blob: 7f5d254313afda8fb4237772d17ea5323021c9ed [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
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
svetoslavganov75986cf2009-05-14 22:28:01 -070019import com.android.internal.R;
20import com.android.internal.view.menu.MenuBuilder;
21
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080022import android.content.Context;
23import android.content.res.Resources;
24import android.content.res.TypedArray;
25import android.graphics.Bitmap;
26import android.graphics.Canvas;
Mike Cleronf116bf82009-09-27 19:14:12 -070027import android.graphics.Interpolator;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080028import android.graphics.LinearGradient;
29import android.graphics.Matrix;
30import android.graphics.Paint;
31import android.graphics.PixelFormat;
svetoslavganov75986cf2009-05-14 22:28:01 -070032import android.graphics.Point;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080033import android.graphics.PorterDuff;
34import android.graphics.PorterDuffXfermode;
35import android.graphics.Rect;
36import android.graphics.Region;
37import android.graphics.Shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080038import 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;
svetoslavganov75986cf2009-05-14 22:28:01 -070049import android.util.Config;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080050import android.util.EventLog;
51import android.util.Log;
Romain Guyd928d682009-03-31 17:52:16 -070052import android.util.Pool;
svetoslavganov75986cf2009-05-14 22:28:01 -070053import android.util.Poolable;
Romain Guyd928d682009-03-31 17:52:16 -070054import android.util.PoolableManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070055import android.util.Pools;
56import android.util.SparseArray;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080057import android.view.ContextMenu.ContextMenuInfo;
svetoslavganov75986cf2009-05-14 22:28:01 -070058import android.view.accessibility.AccessibilityEvent;
59import android.view.accessibility.AccessibilityEventSource;
60import android.view.accessibility.AccessibilityManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080061import android.view.animation.Animation;
Mike Cleron3ecd58c2009-09-28 11:39:02 -070062import android.view.animation.AnimationUtils;
svetoslavganov75986cf2009-05-14 22:28:01 -070063import android.view.inputmethod.EditorInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080064import android.view.inputmethod.InputConnection;
65import android.view.inputmethod.InputMethodManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080066import android.widget.ScrollBarDrawable;
67
svetoslavganov75986cf2009-05-14 22:28:01 -070068import java.lang.ref.SoftReference;
69import java.lang.reflect.InvocationTargetException;
70import java.lang.reflect.Method;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080071import java.util.ArrayList;
72import java.util.Arrays;
Romain Guyd90a3312009-05-06 14:54:28 -070073import java.util.WeakHashMap;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080074
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
Romain Guy8506ab42009-06-11 17:35:47 -070080 * used to create interactive UI components (buttons, text fields, etc.). The
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080081 * {@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">
Romain Guy8506ab42009-06-11 17:35:47 -070087 * <p>For an introduction to using this class to develop your
88 * application's user interface, read the Developer Guide documentation on
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080089 * <strong><a href="{@docRoot}guide/topics/ui/index.html">User Interface</a></strong>. Special topics
Romain Guy8506ab42009-06-11 17:35:47 -070090 * include:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080091 * <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>
Romain Guy8506ab42009-06-11 17:35:47 -0700101 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800102 * <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 * &lt;Button id="@+id/my_button"
263 * android:layout_width="wrap_content"
264 * android:layout_height="wrap_content"
265 * android:text="@string/my_button_text"/&gt;
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>FILL_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>
Romain Guy8506ab42009-06-11 17:35:47 -0700427 * Note that the framework will not draw views that are not in the invalid region.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800428 * </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
Mike Cleronf116bf82009-09-27 19:14:12 -0700519 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and
520 * {@link #awakenScrollBars()} for more details.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800521 * </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 *
Romain Guyd6a463a2009-05-21 23:10:10 -0700544 * @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
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800552 * @attr ref android.R.styleable#View_fitsSystemWindows
Romain Guyd6a463a2009-05-21 23:10:10 -0700553 * @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
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800561 * @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
Romain Guyd6a463a2009-05-21 23:10:10 -0700565 * @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
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800572 * @attr ref android.R.styleable#View_scrollX
573 * @attr ref android.R.styleable#View_scrollY
Romain Guyd6a463a2009-05-21 23:10:10 -0700574 * @attr ref android.R.styleable#View_scrollbarSize
575 * @attr ref android.R.styleable#View_scrollbarStyle
576 * @attr ref android.R.styleable#View_scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -0700577 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
578 * @attr ref android.R.styleable#View_scrollbarFadeDuration
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800579 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal
580 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800581 * @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
Romain Guyd6a463a2009-05-21 23:10:10 -0700585 * @attr ref android.R.styleable#View_soundEffectsEnabled
586 * @attr ref android.R.styleable#View_tag
587 * @attr ref android.R.styleable#View_visibility
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800588 *
589 * @see android.view.ViewGroup
590 */
svetoslavganov75986cf2009-05-14 22:28:01 -0700591public class View implements Drawable.Callback, KeyEvent.Callback, AccessibilityEventSource {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800592 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 /**
svetoslavganov75986cf2009-05-14 22:28:01 -0700889 * 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 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800901 * 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>();
Romain Guyd90a3312009-05-06 14:54:28 -07001339
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
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001350 /**
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 /**
Romain Guy809a7f62009-05-14 15:44:42 -07001456 * 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 /**
Romain Guy8f1344f52009-05-15 16:03:59 -07001478 * 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 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001499 * The parent this view is attached to.
1500 * {@hide}
1501 *
1502 * @see #getParent()
1503 */
1504 protected ViewParent mParent;
1505
1506 /**
1507 * {@hide}
1508 */
1509 AttachInfo mAttachInfo;
1510
1511 /**
1512 * {@hide}
1513 */
Romain Guy809a7f62009-05-14 15:44:42 -07001514 @ViewDebug.ExportedProperty(flagMapping = {
1515 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT,
1516 name = "FORCE_LAYOUT"),
1517 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED,
1518 name = "LAYOUT_REQUIRED"),
1519 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07001520 name = "DRAWING_CACHE_INVALID", outputIf = false),
Romain Guy809a7f62009-05-14 15:44:42 -07001521 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true),
1522 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false),
1523 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
1524 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY")
1525 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001526 int mPrivateFlags;
1527
1528 /**
1529 * Count of how many windows this view has been attached to.
1530 */
1531 int mWindowAttachCount;
1532
1533 /**
1534 * The layout parameters associated with this view and used by the parent
1535 * {@link android.view.ViewGroup} to determine how this view should be
1536 * laid out.
1537 * {@hide}
1538 */
1539 protected ViewGroup.LayoutParams mLayoutParams;
1540
1541 /**
1542 * The view flags hold various views states.
1543 * {@hide}
1544 */
1545 @ViewDebug.ExportedProperty
1546 int mViewFlags;
1547
1548 /**
1549 * The distance in pixels from the left edge of this view's parent
1550 * to the left edge of this view.
1551 * {@hide}
1552 */
1553 @ViewDebug.ExportedProperty
1554 protected int mLeft;
1555 /**
1556 * The distance in pixels from the left edge of this view's parent
1557 * to the right edge of this view.
1558 * {@hide}
1559 */
1560 @ViewDebug.ExportedProperty
1561 protected int mRight;
1562 /**
1563 * The distance in pixels from the top edge of this view's parent
1564 * to the top edge of this view.
1565 * {@hide}
1566 */
1567 @ViewDebug.ExportedProperty
1568 protected int mTop;
1569 /**
1570 * The distance in pixels from the top edge of this view's parent
1571 * to the bottom edge of this view.
1572 * {@hide}
1573 */
1574 @ViewDebug.ExportedProperty
1575 protected int mBottom;
1576
1577 /**
1578 * The offset, in pixels, by which the content of this view is scrolled
1579 * horizontally.
1580 * {@hide}
1581 */
1582 @ViewDebug.ExportedProperty
1583 protected int mScrollX;
1584 /**
1585 * The offset, in pixels, by which the content of this view is scrolled
1586 * vertically.
1587 * {@hide}
1588 */
1589 @ViewDebug.ExportedProperty
1590 protected int mScrollY;
1591
1592 /**
1593 * The left padding in pixels, that is the distance in pixels between the
1594 * left edge of this view and the left edge of its content.
1595 * {@hide}
1596 */
1597 @ViewDebug.ExportedProperty
1598 protected int mPaddingLeft;
1599 /**
1600 * The right padding in pixels, that is the distance in pixels between the
1601 * right edge of this view and the right edge of its content.
1602 * {@hide}
1603 */
1604 @ViewDebug.ExportedProperty
1605 protected int mPaddingRight;
1606 /**
1607 * The top padding in pixels, that is the distance in pixels between the
1608 * top edge of this view and the top edge of its content.
1609 * {@hide}
1610 */
1611 @ViewDebug.ExportedProperty
1612 protected int mPaddingTop;
1613 /**
1614 * The bottom padding in pixels, that is the distance in pixels between the
1615 * bottom edge of this view and the bottom edge of its content.
1616 * {@hide}
1617 */
1618 @ViewDebug.ExportedProperty
1619 protected int mPaddingBottom;
1620
1621 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07001622 * Briefly describes the view and is primarily used for accessibility support.
1623 */
1624 private CharSequence mContentDescription;
1625
1626 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001627 * Cache the paddingRight set by the user to append to the scrollbar's size.
1628 */
1629 @ViewDebug.ExportedProperty
1630 int mUserPaddingRight;
1631
1632 /**
1633 * Cache the paddingBottom set by the user to append to the scrollbar's size.
1634 */
1635 @ViewDebug.ExportedProperty
1636 int mUserPaddingBottom;
1637
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07001638 /**
1639 * @hide
1640 */
1641 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
1642 /**
1643 * @hide
1644 */
1645 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001646
1647 private Resources mResources = null;
1648
1649 private Drawable mBGDrawable;
1650
1651 private int mBackgroundResource;
1652 private boolean mBackgroundSizeChanged;
1653
1654 /**
1655 * Listener used to dispatch focus change events.
1656 * This field should be made private, so it is hidden from the SDK.
1657 * {@hide}
1658 */
1659 protected OnFocusChangeListener mOnFocusChangeListener;
1660
1661 /**
1662 * Listener used to dispatch click events.
1663 * This field should be made private, so it is hidden from the SDK.
1664 * {@hide}
1665 */
1666 protected OnClickListener mOnClickListener;
1667
1668 /**
1669 * Listener used to dispatch long click events.
1670 * This field should be made private, so it is hidden from the SDK.
1671 * {@hide}
1672 */
1673 protected OnLongClickListener mOnLongClickListener;
1674
1675 /**
1676 * Listener used to build the context menu.
1677 * This field should be made private, so it is hidden from the SDK.
1678 * {@hide}
1679 */
1680 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
1681
1682 private OnKeyListener mOnKeyListener;
1683
1684 private OnTouchListener mOnTouchListener;
1685
1686 /**
1687 * The application environment this view lives in.
1688 * This field should be made private, so it is hidden from the SDK.
1689 * {@hide}
1690 */
1691 protected Context mContext;
1692
1693 private ScrollabilityCache mScrollCache;
1694
1695 private int[] mDrawableState = null;
1696
1697 private SoftReference<Bitmap> mDrawingCache;
Romain Guyfbd8f692009-06-26 14:51:58 -07001698 private SoftReference<Bitmap> mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001699
1700 /**
1701 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
1702 * the user may specify which view to go to next.
1703 */
1704 private int mNextFocusLeftId = View.NO_ID;
1705
1706 /**
1707 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
1708 * the user may specify which view to go to next.
1709 */
1710 private int mNextFocusRightId = View.NO_ID;
1711
1712 /**
1713 * When this view has focus and the next focus is {@link #FOCUS_UP},
1714 * the user may specify which view to go to next.
1715 */
1716 private int mNextFocusUpId = View.NO_ID;
1717
1718 /**
1719 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
1720 * the user may specify which view to go to next.
1721 */
1722 private int mNextFocusDownId = View.NO_ID;
1723
1724 private CheckForLongPress mPendingCheckForLongPress;
1725 private UnsetPressedState mUnsetPressedState;
1726
1727 /**
1728 * Whether the long press's action has been invoked. The tap's action is invoked on the
1729 * up event while a long press is invoked as soon as the long press duration is reached, so
1730 * a long press could be performed before the tap is checked, in which case the tap's action
1731 * should not be invoked.
1732 */
1733 private boolean mHasPerformedLongPress;
1734
1735 /**
1736 * The minimum height of the view. We'll try our best to have the height
1737 * of this view to at least this amount.
1738 */
1739 @ViewDebug.ExportedProperty
1740 private int mMinHeight;
1741
1742 /**
1743 * The minimum width of the view. We'll try our best to have the width
1744 * of this view to at least this amount.
1745 */
1746 @ViewDebug.ExportedProperty
1747 private int mMinWidth;
1748
1749 /**
1750 * The delegate to handle touch events that are physically in this view
1751 * but should be handled by another view.
1752 */
1753 private TouchDelegate mTouchDelegate = null;
1754
1755 /**
1756 * Solid color to use as a background when creating the drawing cache. Enables
1757 * the cache to use 16 bit bitmaps instead of 32 bit.
1758 */
1759 private int mDrawingCacheBackgroundColor = 0;
1760
1761 /**
1762 * Special tree observer used when mAttachInfo is null.
1763 */
1764 private ViewTreeObserver mFloatingTreeObserver;
1765
1766 // Used for debug only
1767 static long sInstanceCount = 0;
1768
1769 /**
1770 * Simple constructor to use when creating a view from code.
1771 *
1772 * @param context The Context the view is running in, through which it can
1773 * access the current theme, resources, etc.
1774 */
1775 public View(Context context) {
1776 mContext = context;
1777 mResources = context != null ? context.getResources() : null;
Romain Guy8f1344f52009-05-15 16:03:59 -07001778 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001779 ++sInstanceCount;
1780 }
1781
1782 /**
1783 * Constructor that is called when inflating a view from XML. This is called
1784 * when a view is being constructed from an XML file, supplying attributes
1785 * that were specified in the XML file. This version uses a default style of
1786 * 0, so the only attribute values applied are those in the Context's Theme
1787 * and the given AttributeSet.
1788 *
1789 * <p>
1790 * The method onFinishInflate() will be called after all children have been
1791 * added.
1792 *
1793 * @param context The Context the view is running in, through which it can
1794 * access the current theme, resources, etc.
1795 * @param attrs The attributes of the XML tag that is inflating the view.
1796 * @see #View(Context, AttributeSet, int)
1797 */
1798 public View(Context context, AttributeSet attrs) {
1799 this(context, attrs, 0);
1800 }
1801
1802 /**
1803 * Perform inflation from XML and apply a class-specific base style. This
1804 * constructor of View allows subclasses to use their own base style when
1805 * they are inflating. For example, a Button class's constructor would call
1806 * this version of the super class constructor and supply
1807 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
1808 * the theme's button style to modify all of the base view attributes (in
1809 * particular its background) as well as the Button class's attributes.
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 * @param defStyle The default style to apply to this view. If 0, no style
1815 * will be applied (beyond what is included in the theme). This may
1816 * either be an attribute resource, whose value will be retrieved
1817 * from the current theme, or an explicit style resource.
1818 * @see #View(Context, AttributeSet)
1819 */
1820 public View(Context context, AttributeSet attrs, int defStyle) {
1821 this(context);
1822
1823 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
1824 defStyle, 0);
1825
1826 Drawable background = null;
1827
1828 int leftPadding = -1;
1829 int topPadding = -1;
1830 int rightPadding = -1;
1831 int bottomPadding = -1;
1832
1833 int padding = -1;
1834
1835 int viewFlagValues = 0;
1836 int viewFlagMasks = 0;
1837
1838 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07001839
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001840 int x = 0;
1841 int y = 0;
1842
1843 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
1844
1845 final int N = a.getIndexCount();
1846 for (int i = 0; i < N; i++) {
1847 int attr = a.getIndex(i);
1848 switch (attr) {
1849 case com.android.internal.R.styleable.View_background:
1850 background = a.getDrawable(attr);
1851 break;
1852 case com.android.internal.R.styleable.View_padding:
1853 padding = a.getDimensionPixelSize(attr, -1);
1854 break;
1855 case com.android.internal.R.styleable.View_paddingLeft:
1856 leftPadding = a.getDimensionPixelSize(attr, -1);
1857 break;
1858 case com.android.internal.R.styleable.View_paddingTop:
1859 topPadding = a.getDimensionPixelSize(attr, -1);
1860 break;
1861 case com.android.internal.R.styleable.View_paddingRight:
1862 rightPadding = a.getDimensionPixelSize(attr, -1);
1863 break;
1864 case com.android.internal.R.styleable.View_paddingBottom:
1865 bottomPadding = a.getDimensionPixelSize(attr, -1);
1866 break;
1867 case com.android.internal.R.styleable.View_scrollX:
1868 x = a.getDimensionPixelOffset(attr, 0);
1869 break;
1870 case com.android.internal.R.styleable.View_scrollY:
1871 y = a.getDimensionPixelOffset(attr, 0);
1872 break;
1873 case com.android.internal.R.styleable.View_id:
1874 mID = a.getResourceId(attr, NO_ID);
1875 break;
1876 case com.android.internal.R.styleable.View_tag:
1877 mTag = a.getText(attr);
1878 break;
1879 case com.android.internal.R.styleable.View_fitsSystemWindows:
1880 if (a.getBoolean(attr, false)) {
1881 viewFlagValues |= FITS_SYSTEM_WINDOWS;
1882 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
1883 }
1884 break;
1885 case com.android.internal.R.styleable.View_focusable:
1886 if (a.getBoolean(attr, false)) {
1887 viewFlagValues |= FOCUSABLE;
1888 viewFlagMasks |= FOCUSABLE_MASK;
1889 }
1890 break;
1891 case com.android.internal.R.styleable.View_focusableInTouchMode:
1892 if (a.getBoolean(attr, false)) {
1893 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
1894 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
1895 }
1896 break;
1897 case com.android.internal.R.styleable.View_clickable:
1898 if (a.getBoolean(attr, false)) {
1899 viewFlagValues |= CLICKABLE;
1900 viewFlagMasks |= CLICKABLE;
1901 }
1902 break;
1903 case com.android.internal.R.styleable.View_longClickable:
1904 if (a.getBoolean(attr, false)) {
1905 viewFlagValues |= LONG_CLICKABLE;
1906 viewFlagMasks |= LONG_CLICKABLE;
1907 }
1908 break;
1909 case com.android.internal.R.styleable.View_saveEnabled:
1910 if (!a.getBoolean(attr, true)) {
1911 viewFlagValues |= SAVE_DISABLED;
1912 viewFlagMasks |= SAVE_DISABLED_MASK;
1913 }
1914 break;
1915 case com.android.internal.R.styleable.View_duplicateParentState:
1916 if (a.getBoolean(attr, false)) {
1917 viewFlagValues |= DUPLICATE_PARENT_STATE;
1918 viewFlagMasks |= DUPLICATE_PARENT_STATE;
1919 }
1920 break;
1921 case com.android.internal.R.styleable.View_visibility:
1922 final int visibility = a.getInt(attr, 0);
1923 if (visibility != 0) {
1924 viewFlagValues |= VISIBILITY_FLAGS[visibility];
1925 viewFlagMasks |= VISIBILITY_MASK;
1926 }
1927 break;
1928 case com.android.internal.R.styleable.View_drawingCacheQuality:
1929 final int cacheQuality = a.getInt(attr, 0);
1930 if (cacheQuality != 0) {
1931 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
1932 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
1933 }
1934 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07001935 case com.android.internal.R.styleable.View_contentDescription:
1936 mContentDescription = a.getString(attr);
1937 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001938 case com.android.internal.R.styleable.View_soundEffectsEnabled:
1939 if (!a.getBoolean(attr, true)) {
1940 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
1941 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
1942 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07001943 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001944 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
1945 if (!a.getBoolean(attr, true)) {
1946 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
1947 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
1948 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07001949 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001950 case R.styleable.View_scrollbars:
1951 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
1952 if (scrollbars != SCROLLBARS_NONE) {
1953 viewFlagValues |= scrollbars;
1954 viewFlagMasks |= SCROLLBARS_MASK;
1955 initializeScrollbars(a);
1956 }
1957 break;
1958 case R.styleable.View_fadingEdge:
1959 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
1960 if (fadingEdge != FADING_EDGE_NONE) {
1961 viewFlagValues |= fadingEdge;
1962 viewFlagMasks |= FADING_EDGE_MASK;
1963 initializeFadingEdge(a);
1964 }
1965 break;
1966 case R.styleable.View_scrollbarStyle:
1967 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
1968 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
1969 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
1970 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
1971 }
1972 break;
1973 case R.styleable.View_isScrollContainer:
1974 setScrollContainer = true;
1975 if (a.getBoolean(attr, false)) {
1976 setScrollContainer(true);
1977 }
1978 break;
1979 case com.android.internal.R.styleable.View_keepScreenOn:
1980 if (a.getBoolean(attr, false)) {
1981 viewFlagValues |= KEEP_SCREEN_ON;
1982 viewFlagMasks |= KEEP_SCREEN_ON;
1983 }
1984 break;
1985 case R.styleable.View_nextFocusLeft:
1986 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
1987 break;
1988 case R.styleable.View_nextFocusRight:
1989 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
1990 break;
1991 case R.styleable.View_nextFocusUp:
1992 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
1993 break;
1994 case R.styleable.View_nextFocusDown:
1995 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
1996 break;
1997 case R.styleable.View_minWidth:
1998 mMinWidth = a.getDimensionPixelSize(attr, 0);
1999 break;
2000 case R.styleable.View_minHeight:
2001 mMinHeight = a.getDimensionPixelSize(attr, 0);
2002 break;
Romain Guy9a817362009-05-01 10:57:14 -07002003 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07002004 if (context.isRestricted()) {
2005 throw new IllegalStateException("The android:onClick attribute cannot "
2006 + "be used within a restricted context");
2007 }
2008
Romain Guy9a817362009-05-01 10:57:14 -07002009 final String handlerName = a.getString(attr);
2010 if (handlerName != null) {
2011 setOnClickListener(new OnClickListener() {
2012 private Method mHandler;
2013
2014 public void onClick(View v) {
2015 if (mHandler == null) {
2016 try {
2017 mHandler = getContext().getClass().getMethod(handlerName,
2018 View.class);
2019 } catch (NoSuchMethodException e) {
2020 throw new IllegalStateException("Could not find a method " +
2021 handlerName + "(View) in the activity", e);
2022 }
2023 }
2024
2025 try {
2026 mHandler.invoke(getContext(), View.this);
2027 } catch (IllegalAccessException e) {
2028 throw new IllegalStateException("Could not execute non "
2029 + "public method of the activity", e);
2030 } catch (InvocationTargetException e) {
2031 throw new IllegalStateException("Could not execute "
2032 + "method of the activity", e);
2033 }
2034 }
2035 });
2036 }
2037 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002038 }
2039 }
2040
2041 if (background != null) {
2042 setBackgroundDrawable(background);
2043 }
2044
2045 if (padding >= 0) {
2046 leftPadding = padding;
2047 topPadding = padding;
2048 rightPadding = padding;
2049 bottomPadding = padding;
2050 }
2051
2052 // If the user specified the padding (either with android:padding or
2053 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
2054 // use the default padding or the padding from the background drawable
2055 // (stored at this point in mPadding*)
2056 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
2057 topPadding >= 0 ? topPadding : mPaddingTop,
2058 rightPadding >= 0 ? rightPadding : mPaddingRight,
2059 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
2060
2061 if (viewFlagMasks != 0) {
2062 setFlags(viewFlagValues, viewFlagMasks);
2063 }
2064
2065 // Needs to be called after mViewFlags is set
2066 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2067 recomputePadding();
2068 }
2069
2070 if (x != 0 || y != 0) {
2071 scrollTo(x, y);
2072 }
2073
2074 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
2075 setScrollContainer(true);
2076 }
Romain Guy8f1344f52009-05-15 16:03:59 -07002077
2078 computeOpaqueFlags();
2079
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002080 a.recycle();
2081 }
2082
2083 /**
2084 * Non-public constructor for use in testing
2085 */
2086 View() {
2087 }
2088
2089 @Override
2090 protected void finalize() throws Throwable {
2091 super.finalize();
2092 --sInstanceCount;
2093 }
2094
2095 /**
2096 * <p>
2097 * Initializes the fading edges from a given set of styled attributes. This
2098 * method should be called by subclasses that need fading edges and when an
2099 * instance of these subclasses is created programmatically rather than
2100 * being inflated from XML. This method is automatically called when the XML
2101 * is inflated.
2102 * </p>
2103 *
2104 * @param a the styled attributes set to initialize the fading edges from
2105 */
2106 protected void initializeFadingEdge(TypedArray a) {
2107 initScrollCache();
2108
2109 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
2110 R.styleable.View_fadingEdgeLength,
2111 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
2112 }
2113
2114 /**
2115 * Returns the size of the vertical faded edges used to indicate that more
2116 * content in this view is visible.
2117 *
2118 * @return The size in pixels of the vertical faded edge or 0 if vertical
2119 * faded edges are not enabled for this view.
2120 * @attr ref android.R.styleable#View_fadingEdgeLength
2121 */
2122 public int getVerticalFadingEdgeLength() {
2123 if (isVerticalFadingEdgeEnabled()) {
2124 ScrollabilityCache cache = mScrollCache;
2125 if (cache != null) {
2126 return cache.fadingEdgeLength;
2127 }
2128 }
2129 return 0;
2130 }
2131
2132 /**
2133 * Set the size of the faded edge used to indicate that more content in this
2134 * view is available. Will not change whether the fading edge is enabled; use
2135 * {@link #setVerticalFadingEdgeEnabled} or {@link #setHorizontalFadingEdgeEnabled}
2136 * to enable the fading edge for the vertical or horizontal fading edges.
2137 *
2138 * @param length The size in pixels of the faded edge used to indicate that more
2139 * content in this view is visible.
2140 */
2141 public void setFadingEdgeLength(int length) {
2142 initScrollCache();
2143 mScrollCache.fadingEdgeLength = length;
2144 }
2145
2146 /**
2147 * Returns the size of the horizontal faded edges used to indicate that more
2148 * content in this view is visible.
2149 *
2150 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
2151 * faded edges are not enabled for this view.
2152 * @attr ref android.R.styleable#View_fadingEdgeLength
2153 */
2154 public int getHorizontalFadingEdgeLength() {
2155 if (isHorizontalFadingEdgeEnabled()) {
2156 ScrollabilityCache cache = mScrollCache;
2157 if (cache != null) {
2158 return cache.fadingEdgeLength;
2159 }
2160 }
2161 return 0;
2162 }
2163
2164 /**
2165 * Returns the width of the vertical scrollbar.
2166 *
2167 * @return The width in pixels of the vertical scrollbar or 0 if there
2168 * is no vertical scrollbar.
2169 */
2170 public int getVerticalScrollbarWidth() {
2171 ScrollabilityCache cache = mScrollCache;
2172 if (cache != null) {
2173 ScrollBarDrawable scrollBar = cache.scrollBar;
2174 if (scrollBar != null) {
2175 int size = scrollBar.getSize(true);
2176 if (size <= 0) {
2177 size = cache.scrollBarSize;
2178 }
2179 return size;
2180 }
2181 return 0;
2182 }
2183 return 0;
2184 }
2185
2186 /**
2187 * Returns the height of the horizontal scrollbar.
2188 *
2189 * @return The height in pixels of the horizontal scrollbar or 0 if
2190 * there is no horizontal scrollbar.
2191 */
2192 protected int getHorizontalScrollbarHeight() {
2193 ScrollabilityCache cache = mScrollCache;
2194 if (cache != null) {
2195 ScrollBarDrawable scrollBar = cache.scrollBar;
2196 if (scrollBar != null) {
2197 int size = scrollBar.getSize(false);
2198 if (size <= 0) {
2199 size = cache.scrollBarSize;
2200 }
2201 return size;
2202 }
2203 return 0;
2204 }
2205 return 0;
2206 }
2207
2208 /**
2209 * <p>
2210 * Initializes the scrollbars from a given set of styled attributes. This
2211 * method should be called by subclasses that need scrollbars and when an
2212 * instance of these subclasses is created programmatically rather than
2213 * being inflated from XML. This method is automatically called when the XML
2214 * is inflated.
2215 * </p>
2216 *
2217 * @param a the styled attributes set to initialize the scrollbars from
2218 */
2219 protected void initializeScrollbars(TypedArray a) {
2220 initScrollCache();
2221
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002222 final ScrollabilityCache scrollabilityCache = mScrollCache;
Mike Cleronf116bf82009-09-27 19:14:12 -07002223
2224 if (scrollabilityCache.scrollBar == null) {
2225 scrollabilityCache.scrollBar = new ScrollBarDrawable();
2226 }
2227
2228 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002229
Mike Cleronf116bf82009-09-27 19:14:12 -07002230 if (!fadeScrollbars) {
2231 scrollabilityCache.state = ScrollabilityCache.ON;
2232 }
2233 scrollabilityCache.fadeScrollBars = fadeScrollbars;
2234
2235
2236 scrollabilityCache.scrollBarFadeDuration = a.getInt(
2237 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
2238 .getScrollBarFadeDuration());
2239 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
2240 R.styleable.View_scrollbarDefaultDelayBeforeFade,
2241 ViewConfiguration.getScrollDefaultDelay());
2242
2243
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002244 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
2245 com.android.internal.R.styleable.View_scrollbarSize,
2246 ViewConfiguration.get(mContext).getScaledScrollBarSize());
2247
2248 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
2249 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
2250
2251 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
2252 if (thumb != null) {
2253 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
2254 }
2255
2256 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
2257 false);
2258 if (alwaysDraw) {
2259 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
2260 }
2261
2262 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
2263 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
2264
2265 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
2266 if (thumb != null) {
2267 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
2268 }
2269
2270 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
2271 false);
2272 if (alwaysDraw) {
2273 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
2274 }
2275
2276 // Re-apply user/background padding so that scrollbar(s) get added
2277 recomputePadding();
2278 }
2279
2280 /**
2281 * <p>
2282 * Initalizes the scrollability cache if necessary.
2283 * </p>
2284 */
2285 private void initScrollCache() {
2286 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07002287 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002288 }
2289 }
2290
2291 /**
2292 * Register a callback to be invoked when focus of this view changed.
2293 *
2294 * @param l The callback that will run.
2295 */
2296 public void setOnFocusChangeListener(OnFocusChangeListener l) {
2297 mOnFocusChangeListener = l;
2298 }
2299
2300 /**
2301 * Returns the focus-change callback registered for this view.
2302 *
2303 * @return The callback, or null if one is not registered.
2304 */
2305 public OnFocusChangeListener getOnFocusChangeListener() {
2306 return mOnFocusChangeListener;
2307 }
2308
2309 /**
2310 * Register a callback to be invoked when this view is clicked. If this view is not
2311 * clickable, it becomes clickable.
2312 *
2313 * @param l The callback that will run
2314 *
2315 * @see #setClickable(boolean)
2316 */
2317 public void setOnClickListener(OnClickListener l) {
2318 if (!isClickable()) {
2319 setClickable(true);
2320 }
2321 mOnClickListener = l;
2322 }
2323
2324 /**
2325 * Register a callback to be invoked when this view is clicked and held. If this view is not
2326 * long clickable, it becomes long clickable.
2327 *
2328 * @param l The callback that will run
2329 *
2330 * @see #setLongClickable(boolean)
2331 */
2332 public void setOnLongClickListener(OnLongClickListener l) {
2333 if (!isLongClickable()) {
2334 setLongClickable(true);
2335 }
2336 mOnLongClickListener = l;
2337 }
2338
2339 /**
2340 * Register a callback to be invoked when the context menu for this view is
2341 * being built. If this view is not long clickable, it becomes long clickable.
2342 *
2343 * @param l The callback that will run
2344 *
2345 */
2346 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
2347 if (!isLongClickable()) {
2348 setLongClickable(true);
2349 }
2350 mOnCreateContextMenuListener = l;
2351 }
2352
2353 /**
2354 * Call this view's OnClickListener, if it is defined.
2355 *
2356 * @return True there was an assigned OnClickListener that was called, false
2357 * otherwise is returned.
2358 */
2359 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07002360 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
2361
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002362 if (mOnClickListener != null) {
2363 playSoundEffect(SoundEffectConstants.CLICK);
2364 mOnClickListener.onClick(this);
2365 return true;
2366 }
2367
2368 return false;
2369 }
2370
2371 /**
2372 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu
2373 * if the OnLongClickListener did not consume the event.
2374 *
2375 * @return True there was an assigned OnLongClickListener that was called, false
2376 * otherwise is returned.
2377 */
2378 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07002379 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
2380
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002381 boolean handled = false;
2382 if (mOnLongClickListener != null) {
2383 handled = mOnLongClickListener.onLongClick(View.this);
2384 }
2385 if (!handled) {
2386 handled = showContextMenu();
2387 }
2388 if (handled) {
2389 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
2390 }
2391 return handled;
2392 }
2393
2394 /**
2395 * Bring up the context menu for this view.
2396 *
2397 * @return Whether a context menu was displayed.
2398 */
2399 public boolean showContextMenu() {
2400 return getParent().showContextMenuForChild(this);
2401 }
2402
2403 /**
2404 * Register a callback to be invoked when a key is pressed in this view.
2405 * @param l the key listener to attach to this view
2406 */
2407 public void setOnKeyListener(OnKeyListener l) {
2408 mOnKeyListener = l;
2409 }
2410
2411 /**
2412 * Register a callback to be invoked when a touch event is sent to this view.
2413 * @param l the touch listener to attach to this view
2414 */
2415 public void setOnTouchListener(OnTouchListener l) {
2416 mOnTouchListener = l;
2417 }
2418
2419 /**
2420 * Give this view focus. This will cause {@link #onFocusChanged} to be called.
2421 *
2422 * Note: this does not check whether this {@link View} should get focus, it just
2423 * gives it focus no matter what. It should only be called internally by framework
2424 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
2425 *
2426 * @param direction values are View.FOCUS_UP, View.FOCUS_DOWN,
2427 * View.FOCUS_LEFT or View.FOCUS_RIGHT. This is the direction which
2428 * focus moved when requestFocus() is called. It may not always
2429 * apply, in which case use the default View.FOCUS_DOWN.
2430 * @param previouslyFocusedRect The rectangle of the view that had focus
2431 * prior in this View's coordinate system.
2432 */
2433 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
2434 if (DBG) {
2435 System.out.println(this + " requestFocus()");
2436 }
2437
2438 if ((mPrivateFlags & FOCUSED) == 0) {
2439 mPrivateFlags |= FOCUSED;
2440
2441 if (mParent != null) {
2442 mParent.requestChildFocus(this, this);
2443 }
2444
2445 onFocusChanged(true, direction, previouslyFocusedRect);
2446 refreshDrawableState();
2447 }
2448 }
2449
2450 /**
2451 * Request that a rectangle of this view be visible on the screen,
2452 * scrolling if necessary just enough.
2453 *
2454 * <p>A View should call this if it maintains some notion of which part
2455 * of its content is interesting. For example, a text editing view
2456 * should call this when its cursor moves.
2457 *
2458 * @param rectangle The rectangle.
2459 * @return Whether any parent scrolled.
2460 */
2461 public boolean requestRectangleOnScreen(Rect rectangle) {
2462 return requestRectangleOnScreen(rectangle, false);
2463 }
2464
2465 /**
2466 * Request that a rectangle of this view be visible on the screen,
2467 * scrolling if necessary just enough.
2468 *
2469 * <p>A View should call this if it maintains some notion of which part
2470 * of its content is interesting. For example, a text editing view
2471 * should call this when its cursor moves.
2472 *
2473 * <p>When <code>immediate</code> is set to true, scrolling will not be
2474 * animated.
2475 *
2476 * @param rectangle The rectangle.
2477 * @param immediate True to forbid animated scrolling, false otherwise
2478 * @return Whether any parent scrolled.
2479 */
2480 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
2481 View child = this;
2482 ViewParent parent = mParent;
2483 boolean scrolled = false;
2484 while (parent != null) {
2485 scrolled |= parent.requestChildRectangleOnScreen(child,
2486 rectangle, immediate);
2487
2488 // offset rect so next call has the rectangle in the
2489 // coordinate system of its direct child.
2490 rectangle.offset(child.getLeft(), child.getTop());
2491 rectangle.offset(-child.getScrollX(), -child.getScrollY());
2492
2493 if (!(parent instanceof View)) {
2494 break;
2495 }
Romain Guy8506ab42009-06-11 17:35:47 -07002496
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002497 child = (View) parent;
2498 parent = child.getParent();
2499 }
2500 return scrolled;
2501 }
2502
2503 /**
2504 * Called when this view wants to give up focus. This will cause
2505 * {@link #onFocusChanged} to be called.
2506 */
2507 public void clearFocus() {
2508 if (DBG) {
2509 System.out.println(this + " clearFocus()");
2510 }
2511
2512 if ((mPrivateFlags & FOCUSED) != 0) {
2513 mPrivateFlags &= ~FOCUSED;
2514
2515 if (mParent != null) {
2516 mParent.clearChildFocus(this);
2517 }
2518
2519 onFocusChanged(false, 0, null);
2520 refreshDrawableState();
2521 }
2522 }
2523
2524 /**
2525 * Called to clear the focus of a view that is about to be removed.
2526 * Doesn't call clearChildFocus, which prevents this view from taking
2527 * focus again before it has been removed from the parent
2528 */
2529 void clearFocusForRemoval() {
2530 if ((mPrivateFlags & FOCUSED) != 0) {
2531 mPrivateFlags &= ~FOCUSED;
2532
2533 onFocusChanged(false, 0, null);
2534 refreshDrawableState();
2535 }
2536 }
2537
2538 /**
2539 * Called internally by the view system when a new view is getting focus.
2540 * This is what clears the old focus.
2541 */
2542 void unFocus() {
2543 if (DBG) {
2544 System.out.println(this + " unFocus()");
2545 }
2546
2547 if ((mPrivateFlags & FOCUSED) != 0) {
2548 mPrivateFlags &= ~FOCUSED;
2549
2550 onFocusChanged(false, 0, null);
2551 refreshDrawableState();
2552 }
2553 }
2554
2555 /**
2556 * Returns true if this view has focus iteself, or is the ancestor of the
2557 * view that has focus.
2558 *
2559 * @return True if this view has or contains focus, false otherwise.
2560 */
2561 @ViewDebug.ExportedProperty
2562 public boolean hasFocus() {
2563 return (mPrivateFlags & FOCUSED) != 0;
2564 }
2565
2566 /**
2567 * Returns true if this view is focusable or if it contains a reachable View
2568 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
2569 * is a View whose parents do not block descendants focus.
2570 *
2571 * Only {@link #VISIBLE} views are considered focusable.
2572 *
2573 * @return True if the view is focusable or if the view contains a focusable
2574 * View, false otherwise.
2575 *
2576 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
2577 */
2578 public boolean hasFocusable() {
2579 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
2580 }
2581
2582 /**
2583 * Called by the view system when the focus state of this view changes.
2584 * When the focus change event is caused by directional navigation, direction
2585 * and previouslyFocusedRect provide insight into where the focus is coming from.
2586 * When overriding, be sure to call up through to the super class so that
2587 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07002588 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002589 * @param gainFocus True if the View has focus; false otherwise.
2590 * @param direction The direction focus has moved when requestFocus()
2591 * is called to give this view focus. Values are
Romain Guyea4823c2009-12-08 15:03:39 -08002592 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT} or
2593 * {@link #FOCUS_RIGHT}. It may not always apply, in which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002594 * case use the default.
2595 * @param previouslyFocusedRect The rectangle, in this view's coordinate
2596 * system, of the previously focused view. If applicable, this will be
2597 * passed in as finer grained information about where the focus is coming
2598 * from (in addition to direction). Will be <code>null</code> otherwise.
2599 */
2600 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07002601 if (gainFocus) {
2602 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
2603 }
2604
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002605 InputMethodManager imm = InputMethodManager.peekInstance();
2606 if (!gainFocus) {
2607 if (isPressed()) {
2608 setPressed(false);
2609 }
2610 if (imm != null && mAttachInfo != null
2611 && mAttachInfo.mHasWindowFocus) {
2612 imm.focusOut(this);
2613 }
Romain Guya2431d02009-04-30 16:30:00 -07002614 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002615 } else if (imm != null && mAttachInfo != null
2616 && mAttachInfo.mHasWindowFocus) {
2617 imm.focusIn(this);
2618 }
Romain Guy8506ab42009-06-11 17:35:47 -07002619
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002620 invalidate();
2621 if (mOnFocusChangeListener != null) {
2622 mOnFocusChangeListener.onFocusChange(this, gainFocus);
2623 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002624
2625 if (mAttachInfo != null) {
2626 mAttachInfo.mKeyDispatchState.reset(this);
2627 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002628 }
2629
2630 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002631 * {@inheritDoc}
2632 */
2633 public void sendAccessibilityEvent(int eventType) {
2634 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
2635 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
2636 }
2637 }
2638
2639 /**
2640 * {@inheritDoc}
2641 */
2642 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
2643 event.setClassName(getClass().getName());
2644 event.setPackageName(getContext().getPackageName());
2645 event.setEnabled(isEnabled());
2646 event.setContentDescription(mContentDescription);
2647
2648 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) {
2649 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList;
2650 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, FOCUSABLES_ALL);
2651 event.setItemCount(focusablesTempList.size());
2652 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
2653 focusablesTempList.clear();
2654 }
2655
2656 dispatchPopulateAccessibilityEvent(event);
2657
2658 AccessibilityManager.getInstance(mContext).sendAccessibilityEvent(event);
2659 }
2660
2661 /**
2662 * Dispatches an {@link AccessibilityEvent} to the {@link View} children
2663 * to be populated.
2664 *
2665 * @param event The event.
2666 *
2667 * @return True if the event population was completed.
2668 */
2669 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
2670 return false;
2671 }
2672
2673 /**
2674 * Gets the {@link View} description. It briefly describes the view and is
2675 * primarily used for accessibility support. Set this property to enable
2676 * better accessibility support for your application. This is especially
2677 * true for views that do not have textual representation (For example,
2678 * ImageButton).
2679 *
2680 * @return The content descriptiopn.
2681 *
2682 * @attr ref android.R.styleable#View_contentDescription
2683 */
2684 public CharSequence getContentDescription() {
2685 return mContentDescription;
2686 }
2687
2688 /**
2689 * Sets the {@link View} description. It briefly describes the view and is
2690 * primarily used for accessibility support. Set this property to enable
2691 * better accessibility support for your application. This is especially
2692 * true for views that do not have textual representation (For example,
2693 * ImageButton).
2694 *
2695 * @param contentDescription The content description.
2696 *
2697 * @attr ref android.R.styleable#View_contentDescription
2698 */
2699 public void setContentDescription(CharSequence contentDescription) {
2700 mContentDescription = contentDescription;
2701 }
2702
2703 /**
Romain Guya2431d02009-04-30 16:30:00 -07002704 * Invoked whenever this view loses focus, either by losing window focus or by losing
2705 * focus within its window. This method can be used to clear any state tied to the
2706 * focus. For instance, if a button is held pressed with the trackball and the window
2707 * loses focus, this method can be used to cancel the press.
2708 *
2709 * Subclasses of View overriding this method should always call super.onFocusLost().
2710 *
2711 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07002712 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07002713 *
2714 * @hide pending API council approval
2715 */
2716 protected void onFocusLost() {
2717 resetPressedState();
2718 }
2719
2720 private void resetPressedState() {
2721 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
2722 return;
2723 }
2724
2725 if (isPressed()) {
2726 setPressed(false);
2727
2728 if (!mHasPerformedLongPress) {
2729 if (mPendingCheckForLongPress != null) {
2730 removeCallbacks(mPendingCheckForLongPress);
2731 }
2732 }
2733 }
2734 }
2735
2736 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002737 * Returns true if this view has focus
2738 *
2739 * @return True if this view has focus, false otherwise.
2740 */
2741 @ViewDebug.ExportedProperty
2742 public boolean isFocused() {
2743 return (mPrivateFlags & FOCUSED) != 0;
2744 }
2745
2746 /**
2747 * Find the view in the hierarchy rooted at this view that currently has
2748 * focus.
2749 *
2750 * @return The view that currently has focus, or null if no focused view can
2751 * be found.
2752 */
2753 public View findFocus() {
2754 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
2755 }
2756
2757 /**
2758 * Change whether this view is one of the set of scrollable containers in
2759 * its window. This will be used to determine whether the window can
2760 * resize or must pan when a soft input area is open -- scrollable
2761 * containers allow the window to use resize mode since the container
2762 * will appropriately shrink.
2763 */
2764 public void setScrollContainer(boolean isScrollContainer) {
2765 if (isScrollContainer) {
2766 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
2767 mAttachInfo.mScrollContainers.add(this);
2768 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
2769 }
2770 mPrivateFlags |= SCROLL_CONTAINER;
2771 } else {
2772 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
2773 mAttachInfo.mScrollContainers.remove(this);
2774 }
2775 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
2776 }
2777 }
2778
2779 /**
2780 * Returns the quality of the drawing cache.
2781 *
2782 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
2783 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
2784 *
2785 * @see #setDrawingCacheQuality(int)
2786 * @see #setDrawingCacheEnabled(boolean)
2787 * @see #isDrawingCacheEnabled()
2788 *
2789 * @attr ref android.R.styleable#View_drawingCacheQuality
2790 */
2791 public int getDrawingCacheQuality() {
2792 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
2793 }
2794
2795 /**
2796 * Set the drawing cache quality of this view. This value is used only when the
2797 * drawing cache is enabled
2798 *
2799 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
2800 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
2801 *
2802 * @see #getDrawingCacheQuality()
2803 * @see #setDrawingCacheEnabled(boolean)
2804 * @see #isDrawingCacheEnabled()
2805 *
2806 * @attr ref android.R.styleable#View_drawingCacheQuality
2807 */
2808 public void setDrawingCacheQuality(int quality) {
2809 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
2810 }
2811
2812 /**
2813 * Returns whether the screen should remain on, corresponding to the current
2814 * value of {@link #KEEP_SCREEN_ON}.
2815 *
2816 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
2817 *
2818 * @see #setKeepScreenOn(boolean)
2819 *
2820 * @attr ref android.R.styleable#View_keepScreenOn
2821 */
2822 public boolean getKeepScreenOn() {
2823 return (mViewFlags & KEEP_SCREEN_ON) != 0;
2824 }
2825
2826 /**
2827 * Controls whether the screen should remain on, modifying the
2828 * value of {@link #KEEP_SCREEN_ON}.
2829 *
2830 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
2831 *
2832 * @see #getKeepScreenOn()
2833 *
2834 * @attr ref android.R.styleable#View_keepScreenOn
2835 */
2836 public void setKeepScreenOn(boolean keepScreenOn) {
2837 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
2838 }
2839
2840 /**
2841 * @return The user specified next focus ID.
2842 *
2843 * @attr ref android.R.styleable#View_nextFocusLeft
2844 */
2845 public int getNextFocusLeftId() {
2846 return mNextFocusLeftId;
2847 }
2848
2849 /**
2850 * Set the id of the view to use for the next focus
2851 *
2852 * @param nextFocusLeftId
2853 *
2854 * @attr ref android.R.styleable#View_nextFocusLeft
2855 */
2856 public void setNextFocusLeftId(int nextFocusLeftId) {
2857 mNextFocusLeftId = nextFocusLeftId;
2858 }
2859
2860 /**
2861 * @return The user specified next focus ID.
2862 *
2863 * @attr ref android.R.styleable#View_nextFocusRight
2864 */
2865 public int getNextFocusRightId() {
2866 return mNextFocusRightId;
2867 }
2868
2869 /**
2870 * Set the id of the view to use for the next focus
2871 *
2872 * @param nextFocusRightId
2873 *
2874 * @attr ref android.R.styleable#View_nextFocusRight
2875 */
2876 public void setNextFocusRightId(int nextFocusRightId) {
2877 mNextFocusRightId = nextFocusRightId;
2878 }
2879
2880 /**
2881 * @return The user specified next focus ID.
2882 *
2883 * @attr ref android.R.styleable#View_nextFocusUp
2884 */
2885 public int getNextFocusUpId() {
2886 return mNextFocusUpId;
2887 }
2888
2889 /**
2890 * Set the id of the view to use for the next focus
2891 *
2892 * @param nextFocusUpId
2893 *
2894 * @attr ref android.R.styleable#View_nextFocusUp
2895 */
2896 public void setNextFocusUpId(int nextFocusUpId) {
2897 mNextFocusUpId = nextFocusUpId;
2898 }
2899
2900 /**
2901 * @return The user specified next focus ID.
2902 *
2903 * @attr ref android.R.styleable#View_nextFocusDown
2904 */
2905 public int getNextFocusDownId() {
2906 return mNextFocusDownId;
2907 }
2908
2909 /**
2910 * Set the id of the view to use for the next focus
2911 *
2912 * @param nextFocusDownId
2913 *
2914 * @attr ref android.R.styleable#View_nextFocusDown
2915 */
2916 public void setNextFocusDownId(int nextFocusDownId) {
2917 mNextFocusDownId = nextFocusDownId;
2918 }
2919
2920 /**
2921 * Returns the visibility of this view and all of its ancestors
2922 *
2923 * @return True if this view and all of its ancestors are {@link #VISIBLE}
2924 */
2925 public boolean isShown() {
2926 View current = this;
2927 //noinspection ConstantConditions
2928 do {
2929 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
2930 return false;
2931 }
2932 ViewParent parent = current.mParent;
2933 if (parent == null) {
2934 return false; // We are not attached to the view root
2935 }
2936 if (!(parent instanceof View)) {
2937 return true;
2938 }
2939 current = (View) parent;
2940 } while (current != null);
2941
2942 return false;
2943 }
2944
2945 /**
2946 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag
2947 * is set
2948 *
2949 * @param insets Insets for system windows
2950 *
2951 * @return True if this view applied the insets, false otherwise
2952 */
2953 protected boolean fitSystemWindows(Rect insets) {
2954 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
2955 mPaddingLeft = insets.left;
2956 mPaddingTop = insets.top;
2957 mPaddingRight = insets.right;
2958 mPaddingBottom = insets.bottom;
2959 requestLayout();
2960 return true;
2961 }
2962 return false;
2963 }
2964
2965 /**
2966 * Returns the visibility status for this view.
2967 *
2968 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
2969 * @attr ref android.R.styleable#View_visibility
2970 */
2971 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002972 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
2973 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
2974 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002975 })
2976 public int getVisibility() {
2977 return mViewFlags & VISIBILITY_MASK;
2978 }
2979
2980 /**
2981 * Set the enabled state of this view.
2982 *
2983 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
2984 * @attr ref android.R.styleable#View_visibility
2985 */
2986 @RemotableViewMethod
2987 public void setVisibility(int visibility) {
2988 setFlags(visibility, VISIBILITY_MASK);
2989 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false);
2990 }
2991
2992 /**
2993 * Returns the enabled status for this view. The interpretation of the
2994 * enabled state varies by subclass.
2995 *
2996 * @return True if this view is enabled, false otherwise.
2997 */
2998 @ViewDebug.ExportedProperty
2999 public boolean isEnabled() {
3000 return (mViewFlags & ENABLED_MASK) == ENABLED;
3001 }
3002
3003 /**
3004 * Set the enabled state of this view. The interpretation of the enabled
3005 * state varies by subclass.
3006 *
3007 * @param enabled True if this view is enabled, false otherwise.
3008 */
3009 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07003010 if (enabled == isEnabled()) return;
3011
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003012 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
3013
3014 /*
3015 * The View most likely has to change its appearance, so refresh
3016 * the drawable state.
3017 */
3018 refreshDrawableState();
3019
3020 // Invalidate too, since the default behavior for views is to be
3021 // be drawn at 50% alpha rather than to change the drawable.
3022 invalidate();
3023 }
3024
3025 /**
3026 * Set whether this view can receive the focus.
3027 *
3028 * Setting this to false will also ensure that this view is not focusable
3029 * in touch mode.
3030 *
3031 * @param focusable If true, this view can receive the focus.
3032 *
3033 * @see #setFocusableInTouchMode(boolean)
3034 * @attr ref android.R.styleable#View_focusable
3035 */
3036 public void setFocusable(boolean focusable) {
3037 if (!focusable) {
3038 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
3039 }
3040 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
3041 }
3042
3043 /**
3044 * Set whether this view can receive focus while in touch mode.
3045 *
3046 * Setting this to true will also ensure that this view is focusable.
3047 *
3048 * @param focusableInTouchMode If true, this view can receive the focus while
3049 * in touch mode.
3050 *
3051 * @see #setFocusable(boolean)
3052 * @attr ref android.R.styleable#View_focusableInTouchMode
3053 */
3054 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
3055 // Focusable in touch mode should always be set before the focusable flag
3056 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
3057 // which, in touch mode, will not successfully request focus on this view
3058 // because the focusable in touch mode flag is not set
3059 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
3060 if (focusableInTouchMode) {
3061 setFlags(FOCUSABLE, FOCUSABLE_MASK);
3062 }
3063 }
3064
3065 /**
3066 * Set whether this view should have sound effects enabled for events such as
3067 * clicking and touching.
3068 *
3069 * <p>You may wish to disable sound effects for a view if you already play sounds,
3070 * for instance, a dial key that plays dtmf tones.
3071 *
3072 * @param soundEffectsEnabled whether sound effects are enabled for this view.
3073 * @see #isSoundEffectsEnabled()
3074 * @see #playSoundEffect(int)
3075 * @attr ref android.R.styleable#View_soundEffectsEnabled
3076 */
3077 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
3078 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
3079 }
3080
3081 /**
3082 * @return whether this view should have sound effects enabled for events such as
3083 * clicking and touching.
3084 *
3085 * @see #setSoundEffectsEnabled(boolean)
3086 * @see #playSoundEffect(int)
3087 * @attr ref android.R.styleable#View_soundEffectsEnabled
3088 */
3089 @ViewDebug.ExportedProperty
3090 public boolean isSoundEffectsEnabled() {
3091 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
3092 }
3093
3094 /**
3095 * Set whether this view should have haptic feedback for events such as
3096 * long presses.
3097 *
3098 * <p>You may wish to disable haptic feedback if your view already controls
3099 * its own haptic feedback.
3100 *
3101 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
3102 * @see #isHapticFeedbackEnabled()
3103 * @see #performHapticFeedback(int)
3104 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3105 */
3106 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
3107 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
3108 }
3109
3110 /**
3111 * @return whether this view should have haptic feedback enabled for events
3112 * long presses.
3113 *
3114 * @see #setHapticFeedbackEnabled(boolean)
3115 * @see #performHapticFeedback(int)
3116 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3117 */
3118 @ViewDebug.ExportedProperty
3119 public boolean isHapticFeedbackEnabled() {
3120 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
3121 }
3122
3123 /**
3124 * If this view doesn't do any drawing on its own, set this flag to
3125 * allow further optimizations. By default, this flag is not set on
3126 * View, but could be set on some View subclasses such as ViewGroup.
3127 *
3128 * Typically, if you override {@link #onDraw} you should clear this flag.
3129 *
3130 * @param willNotDraw whether or not this View draw on its own
3131 */
3132 public void setWillNotDraw(boolean willNotDraw) {
3133 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
3134 }
3135
3136 /**
3137 * Returns whether or not this View draws on its own.
3138 *
3139 * @return true if this view has nothing to draw, false otherwise
3140 */
3141 @ViewDebug.ExportedProperty
3142 public boolean willNotDraw() {
3143 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
3144 }
3145
3146 /**
3147 * When a View's drawing cache is enabled, drawing is redirected to an
3148 * offscreen bitmap. Some views, like an ImageView, must be able to
3149 * bypass this mechanism if they already draw a single bitmap, to avoid
3150 * unnecessary usage of the memory.
3151 *
3152 * @param willNotCacheDrawing true if this view does not cache its
3153 * drawing, false otherwise
3154 */
3155 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
3156 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
3157 }
3158
3159 /**
3160 * Returns whether or not this View can cache its drawing or not.
3161 *
3162 * @return true if this view does not cache its drawing, false otherwise
3163 */
3164 @ViewDebug.ExportedProperty
3165 public boolean willNotCacheDrawing() {
3166 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
3167 }
3168
3169 /**
3170 * Indicates whether this view reacts to click events or not.
3171 *
3172 * @return true if the view is clickable, false otherwise
3173 *
3174 * @see #setClickable(boolean)
3175 * @attr ref android.R.styleable#View_clickable
3176 */
3177 @ViewDebug.ExportedProperty
3178 public boolean isClickable() {
3179 return (mViewFlags & CLICKABLE) == CLICKABLE;
3180 }
3181
3182 /**
3183 * Enables or disables click events for this view. When a view
3184 * is clickable it will change its state to "pressed" on every click.
3185 * Subclasses should set the view clickable to visually react to
3186 * user's clicks.
3187 *
3188 * @param clickable true to make the view clickable, false otherwise
3189 *
3190 * @see #isClickable()
3191 * @attr ref android.R.styleable#View_clickable
3192 */
3193 public void setClickable(boolean clickable) {
3194 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
3195 }
3196
3197 /**
3198 * Indicates whether this view reacts to long click events or not.
3199 *
3200 * @return true if the view is long clickable, false otherwise
3201 *
3202 * @see #setLongClickable(boolean)
3203 * @attr ref android.R.styleable#View_longClickable
3204 */
3205 public boolean isLongClickable() {
3206 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
3207 }
3208
3209 /**
3210 * Enables or disables long click events for this view. When a view is long
3211 * clickable it reacts to the user holding down the button for a longer
3212 * duration than a tap. This event can either launch the listener or a
3213 * context menu.
3214 *
3215 * @param longClickable true to make the view long clickable, false otherwise
3216 * @see #isLongClickable()
3217 * @attr ref android.R.styleable#View_longClickable
3218 */
3219 public void setLongClickable(boolean longClickable) {
3220 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
3221 }
3222
3223 /**
3224 * Sets the pressed that for this view.
3225 *
3226 * @see #isClickable()
3227 * @see #setClickable(boolean)
3228 *
3229 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
3230 * the View's internal state from a previously set "pressed" state.
3231 */
3232 public void setPressed(boolean pressed) {
3233 if (pressed) {
3234 mPrivateFlags |= PRESSED;
3235 } else {
3236 mPrivateFlags &= ~PRESSED;
3237 }
3238 refreshDrawableState();
3239 dispatchSetPressed(pressed);
3240 }
3241
3242 /**
3243 * Dispatch setPressed to all of this View's children.
3244 *
3245 * @see #setPressed(boolean)
3246 *
3247 * @param pressed The new pressed state
3248 */
3249 protected void dispatchSetPressed(boolean pressed) {
3250 }
3251
3252 /**
3253 * Indicates whether the view is currently in pressed state. Unless
3254 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
3255 * the pressed state.
3256 *
3257 * @see #setPressed
3258 * @see #isClickable()
3259 * @see #setClickable(boolean)
3260 *
3261 * @return true if the view is currently pressed, false otherwise
3262 */
3263 public boolean isPressed() {
3264 return (mPrivateFlags & PRESSED) == PRESSED;
3265 }
3266
3267 /**
3268 * Indicates whether this view will save its state (that is,
3269 * whether its {@link #onSaveInstanceState} method will be called).
3270 *
3271 * @return Returns true if the view state saving is enabled, else false.
3272 *
3273 * @see #setSaveEnabled(boolean)
3274 * @attr ref android.R.styleable#View_saveEnabled
3275 */
3276 public boolean isSaveEnabled() {
3277 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
3278 }
3279
3280 /**
3281 * Controls whether the saving of this view's state is
3282 * enabled (that is, whether its {@link #onSaveInstanceState} method
3283 * will be called). Note that even if freezing is enabled, the
3284 * view still must have an id assigned to it (via {@link #setId setId()})
3285 * for its state to be saved. This flag can only disable the
3286 * saving of this view; any child views may still have their state saved.
3287 *
3288 * @param enabled Set to false to <em>disable</em> state saving, or true
3289 * (the default) to allow it.
3290 *
3291 * @see #isSaveEnabled()
3292 * @see #setId(int)
3293 * @see #onSaveInstanceState()
3294 * @attr ref android.R.styleable#View_saveEnabled
3295 */
3296 public void setSaveEnabled(boolean enabled) {
3297 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
3298 }
3299
3300
3301 /**
3302 * Returns whether this View is able to take focus.
3303 *
3304 * @return True if this view can take focus, or false otherwise.
3305 * @attr ref android.R.styleable#View_focusable
3306 */
3307 @ViewDebug.ExportedProperty
3308 public final boolean isFocusable() {
3309 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
3310 }
3311
3312 /**
3313 * When a view is focusable, it may not want to take focus when in touch mode.
3314 * For example, a button would like focus when the user is navigating via a D-pad
3315 * so that the user can click on it, but once the user starts touching the screen,
3316 * the button shouldn't take focus
3317 * @return Whether the view is focusable in touch mode.
3318 * @attr ref android.R.styleable#View_focusableInTouchMode
3319 */
3320 @ViewDebug.ExportedProperty
3321 public final boolean isFocusableInTouchMode() {
3322 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
3323 }
3324
3325 /**
3326 * Find the nearest view in the specified direction that can take focus.
3327 * This does not actually give focus to that view.
3328 *
3329 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
3330 *
3331 * @return The nearest focusable in the specified direction, or null if none
3332 * can be found.
3333 */
3334 public View focusSearch(int direction) {
3335 if (mParent != null) {
3336 return mParent.focusSearch(this, direction);
3337 } else {
3338 return null;
3339 }
3340 }
3341
3342 /**
3343 * This method is the last chance for the focused view and its ancestors to
3344 * respond to an arrow key. This is called when the focused view did not
3345 * consume the key internally, nor could the view system find a new view in
3346 * the requested direction to give focus to.
3347 *
3348 * @param focused The currently focused view.
3349 * @param direction The direction focus wants to move. One of FOCUS_UP,
3350 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
3351 * @return True if the this view consumed this unhandled move.
3352 */
3353 public boolean dispatchUnhandledMove(View focused, int direction) {
3354 return false;
3355 }
3356
3357 /**
3358 * If a user manually specified the next view id for a particular direction,
3359 * use the root to look up the view. Once a view is found, it is cached
3360 * for future lookups.
3361 * @param root The root view of the hierarchy containing this view.
3362 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
3363 * @return The user specified next view, or null if there is none.
3364 */
3365 View findUserSetNextFocus(View root, int direction) {
3366 switch (direction) {
3367 case FOCUS_LEFT:
3368 if (mNextFocusLeftId == View.NO_ID) return null;
3369 return findViewShouldExist(root, mNextFocusLeftId);
3370 case FOCUS_RIGHT:
3371 if (mNextFocusRightId == View.NO_ID) return null;
3372 return findViewShouldExist(root, mNextFocusRightId);
3373 case FOCUS_UP:
3374 if (mNextFocusUpId == View.NO_ID) return null;
3375 return findViewShouldExist(root, mNextFocusUpId);
3376 case FOCUS_DOWN:
3377 if (mNextFocusDownId == View.NO_ID) return null;
3378 return findViewShouldExist(root, mNextFocusDownId);
3379 }
3380 return null;
3381 }
3382
3383 private static View findViewShouldExist(View root, int childViewId) {
3384 View result = root.findViewById(childViewId);
3385 if (result == null) {
3386 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
3387 + "by user for id " + childViewId);
3388 }
3389 return result;
3390 }
3391
3392 /**
3393 * Find and return all focusable views that are descendants of this view,
3394 * possibly including this view if it is focusable itself.
3395 *
3396 * @param direction The direction of the focus
3397 * @return A list of focusable views
3398 */
3399 public ArrayList<View> getFocusables(int direction) {
3400 ArrayList<View> result = new ArrayList<View>(24);
3401 addFocusables(result, direction);
3402 return result;
3403 }
3404
3405 /**
3406 * Add any focusable views that are descendants of this view (possibly
3407 * including this view if it is focusable itself) to views. If we are in touch mode,
3408 * only add views that are also focusable in touch mode.
3409 *
3410 * @param views Focusable views found so far
3411 * @param direction The direction of the focus
3412 */
3413 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07003414 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
3415 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003416
svetoslavganov75986cf2009-05-14 22:28:01 -07003417 /**
3418 * Adds any focusable views that are descendants of this view (possibly
3419 * including this view if it is focusable itself) to views. This method
3420 * adds all focusable views regardless if we are in touch mode or
3421 * only views focusable in touch mode if we are in touch mode depending on
3422 * the focusable mode paramater.
3423 *
3424 * @param views Focusable views found so far or null if all we are interested is
3425 * the number of focusables.
3426 * @param direction The direction of the focus.
3427 * @param focusableMode The type of focusables to be added.
3428 *
3429 * @see #FOCUSABLES_ALL
3430 * @see #FOCUSABLES_TOUCH_MODE
3431 */
3432 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
3433 if (!isFocusable()) {
3434 return;
3435 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003436
svetoslavganov75986cf2009-05-14 22:28:01 -07003437 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE &&
3438 isInTouchMode() && !isFocusableInTouchMode()) {
3439 return;
3440 }
3441
3442 if (views != null) {
3443 views.add(this);
3444 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003445 }
3446
3447 /**
3448 * Find and return all touchable views that are descendants of this view,
3449 * possibly including this view if it is touchable itself.
3450 *
3451 * @return A list of touchable views
3452 */
3453 public ArrayList<View> getTouchables() {
3454 ArrayList<View> result = new ArrayList<View>();
3455 addTouchables(result);
3456 return result;
3457 }
3458
3459 /**
3460 * Add any touchable views that are descendants of this view (possibly
3461 * including this view if it is touchable itself) to views.
3462 *
3463 * @param views Touchable views found so far
3464 */
3465 public void addTouchables(ArrayList<View> views) {
3466 final int viewFlags = mViewFlags;
3467
3468 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
3469 && (viewFlags & ENABLED_MASK) == ENABLED) {
3470 views.add(this);
3471 }
3472 }
3473
3474 /**
3475 * Call this to try to give focus to a specific view or to one of its
3476 * descendants.
3477 *
3478 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
3479 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
3480 * while the device is in touch mode.
3481 *
3482 * See also {@link #focusSearch}, which is what you call to say that you
3483 * have focus, and you want your parent to look for the next one.
3484 *
3485 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
3486 * {@link #FOCUS_DOWN} and <code>null</code>.
3487 *
3488 * @return Whether this view or one of its descendants actually took focus.
3489 */
3490 public final boolean requestFocus() {
3491 return requestFocus(View.FOCUS_DOWN);
3492 }
3493
3494
3495 /**
3496 * Call this to try to give focus to a specific view or to one of its
3497 * descendants and give it a hint about what direction focus is heading.
3498 *
3499 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
3500 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
3501 * while the device is in touch mode.
3502 *
3503 * See also {@link #focusSearch}, which is what you call to say that you
3504 * have focus, and you want your parent to look for the next one.
3505 *
3506 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
3507 * <code>null</code> set for the previously focused rectangle.
3508 *
3509 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
3510 * @return Whether this view or one of its descendants actually took focus.
3511 */
3512 public final boolean requestFocus(int direction) {
3513 return requestFocus(direction, null);
3514 }
3515
3516 /**
3517 * Call this to try to give focus to a specific view or to one of its descendants
3518 * and give it hints about the direction and a specific rectangle that the focus
3519 * is coming from. The rectangle can help give larger views a finer grained hint
3520 * about where focus is coming from, and therefore, where to show selection, or
3521 * forward focus change internally.
3522 *
3523 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
3524 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
3525 * while the device is in touch mode.
3526 *
3527 * A View will not take focus if it is not visible.
3528 *
3529 * A View will not take focus if one of its parents has {@link android.view.ViewGroup#getDescendantFocusability()}
3530 * equal to {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
3531 *
3532 * See also {@link #focusSearch}, which is what you call to say that you
3533 * have focus, and you want your parent to look for the next one.
3534 *
3535 * You may wish to override this method if your custom {@link View} has an internal
3536 * {@link View} that it wishes to forward the request to.
3537 *
3538 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
3539 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
3540 * to give a finer grained hint about where focus is coming from. May be null
3541 * if there is no hint.
3542 * @return Whether this view or one of its descendants actually took focus.
3543 */
3544 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
3545 // need to be focusable
3546 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
3547 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
3548 return false;
3549 }
3550
3551 // need to be focusable in touch mode if in touch mode
3552 if (isInTouchMode() &&
3553 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
3554 return false;
3555 }
3556
3557 // need to not have any parents blocking us
3558 if (hasAncestorThatBlocksDescendantFocus()) {
3559 return false;
3560 }
3561
3562 handleFocusGainInternal(direction, previouslyFocusedRect);
3563 return true;
3564 }
3565
3566 /**
3567 * Call this to try to give focus to a specific view or to one of its descendants. This is a
3568 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
3569 * touch mode to request focus when they are touched.
3570 *
3571 * @return Whether this view or one of its descendants actually took focus.
3572 *
3573 * @see #isInTouchMode()
3574 *
3575 */
3576 public final boolean requestFocusFromTouch() {
3577 // Leave touch mode if we need to
3578 if (isInTouchMode()) {
3579 View root = getRootView();
3580 if (root != null) {
3581 ViewRoot viewRoot = (ViewRoot)root.getParent();
3582 if (viewRoot != null) {
3583 viewRoot.ensureTouchMode(false);
3584 }
3585 }
3586 }
3587 return requestFocus(View.FOCUS_DOWN);
3588 }
3589
3590 /**
3591 * @return Whether any ancestor of this view blocks descendant focus.
3592 */
3593 private boolean hasAncestorThatBlocksDescendantFocus() {
3594 ViewParent ancestor = mParent;
3595 while (ancestor instanceof ViewGroup) {
3596 final ViewGroup vgAncestor = (ViewGroup) ancestor;
3597 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
3598 return true;
3599 } else {
3600 ancestor = vgAncestor.getParent();
3601 }
3602 }
3603 return false;
3604 }
3605
3606 /**
3607 * This is called when a container is going to temporarily detach a child
3608 * that currently has focus, with
3609 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
3610 * It will either be followed by {@link #onFinishTemporaryDetach()} or
3611 * {@link #onDetachedFromWindow()} when the container is done. Generally
3612 * this is currently only done ListView for a view with focus.
3613 */
3614 public void onStartTemporaryDetach() {
3615 }
Romain Guy8506ab42009-06-11 17:35:47 -07003616
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003617 /**
3618 * Called after {@link #onStartTemporaryDetach} when the container is done
3619 * changing the view.
3620 */
3621 public void onFinishTemporaryDetach() {
3622 }
Romain Guy8506ab42009-06-11 17:35:47 -07003623
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003624 /**
3625 * capture information of this view for later analysis: developement only
3626 * check dynamic switch to make sure we only dump view
3627 * when ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW) is set
3628 */
3629 private static void captureViewInfo(String subTag, View v) {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07003630 if (v == null || SystemProperties.getInt(ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW, 0) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003631 return;
3632 }
3633 ViewDebug.dumpCapturedView(subTag, v);
3634 }
3635
3636 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07003637 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
3638 * for this view's window. Returns null if the view is not currently attached
3639 * to the window. Normally you will not need to use this directly, but
3640 * just use the standard high-level event callbacks like {@link #onKeyDown}.
3641 */
3642 public KeyEvent.DispatcherState getKeyDispatcherState() {
3643 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
3644 }
3645
3646 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003647 * Dispatch a key event before it is processed by any input method
3648 * associated with the view hierarchy. This can be used to intercept
3649 * key events in special situations before the IME consumes them; a
3650 * typical example would be handling the BACK key to update the application's
3651 * UI instead of allowing the IME to see it and close itself.
3652 *
3653 * @param event The key event to be dispatched.
3654 * @return True if the event was handled, false otherwise.
3655 */
3656 public boolean dispatchKeyEventPreIme(KeyEvent event) {
3657 return onKeyPreIme(event.getKeyCode(), event);
3658 }
3659
3660 /**
3661 * Dispatch a key event to the next view on the focus path. This path runs
3662 * from the top of the view tree down to the currently focused view. If this
3663 * view has focus, it will dispatch to itself. Otherwise it will dispatch
3664 * the next node down the focus path. This method also fires any key
3665 * listeners.
3666 *
3667 * @param event The key event to be dispatched.
3668 * @return True if the event was handled, false otherwise.
3669 */
3670 public boolean dispatchKeyEvent(KeyEvent event) {
3671 // If any attached key listener a first crack at the event.
3672 //noinspection SimplifiableIfStatement
3673
3674 if (android.util.Config.LOGV) {
3675 captureViewInfo("captureViewKeyEvent", this);
3676 }
3677
3678 if (mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
3679 && mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
3680 return true;
3681 }
3682
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07003683 return event.dispatch(this, mAttachInfo != null
3684 ? mAttachInfo.mKeyDispatchState : null, this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003685 }
3686
3687 /**
3688 * Dispatches a key shortcut event.
3689 *
3690 * @param event The key event to be dispatched.
3691 * @return True if the event was handled by the view, false otherwise.
3692 */
3693 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
3694 return onKeyShortcut(event.getKeyCode(), event);
3695 }
3696
3697 /**
3698 * Pass the touch screen motion event down to the target view, or this
3699 * view if it is the target.
3700 *
3701 * @param event The motion event to be dispatched.
3702 * @return True if the event was handled by the view, false otherwise.
3703 */
3704 public boolean dispatchTouchEvent(MotionEvent event) {
3705 if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED &&
3706 mOnTouchListener.onTouch(this, event)) {
3707 return true;
3708 }
3709 return onTouchEvent(event);
3710 }
3711
3712 /**
3713 * Pass a trackball motion event down to the focused view.
3714 *
3715 * @param event The motion event to be dispatched.
3716 * @return True if the event was handled by the view, false otherwise.
3717 */
3718 public boolean dispatchTrackballEvent(MotionEvent event) {
3719 //Log.i("view", "view=" + this + ", " + event.toString());
3720 return onTrackballEvent(event);
3721 }
3722
3723 /**
3724 * Called when the window containing this view gains or loses window focus.
3725 * ViewGroups should override to route to their children.
3726 *
3727 * @param hasFocus True if the window containing this view now has focus,
3728 * false otherwise.
3729 */
3730 public void dispatchWindowFocusChanged(boolean hasFocus) {
3731 onWindowFocusChanged(hasFocus);
3732 }
3733
3734 /**
3735 * Called when the window containing this view gains or loses focus. Note
3736 * that this is separate from view focus: to receive key events, both
3737 * your view and its window must have focus. If a window is displayed
3738 * on top of yours that takes input focus, then your own window will lose
3739 * focus but the view focus will remain unchanged.
3740 *
3741 * @param hasWindowFocus True if the window containing this view now has
3742 * focus, false otherwise.
3743 */
3744 public void onWindowFocusChanged(boolean hasWindowFocus) {
3745 InputMethodManager imm = InputMethodManager.peekInstance();
3746 if (!hasWindowFocus) {
3747 if (isPressed()) {
3748 setPressed(false);
3749 }
3750 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
3751 imm.focusOut(this);
3752 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003753 if (mPendingCheckForLongPress != null) {
3754 removeCallbacks(mPendingCheckForLongPress);
3755 }
Romain Guya2431d02009-04-30 16:30:00 -07003756 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003757 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
3758 imm.focusIn(this);
3759 }
3760 refreshDrawableState();
3761 }
3762
3763 /**
3764 * Returns true if this view is in a window that currently has window focus.
3765 * Note that this is not the same as the view itself having focus.
3766 *
3767 * @return True if this view is in a window that currently has window focus.
3768 */
3769 public boolean hasWindowFocus() {
3770 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
3771 }
3772
3773 /**
Adam Powell326d8082009-12-09 15:10:07 -08003774 * Dispatch a view visibility change down the view hierarchy.
3775 * ViewGroups should override to route to their children.
3776 * @param changedView The view whose visibility changed. Could be 'this' or
3777 * an ancestor view.
3778 * @param visibility The new visibility of changedView.
3779 */
3780 protected void dispatchVisibilityChanged(View changedView, int visibility) {
3781 onVisibilityChanged(changedView, visibility);
3782 }
3783
3784 /**
3785 * Called when the visibility of the view or an ancestor of the view is changed.
3786 * @param changedView The view whose visibility changed. Could be 'this' or
3787 * an ancestor view.
3788 * @param visibility The new visibility of changedView.
3789 */
3790 protected void onVisibilityChanged(View changedView, int visibility) {
3791 }
3792
3793 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003794 * Dispatch a window visibility change down the view hierarchy.
3795 * ViewGroups should override to route to their children.
3796 *
3797 * @param visibility The new visibility of the window.
3798 *
3799 * @see #onWindowVisibilityChanged
3800 */
3801 public void dispatchWindowVisibilityChanged(int visibility) {
3802 onWindowVisibilityChanged(visibility);
3803 }
3804
3805 /**
3806 * Called when the window containing has change its visibility
3807 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
3808 * that this tells you whether or not your window is being made visible
3809 * to the window manager; this does <em>not</em> tell you whether or not
3810 * your window is obscured by other windows on the screen, even if it
3811 * is itself visible.
3812 *
3813 * @param visibility The new visibility of the window.
3814 */
3815 protected void onWindowVisibilityChanged(int visibility) {
3816 }
3817
3818 /**
3819 * Returns the current visibility of the window this view is attached to
3820 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
3821 *
3822 * @return Returns the current visibility of the view's window.
3823 */
3824 public int getWindowVisibility() {
3825 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
3826 }
3827
3828 /**
3829 * Retrieve the overall visible display size in which the window this view is
3830 * attached to has been positioned in. This takes into account screen
3831 * decorations above the window, for both cases where the window itself
3832 * is being position inside of them or the window is being placed under
3833 * then and covered insets are used for the window to position its content
3834 * inside. In effect, this tells you the available area where content can
3835 * be placed and remain visible to users.
3836 *
3837 * <p>This function requires an IPC back to the window manager to retrieve
3838 * the requested information, so should not be used in performance critical
3839 * code like drawing.
3840 *
3841 * @param outRect Filled in with the visible display frame. If the view
3842 * is not attached to a window, this is simply the raw display size.
3843 */
3844 public void getWindowVisibleDisplayFrame(Rect outRect) {
3845 if (mAttachInfo != null) {
3846 try {
3847 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
3848 } catch (RemoteException e) {
3849 return;
3850 }
3851 // XXX This is really broken, and probably all needs to be done
3852 // in the window manager, and we need to know more about whether
3853 // we want the area behind or in front of the IME.
3854 final Rect insets = mAttachInfo.mVisibleInsets;
3855 outRect.left += insets.left;
3856 outRect.top += insets.top;
3857 outRect.right -= insets.right;
3858 outRect.bottom -= insets.bottom;
3859 return;
3860 }
3861 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
3862 outRect.set(0, 0, d.getWidth(), d.getHeight());
3863 }
3864
3865 /**
3866 * Private function to aggregate all per-view attributes in to the view
3867 * root.
3868 */
3869 void dispatchCollectViewAttributes(int visibility) {
3870 performCollectViewAttributes(visibility);
3871 }
3872
3873 void performCollectViewAttributes(int visibility) {
3874 //noinspection PointlessBitwiseExpression
3875 if (((visibility | mViewFlags) & (VISIBILITY_MASK | KEEP_SCREEN_ON))
3876 == (VISIBLE | KEEP_SCREEN_ON)) {
3877 mAttachInfo.mKeepScreenOn = true;
3878 }
3879 }
3880
3881 void needGlobalAttributesUpdate(boolean force) {
3882 AttachInfo ai = mAttachInfo;
3883 if (ai != null) {
3884 if (ai.mKeepScreenOn || force) {
3885 ai.mRecomputeGlobalAttributes = true;
3886 }
3887 }
3888 }
3889
3890 /**
3891 * Returns whether the device is currently in touch mode. Touch mode is entered
3892 * once the user begins interacting with the device by touch, and affects various
3893 * things like whether focus is always visible to the user.
3894 *
3895 * @return Whether the device is in touch mode.
3896 */
3897 @ViewDebug.ExportedProperty
3898 public boolean isInTouchMode() {
3899 if (mAttachInfo != null) {
3900 return mAttachInfo.mInTouchMode;
3901 } else {
3902 return ViewRoot.isInTouchMode();
3903 }
3904 }
3905
3906 /**
3907 * Returns the context the view is running in, through which it can
3908 * access the current theme, resources, etc.
3909 *
3910 * @return The view's Context.
3911 */
3912 @ViewDebug.CapturedViewProperty
3913 public final Context getContext() {
3914 return mContext;
3915 }
3916
3917 /**
3918 * Handle a key event before it is processed by any input method
3919 * associated with the view hierarchy. This can be used to intercept
3920 * key events in special situations before the IME consumes them; a
3921 * typical example would be handling the BACK key to update the application's
3922 * UI instead of allowing the IME to see it and close itself.
3923 *
3924 * @param keyCode The value in event.getKeyCode().
3925 * @param event Description of the key event.
3926 * @return If you handled the event, return true. If you want to allow the
3927 * event to be handled by the next receiver, return false.
3928 */
3929 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
3930 return false;
3931 }
3932
3933 /**
3934 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
3935 * KeyEvent.Callback.onKeyMultiple()}: perform press of the view
3936 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
3937 * is released, if the view is enabled and clickable.
3938 *
3939 * @param keyCode A key code that represents the button pressed, from
3940 * {@link android.view.KeyEvent}.
3941 * @param event The KeyEvent object that defines the button action.
3942 */
3943 public boolean onKeyDown(int keyCode, KeyEvent event) {
3944 boolean result = false;
3945
3946 switch (keyCode) {
3947 case KeyEvent.KEYCODE_DPAD_CENTER:
3948 case KeyEvent.KEYCODE_ENTER: {
3949 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
3950 return true;
3951 }
3952 // Long clickable items don't necessarily have to be clickable
3953 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
3954 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
3955 (event.getRepeatCount() == 0)) {
3956 setPressed(true);
3957 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
3958 postCheckForLongClick();
3959 }
3960 return true;
3961 }
3962 break;
3963 }
3964 }
3965 return result;
3966 }
3967
3968 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07003969 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
3970 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
3971 * the event).
3972 */
3973 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
3974 return false;
3975 }
3976
3977 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003978 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
3979 * KeyEvent.Callback.onKeyMultiple()}: perform clicking of the view
3980 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
3981 * {@link KeyEvent#KEYCODE_ENTER} is released.
3982 *
3983 * @param keyCode A key code that represents the button pressed, from
3984 * {@link android.view.KeyEvent}.
3985 * @param event The KeyEvent object that defines the button action.
3986 */
3987 public boolean onKeyUp(int keyCode, KeyEvent event) {
3988 boolean result = false;
3989
3990 switch (keyCode) {
3991 case KeyEvent.KEYCODE_DPAD_CENTER:
3992 case KeyEvent.KEYCODE_ENTER: {
3993 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
3994 return true;
3995 }
3996 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
3997 setPressed(false);
3998
3999 if (!mHasPerformedLongPress) {
4000 // This is a tap, so remove the longpress check
4001 if (mPendingCheckForLongPress != null) {
4002 removeCallbacks(mPendingCheckForLongPress);
4003 }
4004
4005 result = performClick();
4006 }
4007 }
4008 break;
4009 }
4010 }
4011 return result;
4012 }
4013
4014 /**
4015 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
4016 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
4017 * the event).
4018 *
4019 * @param keyCode A key code that represents the button pressed, from
4020 * {@link android.view.KeyEvent}.
4021 * @param repeatCount The number of times the action was made.
4022 * @param event The KeyEvent object that defines the button action.
4023 */
4024 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
4025 return false;
4026 }
4027
4028 /**
4029 * Called when an unhandled key shortcut event occurs.
4030 *
4031 * @param keyCode The value in event.getKeyCode().
4032 * @param event Description of the key event.
4033 * @return If you handled the event, return true. If you want to allow the
4034 * event to be handled by the next receiver, return false.
4035 */
4036 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
4037 return false;
4038 }
4039
4040 /**
4041 * Check whether the called view is a text editor, in which case it
4042 * would make sense to automatically display a soft input window for
4043 * it. Subclasses should override this if they implement
4044 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004045 * a call on that method would return a non-null InputConnection, and
4046 * they are really a first-class editor that the user would normally
4047 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07004048 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004049 * <p>The default implementation always returns false. This does
4050 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
4051 * will not be called or the user can not otherwise perform edits on your
4052 * view; it is just a hint to the system that this is not the primary
4053 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07004054 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004055 * @return Returns true if this view is a text editor, else false.
4056 */
4057 public boolean onCheckIsTextEditor() {
4058 return false;
4059 }
Romain Guy8506ab42009-06-11 17:35:47 -07004060
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004061 /**
4062 * Create a new InputConnection for an InputMethod to interact
4063 * with the view. The default implementation returns null, since it doesn't
4064 * support input methods. You can override this to implement such support.
4065 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07004066 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004067 * <p>When implementing this, you probably also want to implement
4068 * {@link #onCheckIsTextEditor()} to indicate you will return a
4069 * non-null InputConnection.
4070 *
4071 * @param outAttrs Fill in with attribute information about the connection.
4072 */
4073 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
4074 return null;
4075 }
4076
4077 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004078 * Called by the {@link android.view.inputmethod.InputMethodManager}
4079 * when a view who is not the current
4080 * input connection target is trying to make a call on the manager. The
4081 * default implementation returns false; you can override this to return
4082 * true for certain views if you are performing InputConnection proxying
4083 * to them.
4084 * @param view The View that is making the InputMethodManager call.
4085 * @return Return true to allow the call, false to reject.
4086 */
4087 public boolean checkInputConnectionProxy(View view) {
4088 return false;
4089 }
Romain Guy8506ab42009-06-11 17:35:47 -07004090
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004091 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004092 * Show the context menu for this view. It is not safe to hold on to the
4093 * menu after returning from this method.
4094 *
4095 * @param menu The context menu to populate
4096 */
4097 public void createContextMenu(ContextMenu menu) {
4098 ContextMenuInfo menuInfo = getContextMenuInfo();
4099
4100 // Sets the current menu info so all items added to menu will have
4101 // my extra info set.
4102 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
4103
4104 onCreateContextMenu(menu);
4105 if (mOnCreateContextMenuListener != null) {
4106 mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
4107 }
4108
4109 // Clear the extra information so subsequent items that aren't mine don't
4110 // have my extra info.
4111 ((MenuBuilder)menu).setCurrentMenuInfo(null);
4112
4113 if (mParent != null) {
4114 mParent.createContextMenu(menu);
4115 }
4116 }
4117
4118 /**
4119 * Views should implement this if they have extra information to associate
4120 * with the context menu. The return result is supplied as a parameter to
4121 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
4122 * callback.
4123 *
4124 * @return Extra information about the item for which the context menu
4125 * should be shown. This information will vary across different
4126 * subclasses of View.
4127 */
4128 protected ContextMenuInfo getContextMenuInfo() {
4129 return null;
4130 }
4131
4132 /**
4133 * Views should implement this if the view itself is going to add items to
4134 * the context menu.
4135 *
4136 * @param menu the context menu to populate
4137 */
4138 protected void onCreateContextMenu(ContextMenu menu) {
4139 }
4140
4141 /**
4142 * Implement this method to handle trackball motion events. The
4143 * <em>relative</em> movement of the trackball since the last event
4144 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
4145 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
4146 * that a movement of 1 corresponds to the user pressing one DPAD key (so
4147 * they will often be fractional values, representing the more fine-grained
4148 * movement information available from a trackball).
4149 *
4150 * @param event The motion event.
4151 * @return True if the event was handled, false otherwise.
4152 */
4153 public boolean onTrackballEvent(MotionEvent event) {
4154 return false;
4155 }
4156
4157 /**
4158 * Implement this method to handle touch screen motion events.
4159 *
4160 * @param event The motion event.
4161 * @return True if the event was handled, false otherwise.
4162 */
4163 public boolean onTouchEvent(MotionEvent event) {
4164 final int viewFlags = mViewFlags;
4165
4166 if ((viewFlags & ENABLED_MASK) == DISABLED) {
4167 // A disabled view that is clickable still consumes the touch
4168 // events, it just doesn't respond to them.
4169 return (((viewFlags & CLICKABLE) == CLICKABLE ||
4170 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
4171 }
4172
4173 if (mTouchDelegate != null) {
4174 if (mTouchDelegate.onTouchEvent(event)) {
4175 return true;
4176 }
4177 }
4178
4179 if (((viewFlags & CLICKABLE) == CLICKABLE ||
4180 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
4181 switch (event.getAction()) {
4182 case MotionEvent.ACTION_UP:
4183 if ((mPrivateFlags & PRESSED) != 0) {
4184 // take focus if we don't have it already and we should in
4185 // touch mode.
4186 boolean focusTaken = false;
4187 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
4188 focusTaken = requestFocus();
4189 }
4190
4191 if (!mHasPerformedLongPress) {
4192 // This is a tap, so remove the longpress check
4193 if (mPendingCheckForLongPress != null) {
4194 removeCallbacks(mPendingCheckForLongPress);
4195 }
4196
4197 // Only perform take click actions if we were in the pressed state
4198 if (!focusTaken) {
4199 performClick();
4200 }
4201 }
4202
4203 if (mUnsetPressedState == null) {
4204 mUnsetPressedState = new UnsetPressedState();
4205 }
4206
4207 if (!post(mUnsetPressedState)) {
4208 // If the post failed, unpress right now
4209 mUnsetPressedState.run();
4210 }
4211 }
4212 break;
4213
4214 case MotionEvent.ACTION_DOWN:
4215 mPrivateFlags |= PRESSED;
4216 refreshDrawableState();
4217 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
4218 postCheckForLongClick();
4219 }
4220 break;
4221
4222 case MotionEvent.ACTION_CANCEL:
4223 mPrivateFlags &= ~PRESSED;
4224 refreshDrawableState();
4225 break;
4226
4227 case MotionEvent.ACTION_MOVE:
4228 final int x = (int) event.getX();
4229 final int y = (int) event.getY();
4230
4231 // Be lenient about moving outside of buttons
4232 int slop = ViewConfiguration.get(mContext).getScaledTouchSlop();
4233 if ((x < 0 - slop) || (x >= getWidth() + slop) ||
4234 (y < 0 - slop) || (y >= getHeight() + slop)) {
4235 // Outside button
4236 if ((mPrivateFlags & PRESSED) != 0) {
4237 // Remove any future long press checks
4238 if (mPendingCheckForLongPress != null) {
4239 removeCallbacks(mPendingCheckForLongPress);
4240 }
4241
4242 // Need to switch from pressed to not pressed
4243 mPrivateFlags &= ~PRESSED;
4244 refreshDrawableState();
4245 }
4246 } else {
4247 // Inside button
4248 if ((mPrivateFlags & PRESSED) == 0) {
4249 // Need to switch from not pressed to pressed
4250 mPrivateFlags |= PRESSED;
4251 refreshDrawableState();
4252 }
4253 }
4254 break;
4255 }
4256 return true;
4257 }
4258
4259 return false;
4260 }
4261
4262 /**
4263 * Cancels a pending long press. Your subclass can use this if you
4264 * want the context menu to come up if the user presses and holds
4265 * at the same place, but you don't want it to come up if they press
4266 * and then move around enough to cause scrolling.
4267 */
4268 public void cancelLongPress() {
4269 if (mPendingCheckForLongPress != null) {
4270 removeCallbacks(mPendingCheckForLongPress);
4271 }
4272 }
4273
4274 /**
4275 * Sets the TouchDelegate for this View.
4276 */
4277 public void setTouchDelegate(TouchDelegate delegate) {
4278 mTouchDelegate = delegate;
4279 }
4280
4281 /**
4282 * Gets the TouchDelegate for this View.
4283 */
4284 public TouchDelegate getTouchDelegate() {
4285 return mTouchDelegate;
4286 }
4287
4288 /**
4289 * Set flags controlling behavior of this view.
4290 *
4291 * @param flags Constant indicating the value which should be set
4292 * @param mask Constant indicating the bit range that should be changed
4293 */
4294 void setFlags(int flags, int mask) {
4295 int old = mViewFlags;
4296 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
4297
4298 int changed = mViewFlags ^ old;
4299 if (changed == 0) {
4300 return;
4301 }
4302 int privateFlags = mPrivateFlags;
4303
4304 /* Check if the FOCUSABLE bit has changed */
4305 if (((changed & FOCUSABLE_MASK) != 0) &&
4306 ((privateFlags & HAS_BOUNDS) !=0)) {
4307 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
4308 && ((privateFlags & FOCUSED) != 0)) {
4309 /* Give up focus if we are no longer focusable */
4310 clearFocus();
4311 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
4312 && ((privateFlags & FOCUSED) == 0)) {
4313 /*
4314 * Tell the view system that we are now available to take focus
4315 * if no one else already has it.
4316 */
4317 if (mParent != null) mParent.focusableViewAvailable(this);
4318 }
4319 }
4320
4321 if ((flags & VISIBILITY_MASK) == VISIBLE) {
4322 if ((changed & VISIBILITY_MASK) != 0) {
4323 /*
4324 * If this view is becoming visible, set the DRAWN flag so that
4325 * the next invalidate() will not be skipped.
4326 */
4327 mPrivateFlags |= DRAWN;
4328
4329 needGlobalAttributesUpdate(true);
4330
4331 // a view becoming visible is worth notifying the parent
4332 // about in case nothing has focus. even if this specific view
4333 // isn't focusable, it may contain something that is, so let
4334 // the root view try to give this focus if nothing else does.
4335 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
4336 mParent.focusableViewAvailable(this);
4337 }
4338 }
4339 }
4340
4341 /* Check if the GONE bit has changed */
4342 if ((changed & GONE) != 0) {
4343 needGlobalAttributesUpdate(false);
4344 requestLayout();
4345 invalidate();
4346
Romain Guyecd80ee2009-12-03 17:13:02 -08004347 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
4348 if (hasFocus()) clearFocus();
4349 destroyDrawingCache();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004350 }
4351 if (mAttachInfo != null) {
4352 mAttachInfo.mViewVisibilityChanged = true;
4353 }
4354 }
4355
4356 /* Check if the VISIBLE bit has changed */
4357 if ((changed & INVISIBLE) != 0) {
4358 needGlobalAttributesUpdate(false);
4359 invalidate();
4360
4361 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
4362 // root view becoming invisible shouldn't clear focus
4363 if (getRootView() != this) {
4364 clearFocus();
4365 }
4366 }
4367 if (mAttachInfo != null) {
4368 mAttachInfo.mViewVisibilityChanged = true;
4369 }
4370 }
4371
Adam Powell326d8082009-12-09 15:10:07 -08004372 if ((changed & VISIBILITY_MASK) != 0) {
4373 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
4374 }
4375
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004376 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
4377 destroyDrawingCache();
4378 }
4379
4380 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
4381 destroyDrawingCache();
4382 mPrivateFlags &= ~DRAWING_CACHE_VALID;
4383 }
4384
4385 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
4386 destroyDrawingCache();
4387 mPrivateFlags &= ~DRAWING_CACHE_VALID;
4388 }
4389
4390 if ((changed & DRAW_MASK) != 0) {
4391 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
4392 if (mBGDrawable != null) {
4393 mPrivateFlags &= ~SKIP_DRAW;
4394 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
4395 } else {
4396 mPrivateFlags |= SKIP_DRAW;
4397 }
4398 } else {
4399 mPrivateFlags &= ~SKIP_DRAW;
4400 }
4401 requestLayout();
4402 invalidate();
4403 }
4404
4405 if ((changed & KEEP_SCREEN_ON) != 0) {
4406 if (mParent != null) {
4407 mParent.recomputeViewAttributes(this);
4408 }
4409 }
4410 }
4411
4412 /**
4413 * Change the view's z order in the tree, so it's on top of other sibling
4414 * views
4415 */
4416 public void bringToFront() {
4417 if (mParent != null) {
4418 mParent.bringChildToFront(this);
4419 }
4420 }
4421
4422 /**
4423 * This is called in response to an internal scroll in this view (i.e., the
4424 * view scrolled its own contents). This is typically as a result of
4425 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
4426 * called.
4427 *
4428 * @param l Current horizontal scroll origin.
4429 * @param t Current vertical scroll origin.
4430 * @param oldl Previous horizontal scroll origin.
4431 * @param oldt Previous vertical scroll origin.
4432 */
4433 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
4434 mBackgroundSizeChanged = true;
4435
4436 final AttachInfo ai = mAttachInfo;
4437 if (ai != null) {
4438 ai.mViewScrollChanged = true;
4439 }
4440 }
4441
4442 /**
4443 * This is called during layout when the size of this view has changed. If
4444 * you were just added to the view hierarchy, you're called with the old
4445 * values of 0.
4446 *
4447 * @param w Current width of this view.
4448 * @param h Current height of this view.
4449 * @param oldw Old width of this view.
4450 * @param oldh Old height of this view.
4451 */
4452 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
4453 }
4454
4455 /**
4456 * Called by draw to draw the child views. This may be overridden
4457 * by derived classes to gain control just before its children are drawn
4458 * (but after its own view has been drawn).
4459 * @param canvas the canvas on which to draw the view
4460 */
4461 protected void dispatchDraw(Canvas canvas) {
4462 }
4463
4464 /**
4465 * Gets the parent of this view. Note that the parent is a
4466 * ViewParent and not necessarily a View.
4467 *
4468 * @return Parent of this view.
4469 */
4470 public final ViewParent getParent() {
4471 return mParent;
4472 }
4473
4474 /**
4475 * Return the scrolled left position of this view. This is the left edge of
4476 * the displayed part of your view. You do not need to draw any pixels
4477 * farther left, since those are outside of the frame of your view on
4478 * screen.
4479 *
4480 * @return The left edge of the displayed part of your view, in pixels.
4481 */
4482 public final int getScrollX() {
4483 return mScrollX;
4484 }
4485
4486 /**
4487 * Return the scrolled top position of this view. This is the top edge of
4488 * the displayed part of your view. You do not need to draw any pixels above
4489 * it, since those are outside of the frame of your view on screen.
4490 *
4491 * @return The top edge of the displayed part of your view, in pixels.
4492 */
4493 public final int getScrollY() {
4494 return mScrollY;
4495 }
4496
4497 /**
4498 * Return the width of the your view.
4499 *
4500 * @return The width of your view, in pixels.
4501 */
4502 @ViewDebug.ExportedProperty
4503 public final int getWidth() {
4504 return mRight - mLeft;
4505 }
4506
4507 /**
4508 * Return the height of your view.
4509 *
4510 * @return The height of your view, in pixels.
4511 */
4512 @ViewDebug.ExportedProperty
4513 public final int getHeight() {
4514 return mBottom - mTop;
4515 }
4516
4517 /**
4518 * Return the visible drawing bounds of your view. Fills in the output
4519 * rectangle with the values from getScrollX(), getScrollY(),
4520 * getWidth(), and getHeight().
4521 *
4522 * @param outRect The (scrolled) drawing bounds of the view.
4523 */
4524 public void getDrawingRect(Rect outRect) {
4525 outRect.left = mScrollX;
4526 outRect.top = mScrollY;
4527 outRect.right = mScrollX + (mRight - mLeft);
4528 outRect.bottom = mScrollY + (mBottom - mTop);
4529 }
4530
4531 /**
4532 * The width of this view as measured in the most recent call to measure().
4533 * This should be used during measurement and layout calculations only. Use
4534 * {@link #getWidth()} to see how wide a view is after layout.
4535 *
4536 * @return The measured width of this view.
4537 */
4538 public final int getMeasuredWidth() {
4539 return mMeasuredWidth;
4540 }
4541
4542 /**
4543 * The height of this view as measured in the most recent call to measure().
4544 * This should be used during measurement and layout calculations only. Use
4545 * {@link #getHeight()} to see how tall a view is after layout.
4546 *
4547 * @return The measured height of this view.
4548 */
4549 public final int getMeasuredHeight() {
4550 return mMeasuredHeight;
4551 }
4552
4553 /**
4554 * Top position of this view relative to its parent.
4555 *
4556 * @return The top of this view, in pixels.
4557 */
4558 @ViewDebug.CapturedViewProperty
4559 public final int getTop() {
4560 return mTop;
4561 }
4562
4563 /**
4564 * Bottom position of this view relative to its parent.
4565 *
4566 * @return The bottom of this view, in pixels.
4567 */
4568 @ViewDebug.CapturedViewProperty
4569 public final int getBottom() {
4570 return mBottom;
4571 }
4572
4573 /**
4574 * Left position of this view relative to its parent.
4575 *
4576 * @return The left edge of this view, in pixels.
4577 */
4578 @ViewDebug.CapturedViewProperty
4579 public final int getLeft() {
4580 return mLeft;
4581 }
4582
4583 /**
4584 * Right position of this view relative to its parent.
4585 *
4586 * @return The right edge of this view, in pixels.
4587 */
4588 @ViewDebug.CapturedViewProperty
4589 public final int getRight() {
4590 return mRight;
4591 }
4592
4593 /**
4594 * Hit rectangle in parent's coordinates
4595 *
4596 * @param outRect The hit rectangle of the view.
4597 */
4598 public void getHitRect(Rect outRect) {
4599 outRect.set(mLeft, mTop, mRight, mBottom);
4600 }
4601
4602 /**
4603 * When a view has focus and the user navigates away from it, the next view is searched for
4604 * starting from the rectangle filled in by this method.
4605 *
4606 * By default, the rectange is the {@link #getDrawingRect})of the view. However, if your
4607 * view maintains some idea of internal selection, such as a cursor, or a selected row
4608 * or column, you should override this method and fill in a more specific rectangle.
4609 *
4610 * @param r The rectangle to fill in, in this view's coordinates.
4611 */
4612 public void getFocusedRect(Rect r) {
4613 getDrawingRect(r);
4614 }
4615
4616 /**
4617 * If some part of this view is not clipped by any of its parents, then
4618 * return that area in r in global (root) coordinates. To convert r to local
4619 * coordinates, offset it by -globalOffset (e.g. r.offset(-globalOffset.x,
4620 * -globalOffset.y)) If the view is completely clipped or translated out,
4621 * return false.
4622 *
4623 * @param r If true is returned, r holds the global coordinates of the
4624 * visible portion of this view.
4625 * @param globalOffset If true is returned, globalOffset holds the dx,dy
4626 * between this view and its root. globalOffet may be null.
4627 * @return true if r is non-empty (i.e. part of the view is visible at the
4628 * root level.
4629 */
4630 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
4631 int width = mRight - mLeft;
4632 int height = mBottom - mTop;
4633 if (width > 0 && height > 0) {
4634 r.set(0, 0, width, height);
4635 if (globalOffset != null) {
4636 globalOffset.set(-mScrollX, -mScrollY);
4637 }
4638 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
4639 }
4640 return false;
4641 }
4642
4643 public final boolean getGlobalVisibleRect(Rect r) {
4644 return getGlobalVisibleRect(r, null);
4645 }
4646
4647 public final boolean getLocalVisibleRect(Rect r) {
4648 Point offset = new Point();
4649 if (getGlobalVisibleRect(r, offset)) {
4650 r.offset(-offset.x, -offset.y); // make r local
4651 return true;
4652 }
4653 return false;
4654 }
4655
4656 /**
4657 * Offset this view's vertical location by the specified number of pixels.
4658 *
4659 * @param offset the number of pixels to offset the view by
4660 */
4661 public void offsetTopAndBottom(int offset) {
4662 mTop += offset;
4663 mBottom += offset;
4664 }
4665
4666 /**
4667 * Offset this view's horizontal location by the specified amount of pixels.
4668 *
4669 * @param offset the numer of pixels to offset the view by
4670 */
4671 public void offsetLeftAndRight(int offset) {
4672 mLeft += offset;
4673 mRight += offset;
4674 }
4675
4676 /**
4677 * Get the LayoutParams associated with this view. All views should have
4678 * layout parameters. These supply parameters to the <i>parent</i> of this
4679 * view specifying how it should be arranged. There are many subclasses of
4680 * ViewGroup.LayoutParams, and these correspond to the different subclasses
4681 * of ViewGroup that are responsible for arranging their children.
4682 * @return The LayoutParams associated with this view
4683 */
4684 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
4685 public ViewGroup.LayoutParams getLayoutParams() {
4686 return mLayoutParams;
4687 }
4688
4689 /**
4690 * Set the layout parameters associated with this view. These supply
4691 * parameters to the <i>parent</i> of this view specifying how it should be
4692 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
4693 * correspond to the different subclasses of ViewGroup that are responsible
4694 * for arranging their children.
4695 *
4696 * @param params the layout parameters for this view
4697 */
4698 public void setLayoutParams(ViewGroup.LayoutParams params) {
4699 if (params == null) {
4700 throw new NullPointerException("params == null");
4701 }
4702 mLayoutParams = params;
4703 requestLayout();
4704 }
4705
4706 /**
4707 * Set the scrolled position of your view. This will cause a call to
4708 * {@link #onScrollChanged(int, int, int, int)} and the view will be
4709 * invalidated.
4710 * @param x the x position to scroll to
4711 * @param y the y position to scroll to
4712 */
4713 public void scrollTo(int x, int y) {
4714 if (mScrollX != x || mScrollY != y) {
4715 int oldX = mScrollX;
4716 int oldY = mScrollY;
4717 mScrollX = x;
4718 mScrollY = y;
4719 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07004720 if (!awakenScrollBars()) {
4721 invalidate();
4722 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004723 }
4724 }
4725
4726 /**
4727 * Move the scrolled position of your view. This will cause a call to
4728 * {@link #onScrollChanged(int, int, int, int)} and the view will be
4729 * invalidated.
4730 * @param x the amount of pixels to scroll by horizontally
4731 * @param y the amount of pixels to scroll by vertically
4732 */
4733 public void scrollBy(int x, int y) {
4734 scrollTo(mScrollX + x, mScrollY + y);
4735 }
4736
4737 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07004738 * <p>Trigger the scrollbars to draw. When invoked this method starts an
4739 * animation to fade the scrollbars out after a default delay. If a subclass
4740 * provides animated scrolling, the start delay should equal the duration
4741 * of the scrolling animation.</p>
4742 *
4743 * <p>The animation starts only if at least one of the scrollbars is
4744 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
4745 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
4746 * this method returns true, and false otherwise. If the animation is
4747 * started, this method calls {@link #invalidate()}; in that case the
4748 * caller should not call {@link #invalidate()}.</p>
4749 *
4750 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07004751 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07004752 *
4753 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
4754 * and {@link #scrollTo(int, int)}.</p>
4755 *
4756 * @return true if the animation is played, false otherwise
4757 *
4758 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07004759 * @see #scrollBy(int, int)
4760 * @see #scrollTo(int, int)
4761 * @see #isHorizontalScrollBarEnabled()
4762 * @see #isVerticalScrollBarEnabled()
4763 * @see #setHorizontalScrollBarEnabled(boolean)
4764 * @see #setVerticalScrollBarEnabled(boolean)
4765 */
4766 protected boolean awakenScrollBars() {
4767 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07004768 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07004769 }
4770
4771 /**
4772 * <p>
4773 * Trigger the scrollbars to draw. When invoked this method starts an
4774 * animation to fade the scrollbars out after a fixed delay. If a subclass
4775 * provides animated scrolling, the start delay should equal the duration of
4776 * the scrolling animation.
4777 * </p>
4778 *
4779 * <p>
4780 * The animation starts only if at least one of the scrollbars is enabled,
4781 * as specified by {@link #isHorizontalScrollBarEnabled()} and
4782 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
4783 * this method returns true, and false otherwise. If the animation is
4784 * started, this method calls {@link #invalidate()}; in that case the caller
4785 * should not call {@link #invalidate()}.
4786 * </p>
4787 *
4788 * <p>
4789 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07004790 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07004791 * </p>
4792 *
4793 * @param startDelay the delay, in milliseconds, after which the animation
4794 * should start; when the delay is 0, the animation starts
4795 * immediately
4796 * @return true if the animation is played, false otherwise
4797 *
Mike Cleronf116bf82009-09-27 19:14:12 -07004798 * @see #scrollBy(int, int)
4799 * @see #scrollTo(int, int)
4800 * @see #isHorizontalScrollBarEnabled()
4801 * @see #isVerticalScrollBarEnabled()
4802 * @see #setHorizontalScrollBarEnabled(boolean)
4803 * @see #setVerticalScrollBarEnabled(boolean)
4804 */
4805 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07004806 return awakenScrollBars(startDelay, true);
4807 }
4808
4809 /**
4810 * <p>
4811 * Trigger the scrollbars to draw. When invoked this method starts an
4812 * animation to fade the scrollbars out after a fixed delay. If a subclass
4813 * provides animated scrolling, the start delay should equal the duration of
4814 * the scrolling animation.
4815 * </p>
4816 *
4817 * <p>
4818 * The animation starts only if at least one of the scrollbars is enabled,
4819 * as specified by {@link #isHorizontalScrollBarEnabled()} and
4820 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
4821 * this method returns true, and false otherwise. If the animation is
4822 * started, this method calls {@link #invalidate()} if the invalidate parameter
4823 * is set to true; in that case the caller
4824 * should not call {@link #invalidate()}.
4825 * </p>
4826 *
4827 * <p>
4828 * This method should be invoked everytime a subclass directly updates the
4829 * scroll parameters.
4830 * </p>
4831 *
4832 * @param startDelay the delay, in milliseconds, after which the animation
4833 * should start; when the delay is 0, the animation starts
4834 * immediately
4835 *
4836 * @param invalidate Wheter this method should call invalidate
4837 *
4838 * @return true if the animation is played, false otherwise
4839 *
4840 * @see #scrollBy(int, int)
4841 * @see #scrollTo(int, int)
4842 * @see #isHorizontalScrollBarEnabled()
4843 * @see #isVerticalScrollBarEnabled()
4844 * @see #setHorizontalScrollBarEnabled(boolean)
4845 * @see #setVerticalScrollBarEnabled(boolean)
4846 */
4847 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07004848 final ScrollabilityCache scrollCache = mScrollCache;
4849
4850 if (scrollCache == null || !scrollCache.fadeScrollBars) {
4851 return false;
4852 }
4853
4854 if (scrollCache.scrollBar == null) {
4855 scrollCache.scrollBar = new ScrollBarDrawable();
4856 }
4857
4858 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
4859
Mike Cleron290947b2009-09-29 18:34:32 -07004860 if (invalidate) {
4861 // Invalidate to show the scrollbars
4862 invalidate();
4863 }
Mike Cleronf116bf82009-09-27 19:14:12 -07004864
4865 if (scrollCache.state == ScrollabilityCache.OFF) {
4866 // FIXME: this is copied from WindowManagerService.
4867 // We should get this value from the system when it
4868 // is possible to do so.
4869 final int KEY_REPEAT_FIRST_DELAY = 750;
4870 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
4871 }
4872
4873 // Tell mScrollCache when we should start fading. This may
4874 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07004875 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07004876 scrollCache.fadeStartTime = fadeStartTime;
4877 scrollCache.state = ScrollabilityCache.ON;
4878
4879 // Schedule our fader to run, unscheduling any old ones first
4880 if (mAttachInfo != null) {
4881 mAttachInfo.mHandler.removeCallbacks(scrollCache);
4882 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
4883 }
4884
4885 return true;
4886 }
4887
4888 return false;
4889 }
4890
4891 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004892 * Mark the the area defined by dirty as needing to be drawn. If the view is
4893 * visible, {@link #onDraw} will be called at some point in the future.
4894 * This must be called from a UI thread. To call from a non-UI thread, call
4895 * {@link #postInvalidate()}.
4896 *
4897 * WARNING: This method is destructive to dirty.
4898 * @param dirty the rectangle representing the bounds of the dirty region
4899 */
4900 public void invalidate(Rect dirty) {
4901 if (ViewDebug.TRACE_HIERARCHY) {
4902 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
4903 }
4904
4905 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS)) {
4906 mPrivateFlags &= ~DRAWING_CACHE_VALID;
4907 final ViewParent p = mParent;
4908 final AttachInfo ai = mAttachInfo;
4909 if (p != null && ai != null) {
4910 final int scrollX = mScrollX;
4911 final int scrollY = mScrollY;
4912 final Rect r = ai.mTmpInvalRect;
4913 r.set(dirty.left - scrollX, dirty.top - scrollY,
4914 dirty.right - scrollX, dirty.bottom - scrollY);
4915 mParent.invalidateChild(this, r);
4916 }
4917 }
4918 }
4919
4920 /**
4921 * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
4922 * The coordinates of the dirty rect are relative to the view.
4923 * If the view is visible, {@link #onDraw} will be called at some point
4924 * in the future. This must be called from a UI thread. To call
4925 * from a non-UI thread, call {@link #postInvalidate()}.
4926 * @param l the left position of the dirty region
4927 * @param t the top position of the dirty region
4928 * @param r the right position of the dirty region
4929 * @param b the bottom position of the dirty region
4930 */
4931 public void invalidate(int l, int t, int r, int b) {
4932 if (ViewDebug.TRACE_HIERARCHY) {
4933 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
4934 }
4935
4936 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS)) {
4937 mPrivateFlags &= ~DRAWING_CACHE_VALID;
4938 final ViewParent p = mParent;
4939 final AttachInfo ai = mAttachInfo;
4940 if (p != null && ai != null && l < r && t < b) {
4941 final int scrollX = mScrollX;
4942 final int scrollY = mScrollY;
4943 final Rect tmpr = ai.mTmpInvalRect;
4944 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
4945 p.invalidateChild(this, tmpr);
4946 }
4947 }
4948 }
4949
4950 /**
4951 * Invalidate the whole view. If the view is visible, {@link #onDraw} will
4952 * be called at some point in the future. This must be called from a
4953 * UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
4954 */
4955 public void invalidate() {
4956 if (ViewDebug.TRACE_HIERARCHY) {
4957 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
4958 }
4959
4960 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS)) {
4961 mPrivateFlags &= ~DRAWN & ~DRAWING_CACHE_VALID;
4962 final ViewParent p = mParent;
4963 final AttachInfo ai = mAttachInfo;
4964 if (p != null && ai != null) {
4965 final Rect r = ai.mTmpInvalRect;
4966 r.set(0, 0, mRight - mLeft, mBottom - mTop);
4967 // Don't call invalidate -- we don't want to internally scroll
4968 // our own bounds
4969 p.invalidateChild(this, r);
4970 }
4971 }
4972 }
4973
4974 /**
Romain Guy24443ea2009-05-11 11:56:30 -07004975 * Indicates whether this View is opaque. An opaque View guarantees that it will
4976 * draw all the pixels overlapping its bounds using a fully opaque color.
4977 *
4978 * Subclasses of View should override this method whenever possible to indicate
4979 * whether an instance is opaque. Opaque Views are treated in a special way by
4980 * the View hierarchy, possibly allowing it to perform optimizations during
4981 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -07004982 *
Romain Guy24443ea2009-05-11 11:56:30 -07004983 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -07004984 */
Romain Guy83b21072009-05-12 10:54:51 -07004985 @ViewDebug.ExportedProperty
Romain Guy24443ea2009-05-11 11:56:30 -07004986 public boolean isOpaque() {
Romain Guy8f1344f52009-05-15 16:03:59 -07004987 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK;
4988 }
4989
4990 private void computeOpaqueFlags() {
4991 // Opaque if:
4992 // - Has a background
4993 // - Background is opaque
4994 // - Doesn't have scrollbars or scrollbars are inside overlay
4995
4996 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) {
4997 mPrivateFlags |= OPAQUE_BACKGROUND;
4998 } else {
4999 mPrivateFlags &= ~OPAQUE_BACKGROUND;
5000 }
5001
5002 final int flags = mViewFlags;
5003 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
5004 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
5005 mPrivateFlags |= OPAQUE_SCROLLBARS;
5006 } else {
5007 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
5008 }
5009 }
5010
5011 /**
5012 * @hide
5013 */
5014 protected boolean hasOpaqueScrollbars() {
5015 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -07005016 }
5017
5018 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005019 * @return A handler associated with the thread running the View. This
5020 * handler can be used to pump events in the UI events queue.
5021 */
5022 public Handler getHandler() {
5023 if (mAttachInfo != null) {
5024 return mAttachInfo.mHandler;
5025 }
5026 return null;
5027 }
5028
5029 /**
5030 * Causes the Runnable to be added to the message queue.
5031 * The runnable will be run on the user interface thread.
5032 *
5033 * @param action The Runnable that will be executed.
5034 *
5035 * @return Returns true if the Runnable was successfully placed in to the
5036 * message queue. Returns false on failure, usually because the
5037 * looper processing the message queue is exiting.
5038 */
5039 public boolean post(Runnable action) {
5040 Handler handler;
5041 if (mAttachInfo != null) {
5042 handler = mAttachInfo.mHandler;
5043 } else {
5044 // Assume that post will succeed later
5045 ViewRoot.getRunQueue().post(action);
5046 return true;
5047 }
5048
5049 return handler.post(action);
5050 }
5051
5052 /**
5053 * Causes the Runnable to be added to the message queue, to be run
5054 * after the specified amount of time elapses.
5055 * The runnable will be run on the user interface thread.
5056 *
5057 * @param action The Runnable that will be executed.
5058 * @param delayMillis The delay (in milliseconds) until the Runnable
5059 * will be executed.
5060 *
5061 * @return true if the Runnable was successfully placed in to the
5062 * message queue. Returns false on failure, usually because the
5063 * looper processing the message queue is exiting. Note that a
5064 * result of true does not mean the Runnable will be processed --
5065 * if the looper is quit before the delivery time of the message
5066 * occurs then the message will be dropped.
5067 */
5068 public boolean postDelayed(Runnable action, long delayMillis) {
5069 Handler handler;
5070 if (mAttachInfo != null) {
5071 handler = mAttachInfo.mHandler;
5072 } else {
5073 // Assume that post will succeed later
5074 ViewRoot.getRunQueue().postDelayed(action, delayMillis);
5075 return true;
5076 }
5077
5078 return handler.postDelayed(action, delayMillis);
5079 }
5080
5081 /**
5082 * Removes the specified Runnable from the message queue.
5083 *
5084 * @param action The Runnable to remove from the message handling queue
5085 *
5086 * @return true if this view could ask the Handler to remove the Runnable,
5087 * false otherwise. When the returned value is true, the Runnable
5088 * may or may not have been actually removed from the message queue
5089 * (for instance, if the Runnable was not in the queue already.)
5090 */
5091 public boolean removeCallbacks(Runnable action) {
5092 Handler handler;
5093 if (mAttachInfo != null) {
5094 handler = mAttachInfo.mHandler;
5095 } else {
5096 // Assume that post will succeed later
5097 ViewRoot.getRunQueue().removeCallbacks(action);
5098 return true;
5099 }
5100
5101 handler.removeCallbacks(action);
5102 return true;
5103 }
5104
5105 /**
5106 * Cause an invalidate to happen on a subsequent cycle through the event loop.
5107 * Use this to invalidate the View from a non-UI thread.
5108 *
5109 * @see #invalidate()
5110 */
5111 public void postInvalidate() {
5112 postInvalidateDelayed(0);
5113 }
5114
5115 /**
5116 * Cause an invalidate of the specified area to happen on a subsequent cycle
5117 * through the event loop. Use this to invalidate the View from a non-UI thread.
5118 *
5119 * @param left The left coordinate of the rectangle to invalidate.
5120 * @param top The top coordinate of the rectangle to invalidate.
5121 * @param right The right coordinate of the rectangle to invalidate.
5122 * @param bottom The bottom coordinate of the rectangle to invalidate.
5123 *
5124 * @see #invalidate(int, int, int, int)
5125 * @see #invalidate(Rect)
5126 */
5127 public void postInvalidate(int left, int top, int right, int bottom) {
5128 postInvalidateDelayed(0, left, top, right, bottom);
5129 }
5130
5131 /**
5132 * Cause an invalidate to happen on a subsequent cycle through the event
5133 * loop. Waits for the specified amount of time.
5134 *
5135 * @param delayMilliseconds the duration in milliseconds to delay the
5136 * invalidation by
5137 */
5138 public void postInvalidateDelayed(long delayMilliseconds) {
5139 // We try only with the AttachInfo because there's no point in invalidating
5140 // if we are not attached to our window
5141 if (mAttachInfo != null) {
5142 Message msg = Message.obtain();
5143 msg.what = AttachInfo.INVALIDATE_MSG;
5144 msg.obj = this;
5145 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
5146 }
5147 }
5148
5149 /**
5150 * Cause an invalidate of the specified area to happen on a subsequent cycle
5151 * through the event loop. Waits for the specified amount of time.
5152 *
5153 * @param delayMilliseconds the duration in milliseconds to delay the
5154 * invalidation by
5155 * @param left The left coordinate of the rectangle to invalidate.
5156 * @param top The top coordinate of the rectangle to invalidate.
5157 * @param right The right coordinate of the rectangle to invalidate.
5158 * @param bottom The bottom coordinate of the rectangle to invalidate.
5159 */
5160 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
5161 int right, int bottom) {
5162
5163 // We try only with the AttachInfo because there's no point in invalidating
5164 // if we are not attached to our window
5165 if (mAttachInfo != null) {
5166 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
5167 info.target = this;
5168 info.left = left;
5169 info.top = top;
5170 info.right = right;
5171 info.bottom = bottom;
5172
5173 final Message msg = Message.obtain();
5174 msg.what = AttachInfo.INVALIDATE_RECT_MSG;
5175 msg.obj = info;
5176 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
5177 }
5178 }
5179
5180 /**
5181 * Called by a parent to request that a child update its values for mScrollX
5182 * and mScrollY if necessary. This will typically be done if the child is
5183 * animating a scroll using a {@link android.widget.Scroller Scroller}
5184 * object.
5185 */
5186 public void computeScroll() {
5187 }
5188
5189 /**
5190 * <p>Indicate whether the horizontal edges are faded when the view is
5191 * scrolled horizontally.</p>
5192 *
5193 * @return true if the horizontal edges should are faded on scroll, false
5194 * otherwise
5195 *
5196 * @see #setHorizontalFadingEdgeEnabled(boolean)
5197 * @attr ref android.R.styleable#View_fadingEdge
5198 */
5199 public boolean isHorizontalFadingEdgeEnabled() {
5200 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
5201 }
5202
5203 /**
5204 * <p>Define whether the horizontal edges should be faded when this view
5205 * is scrolled horizontally.</p>
5206 *
5207 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
5208 * be faded when the view is scrolled
5209 * horizontally
5210 *
5211 * @see #isHorizontalFadingEdgeEnabled()
5212 * @attr ref android.R.styleable#View_fadingEdge
5213 */
5214 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
5215 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
5216 if (horizontalFadingEdgeEnabled) {
5217 initScrollCache();
5218 }
5219
5220 mViewFlags ^= FADING_EDGE_HORIZONTAL;
5221 }
5222 }
5223
5224 /**
5225 * <p>Indicate whether the vertical edges are faded when the view is
5226 * scrolled horizontally.</p>
5227 *
5228 * @return true if the vertical edges should are faded on scroll, false
5229 * otherwise
5230 *
5231 * @see #setVerticalFadingEdgeEnabled(boolean)
5232 * @attr ref android.R.styleable#View_fadingEdge
5233 */
5234 public boolean isVerticalFadingEdgeEnabled() {
5235 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
5236 }
5237
5238 /**
5239 * <p>Define whether the vertical edges should be faded when this view
5240 * is scrolled vertically.</p>
5241 *
5242 * @param verticalFadingEdgeEnabled true if the vertical edges should
5243 * be faded when the view is scrolled
5244 * vertically
5245 *
5246 * @see #isVerticalFadingEdgeEnabled()
5247 * @attr ref android.R.styleable#View_fadingEdge
5248 */
5249 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
5250 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
5251 if (verticalFadingEdgeEnabled) {
5252 initScrollCache();
5253 }
5254
5255 mViewFlags ^= FADING_EDGE_VERTICAL;
5256 }
5257 }
5258
5259 /**
5260 * Returns the strength, or intensity, of the top faded edge. The strength is
5261 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
5262 * returns 0.0 or 1.0 but no value in between.
5263 *
5264 * Subclasses should override this method to provide a smoother fade transition
5265 * when scrolling occurs.
5266 *
5267 * @return the intensity of the top fade as a float between 0.0f and 1.0f
5268 */
5269 protected float getTopFadingEdgeStrength() {
5270 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
5271 }
5272
5273 /**
5274 * Returns the strength, or intensity, of the bottom faded edge. The strength is
5275 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
5276 * returns 0.0 or 1.0 but no value in between.
5277 *
5278 * Subclasses should override this method to provide a smoother fade transition
5279 * when scrolling occurs.
5280 *
5281 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
5282 */
5283 protected float getBottomFadingEdgeStrength() {
5284 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
5285 computeVerticalScrollRange() ? 1.0f : 0.0f;
5286 }
5287
5288 /**
5289 * Returns the strength, or intensity, of the left faded edge. The strength is
5290 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
5291 * returns 0.0 or 1.0 but no value in between.
5292 *
5293 * Subclasses should override this method to provide a smoother fade transition
5294 * when scrolling occurs.
5295 *
5296 * @return the intensity of the left fade as a float between 0.0f and 1.0f
5297 */
5298 protected float getLeftFadingEdgeStrength() {
5299 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
5300 }
5301
5302 /**
5303 * Returns the strength, or intensity, of the right faded edge. The strength is
5304 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
5305 * returns 0.0 or 1.0 but no value in between.
5306 *
5307 * Subclasses should override this method to provide a smoother fade transition
5308 * when scrolling occurs.
5309 *
5310 * @return the intensity of the right fade as a float between 0.0f and 1.0f
5311 */
5312 protected float getRightFadingEdgeStrength() {
5313 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
5314 computeHorizontalScrollRange() ? 1.0f : 0.0f;
5315 }
5316
5317 /**
5318 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
5319 * scrollbar is not drawn by default.</p>
5320 *
5321 * @return true if the horizontal scrollbar should be painted, false
5322 * otherwise
5323 *
5324 * @see #setHorizontalScrollBarEnabled(boolean)
5325 */
5326 public boolean isHorizontalScrollBarEnabled() {
5327 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
5328 }
5329
5330 /**
5331 * <p>Define whether the horizontal scrollbar should be drawn or not. The
5332 * scrollbar is not drawn by default.</p>
5333 *
5334 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
5335 * be painted
5336 *
5337 * @see #isHorizontalScrollBarEnabled()
5338 */
5339 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
5340 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
5341 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07005342 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005343 recomputePadding();
5344 }
5345 }
5346
5347 /**
5348 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
5349 * scrollbar is not drawn by default.</p>
5350 *
5351 * @return true if the vertical scrollbar should be painted, false
5352 * otherwise
5353 *
5354 * @see #setVerticalScrollBarEnabled(boolean)
5355 */
5356 public boolean isVerticalScrollBarEnabled() {
5357 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
5358 }
5359
5360 /**
5361 * <p>Define whether the vertical scrollbar should be drawn or not. The
5362 * scrollbar is not drawn by default.</p>
5363 *
5364 * @param verticalScrollBarEnabled true if the vertical scrollbar should
5365 * be painted
5366 *
5367 * @see #isVerticalScrollBarEnabled()
5368 */
5369 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
5370 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
5371 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07005372 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005373 recomputePadding();
5374 }
5375 }
5376
5377 private void recomputePadding() {
5378 setPadding(mPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
5379 }
Mike Cleronfe81d382009-09-28 14:22:16 -07005380
5381 /**
5382 * Define whether scrollbars will fade when the view is not scrolling.
5383 *
5384 * @param fadeScrollbars wheter to enable fading
5385 *
5386 */
5387 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
5388 initScrollCache();
5389 final ScrollabilityCache scrollabilityCache = mScrollCache;
5390 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -07005391 if (fadeScrollbars) {
5392 scrollabilityCache.state = ScrollabilityCache.OFF;
5393 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -07005394 scrollabilityCache.state = ScrollabilityCache.ON;
5395 }
5396 }
5397
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005398 /**
Mike Cleron52f0a642009-09-28 18:21:37 -07005399 *
5400 * Returns true if scrollbars will fade when this view is not scrolling
5401 *
5402 * @return true if scrollbar fading is enabled
5403 */
5404 public boolean isScrollbarFadingEnabled() {
5405 return mScrollCache != null && mScrollCache.fadeScrollBars;
5406 }
5407
5408 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005409 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
5410 * inset. When inset, they add to the padding of the view. And the scrollbars
5411 * can be drawn inside the padding area or on the edge of the view. For example,
5412 * if a view has a background drawable and you want to draw the scrollbars
5413 * inside the padding specified by the drawable, you can use
5414 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
5415 * appear at the edge of the view, ignoring the padding, then you can use
5416 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
5417 * @param style the style of the scrollbars. Should be one of
5418 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
5419 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
5420 * @see #SCROLLBARS_INSIDE_OVERLAY
5421 * @see #SCROLLBARS_INSIDE_INSET
5422 * @see #SCROLLBARS_OUTSIDE_OVERLAY
5423 * @see #SCROLLBARS_OUTSIDE_INSET
5424 */
5425 public void setScrollBarStyle(int style) {
5426 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
5427 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -07005428 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005429 recomputePadding();
5430 }
5431 }
5432
5433 /**
5434 * <p>Returns the current scrollbar style.</p>
5435 * @return the current scrollbar style
5436 * @see #SCROLLBARS_INSIDE_OVERLAY
5437 * @see #SCROLLBARS_INSIDE_INSET
5438 * @see #SCROLLBARS_OUTSIDE_OVERLAY
5439 * @see #SCROLLBARS_OUTSIDE_INSET
5440 */
5441 public int getScrollBarStyle() {
5442 return mViewFlags & SCROLLBARS_STYLE_MASK;
5443 }
5444
5445 /**
5446 * <p>Compute the horizontal range that the horizontal scrollbar
5447 * represents.</p>
5448 *
5449 * <p>The range is expressed in arbitrary units that must be the same as the
5450 * units used by {@link #computeHorizontalScrollExtent()} and
5451 * {@link #computeHorizontalScrollOffset()}.</p>
5452 *
5453 * <p>The default range is the drawing width of this view.</p>
5454 *
5455 * @return the total horizontal range represented by the horizontal
5456 * scrollbar
5457 *
5458 * @see #computeHorizontalScrollExtent()
5459 * @see #computeHorizontalScrollOffset()
5460 * @see android.widget.ScrollBarDrawable
5461 */
5462 protected int computeHorizontalScrollRange() {
5463 return getWidth();
5464 }
5465
5466 /**
5467 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
5468 * within the horizontal range. This value is used to compute the position
5469 * of the thumb within the scrollbar's track.</p>
5470 *
5471 * <p>The range is expressed in arbitrary units that must be the same as the
5472 * units used by {@link #computeHorizontalScrollRange()} and
5473 * {@link #computeHorizontalScrollExtent()}.</p>
5474 *
5475 * <p>The default offset is the scroll offset of this view.</p>
5476 *
5477 * @return the horizontal offset of the scrollbar's thumb
5478 *
5479 * @see #computeHorizontalScrollRange()
5480 * @see #computeHorizontalScrollExtent()
5481 * @see android.widget.ScrollBarDrawable
5482 */
5483 protected int computeHorizontalScrollOffset() {
5484 return mScrollX;
5485 }
5486
5487 /**
5488 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
5489 * within the horizontal range. This value is used to compute the length
5490 * of the thumb within the scrollbar's track.</p>
5491 *
5492 * <p>The range is expressed in arbitrary units that must be the same as the
5493 * units used by {@link #computeHorizontalScrollRange()} and
5494 * {@link #computeHorizontalScrollOffset()}.</p>
5495 *
5496 * <p>The default extent is the drawing width of this view.</p>
5497 *
5498 * @return the horizontal extent of the scrollbar's thumb
5499 *
5500 * @see #computeHorizontalScrollRange()
5501 * @see #computeHorizontalScrollOffset()
5502 * @see android.widget.ScrollBarDrawable
5503 */
5504 protected int computeHorizontalScrollExtent() {
5505 return getWidth();
5506 }
5507
5508 /**
5509 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
5510 *
5511 * <p>The range is expressed in arbitrary units that must be the same as the
5512 * units used by {@link #computeVerticalScrollExtent()} and
5513 * {@link #computeVerticalScrollOffset()}.</p>
5514 *
5515 * @return the total vertical range represented by the vertical scrollbar
5516 *
5517 * <p>The default range is the drawing height of this view.</p>
5518 *
5519 * @see #computeVerticalScrollExtent()
5520 * @see #computeVerticalScrollOffset()
5521 * @see android.widget.ScrollBarDrawable
5522 */
5523 protected int computeVerticalScrollRange() {
5524 return getHeight();
5525 }
5526
5527 /**
5528 * <p>Compute the vertical offset of the vertical 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 #computeVerticalScrollRange()} and
5534 * {@link #computeVerticalScrollExtent()}.</p>
5535 *
5536 * <p>The default offset is the scroll offset of this view.</p>
5537 *
5538 * @return the vertical offset of the scrollbar's thumb
5539 *
5540 * @see #computeVerticalScrollRange()
5541 * @see #computeVerticalScrollExtent()
5542 * @see android.widget.ScrollBarDrawable
5543 */
5544 protected int computeVerticalScrollOffset() {
5545 return mScrollY;
5546 }
5547
5548 /**
5549 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
5550 * within the vertical 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 #computeVerticalScrollOffset()}.</p>
5556 *
5557 * <p>The default extent is the drawing height of this view.</p>
5558 *
5559 * @return the vertical extent of the scrollbar's thumb
5560 *
5561 * @see #computeVerticalScrollRange()
5562 * @see #computeVerticalScrollOffset()
5563 * @see android.widget.ScrollBarDrawable
5564 */
5565 protected int computeVerticalScrollExtent() {
5566 return getHeight();
5567 }
5568
5569 /**
5570 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
5571 * scrollbars are painted only if they have been awakened first.</p>
5572 *
5573 * @param canvas the canvas on which to draw the scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -07005574 *
5575 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005576 */
Romain Guy1d5b3a62009-11-05 18:44:12 -08005577 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005578 // scrollbars are drawn only when the animation is running
5579 final ScrollabilityCache cache = mScrollCache;
5580 if (cache != null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07005581
5582 int state = cache.state;
5583
5584 if (state == ScrollabilityCache.OFF) {
5585 return;
5586 }
5587
5588 boolean invalidate = false;
5589
5590 if (state == ScrollabilityCache.FADING) {
5591 // We're fading -- get our fade interpolation
5592 if (cache.interpolatorValues == null) {
5593 cache.interpolatorValues = new float[1];
5594 }
5595
5596 float[] values = cache.interpolatorValues;
5597
5598 // Stops the animation if we're done
5599 if (cache.scrollBarInterpolator.timeToValues(values) ==
5600 Interpolator.Result.FREEZE_END) {
5601 cache.state = ScrollabilityCache.OFF;
5602 } else {
5603 cache.scrollBar.setAlpha(Math.round(values[0]));
5604 }
5605
5606 // This will make the scroll bars inval themselves after
5607 // drawing. We only want this when we're fading so that
5608 // we prevent excessive redraws
5609 invalidate = true;
5610 } else {
5611 // We're just on -- but we may have been fading before so
5612 // reset alpha
5613 cache.scrollBar.setAlpha(255);
5614 }
5615
5616
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005617 final int viewFlags = mViewFlags;
5618
5619 final boolean drawHorizontalScrollBar =
5620 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
5621 final boolean drawVerticalScrollBar =
5622 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
5623 && !isVerticalScrollBarHidden();
5624
5625 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
5626 final int width = mRight - mLeft;
5627 final int height = mBottom - mTop;
5628
5629 final ScrollBarDrawable scrollBar = cache.scrollBar;
5630 int size = scrollBar.getSize(false);
5631 if (size <= 0) {
5632 size = cache.scrollBarSize;
5633 }
5634
Mike Reede8853fc2009-09-04 14:01:48 -04005635 final int scrollX = mScrollX;
5636 final int scrollY = mScrollY;
5637 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
5638
Mike Cleronf116bf82009-09-27 19:14:12 -07005639 int left, top, right, bottom;
5640
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005641 if (drawHorizontalScrollBar) {
Mike Cleronf116bf82009-09-27 19:14:12 -07005642 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -04005643 computeHorizontalScrollOffset(),
5644 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -04005645 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -07005646 getVerticalScrollbarWidth() : 0;
5647 top = scrollY + height - size - (mUserPaddingBottom & inside);
5648 left = scrollX + (mPaddingLeft & inside);
5649 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
5650 bottom = top + size;
5651 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
5652 if (invalidate) {
5653 invalidate(left, top, right, bottom);
5654 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005655 }
5656
5657 if (drawVerticalScrollBar) {
Mike Reede8853fc2009-09-04 14:01:48 -04005658 scrollBar.setParameters(computeVerticalScrollRange(),
5659 computeVerticalScrollOffset(),
5660 computeVerticalScrollExtent(), true);
5661 // TODO: Deal with RTL languages to position scrollbar on left
Mike Cleronf116bf82009-09-27 19:14:12 -07005662 left = scrollX + width - size - (mUserPaddingRight & inside);
5663 top = scrollY + (mPaddingTop & inside);
5664 right = left + size;
5665 bottom = scrollY + height - (mUserPaddingBottom & inside);
5666 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
5667 if (invalidate) {
5668 invalidate(left, top, right, bottom);
5669 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005670 }
5671 }
5672 }
5673 }
Romain Guy8506ab42009-06-11 17:35:47 -07005674
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005675 /**
Romain Guy8506ab42009-06-11 17:35:47 -07005676 * Override this if the vertical scrollbar needs to be hidden in a subclass, like when
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005677 * FastScroller is visible.
5678 * @return whether to temporarily hide the vertical scrollbar
5679 * @hide
5680 */
5681 protected boolean isVerticalScrollBarHidden() {
5682 return false;
5683 }
5684
5685 /**
5686 * <p>Draw the horizontal scrollbar if
5687 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
5688 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005689 * @param canvas the canvas on which to draw the scrollbar
5690 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005691 *
5692 * @see #isHorizontalScrollBarEnabled()
5693 * @see #computeHorizontalScrollRange()
5694 * @see #computeHorizontalScrollExtent()
5695 * @see #computeHorizontalScrollOffset()
5696 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -07005697 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -04005698 */
Mike Reede8853fc2009-09-04 14:01:48 -04005699 protected void onDrawHorizontalScrollBar(Canvas canvas,
5700 Drawable scrollBar,
5701 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -04005702 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -04005703 scrollBar.draw(canvas);
5704 }
Mike Reede8853fc2009-09-04 14:01:48 -04005705
Mike Reed4d6fe5f2009-09-03 13:29:05 -04005706 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005707 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
5708 * returns true.</p>
5709 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005710 * @param canvas the canvas on which to draw the scrollbar
5711 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005712 *
5713 * @see #isVerticalScrollBarEnabled()
5714 * @see #computeVerticalScrollRange()
5715 * @see #computeVerticalScrollExtent()
5716 * @see #computeVerticalScrollOffset()
5717 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -04005718 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005719 */
Mike Reede8853fc2009-09-04 14:01:48 -04005720 protected void onDrawVerticalScrollBar(Canvas canvas,
5721 Drawable scrollBar,
5722 int l, int t, int r, int b) {
5723 scrollBar.setBounds(l, t, r, b);
5724 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005725 }
5726
5727 /**
5728 * Implement this to do your drawing.
5729 *
5730 * @param canvas the canvas on which the background will be drawn
5731 */
5732 protected void onDraw(Canvas canvas) {
5733 }
5734
5735 /*
5736 * Caller is responsible for calling requestLayout if necessary.
5737 * (This allows addViewInLayout to not request a new layout.)
5738 */
5739 void assignParent(ViewParent parent) {
5740 if (mParent == null) {
5741 mParent = parent;
5742 } else if (parent == null) {
5743 mParent = null;
5744 } else {
5745 throw new RuntimeException("view " + this + " being added, but"
5746 + " it already has a parent");
5747 }
5748 }
5749
5750 /**
5751 * This is called when the view is attached to a window. At this point it
5752 * has a Surface and will start drawing. Note that this function is
5753 * guaranteed to be called before {@link #onDraw}, however it may be called
5754 * any time before the first onDraw -- including before or after
5755 * {@link #onMeasure}.
5756 *
5757 * @see #onDetachedFromWindow()
5758 */
5759 protected void onAttachedToWindow() {
5760 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
5761 mParent.requestTransparentRegion(this);
5762 }
5763 }
5764
5765 /**
5766 * This is called when the view is detached from a window. At this point it
5767 * no longer has a surface for drawing.
5768 *
5769 * @see #onAttachedToWindow()
5770 */
5771 protected void onDetachedFromWindow() {
5772 if (mPendingCheckForLongPress != null) {
5773 removeCallbacks(mPendingCheckForLongPress);
5774 }
5775 destroyDrawingCache();
5776 }
5777
5778 /**
5779 * @return The number of times this view has been attached to a window
5780 */
5781 protected int getWindowAttachCount() {
5782 return mWindowAttachCount;
5783 }
5784
5785 /**
5786 * Retrieve a unique token identifying the window this view is attached to.
5787 * @return Return the window's token for use in
5788 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
5789 */
5790 public IBinder getWindowToken() {
5791 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
5792 }
5793
5794 /**
5795 * Retrieve a unique token identifying the top-level "real" window of
5796 * the window that this view is attached to. That is, this is like
5797 * {@link #getWindowToken}, except if the window this view in is a panel
5798 * window (attached to another containing window), then the token of
5799 * the containing window is returned instead.
5800 *
5801 * @return Returns the associated window token, either
5802 * {@link #getWindowToken()} or the containing window's token.
5803 */
5804 public IBinder getApplicationWindowToken() {
5805 AttachInfo ai = mAttachInfo;
5806 if (ai != null) {
5807 IBinder appWindowToken = ai.mPanelParentWindowToken;
5808 if (appWindowToken == null) {
5809 appWindowToken = ai.mWindowToken;
5810 }
5811 return appWindowToken;
5812 }
5813 return null;
5814 }
5815
5816 /**
5817 * Retrieve private session object this view hierarchy is using to
5818 * communicate with the window manager.
5819 * @return the session object to communicate with the window manager
5820 */
5821 /*package*/ IWindowSession getWindowSession() {
5822 return mAttachInfo != null ? mAttachInfo.mSession : null;
5823 }
5824
5825 /**
5826 * @param info the {@link android.view.View.AttachInfo} to associated with
5827 * this view
5828 */
5829 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
5830 //System.out.println("Attached! " + this);
5831 mAttachInfo = info;
5832 mWindowAttachCount++;
5833 if (mFloatingTreeObserver != null) {
5834 info.mTreeObserver.merge(mFloatingTreeObserver);
5835 mFloatingTreeObserver = null;
5836 }
5837 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
5838 mAttachInfo.mScrollContainers.add(this);
5839 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
5840 }
5841 performCollectViewAttributes(visibility);
5842 onAttachedToWindow();
5843 int vis = info.mWindowVisibility;
5844 if (vis != GONE) {
5845 onWindowVisibilityChanged(vis);
5846 }
5847 }
5848
5849 void dispatchDetachedFromWindow() {
5850 //System.out.println("Detached! " + this);
5851 AttachInfo info = mAttachInfo;
5852 if (info != null) {
5853 int vis = info.mWindowVisibility;
5854 if (vis != GONE) {
5855 onWindowVisibilityChanged(GONE);
5856 }
5857 }
5858
5859 onDetachedFromWindow();
5860 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
5861 mAttachInfo.mScrollContainers.remove(this);
5862 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
5863 }
5864 mAttachInfo = null;
5865 }
5866
5867 /**
5868 * Store this view hierarchy's frozen state into the given container.
5869 *
5870 * @param container The SparseArray in which to save the view's state.
5871 *
5872 * @see #restoreHierarchyState
5873 * @see #dispatchSaveInstanceState
5874 * @see #onSaveInstanceState
5875 */
5876 public void saveHierarchyState(SparseArray<Parcelable> container) {
5877 dispatchSaveInstanceState(container);
5878 }
5879
5880 /**
5881 * Called by {@link #saveHierarchyState} to store the state for this view and its children.
5882 * May be overridden to modify how freezing happens to a view's children; for example, some
5883 * views may want to not store state for their children.
5884 *
5885 * @param container The SparseArray in which to save the view's state.
5886 *
5887 * @see #dispatchRestoreInstanceState
5888 * @see #saveHierarchyState
5889 * @see #onSaveInstanceState
5890 */
5891 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
5892 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
5893 mPrivateFlags &= ~SAVE_STATE_CALLED;
5894 Parcelable state = onSaveInstanceState();
5895 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
5896 throw new IllegalStateException(
5897 "Derived class did not call super.onSaveInstanceState()");
5898 }
5899 if (state != null) {
5900 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
5901 // + ": " + state);
5902 container.put(mID, state);
5903 }
5904 }
5905 }
5906
5907 /**
5908 * Hook allowing a view to generate a representation of its internal state
5909 * that can later be used to create a new instance with that same state.
5910 * This state should only contain information that is not persistent or can
5911 * not be reconstructed later. For example, you will never store your
5912 * current position on screen because that will be computed again when a
5913 * new instance of the view is placed in its view hierarchy.
5914 * <p>
5915 * Some examples of things you may store here: the current cursor position
5916 * in a text view (but usually not the text itself since that is stored in a
5917 * content provider or other persistent storage), the currently selected
5918 * item in a list view.
5919 *
5920 * @return Returns a Parcelable object containing the view's current dynamic
5921 * state, or null if there is nothing interesting to save. The
5922 * default implementation returns null.
5923 * @see #onRestoreInstanceState
5924 * @see #saveHierarchyState
5925 * @see #dispatchSaveInstanceState
5926 * @see #setSaveEnabled(boolean)
5927 */
5928 protected Parcelable onSaveInstanceState() {
5929 mPrivateFlags |= SAVE_STATE_CALLED;
5930 return BaseSavedState.EMPTY_STATE;
5931 }
5932
5933 /**
5934 * Restore this view hierarchy's frozen state from the given container.
5935 *
5936 * @param container The SparseArray which holds previously frozen states.
5937 *
5938 * @see #saveHierarchyState
5939 * @see #dispatchRestoreInstanceState
5940 * @see #onRestoreInstanceState
5941 */
5942 public void restoreHierarchyState(SparseArray<Parcelable> container) {
5943 dispatchRestoreInstanceState(container);
5944 }
5945
5946 /**
5947 * Called by {@link #restoreHierarchyState} to retrieve the state for this view and its
5948 * children. May be overridden to modify how restoreing happens to a view's children; for
5949 * example, some views may want to not store state for their children.
5950 *
5951 * @param container The SparseArray which holds previously saved state.
5952 *
5953 * @see #dispatchSaveInstanceState
5954 * @see #restoreHierarchyState
5955 * @see #onRestoreInstanceState
5956 */
5957 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
5958 if (mID != NO_ID) {
5959 Parcelable state = container.get(mID);
5960 if (state != null) {
5961 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
5962 // + ": " + state);
5963 mPrivateFlags &= ~SAVE_STATE_CALLED;
5964 onRestoreInstanceState(state);
5965 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
5966 throw new IllegalStateException(
5967 "Derived class did not call super.onRestoreInstanceState()");
5968 }
5969 }
5970 }
5971 }
5972
5973 /**
5974 * Hook allowing a view to re-apply a representation of its internal state that had previously
5975 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
5976 * null state.
5977 *
5978 * @param state The frozen state that had previously been returned by
5979 * {@link #onSaveInstanceState}.
5980 *
5981 * @see #onSaveInstanceState
5982 * @see #restoreHierarchyState
5983 * @see #dispatchRestoreInstanceState
5984 */
5985 protected void onRestoreInstanceState(Parcelable state) {
5986 mPrivateFlags |= SAVE_STATE_CALLED;
5987 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -08005988 throw new IllegalArgumentException("Wrong state class, expecting View State but "
5989 + "received " + state.getClass().toString() + " instead. This usually happens "
5990 + "when two views of different type have the same id in the same hierarchy. "
5991 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
5992 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005993 }
5994 }
5995
5996 /**
5997 * <p>Return the time at which the drawing of the view hierarchy started.</p>
5998 *
5999 * @return the drawing start time in milliseconds
6000 */
6001 public long getDrawingTime() {
6002 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
6003 }
6004
6005 /**
6006 * <p>Enables or disables the duplication of the parent's state into this view. When
6007 * duplication is enabled, this view gets its drawable state from its parent rather
6008 * than from its own internal properties.</p>
6009 *
6010 * <p>Note: in the current implementation, setting this property to true after the
6011 * view was added to a ViewGroup might have no effect at all. This property should
6012 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
6013 *
6014 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
6015 * property is enabled, an exception will be thrown.</p>
6016 *
6017 * @param enabled True to enable duplication of the parent's drawable state, false
6018 * to disable it.
6019 *
6020 * @see #getDrawableState()
6021 * @see #isDuplicateParentStateEnabled()
6022 */
6023 public void setDuplicateParentStateEnabled(boolean enabled) {
6024 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
6025 }
6026
6027 /**
6028 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
6029 *
6030 * @return True if this view's drawable state is duplicated from the parent,
6031 * false otherwise
6032 *
6033 * @see #getDrawableState()
6034 * @see #setDuplicateParentStateEnabled(boolean)
6035 */
6036 public boolean isDuplicateParentStateEnabled() {
6037 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
6038 }
6039
6040 /**
6041 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
6042 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
6043 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
6044 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
6045 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
6046 * null.</p>
6047 *
6048 * @param enabled true to enable the drawing cache, false otherwise
6049 *
6050 * @see #isDrawingCacheEnabled()
6051 * @see #getDrawingCache()
6052 * @see #buildDrawingCache()
6053 */
6054 public void setDrawingCacheEnabled(boolean enabled) {
6055 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
6056 }
6057
6058 /**
6059 * <p>Indicates whether the drawing cache is enabled for this view.</p>
6060 *
6061 * @return true if the drawing cache is enabled
6062 *
6063 * @see #setDrawingCacheEnabled(boolean)
6064 * @see #getDrawingCache()
6065 */
6066 @ViewDebug.ExportedProperty
6067 public boolean isDrawingCacheEnabled() {
6068 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
6069 }
6070
6071 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07006072 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
6073 *
6074 * @return A non-scaled bitmap representing this view or null if cache is disabled.
6075 *
6076 * @see #getDrawingCache(boolean)
6077 */
6078 public Bitmap getDrawingCache() {
6079 return getDrawingCache(false);
6080 }
6081
6082 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006083 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
6084 * is null when caching is disabled. If caching is enabled and the cache is not ready,
6085 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
6086 * draw from the cache when the cache is enabled. To benefit from the cache, you must
6087 * request the drawing cache by calling this method and draw it on screen if the
6088 * returned bitmap is not null.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07006089 *
6090 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
6091 * this method will create a bitmap of the same size as this view. Because this bitmap
6092 * will be drawn scaled by the parent ViewGroup, the result on screen might show
6093 * scaling artifacts. To avoid such artifacts, you should call this method by setting
6094 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
6095 * size than the view. This implies that your application must be able to handle this
6096 * size.</p>
6097 *
6098 * @param autoScale Indicates whether the generated bitmap should be scaled based on
6099 * the current density of the screen when the application is in compatibility
6100 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006101 *
Romain Guyfbd8f692009-06-26 14:51:58 -07006102 * @return A bitmap representing this view or null if cache is disabled.
6103 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006104 * @see #setDrawingCacheEnabled(boolean)
6105 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -07006106 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006107 * @see #destroyDrawingCache()
6108 */
Romain Guyfbd8f692009-06-26 14:51:58 -07006109 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006110 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
6111 return null;
6112 }
6113 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -07006114 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006115 }
Romain Guyfbd8f692009-06-26 14:51:58 -07006116 return autoScale ? (mDrawingCache == null ? null : mDrawingCache.get()) :
6117 (mUnscaledDrawingCache == null ? null : mUnscaledDrawingCache.get());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006118 }
6119
6120 /**
6121 * <p>Frees the resources used by the drawing cache. If you call
6122 * {@link #buildDrawingCache()} manually without calling
6123 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
6124 * should cleanup the cache with this method afterwards.</p>
6125 *
6126 * @see #setDrawingCacheEnabled(boolean)
6127 * @see #buildDrawingCache()
6128 * @see #getDrawingCache()
6129 */
6130 public void destroyDrawingCache() {
6131 if (mDrawingCache != null) {
6132 final Bitmap bitmap = mDrawingCache.get();
6133 if (bitmap != null) bitmap.recycle();
6134 mDrawingCache = null;
6135 }
Romain Guyfbd8f692009-06-26 14:51:58 -07006136 if (mUnscaledDrawingCache != null) {
6137 final Bitmap bitmap = mUnscaledDrawingCache.get();
6138 if (bitmap != null) bitmap.recycle();
6139 mUnscaledDrawingCache = null;
6140 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006141 }
6142
6143 /**
6144 * Setting a solid background color for the drawing cache's bitmaps will improve
6145 * perfromance and memory usage. Note, though that this should only be used if this
6146 * view will always be drawn on top of a solid color.
6147 *
6148 * @param color The background color to use for the drawing cache's bitmap
6149 *
6150 * @see #setDrawingCacheEnabled(boolean)
6151 * @see #buildDrawingCache()
6152 * @see #getDrawingCache()
6153 */
6154 public void setDrawingCacheBackgroundColor(int color) {
6155 mDrawingCacheBackgroundColor = color;
6156 }
6157
6158 /**
6159 * @see #setDrawingCacheBackgroundColor(int)
6160 *
6161 * @return The background color to used for the drawing cache's bitmap
6162 */
6163 public int getDrawingCacheBackgroundColor() {
6164 return mDrawingCacheBackgroundColor;
6165 }
6166
6167 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07006168 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
6169 *
6170 * @see #buildDrawingCache(boolean)
6171 */
6172 public void buildDrawingCache() {
6173 buildDrawingCache(false);
6174 }
6175
6176 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006177 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
6178 *
6179 * <p>If you call {@link #buildDrawingCache()} manually without calling
6180 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
6181 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07006182 *
6183 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
6184 * this method will create a bitmap of the same size as this view. Because this bitmap
6185 * will be drawn scaled by the parent ViewGroup, the result on screen might show
6186 * scaling artifacts. To avoid such artifacts, you should call this method by setting
6187 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
6188 * size than the view. This implies that your application must be able to handle this
6189 * size.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006190 *
6191 * @see #getDrawingCache()
6192 * @see #destroyDrawingCache()
6193 */
Romain Guyfbd8f692009-06-26 14:51:58 -07006194 public void buildDrawingCache(boolean autoScale) {
6195 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
6196 (mDrawingCache == null || mDrawingCache.get() == null) :
6197 (mUnscaledDrawingCache == null || mUnscaledDrawingCache.get() == null))) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006198
6199 if (ViewDebug.TRACE_HIERARCHY) {
6200 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
6201 }
Romain Guy13922e02009-05-12 17:56:14 -07006202 if (Config.DEBUG && ViewDebug.profileDrawing) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006203 EventLog.writeEvent(60002, hashCode());
6204 }
6205
Romain Guy8506ab42009-06-11 17:35:47 -07006206 int width = mRight - mLeft;
6207 int height = mBottom - mTop;
6208
6209 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -07006210 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -07006211
Romain Guye1123222009-06-29 14:24:56 -07006212 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07006213 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
6214 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -07006215 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006216
6217 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -07006218 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Romain Guya62e4702009-10-08 10:48:54 -07006219 final boolean translucentWindow = attachInfo != null && attachInfo.mTranslucentWindow;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006220
6221 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -07006222 // Projected bitmap size in bytes
6223 (width * height * (opaque && !translucentWindow ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006224 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
6225 destroyDrawingCache();
6226 return;
6227 }
6228
6229 boolean clear = true;
Romain Guyfbd8f692009-06-26 14:51:58 -07006230 Bitmap bitmap = autoScale ? (mDrawingCache == null ? null : mDrawingCache.get()) :
6231 (mUnscaledDrawingCache == null ? null : mUnscaledDrawingCache.get());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006232
6233 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006234 Bitmap.Config quality;
6235 if (!opaque) {
6236 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
6237 case DRAWING_CACHE_QUALITY_AUTO:
6238 quality = Bitmap.Config.ARGB_8888;
6239 break;
6240 case DRAWING_CACHE_QUALITY_LOW:
6241 quality = Bitmap.Config.ARGB_4444;
6242 break;
6243 case DRAWING_CACHE_QUALITY_HIGH:
6244 quality = Bitmap.Config.ARGB_8888;
6245 break;
6246 default:
6247 quality = Bitmap.Config.ARGB_8888;
6248 break;
6249 }
6250 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -07006251 // Optimization for translucent windows
6252 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
6253 quality = translucentWindow ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006254 }
6255
6256 // Try to cleanup memory
6257 if (bitmap != null) bitmap.recycle();
6258
6259 try {
6260 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -07006261 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -07006262 if (autoScale) {
6263 mDrawingCache = new SoftReference<Bitmap>(bitmap);
6264 } else {
6265 mUnscaledDrawingCache = new SoftReference<Bitmap>(bitmap);
6266 }
Romain Guy35b38ce2009-10-07 13:38:55 -07006267 if (opaque && translucentWindow) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006268 } catch (OutOfMemoryError e) {
6269 // If there is not enough memory to create the bitmap cache, just
6270 // ignore the issue as bitmap caches are not required to draw the
6271 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -07006272 if (autoScale) {
6273 mDrawingCache = null;
6274 } else {
6275 mUnscaledDrawingCache = null;
6276 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006277 return;
6278 }
6279
6280 clear = drawingCacheBackgroundColor != 0;
6281 }
6282
6283 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006284 if (attachInfo != null) {
6285 canvas = attachInfo.mCanvas;
6286 if (canvas == null) {
6287 canvas = new Canvas();
6288 }
6289 canvas.setBitmap(bitmap);
6290 // Temporarily clobber the cached Canvas in case one of our children
6291 // is also using a drawing cache. Without this, the children would
6292 // steal the canvas by attaching their own bitmap to it and bad, bad
6293 // thing would happen (invisible views, corrupted drawings, etc.)
6294 attachInfo.mCanvas = null;
6295 } else {
6296 // This case should hopefully never or seldom happen
6297 canvas = new Canvas(bitmap);
6298 }
6299
6300 if (clear) {
6301 bitmap.eraseColor(drawingCacheBackgroundColor);
6302 }
6303
6304 computeScroll();
6305 final int restoreCount = canvas.save();
Romain Guyfbd8f692009-06-26 14:51:58 -07006306
Romain Guye1123222009-06-29 14:24:56 -07006307 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07006308 final float scale = attachInfo.mApplicationScale;
6309 canvas.scale(scale, scale);
6310 }
6311
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006312 canvas.translate(-mScrollX, -mScrollY);
6313
Romain Guy5bcdff42009-05-14 21:27:18 -07006314 mPrivateFlags |= DRAWN;
Romain Guyecd80ee2009-12-03 17:13:02 -08006315 mPrivateFlags |= DRAWING_CACHE_VALID;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006316
6317 // Fast path for layouts with no backgrounds
6318 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
6319 if (ViewDebug.TRACE_HIERARCHY) {
6320 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
6321 }
Romain Guy5bcdff42009-05-14 21:27:18 -07006322 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006323 dispatchDraw(canvas);
6324 } else {
6325 draw(canvas);
6326 }
6327
6328 canvas.restoreToCount(restoreCount);
6329
6330 if (attachInfo != null) {
6331 // Restore the cached Canvas for our siblings
6332 attachInfo.mCanvas = canvas;
6333 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006334 }
6335 }
6336
6337 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07006338 * Create a snapshot of the view into a bitmap. We should probably make
6339 * some form of this public, but should think about the API.
6340 */
Romain Guya2431d02009-04-30 16:30:00 -07006341 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -07006342 int width = mRight - mLeft;
6343 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07006344
Dianne Hackborn8cae1242009-09-10 14:32:16 -07006345 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -07006346 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -07006347 width = (int) ((width * scale) + 0.5f);
6348 height = (int) ((height * scale) + 0.5f);
6349
Romain Guy8c11e312009-09-14 15:15:30 -07006350 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07006351 if (bitmap == null) {
6352 throw new OutOfMemoryError();
6353 }
6354
Dianne Hackborn8cae1242009-09-10 14:32:16 -07006355 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
6356
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07006357 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07006358 if (attachInfo != null) {
6359 canvas = attachInfo.mCanvas;
6360 if (canvas == null) {
6361 canvas = new Canvas();
6362 }
6363 canvas.setBitmap(bitmap);
6364 // Temporarily clobber the cached Canvas in case one of our children
6365 // is also using a drawing cache. Without this, the children would
6366 // steal the canvas by attaching their own bitmap to it and bad, bad
6367 // things would happen (invisible views, corrupted drawings, etc.)
6368 attachInfo.mCanvas = null;
6369 } else {
6370 // This case should hopefully never or seldom happen
6371 canvas = new Canvas(bitmap);
6372 }
6373
Romain Guy5bcdff42009-05-14 21:27:18 -07006374 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07006375 bitmap.eraseColor(backgroundColor);
6376 }
6377
6378 computeScroll();
6379 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -07006380 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07006381 canvas.translate(-mScrollX, -mScrollY);
6382
Romain Guy5bcdff42009-05-14 21:27:18 -07006383 // Temporarily remove the dirty mask
6384 int flags = mPrivateFlags;
6385 mPrivateFlags &= ~DIRTY_MASK;
6386
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07006387 // Fast path for layouts with no backgrounds
6388 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
6389 dispatchDraw(canvas);
6390 } else {
6391 draw(canvas);
6392 }
6393
Romain Guy5bcdff42009-05-14 21:27:18 -07006394 mPrivateFlags = flags;
6395
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07006396 canvas.restoreToCount(restoreCount);
6397
6398 if (attachInfo != null) {
6399 // Restore the cached Canvas for our siblings
6400 attachInfo.mCanvas = canvas;
6401 }
Romain Guy8506ab42009-06-11 17:35:47 -07006402
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07006403 return bitmap;
6404 }
6405
6406 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006407 * Indicates whether this View is currently in edit mode. A View is usually
6408 * in edit mode when displayed within a developer tool. For instance, if
6409 * this View is being drawn by a visual user interface builder, this method
6410 * should return true.
6411 *
6412 * Subclasses should check the return value of this method to provide
6413 * different behaviors if their normal behavior might interfere with the
6414 * host environment. For instance: the class spawns a thread in its
6415 * constructor, the drawing code relies on device-specific features, etc.
6416 *
6417 * This method is usually checked in the drawing code of custom widgets.
6418 *
6419 * @return True if this View is in edit mode, false otherwise.
6420 */
6421 public boolean isInEditMode() {
6422 return false;
6423 }
6424
6425 /**
6426 * If the View draws content inside its padding and enables fading edges,
6427 * it needs to support padding offsets. Padding offsets are added to the
6428 * fading edges to extend the length of the fade so that it covers pixels
6429 * drawn inside the padding.
6430 *
6431 * Subclasses of this class should override this method if they need
6432 * to draw content inside the padding.
6433 *
6434 * @return True if padding offset must be applied, false otherwise.
6435 *
6436 * @see #getLeftPaddingOffset()
6437 * @see #getRightPaddingOffset()
6438 * @see #getTopPaddingOffset()
6439 * @see #getBottomPaddingOffset()
6440 *
6441 * @since CURRENT
6442 */
6443 protected boolean isPaddingOffsetRequired() {
6444 return false;
6445 }
6446
6447 /**
6448 * Amount by which to extend the left fading region. Called only when
6449 * {@link #isPaddingOffsetRequired()} returns true.
6450 *
6451 * @return The left padding offset in pixels.
6452 *
6453 * @see #isPaddingOffsetRequired()
6454 *
6455 * @since CURRENT
6456 */
6457 protected int getLeftPaddingOffset() {
6458 return 0;
6459 }
6460
6461 /**
6462 * Amount by which to extend the right fading region. Called only when
6463 * {@link #isPaddingOffsetRequired()} returns true.
6464 *
6465 * @return The right padding offset in pixels.
6466 *
6467 * @see #isPaddingOffsetRequired()
6468 *
6469 * @since CURRENT
6470 */
6471 protected int getRightPaddingOffset() {
6472 return 0;
6473 }
6474
6475 /**
6476 * Amount by which to extend the top fading region. Called only when
6477 * {@link #isPaddingOffsetRequired()} returns true.
6478 *
6479 * @return The top padding offset in pixels.
6480 *
6481 * @see #isPaddingOffsetRequired()
6482 *
6483 * @since CURRENT
6484 */
6485 protected int getTopPaddingOffset() {
6486 return 0;
6487 }
6488
6489 /**
6490 * Amount by which to extend the bottom fading region. Called only when
6491 * {@link #isPaddingOffsetRequired()} returns true.
6492 *
6493 * @return The bottom padding offset in pixels.
6494 *
6495 * @see #isPaddingOffsetRequired()
6496 *
6497 * @since CURRENT
6498 */
6499 protected int getBottomPaddingOffset() {
6500 return 0;
6501 }
6502
6503 /**
6504 * Manually render this view (and all of its children) to the given Canvas.
6505 * The view must have already done a full layout before this function is
6506 * called. When implementing a view, do not override this method; instead,
6507 * you should implement {@link #onDraw}.
6508 *
6509 * @param canvas The Canvas to which the View is rendered.
6510 */
6511 public void draw(Canvas canvas) {
6512 if (ViewDebug.TRACE_HIERARCHY) {
6513 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
6514 }
6515
Romain Guy5bcdff42009-05-14 21:27:18 -07006516 final int privateFlags = mPrivateFlags;
6517 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
6518 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
6519 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -07006520
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006521 /*
6522 * Draw traversal performs several drawing steps which must be executed
6523 * in the appropriate order:
6524 *
6525 * 1. Draw the background
6526 * 2. If necessary, save the canvas' layers to prepare for fading
6527 * 3. Draw view's content
6528 * 4. Draw children
6529 * 5. If necessary, draw the fading edges and restore layers
6530 * 6. Draw decorations (scrollbars for instance)
6531 */
6532
6533 // Step 1, draw the background, if needed
6534 int saveCount;
6535
Romain Guy24443ea2009-05-11 11:56:30 -07006536 if (!dirtyOpaque) {
6537 final Drawable background = mBGDrawable;
6538 if (background != null) {
6539 final int scrollX = mScrollX;
6540 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006541
Romain Guy24443ea2009-05-11 11:56:30 -07006542 if (mBackgroundSizeChanged) {
6543 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
6544 mBackgroundSizeChanged = false;
6545 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006546
Romain Guy24443ea2009-05-11 11:56:30 -07006547 if ((scrollX | scrollY) == 0) {
6548 background.draw(canvas);
6549 } else {
6550 canvas.translate(scrollX, scrollY);
6551 background.draw(canvas);
6552 canvas.translate(-scrollX, -scrollY);
6553 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006554 }
6555 }
6556
6557 // skip step 2 & 5 if possible (common case)
6558 final int viewFlags = mViewFlags;
6559 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
6560 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
6561 if (!verticalEdges && !horizontalEdges) {
6562 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07006563 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006564
6565 // Step 4, draw the children
6566 dispatchDraw(canvas);
6567
6568 // Step 6, draw decorations (scrollbars)
6569 onDrawScrollBars(canvas);
6570
6571 // we're done...
6572 return;
6573 }
6574
6575 /*
6576 * Here we do the full fledged routine...
6577 * (this is an uncommon case where speed matters less,
6578 * this is why we repeat some of the tests that have been
6579 * done above)
6580 */
6581
6582 boolean drawTop = false;
6583 boolean drawBottom = false;
6584 boolean drawLeft = false;
6585 boolean drawRight = false;
6586
6587 float topFadeStrength = 0.0f;
6588 float bottomFadeStrength = 0.0f;
6589 float leftFadeStrength = 0.0f;
6590 float rightFadeStrength = 0.0f;
6591
6592 // Step 2, save the canvas' layers
6593 int paddingLeft = mPaddingLeft;
6594 int paddingTop = mPaddingTop;
6595
6596 final boolean offsetRequired = isPaddingOffsetRequired();
6597 if (offsetRequired) {
6598 paddingLeft += getLeftPaddingOffset();
6599 paddingTop += getTopPaddingOffset();
6600 }
6601
6602 int left = mScrollX + paddingLeft;
6603 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
6604 int top = mScrollY + paddingTop;
6605 int bottom = top + mBottom - mTop - mPaddingBottom - paddingTop;
6606
6607 if (offsetRequired) {
6608 right += getRightPaddingOffset();
6609 bottom += getBottomPaddingOffset();
6610 }
6611
6612 final ScrollabilityCache scrollabilityCache = mScrollCache;
6613 int length = scrollabilityCache.fadingEdgeLength;
6614
6615 // clip the fade length if top and bottom fades overlap
6616 // overlapping fades produce odd-looking artifacts
6617 if (verticalEdges && (top + length > bottom - length)) {
6618 length = (bottom - top) / 2;
6619 }
6620
6621 // also clip horizontal fades if necessary
6622 if (horizontalEdges && (left + length > right - length)) {
6623 length = (right - left) / 2;
6624 }
6625
6626 if (verticalEdges) {
6627 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
6628 drawTop = topFadeStrength >= 0.0f;
6629 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
6630 drawBottom = bottomFadeStrength >= 0.0f;
6631 }
6632
6633 if (horizontalEdges) {
6634 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
6635 drawLeft = leftFadeStrength >= 0.0f;
6636 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
6637 drawRight = rightFadeStrength >= 0.0f;
6638 }
6639
6640 saveCount = canvas.getSaveCount();
6641
6642 int solidColor = getSolidColor();
6643 if (solidColor == 0) {
6644 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
6645
6646 if (drawTop) {
6647 canvas.saveLayer(left, top, right, top + length, null, flags);
6648 }
6649
6650 if (drawBottom) {
6651 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
6652 }
6653
6654 if (drawLeft) {
6655 canvas.saveLayer(left, top, left + length, bottom, null, flags);
6656 }
6657
6658 if (drawRight) {
6659 canvas.saveLayer(right - length, top, right, bottom, null, flags);
6660 }
6661 } else {
6662 scrollabilityCache.setFadeColor(solidColor);
6663 }
6664
6665 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07006666 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006667
6668 // Step 4, draw the children
6669 dispatchDraw(canvas);
6670
6671 // Step 5, draw the fade effect and restore layers
6672 final Paint p = scrollabilityCache.paint;
6673 final Matrix matrix = scrollabilityCache.matrix;
6674 final Shader fade = scrollabilityCache.shader;
6675 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
6676
6677 if (drawTop) {
6678 matrix.setScale(1, fadeHeight * topFadeStrength);
6679 matrix.postTranslate(left, top);
6680 fade.setLocalMatrix(matrix);
6681 canvas.drawRect(left, top, right, top + length, p);
6682 }
6683
6684 if (drawBottom) {
6685 matrix.setScale(1, fadeHeight * bottomFadeStrength);
6686 matrix.postRotate(180);
6687 matrix.postTranslate(left, bottom);
6688 fade.setLocalMatrix(matrix);
6689 canvas.drawRect(left, bottom - length, right, bottom, p);
6690 }
6691
6692 if (drawLeft) {
6693 matrix.setScale(1, fadeHeight * leftFadeStrength);
6694 matrix.postRotate(-90);
6695 matrix.postTranslate(left, top);
6696 fade.setLocalMatrix(matrix);
6697 canvas.drawRect(left, top, left + length, bottom, p);
6698 }
6699
6700 if (drawRight) {
6701 matrix.setScale(1, fadeHeight * rightFadeStrength);
6702 matrix.postRotate(90);
6703 matrix.postTranslate(right, top);
6704 fade.setLocalMatrix(matrix);
6705 canvas.drawRect(right - length, top, right, bottom, p);
6706 }
6707
6708 canvas.restoreToCount(saveCount);
6709
6710 // Step 6, draw decorations (scrollbars)
6711 onDrawScrollBars(canvas);
6712 }
6713
6714 /**
6715 * Override this if your view is known to always be drawn on top of a solid color background,
6716 * and needs to draw fading edges. Returning a non-zero color enables the view system to
6717 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
6718 * should be set to 0xFF.
6719 *
6720 * @see #setVerticalFadingEdgeEnabled
6721 * @see #setHorizontalFadingEdgeEnabled
6722 *
6723 * @return The known solid color background for this view, or 0 if the color may vary
6724 */
6725 public int getSolidColor() {
6726 return 0;
6727 }
6728
6729 /**
6730 * Build a human readable string representation of the specified view flags.
6731 *
6732 * @param flags the view flags to convert to a string
6733 * @return a String representing the supplied flags
6734 */
6735 private static String printFlags(int flags) {
6736 String output = "";
6737 int numFlags = 0;
6738 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
6739 output += "TAKES_FOCUS";
6740 numFlags++;
6741 }
6742
6743 switch (flags & VISIBILITY_MASK) {
6744 case INVISIBLE:
6745 if (numFlags > 0) {
6746 output += " ";
6747 }
6748 output += "INVISIBLE";
6749 // USELESS HERE numFlags++;
6750 break;
6751 case GONE:
6752 if (numFlags > 0) {
6753 output += " ";
6754 }
6755 output += "GONE";
6756 // USELESS HERE numFlags++;
6757 break;
6758 default:
6759 break;
6760 }
6761 return output;
6762 }
6763
6764 /**
6765 * Build a human readable string representation of the specified private
6766 * view flags.
6767 *
6768 * @param privateFlags the private view flags to convert to a string
6769 * @return a String representing the supplied flags
6770 */
6771 private static String printPrivateFlags(int privateFlags) {
6772 String output = "";
6773 int numFlags = 0;
6774
6775 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
6776 output += "WANTS_FOCUS";
6777 numFlags++;
6778 }
6779
6780 if ((privateFlags & FOCUSED) == FOCUSED) {
6781 if (numFlags > 0) {
6782 output += " ";
6783 }
6784 output += "FOCUSED";
6785 numFlags++;
6786 }
6787
6788 if ((privateFlags & SELECTED) == SELECTED) {
6789 if (numFlags > 0) {
6790 output += " ";
6791 }
6792 output += "SELECTED";
6793 numFlags++;
6794 }
6795
6796 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
6797 if (numFlags > 0) {
6798 output += " ";
6799 }
6800 output += "IS_ROOT_NAMESPACE";
6801 numFlags++;
6802 }
6803
6804 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
6805 if (numFlags > 0) {
6806 output += " ";
6807 }
6808 output += "HAS_BOUNDS";
6809 numFlags++;
6810 }
6811
6812 if ((privateFlags & DRAWN) == DRAWN) {
6813 if (numFlags > 0) {
6814 output += " ";
6815 }
6816 output += "DRAWN";
6817 // USELESS HERE numFlags++;
6818 }
6819 return output;
6820 }
6821
6822 /**
6823 * <p>Indicates whether or not this view's layout will be requested during
6824 * the next hierarchy layout pass.</p>
6825 *
6826 * @return true if the layout will be forced during next layout pass
6827 */
6828 public boolean isLayoutRequested() {
6829 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
6830 }
6831
6832 /**
6833 * Assign a size and position to a view and all of its
6834 * descendants
6835 *
6836 * <p>This is the second phase of the layout mechanism.
6837 * (The first is measuring). In this phase, each parent calls
6838 * layout on all of its children to position them.
6839 * This is typically done using the child measurements
6840 * that were stored in the measure pass().
6841 *
6842 * Derived classes with children should override
6843 * onLayout. In that method, they should
6844 * call layout on each of their their children.
6845 *
6846 * @param l Left position, relative to parent
6847 * @param t Top position, relative to parent
6848 * @param r Right position, relative to parent
6849 * @param b Bottom position, relative to parent
6850 */
6851 public final void layout(int l, int t, int r, int b) {
6852 boolean changed = setFrame(l, t, r, b);
6853 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
6854 if (ViewDebug.TRACE_HIERARCHY) {
6855 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
6856 }
6857
6858 onLayout(changed, l, t, r, b);
6859 mPrivateFlags &= ~LAYOUT_REQUIRED;
6860 }
6861 mPrivateFlags &= ~FORCE_LAYOUT;
6862 }
6863
6864 /**
6865 * Called from layout when this view should
6866 * assign a size and position to each of its children.
6867 *
6868 * Derived classes with children should override
6869 * this method and call layout on each of
6870 * their their children.
6871 * @param changed This is a new size or position for this view
6872 * @param left Left position, relative to parent
6873 * @param top Top position, relative to parent
6874 * @param right Right position, relative to parent
6875 * @param bottom Bottom position, relative to parent
6876 */
6877 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
6878 }
6879
6880 /**
6881 * Assign a size and position to this view.
6882 *
6883 * This is called from layout.
6884 *
6885 * @param left Left position, relative to parent
6886 * @param top Top position, relative to parent
6887 * @param right Right position, relative to parent
6888 * @param bottom Bottom position, relative to parent
6889 * @return true if the new size and position are different than the
6890 * previous ones
6891 * {@hide}
6892 */
6893 protected boolean setFrame(int left, int top, int right, int bottom) {
6894 boolean changed = false;
6895
6896 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -07006897 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006898 + right + "," + bottom + ")");
6899 }
6900
6901 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
6902 changed = true;
6903
6904 // Remember our drawn bit
6905 int drawn = mPrivateFlags & DRAWN;
6906
6907 // Invalidate our old position
6908 invalidate();
6909
6910
6911 int oldWidth = mRight - mLeft;
6912 int oldHeight = mBottom - mTop;
6913
6914 mLeft = left;
6915 mTop = top;
6916 mRight = right;
6917 mBottom = bottom;
6918
6919 mPrivateFlags |= HAS_BOUNDS;
6920
6921 int newWidth = right - left;
6922 int newHeight = bottom - top;
6923
6924 if (newWidth != oldWidth || newHeight != oldHeight) {
6925 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
6926 }
6927
6928 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
6929 // If we are visible, force the DRAWN bit to on so that
6930 // this invalidate will go through (at least to our parent).
6931 // This is because someone may have invalidated this view
6932 // before this call to setFrame came in, therby clearing
6933 // the DRAWN bit.
6934 mPrivateFlags |= DRAWN;
6935 invalidate();
6936 }
6937
6938 // Reset drawn bit to original value (invalidate turns it off)
6939 mPrivateFlags |= drawn;
6940
6941 mBackgroundSizeChanged = true;
6942 }
6943 return changed;
6944 }
6945
6946 /**
6947 * Finalize inflating a view from XML. This is called as the last phase
6948 * of inflation, after all child views have been added.
6949 *
6950 * <p>Even if the subclass overrides onFinishInflate, they should always be
6951 * sure to call the super method, so that we get called.
6952 */
6953 protected void onFinishInflate() {
6954 }
6955
6956 /**
6957 * Returns the resources associated with this view.
6958 *
6959 * @return Resources object.
6960 */
6961 public Resources getResources() {
6962 return mResources;
6963 }
6964
6965 /**
6966 * Invalidates the specified Drawable.
6967 *
6968 * @param drawable the drawable to invalidate
6969 */
6970 public void invalidateDrawable(Drawable drawable) {
6971 if (verifyDrawable(drawable)) {
6972 final Rect dirty = drawable.getBounds();
6973 final int scrollX = mScrollX;
6974 final int scrollY = mScrollY;
6975
6976 invalidate(dirty.left + scrollX, dirty.top + scrollY,
6977 dirty.right + scrollX, dirty.bottom + scrollY);
6978 }
6979 }
6980
6981 /**
6982 * Schedules an action on a drawable to occur at a specified time.
6983 *
6984 * @param who the recipient of the action
6985 * @param what the action to run on the drawable
6986 * @param when the time at which the action must occur. Uses the
6987 * {@link SystemClock#uptimeMillis} timebase.
6988 */
6989 public void scheduleDrawable(Drawable who, Runnable what, long when) {
6990 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
6991 mAttachInfo.mHandler.postAtTime(what, who, when);
6992 }
6993 }
6994
6995 /**
6996 * Cancels a scheduled action on a drawable.
6997 *
6998 * @param who the recipient of the action
6999 * @param what the action to cancel
7000 */
7001 public void unscheduleDrawable(Drawable who, Runnable what) {
7002 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
7003 mAttachInfo.mHandler.removeCallbacks(what, who);
7004 }
7005 }
7006
7007 /**
7008 * Unschedule any events associated with the given Drawable. This can be
7009 * used when selecting a new Drawable into a view, so that the previous
7010 * one is completely unscheduled.
7011 *
7012 * @param who The Drawable to unschedule.
7013 *
7014 * @see #drawableStateChanged
7015 */
7016 public void unscheduleDrawable(Drawable who) {
7017 if (mAttachInfo != null) {
7018 mAttachInfo.mHandler.removeCallbacksAndMessages(who);
7019 }
7020 }
7021
7022 /**
7023 * If your view subclass is displaying its own Drawable objects, it should
7024 * override this function and return true for any Drawable it is
7025 * displaying. This allows animations for those drawables to be
7026 * scheduled.
7027 *
7028 * <p>Be sure to call through to the super class when overriding this
7029 * function.
7030 *
7031 * @param who The Drawable to verify. Return true if it is one you are
7032 * displaying, else return the result of calling through to the
7033 * super class.
7034 *
7035 * @return boolean If true than the Drawable is being displayed in the
7036 * view; else false and it is not allowed to animate.
7037 *
7038 * @see #unscheduleDrawable
7039 * @see #drawableStateChanged
7040 */
7041 protected boolean verifyDrawable(Drawable who) {
7042 return who == mBGDrawable;
7043 }
7044
7045 /**
7046 * This function is called whenever the state of the view changes in such
7047 * a way that it impacts the state of drawables being shown.
7048 *
7049 * <p>Be sure to call through to the superclass when overriding this
7050 * function.
7051 *
7052 * @see Drawable#setState
7053 */
7054 protected void drawableStateChanged() {
7055 Drawable d = mBGDrawable;
7056 if (d != null && d.isStateful()) {
7057 d.setState(getDrawableState());
7058 }
7059 }
7060
7061 /**
7062 * Call this to force a view to update its drawable state. This will cause
7063 * drawableStateChanged to be called on this view. Views that are interested
7064 * in the new state should call getDrawableState.
7065 *
7066 * @see #drawableStateChanged
7067 * @see #getDrawableState
7068 */
7069 public void refreshDrawableState() {
7070 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
7071 drawableStateChanged();
7072
7073 ViewParent parent = mParent;
7074 if (parent != null) {
7075 parent.childDrawableStateChanged(this);
7076 }
7077 }
7078
7079 /**
7080 * Return an array of resource IDs of the drawable states representing the
7081 * current state of the view.
7082 *
7083 * @return The current drawable state
7084 *
7085 * @see Drawable#setState
7086 * @see #drawableStateChanged
7087 * @see #onCreateDrawableState
7088 */
7089 public final int[] getDrawableState() {
7090 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
7091 return mDrawableState;
7092 } else {
7093 mDrawableState = onCreateDrawableState(0);
7094 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
7095 return mDrawableState;
7096 }
7097 }
7098
7099 /**
7100 * Generate the new {@link android.graphics.drawable.Drawable} state for
7101 * this view. This is called by the view
7102 * system when the cached Drawable state is determined to be invalid. To
7103 * retrieve the current state, you should use {@link #getDrawableState}.
7104 *
7105 * @param extraSpace if non-zero, this is the number of extra entries you
7106 * would like in the returned array in which you can place your own
7107 * states.
7108 *
7109 * @return Returns an array holding the current {@link Drawable} state of
7110 * the view.
7111 *
7112 * @see #mergeDrawableStates
7113 */
7114 protected int[] onCreateDrawableState(int extraSpace) {
7115 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
7116 mParent instanceof View) {
7117 return ((View) mParent).onCreateDrawableState(extraSpace);
7118 }
7119
7120 int[] drawableState;
7121
7122 int privateFlags = mPrivateFlags;
7123
7124 int viewStateIndex = (((privateFlags & PRESSED) != 0) ? 1 : 0);
7125
7126 viewStateIndex = (viewStateIndex << 1)
7127 + (((mViewFlags & ENABLED_MASK) == ENABLED) ? 1 : 0);
7128
7129 viewStateIndex = (viewStateIndex << 1) + (isFocused() ? 1 : 0);
7130
7131 viewStateIndex = (viewStateIndex << 1)
7132 + (((privateFlags & SELECTED) != 0) ? 1 : 0);
7133
7134 final boolean hasWindowFocus = hasWindowFocus();
7135 viewStateIndex = (viewStateIndex << 1) + (hasWindowFocus ? 1 : 0);
7136
7137 drawableState = VIEW_STATE_SETS[viewStateIndex];
7138
7139 //noinspection ConstantIfStatement
7140 if (false) {
7141 Log.i("View", "drawableStateIndex=" + viewStateIndex);
7142 Log.i("View", toString()
7143 + " pressed=" + ((privateFlags & PRESSED) != 0)
7144 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
7145 + " fo=" + hasFocus()
7146 + " sl=" + ((privateFlags & SELECTED) != 0)
7147 + " wf=" + hasWindowFocus
7148 + ": " + Arrays.toString(drawableState));
7149 }
7150
7151 if (extraSpace == 0) {
7152 return drawableState;
7153 }
7154
7155 final int[] fullState;
7156 if (drawableState != null) {
7157 fullState = new int[drawableState.length + extraSpace];
7158 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
7159 } else {
7160 fullState = new int[extraSpace];
7161 }
7162
7163 return fullState;
7164 }
7165
7166 /**
7167 * Merge your own state values in <var>additionalState</var> into the base
7168 * state values <var>baseState</var> that were returned by
7169 * {@link #onCreateDrawableState}.
7170 *
7171 * @param baseState The base state values returned by
7172 * {@link #onCreateDrawableState}, which will be modified to also hold your
7173 * own additional state values.
7174 *
7175 * @param additionalState The additional state values you would like
7176 * added to <var>baseState</var>; this array is not modified.
7177 *
7178 * @return As a convenience, the <var>baseState</var> array you originally
7179 * passed into the function is returned.
7180 *
7181 * @see #onCreateDrawableState
7182 */
7183 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
7184 final int N = baseState.length;
7185 int i = N - 1;
7186 while (i >= 0 && baseState[i] == 0) {
7187 i--;
7188 }
7189 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
7190 return baseState;
7191 }
7192
7193 /**
7194 * Sets the background color for this view.
7195 * @param color the color of the background
7196 */
7197 public void setBackgroundColor(int color) {
7198 setBackgroundDrawable(new ColorDrawable(color));
7199 }
7200
7201 /**
7202 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -07007203 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007204 * @param resid The identifier of the resource.
7205 * @attr ref android.R.styleable#View_background
7206 */
7207 public void setBackgroundResource(int resid) {
7208 if (resid != 0 && resid == mBackgroundResource) {
7209 return;
7210 }
7211
7212 Drawable d= null;
7213 if (resid != 0) {
7214 d = mResources.getDrawable(resid);
7215 }
7216 setBackgroundDrawable(d);
7217
7218 mBackgroundResource = resid;
7219 }
7220
7221 /**
7222 * Set the background to a given Drawable, or remove the background. If the
7223 * background has padding, this View's padding is set to the background's
7224 * padding. However, when a background is removed, this View's padding isn't
7225 * touched. If setting the padding is desired, please use
7226 * {@link #setPadding(int, int, int, int)}.
7227 *
7228 * @param d The Drawable to use as the background, or null to remove the
7229 * background
7230 */
7231 public void setBackgroundDrawable(Drawable d) {
7232 boolean requestLayout = false;
7233
7234 mBackgroundResource = 0;
7235
7236 /*
7237 * Regardless of whether we're setting a new background or not, we want
7238 * to clear the previous drawable.
7239 */
7240 if (mBGDrawable != null) {
7241 mBGDrawable.setCallback(null);
7242 unscheduleDrawable(mBGDrawable);
7243 }
7244
7245 if (d != null) {
7246 Rect padding = sThreadLocal.get();
7247 if (padding == null) {
7248 padding = new Rect();
7249 sThreadLocal.set(padding);
7250 }
7251 if (d.getPadding(padding)) {
7252 setPadding(padding.left, padding.top, padding.right, padding.bottom);
7253 }
7254
7255 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
7256 // if it has a different minimum size, we should layout again
7257 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() ||
7258 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) {
7259 requestLayout = true;
7260 }
7261
7262 d.setCallback(this);
7263 if (d.isStateful()) {
7264 d.setState(getDrawableState());
7265 }
7266 d.setVisible(getVisibility() == VISIBLE, false);
7267 mBGDrawable = d;
7268
7269 if ((mPrivateFlags & SKIP_DRAW) != 0) {
7270 mPrivateFlags &= ~SKIP_DRAW;
7271 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
7272 requestLayout = true;
7273 }
7274 } else {
7275 /* Remove the background */
7276 mBGDrawable = null;
7277
7278 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
7279 /*
7280 * This view ONLY drew the background before and we're removing
7281 * the background, so now it won't draw anything
7282 * (hence we SKIP_DRAW)
7283 */
7284 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
7285 mPrivateFlags |= SKIP_DRAW;
7286 }
7287
7288 /*
7289 * When the background is set, we try to apply its padding to this
7290 * View. When the background is removed, we don't touch this View's
7291 * padding. This is noted in the Javadocs. Hence, we don't need to
7292 * requestLayout(), the invalidate() below is sufficient.
7293 */
7294
7295 // The old background's minimum size could have affected this
7296 // View's layout, so let's requestLayout
7297 requestLayout = true;
7298 }
7299
Romain Guy8f1344f52009-05-15 16:03:59 -07007300 computeOpaqueFlags();
7301
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007302 if (requestLayout) {
7303 requestLayout();
7304 }
7305
7306 mBackgroundSizeChanged = true;
7307 invalidate();
7308 }
7309
7310 /**
7311 * Gets the background drawable
7312 * @return The drawable used as the background for this view, if any.
7313 */
7314 public Drawable getBackground() {
7315 return mBGDrawable;
7316 }
7317
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007318 /**
7319 * Sets the padding. The view may add on the space required to display
7320 * the scrollbars, depending on the style and visibility of the scrollbars.
7321 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
7322 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
7323 * from the values set in this call.
7324 *
7325 * @attr ref android.R.styleable#View_padding
7326 * @attr ref android.R.styleable#View_paddingBottom
7327 * @attr ref android.R.styleable#View_paddingLeft
7328 * @attr ref android.R.styleable#View_paddingRight
7329 * @attr ref android.R.styleable#View_paddingTop
7330 * @param left the left padding in pixels
7331 * @param top the top padding in pixels
7332 * @param right the right padding in pixels
7333 * @param bottom the bottom padding in pixels
7334 */
7335 public void setPadding(int left, int top, int right, int bottom) {
7336 boolean changed = false;
7337
7338 mUserPaddingRight = right;
7339 mUserPaddingBottom = bottom;
7340
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007341 final int viewFlags = mViewFlags;
Romain Guy8506ab42009-06-11 17:35:47 -07007342
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007343 // Common case is there are no scroll bars.
7344 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
7345 // TODO: Deal with RTL languages to adjust left padding instead of right.
7346 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
7347 right += (viewFlags & SCROLLBARS_INSET_MASK) == 0
7348 ? 0 : getVerticalScrollbarWidth();
7349 }
7350 if ((viewFlags & SCROLLBARS_HORIZONTAL) == 0) {
7351 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
7352 ? 0 : getHorizontalScrollbarHeight();
7353 }
7354 }
Romain Guy8506ab42009-06-11 17:35:47 -07007355
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007356 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007357 changed = true;
7358 mPaddingLeft = left;
7359 }
7360 if (mPaddingTop != top) {
7361 changed = true;
7362 mPaddingTop = top;
7363 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007364 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007365 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007366 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007367 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007368 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007369 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007370 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007371 }
7372
7373 if (changed) {
7374 requestLayout();
7375 }
7376 }
7377
7378 /**
7379 * Returns the top padding of this view.
7380 *
7381 * @return the top padding in pixels
7382 */
7383 public int getPaddingTop() {
7384 return mPaddingTop;
7385 }
7386
7387 /**
7388 * Returns the bottom padding of this view. If there are inset and enabled
7389 * scrollbars, this value may include the space required to display the
7390 * scrollbars as well.
7391 *
7392 * @return the bottom padding in pixels
7393 */
7394 public int getPaddingBottom() {
7395 return mPaddingBottom;
7396 }
7397
7398 /**
7399 * Returns the left padding of this view. If there are inset and enabled
7400 * scrollbars, this value may include the space required to display the
7401 * scrollbars as well.
7402 *
7403 * @return the left padding in pixels
7404 */
7405 public int getPaddingLeft() {
7406 return mPaddingLeft;
7407 }
7408
7409 /**
7410 * Returns the right padding of this view. If there are inset and enabled
7411 * scrollbars, this value may include the space required to display the
7412 * scrollbars as well.
7413 *
7414 * @return the right padding in pixels
7415 */
7416 public int getPaddingRight() {
7417 return mPaddingRight;
7418 }
7419
7420 /**
7421 * Changes the selection state of this view. A view can be selected or not.
7422 * Note that selection is not the same as focus. Views are typically
7423 * selected in the context of an AdapterView like ListView or GridView;
7424 * the selected view is the view that is highlighted.
7425 *
7426 * @param selected true if the view must be selected, false otherwise
7427 */
7428 public void setSelected(boolean selected) {
7429 if (((mPrivateFlags & SELECTED) != 0) != selected) {
7430 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -07007431 if (!selected) resetPressedState();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007432 invalidate();
7433 refreshDrawableState();
7434 dispatchSetSelected(selected);
7435 }
7436 }
7437
7438 /**
7439 * Dispatch setSelected to all of this View's children.
7440 *
7441 * @see #setSelected(boolean)
7442 *
7443 * @param selected The new selected state
7444 */
7445 protected void dispatchSetSelected(boolean selected) {
7446 }
7447
7448 /**
7449 * Indicates the selection state of this view.
7450 *
7451 * @return true if the view is selected, false otherwise
7452 */
7453 @ViewDebug.ExportedProperty
7454 public boolean isSelected() {
7455 return (mPrivateFlags & SELECTED) != 0;
7456 }
7457
7458 /**
7459 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
7460 * observer can be used to get notifications when global events, like
7461 * layout, happen.
7462 *
7463 * The returned ViewTreeObserver observer is not guaranteed to remain
7464 * valid for the lifetime of this View. If the caller of this method keeps
7465 * a long-lived reference to ViewTreeObserver, it should always check for
7466 * the return value of {@link ViewTreeObserver#isAlive()}.
7467 *
7468 * @return The ViewTreeObserver for this view's hierarchy.
7469 */
7470 public ViewTreeObserver getViewTreeObserver() {
7471 if (mAttachInfo != null) {
7472 return mAttachInfo.mTreeObserver;
7473 }
7474 if (mFloatingTreeObserver == null) {
7475 mFloatingTreeObserver = new ViewTreeObserver();
7476 }
7477 return mFloatingTreeObserver;
7478 }
7479
7480 /**
7481 * <p>Finds the topmost view in the current view hierarchy.</p>
7482 *
7483 * @return the topmost view containing this view
7484 */
7485 public View getRootView() {
7486 if (mAttachInfo != null) {
7487 final View v = mAttachInfo.mRootView;
7488 if (v != null) {
7489 return v;
7490 }
7491 }
Romain Guy8506ab42009-06-11 17:35:47 -07007492
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007493 View parent = this;
7494
7495 while (parent.mParent != null && parent.mParent instanceof View) {
7496 parent = (View) parent.mParent;
7497 }
7498
7499 return parent;
7500 }
7501
7502 /**
7503 * <p>Computes the coordinates of this view on the screen. The argument
7504 * must be an array of two integers. After the method returns, the array
7505 * contains the x and y location in that order.</p>
7506 *
7507 * @param location an array of two integers in which to hold the coordinates
7508 */
7509 public void getLocationOnScreen(int[] location) {
7510 getLocationInWindow(location);
7511
7512 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -07007513 if (info != null) {
7514 location[0] += info.mWindowLeft;
7515 location[1] += info.mWindowTop;
7516 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007517 }
7518
7519 /**
7520 * <p>Computes the coordinates of this view in its window. The argument
7521 * must be an array of two integers. After the method returns, the array
7522 * contains the x and y location in that order.</p>
7523 *
7524 * @param location an array of two integers in which to hold the coordinates
7525 */
7526 public void getLocationInWindow(int[] location) {
7527 if (location == null || location.length < 2) {
7528 throw new IllegalArgumentException("location must be an array of "
7529 + "two integers");
7530 }
7531
7532 location[0] = mLeft;
7533 location[1] = mTop;
7534
7535 ViewParent viewParent = mParent;
7536 while (viewParent instanceof View) {
7537 final View view = (View)viewParent;
7538 location[0] += view.mLeft - view.mScrollX;
7539 location[1] += view.mTop - view.mScrollY;
7540 viewParent = view.mParent;
7541 }
Romain Guy8506ab42009-06-11 17:35:47 -07007542
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007543 if (viewParent instanceof ViewRoot) {
7544 // *cough*
7545 final ViewRoot vr = (ViewRoot)viewParent;
7546 location[1] -= vr.mCurScrollY;
7547 }
7548 }
7549
7550 /**
7551 * {@hide}
7552 * @param id the id of the view to be found
7553 * @return the view of the specified id, null if cannot be found
7554 */
7555 protected View findViewTraversal(int id) {
7556 if (id == mID) {
7557 return this;
7558 }
7559 return null;
7560 }
7561
7562 /**
7563 * {@hide}
7564 * @param tag the tag of the view to be found
7565 * @return the view of specified tag, null if cannot be found
7566 */
7567 protected View findViewWithTagTraversal(Object tag) {
7568 if (tag != null && tag.equals(mTag)) {
7569 return this;
7570 }
7571 return null;
7572 }
7573
7574 /**
7575 * Look for a child view with the given id. If this view has the given
7576 * id, return this view.
7577 *
7578 * @param id The id to search for.
7579 * @return The view that has the given id in the hierarchy or null
7580 */
7581 public final View findViewById(int id) {
7582 if (id < 0) {
7583 return null;
7584 }
7585 return findViewTraversal(id);
7586 }
7587
7588 /**
7589 * Look for a child view with the given tag. If this view has the given
7590 * tag, return this view.
7591 *
7592 * @param tag The tag to search for, using "tag.equals(getTag())".
7593 * @return The View that has the given tag in the hierarchy or null
7594 */
7595 public final View findViewWithTag(Object tag) {
7596 if (tag == null) {
7597 return null;
7598 }
7599 return findViewWithTagTraversal(tag);
7600 }
7601
7602 /**
7603 * Sets the identifier for this view. The identifier does not have to be
7604 * unique in this view's hierarchy. The identifier should be a positive
7605 * number.
7606 *
7607 * @see #NO_ID
7608 * @see #getId
7609 * @see #findViewById
7610 *
7611 * @param id a number used to identify the view
7612 *
7613 * @attr ref android.R.styleable#View_id
7614 */
7615 public void setId(int id) {
7616 mID = id;
7617 }
7618
7619 /**
7620 * {@hide}
7621 *
7622 * @param isRoot true if the view belongs to the root namespace, false
7623 * otherwise
7624 */
7625 public void setIsRootNamespace(boolean isRoot) {
7626 if (isRoot) {
7627 mPrivateFlags |= IS_ROOT_NAMESPACE;
7628 } else {
7629 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
7630 }
7631 }
7632
7633 /**
7634 * {@hide}
7635 *
7636 * @return true if the view belongs to the root namespace, false otherwise
7637 */
7638 public boolean isRootNamespace() {
7639 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
7640 }
7641
7642 /**
7643 * Returns this view's identifier.
7644 *
7645 * @return a positive integer used to identify the view or {@link #NO_ID}
7646 * if the view has no ID
7647 *
7648 * @see #setId
7649 * @see #findViewById
7650 * @attr ref android.R.styleable#View_id
7651 */
7652 @ViewDebug.CapturedViewProperty
7653 public int getId() {
7654 return mID;
7655 }
7656
7657 /**
7658 * Returns this view's tag.
7659 *
7660 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -07007661 *
7662 * @see #setTag(Object)
7663 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007664 */
7665 @ViewDebug.ExportedProperty
7666 public Object getTag() {
7667 return mTag;
7668 }
7669
7670 /**
7671 * Sets the tag associated with this view. A tag can be used to mark
7672 * a view in its hierarchy and does not have to be unique within the
7673 * hierarchy. Tags can also be used to store data within a view without
7674 * resorting to another data structure.
7675 *
7676 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -07007677 *
7678 * @see #getTag()
7679 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007680 */
7681 public void setTag(final Object tag) {
7682 mTag = tag;
7683 }
7684
7685 /**
Romain Guyd90a3312009-05-06 14:54:28 -07007686 * Returns the tag associated with this view and the specified key.
7687 *
7688 * @param key The key identifying the tag
7689 *
7690 * @return the Object stored in this view as a tag
7691 *
7692 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -07007693 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -07007694 */
7695 public Object getTag(int key) {
7696 SparseArray<Object> tags = null;
7697 synchronized (sTagsLock) {
7698 if (sTags != null) {
7699 tags = sTags.get(this);
7700 }
7701 }
7702
7703 if (tags != null) return tags.get(key);
7704 return null;
7705 }
7706
7707 /**
7708 * Sets a tag associated with this view and a key. A tag can be used
7709 * to mark a view in its hierarchy and does not have to be unique within
7710 * the hierarchy. Tags can also be used to store data within a view
7711 * without resorting to another data structure.
7712 *
7713 * The specified key should be an id declared in the resources of the
7714 * application to ensure it is unique. Keys identified as belonging to
7715 * the Android framework or not associated with any package will cause
7716 * an {@link IllegalArgumentException} to be thrown.
7717 *
7718 * @param key The key identifying the tag
7719 * @param tag An Object to tag the view with
7720 *
7721 * @throws IllegalArgumentException If they specified key is not valid
7722 *
7723 * @see #setTag(Object)
7724 * @see #getTag(int)
7725 */
7726 public void setTag(int key, final Object tag) {
7727 // If the package id is 0x00 or 0x01, it's either an undefined package
7728 // or a framework id
7729 if ((key >>> 24) < 2) {
7730 throw new IllegalArgumentException("The key must be an application-specific "
7731 + "resource id.");
7732 }
7733
7734 setTagInternal(this, key, tag);
7735 }
7736
7737 /**
7738 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
7739 * framework id.
7740 *
7741 * @hide
7742 */
7743 public void setTagInternal(int key, Object tag) {
7744 if ((key >>> 24) != 0x1) {
7745 throw new IllegalArgumentException("The key must be a framework-specific "
7746 + "resource id.");
7747 }
7748
Romain Guy8506ab42009-06-11 17:35:47 -07007749 setTagInternal(this, key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -07007750 }
7751
7752 private static void setTagInternal(View view, int key, Object tag) {
7753 SparseArray<Object> tags = null;
7754 synchronized (sTagsLock) {
7755 if (sTags == null) {
7756 sTags = new WeakHashMap<View, SparseArray<Object>>();
7757 } else {
7758 tags = sTags.get(view);
7759 }
7760 }
7761
7762 if (tags == null) {
7763 tags = new SparseArray<Object>(2);
7764 synchronized (sTagsLock) {
7765 sTags.put(view, tags);
7766 }
7767 }
7768
7769 tags.put(key, tag);
7770 }
7771
7772 /**
Romain Guy13922e02009-05-12 17:56:14 -07007773 * @param consistency The type of consistency. See ViewDebug for more information.
7774 *
7775 * @hide
7776 */
7777 protected boolean dispatchConsistencyCheck(int consistency) {
7778 return onConsistencyCheck(consistency);
7779 }
7780
7781 /**
7782 * Method that subclasses should implement to check their consistency. The type of
7783 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -07007784 *
Romain Guy13922e02009-05-12 17:56:14 -07007785 * @param consistency The type of consistency. See ViewDebug for more information.
7786 *
7787 * @throws IllegalStateException if the view is in an inconsistent state.
7788 *
7789 * @hide
7790 */
7791 protected boolean onConsistencyCheck(int consistency) {
7792 boolean result = true;
7793
7794 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
7795 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
7796
7797 if (checkLayout) {
7798 if (getParent() == null) {
7799 result = false;
7800 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
7801 "View " + this + " does not have a parent.");
7802 }
7803
7804 if (mAttachInfo == null) {
7805 result = false;
7806 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
7807 "View " + this + " is not attached to a window.");
7808 }
7809 }
7810
7811 if (checkDrawing) {
7812 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
7813 // from their draw() method
7814
7815 if ((mPrivateFlags & DRAWN) != DRAWN &&
7816 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
7817 result = false;
7818 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
7819 "View " + this + " was invalidated but its drawing cache is valid.");
7820 }
7821 }
7822
7823 return result;
7824 }
7825
7826 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007827 * Prints information about this view in the log output, with the tag
7828 * {@link #VIEW_LOG_TAG}.
7829 *
7830 * @hide
7831 */
7832 public void debug() {
7833 debug(0);
7834 }
7835
7836 /**
7837 * Prints information about this view in the log output, with the tag
7838 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
7839 * indentation defined by the <code>depth</code>.
7840 *
7841 * @param depth the indentation level
7842 *
7843 * @hide
7844 */
7845 protected void debug(int depth) {
7846 String output = debugIndent(depth - 1);
7847
7848 output += "+ " + this;
7849 int id = getId();
7850 if (id != -1) {
7851 output += " (id=" + id + ")";
7852 }
7853 Object tag = getTag();
7854 if (tag != null) {
7855 output += " (tag=" + tag + ")";
7856 }
7857 Log.d(VIEW_LOG_TAG, output);
7858
7859 if ((mPrivateFlags & FOCUSED) != 0) {
7860 output = debugIndent(depth) + " FOCUSED";
7861 Log.d(VIEW_LOG_TAG, output);
7862 }
7863
7864 output = debugIndent(depth);
7865 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
7866 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
7867 + "} ";
7868 Log.d(VIEW_LOG_TAG, output);
7869
7870 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
7871 || mPaddingBottom != 0) {
7872 output = debugIndent(depth);
7873 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
7874 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
7875 Log.d(VIEW_LOG_TAG, output);
7876 }
7877
7878 output = debugIndent(depth);
7879 output += "mMeasureWidth=" + mMeasuredWidth +
7880 " mMeasureHeight=" + mMeasuredHeight;
7881 Log.d(VIEW_LOG_TAG, output);
7882
7883 output = debugIndent(depth);
7884 if (mLayoutParams == null) {
7885 output += "BAD! no layout params";
7886 } else {
7887 output = mLayoutParams.debug(output);
7888 }
7889 Log.d(VIEW_LOG_TAG, output);
7890
7891 output = debugIndent(depth);
7892 output += "flags={";
7893 output += View.printFlags(mViewFlags);
7894 output += "}";
7895 Log.d(VIEW_LOG_TAG, output);
7896
7897 output = debugIndent(depth);
7898 output += "privateFlags={";
7899 output += View.printPrivateFlags(mPrivateFlags);
7900 output += "}";
7901 Log.d(VIEW_LOG_TAG, output);
7902 }
7903
7904 /**
7905 * Creates an string of whitespaces used for indentation.
7906 *
7907 * @param depth the indentation level
7908 * @return a String containing (depth * 2 + 3) * 2 white spaces
7909 *
7910 * @hide
7911 */
7912 protected static String debugIndent(int depth) {
7913 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
7914 for (int i = 0; i < (depth * 2) + 3; i++) {
7915 spaces.append(' ').append(' ');
7916 }
7917 return spaces.toString();
7918 }
7919
7920 /**
7921 * <p>Return the offset of the widget's text baseline from the widget's top
7922 * boundary. If this widget does not support baseline alignment, this
7923 * method returns -1. </p>
7924 *
7925 * @return the offset of the baseline within the widget's bounds or -1
7926 * if baseline alignment is not supported
7927 */
7928 @ViewDebug.ExportedProperty
7929 public int getBaseline() {
7930 return -1;
7931 }
7932
7933 /**
7934 * Call this when something has changed which has invalidated the
7935 * layout of this view. This will schedule a layout pass of the view
7936 * tree.
7937 */
7938 public void requestLayout() {
7939 if (ViewDebug.TRACE_HIERARCHY) {
7940 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
7941 }
7942
7943 mPrivateFlags |= FORCE_LAYOUT;
7944
7945 if (mParent != null && !mParent.isLayoutRequested()) {
7946 mParent.requestLayout();
7947 }
7948 }
7949
7950 /**
7951 * Forces this view to be laid out during the next layout pass.
7952 * This method does not call requestLayout() or forceLayout()
7953 * on the parent.
7954 */
7955 public void forceLayout() {
7956 mPrivateFlags |= FORCE_LAYOUT;
7957 }
7958
7959 /**
7960 * <p>
7961 * This is called to find out how big a view should be. The parent
7962 * supplies constraint information in the width and height parameters.
7963 * </p>
7964 *
7965 * <p>
7966 * The actual mesurement work of a view is performed in
7967 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
7968 * {@link #onMeasure(int, int)} can and must be overriden by subclasses.
7969 * </p>
7970 *
7971 *
7972 * @param widthMeasureSpec Horizontal space requirements as imposed by the
7973 * parent
7974 * @param heightMeasureSpec Vertical space requirements as imposed by the
7975 * parent
7976 *
7977 * @see #onMeasure(int, int)
7978 */
7979 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
7980 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
7981 widthMeasureSpec != mOldWidthMeasureSpec ||
7982 heightMeasureSpec != mOldHeightMeasureSpec) {
7983
7984 // first clears the measured dimension flag
7985 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
7986
7987 if (ViewDebug.TRACE_HIERARCHY) {
7988 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
7989 }
7990
7991 // measure ourselves, this should set the measured dimension flag back
7992 onMeasure(widthMeasureSpec, heightMeasureSpec);
7993
7994 // flag not set, setMeasuredDimension() was not invoked, we raise
7995 // an exception to warn the developer
7996 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
7997 throw new IllegalStateException("onMeasure() did not set the"
7998 + " measured dimension by calling"
7999 + " setMeasuredDimension()");
8000 }
8001
8002 mPrivateFlags |= LAYOUT_REQUIRED;
8003 }
8004
8005 mOldWidthMeasureSpec = widthMeasureSpec;
8006 mOldHeightMeasureSpec = heightMeasureSpec;
8007 }
8008
8009 /**
8010 * <p>
8011 * Measure the view and its content to determine the measured width and the
8012 * measured height. This method is invoked by {@link #measure(int, int)} and
8013 * should be overriden by subclasses to provide accurate and efficient
8014 * measurement of their contents.
8015 * </p>
8016 *
8017 * <p>
8018 * <strong>CONTRACT:</strong> When overriding this method, you
8019 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
8020 * measured width and height of this view. Failure to do so will trigger an
8021 * <code>IllegalStateException</code>, thrown by
8022 * {@link #measure(int, int)}. Calling the superclass'
8023 * {@link #onMeasure(int, int)} is a valid use.
8024 * </p>
8025 *
8026 * <p>
8027 * The base class implementation of measure defaults to the background size,
8028 * unless a larger size is allowed by the MeasureSpec. Subclasses should
8029 * override {@link #onMeasure(int, int)} to provide better measurements of
8030 * their content.
8031 * </p>
8032 *
8033 * <p>
8034 * If this method is overridden, it is the subclass's responsibility to make
8035 * sure the measured height and width are at least the view's minimum height
8036 * and width ({@link #getSuggestedMinimumHeight()} and
8037 * {@link #getSuggestedMinimumWidth()}).
8038 * </p>
8039 *
8040 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
8041 * The requirements are encoded with
8042 * {@link android.view.View.MeasureSpec}.
8043 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
8044 * The requirements are encoded with
8045 * {@link android.view.View.MeasureSpec}.
8046 *
8047 * @see #getMeasuredWidth()
8048 * @see #getMeasuredHeight()
8049 * @see #setMeasuredDimension(int, int)
8050 * @see #getSuggestedMinimumHeight()
8051 * @see #getSuggestedMinimumWidth()
8052 * @see android.view.View.MeasureSpec#getMode(int)
8053 * @see android.view.View.MeasureSpec#getSize(int)
8054 */
8055 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
8056 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
8057 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
8058 }
8059
8060 /**
8061 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
8062 * measured width and measured height. Failing to do so will trigger an
8063 * exception at measurement time.</p>
8064 *
8065 * @param measuredWidth the measured width of this view
8066 * @param measuredHeight the measured height of this view
8067 */
8068 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
8069 mMeasuredWidth = measuredWidth;
8070 mMeasuredHeight = measuredHeight;
8071
8072 mPrivateFlags |= MEASURED_DIMENSION_SET;
8073 }
8074
8075 /**
8076 * Utility to reconcile a desired size with constraints imposed by a MeasureSpec.
8077 * Will take the desired size, unless a different size is imposed by the constraints.
8078 *
8079 * @param size How big the view wants to be
8080 * @param measureSpec Constraints imposed by the parent
8081 * @return The size this view should be.
8082 */
8083 public static int resolveSize(int size, int measureSpec) {
8084 int result = size;
8085 int specMode = MeasureSpec.getMode(measureSpec);
8086 int specSize = MeasureSpec.getSize(measureSpec);
8087 switch (specMode) {
8088 case MeasureSpec.UNSPECIFIED:
8089 result = size;
8090 break;
8091 case MeasureSpec.AT_MOST:
8092 result = Math.min(size, specSize);
8093 break;
8094 case MeasureSpec.EXACTLY:
8095 result = specSize;
8096 break;
8097 }
8098 return result;
8099 }
8100
8101 /**
8102 * Utility to return a default size. Uses the supplied size if the
8103 * MeasureSpec imposed no contraints. Will get larger if allowed
8104 * by the MeasureSpec.
8105 *
8106 * @param size Default size for this view
8107 * @param measureSpec Constraints imposed by the parent
8108 * @return The size this view should be.
8109 */
8110 public static int getDefaultSize(int size, int measureSpec) {
8111 int result = size;
8112 int specMode = MeasureSpec.getMode(measureSpec);
8113 int specSize = MeasureSpec.getSize(measureSpec);
8114
8115 switch (specMode) {
8116 case MeasureSpec.UNSPECIFIED:
8117 result = size;
8118 break;
8119 case MeasureSpec.AT_MOST:
8120 case MeasureSpec.EXACTLY:
8121 result = specSize;
8122 break;
8123 }
8124 return result;
8125 }
8126
8127 /**
8128 * Returns the suggested minimum height that the view should use. This
8129 * returns the maximum of the view's minimum height
8130 * and the background's minimum height
8131 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
8132 * <p>
8133 * When being used in {@link #onMeasure(int, int)}, the caller should still
8134 * ensure the returned height is within the requirements of the parent.
8135 *
8136 * @return The suggested minimum height of the view.
8137 */
8138 protected int getSuggestedMinimumHeight() {
8139 int suggestedMinHeight = mMinHeight;
8140
8141 if (mBGDrawable != null) {
8142 final int bgMinHeight = mBGDrawable.getMinimumHeight();
8143 if (suggestedMinHeight < bgMinHeight) {
8144 suggestedMinHeight = bgMinHeight;
8145 }
8146 }
8147
8148 return suggestedMinHeight;
8149 }
8150
8151 /**
8152 * Returns the suggested minimum width that the view should use. This
8153 * returns the maximum of the view's minimum width)
8154 * and the background's minimum width
8155 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
8156 * <p>
8157 * When being used in {@link #onMeasure(int, int)}, the caller should still
8158 * ensure the returned width is within the requirements of the parent.
8159 *
8160 * @return The suggested minimum width of the view.
8161 */
8162 protected int getSuggestedMinimumWidth() {
8163 int suggestedMinWidth = mMinWidth;
8164
8165 if (mBGDrawable != null) {
8166 final int bgMinWidth = mBGDrawable.getMinimumWidth();
8167 if (suggestedMinWidth < bgMinWidth) {
8168 suggestedMinWidth = bgMinWidth;
8169 }
8170 }
8171
8172 return suggestedMinWidth;
8173 }
8174
8175 /**
8176 * Sets the minimum height of the view. It is not guaranteed the view will
8177 * be able to achieve this minimum height (for example, if its parent layout
8178 * constrains it with less available height).
8179 *
8180 * @param minHeight The minimum height the view will try to be.
8181 */
8182 public void setMinimumHeight(int minHeight) {
8183 mMinHeight = minHeight;
8184 }
8185
8186 /**
8187 * Sets the minimum width of the view. It is not guaranteed the view will
8188 * be able to achieve this minimum width (for example, if its parent layout
8189 * constrains it with less available width).
8190 *
8191 * @param minWidth The minimum width the view will try to be.
8192 */
8193 public void setMinimumWidth(int minWidth) {
8194 mMinWidth = minWidth;
8195 }
8196
8197 /**
8198 * Get the animation currently associated with this view.
8199 *
8200 * @return The animation that is currently playing or
8201 * scheduled to play for this view.
8202 */
8203 public Animation getAnimation() {
8204 return mCurrentAnimation;
8205 }
8206
8207 /**
8208 * Start the specified animation now.
8209 *
8210 * @param animation the animation to start now
8211 */
8212 public void startAnimation(Animation animation) {
8213 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
8214 setAnimation(animation);
8215 invalidate();
8216 }
8217
8218 /**
8219 * Cancels any animations for this view.
8220 */
8221 public void clearAnimation() {
8222 mCurrentAnimation = null;
8223 }
8224
8225 /**
8226 * Sets the next animation to play for this view.
8227 * If you want the animation to play immediately, use
8228 * startAnimation. This method provides allows fine-grained
8229 * control over the start time and invalidation, but you
8230 * must make sure that 1) the animation has a start time set, and
8231 * 2) the view will be invalidated when the animation is supposed to
8232 * start.
8233 *
8234 * @param animation The next animation, or null.
8235 */
8236 public void setAnimation(Animation animation) {
8237 mCurrentAnimation = animation;
8238 if (animation != null) {
8239 animation.reset();
8240 }
8241 }
8242
8243 /**
8244 * Invoked by a parent ViewGroup to notify the start of the animation
8245 * currently associated with this view. If you override this method,
8246 * always call super.onAnimationStart();
8247 *
8248 * @see #setAnimation(android.view.animation.Animation)
8249 * @see #getAnimation()
8250 */
8251 protected void onAnimationStart() {
8252 mPrivateFlags |= ANIMATION_STARTED;
8253 }
8254
8255 /**
8256 * Invoked by a parent ViewGroup to notify the end of the animation
8257 * currently associated with this view. If you override this method,
8258 * always call super.onAnimationEnd();
8259 *
8260 * @see #setAnimation(android.view.animation.Animation)
8261 * @see #getAnimation()
8262 */
8263 protected void onAnimationEnd() {
8264 mPrivateFlags &= ~ANIMATION_STARTED;
8265 }
8266
8267 /**
8268 * Invoked if there is a Transform that involves alpha. Subclass that can
8269 * draw themselves with the specified alpha should return true, and then
8270 * respect that alpha when their onDraw() is called. If this returns false
8271 * then the view may be redirected to draw into an offscreen buffer to
8272 * fulfill the request, which will look fine, but may be slower than if the
8273 * subclass handles it internally. The default implementation returns false.
8274 *
8275 * @param alpha The alpha (0..255) to apply to the view's drawing
8276 * @return true if the view can draw with the specified alpha.
8277 */
8278 protected boolean onSetAlpha(int alpha) {
8279 return false;
8280 }
8281
8282 /**
8283 * This is used by the RootView to perform an optimization when
8284 * the view hierarchy contains one or several SurfaceView.
8285 * SurfaceView is always considered transparent, but its children are not,
8286 * therefore all View objects remove themselves from the global transparent
8287 * region (passed as a parameter to this function).
8288 *
8289 * @param region The transparent region for this ViewRoot (window).
8290 *
8291 * @return Returns true if the effective visibility of the view at this
8292 * point is opaque, regardless of the transparent region; returns false
8293 * if it is possible for underlying windows to be seen behind the view.
8294 *
8295 * {@hide}
8296 */
8297 public boolean gatherTransparentRegion(Region region) {
8298 final AttachInfo attachInfo = mAttachInfo;
8299 if (region != null && attachInfo != null) {
8300 final int pflags = mPrivateFlags;
8301 if ((pflags & SKIP_DRAW) == 0) {
8302 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
8303 // remove it from the transparent region.
8304 final int[] location = attachInfo.mTransparentLocation;
8305 getLocationInWindow(location);
8306 region.op(location[0], location[1], location[0] + mRight - mLeft,
8307 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
8308 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) {
8309 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
8310 // exists, so we remove the background drawable's non-transparent
8311 // parts from this transparent region.
8312 applyDrawableToTransparentRegion(mBGDrawable, region);
8313 }
8314 }
8315 return true;
8316 }
8317
8318 /**
8319 * Play a sound effect for this view.
8320 *
8321 * <p>The framework will play sound effects for some built in actions, such as
8322 * clicking, but you may wish to play these effects in your widget,
8323 * for instance, for internal navigation.
8324 *
8325 * <p>The sound effect will only be played if sound effects are enabled by the user, and
8326 * {@link #isSoundEffectsEnabled()} is true.
8327 *
8328 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
8329 */
8330 public void playSoundEffect(int soundConstant) {
8331 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
8332 return;
8333 }
8334 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
8335 }
8336
8337 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -07008338 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -07008339 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -07008340 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008341 *
8342 * <p>The framework will provide haptic feedback for some built in actions,
8343 * such as long presses, but you may wish to provide feedback for your
8344 * own widget.
8345 *
8346 * <p>The feedback will only be performed if
8347 * {@link #isHapticFeedbackEnabled()} is true.
8348 *
8349 * @param feedbackConstant One of the constants defined in
8350 * {@link HapticFeedbackConstants}
8351 */
8352 public boolean performHapticFeedback(int feedbackConstant) {
8353 return performHapticFeedback(feedbackConstant, 0);
8354 }
8355
8356 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -07008357 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -07008358 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -07008359 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008360 *
8361 * @param feedbackConstant One of the constants defined in
8362 * {@link HapticFeedbackConstants}
8363 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
8364 */
8365 public boolean performHapticFeedback(int feedbackConstant, int flags) {
8366 if (mAttachInfo == null) {
8367 return false;
8368 }
8369 if ((flags&HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
8370 && !isHapticFeedbackEnabled()) {
8371 return false;
8372 }
8373 return mAttachInfo.mRootCallbacks.performHapticFeedback(
8374 feedbackConstant,
8375 (flags&HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
8376 }
8377
8378 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -07008379 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
8380 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -07008381 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -07008382 */
8383 public void onCloseSystemDialogs(String reason) {
8384 }
8385
8386 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008387 * Given a Drawable whose bounds have been set to draw into this view,
8388 * update a Region being computed for {@link #gatherTransparentRegion} so
8389 * that any non-transparent parts of the Drawable are removed from the
8390 * given transparent region.
8391 *
8392 * @param dr The Drawable whose transparency is to be applied to the region.
8393 * @param region A Region holding the current transparency information,
8394 * where any parts of the region that are set are considered to be
8395 * transparent. On return, this region will be modified to have the
8396 * transparency information reduced by the corresponding parts of the
8397 * Drawable that are not transparent.
8398 * {@hide}
8399 */
8400 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
8401 if (DBG) {
8402 Log.i("View", "Getting transparent region for: " + this);
8403 }
8404 final Region r = dr.getTransparentRegion();
8405 final Rect db = dr.getBounds();
8406 final AttachInfo attachInfo = mAttachInfo;
8407 if (r != null && attachInfo != null) {
8408 final int w = getRight()-getLeft();
8409 final int h = getBottom()-getTop();
8410 if (db.left > 0) {
8411 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
8412 r.op(0, 0, db.left, h, Region.Op.UNION);
8413 }
8414 if (db.right < w) {
8415 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
8416 r.op(db.right, 0, w, h, Region.Op.UNION);
8417 }
8418 if (db.top > 0) {
8419 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
8420 r.op(0, 0, w, db.top, Region.Op.UNION);
8421 }
8422 if (db.bottom < h) {
8423 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
8424 r.op(0, db.bottom, w, h, Region.Op.UNION);
8425 }
8426 final int[] location = attachInfo.mTransparentLocation;
8427 getLocationInWindow(location);
8428 r.translate(location[0], location[1]);
8429 region.op(r, Region.Op.INTERSECT);
8430 } else {
8431 region.op(db, Region.Op.DIFFERENCE);
8432 }
8433 }
8434
8435 private void postCheckForLongClick() {
8436 mHasPerformedLongPress = false;
8437
8438 if (mPendingCheckForLongPress == null) {
8439 mPendingCheckForLongPress = new CheckForLongPress();
8440 }
8441 mPendingCheckForLongPress.rememberWindowAttachCount();
8442 postDelayed(mPendingCheckForLongPress, ViewConfiguration.getLongPressTimeout());
8443 }
8444
8445 private static int[] stateSetUnion(final int[] stateSet1,
8446 final int[] stateSet2) {
8447 final int stateSet1Length = stateSet1.length;
8448 final int stateSet2Length = stateSet2.length;
8449 final int[] newSet = new int[stateSet1Length + stateSet2Length];
8450 int k = 0;
8451 int i = 0;
8452 int j = 0;
8453 // This is a merge of the two input state sets and assumes that the
8454 // input sets are sorted by the order imposed by ViewDrawableStates.
8455 for (int viewState : R.styleable.ViewDrawableStates) {
8456 if (i < stateSet1Length && stateSet1[i] == viewState) {
8457 newSet[k++] = viewState;
8458 i++;
8459 } else if (j < stateSet2Length && stateSet2[j] == viewState) {
8460 newSet[k++] = viewState;
8461 j++;
8462 }
8463 if (k > 1) {
8464 assert(newSet[k - 1] > newSet[k - 2]);
8465 }
8466 }
8467 return newSet;
8468 }
8469
8470 /**
8471 * Inflate a view from an XML resource. This convenience method wraps the {@link
8472 * LayoutInflater} class, which provides a full range of options for view inflation.
8473 *
8474 * @param context The Context object for your activity or application.
8475 * @param resource The resource ID to inflate
8476 * @param root A view group that will be the parent. Used to properly inflate the
8477 * layout_* parameters.
8478 * @see LayoutInflater
8479 */
8480 public static View inflate(Context context, int resource, ViewGroup root) {
8481 LayoutInflater factory = LayoutInflater.from(context);
8482 return factory.inflate(resource, root);
8483 }
8484
8485 /**
8486 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
8487 * Each MeasureSpec represents a requirement for either the width or the height.
8488 * A MeasureSpec is comprised of a size and a mode. There are three possible
8489 * modes:
8490 * <dl>
8491 * <dt>UNSPECIFIED</dt>
8492 * <dd>
8493 * The parent has not imposed any constraint on the child. It can be whatever size
8494 * it wants.
8495 * </dd>
8496 *
8497 * <dt>EXACTLY</dt>
8498 * <dd>
8499 * The parent has determined an exact size for the child. The child is going to be
8500 * given those bounds regardless of how big it wants to be.
8501 * </dd>
8502 *
8503 * <dt>AT_MOST</dt>
8504 * <dd>
8505 * The child can be as large as it wants up to the specified size.
8506 * </dd>
8507 * </dl>
8508 *
8509 * MeasureSpecs are implemented as ints to reduce object allocation. This class
8510 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
8511 */
8512 public static class MeasureSpec {
8513 private static final int MODE_SHIFT = 30;
8514 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
8515
8516 /**
8517 * Measure specification mode: The parent has not imposed any constraint
8518 * on the child. It can be whatever size it wants.
8519 */
8520 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
8521
8522 /**
8523 * Measure specification mode: The parent has determined an exact size
8524 * for the child. The child is going to be given those bounds regardless
8525 * of how big it wants to be.
8526 */
8527 public static final int EXACTLY = 1 << MODE_SHIFT;
8528
8529 /**
8530 * Measure specification mode: The child can be as large as it wants up
8531 * to the specified size.
8532 */
8533 public static final int AT_MOST = 2 << MODE_SHIFT;
8534
8535 /**
8536 * Creates a measure specification based on the supplied size and mode.
8537 *
8538 * The mode must always be one of the following:
8539 * <ul>
8540 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
8541 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
8542 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
8543 * </ul>
8544 *
8545 * @param size the size of the measure specification
8546 * @param mode the mode of the measure specification
8547 * @return the measure specification based on size and mode
8548 */
8549 public static int makeMeasureSpec(int size, int mode) {
8550 return size + mode;
8551 }
8552
8553 /**
8554 * Extracts the mode from the supplied measure specification.
8555 *
8556 * @param measureSpec the measure specification to extract the mode from
8557 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
8558 * {@link android.view.View.MeasureSpec#AT_MOST} or
8559 * {@link android.view.View.MeasureSpec#EXACTLY}
8560 */
8561 public static int getMode(int measureSpec) {
8562 return (measureSpec & MODE_MASK);
8563 }
8564
8565 /**
8566 * Extracts the size from the supplied measure specification.
8567 *
8568 * @param measureSpec the measure specification to extract the size from
8569 * @return the size in pixels defined in the supplied measure specification
8570 */
8571 public static int getSize(int measureSpec) {
8572 return (measureSpec & ~MODE_MASK);
8573 }
8574
8575 /**
8576 * Returns a String representation of the specified measure
8577 * specification.
8578 *
8579 * @param measureSpec the measure specification to convert to a String
8580 * @return a String with the following format: "MeasureSpec: MODE SIZE"
8581 */
8582 public static String toString(int measureSpec) {
8583 int mode = getMode(measureSpec);
8584 int size = getSize(measureSpec);
8585
8586 StringBuilder sb = new StringBuilder("MeasureSpec: ");
8587
8588 if (mode == UNSPECIFIED)
8589 sb.append("UNSPECIFIED ");
8590 else if (mode == EXACTLY)
8591 sb.append("EXACTLY ");
8592 else if (mode == AT_MOST)
8593 sb.append("AT_MOST ");
8594 else
8595 sb.append(mode).append(" ");
8596
8597 sb.append(size);
8598 return sb.toString();
8599 }
8600 }
8601
8602 class CheckForLongPress implements Runnable {
8603
8604 private int mOriginalWindowAttachCount;
8605
8606 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -07008607 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008608 && mOriginalWindowAttachCount == mWindowAttachCount) {
8609 if (performLongClick()) {
8610 mHasPerformedLongPress = true;
8611 }
8612 }
8613 }
8614
8615 public void rememberWindowAttachCount() {
8616 mOriginalWindowAttachCount = mWindowAttachCount;
8617 }
8618 }
8619
8620 /**
8621 * Interface definition for a callback to be invoked when a key event is
8622 * dispatched to this view. The callback will be invoked before the key
8623 * event is given to the view.
8624 */
8625 public interface OnKeyListener {
8626 /**
8627 * Called when a key is dispatched to a view. This allows listeners to
8628 * get a chance to respond before the target view.
8629 *
8630 * @param v The view the key has been dispatched to.
8631 * @param keyCode The code for the physical key that was pressed
8632 * @param event The KeyEvent object containing full information about
8633 * the event.
8634 * @return True if the listener has consumed the event, false otherwise.
8635 */
8636 boolean onKey(View v, int keyCode, KeyEvent event);
8637 }
8638
8639 /**
8640 * Interface definition for a callback to be invoked when a touch event is
8641 * dispatched to this view. The callback will be invoked before the touch
8642 * event is given to the view.
8643 */
8644 public interface OnTouchListener {
8645 /**
8646 * Called when a touch event is dispatched to a view. This allows listeners to
8647 * get a chance to respond before the target view.
8648 *
8649 * @param v The view the touch event has been dispatched to.
8650 * @param event The MotionEvent object containing full information about
8651 * the event.
8652 * @return True if the listener has consumed the event, false otherwise.
8653 */
8654 boolean onTouch(View v, MotionEvent event);
8655 }
8656
8657 /**
8658 * Interface definition for a callback to be invoked when a view has been clicked and held.
8659 */
8660 public interface OnLongClickListener {
8661 /**
8662 * Called when a view has been clicked and held.
8663 *
8664 * @param v The view that was clicked and held.
8665 *
8666 * return True if the callback consumed the long click, false otherwise
8667 */
8668 boolean onLongClick(View v);
8669 }
8670
8671 /**
8672 * Interface definition for a callback to be invoked when the focus state of
8673 * a view changed.
8674 */
8675 public interface OnFocusChangeListener {
8676 /**
8677 * Called when the focus state of a view has changed.
8678 *
8679 * @param v The view whose state has changed.
8680 * @param hasFocus The new focus state of v.
8681 */
8682 void onFocusChange(View v, boolean hasFocus);
8683 }
8684
8685 /**
8686 * Interface definition for a callback to be invoked when a view is clicked.
8687 */
8688 public interface OnClickListener {
8689 /**
8690 * Called when a view has been clicked.
8691 *
8692 * @param v The view that was clicked.
8693 */
8694 void onClick(View v);
8695 }
8696
8697 /**
8698 * Interface definition for a callback to be invoked when the context menu
8699 * for this view is being built.
8700 */
8701 public interface OnCreateContextMenuListener {
8702 /**
8703 * Called when the context menu for this view is being built. It is not
8704 * safe to hold onto the menu after this method returns.
8705 *
8706 * @param menu The context menu that is being built
8707 * @param v The view for which the context menu is being built
8708 * @param menuInfo Extra information about the item for which the
8709 * context menu should be shown. This information will vary
8710 * depending on the class of v.
8711 */
8712 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
8713 }
8714
8715 private final class UnsetPressedState implements Runnable {
8716 public void run() {
8717 setPressed(false);
8718 }
8719 }
8720
8721 /**
8722 * Base class for derived classes that want to save and restore their own
8723 * state in {@link android.view.View#onSaveInstanceState()}.
8724 */
8725 public static class BaseSavedState extends AbsSavedState {
8726 /**
8727 * Constructor used when reading from a parcel. Reads the state of the superclass.
8728 *
8729 * @param source
8730 */
8731 public BaseSavedState(Parcel source) {
8732 super(source);
8733 }
8734
8735 /**
8736 * Constructor called by derived classes when creating their SavedState objects
8737 *
8738 * @param superState The state of the superclass of this view
8739 */
8740 public BaseSavedState(Parcelable superState) {
8741 super(superState);
8742 }
8743
8744 public static final Parcelable.Creator<BaseSavedState> CREATOR =
8745 new Parcelable.Creator<BaseSavedState>() {
8746 public BaseSavedState createFromParcel(Parcel in) {
8747 return new BaseSavedState(in);
8748 }
8749
8750 public BaseSavedState[] newArray(int size) {
8751 return new BaseSavedState[size];
8752 }
8753 };
8754 }
8755
8756 /**
8757 * A set of information given to a view when it is attached to its parent
8758 * window.
8759 */
8760 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008761 interface Callbacks {
8762 void playSoundEffect(int effectId);
8763 boolean performHapticFeedback(int effectId, boolean always);
8764 }
8765
8766 /**
8767 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
8768 * to a Handler. This class contains the target (View) to invalidate and
8769 * the coordinates of the dirty rectangle.
8770 *
8771 * For performance purposes, this class also implements a pool of up to
8772 * POOL_LIMIT objects that get reused. This reduces memory allocations
8773 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008774 */
Romain Guyd928d682009-03-31 17:52:16 -07008775 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008776 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -07008777 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
8778 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -07008779 public InvalidateInfo newInstance() {
8780 return new InvalidateInfo();
8781 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008782
Romain Guyd928d682009-03-31 17:52:16 -07008783 public void onAcquired(InvalidateInfo element) {
8784 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008785
Romain Guyd928d682009-03-31 17:52:16 -07008786 public void onReleased(InvalidateInfo element) {
8787 }
8788 }, POOL_LIMIT)
8789 );
8790
8791 private InvalidateInfo mNext;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008792
8793 View target;
8794
8795 int left;
8796 int top;
8797 int right;
8798 int bottom;
8799
Romain Guyd928d682009-03-31 17:52:16 -07008800 public void setNextPoolable(InvalidateInfo element) {
8801 mNext = element;
8802 }
8803
8804 public InvalidateInfo getNextPoolable() {
8805 return mNext;
8806 }
8807
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008808 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -07008809 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008810 }
8811
8812 void release() {
Romain Guyd928d682009-03-31 17:52:16 -07008813 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008814 }
8815 }
8816
8817 final IWindowSession mSession;
8818
8819 final IWindow mWindow;
8820
8821 final IBinder mWindowToken;
8822
8823 final Callbacks mRootCallbacks;
8824
8825 /**
8826 * The top view of the hierarchy.
8827 */
8828 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -07008829
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008830 IBinder mPanelParentWindowToken;
8831 Surface mSurface;
8832
8833 /**
Romain Guy8506ab42009-06-11 17:35:47 -07008834 * Scale factor used by the compatibility mode
8835 */
8836 float mApplicationScale;
8837
8838 /**
8839 * Indicates whether the application is in compatibility mode
8840 */
8841 boolean mScalingRequired;
8842
8843 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008844 * Left position of this view's window
8845 */
8846 int mWindowLeft;
8847
8848 /**
8849 * Top position of this view's window
8850 */
8851 int mWindowTop;
8852
8853 /**
Romain Guy35b38ce2009-10-07 13:38:55 -07008854 * Indicates whether the window is translucent/transparent
8855 */
8856 boolean mTranslucentWindow;
8857
8858 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008859 * For windows that are full-screen but using insets to layout inside
8860 * of the screen decorations, these are the current insets for the
8861 * content of the window.
8862 */
8863 final Rect mContentInsets = new Rect();
8864
8865 /**
8866 * For windows that are full-screen but using insets to layout inside
8867 * of the screen decorations, these are the current insets for the
8868 * actual visible parts of the window.
8869 */
8870 final Rect mVisibleInsets = new Rect();
8871
8872 /**
8873 * The internal insets given by this window. This value is
8874 * supplied by the client (through
8875 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
8876 * be given to the window manager when changed to be used in laying
8877 * out windows behind it.
8878 */
8879 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
8880 = new ViewTreeObserver.InternalInsetsInfo();
8881
8882 /**
8883 * All views in the window's hierarchy that serve as scroll containers,
8884 * used to determine if the window can be resized or must be panned
8885 * to adjust for a soft input area.
8886 */
8887 final ArrayList<View> mScrollContainers = new ArrayList<View>();
8888
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07008889 final KeyEvent.DispatcherState mKeyDispatchState
8890 = new KeyEvent.DispatcherState();
8891
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008892 /**
8893 * Indicates whether the view's window currently has the focus.
8894 */
8895 boolean mHasWindowFocus;
8896
8897 /**
8898 * The current visibility of the window.
8899 */
8900 int mWindowVisibility;
8901
8902 /**
8903 * Indicates the time at which drawing started to occur.
8904 */
8905 long mDrawingTime;
8906
8907 /**
Romain Guy5bcdff42009-05-14 21:27:18 -07008908 * Indicates whether or not ignoring the DIRTY_MASK flags.
8909 */
8910 boolean mIgnoreDirtyState;
8911
8912 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008913 * Indicates whether the view's window is currently in touch mode.
8914 */
8915 boolean mInTouchMode;
8916
8917 /**
8918 * Indicates that ViewRoot should trigger a global layout change
8919 * the next time it performs a traversal
8920 */
8921 boolean mRecomputeGlobalAttributes;
8922
8923 /**
8924 * Set to true when attributes (like mKeepScreenOn) need to be
8925 * recomputed.
8926 */
8927 boolean mAttributesChanged;
8928
8929 /**
8930 * Set during a traveral if any views want to keep the screen on.
8931 */
8932 boolean mKeepScreenOn;
8933
8934 /**
8935 * Set if the visibility of any views has changed.
8936 */
8937 boolean mViewVisibilityChanged;
8938
8939 /**
8940 * Set to true if a view has been scrolled.
8941 */
8942 boolean mViewScrollChanged;
8943
8944 /**
8945 * Global to the view hierarchy used as a temporary for dealing with
8946 * x/y points in the transparent region computations.
8947 */
8948 final int[] mTransparentLocation = new int[2];
8949
8950 /**
8951 * Global to the view hierarchy used as a temporary for dealing with
8952 * x/y points in the ViewGroup.invalidateChild implementation.
8953 */
8954 final int[] mInvalidateChildLocation = new int[2];
8955
8956 /**
8957 * The view tree observer used to dispatch global events like
8958 * layout, pre-draw, touch mode change, etc.
8959 */
8960 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
8961
8962 /**
8963 * A Canvas used by the view hierarchy to perform bitmap caching.
8964 */
8965 Canvas mCanvas;
8966
8967 /**
8968 * A Handler supplied by a view's {@link android.view.ViewRoot}. This
8969 * handler can be used to pump events in the UI events queue.
8970 */
8971 final Handler mHandler;
8972
8973 /**
8974 * Identifier for messages requesting the view to be invalidated.
8975 * Such messages should be sent to {@link #mHandler}.
8976 */
8977 static final int INVALIDATE_MSG = 0x1;
8978
8979 /**
8980 * Identifier for messages requesting the view to invalidate a region.
8981 * Such messages should be sent to {@link #mHandler}.
8982 */
8983 static final int INVALIDATE_RECT_MSG = 0x2;
8984
8985 /**
8986 * Temporary for use in computing invalidate rectangles while
8987 * calling up the hierarchy.
8988 */
8989 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -07008990
8991 /**
8992 * Temporary list for use in collecting focusable descendents of a view.
8993 */
8994 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24);
8995
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008996 /**
8997 * Creates a new set of attachment information with the specified
8998 * events handler and thread.
8999 *
9000 * @param handler the events handler the view must use
9001 */
9002 AttachInfo(IWindowSession session, IWindow window,
9003 Handler handler, Callbacks effectPlayer) {
9004 mSession = session;
9005 mWindow = window;
9006 mWindowToken = window.asBinder();
9007 mHandler = handler;
9008 mRootCallbacks = effectPlayer;
9009 }
9010 }
9011
9012 /**
9013 * <p>ScrollabilityCache holds various fields used by a View when scrolling
9014 * is supported. This avoids keeping too many unused fields in most
9015 * instances of View.</p>
9016 */
Mike Cleronf116bf82009-09-27 19:14:12 -07009017 private static class ScrollabilityCache implements Runnable {
9018
9019 /**
9020 * Scrollbars are not visible
9021 */
9022 public static final int OFF = 0;
9023
9024 /**
9025 * Scrollbars are visible
9026 */
9027 public static final int ON = 1;
9028
9029 /**
9030 * Scrollbars are fading away
9031 */
9032 public static final int FADING = 2;
9033
9034 public boolean fadeScrollBars;
9035
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009036 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -07009037 public int scrollBarDefaultDelayBeforeFade;
9038 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009039
9040 public int scrollBarSize;
9041 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -07009042 public float[] interpolatorValues;
9043 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009044
9045 public final Paint paint;
9046 public final Matrix matrix;
9047 public Shader shader;
9048
Mike Cleronf116bf82009-09-27 19:14:12 -07009049 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
9050
9051 private final float[] mOpaque = {255.0f};
9052 private final float[] mTransparent = {0.0f};
9053
9054 /**
9055 * When fading should start. This time moves into the future every time
9056 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
9057 */
9058 public long fadeStartTime;
9059
9060
9061 /**
9062 * The current state of the scrollbars: ON, OFF, or FADING
9063 */
9064 public int state = OFF;
9065
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009066 private int mLastColor;
9067
Mike Cleronf116bf82009-09-27 19:14:12 -07009068 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009069 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
9070 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -07009071 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
9072 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009073
9074 paint = new Paint();
9075 matrix = new Matrix();
9076 // use use a height of 1, and then wack the matrix each time we
9077 // actually use it.
9078 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -07009079
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009080 paint.setShader(shader);
9081 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -07009082 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009083 }
Romain Guy8506ab42009-06-11 17:35:47 -07009084
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009085 public void setFadeColor(int color) {
9086 if (color != 0 && color != mLastColor) {
9087 mLastColor = color;
9088 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -07009089
Romain Guye55e1a72009-08-27 10:42:26 -07009090 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
9091 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -07009092
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009093 paint.setShader(shader);
9094 // Restore the default transfer mode (src_over)
9095 paint.setXfermode(null);
9096 }
9097 }
Mike Cleronf116bf82009-09-27 19:14:12 -07009098
9099 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -07009100 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -07009101 if (now >= fadeStartTime) {
9102
9103 // the animation fades the scrollbars out by changing
9104 // the opacity (alpha) from fully opaque to fully
9105 // transparent
9106 int nextFrame = (int) now;
9107 int framesCount = 0;
9108
9109 Interpolator interpolator = scrollBarInterpolator;
9110
9111 // Start opaque
9112 interpolator.setKeyFrame(framesCount++, nextFrame, mOpaque);
9113
9114 // End transparent
9115 nextFrame += scrollBarFadeDuration;
9116 interpolator.setKeyFrame(framesCount, nextFrame, mTransparent);
9117
9118 state = FADING;
9119
9120 // Kick off the fade animation
9121 host.invalidate();
9122 }
9123 }
9124
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009125 }
9126}