View.java revision 732ebb1bc3d7760fd424b84e0235ea9946100102
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.view.menu.MenuBuilder; 21 22import android.content.Context; 23import android.content.res.Resources; 24import android.content.res.TypedArray; 25import android.graphics.Bitmap; 26import android.graphics.Canvas; 27import android.graphics.Interpolator; 28import android.graphics.LinearGradient; 29import android.graphics.Matrix; 30import android.graphics.Paint; 31import android.graphics.PixelFormat; 32import android.graphics.Point; 33import android.graphics.PorterDuff; 34import android.graphics.PorterDuffXfermode; 35import android.graphics.Rect; 36import android.graphics.Region; 37import android.graphics.Shader; 38import android.graphics.drawable.ColorDrawable; 39import android.graphics.drawable.Drawable; 40import android.os.Handler; 41import android.os.IBinder; 42import android.os.Message; 43import android.os.Parcel; 44import android.os.Parcelable; 45import android.os.RemoteException; 46import android.os.SystemClock; 47import android.os.SystemProperties; 48import android.util.AttributeSet; 49import android.util.Config; 50import android.util.EventLog; 51import android.util.Log; 52import android.util.Pool; 53import android.util.Poolable; 54import android.util.PoolableManager; 55import android.util.Pools; 56import android.util.SparseArray; 57import android.view.ContextMenu.ContextMenuInfo; 58import android.view.accessibility.AccessibilityEvent; 59import android.view.accessibility.AccessibilityEventSource; 60import android.view.accessibility.AccessibilityManager; 61import android.view.animation.Animation; 62import android.view.animation.AnimationUtils; 63import android.view.inputmethod.EditorInfo; 64import android.view.inputmethod.InputConnection; 65import android.view.inputmethod.InputMethodManager; 66import android.widget.ScrollBarDrawable; 67 68import java.lang.ref.SoftReference; 69import java.lang.reflect.InvocationTargetException; 70import java.lang.reflect.Method; 71import java.util.ArrayList; 72import java.util.Arrays; 73import java.util.WeakHashMap; 74 75/** 76 * <p> 77 * This class represents the basic building block for user interface components. A View 78 * occupies a rectangular area on the screen and is responsible for drawing and 79 * event handling. View is the base class for <em>widgets</em>, which are 80 * used to create interactive UI components (buttons, text fields, etc.). The 81 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which 82 * are invisible containers that hold other Views (or other ViewGroups) and define 83 * their layout properties. 84 * </p> 85 * 86 * <div class="special"> 87 * <p>For an introduction to using this class to develop your 88 * application's user interface, read the Developer Guide documentation on 89 * <strong><a href="{@docRoot}guide/topics/ui/index.html">User Interface</a></strong>. Special topics 90 * include: 91 * <br/><a href="{@docRoot}guide/topics/ui/declaring-layout.html">Declaring Layout</a> 92 * <br/><a href="{@docRoot}guide/topics/ui/menus.html">Creating Menus</a> 93 * <br/><a href="{@docRoot}guide/topics/ui/layout-objects.html">Common Layout Objects</a> 94 * <br/><a href="{@docRoot}guide/topics/ui/binding.html">Binding to Data with AdapterView</a> 95 * <br/><a href="{@docRoot}guide/topics/ui/ui-events.html">Handling UI Events</a> 96 * <br/><a href="{@docRoot}guide/topics/ui/themes.html">Applying Styles and Themes</a> 97 * <br/><a href="{@docRoot}guide/topics/ui/custom-components.html">Building Custom Components</a> 98 * <br/><a href="{@docRoot}guide/topics/ui/how-android-draws.html">How Android Draws Views</a>. 99 * </p> 100 * </div> 101 * 102 * <a name="Using"></a> 103 * <h3>Using Views</h3> 104 * <p> 105 * All of the views in a window are arranged in a single tree. You can add views 106 * either from code or by specifying a tree of views in one or more XML layout 107 * files. There are many specialized subclasses of views that act as controls or 108 * are capable of displaying text, images, or other content. 109 * </p> 110 * <p> 111 * Once you have created a tree of views, there are typically a few types of 112 * common operations you may wish to perform: 113 * <ul> 114 * <li><strong>Set properties:</strong> for example setting the text of a 115 * {@link android.widget.TextView}. The available properties and the methods 116 * that set them will vary among the different subclasses of views. Note that 117 * properties that are known at build time can be set in the XML layout 118 * files.</li> 119 * <li><strong>Set focus:</strong> The framework will handled moving focus in 120 * response to user input. To force focus to a specific view, call 121 * {@link #requestFocus}.</li> 122 * <li><strong>Set up listeners:</strong> Views allow clients to set listeners 123 * that will be notified when something interesting happens to the view. For 124 * example, all views will let you set a listener to be notified when the view 125 * gains or loses focus. You can register such a listener using 126 * {@link #setOnFocusChangeListener}. Other view subclasses offer more 127 * specialized listeners. For example, a Button exposes a listener to notify 128 * clients when the button is clicked.</li> 129 * <li><strong>Set visibility:</strong> You can hide or show views using 130 * {@link #setVisibility}.</li> 131 * </ul> 132 * </p> 133 * <p><em> 134 * Note: The Android framework is responsible for measuring, laying out and 135 * drawing views. You should not call methods that perform these actions on 136 * views yourself unless you are actually implementing a 137 * {@link android.view.ViewGroup}. 138 * </em></p> 139 * 140 * <a name="Lifecycle"></a> 141 * <h3>Implementing a Custom View</h3> 142 * 143 * <p> 144 * To implement a custom view, you will usually begin by providing overrides for 145 * some of the standard methods that the framework calls on all views. You do 146 * not need to override all of these methods. In fact, you can start by just 147 * overriding {@link #onDraw(android.graphics.Canvas)}. 148 * <table border="2" width="85%" align="center" cellpadding="5"> 149 * <thead> 150 * <tr><th>Category</th> <th>Methods</th> <th>Description</th></tr> 151 * </thead> 152 * 153 * <tbody> 154 * <tr> 155 * <td rowspan="2">Creation</td> 156 * <td>Constructors</td> 157 * <td>There is a form of the constructor that are called when the view 158 * is created from code and a form that is called when the view is 159 * inflated from a layout file. The second form should parse and apply 160 * any attributes defined in the layout file. 161 * </td> 162 * </tr> 163 * <tr> 164 * <td><code>{@link #onFinishInflate()}</code></td> 165 * <td>Called after a view and all of its children has been inflated 166 * from XML.</td> 167 * </tr> 168 * 169 * <tr> 170 * <td rowspan="3">Layout</td> 171 * <td><code>{@link #onMeasure}</code></td> 172 * <td>Called to determine the size requirements for this view and all 173 * of its children. 174 * </td> 175 * </tr> 176 * <tr> 177 * <td><code>{@link #onLayout}</code></td> 178 * <td>Called when this view should assign a size and position to all 179 * of its children. 180 * </td> 181 * </tr> 182 * <tr> 183 * <td><code>{@link #onSizeChanged}</code></td> 184 * <td>Called when the size of this view has changed. 185 * </td> 186 * </tr> 187 * 188 * <tr> 189 * <td>Drawing</td> 190 * <td><code>{@link #onDraw}</code></td> 191 * <td>Called when the view should render its content. 192 * </td> 193 * </tr> 194 * 195 * <tr> 196 * <td rowspan="4">Event processing</td> 197 * <td><code>{@link #onKeyDown}</code></td> 198 * <td>Called when a new key event occurs. 199 * </td> 200 * </tr> 201 * <tr> 202 * <td><code>{@link #onKeyUp}</code></td> 203 * <td>Called when a key up event occurs. 204 * </td> 205 * </tr> 206 * <tr> 207 * <td><code>{@link #onTrackballEvent}</code></td> 208 * <td>Called when a trackball motion event occurs. 209 * </td> 210 * </tr> 211 * <tr> 212 * <td><code>{@link #onTouchEvent}</code></td> 213 * <td>Called when a touch screen motion event occurs. 214 * </td> 215 * </tr> 216 * 217 * <tr> 218 * <td rowspan="2">Focus</td> 219 * <td><code>{@link #onFocusChanged}</code></td> 220 * <td>Called when the view gains or loses focus. 221 * </td> 222 * </tr> 223 * 224 * <tr> 225 * <td><code>{@link #onWindowFocusChanged}</code></td> 226 * <td>Called when the window containing the view gains or loses focus. 227 * </td> 228 * </tr> 229 * 230 * <tr> 231 * <td rowspan="3">Attaching</td> 232 * <td><code>{@link #onAttachedToWindow()}</code></td> 233 * <td>Called when the view is attached to a window. 234 * </td> 235 * </tr> 236 * 237 * <tr> 238 * <td><code>{@link #onDetachedFromWindow}</code></td> 239 * <td>Called when the view is detached from its window. 240 * </td> 241 * </tr> 242 * 243 * <tr> 244 * <td><code>{@link #onWindowVisibilityChanged}</code></td> 245 * <td>Called when the visibility of the window containing the view 246 * has changed. 247 * </td> 248 * </tr> 249 * </tbody> 250 * 251 * </table> 252 * </p> 253 * 254 * <a name="IDs"></a> 255 * <h3>IDs</h3> 256 * Views may have an integer id associated with them. These ids are typically 257 * assigned in the layout XML files, and are used to find specific views within 258 * the view tree. A common pattern is to: 259 * <ul> 260 * <li>Define a Button in the layout file and assign it a unique ID. 261 * <pre> 262 * <Button id="@+id/my_button" 263 * android:layout_width="wrap_content" 264 * android:layout_height="wrap_content" 265 * android:text="@string/my_button_text"/> 266 * </pre></li> 267 * <li>From the onCreate method of an Activity, find the Button 268 * <pre class="prettyprint"> 269 * Button myButton = (Button) findViewById(R.id.my_button); 270 * </pre></li> 271 * </ul> 272 * <p> 273 * View IDs need not be unique throughout the tree, but it is good practice to 274 * ensure that they are at least unique within the part of the tree you are 275 * searching. 276 * </p> 277 * 278 * <a name="Position"></a> 279 * <h3>Position</h3> 280 * <p> 281 * The geometry of a view is that of a rectangle. A view has a location, 282 * expressed as a pair of <em>left</em> and <em>top</em> coordinates, and 283 * two dimensions, expressed as a width and a height. The unit for location 284 * and dimensions is the pixel. 285 * </p> 286 * 287 * <p> 288 * It is possible to retrieve the location of a view by invoking the methods 289 * {@link #getLeft()} and {@link #getTop()}. The former returns the left, or X, 290 * coordinate of the rectangle representing the view. The latter returns the 291 * top, or Y, coordinate of the rectangle representing the view. These methods 292 * both return the location of the view relative to its parent. For instance, 293 * when getLeft() returns 20, that means the view is located 20 pixels to the 294 * right of the left edge of its direct parent. 295 * </p> 296 * 297 * <p> 298 * In addition, several convenience methods are offered to avoid unnecessary 299 * computations, namely {@link #getRight()} and {@link #getBottom()}. 300 * These methods return the coordinates of the right and bottom edges of the 301 * rectangle representing the view. For instance, calling {@link #getRight()} 302 * is similar to the following computation: <code>getLeft() + getWidth()</code> 303 * (see <a href="#SizePaddingMargins">Size</a> for more information about the width.) 304 * </p> 305 * 306 * <a name="SizePaddingMargins"></a> 307 * <h3>Size, padding and margins</h3> 308 * <p> 309 * The size of a view is expressed with a width and a height. A view actually 310 * possess two pairs of width and height values. 311 * </p> 312 * 313 * <p> 314 * The first pair is known as <em>measured width</em> and 315 * <em>measured height</em>. These dimensions define how big a view wants to be 316 * within its parent (see <a href="#Layout">Layout</a> for more details.) The 317 * measured dimensions can be obtained by calling {@link #getMeasuredWidth()} 318 * and {@link #getMeasuredHeight()}. 319 * </p> 320 * 321 * <p> 322 * The second pair is simply known as <em>width</em> and <em>height</em>, or 323 * sometimes <em>drawing width</em> and <em>drawing height</em>. These 324 * dimensions define the actual size of the view on screen, at drawing time and 325 * after layout. These values may, but do not have to, be different from the 326 * measured width and height. The width and height can be obtained by calling 327 * {@link #getWidth()} and {@link #getHeight()}. 328 * </p> 329 * 330 * <p> 331 * To measure its dimensions, a view takes into account its padding. The padding 332 * is expressed in pixels for the left, top, right and bottom parts of the view. 333 * Padding can be used to offset the content of the view by a specific amount of 334 * pixels. For instance, a left padding of 2 will push the view's content by 335 * 2 pixels to the right of the left edge. Padding can be set using the 336 * {@link #setPadding(int, int, int, int)} method and queried by calling 337 * {@link #getPaddingLeft()}, {@link #getPaddingTop()}, 338 * {@link #getPaddingRight()} and {@link #getPaddingBottom()}. 339 * </p> 340 * 341 * <p> 342 * Even though a view can define a padding, it does not provide any support for 343 * margins. However, view groups provide such a support. Refer to 344 * {@link android.view.ViewGroup} and 345 * {@link android.view.ViewGroup.MarginLayoutParams} for further information. 346 * </p> 347 * 348 * <a name="Layout"></a> 349 * <h3>Layout</h3> 350 * <p> 351 * Layout is a two pass process: a measure pass and a layout pass. The measuring 352 * pass is implemented in {@link #measure(int, int)} and is a top-down traversal 353 * of the view tree. Each view pushes dimension specifications down the tree 354 * during the recursion. At the end of the measure pass, every view has stored 355 * its measurements. The second pass happens in 356 * {@link #layout(int,int,int,int)} and is also top-down. During 357 * this pass each parent is responsible for positioning all of its children 358 * using the sizes computed in the measure pass. 359 * </p> 360 * 361 * <p> 362 * When a view's measure() method returns, its {@link #getMeasuredWidth()} and 363 * {@link #getMeasuredHeight()} values must be set, along with those for all of 364 * that view's descendants. A view's measured width and measured height values 365 * must respect the constraints imposed by the view's parents. This guarantees 366 * that at the end of the measure pass, all parents accept all of their 367 * children's measurements. A parent view may call measure() more than once on 368 * its children. For example, the parent may measure each child once with 369 * unspecified dimensions to find out how big they want to be, then call 370 * measure() on them again with actual numbers if the sum of all the children's 371 * unconstrained sizes is too big or too small. 372 * </p> 373 * 374 * <p> 375 * The measure pass uses two classes to communicate dimensions. The 376 * {@link MeasureSpec} class is used by views to tell their parents how they 377 * want to be measured and positioned. The base LayoutParams class just 378 * describes how big the view wants to be for both width and height. For each 379 * dimension, it can specify one of: 380 * <ul> 381 * <li> an exact number 382 * <li>MATCH_PARENT, which means the view wants to be as big as its parent 383 * (minus padding) 384 * <li> WRAP_CONTENT, which means that the view wants to be just big enough to 385 * enclose its content (plus padding). 386 * </ul> 387 * There are subclasses of LayoutParams for different subclasses of ViewGroup. 388 * For example, AbsoluteLayout has its own subclass of LayoutParams which adds 389 * an X and Y value. 390 * </p> 391 * 392 * <p> 393 * MeasureSpecs are used to push requirements down the tree from parent to 394 * child. A MeasureSpec can be in one of three modes: 395 * <ul> 396 * <li>UNSPECIFIED: This is used by a parent to determine the desired dimension 397 * of a child view. For example, a LinearLayout may call measure() on its child 398 * with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how 399 * tall the child view wants to be given a width of 240 pixels. 400 * <li>EXACTLY: This is used by the parent to impose an exact size on the 401 * child. The child must use this size, and guarantee that all of its 402 * descendants will fit within this size. 403 * <li>AT_MOST: This is used by the parent to impose a maximum size on the 404 * child. The child must gurantee that it and all of its descendants will fit 405 * within this size. 406 * </ul> 407 * </p> 408 * 409 * <p> 410 * To intiate a layout, call {@link #requestLayout}. This method is typically 411 * called by a view on itself when it believes that is can no longer fit within 412 * its current bounds. 413 * </p> 414 * 415 * <a name="Drawing"></a> 416 * <h3>Drawing</h3> 417 * <p> 418 * Drawing is handled by walking the tree and rendering each view that 419 * intersects the the invalid region. Because the tree is traversed in-order, 420 * this means that parents will draw before (i.e., behind) their children, with 421 * siblings drawn in the order they appear in the tree. 422 * If you set a background drawable for a View, then the View will draw it for you 423 * before calling back to its <code>onDraw()</code> method. 424 * </p> 425 * 426 * <p> 427 * Note that the framework will not draw views that are not in the invalid region. 428 * </p> 429 * 430 * <p> 431 * To force a view to draw, call {@link #invalidate()}. 432 * </p> 433 * 434 * <a name="EventHandlingThreading"></a> 435 * <h3>Event Handling and Threading</h3> 436 * <p> 437 * The basic cycle of a view is as follows: 438 * <ol> 439 * <li>An event comes in and is dispatched to the appropriate view. The view 440 * handles the event and notifies any listeners.</li> 441 * <li>If in the course of processing the event, the view's bounds may need 442 * to be changed, the view will call {@link #requestLayout()}.</li> 443 * <li>Similarly, if in the course of processing the event the view's appearance 444 * may need to be changed, the view will call {@link #invalidate()}.</li> 445 * <li>If either {@link #requestLayout()} or {@link #invalidate()} were called, 446 * the framework will take care of measuring, laying out, and drawing the tree 447 * as appropriate.</li> 448 * </ol> 449 * </p> 450 * 451 * <p><em>Note: The entire view tree is single threaded. You must always be on 452 * the UI thread when calling any method on any view.</em> 453 * If you are doing work on other threads and want to update the state of a view 454 * from that thread, you should use a {@link Handler}. 455 * </p> 456 * 457 * <a name="FocusHandling"></a> 458 * <h3>Focus Handling</h3> 459 * <p> 460 * The framework will handle routine focus movement in response to user input. 461 * This includes changing the focus as views are removed or hidden, or as new 462 * views become available. Views indicate their willingness to take focus 463 * through the {@link #isFocusable} method. To change whether a view can take 464 * focus, call {@link #setFocusable(boolean)}. When in touch mode (see notes below) 465 * views indicate whether they still would like focus via {@link #isFocusableInTouchMode} 466 * and can change this via {@link #setFocusableInTouchMode(boolean)}. 467 * </p> 468 * <p> 469 * Focus movement is based on an algorithm which finds the nearest neighbor in a 470 * given direction. In rare cases, the default algorithm may not match the 471 * intended behavior of the developer. In these situations, you can provide 472 * explicit overrides by using these XML attributes in the layout file: 473 * <pre> 474 * nextFocusDown 475 * nextFocusLeft 476 * nextFocusRight 477 * nextFocusUp 478 * </pre> 479 * </p> 480 * 481 * 482 * <p> 483 * To get a particular view to take focus, call {@link #requestFocus()}. 484 * </p> 485 * 486 * <a name="TouchMode"></a> 487 * <h3>Touch Mode</h3> 488 * <p> 489 * When a user is navigating a user interface via directional keys such as a D-pad, it is 490 * necessary to give focus to actionable items such as buttons so the user can see 491 * what will take input. If the device has touch capabilities, however, and the user 492 * begins interacting with the interface by touching it, it is no longer necessary to 493 * always highlight, or give focus to, a particular view. This motivates a mode 494 * for interaction named 'touch mode'. 495 * </p> 496 * <p> 497 * For a touch capable device, once the user touches the screen, the device 498 * will enter touch mode. From this point onward, only views for which 499 * {@link #isFocusableInTouchMode} is true will be focusable, such as text editing widgets. 500 * Other views that are touchable, like buttons, will not take focus when touched; they will 501 * only fire the on click listeners. 502 * </p> 503 * <p> 504 * Any time a user hits a directional key, such as a D-pad direction, the view device will 505 * exit touch mode, and find a view to take focus, so that the user may resume interacting 506 * with the user interface without touching the screen again. 507 * </p> 508 * <p> 509 * The touch mode state is maintained across {@link android.app.Activity}s. Call 510 * {@link #isInTouchMode} to see whether the device is currently in touch mode. 511 * </p> 512 * 513 * <a name="Scrolling"></a> 514 * <h3>Scrolling</h3> 515 * <p> 516 * The framework provides basic support for views that wish to internally 517 * scroll their content. This includes keeping track of the X and Y scroll 518 * offset as well as mechanisms for drawing scrollbars. See 519 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and 520 * {@link #awakenScrollBars()} for more details. 521 * </p> 522 * 523 * <a name="Tags"></a> 524 * <h3>Tags</h3> 525 * <p> 526 * Unlike IDs, tags are not used to identify views. Tags are essentially an 527 * extra piece of information that can be associated with a view. They are most 528 * often used as a convenience to store data related to views in the views 529 * themselves rather than by putting them in a separate structure. 530 * </p> 531 * 532 * <a name="Animation"></a> 533 * <h3>Animation</h3> 534 * <p> 535 * You can attach an {@link Animation} object to a view using 536 * {@link #setAnimation(Animation)} or 537 * {@link #startAnimation(Animation)}. The animation can alter the scale, 538 * rotation, translation and alpha of a view over time. If the animation is 539 * attached to a view that has children, the animation will affect the entire 540 * subtree rooted by that node. When an animation is started, the framework will 541 * take care of redrawing the appropriate views until the animation completes. 542 * </p> 543 * 544 * @attr ref android.R.styleable#View_background 545 * @attr ref android.R.styleable#View_clickable 546 * @attr ref android.R.styleable#View_contentDescription 547 * @attr ref android.R.styleable#View_drawingCacheQuality 548 * @attr ref android.R.styleable#View_duplicateParentState 549 * @attr ref android.R.styleable#View_id 550 * @attr ref android.R.styleable#View_fadingEdge 551 * @attr ref android.R.styleable#View_fadingEdgeLength 552 * @attr ref android.R.styleable#View_fitsSystemWindows 553 * @attr ref android.R.styleable#View_isScrollContainer 554 * @attr ref android.R.styleable#View_focusable 555 * @attr ref android.R.styleable#View_focusableInTouchMode 556 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 557 * @attr ref android.R.styleable#View_keepScreenOn 558 * @attr ref android.R.styleable#View_longClickable 559 * @attr ref android.R.styleable#View_minHeight 560 * @attr ref android.R.styleable#View_minWidth 561 * @attr ref android.R.styleable#View_nextFocusDown 562 * @attr ref android.R.styleable#View_nextFocusLeft 563 * @attr ref android.R.styleable#View_nextFocusRight 564 * @attr ref android.R.styleable#View_nextFocusUp 565 * @attr ref android.R.styleable#View_onClick 566 * @attr ref android.R.styleable#View_padding 567 * @attr ref android.R.styleable#View_paddingBottom 568 * @attr ref android.R.styleable#View_paddingLeft 569 * @attr ref android.R.styleable#View_paddingRight 570 * @attr ref android.R.styleable#View_paddingTop 571 * @attr ref android.R.styleable#View_saveEnabled 572 * @attr ref android.R.styleable#View_scrollX 573 * @attr ref android.R.styleable#View_scrollY 574 * @attr ref android.R.styleable#View_scrollbarSize 575 * @attr ref android.R.styleable#View_scrollbarStyle 576 * @attr ref android.R.styleable#View_scrollbars 577 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade 578 * @attr ref android.R.styleable#View_scrollbarFadeDuration 579 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal 580 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal 581 * @attr ref android.R.styleable#View_scrollbarThumbVertical 582 * @attr ref android.R.styleable#View_scrollbarTrackVertical 583 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack 584 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack 585 * @attr ref android.R.styleable#View_soundEffectsEnabled 586 * @attr ref android.R.styleable#View_tag 587 * @attr ref android.R.styleable#View_visibility 588 * 589 * @see android.view.ViewGroup 590 */ 591public class View implements Drawable.Callback, KeyEvent.Callback, AccessibilityEventSource { 592 private static final boolean DBG = false; 593 594 /** 595 * The logging tag used by this class with android.util.Log. 596 */ 597 protected static final String VIEW_LOG_TAG = "View"; 598 599 /** 600 * Used to mark a View that has no ID. 601 */ 602 public static final int NO_ID = -1; 603 604 /** 605 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when 606 * calling setFlags. 607 */ 608 private static final int NOT_FOCUSABLE = 0x00000000; 609 610 /** 611 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling 612 * setFlags. 613 */ 614 private static final int FOCUSABLE = 0x00000001; 615 616 /** 617 * Mask for use with setFlags indicating bits used for focus. 618 */ 619 private static final int FOCUSABLE_MASK = 0x00000001; 620 621 /** 622 * This view will adjust its padding to fit sytem windows (e.g. status bar) 623 */ 624 private static final int FITS_SYSTEM_WINDOWS = 0x00000002; 625 626 /** 627 * This view is visible. Use with {@link #setVisibility}. 628 */ 629 public static final int VISIBLE = 0x00000000; 630 631 /** 632 * This view is invisible, but it still takes up space for layout purposes. 633 * Use with {@link #setVisibility}. 634 */ 635 public static final int INVISIBLE = 0x00000004; 636 637 /** 638 * This view is invisible, and it doesn't take any space for layout 639 * purposes. Use with {@link #setVisibility}. 640 */ 641 public static final int GONE = 0x00000008; 642 643 /** 644 * Mask for use with setFlags indicating bits used for visibility. 645 * {@hide} 646 */ 647 static final int VISIBILITY_MASK = 0x0000000C; 648 649 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE}; 650 651 /** 652 * This view is enabled. Intrepretation varies by subclass. 653 * Use with ENABLED_MASK when calling setFlags. 654 * {@hide} 655 */ 656 static final int ENABLED = 0x00000000; 657 658 /** 659 * This view is disabled. Intrepretation varies by subclass. 660 * Use with ENABLED_MASK when calling setFlags. 661 * {@hide} 662 */ 663 static final int DISABLED = 0x00000020; 664 665 /** 666 * Mask for use with setFlags indicating bits used for indicating whether 667 * this view is enabled 668 * {@hide} 669 */ 670 static final int ENABLED_MASK = 0x00000020; 671 672 /** 673 * This view won't draw. {@link #onDraw} won't be called and further 674 * optimizations 675 * will be performed. It is okay to have this flag set and a background. 676 * Use with DRAW_MASK when calling setFlags. 677 * {@hide} 678 */ 679 static final int WILL_NOT_DRAW = 0x00000080; 680 681 /** 682 * Mask for use with setFlags indicating bits used for indicating whether 683 * this view is will draw 684 * {@hide} 685 */ 686 static final int DRAW_MASK = 0x00000080; 687 688 /** 689 * <p>This view doesn't show scrollbars.</p> 690 * {@hide} 691 */ 692 static final int SCROLLBARS_NONE = 0x00000000; 693 694 /** 695 * <p>This view shows horizontal scrollbars.</p> 696 * {@hide} 697 */ 698 static final int SCROLLBARS_HORIZONTAL = 0x00000100; 699 700 /** 701 * <p>This view shows vertical scrollbars.</p> 702 * {@hide} 703 */ 704 static final int SCROLLBARS_VERTICAL = 0x00000200; 705 706 /** 707 * <p>Mask for use with setFlags indicating bits used for indicating which 708 * scrollbars are enabled.</p> 709 * {@hide} 710 */ 711 static final int SCROLLBARS_MASK = 0x00000300; 712 713 // note 0x00000400 and 0x00000800 are now available for next flags... 714 715 /** 716 * <p>This view doesn't show fading edges.</p> 717 * {@hide} 718 */ 719 static final int FADING_EDGE_NONE = 0x00000000; 720 721 /** 722 * <p>This view shows horizontal fading edges.</p> 723 * {@hide} 724 */ 725 static final int FADING_EDGE_HORIZONTAL = 0x00001000; 726 727 /** 728 * <p>This view shows vertical fading edges.</p> 729 * {@hide} 730 */ 731 static final int FADING_EDGE_VERTICAL = 0x00002000; 732 733 /** 734 * <p>Mask for use with setFlags indicating bits used for indicating which 735 * fading edges are enabled.</p> 736 * {@hide} 737 */ 738 static final int FADING_EDGE_MASK = 0x00003000; 739 740 /** 741 * <p>Indicates this view can be clicked. When clickable, a View reacts 742 * to clicks by notifying the OnClickListener.<p> 743 * {@hide} 744 */ 745 static final int CLICKABLE = 0x00004000; 746 747 /** 748 * <p>Indicates this view is caching its drawing into a bitmap.</p> 749 * {@hide} 750 */ 751 static final int DRAWING_CACHE_ENABLED = 0x00008000; 752 753 /** 754 * <p>Indicates that no icicle should be saved for this view.<p> 755 * {@hide} 756 */ 757 static final int SAVE_DISABLED = 0x000010000; 758 759 /** 760 * <p>Mask for use with setFlags indicating bits used for the saveEnabled 761 * property.</p> 762 * {@hide} 763 */ 764 static final int SAVE_DISABLED_MASK = 0x000010000; 765 766 /** 767 * <p>Indicates that no drawing cache should ever be created for this view.<p> 768 * {@hide} 769 */ 770 static final int WILL_NOT_CACHE_DRAWING = 0x000020000; 771 772 /** 773 * <p>Indicates this view can take / keep focus when int touch mode.</p> 774 * {@hide} 775 */ 776 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000; 777 778 /** 779 * <p>Enables low quality mode for the drawing cache.</p> 780 */ 781 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000; 782 783 /** 784 * <p>Enables high quality mode for the drawing cache.</p> 785 */ 786 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000; 787 788 /** 789 * <p>Enables automatic quality mode for the drawing cache.</p> 790 */ 791 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000; 792 793 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = { 794 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH 795 }; 796 797 /** 798 * <p>Mask for use with setFlags indicating bits used for the cache 799 * quality property.</p> 800 * {@hide} 801 */ 802 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000; 803 804 /** 805 * <p> 806 * Indicates this view can be long clicked. When long clickable, a View 807 * reacts to long clicks by notifying the OnLongClickListener or showing a 808 * context menu. 809 * </p> 810 * {@hide} 811 */ 812 static final int LONG_CLICKABLE = 0x00200000; 813 814 /** 815 * <p>Indicates that this view gets its drawable states from its direct parent 816 * and ignores its original internal states.</p> 817 * 818 * @hide 819 */ 820 static final int DUPLICATE_PARENT_STATE = 0x00400000; 821 822 /** 823 * The scrollbar style to display the scrollbars inside the content area, 824 * without increasing the padding. The scrollbars will be overlaid with 825 * translucency on the view's content. 826 */ 827 public static final int SCROLLBARS_INSIDE_OVERLAY = 0; 828 829 /** 830 * The scrollbar style to display the scrollbars inside the padded area, 831 * increasing the padding of the view. The scrollbars will not overlap the 832 * content area of the view. 833 */ 834 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000; 835 836 /** 837 * The scrollbar style to display the scrollbars at the edge of the view, 838 * without increasing the padding. The scrollbars will be overlaid with 839 * translucency. 840 */ 841 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000; 842 843 /** 844 * The scrollbar style to display the scrollbars at the edge of the view, 845 * increasing the padding of the view. The scrollbars will only overlap the 846 * background, if any. 847 */ 848 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000; 849 850 /** 851 * Mask to check if the scrollbar style is overlay or inset. 852 * {@hide} 853 */ 854 static final int SCROLLBARS_INSET_MASK = 0x01000000; 855 856 /** 857 * Mask to check if the scrollbar style is inside or outside. 858 * {@hide} 859 */ 860 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000; 861 862 /** 863 * Mask for scrollbar style. 864 * {@hide} 865 */ 866 static final int SCROLLBARS_STYLE_MASK = 0x03000000; 867 868 /** 869 * View flag indicating that the screen should remain on while the 870 * window containing this view is visible to the user. This effectively 871 * takes care of automatically setting the WindowManager's 872 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}. 873 */ 874 public static final int KEEP_SCREEN_ON = 0x04000000; 875 876 /** 877 * View flag indicating whether this view should have sound effects enabled 878 * for events such as clicking and touching. 879 */ 880 public static final int SOUND_EFFECTS_ENABLED = 0x08000000; 881 882 /** 883 * View flag indicating whether this view should have haptic feedback 884 * enabled for events such as long presses. 885 */ 886 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000; 887 888 /** 889 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 890 * should add all focusable Views regardless if they are focusable in touch mode. 891 */ 892 public static final int FOCUSABLES_ALL = 0x00000000; 893 894 /** 895 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)} 896 * should add only Views focusable in touch mode. 897 */ 898 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001; 899 900 /** 901 * Use with {@link #focusSearch}. Move focus to the previous selectable 902 * item. 903 */ 904 public static final int FOCUS_BACKWARD = 0x00000001; 905 906 /** 907 * Use with {@link #focusSearch}. Move focus to the next selectable 908 * item. 909 */ 910 public static final int FOCUS_FORWARD = 0x00000002; 911 912 /** 913 * Use with {@link #focusSearch}. Move focus to the left. 914 */ 915 public static final int FOCUS_LEFT = 0x00000011; 916 917 /** 918 * Use with {@link #focusSearch}. Move focus up. 919 */ 920 public static final int FOCUS_UP = 0x00000021; 921 922 /** 923 * Use with {@link #focusSearch}. Move focus to the right. 924 */ 925 public static final int FOCUS_RIGHT = 0x00000042; 926 927 /** 928 * Use with {@link #focusSearch}. Move focus down. 929 */ 930 public static final int FOCUS_DOWN = 0x00000082; 931 932 /** 933 * Base View state sets 934 */ 935 // Singles 936 /** 937 * Indicates the view has no states set. States are used with 938 * {@link android.graphics.drawable.Drawable} to change the drawing of the 939 * view depending on its state. 940 * 941 * @see android.graphics.drawable.Drawable 942 * @see #getDrawableState() 943 */ 944 protected static final int[] EMPTY_STATE_SET = {}; 945 /** 946 * Indicates the view is enabled. States are used with 947 * {@link android.graphics.drawable.Drawable} to change the drawing of the 948 * view depending on its state. 949 * 950 * @see android.graphics.drawable.Drawable 951 * @see #getDrawableState() 952 */ 953 protected static final int[] ENABLED_STATE_SET = {R.attr.state_enabled}; 954 /** 955 * Indicates the view is focused. States are used with 956 * {@link android.graphics.drawable.Drawable} to change the drawing of the 957 * view depending on its state. 958 * 959 * @see android.graphics.drawable.Drawable 960 * @see #getDrawableState() 961 */ 962 protected static final int[] FOCUSED_STATE_SET = {R.attr.state_focused}; 963 /** 964 * Indicates the view is selected. States are used with 965 * {@link android.graphics.drawable.Drawable} to change the drawing of the 966 * view depending on its state. 967 * 968 * @see android.graphics.drawable.Drawable 969 * @see #getDrawableState() 970 */ 971 protected static final int[] SELECTED_STATE_SET = {R.attr.state_selected}; 972 /** 973 * Indicates the view is pressed. States are used with 974 * {@link android.graphics.drawable.Drawable} to change the drawing of the 975 * view depending on its state. 976 * 977 * @see android.graphics.drawable.Drawable 978 * @see #getDrawableState() 979 * @hide 980 */ 981 protected static final int[] PRESSED_STATE_SET = {R.attr.state_pressed}; 982 /** 983 * Indicates the view's window has focus. States are used with 984 * {@link android.graphics.drawable.Drawable} to change the drawing of the 985 * view depending on its state. 986 * 987 * @see android.graphics.drawable.Drawable 988 * @see #getDrawableState() 989 */ 990 protected static final int[] WINDOW_FOCUSED_STATE_SET = 991 {R.attr.state_window_focused}; 992 // Doubles 993 /** 994 * Indicates the view is enabled and has the focus. 995 * 996 * @see #ENABLED_STATE_SET 997 * @see #FOCUSED_STATE_SET 998 */ 999 protected static final int[] ENABLED_FOCUSED_STATE_SET = 1000 stateSetUnion(ENABLED_STATE_SET, FOCUSED_STATE_SET); 1001 /** 1002 * Indicates the view is enabled and selected. 1003 * 1004 * @see #ENABLED_STATE_SET 1005 * @see #SELECTED_STATE_SET 1006 */ 1007 protected static final int[] ENABLED_SELECTED_STATE_SET = 1008 stateSetUnion(ENABLED_STATE_SET, SELECTED_STATE_SET); 1009 /** 1010 * Indicates the view is enabled and that its window has focus. 1011 * 1012 * @see #ENABLED_STATE_SET 1013 * @see #WINDOW_FOCUSED_STATE_SET 1014 */ 1015 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET = 1016 stateSetUnion(ENABLED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1017 /** 1018 * Indicates the view is focused and selected. 1019 * 1020 * @see #FOCUSED_STATE_SET 1021 * @see #SELECTED_STATE_SET 1022 */ 1023 protected static final int[] FOCUSED_SELECTED_STATE_SET = 1024 stateSetUnion(FOCUSED_STATE_SET, SELECTED_STATE_SET); 1025 /** 1026 * Indicates the view has the focus and that its window has the focus. 1027 * 1028 * @see #FOCUSED_STATE_SET 1029 * @see #WINDOW_FOCUSED_STATE_SET 1030 */ 1031 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET = 1032 stateSetUnion(FOCUSED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1033 /** 1034 * Indicates the view is selected and that its window has the focus. 1035 * 1036 * @see #SELECTED_STATE_SET 1037 * @see #WINDOW_FOCUSED_STATE_SET 1038 */ 1039 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET = 1040 stateSetUnion(SELECTED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1041 // Triples 1042 /** 1043 * Indicates the view is enabled, focused and selected. 1044 * 1045 * @see #ENABLED_STATE_SET 1046 * @see #FOCUSED_STATE_SET 1047 * @see #SELECTED_STATE_SET 1048 */ 1049 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET = 1050 stateSetUnion(ENABLED_FOCUSED_STATE_SET, SELECTED_STATE_SET); 1051 /** 1052 * Indicates the view is enabled, focused and its window has the focus. 1053 * 1054 * @see #ENABLED_STATE_SET 1055 * @see #FOCUSED_STATE_SET 1056 * @see #WINDOW_FOCUSED_STATE_SET 1057 */ 1058 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = 1059 stateSetUnion(ENABLED_FOCUSED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1060 /** 1061 * Indicates the view is enabled, selected and its window has the focus. 1062 * 1063 * @see #ENABLED_STATE_SET 1064 * @see #SELECTED_STATE_SET 1065 * @see #WINDOW_FOCUSED_STATE_SET 1066 */ 1067 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = 1068 stateSetUnion(ENABLED_SELECTED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1069 /** 1070 * Indicates the view is focused, selected and its window has the focus. 1071 * 1072 * @see #FOCUSED_STATE_SET 1073 * @see #SELECTED_STATE_SET 1074 * @see #WINDOW_FOCUSED_STATE_SET 1075 */ 1076 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = 1077 stateSetUnion(FOCUSED_SELECTED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1078 /** 1079 * Indicates the view is enabled, focused, selected and its window 1080 * has the focus. 1081 * 1082 * @see #ENABLED_STATE_SET 1083 * @see #FOCUSED_STATE_SET 1084 * @see #SELECTED_STATE_SET 1085 * @see #WINDOW_FOCUSED_STATE_SET 1086 */ 1087 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = 1088 stateSetUnion(ENABLED_FOCUSED_SELECTED_STATE_SET, 1089 WINDOW_FOCUSED_STATE_SET); 1090 1091 /** 1092 * Indicates the view is pressed and its window has the focus. 1093 * 1094 * @see #PRESSED_STATE_SET 1095 * @see #WINDOW_FOCUSED_STATE_SET 1096 */ 1097 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET = 1098 stateSetUnion(PRESSED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1099 1100 /** 1101 * Indicates the view is pressed and selected. 1102 * 1103 * @see #PRESSED_STATE_SET 1104 * @see #SELECTED_STATE_SET 1105 */ 1106 protected static final int[] PRESSED_SELECTED_STATE_SET = 1107 stateSetUnion(PRESSED_STATE_SET, SELECTED_STATE_SET); 1108 1109 /** 1110 * Indicates the view is pressed, selected and its window has the focus. 1111 * 1112 * @see #PRESSED_STATE_SET 1113 * @see #SELECTED_STATE_SET 1114 * @see #WINDOW_FOCUSED_STATE_SET 1115 */ 1116 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = 1117 stateSetUnion(PRESSED_SELECTED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1118 1119 /** 1120 * Indicates the view is pressed and focused. 1121 * 1122 * @see #PRESSED_STATE_SET 1123 * @see #FOCUSED_STATE_SET 1124 */ 1125 protected static final int[] PRESSED_FOCUSED_STATE_SET = 1126 stateSetUnion(PRESSED_STATE_SET, FOCUSED_STATE_SET); 1127 1128 /** 1129 * Indicates the view is pressed, focused and its window has the focus. 1130 * 1131 * @see #PRESSED_STATE_SET 1132 * @see #FOCUSED_STATE_SET 1133 * @see #WINDOW_FOCUSED_STATE_SET 1134 */ 1135 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = 1136 stateSetUnion(PRESSED_FOCUSED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1137 1138 /** 1139 * Indicates the view is pressed, focused and selected. 1140 * 1141 * @see #PRESSED_STATE_SET 1142 * @see #SELECTED_STATE_SET 1143 * @see #FOCUSED_STATE_SET 1144 */ 1145 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET = 1146 stateSetUnion(PRESSED_FOCUSED_STATE_SET, SELECTED_STATE_SET); 1147 1148 /** 1149 * Indicates the view is pressed, focused, selected and its window has the focus. 1150 * 1151 * @see #PRESSED_STATE_SET 1152 * @see #FOCUSED_STATE_SET 1153 * @see #SELECTED_STATE_SET 1154 * @see #WINDOW_FOCUSED_STATE_SET 1155 */ 1156 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = 1157 stateSetUnion(PRESSED_FOCUSED_SELECTED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1158 1159 /** 1160 * Indicates the view is pressed and enabled. 1161 * 1162 * @see #PRESSED_STATE_SET 1163 * @see #ENABLED_STATE_SET 1164 */ 1165 protected static final int[] PRESSED_ENABLED_STATE_SET = 1166 stateSetUnion(PRESSED_STATE_SET, ENABLED_STATE_SET); 1167 1168 /** 1169 * Indicates the view is pressed, enabled and its window has the focus. 1170 * 1171 * @see #PRESSED_STATE_SET 1172 * @see #ENABLED_STATE_SET 1173 * @see #WINDOW_FOCUSED_STATE_SET 1174 */ 1175 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = 1176 stateSetUnion(PRESSED_ENABLED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1177 1178 /** 1179 * Indicates the view is pressed, enabled and selected. 1180 * 1181 * @see #PRESSED_STATE_SET 1182 * @see #ENABLED_STATE_SET 1183 * @see #SELECTED_STATE_SET 1184 */ 1185 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET = 1186 stateSetUnion(PRESSED_ENABLED_STATE_SET, SELECTED_STATE_SET); 1187 1188 /** 1189 * Indicates the view is pressed, enabled, selected and its window has the 1190 * focus. 1191 * 1192 * @see #PRESSED_STATE_SET 1193 * @see #ENABLED_STATE_SET 1194 * @see #SELECTED_STATE_SET 1195 * @see #WINDOW_FOCUSED_STATE_SET 1196 */ 1197 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = 1198 stateSetUnion(PRESSED_ENABLED_SELECTED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1199 1200 /** 1201 * Indicates the view is pressed, enabled and focused. 1202 * 1203 * @see #PRESSED_STATE_SET 1204 * @see #ENABLED_STATE_SET 1205 * @see #FOCUSED_STATE_SET 1206 */ 1207 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET = 1208 stateSetUnion(PRESSED_ENABLED_STATE_SET, FOCUSED_STATE_SET); 1209 1210 /** 1211 * Indicates the view is pressed, enabled, focused and its window has the 1212 * focus. 1213 * 1214 * @see #PRESSED_STATE_SET 1215 * @see #ENABLED_STATE_SET 1216 * @see #FOCUSED_STATE_SET 1217 * @see #WINDOW_FOCUSED_STATE_SET 1218 */ 1219 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = 1220 stateSetUnion(PRESSED_ENABLED_FOCUSED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1221 1222 /** 1223 * Indicates the view is pressed, enabled, focused and selected. 1224 * 1225 * @see #PRESSED_STATE_SET 1226 * @see #ENABLED_STATE_SET 1227 * @see #SELECTED_STATE_SET 1228 * @see #FOCUSED_STATE_SET 1229 */ 1230 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = 1231 stateSetUnion(PRESSED_ENABLED_FOCUSED_STATE_SET, SELECTED_STATE_SET); 1232 1233 /** 1234 * Indicates the view is pressed, enabled, focused, selected and its window 1235 * has the focus. 1236 * 1237 * @see #PRESSED_STATE_SET 1238 * @see #ENABLED_STATE_SET 1239 * @see #SELECTED_STATE_SET 1240 * @see #FOCUSED_STATE_SET 1241 * @see #WINDOW_FOCUSED_STATE_SET 1242 */ 1243 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = 1244 stateSetUnion(PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET, WINDOW_FOCUSED_STATE_SET); 1245 1246 /** 1247 * The order here is very important to {@link #getDrawableState()} 1248 */ 1249 private static final int[][] VIEW_STATE_SETS = { 1250 EMPTY_STATE_SET, // 0 0 0 0 0 1251 WINDOW_FOCUSED_STATE_SET, // 0 0 0 0 1 1252 SELECTED_STATE_SET, // 0 0 0 1 0 1253 SELECTED_WINDOW_FOCUSED_STATE_SET, // 0 0 0 1 1 1254 FOCUSED_STATE_SET, // 0 0 1 0 0 1255 FOCUSED_WINDOW_FOCUSED_STATE_SET, // 0 0 1 0 1 1256 FOCUSED_SELECTED_STATE_SET, // 0 0 1 1 0 1257 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, // 0 0 1 1 1 1258 ENABLED_STATE_SET, // 0 1 0 0 0 1259 ENABLED_WINDOW_FOCUSED_STATE_SET, // 0 1 0 0 1 1260 ENABLED_SELECTED_STATE_SET, // 0 1 0 1 0 1261 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, // 0 1 0 1 1 1262 ENABLED_FOCUSED_STATE_SET, // 0 1 1 0 0 1263 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, // 0 1 1 0 1 1264 ENABLED_FOCUSED_SELECTED_STATE_SET, // 0 1 1 1 0 1265 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, // 0 1 1 1 1 1266 PRESSED_STATE_SET, // 1 0 0 0 0 1267 PRESSED_WINDOW_FOCUSED_STATE_SET, // 1 0 0 0 1 1268 PRESSED_SELECTED_STATE_SET, // 1 0 0 1 0 1269 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET, // 1 0 0 1 1 1270 PRESSED_FOCUSED_STATE_SET, // 1 0 1 0 0 1271 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET, // 1 0 1 0 1 1272 PRESSED_FOCUSED_SELECTED_STATE_SET, // 1 0 1 1 0 1273 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, // 1 0 1 1 1 1274 PRESSED_ENABLED_STATE_SET, // 1 1 0 0 0 1275 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET, // 1 1 0 0 1 1276 PRESSED_ENABLED_SELECTED_STATE_SET, // 1 1 0 1 0 1277 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET, // 1 1 0 1 1 1278 PRESSED_ENABLED_FOCUSED_STATE_SET, // 1 1 1 0 0 1279 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET, // 1 1 1 0 1 1280 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET, // 1 1 1 1 0 1281 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET, // 1 1 1 1 1 1282 }; 1283 1284 /** 1285 * Used by views that contain lists of items. This state indicates that 1286 * the view is showing the last item. 1287 * @hide 1288 */ 1289 protected static final int[] LAST_STATE_SET = {R.attr.state_last}; 1290 /** 1291 * Used by views that contain lists of items. This state indicates that 1292 * the view is showing the first item. 1293 * @hide 1294 */ 1295 protected static final int[] FIRST_STATE_SET = {R.attr.state_first}; 1296 /** 1297 * Used by views that contain lists of items. This state indicates that 1298 * the view is showing the middle item. 1299 * @hide 1300 */ 1301 protected static final int[] MIDDLE_STATE_SET = {R.attr.state_middle}; 1302 /** 1303 * Used by views that contain lists of items. This state indicates that 1304 * the view is showing only one item. 1305 * @hide 1306 */ 1307 protected static final int[] SINGLE_STATE_SET = {R.attr.state_single}; 1308 /** 1309 * Used by views that contain lists of items. This state indicates that 1310 * the view is pressed and showing the last item. 1311 * @hide 1312 */ 1313 protected static final int[] PRESSED_LAST_STATE_SET = {R.attr.state_last, R.attr.state_pressed}; 1314 /** 1315 * Used by views that contain lists of items. This state indicates that 1316 * the view is pressed and showing the first item. 1317 * @hide 1318 */ 1319 protected static final int[] PRESSED_FIRST_STATE_SET = {R.attr.state_first, R.attr.state_pressed}; 1320 /** 1321 * Used by views that contain lists of items. This state indicates that 1322 * the view is pressed and showing the middle item. 1323 * @hide 1324 */ 1325 protected static final int[] PRESSED_MIDDLE_STATE_SET = {R.attr.state_middle, R.attr.state_pressed}; 1326 /** 1327 * Used by views that contain lists of items. This state indicates that 1328 * the view is pressed and showing only one item. 1329 * @hide 1330 */ 1331 protected static final int[] PRESSED_SINGLE_STATE_SET = {R.attr.state_single, R.attr.state_pressed}; 1332 1333 /** 1334 * Temporary Rect currently for use in setBackground(). This will probably 1335 * be extended in the future to hold our own class with more than just 1336 * a Rect. :) 1337 */ 1338 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>(); 1339 1340 /** 1341 * Map used to store views' tags. 1342 */ 1343 private static WeakHashMap<View, SparseArray<Object>> sTags; 1344 1345 /** 1346 * Lock used to access sTags. 1347 */ 1348 private static final Object sTagsLock = new Object(); 1349 1350 /** 1351 * The animation currently associated with this view. 1352 * @hide 1353 */ 1354 protected Animation mCurrentAnimation = null; 1355 1356 /** 1357 * Width as measured during measure pass. 1358 * {@hide} 1359 */ 1360 @ViewDebug.ExportedProperty 1361 protected int mMeasuredWidth; 1362 1363 /** 1364 * Height as measured during measure pass. 1365 * {@hide} 1366 */ 1367 @ViewDebug.ExportedProperty 1368 protected int mMeasuredHeight; 1369 1370 /** 1371 * The view's identifier. 1372 * {@hide} 1373 * 1374 * @see #setId(int) 1375 * @see #getId() 1376 */ 1377 @ViewDebug.ExportedProperty(resolveId = true) 1378 int mID = NO_ID; 1379 1380 /** 1381 * The view's tag. 1382 * {@hide} 1383 * 1384 * @see #setTag(Object) 1385 * @see #getTag() 1386 */ 1387 protected Object mTag; 1388 1389 // for mPrivateFlags: 1390 /** {@hide} */ 1391 static final int WANTS_FOCUS = 0x00000001; 1392 /** {@hide} */ 1393 static final int FOCUSED = 0x00000002; 1394 /** {@hide} */ 1395 static final int SELECTED = 0x00000004; 1396 /** {@hide} */ 1397 static final int IS_ROOT_NAMESPACE = 0x00000008; 1398 /** {@hide} */ 1399 static final int HAS_BOUNDS = 0x00000010; 1400 /** {@hide} */ 1401 static final int DRAWN = 0x00000020; 1402 /** 1403 * When this flag is set, this view is running an animation on behalf of its 1404 * children and should therefore not cancel invalidate requests, even if they 1405 * lie outside of this view's bounds. 1406 * 1407 * {@hide} 1408 */ 1409 static final int DRAW_ANIMATION = 0x00000040; 1410 /** {@hide} */ 1411 static final int SKIP_DRAW = 0x00000080; 1412 /** {@hide} */ 1413 static final int ONLY_DRAWS_BACKGROUND = 0x00000100; 1414 /** {@hide} */ 1415 static final int REQUEST_TRANSPARENT_REGIONS = 0x00000200; 1416 /** {@hide} */ 1417 static final int DRAWABLE_STATE_DIRTY = 0x00000400; 1418 /** {@hide} */ 1419 static final int MEASURED_DIMENSION_SET = 0x00000800; 1420 /** {@hide} */ 1421 static final int FORCE_LAYOUT = 0x00001000; 1422 1423 private static final int LAYOUT_REQUIRED = 0x00002000; 1424 1425 private static final int PRESSED = 0x00004000; 1426 1427 /** {@hide} */ 1428 static final int DRAWING_CACHE_VALID = 0x00008000; 1429 /** 1430 * Flag used to indicate that this view should be drawn once more (and only once 1431 * more) after its animation has completed. 1432 * {@hide} 1433 */ 1434 static final int ANIMATION_STARTED = 0x00010000; 1435 1436 private static final int SAVE_STATE_CALLED = 0x00020000; 1437 1438 /** 1439 * Indicates that the View returned true when onSetAlpha() was called and that 1440 * the alpha must be restored. 1441 * {@hide} 1442 */ 1443 static final int ALPHA_SET = 0x00040000; 1444 1445 /** 1446 * Set by {@link #setScrollContainer(boolean)}. 1447 */ 1448 static final int SCROLL_CONTAINER = 0x00080000; 1449 1450 /** 1451 * Set by {@link #setScrollContainer(boolean)}. 1452 */ 1453 static final int SCROLL_CONTAINER_ADDED = 0x00100000; 1454 1455 /** 1456 * View flag indicating whether this view was invalidated (fully or partially.) 1457 * 1458 * @hide 1459 */ 1460 static final int DIRTY = 0x00200000; 1461 1462 /** 1463 * View flag indicating whether this view was invalidated by an opaque 1464 * invalidate request. 1465 * 1466 * @hide 1467 */ 1468 static final int DIRTY_OPAQUE = 0x00400000; 1469 1470 /** 1471 * Mask for {@link #DIRTY} and {@link #DIRTY_OPAQUE}. 1472 * 1473 * @hide 1474 */ 1475 static final int DIRTY_MASK = 0x00600000; 1476 1477 /** 1478 * Indicates whether the background is opaque. 1479 * 1480 * @hide 1481 */ 1482 static final int OPAQUE_BACKGROUND = 0x00800000; 1483 1484 /** 1485 * Indicates whether the scrollbars are opaque. 1486 * 1487 * @hide 1488 */ 1489 static final int OPAQUE_SCROLLBARS = 0x01000000; 1490 1491 /** 1492 * Indicates whether the view is opaque. 1493 * 1494 * @hide 1495 */ 1496 static final int OPAQUE_MASK = 0x01800000; 1497 1498 /** 1499 * Indicates a prepressed state; 1500 * the short time between ACTION_DOWN and recognizing 1501 * a 'real' press. Prepressed is used to recognize quick taps 1502 * even when they are shorter than ViewConfiguration.getTapTimeout(). 1503 * 1504 * @hide 1505 */ 1506 private static final int PREPRESSED = 0x02000000; 1507 1508 /** 1509 * The parent this view is attached to. 1510 * {@hide} 1511 * 1512 * @see #getParent() 1513 */ 1514 protected ViewParent mParent; 1515 1516 /** 1517 * {@hide} 1518 */ 1519 AttachInfo mAttachInfo; 1520 1521 /** 1522 * {@hide} 1523 */ 1524 @ViewDebug.ExportedProperty(flagMapping = { 1525 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT, 1526 name = "FORCE_LAYOUT"), 1527 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED, 1528 name = "LAYOUT_REQUIRED"), 1529 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID, 1530 name = "DRAWING_CACHE_INVALID", outputIf = false), 1531 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true), 1532 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false), 1533 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"), 1534 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY") 1535 }) 1536 int mPrivateFlags; 1537 1538 /** 1539 * Count of how many windows this view has been attached to. 1540 */ 1541 int mWindowAttachCount; 1542 1543 /** 1544 * The layout parameters associated with this view and used by the parent 1545 * {@link android.view.ViewGroup} to determine how this view should be 1546 * laid out. 1547 * {@hide} 1548 */ 1549 protected ViewGroup.LayoutParams mLayoutParams; 1550 1551 /** 1552 * The view flags hold various views states. 1553 * {@hide} 1554 */ 1555 @ViewDebug.ExportedProperty 1556 int mViewFlags; 1557 1558 /** 1559 * The distance in pixels from the left edge of this view's parent 1560 * to the left edge of this view. 1561 * {@hide} 1562 */ 1563 @ViewDebug.ExportedProperty 1564 protected int mLeft; 1565 /** 1566 * The distance in pixels from the left edge of this view's parent 1567 * to the right edge of this view. 1568 * {@hide} 1569 */ 1570 @ViewDebug.ExportedProperty 1571 protected int mRight; 1572 /** 1573 * The distance in pixels from the top edge of this view's parent 1574 * to the top edge of this view. 1575 * {@hide} 1576 */ 1577 @ViewDebug.ExportedProperty 1578 protected int mTop; 1579 /** 1580 * The distance in pixels from the top edge of this view's parent 1581 * to the bottom edge of this view. 1582 * {@hide} 1583 */ 1584 @ViewDebug.ExportedProperty 1585 protected int mBottom; 1586 1587 /** 1588 * The offset, in pixels, by which the content of this view is scrolled 1589 * horizontally. 1590 * {@hide} 1591 */ 1592 @ViewDebug.ExportedProperty 1593 protected int mScrollX; 1594 /** 1595 * The offset, in pixels, by which the content of this view is scrolled 1596 * vertically. 1597 * {@hide} 1598 */ 1599 @ViewDebug.ExportedProperty 1600 protected int mScrollY; 1601 1602 /** 1603 * The left padding in pixels, that is the distance in pixels between the 1604 * left edge of this view and the left edge of its content. 1605 * {@hide} 1606 */ 1607 @ViewDebug.ExportedProperty 1608 protected int mPaddingLeft; 1609 /** 1610 * The right padding in pixels, that is the distance in pixels between the 1611 * right edge of this view and the right edge of its content. 1612 * {@hide} 1613 */ 1614 @ViewDebug.ExportedProperty 1615 protected int mPaddingRight; 1616 /** 1617 * The top padding in pixels, that is the distance in pixels between the 1618 * top edge of this view and the top edge of its content. 1619 * {@hide} 1620 */ 1621 @ViewDebug.ExportedProperty 1622 protected int mPaddingTop; 1623 /** 1624 * The bottom padding in pixels, that is the distance in pixels between the 1625 * bottom edge of this view and the bottom edge of its content. 1626 * {@hide} 1627 */ 1628 @ViewDebug.ExportedProperty 1629 protected int mPaddingBottom; 1630 1631 /** 1632 * Briefly describes the view and is primarily used for accessibility support. 1633 */ 1634 private CharSequence mContentDescription; 1635 1636 /** 1637 * Cache the paddingRight set by the user to append to the scrollbar's size. 1638 */ 1639 @ViewDebug.ExportedProperty 1640 int mUserPaddingRight; 1641 1642 /** 1643 * Cache the paddingBottom set by the user to append to the scrollbar's size. 1644 */ 1645 @ViewDebug.ExportedProperty 1646 int mUserPaddingBottom; 1647 1648 /** 1649 * @hide 1650 */ 1651 int mOldWidthMeasureSpec = Integer.MIN_VALUE; 1652 /** 1653 * @hide 1654 */ 1655 int mOldHeightMeasureSpec = Integer.MIN_VALUE; 1656 1657 private Resources mResources = null; 1658 1659 private Drawable mBGDrawable; 1660 1661 private int mBackgroundResource; 1662 private boolean mBackgroundSizeChanged; 1663 1664 /** 1665 * Listener used to dispatch focus change events. 1666 * This field should be made private, so it is hidden from the SDK. 1667 * {@hide} 1668 */ 1669 protected OnFocusChangeListener mOnFocusChangeListener; 1670 1671 /** 1672 * Listener used to dispatch click events. 1673 * This field should be made private, so it is hidden from the SDK. 1674 * {@hide} 1675 */ 1676 protected OnClickListener mOnClickListener; 1677 1678 /** 1679 * Listener used to dispatch long click events. 1680 * This field should be made private, so it is hidden from the SDK. 1681 * {@hide} 1682 */ 1683 protected OnLongClickListener mOnLongClickListener; 1684 1685 /** 1686 * Listener used to build the context menu. 1687 * This field should be made private, so it is hidden from the SDK. 1688 * {@hide} 1689 */ 1690 protected OnCreateContextMenuListener mOnCreateContextMenuListener; 1691 1692 private OnKeyListener mOnKeyListener; 1693 1694 private OnTouchListener mOnTouchListener; 1695 1696 /** 1697 * The application environment this view lives in. 1698 * This field should be made private, so it is hidden from the SDK. 1699 * {@hide} 1700 */ 1701 protected Context mContext; 1702 1703 private ScrollabilityCache mScrollCache; 1704 1705 private int[] mDrawableState = null; 1706 1707 private SoftReference<Bitmap> mDrawingCache; 1708 private SoftReference<Bitmap> mUnscaledDrawingCache; 1709 1710 /** 1711 * When this view has focus and the next focus is {@link #FOCUS_LEFT}, 1712 * the user may specify which view to go to next. 1713 */ 1714 private int mNextFocusLeftId = View.NO_ID; 1715 1716 /** 1717 * When this view has focus and the next focus is {@link #FOCUS_RIGHT}, 1718 * the user may specify which view to go to next. 1719 */ 1720 private int mNextFocusRightId = View.NO_ID; 1721 1722 /** 1723 * When this view has focus and the next focus is {@link #FOCUS_UP}, 1724 * the user may specify which view to go to next. 1725 */ 1726 private int mNextFocusUpId = View.NO_ID; 1727 1728 /** 1729 * When this view has focus and the next focus is {@link #FOCUS_DOWN}, 1730 * the user may specify which view to go to next. 1731 */ 1732 private int mNextFocusDownId = View.NO_ID; 1733 1734 private CheckForLongPress mPendingCheckForLongPress; 1735 private CheckForTap mPendingCheckForTap = null; 1736 1737 private UnsetPressedState mUnsetPressedState; 1738 1739 /** 1740 * Whether the long press's action has been invoked. The tap's action is invoked on the 1741 * up event while a long press is invoked as soon as the long press duration is reached, so 1742 * a long press could be performed before the tap is checked, in which case the tap's action 1743 * should not be invoked. 1744 */ 1745 private boolean mHasPerformedLongPress; 1746 1747 /** 1748 * The minimum height of the view. We'll try our best to have the height 1749 * of this view to at least this amount. 1750 */ 1751 @ViewDebug.ExportedProperty 1752 private int mMinHeight; 1753 1754 /** 1755 * The minimum width of the view. We'll try our best to have the width 1756 * of this view to at least this amount. 1757 */ 1758 @ViewDebug.ExportedProperty 1759 private int mMinWidth; 1760 1761 /** 1762 * The delegate to handle touch events that are physically in this view 1763 * but should be handled by another view. 1764 */ 1765 private TouchDelegate mTouchDelegate = null; 1766 1767 /** 1768 * Solid color to use as a background when creating the drawing cache. Enables 1769 * the cache to use 16 bit bitmaps instead of 32 bit. 1770 */ 1771 private int mDrawingCacheBackgroundColor = 0; 1772 1773 /** 1774 * Special tree observer used when mAttachInfo is null. 1775 */ 1776 private ViewTreeObserver mFloatingTreeObserver; 1777 1778 /** 1779 * Cache the touch slop from the context that created the view. 1780 */ 1781 private int mTouchSlop; 1782 1783 // Used for debug only 1784 static long sInstanceCount = 0; 1785 1786 /** 1787 * Simple constructor to use when creating a view from code. 1788 * 1789 * @param context The Context the view is running in, through which it can 1790 * access the current theme, resources, etc. 1791 */ 1792 public View(Context context) { 1793 mContext = context; 1794 mResources = context != null ? context.getResources() : null; 1795 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED; 1796 ++sInstanceCount; 1797 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop(); 1798 } 1799 1800 /** 1801 * Constructor that is called when inflating a view from XML. This is called 1802 * when a view is being constructed from an XML file, supplying attributes 1803 * that were specified in the XML file. This version uses a default style of 1804 * 0, so the only attribute values applied are those in the Context's Theme 1805 * and the given AttributeSet. 1806 * 1807 * <p> 1808 * The method onFinishInflate() will be called after all children have been 1809 * added. 1810 * 1811 * @param context The Context the view is running in, through which it can 1812 * access the current theme, resources, etc. 1813 * @param attrs The attributes of the XML tag that is inflating the view. 1814 * @see #View(Context, AttributeSet, int) 1815 */ 1816 public View(Context context, AttributeSet attrs) { 1817 this(context, attrs, 0); 1818 } 1819 1820 /** 1821 * Perform inflation from XML and apply a class-specific base style. This 1822 * constructor of View allows subclasses to use their own base style when 1823 * they are inflating. For example, a Button class's constructor would call 1824 * this version of the super class constructor and supply 1825 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows 1826 * the theme's button style to modify all of the base view attributes (in 1827 * particular its background) as well as the Button class's attributes. 1828 * 1829 * @param context The Context the view is running in, through which it can 1830 * access the current theme, resources, etc. 1831 * @param attrs The attributes of the XML tag that is inflating the view. 1832 * @param defStyle The default style to apply to this view. If 0, no style 1833 * will be applied (beyond what is included in the theme). This may 1834 * either be an attribute resource, whose value will be retrieved 1835 * from the current theme, or an explicit style resource. 1836 * @see #View(Context, AttributeSet) 1837 */ 1838 public View(Context context, AttributeSet attrs, int defStyle) { 1839 this(context); 1840 1841 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View, 1842 defStyle, 0); 1843 1844 Drawable background = null; 1845 1846 int leftPadding = -1; 1847 int topPadding = -1; 1848 int rightPadding = -1; 1849 int bottomPadding = -1; 1850 1851 int padding = -1; 1852 1853 int viewFlagValues = 0; 1854 int viewFlagMasks = 0; 1855 1856 boolean setScrollContainer = false; 1857 1858 int x = 0; 1859 int y = 0; 1860 1861 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY; 1862 1863 final int N = a.getIndexCount(); 1864 for (int i = 0; i < N; i++) { 1865 int attr = a.getIndex(i); 1866 switch (attr) { 1867 case com.android.internal.R.styleable.View_background: 1868 background = a.getDrawable(attr); 1869 break; 1870 case com.android.internal.R.styleable.View_padding: 1871 padding = a.getDimensionPixelSize(attr, -1); 1872 break; 1873 case com.android.internal.R.styleable.View_paddingLeft: 1874 leftPadding = a.getDimensionPixelSize(attr, -1); 1875 break; 1876 case com.android.internal.R.styleable.View_paddingTop: 1877 topPadding = a.getDimensionPixelSize(attr, -1); 1878 break; 1879 case com.android.internal.R.styleable.View_paddingRight: 1880 rightPadding = a.getDimensionPixelSize(attr, -1); 1881 break; 1882 case com.android.internal.R.styleable.View_paddingBottom: 1883 bottomPadding = a.getDimensionPixelSize(attr, -1); 1884 break; 1885 case com.android.internal.R.styleable.View_scrollX: 1886 x = a.getDimensionPixelOffset(attr, 0); 1887 break; 1888 case com.android.internal.R.styleable.View_scrollY: 1889 y = a.getDimensionPixelOffset(attr, 0); 1890 break; 1891 case com.android.internal.R.styleable.View_id: 1892 mID = a.getResourceId(attr, NO_ID); 1893 break; 1894 case com.android.internal.R.styleable.View_tag: 1895 mTag = a.getText(attr); 1896 break; 1897 case com.android.internal.R.styleable.View_fitsSystemWindows: 1898 if (a.getBoolean(attr, false)) { 1899 viewFlagValues |= FITS_SYSTEM_WINDOWS; 1900 viewFlagMasks |= FITS_SYSTEM_WINDOWS; 1901 } 1902 break; 1903 case com.android.internal.R.styleable.View_focusable: 1904 if (a.getBoolean(attr, false)) { 1905 viewFlagValues |= FOCUSABLE; 1906 viewFlagMasks |= FOCUSABLE_MASK; 1907 } 1908 break; 1909 case com.android.internal.R.styleable.View_focusableInTouchMode: 1910 if (a.getBoolean(attr, false)) { 1911 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE; 1912 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK; 1913 } 1914 break; 1915 case com.android.internal.R.styleable.View_clickable: 1916 if (a.getBoolean(attr, false)) { 1917 viewFlagValues |= CLICKABLE; 1918 viewFlagMasks |= CLICKABLE; 1919 } 1920 break; 1921 case com.android.internal.R.styleable.View_longClickable: 1922 if (a.getBoolean(attr, false)) { 1923 viewFlagValues |= LONG_CLICKABLE; 1924 viewFlagMasks |= LONG_CLICKABLE; 1925 } 1926 break; 1927 case com.android.internal.R.styleable.View_saveEnabled: 1928 if (!a.getBoolean(attr, true)) { 1929 viewFlagValues |= SAVE_DISABLED; 1930 viewFlagMasks |= SAVE_DISABLED_MASK; 1931 } 1932 break; 1933 case com.android.internal.R.styleable.View_duplicateParentState: 1934 if (a.getBoolean(attr, false)) { 1935 viewFlagValues |= DUPLICATE_PARENT_STATE; 1936 viewFlagMasks |= DUPLICATE_PARENT_STATE; 1937 } 1938 break; 1939 case com.android.internal.R.styleable.View_visibility: 1940 final int visibility = a.getInt(attr, 0); 1941 if (visibility != 0) { 1942 viewFlagValues |= VISIBILITY_FLAGS[visibility]; 1943 viewFlagMasks |= VISIBILITY_MASK; 1944 } 1945 break; 1946 case com.android.internal.R.styleable.View_drawingCacheQuality: 1947 final int cacheQuality = a.getInt(attr, 0); 1948 if (cacheQuality != 0) { 1949 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality]; 1950 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK; 1951 } 1952 break; 1953 case com.android.internal.R.styleable.View_contentDescription: 1954 mContentDescription = a.getString(attr); 1955 break; 1956 case com.android.internal.R.styleable.View_soundEffectsEnabled: 1957 if (!a.getBoolean(attr, true)) { 1958 viewFlagValues &= ~SOUND_EFFECTS_ENABLED; 1959 viewFlagMasks |= SOUND_EFFECTS_ENABLED; 1960 } 1961 break; 1962 case com.android.internal.R.styleable.View_hapticFeedbackEnabled: 1963 if (!a.getBoolean(attr, true)) { 1964 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED; 1965 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED; 1966 } 1967 break; 1968 case R.styleable.View_scrollbars: 1969 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE); 1970 if (scrollbars != SCROLLBARS_NONE) { 1971 viewFlagValues |= scrollbars; 1972 viewFlagMasks |= SCROLLBARS_MASK; 1973 initializeScrollbars(a); 1974 } 1975 break; 1976 case R.styleable.View_fadingEdge: 1977 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE); 1978 if (fadingEdge != FADING_EDGE_NONE) { 1979 viewFlagValues |= fadingEdge; 1980 viewFlagMasks |= FADING_EDGE_MASK; 1981 initializeFadingEdge(a); 1982 } 1983 break; 1984 case R.styleable.View_scrollbarStyle: 1985 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY); 1986 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 1987 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK; 1988 viewFlagMasks |= SCROLLBARS_STYLE_MASK; 1989 } 1990 break; 1991 case R.styleable.View_isScrollContainer: 1992 setScrollContainer = true; 1993 if (a.getBoolean(attr, false)) { 1994 setScrollContainer(true); 1995 } 1996 break; 1997 case com.android.internal.R.styleable.View_keepScreenOn: 1998 if (a.getBoolean(attr, false)) { 1999 viewFlagValues |= KEEP_SCREEN_ON; 2000 viewFlagMasks |= KEEP_SCREEN_ON; 2001 } 2002 break; 2003 case R.styleable.View_nextFocusLeft: 2004 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID); 2005 break; 2006 case R.styleable.View_nextFocusRight: 2007 mNextFocusRightId = a.getResourceId(attr, View.NO_ID); 2008 break; 2009 case R.styleable.View_nextFocusUp: 2010 mNextFocusUpId = a.getResourceId(attr, View.NO_ID); 2011 break; 2012 case R.styleable.View_nextFocusDown: 2013 mNextFocusDownId = a.getResourceId(attr, View.NO_ID); 2014 break; 2015 case R.styleable.View_minWidth: 2016 mMinWidth = a.getDimensionPixelSize(attr, 0); 2017 break; 2018 case R.styleable.View_minHeight: 2019 mMinHeight = a.getDimensionPixelSize(attr, 0); 2020 break; 2021 case R.styleable.View_onClick: 2022 if (context.isRestricted()) { 2023 throw new IllegalStateException("The android:onClick attribute cannot " 2024 + "be used within a restricted context"); 2025 } 2026 2027 final String handlerName = a.getString(attr); 2028 if (handlerName != null) { 2029 setOnClickListener(new OnClickListener() { 2030 private Method mHandler; 2031 2032 public void onClick(View v) { 2033 if (mHandler == null) { 2034 try { 2035 mHandler = getContext().getClass().getMethod(handlerName, 2036 View.class); 2037 } catch (NoSuchMethodException e) { 2038 throw new IllegalStateException("Could not find a method " + 2039 handlerName + "(View) in the activity", e); 2040 } 2041 } 2042 2043 try { 2044 mHandler.invoke(getContext(), View.this); 2045 } catch (IllegalAccessException e) { 2046 throw new IllegalStateException("Could not execute non " 2047 + "public method of the activity", e); 2048 } catch (InvocationTargetException e) { 2049 throw new IllegalStateException("Could not execute " 2050 + "method of the activity", e); 2051 } 2052 } 2053 }); 2054 } 2055 break; 2056 } 2057 } 2058 2059 if (background != null) { 2060 setBackgroundDrawable(background); 2061 } 2062 2063 if (padding >= 0) { 2064 leftPadding = padding; 2065 topPadding = padding; 2066 rightPadding = padding; 2067 bottomPadding = padding; 2068 } 2069 2070 // If the user specified the padding (either with android:padding or 2071 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise 2072 // use the default padding or the padding from the background drawable 2073 // (stored at this point in mPadding*) 2074 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft, 2075 topPadding >= 0 ? topPadding : mPaddingTop, 2076 rightPadding >= 0 ? rightPadding : mPaddingRight, 2077 bottomPadding >= 0 ? bottomPadding : mPaddingBottom); 2078 2079 if (viewFlagMasks != 0) { 2080 setFlags(viewFlagValues, viewFlagMasks); 2081 } 2082 2083 // Needs to be called after mViewFlags is set 2084 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) { 2085 recomputePadding(); 2086 } 2087 2088 if (x != 0 || y != 0) { 2089 scrollTo(x, y); 2090 } 2091 2092 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) { 2093 setScrollContainer(true); 2094 } 2095 2096 computeOpaqueFlags(); 2097 2098 a.recycle(); 2099 } 2100 2101 /** 2102 * Non-public constructor for use in testing 2103 */ 2104 View() { 2105 } 2106 2107 @Override 2108 protected void finalize() throws Throwable { 2109 super.finalize(); 2110 --sInstanceCount; 2111 } 2112 2113 /** 2114 * <p> 2115 * Initializes the fading edges from a given set of styled attributes. This 2116 * method should be called by subclasses that need fading edges and when an 2117 * instance of these subclasses is created programmatically rather than 2118 * being inflated from XML. This method is automatically called when the XML 2119 * is inflated. 2120 * </p> 2121 * 2122 * @param a the styled attributes set to initialize the fading edges from 2123 */ 2124 protected void initializeFadingEdge(TypedArray a) { 2125 initScrollCache(); 2126 2127 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize( 2128 R.styleable.View_fadingEdgeLength, 2129 ViewConfiguration.get(mContext).getScaledFadingEdgeLength()); 2130 } 2131 2132 /** 2133 * Returns the size of the vertical faded edges used to indicate that more 2134 * content in this view is visible. 2135 * 2136 * @return The size in pixels of the vertical faded edge or 0 if vertical 2137 * faded edges are not enabled for this view. 2138 * @attr ref android.R.styleable#View_fadingEdgeLength 2139 */ 2140 public int getVerticalFadingEdgeLength() { 2141 if (isVerticalFadingEdgeEnabled()) { 2142 ScrollabilityCache cache = mScrollCache; 2143 if (cache != null) { 2144 return cache.fadingEdgeLength; 2145 } 2146 } 2147 return 0; 2148 } 2149 2150 /** 2151 * Set the size of the faded edge used to indicate that more content in this 2152 * view is available. Will not change whether the fading edge is enabled; use 2153 * {@link #setVerticalFadingEdgeEnabled} or {@link #setHorizontalFadingEdgeEnabled} 2154 * to enable the fading edge for the vertical or horizontal fading edges. 2155 * 2156 * @param length The size in pixels of the faded edge used to indicate that more 2157 * content in this view is visible. 2158 */ 2159 public void setFadingEdgeLength(int length) { 2160 initScrollCache(); 2161 mScrollCache.fadingEdgeLength = length; 2162 } 2163 2164 /** 2165 * Returns the size of the horizontal faded edges used to indicate that more 2166 * content in this view is visible. 2167 * 2168 * @return The size in pixels of the horizontal faded edge or 0 if horizontal 2169 * faded edges are not enabled for this view. 2170 * @attr ref android.R.styleable#View_fadingEdgeLength 2171 */ 2172 public int getHorizontalFadingEdgeLength() { 2173 if (isHorizontalFadingEdgeEnabled()) { 2174 ScrollabilityCache cache = mScrollCache; 2175 if (cache != null) { 2176 return cache.fadingEdgeLength; 2177 } 2178 } 2179 return 0; 2180 } 2181 2182 /** 2183 * Returns the width of the vertical scrollbar. 2184 * 2185 * @return The width in pixels of the vertical scrollbar or 0 if there 2186 * is no vertical scrollbar. 2187 */ 2188 public int getVerticalScrollbarWidth() { 2189 ScrollabilityCache cache = mScrollCache; 2190 if (cache != null) { 2191 ScrollBarDrawable scrollBar = cache.scrollBar; 2192 if (scrollBar != null) { 2193 int size = scrollBar.getSize(true); 2194 if (size <= 0) { 2195 size = cache.scrollBarSize; 2196 } 2197 return size; 2198 } 2199 return 0; 2200 } 2201 return 0; 2202 } 2203 2204 /** 2205 * Returns the height of the horizontal scrollbar. 2206 * 2207 * @return The height in pixels of the horizontal scrollbar or 0 if 2208 * there is no horizontal scrollbar. 2209 */ 2210 protected int getHorizontalScrollbarHeight() { 2211 ScrollabilityCache cache = mScrollCache; 2212 if (cache != null) { 2213 ScrollBarDrawable scrollBar = cache.scrollBar; 2214 if (scrollBar != null) { 2215 int size = scrollBar.getSize(false); 2216 if (size <= 0) { 2217 size = cache.scrollBarSize; 2218 } 2219 return size; 2220 } 2221 return 0; 2222 } 2223 return 0; 2224 } 2225 2226 /** 2227 * <p> 2228 * Initializes the scrollbars from a given set of styled attributes. This 2229 * method should be called by subclasses that need scrollbars and when an 2230 * instance of these subclasses is created programmatically rather than 2231 * being inflated from XML. This method is automatically called when the XML 2232 * is inflated. 2233 * </p> 2234 * 2235 * @param a the styled attributes set to initialize the scrollbars from 2236 */ 2237 protected void initializeScrollbars(TypedArray a) { 2238 initScrollCache(); 2239 2240 final ScrollabilityCache scrollabilityCache = mScrollCache; 2241 2242 if (scrollabilityCache.scrollBar == null) { 2243 scrollabilityCache.scrollBar = new ScrollBarDrawable(); 2244 } 2245 2246 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, false); 2247 2248 if (!fadeScrollbars) { 2249 scrollabilityCache.state = ScrollabilityCache.ON; 2250 } 2251 scrollabilityCache.fadeScrollBars = fadeScrollbars; 2252 2253 2254 scrollabilityCache.scrollBarFadeDuration = a.getInt( 2255 R.styleable.View_scrollbarFadeDuration, ViewConfiguration 2256 .getScrollBarFadeDuration()); 2257 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt( 2258 R.styleable.View_scrollbarDefaultDelayBeforeFade, 2259 ViewConfiguration.getScrollDefaultDelay()); 2260 2261 2262 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize( 2263 com.android.internal.R.styleable.View_scrollbarSize, 2264 ViewConfiguration.get(mContext).getScaledScrollBarSize()); 2265 2266 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal); 2267 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track); 2268 2269 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal); 2270 if (thumb != null) { 2271 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb); 2272 } 2273 2274 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack, 2275 false); 2276 if (alwaysDraw) { 2277 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true); 2278 } 2279 2280 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical); 2281 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track); 2282 2283 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical); 2284 if (thumb != null) { 2285 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb); 2286 } 2287 2288 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack, 2289 false); 2290 if (alwaysDraw) { 2291 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true); 2292 } 2293 2294 // Re-apply user/background padding so that scrollbar(s) get added 2295 recomputePadding(); 2296 } 2297 2298 /** 2299 * <p> 2300 * Initalizes the scrollability cache if necessary. 2301 * </p> 2302 */ 2303 private void initScrollCache() { 2304 if (mScrollCache == null) { 2305 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this); 2306 } 2307 } 2308 2309 /** 2310 * Register a callback to be invoked when focus of this view changed. 2311 * 2312 * @param l The callback that will run. 2313 */ 2314 public void setOnFocusChangeListener(OnFocusChangeListener l) { 2315 mOnFocusChangeListener = l; 2316 } 2317 2318 /** 2319 * Returns the focus-change callback registered for this view. 2320 * 2321 * @return The callback, or null if one is not registered. 2322 */ 2323 public OnFocusChangeListener getOnFocusChangeListener() { 2324 return mOnFocusChangeListener; 2325 } 2326 2327 /** 2328 * Register a callback to be invoked when this view is clicked. If this view is not 2329 * clickable, it becomes clickable. 2330 * 2331 * @param l The callback that will run 2332 * 2333 * @see #setClickable(boolean) 2334 */ 2335 public void setOnClickListener(OnClickListener l) { 2336 if (!isClickable()) { 2337 setClickable(true); 2338 } 2339 mOnClickListener = l; 2340 } 2341 2342 /** 2343 * Register a callback to be invoked when this view is clicked and held. If this view is not 2344 * long clickable, it becomes long clickable. 2345 * 2346 * @param l The callback that will run 2347 * 2348 * @see #setLongClickable(boolean) 2349 */ 2350 public void setOnLongClickListener(OnLongClickListener l) { 2351 if (!isLongClickable()) { 2352 setLongClickable(true); 2353 } 2354 mOnLongClickListener = l; 2355 } 2356 2357 /** 2358 * Register a callback to be invoked when the context menu for this view is 2359 * being built. If this view is not long clickable, it becomes long clickable. 2360 * 2361 * @param l The callback that will run 2362 * 2363 */ 2364 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) { 2365 if (!isLongClickable()) { 2366 setLongClickable(true); 2367 } 2368 mOnCreateContextMenuListener = l; 2369 } 2370 2371 /** 2372 * Call this view's OnClickListener, if it is defined. 2373 * 2374 * @return True there was an assigned OnClickListener that was called, false 2375 * otherwise is returned. 2376 */ 2377 public boolean performClick() { 2378 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED); 2379 2380 if (mOnClickListener != null) { 2381 playSoundEffect(SoundEffectConstants.CLICK); 2382 mOnClickListener.onClick(this); 2383 return true; 2384 } 2385 2386 return false; 2387 } 2388 2389 /** 2390 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu 2391 * if the OnLongClickListener did not consume the event. 2392 * 2393 * @return True there was an assigned OnLongClickListener that was called, false 2394 * otherwise is returned. 2395 */ 2396 public boolean performLongClick() { 2397 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED); 2398 2399 boolean handled = false; 2400 if (mOnLongClickListener != null) { 2401 handled = mOnLongClickListener.onLongClick(View.this); 2402 } 2403 if (!handled) { 2404 handled = showContextMenu(); 2405 } 2406 if (handled) { 2407 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS); 2408 } 2409 return handled; 2410 } 2411 2412 /** 2413 * Bring up the context menu for this view. 2414 * 2415 * @return Whether a context menu was displayed. 2416 */ 2417 public boolean showContextMenu() { 2418 return getParent().showContextMenuForChild(this); 2419 } 2420 2421 /** 2422 * Register a callback to be invoked when a key is pressed in this view. 2423 * @param l the key listener to attach to this view 2424 */ 2425 public void setOnKeyListener(OnKeyListener l) { 2426 mOnKeyListener = l; 2427 } 2428 2429 /** 2430 * Register a callback to be invoked when a touch event is sent to this view. 2431 * @param l the touch listener to attach to this view 2432 */ 2433 public void setOnTouchListener(OnTouchListener l) { 2434 mOnTouchListener = l; 2435 } 2436 2437 /** 2438 * Give this view focus. This will cause {@link #onFocusChanged} to be called. 2439 * 2440 * Note: this does not check whether this {@link View} should get focus, it just 2441 * gives it focus no matter what. It should only be called internally by framework 2442 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}. 2443 * 2444 * @param direction values are View.FOCUS_UP, View.FOCUS_DOWN, 2445 * View.FOCUS_LEFT or View.FOCUS_RIGHT. This is the direction which 2446 * focus moved when requestFocus() is called. It may not always 2447 * apply, in which case use the default View.FOCUS_DOWN. 2448 * @param previouslyFocusedRect The rectangle of the view that had focus 2449 * prior in this View's coordinate system. 2450 */ 2451 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) { 2452 if (DBG) { 2453 System.out.println(this + " requestFocus()"); 2454 } 2455 2456 if ((mPrivateFlags & FOCUSED) == 0) { 2457 mPrivateFlags |= FOCUSED; 2458 2459 if (mParent != null) { 2460 mParent.requestChildFocus(this, this); 2461 } 2462 2463 onFocusChanged(true, direction, previouslyFocusedRect); 2464 refreshDrawableState(); 2465 } 2466 } 2467 2468 /** 2469 * Request that a rectangle of this view be visible on the screen, 2470 * scrolling if necessary just enough. 2471 * 2472 * <p>A View should call this if it maintains some notion of which part 2473 * of its content is interesting. For example, a text editing view 2474 * should call this when its cursor moves. 2475 * 2476 * @param rectangle The rectangle. 2477 * @return Whether any parent scrolled. 2478 */ 2479 public boolean requestRectangleOnScreen(Rect rectangle) { 2480 return requestRectangleOnScreen(rectangle, false); 2481 } 2482 2483 /** 2484 * Request that a rectangle of this view be visible on the screen, 2485 * scrolling if necessary just enough. 2486 * 2487 * <p>A View should call this if it maintains some notion of which part 2488 * of its content is interesting. For example, a text editing view 2489 * should call this when its cursor moves. 2490 * 2491 * <p>When <code>immediate</code> is set to true, scrolling will not be 2492 * animated. 2493 * 2494 * @param rectangle The rectangle. 2495 * @param immediate True to forbid animated scrolling, false otherwise 2496 * @return Whether any parent scrolled. 2497 */ 2498 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) { 2499 View child = this; 2500 ViewParent parent = mParent; 2501 boolean scrolled = false; 2502 while (parent != null) { 2503 scrolled |= parent.requestChildRectangleOnScreen(child, 2504 rectangle, immediate); 2505 2506 // offset rect so next call has the rectangle in the 2507 // coordinate system of its direct child. 2508 rectangle.offset(child.getLeft(), child.getTop()); 2509 rectangle.offset(-child.getScrollX(), -child.getScrollY()); 2510 2511 if (!(parent instanceof View)) { 2512 break; 2513 } 2514 2515 child = (View) parent; 2516 parent = child.getParent(); 2517 } 2518 return scrolled; 2519 } 2520 2521 /** 2522 * Called when this view wants to give up focus. This will cause 2523 * {@link #onFocusChanged} to be called. 2524 */ 2525 public void clearFocus() { 2526 if (DBG) { 2527 System.out.println(this + " clearFocus()"); 2528 } 2529 2530 if ((mPrivateFlags & FOCUSED) != 0) { 2531 mPrivateFlags &= ~FOCUSED; 2532 2533 if (mParent != null) { 2534 mParent.clearChildFocus(this); 2535 } 2536 2537 onFocusChanged(false, 0, null); 2538 refreshDrawableState(); 2539 } 2540 } 2541 2542 /** 2543 * Called to clear the focus of a view that is about to be removed. 2544 * Doesn't call clearChildFocus, which prevents this view from taking 2545 * focus again before it has been removed from the parent 2546 */ 2547 void clearFocusForRemoval() { 2548 if ((mPrivateFlags & FOCUSED) != 0) { 2549 mPrivateFlags &= ~FOCUSED; 2550 2551 onFocusChanged(false, 0, null); 2552 refreshDrawableState(); 2553 } 2554 } 2555 2556 /** 2557 * Called internally by the view system when a new view is getting focus. 2558 * This is what clears the old focus. 2559 */ 2560 void unFocus() { 2561 if (DBG) { 2562 System.out.println(this + " unFocus()"); 2563 } 2564 2565 if ((mPrivateFlags & FOCUSED) != 0) { 2566 mPrivateFlags &= ~FOCUSED; 2567 2568 onFocusChanged(false, 0, null); 2569 refreshDrawableState(); 2570 } 2571 } 2572 2573 /** 2574 * Returns true if this view has focus iteself, or is the ancestor of the 2575 * view that has focus. 2576 * 2577 * @return True if this view has or contains focus, false otherwise. 2578 */ 2579 @ViewDebug.ExportedProperty 2580 public boolean hasFocus() { 2581 return (mPrivateFlags & FOCUSED) != 0; 2582 } 2583 2584 /** 2585 * Returns true if this view is focusable or if it contains a reachable View 2586 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()" 2587 * is a View whose parents do not block descendants focus. 2588 * 2589 * Only {@link #VISIBLE} views are considered focusable. 2590 * 2591 * @return True if the view is focusable or if the view contains a focusable 2592 * View, false otherwise. 2593 * 2594 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS 2595 */ 2596 public boolean hasFocusable() { 2597 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable(); 2598 } 2599 2600 /** 2601 * Called by the view system when the focus state of this view changes. 2602 * When the focus change event is caused by directional navigation, direction 2603 * and previouslyFocusedRect provide insight into where the focus is coming from. 2604 * When overriding, be sure to call up through to the super class so that 2605 * the standard focus handling will occur. 2606 * 2607 * @param gainFocus True if the View has focus; false otherwise. 2608 * @param direction The direction focus has moved when requestFocus() 2609 * is called to give this view focus. Values are 2610 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT} or 2611 * {@link #FOCUS_RIGHT}. It may not always apply, in which 2612 * case use the default. 2613 * @param previouslyFocusedRect The rectangle, in this view's coordinate 2614 * system, of the previously focused view. If applicable, this will be 2615 * passed in as finer grained information about where the focus is coming 2616 * from (in addition to direction). Will be <code>null</code> otherwise. 2617 */ 2618 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) { 2619 if (gainFocus) { 2620 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED); 2621 } 2622 2623 InputMethodManager imm = InputMethodManager.peekInstance(); 2624 if (!gainFocus) { 2625 if (isPressed()) { 2626 setPressed(false); 2627 } 2628 if (imm != null && mAttachInfo != null 2629 && mAttachInfo.mHasWindowFocus) { 2630 imm.focusOut(this); 2631 } 2632 onFocusLost(); 2633 } else if (imm != null && mAttachInfo != null 2634 && mAttachInfo.mHasWindowFocus) { 2635 imm.focusIn(this); 2636 } 2637 2638 invalidate(); 2639 if (mOnFocusChangeListener != null) { 2640 mOnFocusChangeListener.onFocusChange(this, gainFocus); 2641 } 2642 2643 if (mAttachInfo != null) { 2644 mAttachInfo.mKeyDispatchState.reset(this); 2645 } 2646 } 2647 2648 /** 2649 * {@inheritDoc} 2650 */ 2651 public void sendAccessibilityEvent(int eventType) { 2652 if (AccessibilityManager.getInstance(mContext).isEnabled()) { 2653 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType)); 2654 } 2655 } 2656 2657 /** 2658 * {@inheritDoc} 2659 */ 2660 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) { 2661 event.setClassName(getClass().getName()); 2662 event.setPackageName(getContext().getPackageName()); 2663 event.setEnabled(isEnabled()); 2664 event.setContentDescription(mContentDescription); 2665 2666 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) { 2667 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList; 2668 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, FOCUSABLES_ALL); 2669 event.setItemCount(focusablesTempList.size()); 2670 event.setCurrentItemIndex(focusablesTempList.indexOf(this)); 2671 focusablesTempList.clear(); 2672 } 2673 2674 dispatchPopulateAccessibilityEvent(event); 2675 2676 AccessibilityManager.getInstance(mContext).sendAccessibilityEvent(event); 2677 } 2678 2679 /** 2680 * Dispatches an {@link AccessibilityEvent} to the {@link View} children 2681 * to be populated. 2682 * 2683 * @param event The event. 2684 * 2685 * @return True if the event population was completed. 2686 */ 2687 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) { 2688 return false; 2689 } 2690 2691 /** 2692 * Gets the {@link View} description. It briefly describes the view and is 2693 * primarily used for accessibility support. Set this property to enable 2694 * better accessibility support for your application. This is especially 2695 * true for views that do not have textual representation (For example, 2696 * ImageButton). 2697 * 2698 * @return The content descriptiopn. 2699 * 2700 * @attr ref android.R.styleable#View_contentDescription 2701 */ 2702 public CharSequence getContentDescription() { 2703 return mContentDescription; 2704 } 2705 2706 /** 2707 * Sets the {@link View} description. It briefly describes the view and is 2708 * primarily used for accessibility support. Set this property to enable 2709 * better accessibility support for your application. This is especially 2710 * true for views that do not have textual representation (For example, 2711 * ImageButton). 2712 * 2713 * @param contentDescription The content description. 2714 * 2715 * @attr ref android.R.styleable#View_contentDescription 2716 */ 2717 public void setContentDescription(CharSequence contentDescription) { 2718 mContentDescription = contentDescription; 2719 } 2720 2721 /** 2722 * Invoked whenever this view loses focus, either by losing window focus or by losing 2723 * focus within its window. This method can be used to clear any state tied to the 2724 * focus. For instance, if a button is held pressed with the trackball and the window 2725 * loses focus, this method can be used to cancel the press. 2726 * 2727 * Subclasses of View overriding this method should always call super.onFocusLost(). 2728 * 2729 * @see #onFocusChanged(boolean, int, android.graphics.Rect) 2730 * @see #onWindowFocusChanged(boolean) 2731 * 2732 * @hide pending API council approval 2733 */ 2734 protected void onFocusLost() { 2735 resetPressedState(); 2736 } 2737 2738 private void resetPressedState() { 2739 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 2740 return; 2741 } 2742 2743 if (isPressed()) { 2744 setPressed(false); 2745 2746 if (!mHasPerformedLongPress) { 2747 removeLongPressCallback(); 2748 } 2749 } 2750 } 2751 2752 /** 2753 * Returns true if this view has focus 2754 * 2755 * @return True if this view has focus, false otherwise. 2756 */ 2757 @ViewDebug.ExportedProperty 2758 public boolean isFocused() { 2759 return (mPrivateFlags & FOCUSED) != 0; 2760 } 2761 2762 /** 2763 * Find the view in the hierarchy rooted at this view that currently has 2764 * focus. 2765 * 2766 * @return The view that currently has focus, or null if no focused view can 2767 * be found. 2768 */ 2769 public View findFocus() { 2770 return (mPrivateFlags & FOCUSED) != 0 ? this : null; 2771 } 2772 2773 /** 2774 * Change whether this view is one of the set of scrollable containers in 2775 * its window. This will be used to determine whether the window can 2776 * resize or must pan when a soft input area is open -- scrollable 2777 * containers allow the window to use resize mode since the container 2778 * will appropriately shrink. 2779 */ 2780 public void setScrollContainer(boolean isScrollContainer) { 2781 if (isScrollContainer) { 2782 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) { 2783 mAttachInfo.mScrollContainers.add(this); 2784 mPrivateFlags |= SCROLL_CONTAINER_ADDED; 2785 } 2786 mPrivateFlags |= SCROLL_CONTAINER; 2787 } else { 2788 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) { 2789 mAttachInfo.mScrollContainers.remove(this); 2790 } 2791 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED); 2792 } 2793 } 2794 2795 /** 2796 * Returns the quality of the drawing cache. 2797 * 2798 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 2799 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 2800 * 2801 * @see #setDrawingCacheQuality(int) 2802 * @see #setDrawingCacheEnabled(boolean) 2803 * @see #isDrawingCacheEnabled() 2804 * 2805 * @attr ref android.R.styleable#View_drawingCacheQuality 2806 */ 2807 public int getDrawingCacheQuality() { 2808 return mViewFlags & DRAWING_CACHE_QUALITY_MASK; 2809 } 2810 2811 /** 2812 * Set the drawing cache quality of this view. This value is used only when the 2813 * drawing cache is enabled 2814 * 2815 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO}, 2816 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH} 2817 * 2818 * @see #getDrawingCacheQuality() 2819 * @see #setDrawingCacheEnabled(boolean) 2820 * @see #isDrawingCacheEnabled() 2821 * 2822 * @attr ref android.R.styleable#View_drawingCacheQuality 2823 */ 2824 public void setDrawingCacheQuality(int quality) { 2825 setFlags(quality, DRAWING_CACHE_QUALITY_MASK); 2826 } 2827 2828 /** 2829 * Returns whether the screen should remain on, corresponding to the current 2830 * value of {@link #KEEP_SCREEN_ON}. 2831 * 2832 * @return Returns true if {@link #KEEP_SCREEN_ON} is set. 2833 * 2834 * @see #setKeepScreenOn(boolean) 2835 * 2836 * @attr ref android.R.styleable#View_keepScreenOn 2837 */ 2838 public boolean getKeepScreenOn() { 2839 return (mViewFlags & KEEP_SCREEN_ON) != 0; 2840 } 2841 2842 /** 2843 * Controls whether the screen should remain on, modifying the 2844 * value of {@link #KEEP_SCREEN_ON}. 2845 * 2846 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}. 2847 * 2848 * @see #getKeepScreenOn() 2849 * 2850 * @attr ref android.R.styleable#View_keepScreenOn 2851 */ 2852 public void setKeepScreenOn(boolean keepScreenOn) { 2853 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON); 2854 } 2855 2856 /** 2857 * @return The user specified next focus ID. 2858 * 2859 * @attr ref android.R.styleable#View_nextFocusLeft 2860 */ 2861 public int getNextFocusLeftId() { 2862 return mNextFocusLeftId; 2863 } 2864 2865 /** 2866 * Set the id of the view to use for the next focus 2867 * 2868 * @param nextFocusLeftId 2869 * 2870 * @attr ref android.R.styleable#View_nextFocusLeft 2871 */ 2872 public void setNextFocusLeftId(int nextFocusLeftId) { 2873 mNextFocusLeftId = nextFocusLeftId; 2874 } 2875 2876 /** 2877 * @return The user specified next focus ID. 2878 * 2879 * @attr ref android.R.styleable#View_nextFocusRight 2880 */ 2881 public int getNextFocusRightId() { 2882 return mNextFocusRightId; 2883 } 2884 2885 /** 2886 * Set the id of the view to use for the next focus 2887 * 2888 * @param nextFocusRightId 2889 * 2890 * @attr ref android.R.styleable#View_nextFocusRight 2891 */ 2892 public void setNextFocusRightId(int nextFocusRightId) { 2893 mNextFocusRightId = nextFocusRightId; 2894 } 2895 2896 /** 2897 * @return The user specified next focus ID. 2898 * 2899 * @attr ref android.R.styleable#View_nextFocusUp 2900 */ 2901 public int getNextFocusUpId() { 2902 return mNextFocusUpId; 2903 } 2904 2905 /** 2906 * Set the id of the view to use for the next focus 2907 * 2908 * @param nextFocusUpId 2909 * 2910 * @attr ref android.R.styleable#View_nextFocusUp 2911 */ 2912 public void setNextFocusUpId(int nextFocusUpId) { 2913 mNextFocusUpId = nextFocusUpId; 2914 } 2915 2916 /** 2917 * @return The user specified next focus ID. 2918 * 2919 * @attr ref android.R.styleable#View_nextFocusDown 2920 */ 2921 public int getNextFocusDownId() { 2922 return mNextFocusDownId; 2923 } 2924 2925 /** 2926 * Set the id of the view to use for the next focus 2927 * 2928 * @param nextFocusDownId 2929 * 2930 * @attr ref android.R.styleable#View_nextFocusDown 2931 */ 2932 public void setNextFocusDownId(int nextFocusDownId) { 2933 mNextFocusDownId = nextFocusDownId; 2934 } 2935 2936 /** 2937 * Returns the visibility of this view and all of its ancestors 2938 * 2939 * @return True if this view and all of its ancestors are {@link #VISIBLE} 2940 */ 2941 public boolean isShown() { 2942 View current = this; 2943 //noinspection ConstantConditions 2944 do { 2945 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) { 2946 return false; 2947 } 2948 ViewParent parent = current.mParent; 2949 if (parent == null) { 2950 return false; // We are not attached to the view root 2951 } 2952 if (!(parent instanceof View)) { 2953 return true; 2954 } 2955 current = (View) parent; 2956 } while (current != null); 2957 2958 return false; 2959 } 2960 2961 /** 2962 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag 2963 * is set 2964 * 2965 * @param insets Insets for system windows 2966 * 2967 * @return True if this view applied the insets, false otherwise 2968 */ 2969 protected boolean fitSystemWindows(Rect insets) { 2970 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) { 2971 mPaddingLeft = insets.left; 2972 mPaddingTop = insets.top; 2973 mPaddingRight = insets.right; 2974 mPaddingBottom = insets.bottom; 2975 requestLayout(); 2976 return true; 2977 } 2978 return false; 2979 } 2980 2981 /** 2982 * Returns the visibility status for this view. 2983 * 2984 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 2985 * @attr ref android.R.styleable#View_visibility 2986 */ 2987 @ViewDebug.ExportedProperty(mapping = { 2988 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"), 2989 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"), 2990 @ViewDebug.IntToString(from = GONE, to = "GONE") 2991 }) 2992 public int getVisibility() { 2993 return mViewFlags & VISIBILITY_MASK; 2994 } 2995 2996 /** 2997 * Set the enabled state of this view. 2998 * 2999 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}. 3000 * @attr ref android.R.styleable#View_visibility 3001 */ 3002 @RemotableViewMethod 3003 public void setVisibility(int visibility) { 3004 setFlags(visibility, VISIBILITY_MASK); 3005 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false); 3006 } 3007 3008 /** 3009 * Returns the enabled status for this view. The interpretation of the 3010 * enabled state varies by subclass. 3011 * 3012 * @return True if this view is enabled, false otherwise. 3013 */ 3014 @ViewDebug.ExportedProperty 3015 public boolean isEnabled() { 3016 return (mViewFlags & ENABLED_MASK) == ENABLED; 3017 } 3018 3019 /** 3020 * Set the enabled state of this view. The interpretation of the enabled 3021 * state varies by subclass. 3022 * 3023 * @param enabled True if this view is enabled, false otherwise. 3024 */ 3025 public void setEnabled(boolean enabled) { 3026 if (enabled == isEnabled()) return; 3027 3028 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK); 3029 3030 /* 3031 * The View most likely has to change its appearance, so refresh 3032 * the drawable state. 3033 */ 3034 refreshDrawableState(); 3035 3036 // Invalidate too, since the default behavior for views is to be 3037 // be drawn at 50% alpha rather than to change the drawable. 3038 invalidate(); 3039 } 3040 3041 /** 3042 * Set whether this view can receive the focus. 3043 * 3044 * Setting this to false will also ensure that this view is not focusable 3045 * in touch mode. 3046 * 3047 * @param focusable If true, this view can receive the focus. 3048 * 3049 * @see #setFocusableInTouchMode(boolean) 3050 * @attr ref android.R.styleable#View_focusable 3051 */ 3052 public void setFocusable(boolean focusable) { 3053 if (!focusable) { 3054 setFlags(0, FOCUSABLE_IN_TOUCH_MODE); 3055 } 3056 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK); 3057 } 3058 3059 /** 3060 * Set whether this view can receive focus while in touch mode. 3061 * 3062 * Setting this to true will also ensure that this view is focusable. 3063 * 3064 * @param focusableInTouchMode If true, this view can receive the focus while 3065 * in touch mode. 3066 * 3067 * @see #setFocusable(boolean) 3068 * @attr ref android.R.styleable#View_focusableInTouchMode 3069 */ 3070 public void setFocusableInTouchMode(boolean focusableInTouchMode) { 3071 // Focusable in touch mode should always be set before the focusable flag 3072 // otherwise, setting the focusable flag will trigger a focusableViewAvailable() 3073 // which, in touch mode, will not successfully request focus on this view 3074 // because the focusable in touch mode flag is not set 3075 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE); 3076 if (focusableInTouchMode) { 3077 setFlags(FOCUSABLE, FOCUSABLE_MASK); 3078 } 3079 } 3080 3081 /** 3082 * Set whether this view should have sound effects enabled for events such as 3083 * clicking and touching. 3084 * 3085 * <p>You may wish to disable sound effects for a view if you already play sounds, 3086 * for instance, a dial key that plays dtmf tones. 3087 * 3088 * @param soundEffectsEnabled whether sound effects are enabled for this view. 3089 * @see #isSoundEffectsEnabled() 3090 * @see #playSoundEffect(int) 3091 * @attr ref android.R.styleable#View_soundEffectsEnabled 3092 */ 3093 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) { 3094 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED); 3095 } 3096 3097 /** 3098 * @return whether this view should have sound effects enabled for events such as 3099 * clicking and touching. 3100 * 3101 * @see #setSoundEffectsEnabled(boolean) 3102 * @see #playSoundEffect(int) 3103 * @attr ref android.R.styleable#View_soundEffectsEnabled 3104 */ 3105 @ViewDebug.ExportedProperty 3106 public boolean isSoundEffectsEnabled() { 3107 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED); 3108 } 3109 3110 /** 3111 * Set whether this view should have haptic feedback for events such as 3112 * long presses. 3113 * 3114 * <p>You may wish to disable haptic feedback if your view already controls 3115 * its own haptic feedback. 3116 * 3117 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view. 3118 * @see #isHapticFeedbackEnabled() 3119 * @see #performHapticFeedback(int) 3120 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 3121 */ 3122 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) { 3123 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED); 3124 } 3125 3126 /** 3127 * @return whether this view should have haptic feedback enabled for events 3128 * long presses. 3129 * 3130 * @see #setHapticFeedbackEnabled(boolean) 3131 * @see #performHapticFeedback(int) 3132 * @attr ref android.R.styleable#View_hapticFeedbackEnabled 3133 */ 3134 @ViewDebug.ExportedProperty 3135 public boolean isHapticFeedbackEnabled() { 3136 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED); 3137 } 3138 3139 /** 3140 * If this view doesn't do any drawing on its own, set this flag to 3141 * allow further optimizations. By default, this flag is not set on 3142 * View, but could be set on some View subclasses such as ViewGroup. 3143 * 3144 * Typically, if you override {@link #onDraw} you should clear this flag. 3145 * 3146 * @param willNotDraw whether or not this View draw on its own 3147 */ 3148 public void setWillNotDraw(boolean willNotDraw) { 3149 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK); 3150 } 3151 3152 /** 3153 * Returns whether or not this View draws on its own. 3154 * 3155 * @return true if this view has nothing to draw, false otherwise 3156 */ 3157 @ViewDebug.ExportedProperty 3158 public boolean willNotDraw() { 3159 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW; 3160 } 3161 3162 /** 3163 * When a View's drawing cache is enabled, drawing is redirected to an 3164 * offscreen bitmap. Some views, like an ImageView, must be able to 3165 * bypass this mechanism if they already draw a single bitmap, to avoid 3166 * unnecessary usage of the memory. 3167 * 3168 * @param willNotCacheDrawing true if this view does not cache its 3169 * drawing, false otherwise 3170 */ 3171 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) { 3172 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING); 3173 } 3174 3175 /** 3176 * Returns whether or not this View can cache its drawing or not. 3177 * 3178 * @return true if this view does not cache its drawing, false otherwise 3179 */ 3180 @ViewDebug.ExportedProperty 3181 public boolean willNotCacheDrawing() { 3182 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING; 3183 } 3184 3185 /** 3186 * Indicates whether this view reacts to click events or not. 3187 * 3188 * @return true if the view is clickable, false otherwise 3189 * 3190 * @see #setClickable(boolean) 3191 * @attr ref android.R.styleable#View_clickable 3192 */ 3193 @ViewDebug.ExportedProperty 3194 public boolean isClickable() { 3195 return (mViewFlags & CLICKABLE) == CLICKABLE; 3196 } 3197 3198 /** 3199 * Enables or disables click events for this view. When a view 3200 * is clickable it will change its state to "pressed" on every click. 3201 * Subclasses should set the view clickable to visually react to 3202 * user's clicks. 3203 * 3204 * @param clickable true to make the view clickable, false otherwise 3205 * 3206 * @see #isClickable() 3207 * @attr ref android.R.styleable#View_clickable 3208 */ 3209 public void setClickable(boolean clickable) { 3210 setFlags(clickable ? CLICKABLE : 0, CLICKABLE); 3211 } 3212 3213 /** 3214 * Indicates whether this view reacts to long click events or not. 3215 * 3216 * @return true if the view is long clickable, false otherwise 3217 * 3218 * @see #setLongClickable(boolean) 3219 * @attr ref android.R.styleable#View_longClickable 3220 */ 3221 public boolean isLongClickable() { 3222 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE; 3223 } 3224 3225 /** 3226 * Enables or disables long click events for this view. When a view is long 3227 * clickable it reacts to the user holding down the button for a longer 3228 * duration than a tap. This event can either launch the listener or a 3229 * context menu. 3230 * 3231 * @param longClickable true to make the view long clickable, false otherwise 3232 * @see #isLongClickable() 3233 * @attr ref android.R.styleable#View_longClickable 3234 */ 3235 public void setLongClickable(boolean longClickable) { 3236 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE); 3237 } 3238 3239 /** 3240 * Sets the pressed that for this view. 3241 * 3242 * @see #isClickable() 3243 * @see #setClickable(boolean) 3244 * 3245 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts 3246 * the View's internal state from a previously set "pressed" state. 3247 */ 3248 public void setPressed(boolean pressed) { 3249 if (pressed) { 3250 mPrivateFlags |= PRESSED; 3251 } else { 3252 mPrivateFlags &= ~PRESSED; 3253 } 3254 refreshDrawableState(); 3255 dispatchSetPressed(pressed); 3256 } 3257 3258 /** 3259 * Dispatch setPressed to all of this View's children. 3260 * 3261 * @see #setPressed(boolean) 3262 * 3263 * @param pressed The new pressed state 3264 */ 3265 protected void dispatchSetPressed(boolean pressed) { 3266 } 3267 3268 /** 3269 * Indicates whether the view is currently in pressed state. Unless 3270 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter 3271 * the pressed state. 3272 * 3273 * @see #setPressed 3274 * @see #isClickable() 3275 * @see #setClickable(boolean) 3276 * 3277 * @return true if the view is currently pressed, false otherwise 3278 */ 3279 public boolean isPressed() { 3280 return (mPrivateFlags & PRESSED) == PRESSED; 3281 } 3282 3283 /** 3284 * Indicates whether this view will save its state (that is, 3285 * whether its {@link #onSaveInstanceState} method will be called). 3286 * 3287 * @return Returns true if the view state saving is enabled, else false. 3288 * 3289 * @see #setSaveEnabled(boolean) 3290 * @attr ref android.R.styleable#View_saveEnabled 3291 */ 3292 public boolean isSaveEnabled() { 3293 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED; 3294 } 3295 3296 /** 3297 * Controls whether the saving of this view's state is 3298 * enabled (that is, whether its {@link #onSaveInstanceState} method 3299 * will be called). Note that even if freezing is enabled, the 3300 * view still must have an id assigned to it (via {@link #setId setId()}) 3301 * for its state to be saved. This flag can only disable the 3302 * saving of this view; any child views may still have their state saved. 3303 * 3304 * @param enabled Set to false to <em>disable</em> state saving, or true 3305 * (the default) to allow it. 3306 * 3307 * @see #isSaveEnabled() 3308 * @see #setId(int) 3309 * @see #onSaveInstanceState() 3310 * @attr ref android.R.styleable#View_saveEnabled 3311 */ 3312 public void setSaveEnabled(boolean enabled) { 3313 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK); 3314 } 3315 3316 3317 /** 3318 * Returns whether this View is able to take focus. 3319 * 3320 * @return True if this view can take focus, or false otherwise. 3321 * @attr ref android.R.styleable#View_focusable 3322 */ 3323 @ViewDebug.ExportedProperty 3324 public final boolean isFocusable() { 3325 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK); 3326 } 3327 3328 /** 3329 * When a view is focusable, it may not want to take focus when in touch mode. 3330 * For example, a button would like focus when the user is navigating via a D-pad 3331 * so that the user can click on it, but once the user starts touching the screen, 3332 * the button shouldn't take focus 3333 * @return Whether the view is focusable in touch mode. 3334 * @attr ref android.R.styleable#View_focusableInTouchMode 3335 */ 3336 @ViewDebug.ExportedProperty 3337 public final boolean isFocusableInTouchMode() { 3338 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE); 3339 } 3340 3341 /** 3342 * Find the nearest view in the specified direction that can take focus. 3343 * This does not actually give focus to that view. 3344 * 3345 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 3346 * 3347 * @return The nearest focusable in the specified direction, or null if none 3348 * can be found. 3349 */ 3350 public View focusSearch(int direction) { 3351 if (mParent != null) { 3352 return mParent.focusSearch(this, direction); 3353 } else { 3354 return null; 3355 } 3356 } 3357 3358 /** 3359 * This method is the last chance for the focused view and its ancestors to 3360 * respond to an arrow key. This is called when the focused view did not 3361 * consume the key internally, nor could the view system find a new view in 3362 * the requested direction to give focus to. 3363 * 3364 * @param focused The currently focused view. 3365 * @param direction The direction focus wants to move. One of FOCUS_UP, 3366 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT. 3367 * @return True if the this view consumed this unhandled move. 3368 */ 3369 public boolean dispatchUnhandledMove(View focused, int direction) { 3370 return false; 3371 } 3372 3373 /** 3374 * If a user manually specified the next view id for a particular direction, 3375 * use the root to look up the view. Once a view is found, it is cached 3376 * for future lookups. 3377 * @param root The root view of the hierarchy containing this view. 3378 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 3379 * @return The user specified next view, or null if there is none. 3380 */ 3381 View findUserSetNextFocus(View root, int direction) { 3382 switch (direction) { 3383 case FOCUS_LEFT: 3384 if (mNextFocusLeftId == View.NO_ID) return null; 3385 return findViewShouldExist(root, mNextFocusLeftId); 3386 case FOCUS_RIGHT: 3387 if (mNextFocusRightId == View.NO_ID) return null; 3388 return findViewShouldExist(root, mNextFocusRightId); 3389 case FOCUS_UP: 3390 if (mNextFocusUpId == View.NO_ID) return null; 3391 return findViewShouldExist(root, mNextFocusUpId); 3392 case FOCUS_DOWN: 3393 if (mNextFocusDownId == View.NO_ID) return null; 3394 return findViewShouldExist(root, mNextFocusDownId); 3395 } 3396 return null; 3397 } 3398 3399 private static View findViewShouldExist(View root, int childViewId) { 3400 View result = root.findViewById(childViewId); 3401 if (result == null) { 3402 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified " 3403 + "by user for id " + childViewId); 3404 } 3405 return result; 3406 } 3407 3408 /** 3409 * Find and return all focusable views that are descendants of this view, 3410 * possibly including this view if it is focusable itself. 3411 * 3412 * @param direction The direction of the focus 3413 * @return A list of focusable views 3414 */ 3415 public ArrayList<View> getFocusables(int direction) { 3416 ArrayList<View> result = new ArrayList<View>(24); 3417 addFocusables(result, direction); 3418 return result; 3419 } 3420 3421 /** 3422 * Add any focusable views that are descendants of this view (possibly 3423 * including this view if it is focusable itself) to views. If we are in touch mode, 3424 * only add views that are also focusable in touch mode. 3425 * 3426 * @param views Focusable views found so far 3427 * @param direction The direction of the focus 3428 */ 3429 public void addFocusables(ArrayList<View> views, int direction) { 3430 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE); 3431 } 3432 3433 /** 3434 * Adds any focusable views that are descendants of this view (possibly 3435 * including this view if it is focusable itself) to views. This method 3436 * adds all focusable views regardless if we are in touch mode or 3437 * only views focusable in touch mode if we are in touch mode depending on 3438 * the focusable mode paramater. 3439 * 3440 * @param views Focusable views found so far or null if all we are interested is 3441 * the number of focusables. 3442 * @param direction The direction of the focus. 3443 * @param focusableMode The type of focusables to be added. 3444 * 3445 * @see #FOCUSABLES_ALL 3446 * @see #FOCUSABLES_TOUCH_MODE 3447 */ 3448 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) { 3449 if (!isFocusable()) { 3450 return; 3451 } 3452 3453 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE && 3454 isInTouchMode() && !isFocusableInTouchMode()) { 3455 return; 3456 } 3457 3458 if (views != null) { 3459 views.add(this); 3460 } 3461 } 3462 3463 /** 3464 * Find and return all touchable views that are descendants of this view, 3465 * possibly including this view if it is touchable itself. 3466 * 3467 * @return A list of touchable views 3468 */ 3469 public ArrayList<View> getTouchables() { 3470 ArrayList<View> result = new ArrayList<View>(); 3471 addTouchables(result); 3472 return result; 3473 } 3474 3475 /** 3476 * Add any touchable views that are descendants of this view (possibly 3477 * including this view if it is touchable itself) to views. 3478 * 3479 * @param views Touchable views found so far 3480 */ 3481 public void addTouchables(ArrayList<View> views) { 3482 final int viewFlags = mViewFlags; 3483 3484 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) 3485 && (viewFlags & ENABLED_MASK) == ENABLED) { 3486 views.add(this); 3487 } 3488 } 3489 3490 /** 3491 * Call this to try to give focus to a specific view or to one of its 3492 * descendants. 3493 * 3494 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false), 3495 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode}) 3496 * while the device is in touch mode. 3497 * 3498 * See also {@link #focusSearch}, which is what you call to say that you 3499 * have focus, and you want your parent to look for the next one. 3500 * 3501 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments 3502 * {@link #FOCUS_DOWN} and <code>null</code>. 3503 * 3504 * @return Whether this view or one of its descendants actually took focus. 3505 */ 3506 public final boolean requestFocus() { 3507 return requestFocus(View.FOCUS_DOWN); 3508 } 3509 3510 3511 /** 3512 * Call this to try to give focus to a specific view or to one of its 3513 * descendants and give it a hint about what direction focus is heading. 3514 * 3515 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false), 3516 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode}) 3517 * while the device is in touch mode. 3518 * 3519 * See also {@link #focusSearch}, which is what you call to say that you 3520 * have focus, and you want your parent to look for the next one. 3521 * 3522 * This is equivalent to calling {@link #requestFocus(int, Rect)} with 3523 * <code>null</code> set for the previously focused rectangle. 3524 * 3525 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 3526 * @return Whether this view or one of its descendants actually took focus. 3527 */ 3528 public final boolean requestFocus(int direction) { 3529 return requestFocus(direction, null); 3530 } 3531 3532 /** 3533 * Call this to try to give focus to a specific view or to one of its descendants 3534 * and give it hints about the direction and a specific rectangle that the focus 3535 * is coming from. The rectangle can help give larger views a finer grained hint 3536 * about where focus is coming from, and therefore, where to show selection, or 3537 * forward focus change internally. 3538 * 3539 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false), 3540 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode}) 3541 * while the device is in touch mode. 3542 * 3543 * A View will not take focus if it is not visible. 3544 * 3545 * A View will not take focus if one of its parents has {@link android.view.ViewGroup#getDescendantFocusability()} 3546 * equal to {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}. 3547 * 3548 * See also {@link #focusSearch}, which is what you call to say that you 3549 * have focus, and you want your parent to look for the next one. 3550 * 3551 * You may wish to override this method if your custom {@link View} has an internal 3552 * {@link View} that it wishes to forward the request to. 3553 * 3554 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT 3555 * @param previouslyFocusedRect The rectangle (in this View's coordinate system) 3556 * to give a finer grained hint about where focus is coming from. May be null 3557 * if there is no hint. 3558 * @return Whether this view or one of its descendants actually took focus. 3559 */ 3560 public boolean requestFocus(int direction, Rect previouslyFocusedRect) { 3561 // need to be focusable 3562 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE || 3563 (mViewFlags & VISIBILITY_MASK) != VISIBLE) { 3564 return false; 3565 } 3566 3567 // need to be focusable in touch mode if in touch mode 3568 if (isInTouchMode() && 3569 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) { 3570 return false; 3571 } 3572 3573 // need to not have any parents blocking us 3574 if (hasAncestorThatBlocksDescendantFocus()) { 3575 return false; 3576 } 3577 3578 handleFocusGainInternal(direction, previouslyFocusedRect); 3579 return true; 3580 } 3581 3582 /** 3583 * Call this to try to give focus to a specific view or to one of its descendants. This is a 3584 * special variant of {@link #requestFocus() } that will allow views that are not focuable in 3585 * touch mode to request focus when they are touched. 3586 * 3587 * @return Whether this view or one of its descendants actually took focus. 3588 * 3589 * @see #isInTouchMode() 3590 * 3591 */ 3592 public final boolean requestFocusFromTouch() { 3593 // Leave touch mode if we need to 3594 if (isInTouchMode()) { 3595 View root = getRootView(); 3596 if (root != null) { 3597 ViewRoot viewRoot = (ViewRoot)root.getParent(); 3598 if (viewRoot != null) { 3599 viewRoot.ensureTouchMode(false); 3600 } 3601 } 3602 } 3603 return requestFocus(View.FOCUS_DOWN); 3604 } 3605 3606 /** 3607 * @return Whether any ancestor of this view blocks descendant focus. 3608 */ 3609 private boolean hasAncestorThatBlocksDescendantFocus() { 3610 ViewParent ancestor = mParent; 3611 while (ancestor instanceof ViewGroup) { 3612 final ViewGroup vgAncestor = (ViewGroup) ancestor; 3613 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) { 3614 return true; 3615 } else { 3616 ancestor = vgAncestor.getParent(); 3617 } 3618 } 3619 return false; 3620 } 3621 3622 /** 3623 * This is called when a container is going to temporarily detach a child 3624 * that currently has focus, with 3625 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}. 3626 * It will either be followed by {@link #onFinishTemporaryDetach()} or 3627 * {@link #onDetachedFromWindow()} when the container is done. Generally 3628 * this is currently only done ListView for a view with focus. 3629 */ 3630 public void onStartTemporaryDetach() { 3631 } 3632 3633 /** 3634 * Called after {@link #onStartTemporaryDetach} when the container is done 3635 * changing the view. 3636 */ 3637 public void onFinishTemporaryDetach() { 3638 } 3639 3640 /** 3641 * capture information of this view for later analysis: developement only 3642 * check dynamic switch to make sure we only dump view 3643 * when ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW) is set 3644 */ 3645 private static void captureViewInfo(String subTag, View v) { 3646 if (v == null || SystemProperties.getInt(ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW, 0) == 0) { 3647 return; 3648 } 3649 ViewDebug.dumpCapturedView(subTag, v); 3650 } 3651 3652 /** 3653 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState} 3654 * for this view's window. Returns null if the view is not currently attached 3655 * to the window. Normally you will not need to use this directly, but 3656 * just use the standard high-level event callbacks like {@link #onKeyDown}. 3657 */ 3658 public KeyEvent.DispatcherState getKeyDispatcherState() { 3659 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null; 3660 } 3661 3662 /** 3663 * Dispatch a key event before it is processed by any input method 3664 * associated with the view hierarchy. This can be used to intercept 3665 * key events in special situations before the IME consumes them; a 3666 * typical example would be handling the BACK key to update the application's 3667 * UI instead of allowing the IME to see it and close itself. 3668 * 3669 * @param event The key event to be dispatched. 3670 * @return True if the event was handled, false otherwise. 3671 */ 3672 public boolean dispatchKeyEventPreIme(KeyEvent event) { 3673 return onKeyPreIme(event.getKeyCode(), event); 3674 } 3675 3676 /** 3677 * Dispatch a key event to the next view on the focus path. This path runs 3678 * from the top of the view tree down to the currently focused view. If this 3679 * view has focus, it will dispatch to itself. Otherwise it will dispatch 3680 * the next node down the focus path. This method also fires any key 3681 * listeners. 3682 * 3683 * @param event The key event to be dispatched. 3684 * @return True if the event was handled, false otherwise. 3685 */ 3686 public boolean dispatchKeyEvent(KeyEvent event) { 3687 // If any attached key listener a first crack at the event. 3688 //noinspection SimplifiableIfStatement 3689 3690 if (android.util.Config.LOGV) { 3691 captureViewInfo("captureViewKeyEvent", this); 3692 } 3693 3694 if (mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED 3695 && mOnKeyListener.onKey(this, event.getKeyCode(), event)) { 3696 return true; 3697 } 3698 3699 return event.dispatch(this, mAttachInfo != null 3700 ? mAttachInfo.mKeyDispatchState : null, this); 3701 } 3702 3703 /** 3704 * Dispatches a key shortcut event. 3705 * 3706 * @param event The key event to be dispatched. 3707 * @return True if the event was handled by the view, false otherwise. 3708 */ 3709 public boolean dispatchKeyShortcutEvent(KeyEvent event) { 3710 return onKeyShortcut(event.getKeyCode(), event); 3711 } 3712 3713 /** 3714 * Pass the touch screen motion event down to the target view, or this 3715 * view if it is the target. 3716 * 3717 * @param event The motion event to be dispatched. 3718 * @return True if the event was handled by the view, false otherwise. 3719 */ 3720 public boolean dispatchTouchEvent(MotionEvent event) { 3721 if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED && 3722 mOnTouchListener.onTouch(this, event)) { 3723 return true; 3724 } 3725 return onTouchEvent(event); 3726 } 3727 3728 /** 3729 * Pass a trackball motion event down to the focused view. 3730 * 3731 * @param event The motion event to be dispatched. 3732 * @return True if the event was handled by the view, false otherwise. 3733 */ 3734 public boolean dispatchTrackballEvent(MotionEvent event) { 3735 //Log.i("view", "view=" + this + ", " + event.toString()); 3736 return onTrackballEvent(event); 3737 } 3738 3739 /** 3740 * Called when the window containing this view gains or loses window focus. 3741 * ViewGroups should override to route to their children. 3742 * 3743 * @param hasFocus True if the window containing this view now has focus, 3744 * false otherwise. 3745 */ 3746 public void dispatchWindowFocusChanged(boolean hasFocus) { 3747 onWindowFocusChanged(hasFocus); 3748 } 3749 3750 /** 3751 * Called when the window containing this view gains or loses focus. Note 3752 * that this is separate from view focus: to receive key events, both 3753 * your view and its window must have focus. If a window is displayed 3754 * on top of yours that takes input focus, then your own window will lose 3755 * focus but the view focus will remain unchanged. 3756 * 3757 * @param hasWindowFocus True if the window containing this view now has 3758 * focus, false otherwise. 3759 */ 3760 public void onWindowFocusChanged(boolean hasWindowFocus) { 3761 InputMethodManager imm = InputMethodManager.peekInstance(); 3762 if (!hasWindowFocus) { 3763 if (isPressed()) { 3764 setPressed(false); 3765 } 3766 if (imm != null && (mPrivateFlags & FOCUSED) != 0) { 3767 imm.focusOut(this); 3768 } 3769 removeLongPressCallback(); 3770 onFocusLost(); 3771 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) { 3772 imm.focusIn(this); 3773 } 3774 refreshDrawableState(); 3775 } 3776 3777 /** 3778 * Returns true if this view is in a window that currently has window focus. 3779 * Note that this is not the same as the view itself having focus. 3780 * 3781 * @return True if this view is in a window that currently has window focus. 3782 */ 3783 public boolean hasWindowFocus() { 3784 return mAttachInfo != null && mAttachInfo.mHasWindowFocus; 3785 } 3786 3787 /** 3788 * Dispatch a view visibility change down the view hierarchy. 3789 * ViewGroups should override to route to their children. 3790 * @param changedView The view whose visibility changed. Could be 'this' or 3791 * an ancestor view. 3792 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 3793 * {@link #INVISIBLE} or {@link #GONE}. 3794 */ 3795 protected void dispatchVisibilityChanged(View changedView, int visibility) { 3796 onVisibilityChanged(changedView, visibility); 3797 } 3798 3799 /** 3800 * Called when the visibility of the view or an ancestor of the view is changed. 3801 * @param changedView The view whose visibility changed. Could be 'this' or 3802 * an ancestor view. 3803 * @param visibility The new visibility of changedView: {@link #VISIBLE}, 3804 * {@link #INVISIBLE} or {@link #GONE}. 3805 */ 3806 protected void onVisibilityChanged(View changedView, int visibility) { 3807 } 3808 3809 /** 3810 * Dispatch a hint about whether this view is displayed. For instance, when 3811 * a View moves out of the screen, it might receives a display hint indicating 3812 * the view is not displayed. Applications should not <em>rely</em> on this hint 3813 * as there is no guarantee that they will receive one. 3814 * 3815 * @param hint A hint about whether or not this view is displayed: 3816 * {@link #VISIBLE} or {@link #INVISIBLE}. 3817 */ 3818 public void dispatchDisplayHint(int hint) { 3819 onDisplayHint(hint); 3820 } 3821 3822 /** 3823 * Gives this view a hint about whether is displayed or not. For instance, when 3824 * a View moves out of the screen, it might receives a display hint indicating 3825 * the view is not displayed. Applications should not <em>rely</em> on this hint 3826 * as there is no guarantee that they will receive one. 3827 * 3828 * @param hint A hint about whether or not this view is displayed: 3829 * {@link #VISIBLE} or {@link #INVISIBLE}. 3830 */ 3831 protected void onDisplayHint(int hint) { 3832 } 3833 3834 /** 3835 * Dispatch a window visibility change down the view hierarchy. 3836 * ViewGroups should override to route to their children. 3837 * 3838 * @param visibility The new visibility of the window. 3839 * 3840 * @see #onWindowVisibilityChanged 3841 */ 3842 public void dispatchWindowVisibilityChanged(int visibility) { 3843 onWindowVisibilityChanged(visibility); 3844 } 3845 3846 /** 3847 * Called when the window containing has change its visibility 3848 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note 3849 * that this tells you whether or not your window is being made visible 3850 * to the window manager; this does <em>not</em> tell you whether or not 3851 * your window is obscured by other windows on the screen, even if it 3852 * is itself visible. 3853 * 3854 * @param visibility The new visibility of the window. 3855 */ 3856 protected void onWindowVisibilityChanged(int visibility) { 3857 } 3858 3859 /** 3860 * Returns the current visibility of the window this view is attached to 3861 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}). 3862 * 3863 * @return Returns the current visibility of the view's window. 3864 */ 3865 public int getWindowVisibility() { 3866 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE; 3867 } 3868 3869 /** 3870 * Retrieve the overall visible display size in which the window this view is 3871 * attached to has been positioned in. This takes into account screen 3872 * decorations above the window, for both cases where the window itself 3873 * is being position inside of them or the window is being placed under 3874 * then and covered insets are used for the window to position its content 3875 * inside. In effect, this tells you the available area where content can 3876 * be placed and remain visible to users. 3877 * 3878 * <p>This function requires an IPC back to the window manager to retrieve 3879 * the requested information, so should not be used in performance critical 3880 * code like drawing. 3881 * 3882 * @param outRect Filled in with the visible display frame. If the view 3883 * is not attached to a window, this is simply the raw display size. 3884 */ 3885 public void getWindowVisibleDisplayFrame(Rect outRect) { 3886 if (mAttachInfo != null) { 3887 try { 3888 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect); 3889 } catch (RemoteException e) { 3890 return; 3891 } 3892 // XXX This is really broken, and probably all needs to be done 3893 // in the window manager, and we need to know more about whether 3894 // we want the area behind or in front of the IME. 3895 final Rect insets = mAttachInfo.mVisibleInsets; 3896 outRect.left += insets.left; 3897 outRect.top += insets.top; 3898 outRect.right -= insets.right; 3899 outRect.bottom -= insets.bottom; 3900 return; 3901 } 3902 Display d = WindowManagerImpl.getDefault().getDefaultDisplay(); 3903 outRect.set(0, 0, d.getWidth(), d.getHeight()); 3904 } 3905 3906 /** 3907 * Private function to aggregate all per-view attributes in to the view 3908 * root. 3909 */ 3910 void dispatchCollectViewAttributes(int visibility) { 3911 performCollectViewAttributes(visibility); 3912 } 3913 3914 void performCollectViewAttributes(int visibility) { 3915 //noinspection PointlessBitwiseExpression 3916 if (((visibility | mViewFlags) & (VISIBILITY_MASK | KEEP_SCREEN_ON)) 3917 == (VISIBLE | KEEP_SCREEN_ON)) { 3918 mAttachInfo.mKeepScreenOn = true; 3919 } 3920 } 3921 3922 void needGlobalAttributesUpdate(boolean force) { 3923 AttachInfo ai = mAttachInfo; 3924 if (ai != null) { 3925 if (ai.mKeepScreenOn || force) { 3926 ai.mRecomputeGlobalAttributes = true; 3927 } 3928 } 3929 } 3930 3931 /** 3932 * Returns whether the device is currently in touch mode. Touch mode is entered 3933 * once the user begins interacting with the device by touch, and affects various 3934 * things like whether focus is always visible to the user. 3935 * 3936 * @return Whether the device is in touch mode. 3937 */ 3938 @ViewDebug.ExportedProperty 3939 public boolean isInTouchMode() { 3940 if (mAttachInfo != null) { 3941 return mAttachInfo.mInTouchMode; 3942 } else { 3943 return ViewRoot.isInTouchMode(); 3944 } 3945 } 3946 3947 /** 3948 * Returns the context the view is running in, through which it can 3949 * access the current theme, resources, etc. 3950 * 3951 * @return The view's Context. 3952 */ 3953 @ViewDebug.CapturedViewProperty 3954 public final Context getContext() { 3955 return mContext; 3956 } 3957 3958 /** 3959 * Handle a key event before it is processed by any input method 3960 * associated with the view hierarchy. This can be used to intercept 3961 * key events in special situations before the IME consumes them; a 3962 * typical example would be handling the BACK key to update the application's 3963 * UI instead of allowing the IME to see it and close itself. 3964 * 3965 * @param keyCode The value in event.getKeyCode(). 3966 * @param event Description of the key event. 3967 * @return If you handled the event, return true. If you want to allow the 3968 * event to be handled by the next receiver, return false. 3969 */ 3970 public boolean onKeyPreIme(int keyCode, KeyEvent event) { 3971 return false; 3972 } 3973 3974 /** 3975 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 3976 * KeyEvent.Callback.onKeyMultiple()}: perform press of the view 3977 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER} 3978 * is released, if the view is enabled and clickable. 3979 * 3980 * @param keyCode A key code that represents the button pressed, from 3981 * {@link android.view.KeyEvent}. 3982 * @param event The KeyEvent object that defines the button action. 3983 */ 3984 public boolean onKeyDown(int keyCode, KeyEvent event) { 3985 boolean result = false; 3986 3987 switch (keyCode) { 3988 case KeyEvent.KEYCODE_DPAD_CENTER: 3989 case KeyEvent.KEYCODE_ENTER: { 3990 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 3991 return true; 3992 } 3993 // Long clickable items don't necessarily have to be clickable 3994 if (((mViewFlags & CLICKABLE) == CLICKABLE || 3995 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) && 3996 (event.getRepeatCount() == 0)) { 3997 setPressed(true); 3998 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) { 3999 postCheckForLongClick(0); 4000 } 4001 return true; 4002 } 4003 break; 4004 } 4005 } 4006 return result; 4007 } 4008 4009 /** 4010 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent) 4011 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle 4012 * the event). 4013 */ 4014 public boolean onKeyLongPress(int keyCode, KeyEvent event) { 4015 return false; 4016 } 4017 4018 /** 4019 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 4020 * KeyEvent.Callback.onKeyMultiple()}: perform clicking of the view 4021 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or 4022 * {@link KeyEvent#KEYCODE_ENTER} is released. 4023 * 4024 * @param keyCode A key code that represents the button pressed, from 4025 * {@link android.view.KeyEvent}. 4026 * @param event The KeyEvent object that defines the button action. 4027 */ 4028 public boolean onKeyUp(int keyCode, KeyEvent event) { 4029 boolean result = false; 4030 4031 switch (keyCode) { 4032 case KeyEvent.KEYCODE_DPAD_CENTER: 4033 case KeyEvent.KEYCODE_ENTER: { 4034 if ((mViewFlags & ENABLED_MASK) == DISABLED) { 4035 return true; 4036 } 4037 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) { 4038 setPressed(false); 4039 4040 if (!mHasPerformedLongPress) { 4041 // This is a tap, so remove the longpress check 4042 removeLongPressCallback(); 4043 4044 result = performClick(); 4045 } 4046 } 4047 break; 4048 } 4049 } 4050 return result; 4051 } 4052 4053 /** 4054 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent) 4055 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle 4056 * the event). 4057 * 4058 * @param keyCode A key code that represents the button pressed, from 4059 * {@link android.view.KeyEvent}. 4060 * @param repeatCount The number of times the action was made. 4061 * @param event The KeyEvent object that defines the button action. 4062 */ 4063 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) { 4064 return false; 4065 } 4066 4067 /** 4068 * Called when an unhandled key shortcut event occurs. 4069 * 4070 * @param keyCode The value in event.getKeyCode(). 4071 * @param event Description of the key event. 4072 * @return If you handled the event, return true. If you want to allow the 4073 * event to be handled by the next receiver, return false. 4074 */ 4075 public boolean onKeyShortcut(int keyCode, KeyEvent event) { 4076 return false; 4077 } 4078 4079 /** 4080 * Check whether the called view is a text editor, in which case it 4081 * would make sense to automatically display a soft input window for 4082 * it. Subclasses should override this if they implement 4083 * {@link #onCreateInputConnection(EditorInfo)} to return true if 4084 * a call on that method would return a non-null InputConnection, and 4085 * they are really a first-class editor that the user would normally 4086 * start typing on when the go into a window containing your view. 4087 * 4088 * <p>The default implementation always returns false. This does 4089 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)} 4090 * will not be called or the user can not otherwise perform edits on your 4091 * view; it is just a hint to the system that this is not the primary 4092 * purpose of this view. 4093 * 4094 * @return Returns true if this view is a text editor, else false. 4095 */ 4096 public boolean onCheckIsTextEditor() { 4097 return false; 4098 } 4099 4100 /** 4101 * Create a new InputConnection for an InputMethod to interact 4102 * with the view. The default implementation returns null, since it doesn't 4103 * support input methods. You can override this to implement such support. 4104 * This is only needed for views that take focus and text input. 4105 * 4106 * <p>When implementing this, you probably also want to implement 4107 * {@link #onCheckIsTextEditor()} to indicate you will return a 4108 * non-null InputConnection. 4109 * 4110 * @param outAttrs Fill in with attribute information about the connection. 4111 */ 4112 public InputConnection onCreateInputConnection(EditorInfo outAttrs) { 4113 return null; 4114 } 4115 4116 /** 4117 * Called by the {@link android.view.inputmethod.InputMethodManager} 4118 * when a view who is not the current 4119 * input connection target is trying to make a call on the manager. The 4120 * default implementation returns false; you can override this to return 4121 * true for certain views if you are performing InputConnection proxying 4122 * to them. 4123 * @param view The View that is making the InputMethodManager call. 4124 * @return Return true to allow the call, false to reject. 4125 */ 4126 public boolean checkInputConnectionProxy(View view) { 4127 return false; 4128 } 4129 4130 /** 4131 * Show the context menu for this view. It is not safe to hold on to the 4132 * menu after returning from this method. 4133 * 4134 * @param menu The context menu to populate 4135 */ 4136 public void createContextMenu(ContextMenu menu) { 4137 ContextMenuInfo menuInfo = getContextMenuInfo(); 4138 4139 // Sets the current menu info so all items added to menu will have 4140 // my extra info set. 4141 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo); 4142 4143 onCreateContextMenu(menu); 4144 if (mOnCreateContextMenuListener != null) { 4145 mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo); 4146 } 4147 4148 // Clear the extra information so subsequent items that aren't mine don't 4149 // have my extra info. 4150 ((MenuBuilder)menu).setCurrentMenuInfo(null); 4151 4152 if (mParent != null) { 4153 mParent.createContextMenu(menu); 4154 } 4155 } 4156 4157 /** 4158 * Views should implement this if they have extra information to associate 4159 * with the context menu. The return result is supplied as a parameter to 4160 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)} 4161 * callback. 4162 * 4163 * @return Extra information about the item for which the context menu 4164 * should be shown. This information will vary across different 4165 * subclasses of View. 4166 */ 4167 protected ContextMenuInfo getContextMenuInfo() { 4168 return null; 4169 } 4170 4171 /** 4172 * Views should implement this if the view itself is going to add items to 4173 * the context menu. 4174 * 4175 * @param menu the context menu to populate 4176 */ 4177 protected void onCreateContextMenu(ContextMenu menu) { 4178 } 4179 4180 /** 4181 * Implement this method to handle trackball motion events. The 4182 * <em>relative</em> movement of the trackball since the last event 4183 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and 4184 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so 4185 * that a movement of 1 corresponds to the user pressing one DPAD key (so 4186 * they will often be fractional values, representing the more fine-grained 4187 * movement information available from a trackball). 4188 * 4189 * @param event The motion event. 4190 * @return True if the event was handled, false otherwise. 4191 */ 4192 public boolean onTrackballEvent(MotionEvent event) { 4193 return false; 4194 } 4195 4196 /** 4197 * Implement this method to handle touch screen motion events. 4198 * 4199 * @param event The motion event. 4200 * @return True if the event was handled, false otherwise. 4201 */ 4202 public boolean onTouchEvent(MotionEvent event) { 4203 final int viewFlags = mViewFlags; 4204 4205 if ((viewFlags & ENABLED_MASK) == DISABLED) { 4206 // A disabled view that is clickable still consumes the touch 4207 // events, it just doesn't respond to them. 4208 return (((viewFlags & CLICKABLE) == CLICKABLE || 4209 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)); 4210 } 4211 4212 if (mTouchDelegate != null) { 4213 if (mTouchDelegate.onTouchEvent(event)) { 4214 return true; 4215 } 4216 } 4217 4218 if (((viewFlags & CLICKABLE) == CLICKABLE || 4219 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) { 4220 switch (event.getAction()) { 4221 case MotionEvent.ACTION_UP: 4222 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0; 4223 if ((mPrivateFlags & PRESSED) != 0 || prepressed) { 4224 // take focus if we don't have it already and we should in 4225 // touch mode. 4226 boolean focusTaken = false; 4227 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) { 4228 focusTaken = requestFocus(); 4229 } 4230 4231 if (!mHasPerformedLongPress) { 4232 // This is a tap, so remove the longpress check 4233 removeLongPressCallback(); 4234 4235 // Only perform take click actions if we were in the pressed state 4236 if (!focusTaken) { 4237 performClick(); 4238 } 4239 } 4240 4241 if (mUnsetPressedState == null) { 4242 mUnsetPressedState = new UnsetPressedState(); 4243 } 4244 4245 if (prepressed) { 4246 mPrivateFlags |= PRESSED; 4247 refreshDrawableState(); 4248 postDelayed(mUnsetPressedState, 4249 ViewConfiguration.getPressedStateDuration()); 4250 } else if (!post(mUnsetPressedState)) { 4251 // If the post failed, unpress right now 4252 mUnsetPressedState.run(); 4253 } 4254 removeTapCallback(); 4255 } 4256 break; 4257 4258 case MotionEvent.ACTION_DOWN: 4259 if (mPendingCheckForTap == null) { 4260 mPendingCheckForTap = new CheckForTap(); 4261 } 4262 mPrivateFlags |= PREPRESSED; 4263 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout()); 4264 break; 4265 4266 case MotionEvent.ACTION_CANCEL: 4267 mPrivateFlags &= ~PRESSED; 4268 refreshDrawableState(); 4269 removeTapCallback(); 4270 break; 4271 4272 case MotionEvent.ACTION_MOVE: 4273 final int x = (int) event.getX(); 4274 final int y = (int) event.getY(); 4275 4276 // Be lenient about moving outside of buttons 4277 int slop = mTouchSlop; 4278 if ((x < 0 - slop) || (x >= getWidth() + slop) || 4279 (y < 0 - slop) || (y >= getHeight() + slop)) { 4280 // Outside button 4281 removeTapCallback(); 4282 if ((mPrivateFlags & PRESSED) != 0) { 4283 // Remove any future long press/tap checks 4284 removeLongPressCallback(); 4285 4286 // Need to switch from pressed to not pressed 4287 mPrivateFlags &= ~PRESSED; 4288 refreshDrawableState(); 4289 } 4290 } 4291 break; 4292 } 4293 return true; 4294 } 4295 4296 return false; 4297 } 4298 4299 /** 4300 * Remove the longpress detection timer. 4301 */ 4302 private void removeLongPressCallback() { 4303 if (mPendingCheckForLongPress != null) { 4304 removeCallbacks(mPendingCheckForLongPress); 4305 } 4306 } 4307 4308 /** 4309 * Remove the tap detection timer. 4310 */ 4311 private void removeTapCallback() { 4312 if (mPendingCheckForTap != null) { 4313 mPrivateFlags &= ~PREPRESSED; 4314 removeCallbacks(mPendingCheckForTap); 4315 } 4316 } 4317 4318 /** 4319 * Cancels a pending long press. Your subclass can use this if you 4320 * want the context menu to come up if the user presses and holds 4321 * at the same place, but you don't want it to come up if they press 4322 * and then move around enough to cause scrolling. 4323 */ 4324 public void cancelLongPress() { 4325 removeLongPressCallback(); 4326 4327 /* 4328 * The prepressed state handled by the tap callback is a display 4329 * construct, but the tap callback will post a long press callback 4330 * less its own timeout. Remove it here. 4331 */ 4332 removeTapCallback(); 4333 } 4334 4335 /** 4336 * Sets the TouchDelegate for this View. 4337 */ 4338 public void setTouchDelegate(TouchDelegate delegate) { 4339 mTouchDelegate = delegate; 4340 } 4341 4342 /** 4343 * Gets the TouchDelegate for this View. 4344 */ 4345 public TouchDelegate getTouchDelegate() { 4346 return mTouchDelegate; 4347 } 4348 4349 /** 4350 * Set flags controlling behavior of this view. 4351 * 4352 * @param flags Constant indicating the value which should be set 4353 * @param mask Constant indicating the bit range that should be changed 4354 */ 4355 void setFlags(int flags, int mask) { 4356 int old = mViewFlags; 4357 mViewFlags = (mViewFlags & ~mask) | (flags & mask); 4358 4359 int changed = mViewFlags ^ old; 4360 if (changed == 0) { 4361 return; 4362 } 4363 int privateFlags = mPrivateFlags; 4364 4365 /* Check if the FOCUSABLE bit has changed */ 4366 if (((changed & FOCUSABLE_MASK) != 0) && 4367 ((privateFlags & HAS_BOUNDS) !=0)) { 4368 if (((old & FOCUSABLE_MASK) == FOCUSABLE) 4369 && ((privateFlags & FOCUSED) != 0)) { 4370 /* Give up focus if we are no longer focusable */ 4371 clearFocus(); 4372 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE) 4373 && ((privateFlags & FOCUSED) == 0)) { 4374 /* 4375 * Tell the view system that we are now available to take focus 4376 * if no one else already has it. 4377 */ 4378 if (mParent != null) mParent.focusableViewAvailable(this); 4379 } 4380 } 4381 4382 if ((flags & VISIBILITY_MASK) == VISIBLE) { 4383 if ((changed & VISIBILITY_MASK) != 0) { 4384 /* 4385 * If this view is becoming visible, set the DRAWN flag so that 4386 * the next invalidate() will not be skipped. 4387 */ 4388 mPrivateFlags |= DRAWN; 4389 4390 needGlobalAttributesUpdate(true); 4391 4392 // a view becoming visible is worth notifying the parent 4393 // about in case nothing has focus. even if this specific view 4394 // isn't focusable, it may contain something that is, so let 4395 // the root view try to give this focus if nothing else does. 4396 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) { 4397 mParent.focusableViewAvailable(this); 4398 } 4399 } 4400 } 4401 4402 /* Check if the GONE bit has changed */ 4403 if ((changed & GONE) != 0) { 4404 needGlobalAttributesUpdate(false); 4405 requestLayout(); 4406 invalidate(); 4407 4408 if (((mViewFlags & VISIBILITY_MASK) == GONE)) { 4409 if (hasFocus()) clearFocus(); 4410 destroyDrawingCache(); 4411 } 4412 if (mAttachInfo != null) { 4413 mAttachInfo.mViewVisibilityChanged = true; 4414 } 4415 } 4416 4417 /* Check if the VISIBLE bit has changed */ 4418 if ((changed & INVISIBLE) != 0) { 4419 needGlobalAttributesUpdate(false); 4420 invalidate(); 4421 4422 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) { 4423 // root view becoming invisible shouldn't clear focus 4424 if (getRootView() != this) { 4425 clearFocus(); 4426 } 4427 } 4428 if (mAttachInfo != null) { 4429 mAttachInfo.mViewVisibilityChanged = true; 4430 } 4431 } 4432 4433 if ((changed & VISIBILITY_MASK) != 0) { 4434 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK)); 4435 } 4436 4437 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) { 4438 destroyDrawingCache(); 4439 } 4440 4441 if ((changed & DRAWING_CACHE_ENABLED) != 0) { 4442 destroyDrawingCache(); 4443 mPrivateFlags &= ~DRAWING_CACHE_VALID; 4444 } 4445 4446 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) { 4447 destroyDrawingCache(); 4448 mPrivateFlags &= ~DRAWING_CACHE_VALID; 4449 } 4450 4451 if ((changed & DRAW_MASK) != 0) { 4452 if ((mViewFlags & WILL_NOT_DRAW) != 0) { 4453 if (mBGDrawable != null) { 4454 mPrivateFlags &= ~SKIP_DRAW; 4455 mPrivateFlags |= ONLY_DRAWS_BACKGROUND; 4456 } else { 4457 mPrivateFlags |= SKIP_DRAW; 4458 } 4459 } else { 4460 mPrivateFlags &= ~SKIP_DRAW; 4461 } 4462 requestLayout(); 4463 invalidate(); 4464 } 4465 4466 if ((changed & KEEP_SCREEN_ON) != 0) { 4467 if (mParent != null) { 4468 mParent.recomputeViewAttributes(this); 4469 } 4470 } 4471 } 4472 4473 /** 4474 * Change the view's z order in the tree, so it's on top of other sibling 4475 * views 4476 */ 4477 public void bringToFront() { 4478 if (mParent != null) { 4479 mParent.bringChildToFront(this); 4480 } 4481 } 4482 4483 /** 4484 * This is called in response to an internal scroll in this view (i.e., the 4485 * view scrolled its own contents). This is typically as a result of 4486 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been 4487 * called. 4488 * 4489 * @param l Current horizontal scroll origin. 4490 * @param t Current vertical scroll origin. 4491 * @param oldl Previous horizontal scroll origin. 4492 * @param oldt Previous vertical scroll origin. 4493 */ 4494 protected void onScrollChanged(int l, int t, int oldl, int oldt) { 4495 mBackgroundSizeChanged = true; 4496 4497 final AttachInfo ai = mAttachInfo; 4498 if (ai != null) { 4499 ai.mViewScrollChanged = true; 4500 } 4501 } 4502 4503 /** 4504 * This is called during layout when the size of this view has changed. If 4505 * you were just added to the view hierarchy, you're called with the old 4506 * values of 0. 4507 * 4508 * @param w Current width of this view. 4509 * @param h Current height of this view. 4510 * @param oldw Old width of this view. 4511 * @param oldh Old height of this view. 4512 */ 4513 protected void onSizeChanged(int w, int h, int oldw, int oldh) { 4514 } 4515 4516 /** 4517 * Called by draw to draw the child views. This may be overridden 4518 * by derived classes to gain control just before its children are drawn 4519 * (but after its own view has been drawn). 4520 * @param canvas the canvas on which to draw the view 4521 */ 4522 protected void dispatchDraw(Canvas canvas) { 4523 } 4524 4525 /** 4526 * Gets the parent of this view. Note that the parent is a 4527 * ViewParent and not necessarily a View. 4528 * 4529 * @return Parent of this view. 4530 */ 4531 public final ViewParent getParent() { 4532 return mParent; 4533 } 4534 4535 /** 4536 * Return the scrolled left position of this view. This is the left edge of 4537 * the displayed part of your view. You do not need to draw any pixels 4538 * farther left, since those are outside of the frame of your view on 4539 * screen. 4540 * 4541 * @return The left edge of the displayed part of your view, in pixels. 4542 */ 4543 public final int getScrollX() { 4544 return mScrollX; 4545 } 4546 4547 /** 4548 * Return the scrolled top position of this view. This is the top edge of 4549 * the displayed part of your view. You do not need to draw any pixels above 4550 * it, since those are outside of the frame of your view on screen. 4551 * 4552 * @return The top edge of the displayed part of your view, in pixels. 4553 */ 4554 public final int getScrollY() { 4555 return mScrollY; 4556 } 4557 4558 /** 4559 * Return the width of the your view. 4560 * 4561 * @return The width of your view, in pixels. 4562 */ 4563 @ViewDebug.ExportedProperty 4564 public final int getWidth() { 4565 return mRight - mLeft; 4566 } 4567 4568 /** 4569 * Return the height of your view. 4570 * 4571 * @return The height of your view, in pixels. 4572 */ 4573 @ViewDebug.ExportedProperty 4574 public final int getHeight() { 4575 return mBottom - mTop; 4576 } 4577 4578 /** 4579 * Return the visible drawing bounds of your view. Fills in the output 4580 * rectangle with the values from getScrollX(), getScrollY(), 4581 * getWidth(), and getHeight(). 4582 * 4583 * @param outRect The (scrolled) drawing bounds of the view. 4584 */ 4585 public void getDrawingRect(Rect outRect) { 4586 outRect.left = mScrollX; 4587 outRect.top = mScrollY; 4588 outRect.right = mScrollX + (mRight - mLeft); 4589 outRect.bottom = mScrollY + (mBottom - mTop); 4590 } 4591 4592 /** 4593 * The width of this view as measured in the most recent call to measure(). 4594 * This should be used during measurement and layout calculations only. Use 4595 * {@link #getWidth()} to see how wide a view is after layout. 4596 * 4597 * @return The measured width of this view. 4598 */ 4599 public final int getMeasuredWidth() { 4600 return mMeasuredWidth; 4601 } 4602 4603 /** 4604 * The height of this view as measured in the most recent call to measure(). 4605 * This should be used during measurement and layout calculations only. Use 4606 * {@link #getHeight()} to see how tall a view is after layout. 4607 * 4608 * @return The measured height of this view. 4609 */ 4610 public final int getMeasuredHeight() { 4611 return mMeasuredHeight; 4612 } 4613 4614 /** 4615 * Top position of this view relative to its parent. 4616 * 4617 * @return The top of this view, in pixels. 4618 */ 4619 @ViewDebug.CapturedViewProperty 4620 public final int getTop() { 4621 return mTop; 4622 } 4623 4624 /** 4625 * Bottom position of this view relative to its parent. 4626 * 4627 * @return The bottom of this view, in pixels. 4628 */ 4629 @ViewDebug.CapturedViewProperty 4630 public final int getBottom() { 4631 return mBottom; 4632 } 4633 4634 /** 4635 * Left position of this view relative to its parent. 4636 * 4637 * @return The left edge of this view, in pixels. 4638 */ 4639 @ViewDebug.CapturedViewProperty 4640 public final int getLeft() { 4641 return mLeft; 4642 } 4643 4644 /** 4645 * Right position of this view relative to its parent. 4646 * 4647 * @return The right edge of this view, in pixels. 4648 */ 4649 @ViewDebug.CapturedViewProperty 4650 public final int getRight() { 4651 return mRight; 4652 } 4653 4654 /** 4655 * Hit rectangle in parent's coordinates 4656 * 4657 * @param outRect The hit rectangle of the view. 4658 */ 4659 public void getHitRect(Rect outRect) { 4660 outRect.set(mLeft, mTop, mRight, mBottom); 4661 } 4662 4663 /** 4664 * When a view has focus and the user navigates away from it, the next view is searched for 4665 * starting from the rectangle filled in by this method. 4666 * 4667 * By default, the rectange is the {@link #getDrawingRect})of the view. However, if your 4668 * view maintains some idea of internal selection, such as a cursor, or a selected row 4669 * or column, you should override this method and fill in a more specific rectangle. 4670 * 4671 * @param r The rectangle to fill in, in this view's coordinates. 4672 */ 4673 public void getFocusedRect(Rect r) { 4674 getDrawingRect(r); 4675 } 4676 4677 /** 4678 * If some part of this view is not clipped by any of its parents, then 4679 * return that area in r in global (root) coordinates. To convert r to local 4680 * coordinates, offset it by -globalOffset (e.g. r.offset(-globalOffset.x, 4681 * -globalOffset.y)) If the view is completely clipped or translated out, 4682 * return false. 4683 * 4684 * @param r If true is returned, r holds the global coordinates of the 4685 * visible portion of this view. 4686 * @param globalOffset If true is returned, globalOffset holds the dx,dy 4687 * between this view and its root. globalOffet may be null. 4688 * @return true if r is non-empty (i.e. part of the view is visible at the 4689 * root level. 4690 */ 4691 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) { 4692 int width = mRight - mLeft; 4693 int height = mBottom - mTop; 4694 if (width > 0 && height > 0) { 4695 r.set(0, 0, width, height); 4696 if (globalOffset != null) { 4697 globalOffset.set(-mScrollX, -mScrollY); 4698 } 4699 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset); 4700 } 4701 return false; 4702 } 4703 4704 public final boolean getGlobalVisibleRect(Rect r) { 4705 return getGlobalVisibleRect(r, null); 4706 } 4707 4708 public final boolean getLocalVisibleRect(Rect r) { 4709 Point offset = new Point(); 4710 if (getGlobalVisibleRect(r, offset)) { 4711 r.offset(-offset.x, -offset.y); // make r local 4712 return true; 4713 } 4714 return false; 4715 } 4716 4717 /** 4718 * Offset this view's vertical location by the specified number of pixels. 4719 * 4720 * @param offset the number of pixels to offset the view by 4721 */ 4722 public void offsetTopAndBottom(int offset) { 4723 mTop += offset; 4724 mBottom += offset; 4725 } 4726 4727 /** 4728 * Offset this view's horizontal location by the specified amount of pixels. 4729 * 4730 * @param offset the numer of pixels to offset the view by 4731 */ 4732 public void offsetLeftAndRight(int offset) { 4733 mLeft += offset; 4734 mRight += offset; 4735 } 4736 4737 /** 4738 * Get the LayoutParams associated with this view. All views should have 4739 * layout parameters. These supply parameters to the <i>parent</i> of this 4740 * view specifying how it should be arranged. There are many subclasses of 4741 * ViewGroup.LayoutParams, and these correspond to the different subclasses 4742 * of ViewGroup that are responsible for arranging their children. 4743 * @return The LayoutParams associated with this view 4744 */ 4745 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_") 4746 public ViewGroup.LayoutParams getLayoutParams() { 4747 return mLayoutParams; 4748 } 4749 4750 /** 4751 * Set the layout parameters associated with this view. These supply 4752 * parameters to the <i>parent</i> of this view specifying how it should be 4753 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these 4754 * correspond to the different subclasses of ViewGroup that are responsible 4755 * for arranging their children. 4756 * 4757 * @param params the layout parameters for this view 4758 */ 4759 public void setLayoutParams(ViewGroup.LayoutParams params) { 4760 if (params == null) { 4761 throw new NullPointerException("params == null"); 4762 } 4763 mLayoutParams = params; 4764 requestLayout(); 4765 } 4766 4767 /** 4768 * Set the scrolled position of your view. This will cause a call to 4769 * {@link #onScrollChanged(int, int, int, int)} and the view will be 4770 * invalidated. 4771 * @param x the x position to scroll to 4772 * @param y the y position to scroll to 4773 */ 4774 public void scrollTo(int x, int y) { 4775 if (mScrollX != x || mScrollY != y) { 4776 int oldX = mScrollX; 4777 int oldY = mScrollY; 4778 mScrollX = x; 4779 mScrollY = y; 4780 onScrollChanged(mScrollX, mScrollY, oldX, oldY); 4781 if (!awakenScrollBars()) { 4782 invalidate(); 4783 } 4784 } 4785 } 4786 4787 /** 4788 * Move the scrolled position of your view. This will cause a call to 4789 * {@link #onScrollChanged(int, int, int, int)} and the view will be 4790 * invalidated. 4791 * @param x the amount of pixels to scroll by horizontally 4792 * @param y the amount of pixels to scroll by vertically 4793 */ 4794 public void scrollBy(int x, int y) { 4795 scrollTo(mScrollX + x, mScrollY + y); 4796 } 4797 4798 /** 4799 * <p>Trigger the scrollbars to draw. When invoked this method starts an 4800 * animation to fade the scrollbars out after a default delay. If a subclass 4801 * provides animated scrolling, the start delay should equal the duration 4802 * of the scrolling animation.</p> 4803 * 4804 * <p>The animation starts only if at least one of the scrollbars is 4805 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and 4806 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 4807 * this method returns true, and false otherwise. If the animation is 4808 * started, this method calls {@link #invalidate()}; in that case the 4809 * caller should not call {@link #invalidate()}.</p> 4810 * 4811 * <p>This method should be invoked every time a subclass directly updates 4812 * the scroll parameters.</p> 4813 * 4814 * <p>This method is automatically invoked by {@link #scrollBy(int, int)} 4815 * and {@link #scrollTo(int, int)}.</p> 4816 * 4817 * @return true if the animation is played, false otherwise 4818 * 4819 * @see #awakenScrollBars(int) 4820 * @see #scrollBy(int, int) 4821 * @see #scrollTo(int, int) 4822 * @see #isHorizontalScrollBarEnabled() 4823 * @see #isVerticalScrollBarEnabled() 4824 * @see #setHorizontalScrollBarEnabled(boolean) 4825 * @see #setVerticalScrollBarEnabled(boolean) 4826 */ 4827 protected boolean awakenScrollBars() { 4828 return mScrollCache != null && 4829 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true); 4830 } 4831 4832 /** 4833 * <p> 4834 * Trigger the scrollbars to draw. When invoked this method starts an 4835 * animation to fade the scrollbars out after a fixed delay. If a subclass 4836 * provides animated scrolling, the start delay should equal the duration of 4837 * the scrolling animation. 4838 * </p> 4839 * 4840 * <p> 4841 * The animation starts only if at least one of the scrollbars is enabled, 4842 * as specified by {@link #isHorizontalScrollBarEnabled()} and 4843 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 4844 * this method returns true, and false otherwise. If the animation is 4845 * started, this method calls {@link #invalidate()}; in that case the caller 4846 * should not call {@link #invalidate()}. 4847 * </p> 4848 * 4849 * <p> 4850 * This method should be invoked everytime a subclass directly updates the 4851 * scroll parameters. 4852 * </p> 4853 * 4854 * @param startDelay the delay, in milliseconds, after which the animation 4855 * should start; when the delay is 0, the animation starts 4856 * immediately 4857 * @return true if the animation is played, false otherwise 4858 * 4859 * @see #scrollBy(int, int) 4860 * @see #scrollTo(int, int) 4861 * @see #isHorizontalScrollBarEnabled() 4862 * @see #isVerticalScrollBarEnabled() 4863 * @see #setHorizontalScrollBarEnabled(boolean) 4864 * @see #setVerticalScrollBarEnabled(boolean) 4865 */ 4866 protected boolean awakenScrollBars(int startDelay) { 4867 return awakenScrollBars(startDelay, true); 4868 } 4869 4870 /** 4871 * <p> 4872 * Trigger the scrollbars to draw. When invoked this method starts an 4873 * animation to fade the scrollbars out after a fixed delay. If a subclass 4874 * provides animated scrolling, the start delay should equal the duration of 4875 * the scrolling animation. 4876 * </p> 4877 * 4878 * <p> 4879 * The animation starts only if at least one of the scrollbars is enabled, 4880 * as specified by {@link #isHorizontalScrollBarEnabled()} and 4881 * {@link #isVerticalScrollBarEnabled()}. When the animation is started, 4882 * this method returns true, and false otherwise. If the animation is 4883 * started, this method calls {@link #invalidate()} if the invalidate parameter 4884 * is set to true; in that case the caller 4885 * should not call {@link #invalidate()}. 4886 * </p> 4887 * 4888 * <p> 4889 * This method should be invoked everytime a subclass directly updates the 4890 * scroll parameters. 4891 * </p> 4892 * 4893 * @param startDelay the delay, in milliseconds, after which the animation 4894 * should start; when the delay is 0, the animation starts 4895 * immediately 4896 * 4897 * @param invalidate Wheter this method should call invalidate 4898 * 4899 * @return true if the animation is played, false otherwise 4900 * 4901 * @see #scrollBy(int, int) 4902 * @see #scrollTo(int, int) 4903 * @see #isHorizontalScrollBarEnabled() 4904 * @see #isVerticalScrollBarEnabled() 4905 * @see #setHorizontalScrollBarEnabled(boolean) 4906 * @see #setVerticalScrollBarEnabled(boolean) 4907 */ 4908 protected boolean awakenScrollBars(int startDelay, boolean invalidate) { 4909 final ScrollabilityCache scrollCache = mScrollCache; 4910 4911 if (scrollCache == null || !scrollCache.fadeScrollBars) { 4912 return false; 4913 } 4914 4915 if (scrollCache.scrollBar == null) { 4916 scrollCache.scrollBar = new ScrollBarDrawable(); 4917 } 4918 4919 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) { 4920 4921 if (invalidate) { 4922 // Invalidate to show the scrollbars 4923 invalidate(); 4924 } 4925 4926 if (scrollCache.state == ScrollabilityCache.OFF) { 4927 // FIXME: this is copied from WindowManagerService. 4928 // We should get this value from the system when it 4929 // is possible to do so. 4930 final int KEY_REPEAT_FIRST_DELAY = 750; 4931 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay); 4932 } 4933 4934 // Tell mScrollCache when we should start fading. This may 4935 // extend the fade start time if one was already scheduled 4936 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay; 4937 scrollCache.fadeStartTime = fadeStartTime; 4938 scrollCache.state = ScrollabilityCache.ON; 4939 4940 // Schedule our fader to run, unscheduling any old ones first 4941 if (mAttachInfo != null) { 4942 mAttachInfo.mHandler.removeCallbacks(scrollCache); 4943 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime); 4944 } 4945 4946 return true; 4947 } 4948 4949 return false; 4950 } 4951 4952 /** 4953 * Mark the the area defined by dirty as needing to be drawn. If the view is 4954 * visible, {@link #onDraw} will be called at some point in the future. 4955 * This must be called from a UI thread. To call from a non-UI thread, call 4956 * {@link #postInvalidate()}. 4957 * 4958 * WARNING: This method is destructive to dirty. 4959 * @param dirty the rectangle representing the bounds of the dirty region 4960 */ 4961 public void invalidate(Rect dirty) { 4962 if (ViewDebug.TRACE_HIERARCHY) { 4963 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 4964 } 4965 4966 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS)) { 4967 mPrivateFlags &= ~DRAWING_CACHE_VALID; 4968 final ViewParent p = mParent; 4969 final AttachInfo ai = mAttachInfo; 4970 if (p != null && ai != null) { 4971 final int scrollX = mScrollX; 4972 final int scrollY = mScrollY; 4973 final Rect r = ai.mTmpInvalRect; 4974 r.set(dirty.left - scrollX, dirty.top - scrollY, 4975 dirty.right - scrollX, dirty.bottom - scrollY); 4976 mParent.invalidateChild(this, r); 4977 } 4978 } 4979 } 4980 4981 /** 4982 * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn. 4983 * The coordinates of the dirty rect are relative to the view. 4984 * If the view is visible, {@link #onDraw} will be called at some point 4985 * in the future. This must be called from a UI thread. To call 4986 * from a non-UI thread, call {@link #postInvalidate()}. 4987 * @param l the left position of the dirty region 4988 * @param t the top position of the dirty region 4989 * @param r the right position of the dirty region 4990 * @param b the bottom position of the dirty region 4991 */ 4992 public void invalidate(int l, int t, int r, int b) { 4993 if (ViewDebug.TRACE_HIERARCHY) { 4994 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 4995 } 4996 4997 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS)) { 4998 mPrivateFlags &= ~DRAWING_CACHE_VALID; 4999 final ViewParent p = mParent; 5000 final AttachInfo ai = mAttachInfo; 5001 if (p != null && ai != null && l < r && t < b) { 5002 final int scrollX = mScrollX; 5003 final int scrollY = mScrollY; 5004 final Rect tmpr = ai.mTmpInvalRect; 5005 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY); 5006 p.invalidateChild(this, tmpr); 5007 } 5008 } 5009 } 5010 5011 /** 5012 * Invalidate the whole view. If the view is visible, {@link #onDraw} will 5013 * be called at some point in the future. This must be called from a 5014 * UI thread. To call from a non-UI thread, call {@link #postInvalidate()}. 5015 */ 5016 public void invalidate() { 5017 if (ViewDebug.TRACE_HIERARCHY) { 5018 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE); 5019 } 5020 5021 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS)) { 5022 mPrivateFlags &= ~DRAWN & ~DRAWING_CACHE_VALID; 5023 final ViewParent p = mParent; 5024 final AttachInfo ai = mAttachInfo; 5025 if (p != null && ai != null) { 5026 final Rect r = ai.mTmpInvalRect; 5027 r.set(0, 0, mRight - mLeft, mBottom - mTop); 5028 // Don't call invalidate -- we don't want to internally scroll 5029 // our own bounds 5030 p.invalidateChild(this, r); 5031 } 5032 } 5033 } 5034 5035 /** 5036 * Indicates whether this View is opaque. An opaque View guarantees that it will 5037 * draw all the pixels overlapping its bounds using a fully opaque color. 5038 * 5039 * Subclasses of View should override this method whenever possible to indicate 5040 * whether an instance is opaque. Opaque Views are treated in a special way by 5041 * the View hierarchy, possibly allowing it to perform optimizations during 5042 * invalidate/draw passes. 5043 * 5044 * @return True if this View is guaranteed to be fully opaque, false otherwise. 5045 */ 5046 @ViewDebug.ExportedProperty 5047 public boolean isOpaque() { 5048 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK; 5049 } 5050 5051 private void computeOpaqueFlags() { 5052 // Opaque if: 5053 // - Has a background 5054 // - Background is opaque 5055 // - Doesn't have scrollbars or scrollbars are inside overlay 5056 5057 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) { 5058 mPrivateFlags |= OPAQUE_BACKGROUND; 5059 } else { 5060 mPrivateFlags &= ~OPAQUE_BACKGROUND; 5061 } 5062 5063 final int flags = mViewFlags; 5064 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) || 5065 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) { 5066 mPrivateFlags |= OPAQUE_SCROLLBARS; 5067 } else { 5068 mPrivateFlags &= ~OPAQUE_SCROLLBARS; 5069 } 5070 } 5071 5072 /** 5073 * @hide 5074 */ 5075 protected boolean hasOpaqueScrollbars() { 5076 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS; 5077 } 5078 5079 /** 5080 * @return A handler associated with the thread running the View. This 5081 * handler can be used to pump events in the UI events queue. 5082 */ 5083 public Handler getHandler() { 5084 if (mAttachInfo != null) { 5085 return mAttachInfo.mHandler; 5086 } 5087 return null; 5088 } 5089 5090 /** 5091 * Causes the Runnable to be added to the message queue. 5092 * The runnable will be run on the user interface thread. 5093 * 5094 * @param action The Runnable that will be executed. 5095 * 5096 * @return Returns true if the Runnable was successfully placed in to the 5097 * message queue. Returns false on failure, usually because the 5098 * looper processing the message queue is exiting. 5099 */ 5100 public boolean post(Runnable action) { 5101 Handler handler; 5102 if (mAttachInfo != null) { 5103 handler = mAttachInfo.mHandler; 5104 } else { 5105 // Assume that post will succeed later 5106 ViewRoot.getRunQueue().post(action); 5107 return true; 5108 } 5109 5110 return handler.post(action); 5111 } 5112 5113 /** 5114 * Causes the Runnable to be added to the message queue, to be run 5115 * after the specified amount of time elapses. 5116 * The runnable will be run on the user interface thread. 5117 * 5118 * @param action The Runnable that will be executed. 5119 * @param delayMillis The delay (in milliseconds) until the Runnable 5120 * will be executed. 5121 * 5122 * @return true if the Runnable was successfully placed in to the 5123 * message queue. Returns false on failure, usually because the 5124 * looper processing the message queue is exiting. Note that a 5125 * result of true does not mean the Runnable will be processed -- 5126 * if the looper is quit before the delivery time of the message 5127 * occurs then the message will be dropped. 5128 */ 5129 public boolean postDelayed(Runnable action, long delayMillis) { 5130 Handler handler; 5131 if (mAttachInfo != null) { 5132 handler = mAttachInfo.mHandler; 5133 } else { 5134 // Assume that post will succeed later 5135 ViewRoot.getRunQueue().postDelayed(action, delayMillis); 5136 return true; 5137 } 5138 5139 return handler.postDelayed(action, delayMillis); 5140 } 5141 5142 /** 5143 * Removes the specified Runnable from the message queue. 5144 * 5145 * @param action The Runnable to remove from the message handling queue 5146 * 5147 * @return true if this view could ask the Handler to remove the Runnable, 5148 * false otherwise. When the returned value is true, the Runnable 5149 * may or may not have been actually removed from the message queue 5150 * (for instance, if the Runnable was not in the queue already.) 5151 */ 5152 public boolean removeCallbacks(Runnable action) { 5153 Handler handler; 5154 if (mAttachInfo != null) { 5155 handler = mAttachInfo.mHandler; 5156 } else { 5157 // Assume that post will succeed later 5158 ViewRoot.getRunQueue().removeCallbacks(action); 5159 return true; 5160 } 5161 5162 handler.removeCallbacks(action); 5163 return true; 5164 } 5165 5166 /** 5167 * Cause an invalidate to happen on a subsequent cycle through the event loop. 5168 * Use this to invalidate the View from a non-UI thread. 5169 * 5170 * @see #invalidate() 5171 */ 5172 public void postInvalidate() { 5173 postInvalidateDelayed(0); 5174 } 5175 5176 /** 5177 * Cause an invalidate of the specified area to happen on a subsequent cycle 5178 * through the event loop. Use this to invalidate the View from a non-UI thread. 5179 * 5180 * @param left The left coordinate of the rectangle to invalidate. 5181 * @param top The top coordinate of the rectangle to invalidate. 5182 * @param right The right coordinate of the rectangle to invalidate. 5183 * @param bottom The bottom coordinate of the rectangle to invalidate. 5184 * 5185 * @see #invalidate(int, int, int, int) 5186 * @see #invalidate(Rect) 5187 */ 5188 public void postInvalidate(int left, int top, int right, int bottom) { 5189 postInvalidateDelayed(0, left, top, right, bottom); 5190 } 5191 5192 /** 5193 * Cause an invalidate to happen on a subsequent cycle through the event 5194 * loop. Waits for the specified amount of time. 5195 * 5196 * @param delayMilliseconds the duration in milliseconds to delay the 5197 * invalidation by 5198 */ 5199 public void postInvalidateDelayed(long delayMilliseconds) { 5200 // We try only with the AttachInfo because there's no point in invalidating 5201 // if we are not attached to our window 5202 if (mAttachInfo != null) { 5203 Message msg = Message.obtain(); 5204 msg.what = AttachInfo.INVALIDATE_MSG; 5205 msg.obj = this; 5206 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds); 5207 } 5208 } 5209 5210 /** 5211 * Cause an invalidate of the specified area to happen on a subsequent cycle 5212 * through the event loop. Waits for the specified amount of time. 5213 * 5214 * @param delayMilliseconds the duration in milliseconds to delay the 5215 * invalidation by 5216 * @param left The left coordinate of the rectangle to invalidate. 5217 * @param top The top coordinate of the rectangle to invalidate. 5218 * @param right The right coordinate of the rectangle to invalidate. 5219 * @param bottom The bottom coordinate of the rectangle to invalidate. 5220 */ 5221 public void postInvalidateDelayed(long delayMilliseconds, int left, int top, 5222 int right, int bottom) { 5223 5224 // We try only with the AttachInfo because there's no point in invalidating 5225 // if we are not attached to our window 5226 if (mAttachInfo != null) { 5227 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire(); 5228 info.target = this; 5229 info.left = left; 5230 info.top = top; 5231 info.right = right; 5232 info.bottom = bottom; 5233 5234 final Message msg = Message.obtain(); 5235 msg.what = AttachInfo.INVALIDATE_RECT_MSG; 5236 msg.obj = info; 5237 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds); 5238 } 5239 } 5240 5241 /** 5242 * Called by a parent to request that a child update its values for mScrollX 5243 * and mScrollY if necessary. This will typically be done if the child is 5244 * animating a scroll using a {@link android.widget.Scroller Scroller} 5245 * object. 5246 */ 5247 public void computeScroll() { 5248 } 5249 5250 /** 5251 * <p>Indicate whether the horizontal edges are faded when the view is 5252 * scrolled horizontally.</p> 5253 * 5254 * @return true if the horizontal edges should are faded on scroll, false 5255 * otherwise 5256 * 5257 * @see #setHorizontalFadingEdgeEnabled(boolean) 5258 * @attr ref android.R.styleable#View_fadingEdge 5259 */ 5260 public boolean isHorizontalFadingEdgeEnabled() { 5261 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL; 5262 } 5263 5264 /** 5265 * <p>Define whether the horizontal edges should be faded when this view 5266 * is scrolled horizontally.</p> 5267 * 5268 * @param horizontalFadingEdgeEnabled true if the horizontal edges should 5269 * be faded when the view is scrolled 5270 * horizontally 5271 * 5272 * @see #isHorizontalFadingEdgeEnabled() 5273 * @attr ref android.R.styleable#View_fadingEdge 5274 */ 5275 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) { 5276 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) { 5277 if (horizontalFadingEdgeEnabled) { 5278 initScrollCache(); 5279 } 5280 5281 mViewFlags ^= FADING_EDGE_HORIZONTAL; 5282 } 5283 } 5284 5285 /** 5286 * <p>Indicate whether the vertical edges are faded when the view is 5287 * scrolled horizontally.</p> 5288 * 5289 * @return true if the vertical edges should are faded on scroll, false 5290 * otherwise 5291 * 5292 * @see #setVerticalFadingEdgeEnabled(boolean) 5293 * @attr ref android.R.styleable#View_fadingEdge 5294 */ 5295 public boolean isVerticalFadingEdgeEnabled() { 5296 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL; 5297 } 5298 5299 /** 5300 * <p>Define whether the vertical edges should be faded when this view 5301 * is scrolled vertically.</p> 5302 * 5303 * @param verticalFadingEdgeEnabled true if the vertical edges should 5304 * be faded when the view is scrolled 5305 * vertically 5306 * 5307 * @see #isVerticalFadingEdgeEnabled() 5308 * @attr ref android.R.styleable#View_fadingEdge 5309 */ 5310 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) { 5311 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) { 5312 if (verticalFadingEdgeEnabled) { 5313 initScrollCache(); 5314 } 5315 5316 mViewFlags ^= FADING_EDGE_VERTICAL; 5317 } 5318 } 5319 5320 /** 5321 * Returns the strength, or intensity, of the top faded edge. The strength is 5322 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 5323 * returns 0.0 or 1.0 but no value in between. 5324 * 5325 * Subclasses should override this method to provide a smoother fade transition 5326 * when scrolling occurs. 5327 * 5328 * @return the intensity of the top fade as a float between 0.0f and 1.0f 5329 */ 5330 protected float getTopFadingEdgeStrength() { 5331 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f; 5332 } 5333 5334 /** 5335 * Returns the strength, or intensity, of the bottom faded edge. The strength is 5336 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 5337 * returns 0.0 or 1.0 but no value in between. 5338 * 5339 * Subclasses should override this method to provide a smoother fade transition 5340 * when scrolling occurs. 5341 * 5342 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f 5343 */ 5344 protected float getBottomFadingEdgeStrength() { 5345 return computeVerticalScrollOffset() + computeVerticalScrollExtent() < 5346 computeVerticalScrollRange() ? 1.0f : 0.0f; 5347 } 5348 5349 /** 5350 * Returns the strength, or intensity, of the left faded edge. The strength is 5351 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 5352 * returns 0.0 or 1.0 but no value in between. 5353 * 5354 * Subclasses should override this method to provide a smoother fade transition 5355 * when scrolling occurs. 5356 * 5357 * @return the intensity of the left fade as a float between 0.0f and 1.0f 5358 */ 5359 protected float getLeftFadingEdgeStrength() { 5360 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f; 5361 } 5362 5363 /** 5364 * Returns the strength, or intensity, of the right faded edge. The strength is 5365 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation 5366 * returns 0.0 or 1.0 but no value in between. 5367 * 5368 * Subclasses should override this method to provide a smoother fade transition 5369 * when scrolling occurs. 5370 * 5371 * @return the intensity of the right fade as a float between 0.0f and 1.0f 5372 */ 5373 protected float getRightFadingEdgeStrength() { 5374 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() < 5375 computeHorizontalScrollRange() ? 1.0f : 0.0f; 5376 } 5377 5378 /** 5379 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The 5380 * scrollbar is not drawn by default.</p> 5381 * 5382 * @return true if the horizontal scrollbar should be painted, false 5383 * otherwise 5384 * 5385 * @see #setHorizontalScrollBarEnabled(boolean) 5386 */ 5387 public boolean isHorizontalScrollBarEnabled() { 5388 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 5389 } 5390 5391 /** 5392 * <p>Define whether the horizontal scrollbar should be drawn or not. The 5393 * scrollbar is not drawn by default.</p> 5394 * 5395 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should 5396 * be painted 5397 * 5398 * @see #isHorizontalScrollBarEnabled() 5399 */ 5400 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) { 5401 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) { 5402 mViewFlags ^= SCROLLBARS_HORIZONTAL; 5403 computeOpaqueFlags(); 5404 recomputePadding(); 5405 } 5406 } 5407 5408 /** 5409 * <p>Indicate whether the vertical scrollbar should be drawn or not. The 5410 * scrollbar is not drawn by default.</p> 5411 * 5412 * @return true if the vertical scrollbar should be painted, false 5413 * otherwise 5414 * 5415 * @see #setVerticalScrollBarEnabled(boolean) 5416 */ 5417 public boolean isVerticalScrollBarEnabled() { 5418 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL; 5419 } 5420 5421 /** 5422 * <p>Define whether the vertical scrollbar should be drawn or not. The 5423 * scrollbar is not drawn by default.</p> 5424 * 5425 * @param verticalScrollBarEnabled true if the vertical scrollbar should 5426 * be painted 5427 * 5428 * @see #isVerticalScrollBarEnabled() 5429 */ 5430 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) { 5431 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) { 5432 mViewFlags ^= SCROLLBARS_VERTICAL; 5433 computeOpaqueFlags(); 5434 recomputePadding(); 5435 } 5436 } 5437 5438 private void recomputePadding() { 5439 setPadding(mPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom); 5440 } 5441 5442 /** 5443 * Define whether scrollbars will fade when the view is not scrolling. 5444 * 5445 * @param fadeScrollbars wheter to enable fading 5446 * 5447 */ 5448 public void setScrollbarFadingEnabled(boolean fadeScrollbars) { 5449 initScrollCache(); 5450 final ScrollabilityCache scrollabilityCache = mScrollCache; 5451 scrollabilityCache.fadeScrollBars = fadeScrollbars; 5452 if (fadeScrollbars) { 5453 scrollabilityCache.state = ScrollabilityCache.OFF; 5454 } else { 5455 scrollabilityCache.state = ScrollabilityCache.ON; 5456 } 5457 } 5458 5459 /** 5460 * 5461 * Returns true if scrollbars will fade when this view is not scrolling 5462 * 5463 * @return true if scrollbar fading is enabled 5464 */ 5465 public boolean isScrollbarFadingEnabled() { 5466 return mScrollCache != null && mScrollCache.fadeScrollBars; 5467 } 5468 5469 /** 5470 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or 5471 * inset. When inset, they add to the padding of the view. And the scrollbars 5472 * can be drawn inside the padding area or on the edge of the view. For example, 5473 * if a view has a background drawable and you want to draw the scrollbars 5474 * inside the padding specified by the drawable, you can use 5475 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to 5476 * appear at the edge of the view, ignoring the padding, then you can use 5477 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p> 5478 * @param style the style of the scrollbars. Should be one of 5479 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET, 5480 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET. 5481 * @see #SCROLLBARS_INSIDE_OVERLAY 5482 * @see #SCROLLBARS_INSIDE_INSET 5483 * @see #SCROLLBARS_OUTSIDE_OVERLAY 5484 * @see #SCROLLBARS_OUTSIDE_INSET 5485 */ 5486 public void setScrollBarStyle(int style) { 5487 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) { 5488 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK); 5489 computeOpaqueFlags(); 5490 recomputePadding(); 5491 } 5492 } 5493 5494 /** 5495 * <p>Returns the current scrollbar style.</p> 5496 * @return the current scrollbar style 5497 * @see #SCROLLBARS_INSIDE_OVERLAY 5498 * @see #SCROLLBARS_INSIDE_INSET 5499 * @see #SCROLLBARS_OUTSIDE_OVERLAY 5500 * @see #SCROLLBARS_OUTSIDE_INSET 5501 */ 5502 public int getScrollBarStyle() { 5503 return mViewFlags & SCROLLBARS_STYLE_MASK; 5504 } 5505 5506 /** 5507 * <p>Compute the horizontal range that the horizontal scrollbar 5508 * represents.</p> 5509 * 5510 * <p>The range is expressed in arbitrary units that must be the same as the 5511 * units used by {@link #computeHorizontalScrollExtent()} and 5512 * {@link #computeHorizontalScrollOffset()}.</p> 5513 * 5514 * <p>The default range is the drawing width of this view.</p> 5515 * 5516 * @return the total horizontal range represented by the horizontal 5517 * scrollbar 5518 * 5519 * @see #computeHorizontalScrollExtent() 5520 * @see #computeHorizontalScrollOffset() 5521 * @see android.widget.ScrollBarDrawable 5522 */ 5523 protected int computeHorizontalScrollRange() { 5524 return getWidth(); 5525 } 5526 5527 /** 5528 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb 5529 * within the horizontal range. This value is used to compute the position 5530 * of the thumb within the scrollbar's track.</p> 5531 * 5532 * <p>The range is expressed in arbitrary units that must be the same as the 5533 * units used by {@link #computeHorizontalScrollRange()} and 5534 * {@link #computeHorizontalScrollExtent()}.</p> 5535 * 5536 * <p>The default offset is the scroll offset of this view.</p> 5537 * 5538 * @return the horizontal offset of the scrollbar's thumb 5539 * 5540 * @see #computeHorizontalScrollRange() 5541 * @see #computeHorizontalScrollExtent() 5542 * @see android.widget.ScrollBarDrawable 5543 */ 5544 protected int computeHorizontalScrollOffset() { 5545 return mScrollX; 5546 } 5547 5548 /** 5549 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb 5550 * within the horizontal range. This value is used to compute the length 5551 * of the thumb within the scrollbar's track.</p> 5552 * 5553 * <p>The range is expressed in arbitrary units that must be the same as the 5554 * units used by {@link #computeHorizontalScrollRange()} and 5555 * {@link #computeHorizontalScrollOffset()}.</p> 5556 * 5557 * <p>The default extent is the drawing width of this view.</p> 5558 * 5559 * @return the horizontal extent of the scrollbar's thumb 5560 * 5561 * @see #computeHorizontalScrollRange() 5562 * @see #computeHorizontalScrollOffset() 5563 * @see android.widget.ScrollBarDrawable 5564 */ 5565 protected int computeHorizontalScrollExtent() { 5566 return getWidth(); 5567 } 5568 5569 /** 5570 * <p>Compute the vertical range that the vertical scrollbar represents.</p> 5571 * 5572 * <p>The range is expressed in arbitrary units that must be the same as the 5573 * units used by {@link #computeVerticalScrollExtent()} and 5574 * {@link #computeVerticalScrollOffset()}.</p> 5575 * 5576 * @return the total vertical range represented by the vertical scrollbar 5577 * 5578 * <p>The default range is the drawing height of this view.</p> 5579 * 5580 * @see #computeVerticalScrollExtent() 5581 * @see #computeVerticalScrollOffset() 5582 * @see android.widget.ScrollBarDrawable 5583 */ 5584 protected int computeVerticalScrollRange() { 5585 return getHeight(); 5586 } 5587 5588 /** 5589 * <p>Compute the vertical offset of the vertical scrollbar's thumb 5590 * within the horizontal range. This value is used to compute the position 5591 * of the thumb within the scrollbar's track.</p> 5592 * 5593 * <p>The range is expressed in arbitrary units that must be the same as the 5594 * units used by {@link #computeVerticalScrollRange()} and 5595 * {@link #computeVerticalScrollExtent()}.</p> 5596 * 5597 * <p>The default offset is the scroll offset of this view.</p> 5598 * 5599 * @return the vertical offset of the scrollbar's thumb 5600 * 5601 * @see #computeVerticalScrollRange() 5602 * @see #computeVerticalScrollExtent() 5603 * @see android.widget.ScrollBarDrawable 5604 */ 5605 protected int computeVerticalScrollOffset() { 5606 return mScrollY; 5607 } 5608 5609 /** 5610 * <p>Compute the vertical extent of the horizontal scrollbar's thumb 5611 * within the vertical range. This value is used to compute the length 5612 * of the thumb within the scrollbar's track.</p> 5613 * 5614 * <p>The range is expressed in arbitrary units that must be the same as the 5615 * units used by {@link #computeHorizontalScrollRange()} and 5616 * {@link #computeVerticalScrollOffset()}.</p> 5617 * 5618 * <p>The default extent is the drawing height of this view.</p> 5619 * 5620 * @return the vertical extent of the scrollbar's thumb 5621 * 5622 * @see #computeVerticalScrollRange() 5623 * @see #computeVerticalScrollOffset() 5624 * @see android.widget.ScrollBarDrawable 5625 */ 5626 protected int computeVerticalScrollExtent() { 5627 return getHeight(); 5628 } 5629 5630 /** 5631 * <p>Request the drawing of the horizontal and the vertical scrollbar. The 5632 * scrollbars are painted only if they have been awakened first.</p> 5633 * 5634 * @param canvas the canvas on which to draw the scrollbars 5635 * 5636 * @see #awakenScrollBars(int) 5637 */ 5638 protected final void onDrawScrollBars(Canvas canvas) { 5639 // scrollbars are drawn only when the animation is running 5640 final ScrollabilityCache cache = mScrollCache; 5641 if (cache != null) { 5642 5643 int state = cache.state; 5644 5645 if (state == ScrollabilityCache.OFF) { 5646 return; 5647 } 5648 5649 boolean invalidate = false; 5650 5651 if (state == ScrollabilityCache.FADING) { 5652 // We're fading -- get our fade interpolation 5653 if (cache.interpolatorValues == null) { 5654 cache.interpolatorValues = new float[1]; 5655 } 5656 5657 float[] values = cache.interpolatorValues; 5658 5659 // Stops the animation if we're done 5660 if (cache.scrollBarInterpolator.timeToValues(values) == 5661 Interpolator.Result.FREEZE_END) { 5662 cache.state = ScrollabilityCache.OFF; 5663 } else { 5664 cache.scrollBar.setAlpha(Math.round(values[0])); 5665 } 5666 5667 // This will make the scroll bars inval themselves after 5668 // drawing. We only want this when we're fading so that 5669 // we prevent excessive redraws 5670 invalidate = true; 5671 } else { 5672 // We're just on -- but we may have been fading before so 5673 // reset alpha 5674 cache.scrollBar.setAlpha(255); 5675 } 5676 5677 5678 final int viewFlags = mViewFlags; 5679 5680 final boolean drawHorizontalScrollBar = 5681 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL; 5682 final boolean drawVerticalScrollBar = 5683 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL 5684 && !isVerticalScrollBarHidden(); 5685 5686 if (drawVerticalScrollBar || drawHorizontalScrollBar) { 5687 final int width = mRight - mLeft; 5688 final int height = mBottom - mTop; 5689 5690 final ScrollBarDrawable scrollBar = cache.scrollBar; 5691 int size = scrollBar.getSize(false); 5692 if (size <= 0) { 5693 size = cache.scrollBarSize; 5694 } 5695 5696 final int scrollX = mScrollX; 5697 final int scrollY = mScrollY; 5698 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0; 5699 5700 int left, top, right, bottom; 5701 5702 if (drawHorizontalScrollBar) { 5703 scrollBar.setParameters(computeHorizontalScrollRange(), 5704 computeHorizontalScrollOffset(), 5705 computeHorizontalScrollExtent(), false); 5706 final int verticalScrollBarGap = drawVerticalScrollBar ? 5707 getVerticalScrollbarWidth() : 0; 5708 top = scrollY + height - size - (mUserPaddingBottom & inside); 5709 left = scrollX + (mPaddingLeft & inside); 5710 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap; 5711 bottom = top + size; 5712 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom); 5713 if (invalidate) { 5714 invalidate(left, top, right, bottom); 5715 } 5716 } 5717 5718 if (drawVerticalScrollBar) { 5719 scrollBar.setParameters(computeVerticalScrollRange(), 5720 computeVerticalScrollOffset(), 5721 computeVerticalScrollExtent(), true); 5722 // TODO: Deal with RTL languages to position scrollbar on left 5723 left = scrollX + width - size - (mUserPaddingRight & inside); 5724 top = scrollY + (mPaddingTop & inside); 5725 right = left + size; 5726 bottom = scrollY + height - (mUserPaddingBottom & inside); 5727 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom); 5728 if (invalidate) { 5729 invalidate(left, top, right, bottom); 5730 } 5731 } 5732 } 5733 } 5734 } 5735 5736 /** 5737 * Override this if the vertical scrollbar needs to be hidden in a subclass, like when 5738 * FastScroller is visible. 5739 * @return whether to temporarily hide the vertical scrollbar 5740 * @hide 5741 */ 5742 protected boolean isVerticalScrollBarHidden() { 5743 return false; 5744 } 5745 5746 /** 5747 * <p>Draw the horizontal scrollbar if 5748 * {@link #isHorizontalScrollBarEnabled()} returns true.</p> 5749 * 5750 * @param canvas the canvas on which to draw the scrollbar 5751 * @param scrollBar the scrollbar's drawable 5752 * 5753 * @see #isHorizontalScrollBarEnabled() 5754 * @see #computeHorizontalScrollRange() 5755 * @see #computeHorizontalScrollExtent() 5756 * @see #computeHorizontalScrollOffset() 5757 * @see android.widget.ScrollBarDrawable 5758 * @hide 5759 */ 5760 protected void onDrawHorizontalScrollBar(Canvas canvas, 5761 Drawable scrollBar, 5762 int l, int t, int r, int b) { 5763 scrollBar.setBounds(l, t, r, b); 5764 scrollBar.draw(canvas); 5765 } 5766 5767 /** 5768 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()} 5769 * returns true.</p> 5770 * 5771 * @param canvas the canvas on which to draw the scrollbar 5772 * @param scrollBar the scrollbar's drawable 5773 * 5774 * @see #isVerticalScrollBarEnabled() 5775 * @see #computeVerticalScrollRange() 5776 * @see #computeVerticalScrollExtent() 5777 * @see #computeVerticalScrollOffset() 5778 * @see android.widget.ScrollBarDrawable 5779 * @hide 5780 */ 5781 protected void onDrawVerticalScrollBar(Canvas canvas, 5782 Drawable scrollBar, 5783 int l, int t, int r, int b) { 5784 scrollBar.setBounds(l, t, r, b); 5785 scrollBar.draw(canvas); 5786 } 5787 5788 /** 5789 * Implement this to do your drawing. 5790 * 5791 * @param canvas the canvas on which the background will be drawn 5792 */ 5793 protected void onDraw(Canvas canvas) { 5794 } 5795 5796 /* 5797 * Caller is responsible for calling requestLayout if necessary. 5798 * (This allows addViewInLayout to not request a new layout.) 5799 */ 5800 void assignParent(ViewParent parent) { 5801 if (mParent == null) { 5802 mParent = parent; 5803 } else if (parent == null) { 5804 mParent = null; 5805 } else { 5806 throw new RuntimeException("view " + this + " being added, but" 5807 + " it already has a parent"); 5808 } 5809 } 5810 5811 /** 5812 * This is called when the view is attached to a window. At this point it 5813 * has a Surface and will start drawing. Note that this function is 5814 * guaranteed to be called before {@link #onDraw}, however it may be called 5815 * any time before the first onDraw -- including before or after 5816 * {@link #onMeasure}. 5817 * 5818 * @see #onDetachedFromWindow() 5819 */ 5820 protected void onAttachedToWindow() { 5821 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) { 5822 mParent.requestTransparentRegion(this); 5823 } 5824 } 5825 5826 /** 5827 * This is called when the view is detached from a window. At this point it 5828 * no longer has a surface for drawing. 5829 * 5830 * @see #onAttachedToWindow() 5831 */ 5832 protected void onDetachedFromWindow() { 5833 removeLongPressCallback(); 5834 destroyDrawingCache(); 5835 } 5836 5837 /** 5838 * @return The number of times this view has been attached to a window 5839 */ 5840 protected int getWindowAttachCount() { 5841 return mWindowAttachCount; 5842 } 5843 5844 /** 5845 * Retrieve a unique token identifying the window this view is attached to. 5846 * @return Return the window's token for use in 5847 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}. 5848 */ 5849 public IBinder getWindowToken() { 5850 return mAttachInfo != null ? mAttachInfo.mWindowToken : null; 5851 } 5852 5853 /** 5854 * Retrieve a unique token identifying the top-level "real" window of 5855 * the window that this view is attached to. That is, this is like 5856 * {@link #getWindowToken}, except if the window this view in is a panel 5857 * window (attached to another containing window), then the token of 5858 * the containing window is returned instead. 5859 * 5860 * @return Returns the associated window token, either 5861 * {@link #getWindowToken()} or the containing window's token. 5862 */ 5863 public IBinder getApplicationWindowToken() { 5864 AttachInfo ai = mAttachInfo; 5865 if (ai != null) { 5866 IBinder appWindowToken = ai.mPanelParentWindowToken; 5867 if (appWindowToken == null) { 5868 appWindowToken = ai.mWindowToken; 5869 } 5870 return appWindowToken; 5871 } 5872 return null; 5873 } 5874 5875 /** 5876 * Retrieve private session object this view hierarchy is using to 5877 * communicate with the window manager. 5878 * @return the session object to communicate with the window manager 5879 */ 5880 /*package*/ IWindowSession getWindowSession() { 5881 return mAttachInfo != null ? mAttachInfo.mSession : null; 5882 } 5883 5884 /** 5885 * @param info the {@link android.view.View.AttachInfo} to associated with 5886 * this view 5887 */ 5888 void dispatchAttachedToWindow(AttachInfo info, int visibility) { 5889 //System.out.println("Attached! " + this); 5890 mAttachInfo = info; 5891 mWindowAttachCount++; 5892 if (mFloatingTreeObserver != null) { 5893 info.mTreeObserver.merge(mFloatingTreeObserver); 5894 mFloatingTreeObserver = null; 5895 } 5896 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) { 5897 mAttachInfo.mScrollContainers.add(this); 5898 mPrivateFlags |= SCROLL_CONTAINER_ADDED; 5899 } 5900 performCollectViewAttributes(visibility); 5901 onAttachedToWindow(); 5902 int vis = info.mWindowVisibility; 5903 if (vis != GONE) { 5904 onWindowVisibilityChanged(vis); 5905 } 5906 } 5907 5908 void dispatchDetachedFromWindow() { 5909 //System.out.println("Detached! " + this); 5910 AttachInfo info = mAttachInfo; 5911 if (info != null) { 5912 int vis = info.mWindowVisibility; 5913 if (vis != GONE) { 5914 onWindowVisibilityChanged(GONE); 5915 } 5916 } 5917 5918 onDetachedFromWindow(); 5919 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) { 5920 mAttachInfo.mScrollContainers.remove(this); 5921 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED; 5922 } 5923 mAttachInfo = null; 5924 } 5925 5926 /** 5927 * Store this view hierarchy's frozen state into the given container. 5928 * 5929 * @param container The SparseArray in which to save the view's state. 5930 * 5931 * @see #restoreHierarchyState 5932 * @see #dispatchSaveInstanceState 5933 * @see #onSaveInstanceState 5934 */ 5935 public void saveHierarchyState(SparseArray<Parcelable> container) { 5936 dispatchSaveInstanceState(container); 5937 } 5938 5939 /** 5940 * Called by {@link #saveHierarchyState} to store the state for this view and its children. 5941 * May be overridden to modify how freezing happens to a view's children; for example, some 5942 * views may want to not store state for their children. 5943 * 5944 * @param container The SparseArray in which to save the view's state. 5945 * 5946 * @see #dispatchRestoreInstanceState 5947 * @see #saveHierarchyState 5948 * @see #onSaveInstanceState 5949 */ 5950 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) { 5951 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) { 5952 mPrivateFlags &= ~SAVE_STATE_CALLED; 5953 Parcelable state = onSaveInstanceState(); 5954 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) { 5955 throw new IllegalStateException( 5956 "Derived class did not call super.onSaveInstanceState()"); 5957 } 5958 if (state != null) { 5959 // Log.i("View", "Freezing #" + Integer.toHexString(mID) 5960 // + ": " + state); 5961 container.put(mID, state); 5962 } 5963 } 5964 } 5965 5966 /** 5967 * Hook allowing a view to generate a representation of its internal state 5968 * that can later be used to create a new instance with that same state. 5969 * This state should only contain information that is not persistent or can 5970 * not be reconstructed later. For example, you will never store your 5971 * current position on screen because that will be computed again when a 5972 * new instance of the view is placed in its view hierarchy. 5973 * <p> 5974 * Some examples of things you may store here: the current cursor position 5975 * in a text view (but usually not the text itself since that is stored in a 5976 * content provider or other persistent storage), the currently selected 5977 * item in a list view. 5978 * 5979 * @return Returns a Parcelable object containing the view's current dynamic 5980 * state, or null if there is nothing interesting to save. The 5981 * default implementation returns null. 5982 * @see #onRestoreInstanceState 5983 * @see #saveHierarchyState 5984 * @see #dispatchSaveInstanceState 5985 * @see #setSaveEnabled(boolean) 5986 */ 5987 protected Parcelable onSaveInstanceState() { 5988 mPrivateFlags |= SAVE_STATE_CALLED; 5989 return BaseSavedState.EMPTY_STATE; 5990 } 5991 5992 /** 5993 * Restore this view hierarchy's frozen state from the given container. 5994 * 5995 * @param container The SparseArray which holds previously frozen states. 5996 * 5997 * @see #saveHierarchyState 5998 * @see #dispatchRestoreInstanceState 5999 * @see #onRestoreInstanceState 6000 */ 6001 public void restoreHierarchyState(SparseArray<Parcelable> container) { 6002 dispatchRestoreInstanceState(container); 6003 } 6004 6005 /** 6006 * Called by {@link #restoreHierarchyState} to retrieve the state for this view and its 6007 * children. May be overridden to modify how restoreing happens to a view's children; for 6008 * example, some views may want to not store state for their children. 6009 * 6010 * @param container The SparseArray which holds previously saved state. 6011 * 6012 * @see #dispatchSaveInstanceState 6013 * @see #restoreHierarchyState 6014 * @see #onRestoreInstanceState 6015 */ 6016 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) { 6017 if (mID != NO_ID) { 6018 Parcelable state = container.get(mID); 6019 if (state != null) { 6020 // Log.i("View", "Restoreing #" + Integer.toHexString(mID) 6021 // + ": " + state); 6022 mPrivateFlags &= ~SAVE_STATE_CALLED; 6023 onRestoreInstanceState(state); 6024 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) { 6025 throw new IllegalStateException( 6026 "Derived class did not call super.onRestoreInstanceState()"); 6027 } 6028 } 6029 } 6030 } 6031 6032 /** 6033 * Hook allowing a view to re-apply a representation of its internal state that had previously 6034 * been generated by {@link #onSaveInstanceState}. This function will never be called with a 6035 * null state. 6036 * 6037 * @param state The frozen state that had previously been returned by 6038 * {@link #onSaveInstanceState}. 6039 * 6040 * @see #onSaveInstanceState 6041 * @see #restoreHierarchyState 6042 * @see #dispatchRestoreInstanceState 6043 */ 6044 protected void onRestoreInstanceState(Parcelable state) { 6045 mPrivateFlags |= SAVE_STATE_CALLED; 6046 if (state != BaseSavedState.EMPTY_STATE && state != null) { 6047 throw new IllegalArgumentException("Wrong state class, expecting View State but " 6048 + "received " + state.getClass().toString() + " instead. This usually happens " 6049 + "when two views of different type have the same id in the same hierarchy. " 6050 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure " 6051 + "other views do not use the same id."); 6052 } 6053 } 6054 6055 /** 6056 * <p>Return the time at which the drawing of the view hierarchy started.</p> 6057 * 6058 * @return the drawing start time in milliseconds 6059 */ 6060 public long getDrawingTime() { 6061 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0; 6062 } 6063 6064 /** 6065 * <p>Enables or disables the duplication of the parent's state into this view. When 6066 * duplication is enabled, this view gets its drawable state from its parent rather 6067 * than from its own internal properties.</p> 6068 * 6069 * <p>Note: in the current implementation, setting this property to true after the 6070 * view was added to a ViewGroup might have no effect at all. This property should 6071 * always be used from XML or set to true before adding this view to a ViewGroup.</p> 6072 * 6073 * <p>Note: if this view's parent addStateFromChildren property is enabled and this 6074 * property is enabled, an exception will be thrown.</p> 6075 * 6076 * @param enabled True to enable duplication of the parent's drawable state, false 6077 * to disable it. 6078 * 6079 * @see #getDrawableState() 6080 * @see #isDuplicateParentStateEnabled() 6081 */ 6082 public void setDuplicateParentStateEnabled(boolean enabled) { 6083 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE); 6084 } 6085 6086 /** 6087 * <p>Indicates whether this duplicates its drawable state from its parent.</p> 6088 * 6089 * @return True if this view's drawable state is duplicated from the parent, 6090 * false otherwise 6091 * 6092 * @see #getDrawableState() 6093 * @see #setDuplicateParentStateEnabled(boolean) 6094 */ 6095 public boolean isDuplicateParentStateEnabled() { 6096 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE; 6097 } 6098 6099 /** 6100 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call 6101 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a 6102 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when 6103 * the cache is enabled. To benefit from the cache, you must request the drawing cache by 6104 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not 6105 * null.</p> 6106 * 6107 * @param enabled true to enable the drawing cache, false otherwise 6108 * 6109 * @see #isDrawingCacheEnabled() 6110 * @see #getDrawingCache() 6111 * @see #buildDrawingCache() 6112 */ 6113 public void setDrawingCacheEnabled(boolean enabled) { 6114 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED); 6115 } 6116 6117 /** 6118 * <p>Indicates whether the drawing cache is enabled for this view.</p> 6119 * 6120 * @return true if the drawing cache is enabled 6121 * 6122 * @see #setDrawingCacheEnabled(boolean) 6123 * @see #getDrawingCache() 6124 */ 6125 @ViewDebug.ExportedProperty 6126 public boolean isDrawingCacheEnabled() { 6127 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED; 6128 } 6129 6130 /** 6131 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p> 6132 * 6133 * @return A non-scaled bitmap representing this view or null if cache is disabled. 6134 * 6135 * @see #getDrawingCache(boolean) 6136 */ 6137 public Bitmap getDrawingCache() { 6138 return getDrawingCache(false); 6139 } 6140 6141 /** 6142 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap 6143 * is null when caching is disabled. If caching is enabled and the cache is not ready, 6144 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not 6145 * draw from the cache when the cache is enabled. To benefit from the cache, you must 6146 * request the drawing cache by calling this method and draw it on screen if the 6147 * returned bitmap is not null.</p> 6148 * 6149 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 6150 * this method will create a bitmap of the same size as this view. Because this bitmap 6151 * will be drawn scaled by the parent ViewGroup, the result on screen might show 6152 * scaling artifacts. To avoid such artifacts, you should call this method by setting 6153 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 6154 * size than the view. This implies that your application must be able to handle this 6155 * size.</p> 6156 * 6157 * @param autoScale Indicates whether the generated bitmap should be scaled based on 6158 * the current density of the screen when the application is in compatibility 6159 * mode. 6160 * 6161 * @return A bitmap representing this view or null if cache is disabled. 6162 * 6163 * @see #setDrawingCacheEnabled(boolean) 6164 * @see #isDrawingCacheEnabled() 6165 * @see #buildDrawingCache(boolean) 6166 * @see #destroyDrawingCache() 6167 */ 6168 public Bitmap getDrawingCache(boolean autoScale) { 6169 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) { 6170 return null; 6171 } 6172 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) { 6173 buildDrawingCache(autoScale); 6174 } 6175 return autoScale ? (mDrawingCache == null ? null : mDrawingCache.get()) : 6176 (mUnscaledDrawingCache == null ? null : mUnscaledDrawingCache.get()); 6177 } 6178 6179 /** 6180 * <p>Frees the resources used by the drawing cache. If you call 6181 * {@link #buildDrawingCache()} manually without calling 6182 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 6183 * should cleanup the cache with this method afterwards.</p> 6184 * 6185 * @see #setDrawingCacheEnabled(boolean) 6186 * @see #buildDrawingCache() 6187 * @see #getDrawingCache() 6188 */ 6189 public void destroyDrawingCache() { 6190 if (mDrawingCache != null) { 6191 final Bitmap bitmap = mDrawingCache.get(); 6192 if (bitmap != null) bitmap.recycle(); 6193 mDrawingCache = null; 6194 } 6195 if (mUnscaledDrawingCache != null) { 6196 final Bitmap bitmap = mUnscaledDrawingCache.get(); 6197 if (bitmap != null) bitmap.recycle(); 6198 mUnscaledDrawingCache = null; 6199 } 6200 } 6201 6202 /** 6203 * Setting a solid background color for the drawing cache's bitmaps will improve 6204 * perfromance and memory usage. Note, though that this should only be used if this 6205 * view will always be drawn on top of a solid color. 6206 * 6207 * @param color The background color to use for the drawing cache's bitmap 6208 * 6209 * @see #setDrawingCacheEnabled(boolean) 6210 * @see #buildDrawingCache() 6211 * @see #getDrawingCache() 6212 */ 6213 public void setDrawingCacheBackgroundColor(int color) { 6214 if (color != mDrawingCacheBackgroundColor) { 6215 mDrawingCacheBackgroundColor = color; 6216 mPrivateFlags &= ~DRAWING_CACHE_VALID; 6217 } 6218 } 6219 6220 /** 6221 * @see #setDrawingCacheBackgroundColor(int) 6222 * 6223 * @return The background color to used for the drawing cache's bitmap 6224 */ 6225 public int getDrawingCacheBackgroundColor() { 6226 return mDrawingCacheBackgroundColor; 6227 } 6228 6229 /** 6230 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p> 6231 * 6232 * @see #buildDrawingCache(boolean) 6233 */ 6234 public void buildDrawingCache() { 6235 buildDrawingCache(false); 6236 } 6237 6238 /** 6239 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p> 6240 * 6241 * <p>If you call {@link #buildDrawingCache()} manually without calling 6242 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you 6243 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p> 6244 * 6245 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled, 6246 * this method will create a bitmap of the same size as this view. Because this bitmap 6247 * will be drawn scaled by the parent ViewGroup, the result on screen might show 6248 * scaling artifacts. To avoid such artifacts, you should call this method by setting 6249 * the auto scaling to true. Doing so, however, will generate a bitmap of a different 6250 * size than the view. This implies that your application must be able to handle this 6251 * size.</p> 6252 * 6253 * @see #getDrawingCache() 6254 * @see #destroyDrawingCache() 6255 */ 6256 public void buildDrawingCache(boolean autoScale) { 6257 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ? 6258 (mDrawingCache == null || mDrawingCache.get() == null) : 6259 (mUnscaledDrawingCache == null || mUnscaledDrawingCache.get() == null))) { 6260 6261 if (ViewDebug.TRACE_HIERARCHY) { 6262 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE); 6263 } 6264 if (Config.DEBUG && ViewDebug.profileDrawing) { 6265 EventLog.writeEvent(60002, hashCode()); 6266 } 6267 6268 int width = mRight - mLeft; 6269 int height = mBottom - mTop; 6270 6271 final AttachInfo attachInfo = mAttachInfo; 6272 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired; 6273 6274 if (autoScale && scalingRequired) { 6275 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f); 6276 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f); 6277 } 6278 6279 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor; 6280 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque(); 6281 final boolean translucentWindow = attachInfo != null && attachInfo.mTranslucentWindow; 6282 6283 if (width <= 0 || height <= 0 || 6284 // Projected bitmap size in bytes 6285 (width * height * (opaque && !translucentWindow ? 2 : 4) > 6286 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) { 6287 destroyDrawingCache(); 6288 return; 6289 } 6290 6291 boolean clear = true; 6292 Bitmap bitmap = autoScale ? (mDrawingCache == null ? null : mDrawingCache.get()) : 6293 (mUnscaledDrawingCache == null ? null : mUnscaledDrawingCache.get()); 6294 6295 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) { 6296 Bitmap.Config quality; 6297 if (!opaque) { 6298 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) { 6299 case DRAWING_CACHE_QUALITY_AUTO: 6300 quality = Bitmap.Config.ARGB_8888; 6301 break; 6302 case DRAWING_CACHE_QUALITY_LOW: 6303 quality = Bitmap.Config.ARGB_4444; 6304 break; 6305 case DRAWING_CACHE_QUALITY_HIGH: 6306 quality = Bitmap.Config.ARGB_8888; 6307 break; 6308 default: 6309 quality = Bitmap.Config.ARGB_8888; 6310 break; 6311 } 6312 } else { 6313 // Optimization for translucent windows 6314 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy() 6315 quality = translucentWindow ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565; 6316 } 6317 6318 // Try to cleanup memory 6319 if (bitmap != null) bitmap.recycle(); 6320 6321 try { 6322 bitmap = Bitmap.createBitmap(width, height, quality); 6323 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi); 6324 if (autoScale) { 6325 mDrawingCache = new SoftReference<Bitmap>(bitmap); 6326 } else { 6327 mUnscaledDrawingCache = new SoftReference<Bitmap>(bitmap); 6328 } 6329 if (opaque && translucentWindow) bitmap.setHasAlpha(false); 6330 } catch (OutOfMemoryError e) { 6331 // If there is not enough memory to create the bitmap cache, just 6332 // ignore the issue as bitmap caches are not required to draw the 6333 // view hierarchy 6334 if (autoScale) { 6335 mDrawingCache = null; 6336 } else { 6337 mUnscaledDrawingCache = null; 6338 } 6339 return; 6340 } 6341 6342 clear = drawingCacheBackgroundColor != 0; 6343 } 6344 6345 Canvas canvas; 6346 if (attachInfo != null) { 6347 canvas = attachInfo.mCanvas; 6348 if (canvas == null) { 6349 canvas = new Canvas(); 6350 } 6351 canvas.setBitmap(bitmap); 6352 // Temporarily clobber the cached Canvas in case one of our children 6353 // is also using a drawing cache. Without this, the children would 6354 // steal the canvas by attaching their own bitmap to it and bad, bad 6355 // thing would happen (invisible views, corrupted drawings, etc.) 6356 attachInfo.mCanvas = null; 6357 } else { 6358 // This case should hopefully never or seldom happen 6359 canvas = new Canvas(bitmap); 6360 } 6361 6362 if (clear) { 6363 bitmap.eraseColor(drawingCacheBackgroundColor); 6364 } 6365 6366 computeScroll(); 6367 final int restoreCount = canvas.save(); 6368 6369 if (autoScale && scalingRequired) { 6370 final float scale = attachInfo.mApplicationScale; 6371 canvas.scale(scale, scale); 6372 } 6373 6374 canvas.translate(-mScrollX, -mScrollY); 6375 6376 mPrivateFlags |= DRAWN; 6377 mPrivateFlags |= DRAWING_CACHE_VALID; 6378 6379 // Fast path for layouts with no backgrounds 6380 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 6381 if (ViewDebug.TRACE_HIERARCHY) { 6382 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW); 6383 } 6384 mPrivateFlags &= ~DIRTY_MASK; 6385 dispatchDraw(canvas); 6386 } else { 6387 draw(canvas); 6388 } 6389 6390 canvas.restoreToCount(restoreCount); 6391 6392 if (attachInfo != null) { 6393 // Restore the cached Canvas for our siblings 6394 attachInfo.mCanvas = canvas; 6395 } 6396 } 6397 } 6398 6399 /** 6400 * Create a snapshot of the view into a bitmap. We should probably make 6401 * some form of this public, but should think about the API. 6402 */ 6403 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor) { 6404 int width = mRight - mLeft; 6405 int height = mBottom - mTop; 6406 6407 final AttachInfo attachInfo = mAttachInfo; 6408 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f; 6409 width = (int) ((width * scale) + 0.5f); 6410 height = (int) ((height * scale) + 0.5f); 6411 6412 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality); 6413 if (bitmap == null) { 6414 throw new OutOfMemoryError(); 6415 } 6416 6417 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi); 6418 6419 Canvas canvas; 6420 if (attachInfo != null) { 6421 canvas = attachInfo.mCanvas; 6422 if (canvas == null) { 6423 canvas = new Canvas(); 6424 } 6425 canvas.setBitmap(bitmap); 6426 // Temporarily clobber the cached Canvas in case one of our children 6427 // is also using a drawing cache. Without this, the children would 6428 // steal the canvas by attaching their own bitmap to it and bad, bad 6429 // things would happen (invisible views, corrupted drawings, etc.) 6430 attachInfo.mCanvas = null; 6431 } else { 6432 // This case should hopefully never or seldom happen 6433 canvas = new Canvas(bitmap); 6434 } 6435 6436 if ((backgroundColor & 0xff000000) != 0) { 6437 bitmap.eraseColor(backgroundColor); 6438 } 6439 6440 computeScroll(); 6441 final int restoreCount = canvas.save(); 6442 canvas.scale(scale, scale); 6443 canvas.translate(-mScrollX, -mScrollY); 6444 6445 // Temporarily remove the dirty mask 6446 int flags = mPrivateFlags; 6447 mPrivateFlags &= ~DIRTY_MASK; 6448 6449 // Fast path for layouts with no backgrounds 6450 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) { 6451 dispatchDraw(canvas); 6452 } else { 6453 draw(canvas); 6454 } 6455 6456 mPrivateFlags = flags; 6457 6458 canvas.restoreToCount(restoreCount); 6459 6460 if (attachInfo != null) { 6461 // Restore the cached Canvas for our siblings 6462 attachInfo.mCanvas = canvas; 6463 } 6464 6465 return bitmap; 6466 } 6467 6468 /** 6469 * Indicates whether this View is currently in edit mode. A View is usually 6470 * in edit mode when displayed within a developer tool. For instance, if 6471 * this View is being drawn by a visual user interface builder, this method 6472 * should return true. 6473 * 6474 * Subclasses should check the return value of this method to provide 6475 * different behaviors if their normal behavior might interfere with the 6476 * host environment. For instance: the class spawns a thread in its 6477 * constructor, the drawing code relies on device-specific features, etc. 6478 * 6479 * This method is usually checked in the drawing code of custom widgets. 6480 * 6481 * @return True if this View is in edit mode, false otherwise. 6482 */ 6483 public boolean isInEditMode() { 6484 return false; 6485 } 6486 6487 /** 6488 * If the View draws content inside its padding and enables fading edges, 6489 * it needs to support padding offsets. Padding offsets are added to the 6490 * fading edges to extend the length of the fade so that it covers pixels 6491 * drawn inside the padding. 6492 * 6493 * Subclasses of this class should override this method if they need 6494 * to draw content inside the padding. 6495 * 6496 * @return True if padding offset must be applied, false otherwise. 6497 * 6498 * @see #getLeftPaddingOffset() 6499 * @see #getRightPaddingOffset() 6500 * @see #getTopPaddingOffset() 6501 * @see #getBottomPaddingOffset() 6502 * 6503 * @since CURRENT 6504 */ 6505 protected boolean isPaddingOffsetRequired() { 6506 return false; 6507 } 6508 6509 /** 6510 * Amount by which to extend the left fading region. Called only when 6511 * {@link #isPaddingOffsetRequired()} returns true. 6512 * 6513 * @return The left padding offset in pixels. 6514 * 6515 * @see #isPaddingOffsetRequired() 6516 * 6517 * @since CURRENT 6518 */ 6519 protected int getLeftPaddingOffset() { 6520 return 0; 6521 } 6522 6523 /** 6524 * Amount by which to extend the right fading region. Called only when 6525 * {@link #isPaddingOffsetRequired()} returns true. 6526 * 6527 * @return The right padding offset in pixels. 6528 * 6529 * @see #isPaddingOffsetRequired() 6530 * 6531 * @since CURRENT 6532 */ 6533 protected int getRightPaddingOffset() { 6534 return 0; 6535 } 6536 6537 /** 6538 * Amount by which to extend the top fading region. Called only when 6539 * {@link #isPaddingOffsetRequired()} returns true. 6540 * 6541 * @return The top padding offset in pixels. 6542 * 6543 * @see #isPaddingOffsetRequired() 6544 * 6545 * @since CURRENT 6546 */ 6547 protected int getTopPaddingOffset() { 6548 return 0; 6549 } 6550 6551 /** 6552 * Amount by which to extend the bottom fading region. Called only when 6553 * {@link #isPaddingOffsetRequired()} returns true. 6554 * 6555 * @return The bottom padding offset in pixels. 6556 * 6557 * @see #isPaddingOffsetRequired() 6558 * 6559 * @since CURRENT 6560 */ 6561 protected int getBottomPaddingOffset() { 6562 return 0; 6563 } 6564 6565 /** 6566 * Manually render this view (and all of its children) to the given Canvas. 6567 * The view must have already done a full layout before this function is 6568 * called. When implementing a view, do not override this method; instead, 6569 * you should implement {@link #onDraw}. 6570 * 6571 * @param canvas The Canvas to which the View is rendered. 6572 */ 6573 public void draw(Canvas canvas) { 6574 if (ViewDebug.TRACE_HIERARCHY) { 6575 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW); 6576 } 6577 6578 final int privateFlags = mPrivateFlags; 6579 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE && 6580 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState); 6581 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN; 6582 6583 /* 6584 * Draw traversal performs several drawing steps which must be executed 6585 * in the appropriate order: 6586 * 6587 * 1. Draw the background 6588 * 2. If necessary, save the canvas' layers to prepare for fading 6589 * 3. Draw view's content 6590 * 4. Draw children 6591 * 5. If necessary, draw the fading edges and restore layers 6592 * 6. Draw decorations (scrollbars for instance) 6593 */ 6594 6595 // Step 1, draw the background, if needed 6596 int saveCount; 6597 6598 if (!dirtyOpaque) { 6599 final Drawable background = mBGDrawable; 6600 if (background != null) { 6601 final int scrollX = mScrollX; 6602 final int scrollY = mScrollY; 6603 6604 if (mBackgroundSizeChanged) { 6605 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop); 6606 mBackgroundSizeChanged = false; 6607 } 6608 6609 if ((scrollX | scrollY) == 0) { 6610 background.draw(canvas); 6611 } else { 6612 canvas.translate(scrollX, scrollY); 6613 background.draw(canvas); 6614 canvas.translate(-scrollX, -scrollY); 6615 } 6616 } 6617 } 6618 6619 // skip step 2 & 5 if possible (common case) 6620 final int viewFlags = mViewFlags; 6621 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0; 6622 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0; 6623 if (!verticalEdges && !horizontalEdges) { 6624 // Step 3, draw the content 6625 if (!dirtyOpaque) onDraw(canvas); 6626 6627 // Step 4, draw the children 6628 dispatchDraw(canvas); 6629 6630 // Step 6, draw decorations (scrollbars) 6631 onDrawScrollBars(canvas); 6632 6633 // we're done... 6634 return; 6635 } 6636 6637 /* 6638 * Here we do the full fledged routine... 6639 * (this is an uncommon case where speed matters less, 6640 * this is why we repeat some of the tests that have been 6641 * done above) 6642 */ 6643 6644 boolean drawTop = false; 6645 boolean drawBottom = false; 6646 boolean drawLeft = false; 6647 boolean drawRight = false; 6648 6649 float topFadeStrength = 0.0f; 6650 float bottomFadeStrength = 0.0f; 6651 float leftFadeStrength = 0.0f; 6652 float rightFadeStrength = 0.0f; 6653 6654 // Step 2, save the canvas' layers 6655 int paddingLeft = mPaddingLeft; 6656 int paddingTop = mPaddingTop; 6657 6658 final boolean offsetRequired = isPaddingOffsetRequired(); 6659 if (offsetRequired) { 6660 paddingLeft += getLeftPaddingOffset(); 6661 paddingTop += getTopPaddingOffset(); 6662 } 6663 6664 int left = mScrollX + paddingLeft; 6665 int right = left + mRight - mLeft - mPaddingRight - paddingLeft; 6666 int top = mScrollY + paddingTop; 6667 int bottom = top + mBottom - mTop - mPaddingBottom - paddingTop; 6668 6669 if (offsetRequired) { 6670 right += getRightPaddingOffset(); 6671 bottom += getBottomPaddingOffset(); 6672 } 6673 6674 final ScrollabilityCache scrollabilityCache = mScrollCache; 6675 int length = scrollabilityCache.fadingEdgeLength; 6676 6677 // clip the fade length if top and bottom fades overlap 6678 // overlapping fades produce odd-looking artifacts 6679 if (verticalEdges && (top + length > bottom - length)) { 6680 length = (bottom - top) / 2; 6681 } 6682 6683 // also clip horizontal fades if necessary 6684 if (horizontalEdges && (left + length > right - length)) { 6685 length = (right - left) / 2; 6686 } 6687 6688 if (verticalEdges) { 6689 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength())); 6690 drawTop = topFadeStrength >= 0.0f; 6691 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength())); 6692 drawBottom = bottomFadeStrength >= 0.0f; 6693 } 6694 6695 if (horizontalEdges) { 6696 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength())); 6697 drawLeft = leftFadeStrength >= 0.0f; 6698 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength())); 6699 drawRight = rightFadeStrength >= 0.0f; 6700 } 6701 6702 saveCount = canvas.getSaveCount(); 6703 6704 int solidColor = getSolidColor(); 6705 if (solidColor == 0) { 6706 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG; 6707 6708 if (drawTop) { 6709 canvas.saveLayer(left, top, right, top + length, null, flags); 6710 } 6711 6712 if (drawBottom) { 6713 canvas.saveLayer(left, bottom - length, right, bottom, null, flags); 6714 } 6715 6716 if (drawLeft) { 6717 canvas.saveLayer(left, top, left + length, bottom, null, flags); 6718 } 6719 6720 if (drawRight) { 6721 canvas.saveLayer(right - length, top, right, bottom, null, flags); 6722 } 6723 } else { 6724 scrollabilityCache.setFadeColor(solidColor); 6725 } 6726 6727 // Step 3, draw the content 6728 if (!dirtyOpaque) onDraw(canvas); 6729 6730 // Step 4, draw the children 6731 dispatchDraw(canvas); 6732 6733 // Step 5, draw the fade effect and restore layers 6734 final Paint p = scrollabilityCache.paint; 6735 final Matrix matrix = scrollabilityCache.matrix; 6736 final Shader fade = scrollabilityCache.shader; 6737 final float fadeHeight = scrollabilityCache.fadingEdgeLength; 6738 6739 if (drawTop) { 6740 matrix.setScale(1, fadeHeight * topFadeStrength); 6741 matrix.postTranslate(left, top); 6742 fade.setLocalMatrix(matrix); 6743 canvas.drawRect(left, top, right, top + length, p); 6744 } 6745 6746 if (drawBottom) { 6747 matrix.setScale(1, fadeHeight * bottomFadeStrength); 6748 matrix.postRotate(180); 6749 matrix.postTranslate(left, bottom); 6750 fade.setLocalMatrix(matrix); 6751 canvas.drawRect(left, bottom - length, right, bottom, p); 6752 } 6753 6754 if (drawLeft) { 6755 matrix.setScale(1, fadeHeight * leftFadeStrength); 6756 matrix.postRotate(-90); 6757 matrix.postTranslate(left, top); 6758 fade.setLocalMatrix(matrix); 6759 canvas.drawRect(left, top, left + length, bottom, p); 6760 } 6761 6762 if (drawRight) { 6763 matrix.setScale(1, fadeHeight * rightFadeStrength); 6764 matrix.postRotate(90); 6765 matrix.postTranslate(right, top); 6766 fade.setLocalMatrix(matrix); 6767 canvas.drawRect(right - length, top, right, bottom, p); 6768 } 6769 6770 canvas.restoreToCount(saveCount); 6771 6772 // Step 6, draw decorations (scrollbars) 6773 onDrawScrollBars(canvas); 6774 } 6775 6776 /** 6777 * Override this if your view is known to always be drawn on top of a solid color background, 6778 * and needs to draw fading edges. Returning a non-zero color enables the view system to 6779 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha 6780 * should be set to 0xFF. 6781 * 6782 * @see #setVerticalFadingEdgeEnabled 6783 * @see #setHorizontalFadingEdgeEnabled 6784 * 6785 * @return The known solid color background for this view, or 0 if the color may vary 6786 */ 6787 public int getSolidColor() { 6788 return 0; 6789 } 6790 6791 /** 6792 * Build a human readable string representation of the specified view flags. 6793 * 6794 * @param flags the view flags to convert to a string 6795 * @return a String representing the supplied flags 6796 */ 6797 private static String printFlags(int flags) { 6798 String output = ""; 6799 int numFlags = 0; 6800 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) { 6801 output += "TAKES_FOCUS"; 6802 numFlags++; 6803 } 6804 6805 switch (flags & VISIBILITY_MASK) { 6806 case INVISIBLE: 6807 if (numFlags > 0) { 6808 output += " "; 6809 } 6810 output += "INVISIBLE"; 6811 // USELESS HERE numFlags++; 6812 break; 6813 case GONE: 6814 if (numFlags > 0) { 6815 output += " "; 6816 } 6817 output += "GONE"; 6818 // USELESS HERE numFlags++; 6819 break; 6820 default: 6821 break; 6822 } 6823 return output; 6824 } 6825 6826 /** 6827 * Build a human readable string representation of the specified private 6828 * view flags. 6829 * 6830 * @param privateFlags the private view flags to convert to a string 6831 * @return a String representing the supplied flags 6832 */ 6833 private static String printPrivateFlags(int privateFlags) { 6834 String output = ""; 6835 int numFlags = 0; 6836 6837 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) { 6838 output += "WANTS_FOCUS"; 6839 numFlags++; 6840 } 6841 6842 if ((privateFlags & FOCUSED) == FOCUSED) { 6843 if (numFlags > 0) { 6844 output += " "; 6845 } 6846 output += "FOCUSED"; 6847 numFlags++; 6848 } 6849 6850 if ((privateFlags & SELECTED) == SELECTED) { 6851 if (numFlags > 0) { 6852 output += " "; 6853 } 6854 output += "SELECTED"; 6855 numFlags++; 6856 } 6857 6858 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) { 6859 if (numFlags > 0) { 6860 output += " "; 6861 } 6862 output += "IS_ROOT_NAMESPACE"; 6863 numFlags++; 6864 } 6865 6866 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) { 6867 if (numFlags > 0) { 6868 output += " "; 6869 } 6870 output += "HAS_BOUNDS"; 6871 numFlags++; 6872 } 6873 6874 if ((privateFlags & DRAWN) == DRAWN) { 6875 if (numFlags > 0) { 6876 output += " "; 6877 } 6878 output += "DRAWN"; 6879 // USELESS HERE numFlags++; 6880 } 6881 return output; 6882 } 6883 6884 /** 6885 * <p>Indicates whether or not this view's layout will be requested during 6886 * the next hierarchy layout pass.</p> 6887 * 6888 * @return true if the layout will be forced during next layout pass 6889 */ 6890 public boolean isLayoutRequested() { 6891 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT; 6892 } 6893 6894 /** 6895 * Assign a size and position to a view and all of its 6896 * descendants 6897 * 6898 * <p>This is the second phase of the layout mechanism. 6899 * (The first is measuring). In this phase, each parent calls 6900 * layout on all of its children to position them. 6901 * This is typically done using the child measurements 6902 * that were stored in the measure pass(). 6903 * 6904 * Derived classes with children should override 6905 * onLayout. In that method, they should 6906 * call layout on each of their their children. 6907 * 6908 * @param l Left position, relative to parent 6909 * @param t Top position, relative to parent 6910 * @param r Right position, relative to parent 6911 * @param b Bottom position, relative to parent 6912 */ 6913 public final void layout(int l, int t, int r, int b) { 6914 boolean changed = setFrame(l, t, r, b); 6915 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) { 6916 if (ViewDebug.TRACE_HIERARCHY) { 6917 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT); 6918 } 6919 6920 onLayout(changed, l, t, r, b); 6921 mPrivateFlags &= ~LAYOUT_REQUIRED; 6922 } 6923 mPrivateFlags &= ~FORCE_LAYOUT; 6924 } 6925 6926 /** 6927 * Called from layout when this view should 6928 * assign a size and position to each of its children. 6929 * 6930 * Derived classes with children should override 6931 * this method and call layout on each of 6932 * their their children. 6933 * @param changed This is a new size or position for this view 6934 * @param left Left position, relative to parent 6935 * @param top Top position, relative to parent 6936 * @param right Right position, relative to parent 6937 * @param bottom Bottom position, relative to parent 6938 */ 6939 protected void onLayout(boolean changed, int left, int top, int right, int bottom) { 6940 } 6941 6942 /** 6943 * Assign a size and position to this view. 6944 * 6945 * This is called from layout. 6946 * 6947 * @param left Left position, relative to parent 6948 * @param top Top position, relative to parent 6949 * @param right Right position, relative to parent 6950 * @param bottom Bottom position, relative to parent 6951 * @return true if the new size and position are different than the 6952 * previous ones 6953 * {@hide} 6954 */ 6955 protected boolean setFrame(int left, int top, int right, int bottom) { 6956 boolean changed = false; 6957 6958 if (DBG) { 6959 Log.d("View", this + " View.setFrame(" + left + "," + top + "," 6960 + right + "," + bottom + ")"); 6961 } 6962 6963 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) { 6964 changed = true; 6965 6966 // Remember our drawn bit 6967 int drawn = mPrivateFlags & DRAWN; 6968 6969 // Invalidate our old position 6970 invalidate(); 6971 6972 6973 int oldWidth = mRight - mLeft; 6974 int oldHeight = mBottom - mTop; 6975 6976 mLeft = left; 6977 mTop = top; 6978 mRight = right; 6979 mBottom = bottom; 6980 6981 mPrivateFlags |= HAS_BOUNDS; 6982 6983 int newWidth = right - left; 6984 int newHeight = bottom - top; 6985 6986 if (newWidth != oldWidth || newHeight != oldHeight) { 6987 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight); 6988 } 6989 6990 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) { 6991 // If we are visible, force the DRAWN bit to on so that 6992 // this invalidate will go through (at least to our parent). 6993 // This is because someone may have invalidated this view 6994 // before this call to setFrame came in, therby clearing 6995 // the DRAWN bit. 6996 mPrivateFlags |= DRAWN; 6997 invalidate(); 6998 } 6999 7000 // Reset drawn bit to original value (invalidate turns it off) 7001 mPrivateFlags |= drawn; 7002 7003 mBackgroundSizeChanged = true; 7004 } 7005 return changed; 7006 } 7007 7008 /** 7009 * Finalize inflating a view from XML. This is called as the last phase 7010 * of inflation, after all child views have been added. 7011 * 7012 * <p>Even if the subclass overrides onFinishInflate, they should always be 7013 * sure to call the super method, so that we get called. 7014 */ 7015 protected void onFinishInflate() { 7016 } 7017 7018 /** 7019 * Returns the resources associated with this view. 7020 * 7021 * @return Resources object. 7022 */ 7023 public Resources getResources() { 7024 return mResources; 7025 } 7026 7027 /** 7028 * Invalidates the specified Drawable. 7029 * 7030 * @param drawable the drawable to invalidate 7031 */ 7032 public void invalidateDrawable(Drawable drawable) { 7033 if (verifyDrawable(drawable)) { 7034 final Rect dirty = drawable.getBounds(); 7035 final int scrollX = mScrollX; 7036 final int scrollY = mScrollY; 7037 7038 invalidate(dirty.left + scrollX, dirty.top + scrollY, 7039 dirty.right + scrollX, dirty.bottom + scrollY); 7040 } 7041 } 7042 7043 /** 7044 * Schedules an action on a drawable to occur at a specified time. 7045 * 7046 * @param who the recipient of the action 7047 * @param what the action to run on the drawable 7048 * @param when the time at which the action must occur. Uses the 7049 * {@link SystemClock#uptimeMillis} timebase. 7050 */ 7051 public void scheduleDrawable(Drawable who, Runnable what, long when) { 7052 if (verifyDrawable(who) && what != null && mAttachInfo != null) { 7053 mAttachInfo.mHandler.postAtTime(what, who, when); 7054 } 7055 } 7056 7057 /** 7058 * Cancels a scheduled action on a drawable. 7059 * 7060 * @param who the recipient of the action 7061 * @param what the action to cancel 7062 */ 7063 public void unscheduleDrawable(Drawable who, Runnable what) { 7064 if (verifyDrawable(who) && what != null && mAttachInfo != null) { 7065 mAttachInfo.mHandler.removeCallbacks(what, who); 7066 } 7067 } 7068 7069 /** 7070 * Unschedule any events associated with the given Drawable. This can be 7071 * used when selecting a new Drawable into a view, so that the previous 7072 * one is completely unscheduled. 7073 * 7074 * @param who The Drawable to unschedule. 7075 * 7076 * @see #drawableStateChanged 7077 */ 7078 public void unscheduleDrawable(Drawable who) { 7079 if (mAttachInfo != null) { 7080 mAttachInfo.mHandler.removeCallbacksAndMessages(who); 7081 } 7082 } 7083 7084 /** 7085 * If your view subclass is displaying its own Drawable objects, it should 7086 * override this function and return true for any Drawable it is 7087 * displaying. This allows animations for those drawables to be 7088 * scheduled. 7089 * 7090 * <p>Be sure to call through to the super class when overriding this 7091 * function. 7092 * 7093 * @param who The Drawable to verify. Return true if it is one you are 7094 * displaying, else return the result of calling through to the 7095 * super class. 7096 * 7097 * @return boolean If true than the Drawable is being displayed in the 7098 * view; else false and it is not allowed to animate. 7099 * 7100 * @see #unscheduleDrawable 7101 * @see #drawableStateChanged 7102 */ 7103 protected boolean verifyDrawable(Drawable who) { 7104 return who == mBGDrawable; 7105 } 7106 7107 /** 7108 * This function is called whenever the state of the view changes in such 7109 * a way that it impacts the state of drawables being shown. 7110 * 7111 * <p>Be sure to call through to the superclass when overriding this 7112 * function. 7113 * 7114 * @see Drawable#setState 7115 */ 7116 protected void drawableStateChanged() { 7117 Drawable d = mBGDrawable; 7118 if (d != null && d.isStateful()) { 7119 d.setState(getDrawableState()); 7120 } 7121 } 7122 7123 /** 7124 * Call this to force a view to update its drawable state. This will cause 7125 * drawableStateChanged to be called on this view. Views that are interested 7126 * in the new state should call getDrawableState. 7127 * 7128 * @see #drawableStateChanged 7129 * @see #getDrawableState 7130 */ 7131 public void refreshDrawableState() { 7132 mPrivateFlags |= DRAWABLE_STATE_DIRTY; 7133 drawableStateChanged(); 7134 7135 ViewParent parent = mParent; 7136 if (parent != null) { 7137 parent.childDrawableStateChanged(this); 7138 } 7139 } 7140 7141 /** 7142 * Return an array of resource IDs of the drawable states representing the 7143 * current state of the view. 7144 * 7145 * @return The current drawable state 7146 * 7147 * @see Drawable#setState 7148 * @see #drawableStateChanged 7149 * @see #onCreateDrawableState 7150 */ 7151 public final int[] getDrawableState() { 7152 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) { 7153 return mDrawableState; 7154 } else { 7155 mDrawableState = onCreateDrawableState(0); 7156 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY; 7157 return mDrawableState; 7158 } 7159 } 7160 7161 /** 7162 * Generate the new {@link android.graphics.drawable.Drawable} state for 7163 * this view. This is called by the view 7164 * system when the cached Drawable state is determined to be invalid. To 7165 * retrieve the current state, you should use {@link #getDrawableState}. 7166 * 7167 * @param extraSpace if non-zero, this is the number of extra entries you 7168 * would like in the returned array in which you can place your own 7169 * states. 7170 * 7171 * @return Returns an array holding the current {@link Drawable} state of 7172 * the view. 7173 * 7174 * @see #mergeDrawableStates 7175 */ 7176 protected int[] onCreateDrawableState(int extraSpace) { 7177 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE && 7178 mParent instanceof View) { 7179 return ((View) mParent).onCreateDrawableState(extraSpace); 7180 } 7181 7182 int[] drawableState; 7183 7184 int privateFlags = mPrivateFlags; 7185 7186 int viewStateIndex = (((privateFlags & PRESSED) != 0) ? 1 : 0); 7187 7188 viewStateIndex = (viewStateIndex << 1) 7189 + (((mViewFlags & ENABLED_MASK) == ENABLED) ? 1 : 0); 7190 7191 viewStateIndex = (viewStateIndex << 1) + (isFocused() ? 1 : 0); 7192 7193 viewStateIndex = (viewStateIndex << 1) 7194 + (((privateFlags & SELECTED) != 0) ? 1 : 0); 7195 7196 final boolean hasWindowFocus = hasWindowFocus(); 7197 viewStateIndex = (viewStateIndex << 1) + (hasWindowFocus ? 1 : 0); 7198 7199 drawableState = VIEW_STATE_SETS[viewStateIndex]; 7200 7201 //noinspection ConstantIfStatement 7202 if (false) { 7203 Log.i("View", "drawableStateIndex=" + viewStateIndex); 7204 Log.i("View", toString() 7205 + " pressed=" + ((privateFlags & PRESSED) != 0) 7206 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED) 7207 + " fo=" + hasFocus() 7208 + " sl=" + ((privateFlags & SELECTED) != 0) 7209 + " wf=" + hasWindowFocus 7210 + ": " + Arrays.toString(drawableState)); 7211 } 7212 7213 if (extraSpace == 0) { 7214 return drawableState; 7215 } 7216 7217 final int[] fullState; 7218 if (drawableState != null) { 7219 fullState = new int[drawableState.length + extraSpace]; 7220 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length); 7221 } else { 7222 fullState = new int[extraSpace]; 7223 } 7224 7225 return fullState; 7226 } 7227 7228 /** 7229 * Merge your own state values in <var>additionalState</var> into the base 7230 * state values <var>baseState</var> that were returned by 7231 * {@link #onCreateDrawableState}. 7232 * 7233 * @param baseState The base state values returned by 7234 * {@link #onCreateDrawableState}, which will be modified to also hold your 7235 * own additional state values. 7236 * 7237 * @param additionalState The additional state values you would like 7238 * added to <var>baseState</var>; this array is not modified. 7239 * 7240 * @return As a convenience, the <var>baseState</var> array you originally 7241 * passed into the function is returned. 7242 * 7243 * @see #onCreateDrawableState 7244 */ 7245 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) { 7246 final int N = baseState.length; 7247 int i = N - 1; 7248 while (i >= 0 && baseState[i] == 0) { 7249 i--; 7250 } 7251 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length); 7252 return baseState; 7253 } 7254 7255 /** 7256 * Sets the background color for this view. 7257 * @param color the color of the background 7258 */ 7259 public void setBackgroundColor(int color) { 7260 setBackgroundDrawable(new ColorDrawable(color)); 7261 } 7262 7263 /** 7264 * Set the background to a given resource. The resource should refer to 7265 * a Drawable object or 0 to remove the background. 7266 * @param resid The identifier of the resource. 7267 * @attr ref android.R.styleable#View_background 7268 */ 7269 public void setBackgroundResource(int resid) { 7270 if (resid != 0 && resid == mBackgroundResource) { 7271 return; 7272 } 7273 7274 Drawable d= null; 7275 if (resid != 0) { 7276 d = mResources.getDrawable(resid); 7277 } 7278 setBackgroundDrawable(d); 7279 7280 mBackgroundResource = resid; 7281 } 7282 7283 /** 7284 * Set the background to a given Drawable, or remove the background. If the 7285 * background has padding, this View's padding is set to the background's 7286 * padding. However, when a background is removed, this View's padding isn't 7287 * touched. If setting the padding is desired, please use 7288 * {@link #setPadding(int, int, int, int)}. 7289 * 7290 * @param d The Drawable to use as the background, or null to remove the 7291 * background 7292 */ 7293 public void setBackgroundDrawable(Drawable d) { 7294 boolean requestLayout = false; 7295 7296 mBackgroundResource = 0; 7297 7298 /* 7299 * Regardless of whether we're setting a new background or not, we want 7300 * to clear the previous drawable. 7301 */ 7302 if (mBGDrawable != null) { 7303 mBGDrawable.setCallback(null); 7304 unscheduleDrawable(mBGDrawable); 7305 } 7306 7307 if (d != null) { 7308 Rect padding = sThreadLocal.get(); 7309 if (padding == null) { 7310 padding = new Rect(); 7311 sThreadLocal.set(padding); 7312 } 7313 if (d.getPadding(padding)) { 7314 setPadding(padding.left, padding.top, padding.right, padding.bottom); 7315 } 7316 7317 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or 7318 // if it has a different minimum size, we should layout again 7319 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() || 7320 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) { 7321 requestLayout = true; 7322 } 7323 7324 d.setCallback(this); 7325 if (d.isStateful()) { 7326 d.setState(getDrawableState()); 7327 } 7328 d.setVisible(getVisibility() == VISIBLE, false); 7329 mBGDrawable = d; 7330 7331 if ((mPrivateFlags & SKIP_DRAW) != 0) { 7332 mPrivateFlags &= ~SKIP_DRAW; 7333 mPrivateFlags |= ONLY_DRAWS_BACKGROUND; 7334 requestLayout = true; 7335 } 7336 } else { 7337 /* Remove the background */ 7338 mBGDrawable = null; 7339 7340 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) { 7341 /* 7342 * This view ONLY drew the background before and we're removing 7343 * the background, so now it won't draw anything 7344 * (hence we SKIP_DRAW) 7345 */ 7346 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND; 7347 mPrivateFlags |= SKIP_DRAW; 7348 } 7349 7350 /* 7351 * When the background is set, we try to apply its padding to this 7352 * View. When the background is removed, we don't touch this View's 7353 * padding. This is noted in the Javadocs. Hence, we don't need to 7354 * requestLayout(), the invalidate() below is sufficient. 7355 */ 7356 7357 // The old background's minimum size could have affected this 7358 // View's layout, so let's requestLayout 7359 requestLayout = true; 7360 } 7361 7362 computeOpaqueFlags(); 7363 7364 if (requestLayout) { 7365 requestLayout(); 7366 } 7367 7368 mBackgroundSizeChanged = true; 7369 invalidate(); 7370 } 7371 7372 /** 7373 * Gets the background drawable 7374 * @return The drawable used as the background for this view, if any. 7375 */ 7376 public Drawable getBackground() { 7377 return mBGDrawable; 7378 } 7379 7380 /** 7381 * Sets the padding. The view may add on the space required to display 7382 * the scrollbars, depending on the style and visibility of the scrollbars. 7383 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop}, 7384 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different 7385 * from the values set in this call. 7386 * 7387 * @attr ref android.R.styleable#View_padding 7388 * @attr ref android.R.styleable#View_paddingBottom 7389 * @attr ref android.R.styleable#View_paddingLeft 7390 * @attr ref android.R.styleable#View_paddingRight 7391 * @attr ref android.R.styleable#View_paddingTop 7392 * @param left the left padding in pixels 7393 * @param top the top padding in pixels 7394 * @param right the right padding in pixels 7395 * @param bottom the bottom padding in pixels 7396 */ 7397 public void setPadding(int left, int top, int right, int bottom) { 7398 boolean changed = false; 7399 7400 mUserPaddingRight = right; 7401 mUserPaddingBottom = bottom; 7402 7403 final int viewFlags = mViewFlags; 7404 7405 // Common case is there are no scroll bars. 7406 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) { 7407 // TODO: Deal with RTL languages to adjust left padding instead of right. 7408 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) { 7409 right += (viewFlags & SCROLLBARS_INSET_MASK) == 0 7410 ? 0 : getVerticalScrollbarWidth(); 7411 } 7412 if ((viewFlags & SCROLLBARS_HORIZONTAL) == 0) { 7413 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0 7414 ? 0 : getHorizontalScrollbarHeight(); 7415 } 7416 } 7417 7418 if (mPaddingLeft != left) { 7419 changed = true; 7420 mPaddingLeft = left; 7421 } 7422 if (mPaddingTop != top) { 7423 changed = true; 7424 mPaddingTop = top; 7425 } 7426 if (mPaddingRight != right) { 7427 changed = true; 7428 mPaddingRight = right; 7429 } 7430 if (mPaddingBottom != bottom) { 7431 changed = true; 7432 mPaddingBottom = bottom; 7433 } 7434 7435 if (changed) { 7436 requestLayout(); 7437 } 7438 } 7439 7440 /** 7441 * Returns the top padding of this view. 7442 * 7443 * @return the top padding in pixels 7444 */ 7445 public int getPaddingTop() { 7446 return mPaddingTop; 7447 } 7448 7449 /** 7450 * Returns the bottom padding of this view. If there are inset and enabled 7451 * scrollbars, this value may include the space required to display the 7452 * scrollbars as well. 7453 * 7454 * @return the bottom padding in pixels 7455 */ 7456 public int getPaddingBottom() { 7457 return mPaddingBottom; 7458 } 7459 7460 /** 7461 * Returns the left padding of this view. If there are inset and enabled 7462 * scrollbars, this value may include the space required to display the 7463 * scrollbars as well. 7464 * 7465 * @return the left padding in pixels 7466 */ 7467 public int getPaddingLeft() { 7468 return mPaddingLeft; 7469 } 7470 7471 /** 7472 * Returns the right padding of this view. If there are inset and enabled 7473 * scrollbars, this value may include the space required to display the 7474 * scrollbars as well. 7475 * 7476 * @return the right padding in pixels 7477 */ 7478 public int getPaddingRight() { 7479 return mPaddingRight; 7480 } 7481 7482 /** 7483 * Changes the selection state of this view. A view can be selected or not. 7484 * Note that selection is not the same as focus. Views are typically 7485 * selected in the context of an AdapterView like ListView or GridView; 7486 * the selected view is the view that is highlighted. 7487 * 7488 * @param selected true if the view must be selected, false otherwise 7489 */ 7490 public void setSelected(boolean selected) { 7491 if (((mPrivateFlags & SELECTED) != 0) != selected) { 7492 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0); 7493 if (!selected) resetPressedState(); 7494 invalidate(); 7495 refreshDrawableState(); 7496 dispatchSetSelected(selected); 7497 } 7498 } 7499 7500 /** 7501 * Dispatch setSelected to all of this View's children. 7502 * 7503 * @see #setSelected(boolean) 7504 * 7505 * @param selected The new selected state 7506 */ 7507 protected void dispatchSetSelected(boolean selected) { 7508 } 7509 7510 /** 7511 * Indicates the selection state of this view. 7512 * 7513 * @return true if the view is selected, false otherwise 7514 */ 7515 @ViewDebug.ExportedProperty 7516 public boolean isSelected() { 7517 return (mPrivateFlags & SELECTED) != 0; 7518 } 7519 7520 /** 7521 * Returns the ViewTreeObserver for this view's hierarchy. The view tree 7522 * observer can be used to get notifications when global events, like 7523 * layout, happen. 7524 * 7525 * The returned ViewTreeObserver observer is not guaranteed to remain 7526 * valid for the lifetime of this View. If the caller of this method keeps 7527 * a long-lived reference to ViewTreeObserver, it should always check for 7528 * the return value of {@link ViewTreeObserver#isAlive()}. 7529 * 7530 * @return The ViewTreeObserver for this view's hierarchy. 7531 */ 7532 public ViewTreeObserver getViewTreeObserver() { 7533 if (mAttachInfo != null) { 7534 return mAttachInfo.mTreeObserver; 7535 } 7536 if (mFloatingTreeObserver == null) { 7537 mFloatingTreeObserver = new ViewTreeObserver(); 7538 } 7539 return mFloatingTreeObserver; 7540 } 7541 7542 /** 7543 * <p>Finds the topmost view in the current view hierarchy.</p> 7544 * 7545 * @return the topmost view containing this view 7546 */ 7547 public View getRootView() { 7548 if (mAttachInfo != null) { 7549 final View v = mAttachInfo.mRootView; 7550 if (v != null) { 7551 return v; 7552 } 7553 } 7554 7555 View parent = this; 7556 7557 while (parent.mParent != null && parent.mParent instanceof View) { 7558 parent = (View) parent.mParent; 7559 } 7560 7561 return parent; 7562 } 7563 7564 /** 7565 * <p>Computes the coordinates of this view on the screen. The argument 7566 * must be an array of two integers. After the method returns, the array 7567 * contains the x and y location in that order.</p> 7568 * 7569 * @param location an array of two integers in which to hold the coordinates 7570 */ 7571 public void getLocationOnScreen(int[] location) { 7572 getLocationInWindow(location); 7573 7574 final AttachInfo info = mAttachInfo; 7575 if (info != null) { 7576 location[0] += info.mWindowLeft; 7577 location[1] += info.mWindowTop; 7578 } 7579 } 7580 7581 /** 7582 * <p>Computes the coordinates of this view in its window. The argument 7583 * must be an array of two integers. After the method returns, the array 7584 * contains the x and y location in that order.</p> 7585 * 7586 * @param location an array of two integers in which to hold the coordinates 7587 */ 7588 public void getLocationInWindow(int[] location) { 7589 if (location == null || location.length < 2) { 7590 throw new IllegalArgumentException("location must be an array of " 7591 + "two integers"); 7592 } 7593 7594 location[0] = mLeft; 7595 location[1] = mTop; 7596 7597 ViewParent viewParent = mParent; 7598 while (viewParent instanceof View) { 7599 final View view = (View)viewParent; 7600 location[0] += view.mLeft - view.mScrollX; 7601 location[1] += view.mTop - view.mScrollY; 7602 viewParent = view.mParent; 7603 } 7604 7605 if (viewParent instanceof ViewRoot) { 7606 // *cough* 7607 final ViewRoot vr = (ViewRoot)viewParent; 7608 location[1] -= vr.mCurScrollY; 7609 } 7610 } 7611 7612 /** 7613 * {@hide} 7614 * @param id the id of the view to be found 7615 * @return the view of the specified id, null if cannot be found 7616 */ 7617 protected View findViewTraversal(int id) { 7618 if (id == mID) { 7619 return this; 7620 } 7621 return null; 7622 } 7623 7624 /** 7625 * {@hide} 7626 * @param tag the tag of the view to be found 7627 * @return the view of specified tag, null if cannot be found 7628 */ 7629 protected View findViewWithTagTraversal(Object tag) { 7630 if (tag != null && tag.equals(mTag)) { 7631 return this; 7632 } 7633 return null; 7634 } 7635 7636 /** 7637 * Look for a child view with the given id. If this view has the given 7638 * id, return this view. 7639 * 7640 * @param id The id to search for. 7641 * @return The view that has the given id in the hierarchy or null 7642 */ 7643 public final View findViewById(int id) { 7644 if (id < 0) { 7645 return null; 7646 } 7647 return findViewTraversal(id); 7648 } 7649 7650 /** 7651 * Look for a child view with the given tag. If this view has the given 7652 * tag, return this view. 7653 * 7654 * @param tag The tag to search for, using "tag.equals(getTag())". 7655 * @return The View that has the given tag in the hierarchy or null 7656 */ 7657 public final View findViewWithTag(Object tag) { 7658 if (tag == null) { 7659 return null; 7660 } 7661 return findViewWithTagTraversal(tag); 7662 } 7663 7664 /** 7665 * Sets the identifier for this view. The identifier does not have to be 7666 * unique in this view's hierarchy. The identifier should be a positive 7667 * number. 7668 * 7669 * @see #NO_ID 7670 * @see #getId 7671 * @see #findViewById 7672 * 7673 * @param id a number used to identify the view 7674 * 7675 * @attr ref android.R.styleable#View_id 7676 */ 7677 public void setId(int id) { 7678 mID = id; 7679 } 7680 7681 /** 7682 * {@hide} 7683 * 7684 * @param isRoot true if the view belongs to the root namespace, false 7685 * otherwise 7686 */ 7687 public void setIsRootNamespace(boolean isRoot) { 7688 if (isRoot) { 7689 mPrivateFlags |= IS_ROOT_NAMESPACE; 7690 } else { 7691 mPrivateFlags &= ~IS_ROOT_NAMESPACE; 7692 } 7693 } 7694 7695 /** 7696 * {@hide} 7697 * 7698 * @return true if the view belongs to the root namespace, false otherwise 7699 */ 7700 public boolean isRootNamespace() { 7701 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0; 7702 } 7703 7704 /** 7705 * Returns this view's identifier. 7706 * 7707 * @return a positive integer used to identify the view or {@link #NO_ID} 7708 * if the view has no ID 7709 * 7710 * @see #setId 7711 * @see #findViewById 7712 * @attr ref android.R.styleable#View_id 7713 */ 7714 @ViewDebug.CapturedViewProperty 7715 public int getId() { 7716 return mID; 7717 } 7718 7719 /** 7720 * Returns this view's tag. 7721 * 7722 * @return the Object stored in this view as a tag 7723 * 7724 * @see #setTag(Object) 7725 * @see #getTag(int) 7726 */ 7727 @ViewDebug.ExportedProperty 7728 public Object getTag() { 7729 return mTag; 7730 } 7731 7732 /** 7733 * Sets the tag associated with this view. A tag can be used to mark 7734 * a view in its hierarchy and does not have to be unique within the 7735 * hierarchy. Tags can also be used to store data within a view without 7736 * resorting to another data structure. 7737 * 7738 * @param tag an Object to tag the view with 7739 * 7740 * @see #getTag() 7741 * @see #setTag(int, Object) 7742 */ 7743 public void setTag(final Object tag) { 7744 mTag = tag; 7745 } 7746 7747 /** 7748 * Returns the tag associated with this view and the specified key. 7749 * 7750 * @param key The key identifying the tag 7751 * 7752 * @return the Object stored in this view as a tag 7753 * 7754 * @see #setTag(int, Object) 7755 * @see #getTag() 7756 */ 7757 public Object getTag(int key) { 7758 SparseArray<Object> tags = null; 7759 synchronized (sTagsLock) { 7760 if (sTags != null) { 7761 tags = sTags.get(this); 7762 } 7763 } 7764 7765 if (tags != null) return tags.get(key); 7766 return null; 7767 } 7768 7769 /** 7770 * Sets a tag associated with this view and a key. A tag can be used 7771 * to mark a view in its hierarchy and does not have to be unique within 7772 * the hierarchy. Tags can also be used to store data within a view 7773 * without resorting to another data structure. 7774 * 7775 * The specified key should be an id declared in the resources of the 7776 * application to ensure it is unique. Keys identified as belonging to 7777 * the Android framework or not associated with any package will cause 7778 * an {@link IllegalArgumentException} to be thrown. 7779 * 7780 * @param key The key identifying the tag 7781 * @param tag An Object to tag the view with 7782 * 7783 * @throws IllegalArgumentException If they specified key is not valid 7784 * 7785 * @see #setTag(Object) 7786 * @see #getTag(int) 7787 */ 7788 public void setTag(int key, final Object tag) { 7789 // If the package id is 0x00 or 0x01, it's either an undefined package 7790 // or a framework id 7791 if ((key >>> 24) < 2) { 7792 throw new IllegalArgumentException("The key must be an application-specific " 7793 + "resource id."); 7794 } 7795 7796 setTagInternal(this, key, tag); 7797 } 7798 7799 /** 7800 * Variation of {@link #setTag(int, Object)} that enforces the key to be a 7801 * framework id. 7802 * 7803 * @hide 7804 */ 7805 public void setTagInternal(int key, Object tag) { 7806 if ((key >>> 24) != 0x1) { 7807 throw new IllegalArgumentException("The key must be a framework-specific " 7808 + "resource id."); 7809 } 7810 7811 setTagInternal(this, key, tag); 7812 } 7813 7814 private static void setTagInternal(View view, int key, Object tag) { 7815 SparseArray<Object> tags = null; 7816 synchronized (sTagsLock) { 7817 if (sTags == null) { 7818 sTags = new WeakHashMap<View, SparseArray<Object>>(); 7819 } else { 7820 tags = sTags.get(view); 7821 } 7822 } 7823 7824 if (tags == null) { 7825 tags = new SparseArray<Object>(2); 7826 synchronized (sTagsLock) { 7827 sTags.put(view, tags); 7828 } 7829 } 7830 7831 tags.put(key, tag); 7832 } 7833 7834 /** 7835 * @param consistency The type of consistency. See ViewDebug for more information. 7836 * 7837 * @hide 7838 */ 7839 protected boolean dispatchConsistencyCheck(int consistency) { 7840 return onConsistencyCheck(consistency); 7841 } 7842 7843 /** 7844 * Method that subclasses should implement to check their consistency. The type of 7845 * consistency check is indicated by the bit field passed as a parameter. 7846 * 7847 * @param consistency The type of consistency. See ViewDebug for more information. 7848 * 7849 * @throws IllegalStateException if the view is in an inconsistent state. 7850 * 7851 * @hide 7852 */ 7853 protected boolean onConsistencyCheck(int consistency) { 7854 boolean result = true; 7855 7856 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0; 7857 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0; 7858 7859 if (checkLayout) { 7860 if (getParent() == null) { 7861 result = false; 7862 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 7863 "View " + this + " does not have a parent."); 7864 } 7865 7866 if (mAttachInfo == null) { 7867 result = false; 7868 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 7869 "View " + this + " is not attached to a window."); 7870 } 7871 } 7872 7873 if (checkDrawing) { 7874 // Do not check the DIRTY/DRAWN flags because views can call invalidate() 7875 // from their draw() method 7876 7877 if ((mPrivateFlags & DRAWN) != DRAWN && 7878 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) { 7879 result = false; 7880 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG, 7881 "View " + this + " was invalidated but its drawing cache is valid."); 7882 } 7883 } 7884 7885 return result; 7886 } 7887 7888 /** 7889 * Prints information about this view in the log output, with the tag 7890 * {@link #VIEW_LOG_TAG}. 7891 * 7892 * @hide 7893 */ 7894 public void debug() { 7895 debug(0); 7896 } 7897 7898 /** 7899 * Prints information about this view in the log output, with the tag 7900 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an 7901 * indentation defined by the <code>depth</code>. 7902 * 7903 * @param depth the indentation level 7904 * 7905 * @hide 7906 */ 7907 protected void debug(int depth) { 7908 String output = debugIndent(depth - 1); 7909 7910 output += "+ " + this; 7911 int id = getId(); 7912 if (id != -1) { 7913 output += " (id=" + id + ")"; 7914 } 7915 Object tag = getTag(); 7916 if (tag != null) { 7917 output += " (tag=" + tag + ")"; 7918 } 7919 Log.d(VIEW_LOG_TAG, output); 7920 7921 if ((mPrivateFlags & FOCUSED) != 0) { 7922 output = debugIndent(depth) + " FOCUSED"; 7923 Log.d(VIEW_LOG_TAG, output); 7924 } 7925 7926 output = debugIndent(depth); 7927 output += "frame={" + mLeft + ", " + mTop + ", " + mRight 7928 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY 7929 + "} "; 7930 Log.d(VIEW_LOG_TAG, output); 7931 7932 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0 7933 || mPaddingBottom != 0) { 7934 output = debugIndent(depth); 7935 output += "padding={" + mPaddingLeft + ", " + mPaddingTop 7936 + ", " + mPaddingRight + ", " + mPaddingBottom + "}"; 7937 Log.d(VIEW_LOG_TAG, output); 7938 } 7939 7940 output = debugIndent(depth); 7941 output += "mMeasureWidth=" + mMeasuredWidth + 7942 " mMeasureHeight=" + mMeasuredHeight; 7943 Log.d(VIEW_LOG_TAG, output); 7944 7945 output = debugIndent(depth); 7946 if (mLayoutParams == null) { 7947 output += "BAD! no layout params"; 7948 } else { 7949 output = mLayoutParams.debug(output); 7950 } 7951 Log.d(VIEW_LOG_TAG, output); 7952 7953 output = debugIndent(depth); 7954 output += "flags={"; 7955 output += View.printFlags(mViewFlags); 7956 output += "}"; 7957 Log.d(VIEW_LOG_TAG, output); 7958 7959 output = debugIndent(depth); 7960 output += "privateFlags={"; 7961 output += View.printPrivateFlags(mPrivateFlags); 7962 output += "}"; 7963 Log.d(VIEW_LOG_TAG, output); 7964 } 7965 7966 /** 7967 * Creates an string of whitespaces used for indentation. 7968 * 7969 * @param depth the indentation level 7970 * @return a String containing (depth * 2 + 3) * 2 white spaces 7971 * 7972 * @hide 7973 */ 7974 protected static String debugIndent(int depth) { 7975 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2); 7976 for (int i = 0; i < (depth * 2) + 3; i++) { 7977 spaces.append(' ').append(' '); 7978 } 7979 return spaces.toString(); 7980 } 7981 7982 /** 7983 * <p>Return the offset of the widget's text baseline from the widget's top 7984 * boundary. If this widget does not support baseline alignment, this 7985 * method returns -1. </p> 7986 * 7987 * @return the offset of the baseline within the widget's bounds or -1 7988 * if baseline alignment is not supported 7989 */ 7990 @ViewDebug.ExportedProperty 7991 public int getBaseline() { 7992 return -1; 7993 } 7994 7995 /** 7996 * Call this when something has changed which has invalidated the 7997 * layout of this view. This will schedule a layout pass of the view 7998 * tree. 7999 */ 8000 public void requestLayout() { 8001 if (ViewDebug.TRACE_HIERARCHY) { 8002 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT); 8003 } 8004 8005 mPrivateFlags |= FORCE_LAYOUT; 8006 8007 if (mParent != null && !mParent.isLayoutRequested()) { 8008 mParent.requestLayout(); 8009 } 8010 } 8011 8012 /** 8013 * Forces this view to be laid out during the next layout pass. 8014 * This method does not call requestLayout() or forceLayout() 8015 * on the parent. 8016 */ 8017 public void forceLayout() { 8018 mPrivateFlags |= FORCE_LAYOUT; 8019 } 8020 8021 /** 8022 * <p> 8023 * This is called to find out how big a view should be. The parent 8024 * supplies constraint information in the width and height parameters. 8025 * </p> 8026 * 8027 * <p> 8028 * The actual mesurement work of a view is performed in 8029 * {@link #onMeasure(int, int)}, called by this method. Therefore, only 8030 * {@link #onMeasure(int, int)} can and must be overriden by subclasses. 8031 * </p> 8032 * 8033 * 8034 * @param widthMeasureSpec Horizontal space requirements as imposed by the 8035 * parent 8036 * @param heightMeasureSpec Vertical space requirements as imposed by the 8037 * parent 8038 * 8039 * @see #onMeasure(int, int) 8040 */ 8041 public final void measure(int widthMeasureSpec, int heightMeasureSpec) { 8042 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT || 8043 widthMeasureSpec != mOldWidthMeasureSpec || 8044 heightMeasureSpec != mOldHeightMeasureSpec) { 8045 8046 // first clears the measured dimension flag 8047 mPrivateFlags &= ~MEASURED_DIMENSION_SET; 8048 8049 if (ViewDebug.TRACE_HIERARCHY) { 8050 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE); 8051 } 8052 8053 // measure ourselves, this should set the measured dimension flag back 8054 onMeasure(widthMeasureSpec, heightMeasureSpec); 8055 8056 // flag not set, setMeasuredDimension() was not invoked, we raise 8057 // an exception to warn the developer 8058 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) { 8059 throw new IllegalStateException("onMeasure() did not set the" 8060 + " measured dimension by calling" 8061 + " setMeasuredDimension()"); 8062 } 8063 8064 mPrivateFlags |= LAYOUT_REQUIRED; 8065 } 8066 8067 mOldWidthMeasureSpec = widthMeasureSpec; 8068 mOldHeightMeasureSpec = heightMeasureSpec; 8069 } 8070 8071 /** 8072 * <p> 8073 * Measure the view and its content to determine the measured width and the 8074 * measured height. This method is invoked by {@link #measure(int, int)} and 8075 * should be overriden by subclasses to provide accurate and efficient 8076 * measurement of their contents. 8077 * </p> 8078 * 8079 * <p> 8080 * <strong>CONTRACT:</strong> When overriding this method, you 8081 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the 8082 * measured width and height of this view. Failure to do so will trigger an 8083 * <code>IllegalStateException</code>, thrown by 8084 * {@link #measure(int, int)}. Calling the superclass' 8085 * {@link #onMeasure(int, int)} is a valid use. 8086 * </p> 8087 * 8088 * <p> 8089 * The base class implementation of measure defaults to the background size, 8090 * unless a larger size is allowed by the MeasureSpec. Subclasses should 8091 * override {@link #onMeasure(int, int)} to provide better measurements of 8092 * their content. 8093 * </p> 8094 * 8095 * <p> 8096 * If this method is overridden, it is the subclass's responsibility to make 8097 * sure the measured height and width are at least the view's minimum height 8098 * and width ({@link #getSuggestedMinimumHeight()} and 8099 * {@link #getSuggestedMinimumWidth()}). 8100 * </p> 8101 * 8102 * @param widthMeasureSpec horizontal space requirements as imposed by the parent. 8103 * The requirements are encoded with 8104 * {@link android.view.View.MeasureSpec}. 8105 * @param heightMeasureSpec vertical space requirements as imposed by the parent. 8106 * The requirements are encoded with 8107 * {@link android.view.View.MeasureSpec}. 8108 * 8109 * @see #getMeasuredWidth() 8110 * @see #getMeasuredHeight() 8111 * @see #setMeasuredDimension(int, int) 8112 * @see #getSuggestedMinimumHeight() 8113 * @see #getSuggestedMinimumWidth() 8114 * @see android.view.View.MeasureSpec#getMode(int) 8115 * @see android.view.View.MeasureSpec#getSize(int) 8116 */ 8117 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 8118 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec), 8119 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec)); 8120 } 8121 8122 /** 8123 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the 8124 * measured width and measured height. Failing to do so will trigger an 8125 * exception at measurement time.</p> 8126 * 8127 * @param measuredWidth the measured width of this view 8128 * @param measuredHeight the measured height of this view 8129 */ 8130 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) { 8131 mMeasuredWidth = measuredWidth; 8132 mMeasuredHeight = measuredHeight; 8133 8134 mPrivateFlags |= MEASURED_DIMENSION_SET; 8135 } 8136 8137 /** 8138 * Utility to reconcile a desired size with constraints imposed by a MeasureSpec. 8139 * Will take the desired size, unless a different size is imposed by the constraints. 8140 * 8141 * @param size How big the view wants to be 8142 * @param measureSpec Constraints imposed by the parent 8143 * @return The size this view should be. 8144 */ 8145 public static int resolveSize(int size, int measureSpec) { 8146 int result = size; 8147 int specMode = MeasureSpec.getMode(measureSpec); 8148 int specSize = MeasureSpec.getSize(measureSpec); 8149 switch (specMode) { 8150 case MeasureSpec.UNSPECIFIED: 8151 result = size; 8152 break; 8153 case MeasureSpec.AT_MOST: 8154 result = Math.min(size, specSize); 8155 break; 8156 case MeasureSpec.EXACTLY: 8157 result = specSize; 8158 break; 8159 } 8160 return result; 8161 } 8162 8163 /** 8164 * Utility to return a default size. Uses the supplied size if the 8165 * MeasureSpec imposed no contraints. Will get larger if allowed 8166 * by the MeasureSpec. 8167 * 8168 * @param size Default size for this view 8169 * @param measureSpec Constraints imposed by the parent 8170 * @return The size this view should be. 8171 */ 8172 public static int getDefaultSize(int size, int measureSpec) { 8173 int result = size; 8174 int specMode = MeasureSpec.getMode(measureSpec); 8175 int specSize = MeasureSpec.getSize(measureSpec); 8176 8177 switch (specMode) { 8178 case MeasureSpec.UNSPECIFIED: 8179 result = size; 8180 break; 8181 case MeasureSpec.AT_MOST: 8182 case MeasureSpec.EXACTLY: 8183 result = specSize; 8184 break; 8185 } 8186 return result; 8187 } 8188 8189 /** 8190 * Returns the suggested minimum height that the view should use. This 8191 * returns the maximum of the view's minimum height 8192 * and the background's minimum height 8193 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}). 8194 * <p> 8195 * When being used in {@link #onMeasure(int, int)}, the caller should still 8196 * ensure the returned height is within the requirements of the parent. 8197 * 8198 * @return The suggested minimum height of the view. 8199 */ 8200 protected int getSuggestedMinimumHeight() { 8201 int suggestedMinHeight = mMinHeight; 8202 8203 if (mBGDrawable != null) { 8204 final int bgMinHeight = mBGDrawable.getMinimumHeight(); 8205 if (suggestedMinHeight < bgMinHeight) { 8206 suggestedMinHeight = bgMinHeight; 8207 } 8208 } 8209 8210 return suggestedMinHeight; 8211 } 8212 8213 /** 8214 * Returns the suggested minimum width that the view should use. This 8215 * returns the maximum of the view's minimum width) 8216 * and the background's minimum width 8217 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}). 8218 * <p> 8219 * When being used in {@link #onMeasure(int, int)}, the caller should still 8220 * ensure the returned width is within the requirements of the parent. 8221 * 8222 * @return The suggested minimum width of the view. 8223 */ 8224 protected int getSuggestedMinimumWidth() { 8225 int suggestedMinWidth = mMinWidth; 8226 8227 if (mBGDrawable != null) { 8228 final int bgMinWidth = mBGDrawable.getMinimumWidth(); 8229 if (suggestedMinWidth < bgMinWidth) { 8230 suggestedMinWidth = bgMinWidth; 8231 } 8232 } 8233 8234 return suggestedMinWidth; 8235 } 8236 8237 /** 8238 * Sets the minimum height of the view. It is not guaranteed the view will 8239 * be able to achieve this minimum height (for example, if its parent layout 8240 * constrains it with less available height). 8241 * 8242 * @param minHeight The minimum height the view will try to be. 8243 */ 8244 public void setMinimumHeight(int minHeight) { 8245 mMinHeight = minHeight; 8246 } 8247 8248 /** 8249 * Sets the minimum width of the view. It is not guaranteed the view will 8250 * be able to achieve this minimum width (for example, if its parent layout 8251 * constrains it with less available width). 8252 * 8253 * @param minWidth The minimum width the view will try to be. 8254 */ 8255 public void setMinimumWidth(int minWidth) { 8256 mMinWidth = minWidth; 8257 } 8258 8259 /** 8260 * Get the animation currently associated with this view. 8261 * 8262 * @return The animation that is currently playing or 8263 * scheduled to play for this view. 8264 */ 8265 public Animation getAnimation() { 8266 return mCurrentAnimation; 8267 } 8268 8269 /** 8270 * Start the specified animation now. 8271 * 8272 * @param animation the animation to start now 8273 */ 8274 public void startAnimation(Animation animation) { 8275 animation.setStartTime(Animation.START_ON_FIRST_FRAME); 8276 setAnimation(animation); 8277 invalidate(); 8278 } 8279 8280 /** 8281 * Cancels any animations for this view. 8282 */ 8283 public void clearAnimation() { 8284 mCurrentAnimation = null; 8285 } 8286 8287 /** 8288 * Sets the next animation to play for this view. 8289 * If you want the animation to play immediately, use 8290 * startAnimation. This method provides allows fine-grained 8291 * control over the start time and invalidation, but you 8292 * must make sure that 1) the animation has a start time set, and 8293 * 2) the view will be invalidated when the animation is supposed to 8294 * start. 8295 * 8296 * @param animation The next animation, or null. 8297 */ 8298 public void setAnimation(Animation animation) { 8299 mCurrentAnimation = animation; 8300 if (animation != null) { 8301 animation.reset(); 8302 } 8303 } 8304 8305 /** 8306 * Invoked by a parent ViewGroup to notify the start of the animation 8307 * currently associated with this view. If you override this method, 8308 * always call super.onAnimationStart(); 8309 * 8310 * @see #setAnimation(android.view.animation.Animation) 8311 * @see #getAnimation() 8312 */ 8313 protected void onAnimationStart() { 8314 mPrivateFlags |= ANIMATION_STARTED; 8315 } 8316 8317 /** 8318 * Invoked by a parent ViewGroup to notify the end of the animation 8319 * currently associated with this view. If you override this method, 8320 * always call super.onAnimationEnd(); 8321 * 8322 * @see #setAnimation(android.view.animation.Animation) 8323 * @see #getAnimation() 8324 */ 8325 protected void onAnimationEnd() { 8326 mPrivateFlags &= ~ANIMATION_STARTED; 8327 } 8328 8329 /** 8330 * Invoked if there is a Transform that involves alpha. Subclass that can 8331 * draw themselves with the specified alpha should return true, and then 8332 * respect that alpha when their onDraw() is called. If this returns false 8333 * then the view may be redirected to draw into an offscreen buffer to 8334 * fulfill the request, which will look fine, but may be slower than if the 8335 * subclass handles it internally. The default implementation returns false. 8336 * 8337 * @param alpha The alpha (0..255) to apply to the view's drawing 8338 * @return true if the view can draw with the specified alpha. 8339 */ 8340 protected boolean onSetAlpha(int alpha) { 8341 return false; 8342 } 8343 8344 /** 8345 * This is used by the RootView to perform an optimization when 8346 * the view hierarchy contains one or several SurfaceView. 8347 * SurfaceView is always considered transparent, but its children are not, 8348 * therefore all View objects remove themselves from the global transparent 8349 * region (passed as a parameter to this function). 8350 * 8351 * @param region The transparent region for this ViewRoot (window). 8352 * 8353 * @return Returns true if the effective visibility of the view at this 8354 * point is opaque, regardless of the transparent region; returns false 8355 * if it is possible for underlying windows to be seen behind the view. 8356 * 8357 * {@hide} 8358 */ 8359 public boolean gatherTransparentRegion(Region region) { 8360 final AttachInfo attachInfo = mAttachInfo; 8361 if (region != null && attachInfo != null) { 8362 final int pflags = mPrivateFlags; 8363 if ((pflags & SKIP_DRAW) == 0) { 8364 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to 8365 // remove it from the transparent region. 8366 final int[] location = attachInfo.mTransparentLocation; 8367 getLocationInWindow(location); 8368 region.op(location[0], location[1], location[0] + mRight - mLeft, 8369 location[1] + mBottom - mTop, Region.Op.DIFFERENCE); 8370 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) { 8371 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable 8372 // exists, so we remove the background drawable's non-transparent 8373 // parts from this transparent region. 8374 applyDrawableToTransparentRegion(mBGDrawable, region); 8375 } 8376 } 8377 return true; 8378 } 8379 8380 /** 8381 * Play a sound effect for this view. 8382 * 8383 * <p>The framework will play sound effects for some built in actions, such as 8384 * clicking, but you may wish to play these effects in your widget, 8385 * for instance, for internal navigation. 8386 * 8387 * <p>The sound effect will only be played if sound effects are enabled by the user, and 8388 * {@link #isSoundEffectsEnabled()} is true. 8389 * 8390 * @param soundConstant One of the constants defined in {@link SoundEffectConstants} 8391 */ 8392 public void playSoundEffect(int soundConstant) { 8393 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) { 8394 return; 8395 } 8396 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant); 8397 } 8398 8399 /** 8400 * BZZZTT!!1! 8401 * 8402 * <p>Provide haptic feedback to the user for this view. 8403 * 8404 * <p>The framework will provide haptic feedback for some built in actions, 8405 * such as long presses, but you may wish to provide feedback for your 8406 * own widget. 8407 * 8408 * <p>The feedback will only be performed if 8409 * {@link #isHapticFeedbackEnabled()} is true. 8410 * 8411 * @param feedbackConstant One of the constants defined in 8412 * {@link HapticFeedbackConstants} 8413 */ 8414 public boolean performHapticFeedback(int feedbackConstant) { 8415 return performHapticFeedback(feedbackConstant, 0); 8416 } 8417 8418 /** 8419 * BZZZTT!!1! 8420 * 8421 * <p>Like {@link #performHapticFeedback(int)}, with additional options. 8422 * 8423 * @param feedbackConstant One of the constants defined in 8424 * {@link HapticFeedbackConstants} 8425 * @param flags Additional flags as per {@link HapticFeedbackConstants}. 8426 */ 8427 public boolean performHapticFeedback(int feedbackConstant, int flags) { 8428 if (mAttachInfo == null) { 8429 return false; 8430 } 8431 if ((flags&HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0 8432 && !isHapticFeedbackEnabled()) { 8433 return false; 8434 } 8435 return mAttachInfo.mRootCallbacks.performHapticFeedback( 8436 feedbackConstant, 8437 (flags&HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0); 8438 } 8439 8440 /** 8441 * This needs to be a better API (NOT ON VIEW) before it is exposed. If 8442 * it is ever exposed at all. 8443 * @hide 8444 */ 8445 public void onCloseSystemDialogs(String reason) { 8446 } 8447 8448 /** 8449 * Given a Drawable whose bounds have been set to draw into this view, 8450 * update a Region being computed for {@link #gatherTransparentRegion} so 8451 * that any non-transparent parts of the Drawable are removed from the 8452 * given transparent region. 8453 * 8454 * @param dr The Drawable whose transparency is to be applied to the region. 8455 * @param region A Region holding the current transparency information, 8456 * where any parts of the region that are set are considered to be 8457 * transparent. On return, this region will be modified to have the 8458 * transparency information reduced by the corresponding parts of the 8459 * Drawable that are not transparent. 8460 * {@hide} 8461 */ 8462 public void applyDrawableToTransparentRegion(Drawable dr, Region region) { 8463 if (DBG) { 8464 Log.i("View", "Getting transparent region for: " + this); 8465 } 8466 final Region r = dr.getTransparentRegion(); 8467 final Rect db = dr.getBounds(); 8468 final AttachInfo attachInfo = mAttachInfo; 8469 if (r != null && attachInfo != null) { 8470 final int w = getRight()-getLeft(); 8471 final int h = getBottom()-getTop(); 8472 if (db.left > 0) { 8473 //Log.i("VIEW", "Drawable left " + db.left + " > view 0"); 8474 r.op(0, 0, db.left, h, Region.Op.UNION); 8475 } 8476 if (db.right < w) { 8477 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w); 8478 r.op(db.right, 0, w, h, Region.Op.UNION); 8479 } 8480 if (db.top > 0) { 8481 //Log.i("VIEW", "Drawable top " + db.top + " > view 0"); 8482 r.op(0, 0, w, db.top, Region.Op.UNION); 8483 } 8484 if (db.bottom < h) { 8485 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h); 8486 r.op(0, db.bottom, w, h, Region.Op.UNION); 8487 } 8488 final int[] location = attachInfo.mTransparentLocation; 8489 getLocationInWindow(location); 8490 r.translate(location[0], location[1]); 8491 region.op(r, Region.Op.INTERSECT); 8492 } else { 8493 region.op(db, Region.Op.DIFFERENCE); 8494 } 8495 } 8496 8497 private void postCheckForLongClick(int delayOffset) { 8498 mHasPerformedLongPress = false; 8499 8500 if (mPendingCheckForLongPress == null) { 8501 mPendingCheckForLongPress = new CheckForLongPress(); 8502 } 8503 mPendingCheckForLongPress.rememberWindowAttachCount(); 8504 postDelayed(mPendingCheckForLongPress, 8505 ViewConfiguration.getLongPressTimeout() - delayOffset); 8506 } 8507 8508 private static int[] stateSetUnion(final int[] stateSet1, 8509 final int[] stateSet2) { 8510 final int stateSet1Length = stateSet1.length; 8511 final int stateSet2Length = stateSet2.length; 8512 final int[] newSet = new int[stateSet1Length + stateSet2Length]; 8513 int k = 0; 8514 int i = 0; 8515 int j = 0; 8516 // This is a merge of the two input state sets and assumes that the 8517 // input sets are sorted by the order imposed by ViewDrawableStates. 8518 for (int viewState : R.styleable.ViewDrawableStates) { 8519 if (i < stateSet1Length && stateSet1[i] == viewState) { 8520 newSet[k++] = viewState; 8521 i++; 8522 } else if (j < stateSet2Length && stateSet2[j] == viewState) { 8523 newSet[k++] = viewState; 8524 j++; 8525 } 8526 if (k > 1) { 8527 assert(newSet[k - 1] > newSet[k - 2]); 8528 } 8529 } 8530 return newSet; 8531 } 8532 8533 /** 8534 * Inflate a view from an XML resource. This convenience method wraps the {@link 8535 * LayoutInflater} class, which provides a full range of options for view inflation. 8536 * 8537 * @param context The Context object for your activity or application. 8538 * @param resource The resource ID to inflate 8539 * @param root A view group that will be the parent. Used to properly inflate the 8540 * layout_* parameters. 8541 * @see LayoutInflater 8542 */ 8543 public static View inflate(Context context, int resource, ViewGroup root) { 8544 LayoutInflater factory = LayoutInflater.from(context); 8545 return factory.inflate(resource, root); 8546 } 8547 8548 /** 8549 * A MeasureSpec encapsulates the layout requirements passed from parent to child. 8550 * Each MeasureSpec represents a requirement for either the width or the height. 8551 * A MeasureSpec is comprised of a size and a mode. There are three possible 8552 * modes: 8553 * <dl> 8554 * <dt>UNSPECIFIED</dt> 8555 * <dd> 8556 * The parent has not imposed any constraint on the child. It can be whatever size 8557 * it wants. 8558 * </dd> 8559 * 8560 * <dt>EXACTLY</dt> 8561 * <dd> 8562 * The parent has determined an exact size for the child. The child is going to be 8563 * given those bounds regardless of how big it wants to be. 8564 * </dd> 8565 * 8566 * <dt>AT_MOST</dt> 8567 * <dd> 8568 * The child can be as large as it wants up to the specified size. 8569 * </dd> 8570 * </dl> 8571 * 8572 * MeasureSpecs are implemented as ints to reduce object allocation. This class 8573 * is provided to pack and unpack the <size, mode> tuple into the int. 8574 */ 8575 public static class MeasureSpec { 8576 private static final int MODE_SHIFT = 30; 8577 private static final int MODE_MASK = 0x3 << MODE_SHIFT; 8578 8579 /** 8580 * Measure specification mode: The parent has not imposed any constraint 8581 * on the child. It can be whatever size it wants. 8582 */ 8583 public static final int UNSPECIFIED = 0 << MODE_SHIFT; 8584 8585 /** 8586 * Measure specification mode: The parent has determined an exact size 8587 * for the child. The child is going to be given those bounds regardless 8588 * of how big it wants to be. 8589 */ 8590 public static final int EXACTLY = 1 << MODE_SHIFT; 8591 8592 /** 8593 * Measure specification mode: The child can be as large as it wants up 8594 * to the specified size. 8595 */ 8596 public static final int AT_MOST = 2 << MODE_SHIFT; 8597 8598 /** 8599 * Creates a measure specification based on the supplied size and mode. 8600 * 8601 * The mode must always be one of the following: 8602 * <ul> 8603 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li> 8604 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li> 8605 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li> 8606 * </ul> 8607 * 8608 * @param size the size of the measure specification 8609 * @param mode the mode of the measure specification 8610 * @return the measure specification based on size and mode 8611 */ 8612 public static int makeMeasureSpec(int size, int mode) { 8613 return size + mode; 8614 } 8615 8616 /** 8617 * Extracts the mode from the supplied measure specification. 8618 * 8619 * @param measureSpec the measure specification to extract the mode from 8620 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED}, 8621 * {@link android.view.View.MeasureSpec#AT_MOST} or 8622 * {@link android.view.View.MeasureSpec#EXACTLY} 8623 */ 8624 public static int getMode(int measureSpec) { 8625 return (measureSpec & MODE_MASK); 8626 } 8627 8628 /** 8629 * Extracts the size from the supplied measure specification. 8630 * 8631 * @param measureSpec the measure specification to extract the size from 8632 * @return the size in pixels defined in the supplied measure specification 8633 */ 8634 public static int getSize(int measureSpec) { 8635 return (measureSpec & ~MODE_MASK); 8636 } 8637 8638 /** 8639 * Returns a String representation of the specified measure 8640 * specification. 8641 * 8642 * @param measureSpec the measure specification to convert to a String 8643 * @return a String with the following format: "MeasureSpec: MODE SIZE" 8644 */ 8645 public static String toString(int measureSpec) { 8646 int mode = getMode(measureSpec); 8647 int size = getSize(measureSpec); 8648 8649 StringBuilder sb = new StringBuilder("MeasureSpec: "); 8650 8651 if (mode == UNSPECIFIED) 8652 sb.append("UNSPECIFIED "); 8653 else if (mode == EXACTLY) 8654 sb.append("EXACTLY "); 8655 else if (mode == AT_MOST) 8656 sb.append("AT_MOST "); 8657 else 8658 sb.append(mode).append(" "); 8659 8660 sb.append(size); 8661 return sb.toString(); 8662 } 8663 } 8664 8665 class CheckForLongPress implements Runnable { 8666 8667 private int mOriginalWindowAttachCount; 8668 8669 public void run() { 8670 if (isPressed() && (mParent != null) 8671 && mOriginalWindowAttachCount == mWindowAttachCount) { 8672 if (performLongClick()) { 8673 mHasPerformedLongPress = true; 8674 } 8675 } 8676 } 8677 8678 public void rememberWindowAttachCount() { 8679 mOriginalWindowAttachCount = mWindowAttachCount; 8680 } 8681 } 8682 8683 private final class CheckForTap implements Runnable { 8684 public void run() { 8685 mPrivateFlags &= ~PREPRESSED; 8686 mPrivateFlags |= PRESSED; 8687 refreshDrawableState(); 8688 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) { 8689 postCheckForLongClick(ViewConfiguration.getTapTimeout()); 8690 } 8691 } 8692 } 8693 8694 /** 8695 * Interface definition for a callback to be invoked when a key event is 8696 * dispatched to this view. The callback will be invoked before the key 8697 * event is given to the view. 8698 */ 8699 public interface OnKeyListener { 8700 /** 8701 * Called when a key is dispatched to a view. This allows listeners to 8702 * get a chance to respond before the target view. 8703 * 8704 * @param v The view the key has been dispatched to. 8705 * @param keyCode The code for the physical key that was pressed 8706 * @param event The KeyEvent object containing full information about 8707 * the event. 8708 * @return True if the listener has consumed the event, false otherwise. 8709 */ 8710 boolean onKey(View v, int keyCode, KeyEvent event); 8711 } 8712 8713 /** 8714 * Interface definition for a callback to be invoked when a touch event is 8715 * dispatched to this view. The callback will be invoked before the touch 8716 * event is given to the view. 8717 */ 8718 public interface OnTouchListener { 8719 /** 8720 * Called when a touch event is dispatched to a view. This allows listeners to 8721 * get a chance to respond before the target view. 8722 * 8723 * @param v The view the touch event has been dispatched to. 8724 * @param event The MotionEvent object containing full information about 8725 * the event. 8726 * @return True if the listener has consumed the event, false otherwise. 8727 */ 8728 boolean onTouch(View v, MotionEvent event); 8729 } 8730 8731 /** 8732 * Interface definition for a callback to be invoked when a view has been clicked and held. 8733 */ 8734 public interface OnLongClickListener { 8735 /** 8736 * Called when a view has been clicked and held. 8737 * 8738 * @param v The view that was clicked and held. 8739 * 8740 * return True if the callback consumed the long click, false otherwise 8741 */ 8742 boolean onLongClick(View v); 8743 } 8744 8745 /** 8746 * Interface definition for a callback to be invoked when the focus state of 8747 * a view changed. 8748 */ 8749 public interface OnFocusChangeListener { 8750 /** 8751 * Called when the focus state of a view has changed. 8752 * 8753 * @param v The view whose state has changed. 8754 * @param hasFocus The new focus state of v. 8755 */ 8756 void onFocusChange(View v, boolean hasFocus); 8757 } 8758 8759 /** 8760 * Interface definition for a callback to be invoked when a view is clicked. 8761 */ 8762 public interface OnClickListener { 8763 /** 8764 * Called when a view has been clicked. 8765 * 8766 * @param v The view that was clicked. 8767 */ 8768 void onClick(View v); 8769 } 8770 8771 /** 8772 * Interface definition for a callback to be invoked when the context menu 8773 * for this view is being built. 8774 */ 8775 public interface OnCreateContextMenuListener { 8776 /** 8777 * Called when the context menu for this view is being built. It is not 8778 * safe to hold onto the menu after this method returns. 8779 * 8780 * @param menu The context menu that is being built 8781 * @param v The view for which the context menu is being built 8782 * @param menuInfo Extra information about the item for which the 8783 * context menu should be shown. This information will vary 8784 * depending on the class of v. 8785 */ 8786 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo); 8787 } 8788 8789 private final class UnsetPressedState implements Runnable { 8790 public void run() { 8791 setPressed(false); 8792 } 8793 } 8794 8795 /** 8796 * Base class for derived classes that want to save and restore their own 8797 * state in {@link android.view.View#onSaveInstanceState()}. 8798 */ 8799 public static class BaseSavedState extends AbsSavedState { 8800 /** 8801 * Constructor used when reading from a parcel. Reads the state of the superclass. 8802 * 8803 * @param source 8804 */ 8805 public BaseSavedState(Parcel source) { 8806 super(source); 8807 } 8808 8809 /** 8810 * Constructor called by derived classes when creating their SavedState objects 8811 * 8812 * @param superState The state of the superclass of this view 8813 */ 8814 public BaseSavedState(Parcelable superState) { 8815 super(superState); 8816 } 8817 8818 public static final Parcelable.Creator<BaseSavedState> CREATOR = 8819 new Parcelable.Creator<BaseSavedState>() { 8820 public BaseSavedState createFromParcel(Parcel in) { 8821 return new BaseSavedState(in); 8822 } 8823 8824 public BaseSavedState[] newArray(int size) { 8825 return new BaseSavedState[size]; 8826 } 8827 }; 8828 } 8829 8830 /** 8831 * A set of information given to a view when it is attached to its parent 8832 * window. 8833 */ 8834 static class AttachInfo { 8835 interface Callbacks { 8836 void playSoundEffect(int effectId); 8837 boolean performHapticFeedback(int effectId, boolean always); 8838 } 8839 8840 /** 8841 * InvalidateInfo is used to post invalidate(int, int, int, int) messages 8842 * to a Handler. This class contains the target (View) to invalidate and 8843 * the coordinates of the dirty rectangle. 8844 * 8845 * For performance purposes, this class also implements a pool of up to 8846 * POOL_LIMIT objects that get reused. This reduces memory allocations 8847 * whenever possible. 8848 */ 8849 static class InvalidateInfo implements Poolable<InvalidateInfo> { 8850 private static final int POOL_LIMIT = 10; 8851 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool( 8852 Pools.finitePool(new PoolableManager<InvalidateInfo>() { 8853 public InvalidateInfo newInstance() { 8854 return new InvalidateInfo(); 8855 } 8856 8857 public void onAcquired(InvalidateInfo element) { 8858 } 8859 8860 public void onReleased(InvalidateInfo element) { 8861 } 8862 }, POOL_LIMIT) 8863 ); 8864 8865 private InvalidateInfo mNext; 8866 8867 View target; 8868 8869 int left; 8870 int top; 8871 int right; 8872 int bottom; 8873 8874 public void setNextPoolable(InvalidateInfo element) { 8875 mNext = element; 8876 } 8877 8878 public InvalidateInfo getNextPoolable() { 8879 return mNext; 8880 } 8881 8882 static InvalidateInfo acquire() { 8883 return sPool.acquire(); 8884 } 8885 8886 void release() { 8887 sPool.release(this); 8888 } 8889 } 8890 8891 final IWindowSession mSession; 8892 8893 final IWindow mWindow; 8894 8895 final IBinder mWindowToken; 8896 8897 final Callbacks mRootCallbacks; 8898 8899 /** 8900 * The top view of the hierarchy. 8901 */ 8902 View mRootView; 8903 8904 IBinder mPanelParentWindowToken; 8905 Surface mSurface; 8906 8907 /** 8908 * Scale factor used by the compatibility mode 8909 */ 8910 float mApplicationScale; 8911 8912 /** 8913 * Indicates whether the application is in compatibility mode 8914 */ 8915 boolean mScalingRequired; 8916 8917 /** 8918 * Left position of this view's window 8919 */ 8920 int mWindowLeft; 8921 8922 /** 8923 * Top position of this view's window 8924 */ 8925 int mWindowTop; 8926 8927 /** 8928 * Indicates whether the window is translucent/transparent 8929 */ 8930 boolean mTranslucentWindow; 8931 8932 /** 8933 * For windows that are full-screen but using insets to layout inside 8934 * of the screen decorations, these are the current insets for the 8935 * content of the window. 8936 */ 8937 final Rect mContentInsets = new Rect(); 8938 8939 /** 8940 * For windows that are full-screen but using insets to layout inside 8941 * of the screen decorations, these are the current insets for the 8942 * actual visible parts of the window. 8943 */ 8944 final Rect mVisibleInsets = new Rect(); 8945 8946 /** 8947 * The internal insets given by this window. This value is 8948 * supplied by the client (through 8949 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will 8950 * be given to the window manager when changed to be used in laying 8951 * out windows behind it. 8952 */ 8953 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets 8954 = new ViewTreeObserver.InternalInsetsInfo(); 8955 8956 /** 8957 * All views in the window's hierarchy that serve as scroll containers, 8958 * used to determine if the window can be resized or must be panned 8959 * to adjust for a soft input area. 8960 */ 8961 final ArrayList<View> mScrollContainers = new ArrayList<View>(); 8962 8963 final KeyEvent.DispatcherState mKeyDispatchState 8964 = new KeyEvent.DispatcherState(); 8965 8966 /** 8967 * Indicates whether the view's window currently has the focus. 8968 */ 8969 boolean mHasWindowFocus; 8970 8971 /** 8972 * The current visibility of the window. 8973 */ 8974 int mWindowVisibility; 8975 8976 /** 8977 * Indicates the time at which drawing started to occur. 8978 */ 8979 long mDrawingTime; 8980 8981 /** 8982 * Indicates whether or not ignoring the DIRTY_MASK flags. 8983 */ 8984 boolean mIgnoreDirtyState; 8985 8986 /** 8987 * Indicates whether the view's window is currently in touch mode. 8988 */ 8989 boolean mInTouchMode; 8990 8991 /** 8992 * Indicates that ViewRoot should trigger a global layout change 8993 * the next time it performs a traversal 8994 */ 8995 boolean mRecomputeGlobalAttributes; 8996 8997 /** 8998 * Set to true when attributes (like mKeepScreenOn) need to be 8999 * recomputed. 9000 */ 9001 boolean mAttributesChanged; 9002 9003 /** 9004 * Set during a traveral if any views want to keep the screen on. 9005 */ 9006 boolean mKeepScreenOn; 9007 9008 /** 9009 * Set if the visibility of any views has changed. 9010 */ 9011 boolean mViewVisibilityChanged; 9012 9013 /** 9014 * Set to true if a view has been scrolled. 9015 */ 9016 boolean mViewScrollChanged; 9017 9018 /** 9019 * Global to the view hierarchy used as a temporary for dealing with 9020 * x/y points in the transparent region computations. 9021 */ 9022 final int[] mTransparentLocation = new int[2]; 9023 9024 /** 9025 * Global to the view hierarchy used as a temporary for dealing with 9026 * x/y points in the ViewGroup.invalidateChild implementation. 9027 */ 9028 final int[] mInvalidateChildLocation = new int[2]; 9029 9030 /** 9031 * The view tree observer used to dispatch global events like 9032 * layout, pre-draw, touch mode change, etc. 9033 */ 9034 final ViewTreeObserver mTreeObserver = new ViewTreeObserver(); 9035 9036 /** 9037 * A Canvas used by the view hierarchy to perform bitmap caching. 9038 */ 9039 Canvas mCanvas; 9040 9041 /** 9042 * A Handler supplied by a view's {@link android.view.ViewRoot}. This 9043 * handler can be used to pump events in the UI events queue. 9044 */ 9045 final Handler mHandler; 9046 9047 /** 9048 * Identifier for messages requesting the view to be invalidated. 9049 * Such messages should be sent to {@link #mHandler}. 9050 */ 9051 static final int INVALIDATE_MSG = 0x1; 9052 9053 /** 9054 * Identifier for messages requesting the view to invalidate a region. 9055 * Such messages should be sent to {@link #mHandler}. 9056 */ 9057 static final int INVALIDATE_RECT_MSG = 0x2; 9058 9059 /** 9060 * Temporary for use in computing invalidate rectangles while 9061 * calling up the hierarchy. 9062 */ 9063 final Rect mTmpInvalRect = new Rect(); 9064 9065 /** 9066 * Temporary list for use in collecting focusable descendents of a view. 9067 */ 9068 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24); 9069 9070 /** 9071 * Creates a new set of attachment information with the specified 9072 * events handler and thread. 9073 * 9074 * @param handler the events handler the view must use 9075 */ 9076 AttachInfo(IWindowSession session, IWindow window, 9077 Handler handler, Callbacks effectPlayer) { 9078 mSession = session; 9079 mWindow = window; 9080 mWindowToken = window.asBinder(); 9081 mHandler = handler; 9082 mRootCallbacks = effectPlayer; 9083 } 9084 } 9085 9086 /** 9087 * <p>ScrollabilityCache holds various fields used by a View when scrolling 9088 * is supported. This avoids keeping too many unused fields in most 9089 * instances of View.</p> 9090 */ 9091 private static class ScrollabilityCache implements Runnable { 9092 9093 /** 9094 * Scrollbars are not visible 9095 */ 9096 public static final int OFF = 0; 9097 9098 /** 9099 * Scrollbars are visible 9100 */ 9101 public static final int ON = 1; 9102 9103 /** 9104 * Scrollbars are fading away 9105 */ 9106 public static final int FADING = 2; 9107 9108 public boolean fadeScrollBars; 9109 9110 public int fadingEdgeLength; 9111 public int scrollBarDefaultDelayBeforeFade; 9112 public int scrollBarFadeDuration; 9113 9114 public int scrollBarSize; 9115 public ScrollBarDrawable scrollBar; 9116 public float[] interpolatorValues; 9117 public View host; 9118 9119 public final Paint paint; 9120 public final Matrix matrix; 9121 public Shader shader; 9122 9123 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2); 9124 9125 private final float[] mOpaque = {255.0f}; 9126 private final float[] mTransparent = {0.0f}; 9127 9128 /** 9129 * When fading should start. This time moves into the future every time 9130 * a new scroll happens. Measured based on SystemClock.uptimeMillis() 9131 */ 9132 public long fadeStartTime; 9133 9134 9135 /** 9136 * The current state of the scrollbars: ON, OFF, or FADING 9137 */ 9138 public int state = OFF; 9139 9140 private int mLastColor; 9141 9142 public ScrollabilityCache(ViewConfiguration configuration, View host) { 9143 fadingEdgeLength = configuration.getScaledFadingEdgeLength(); 9144 scrollBarSize = configuration.getScaledScrollBarSize(); 9145 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay(); 9146 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration(); 9147 9148 paint = new Paint(); 9149 matrix = new Matrix(); 9150 // use use a height of 1, and then wack the matrix each time we 9151 // actually use it. 9152 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP); 9153 9154 paint.setShader(shader); 9155 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT)); 9156 this.host = host; 9157 } 9158 9159 public void setFadeColor(int color) { 9160 if (color != 0 && color != mLastColor) { 9161 mLastColor = color; 9162 color |= 0xFF000000; 9163 9164 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000, 9165 color & 0x00FFFFFF, Shader.TileMode.CLAMP); 9166 9167 paint.setShader(shader); 9168 // Restore the default transfer mode (src_over) 9169 paint.setXfermode(null); 9170 } 9171 } 9172 9173 public void run() { 9174 long now = AnimationUtils.currentAnimationTimeMillis(); 9175 if (now >= fadeStartTime) { 9176 9177 // the animation fades the scrollbars out by changing 9178 // the opacity (alpha) from fully opaque to fully 9179 // transparent 9180 int nextFrame = (int) now; 9181 int framesCount = 0; 9182 9183 Interpolator interpolator = scrollBarInterpolator; 9184 9185 // Start opaque 9186 interpolator.setKeyFrame(framesCount++, nextFrame, mOpaque); 9187 9188 // End transparent 9189 nextFrame += scrollBarFadeDuration; 9190 interpolator.setKeyFrame(framesCount, nextFrame, mTransparent); 9191 9192 state = FADING; 9193 9194 // Kick off the fade animation 9195 host.invalidate(); 9196 } 9197 } 9198 9199 } 9200} 9201