blob: 20b3b4611aab92b60a06b450f33e0d9d41943608 [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
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080019import com.android.internal.R;
20import com.android.internal.util.Predicate;
21import com.android.internal.view.menu.MenuBuilder;
22
Christopher Tatea53146c2010-09-07 11:57:52 -070023import android.content.ClipData;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080024import android.content.Context;
Dianne Hackborne36d6e22010-02-17 19:46:25 -080025import android.content.res.Configuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080026import android.content.res.Resources;
27import android.content.res.TypedArray;
28import android.graphics.Bitmap;
Adam Powell2b342f02010-08-18 18:14:13 -070029import android.graphics.Camera;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080030import android.graphics.Canvas;
Mike Cleronf116bf82009-09-27 19:14:12 -070031import android.graphics.Interpolator;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080032import android.graphics.LinearGradient;
33import android.graphics.Matrix;
34import android.graphics.Paint;
35import android.graphics.PixelFormat;
svetoslavganov75986cf2009-05-14 22:28:01 -070036import android.graphics.Point;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080037import android.graphics.PorterDuff;
38import android.graphics.PorterDuffXfermode;
39import android.graphics.Rect;
Adam Powell6e346362010-07-23 10:18:23 -070040import android.graphics.RectF;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080041import android.graphics.Region;
42import android.graphics.Shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080043import android.graphics.drawable.ColorDrawable;
44import android.graphics.drawable.Drawable;
45import android.os.Handler;
46import android.os.IBinder;
47import android.os.Message;
48import android.os.Parcel;
49import android.os.Parcelable;
50import android.os.RemoteException;
51import android.os.SystemClock;
52import android.os.SystemProperties;
53import android.util.AttributeSet;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080054import android.util.Log;
Romain Guyd928d682009-03-31 17:52:16 -070055import android.util.Pool;
svetoslavganov75986cf2009-05-14 22:28:01 -070056import android.util.Poolable;
Romain Guyd928d682009-03-31 17:52:16 -070057import android.util.PoolableManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070058import android.util.Pools;
59import android.util.SparseArray;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080060import android.view.ContextMenu.ContextMenuInfo;
svetoslavganov75986cf2009-05-14 22:28:01 -070061import android.view.accessibility.AccessibilityEvent;
62import android.view.accessibility.AccessibilityEventSource;
63import android.view.accessibility.AccessibilityManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080064import android.view.animation.Animation;
Mike Cleron3ecd58c2009-09-28 11:39:02 -070065import android.view.animation.AnimationUtils;
svetoslavganov75986cf2009-05-14 22:28:01 -070066import android.view.inputmethod.EditorInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080067import android.view.inputmethod.InputConnection;
68import android.view.inputmethod.InputMethodManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080069import android.widget.ScrollBarDrawable;
70
Christopher Tatea0374192010-10-05 13:06:41 -070071import java.lang.ref.WeakReference;
svetoslavganov75986cf2009-05-14 22:28:01 -070072import java.lang.reflect.InvocationTargetException;
73import java.lang.reflect.Method;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080074import java.util.ArrayList;
75import java.util.Arrays;
Chet Haase21cd1382010-09-01 17:42:29 -070076import java.util.List;
Romain Guyd90a3312009-05-06 14:54:28 -070077import java.util.WeakHashMap;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080078
79/**
80 * <p>
81 * This class represents the basic building block for user interface components. A View
82 * occupies a rectangular area on the screen and is responsible for drawing and
83 * event handling. View is the base class for <em>widgets</em>, which are
Romain Guy8506ab42009-06-11 17:35:47 -070084 * used to create interactive UI components (buttons, text fields, etc.). The
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080085 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which
86 * are invisible containers that hold other Views (or other ViewGroups) and define
87 * their layout properties.
88 * </p>
89 *
90 * <div class="special">
Romain Guy8506ab42009-06-11 17:35:47 -070091 * <p>For an introduction to using this class to develop your
92 * application's user interface, read the Developer Guide documentation on
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080093 * <strong><a href="{@docRoot}guide/topics/ui/index.html">User Interface</a></strong>. Special topics
Romain Guy8506ab42009-06-11 17:35:47 -070094 * include:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080095 * <br/><a href="{@docRoot}guide/topics/ui/declaring-layout.html">Declaring Layout</a>
96 * <br/><a href="{@docRoot}guide/topics/ui/menus.html">Creating Menus</a>
97 * <br/><a href="{@docRoot}guide/topics/ui/layout-objects.html">Common Layout Objects</a>
98 * <br/><a href="{@docRoot}guide/topics/ui/binding.html">Binding to Data with AdapterView</a>
99 * <br/><a href="{@docRoot}guide/topics/ui/ui-events.html">Handling UI Events</a>
100 * <br/><a href="{@docRoot}guide/topics/ui/themes.html">Applying Styles and Themes</a>
101 * <br/><a href="{@docRoot}guide/topics/ui/custom-components.html">Building Custom Components</a>
102 * <br/><a href="{@docRoot}guide/topics/ui/how-android-draws.html">How Android Draws Views</a>.
103 * </p>
104 * </div>
Romain Guy8506ab42009-06-11 17:35:47 -0700105 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800106 * <a name="Using"></a>
107 * <h3>Using Views</h3>
108 * <p>
109 * All of the views in a window are arranged in a single tree. You can add views
110 * either from code or by specifying a tree of views in one or more XML layout
111 * files. There are many specialized subclasses of views that act as controls or
112 * are capable of displaying text, images, or other content.
113 * </p>
114 * <p>
115 * Once you have created a tree of views, there are typically a few types of
116 * common operations you may wish to perform:
117 * <ul>
118 * <li><strong>Set properties:</strong> for example setting the text of a
119 * {@link android.widget.TextView}. The available properties and the methods
120 * that set them will vary among the different subclasses of views. Note that
121 * properties that are known at build time can be set in the XML layout
122 * files.</li>
123 * <li><strong>Set focus:</strong> The framework will handled moving focus in
124 * response to user input. To force focus to a specific view, call
125 * {@link #requestFocus}.</li>
126 * <li><strong>Set up listeners:</strong> Views allow clients to set listeners
127 * that will be notified when something interesting happens to the view. For
128 * example, all views will let you set a listener to be notified when the view
129 * gains or loses focus. You can register such a listener using
130 * {@link #setOnFocusChangeListener}. Other view subclasses offer more
131 * specialized listeners. For example, a Button exposes a listener to notify
132 * clients when the button is clicked.</li>
133 * <li><strong>Set visibility:</strong> You can hide or show views using
134 * {@link #setVisibility}.</li>
135 * </ul>
136 * </p>
137 * <p><em>
138 * Note: The Android framework is responsible for measuring, laying out and
139 * drawing views. You should not call methods that perform these actions on
140 * views yourself unless you are actually implementing a
141 * {@link android.view.ViewGroup}.
142 * </em></p>
143 *
144 * <a name="Lifecycle"></a>
145 * <h3>Implementing a Custom View</h3>
146 *
147 * <p>
148 * To implement a custom view, you will usually begin by providing overrides for
149 * some of the standard methods that the framework calls on all views. You do
150 * not need to override all of these methods. In fact, you can start by just
151 * overriding {@link #onDraw(android.graphics.Canvas)}.
152 * <table border="2" width="85%" align="center" cellpadding="5">
153 * <thead>
154 * <tr><th>Category</th> <th>Methods</th> <th>Description</th></tr>
155 * </thead>
156 *
157 * <tbody>
158 * <tr>
159 * <td rowspan="2">Creation</td>
160 * <td>Constructors</td>
161 * <td>There is a form of the constructor that are called when the view
162 * is created from code and a form that is called when the view is
163 * inflated from a layout file. The second form should parse and apply
164 * any attributes defined in the layout file.
165 * </td>
166 * </tr>
167 * <tr>
168 * <td><code>{@link #onFinishInflate()}</code></td>
169 * <td>Called after a view and all of its children has been inflated
170 * from XML.</td>
171 * </tr>
172 *
173 * <tr>
174 * <td rowspan="3">Layout</td>
175 * <td><code>{@link #onMeasure}</code></td>
176 * <td>Called to determine the size requirements for this view and all
177 * of its children.
178 * </td>
179 * </tr>
180 * <tr>
181 * <td><code>{@link #onLayout}</code></td>
182 * <td>Called when this view should assign a size and position to all
183 * of its children.
184 * </td>
185 * </tr>
186 * <tr>
187 * <td><code>{@link #onSizeChanged}</code></td>
188 * <td>Called when the size of this view has changed.
189 * </td>
190 * </tr>
191 *
192 * <tr>
193 * <td>Drawing</td>
194 * <td><code>{@link #onDraw}</code></td>
195 * <td>Called when the view should render its content.
196 * </td>
197 * </tr>
198 *
199 * <tr>
200 * <td rowspan="4">Event processing</td>
201 * <td><code>{@link #onKeyDown}</code></td>
202 * <td>Called when a new key event occurs.
203 * </td>
204 * </tr>
205 * <tr>
206 * <td><code>{@link #onKeyUp}</code></td>
207 * <td>Called when a key up event occurs.
208 * </td>
209 * </tr>
210 * <tr>
211 * <td><code>{@link #onTrackballEvent}</code></td>
212 * <td>Called when a trackball motion event occurs.
213 * </td>
214 * </tr>
215 * <tr>
216 * <td><code>{@link #onTouchEvent}</code></td>
217 * <td>Called when a touch screen motion event occurs.
218 * </td>
219 * </tr>
220 *
221 * <tr>
222 * <td rowspan="2">Focus</td>
223 * <td><code>{@link #onFocusChanged}</code></td>
224 * <td>Called when the view gains or loses focus.
225 * </td>
226 * </tr>
227 *
228 * <tr>
229 * <td><code>{@link #onWindowFocusChanged}</code></td>
230 * <td>Called when the window containing the view gains or loses focus.
231 * </td>
232 * </tr>
233 *
234 * <tr>
235 * <td rowspan="3">Attaching</td>
236 * <td><code>{@link #onAttachedToWindow()}</code></td>
237 * <td>Called when the view is attached to a window.
238 * </td>
239 * </tr>
240 *
241 * <tr>
242 * <td><code>{@link #onDetachedFromWindow}</code></td>
243 * <td>Called when the view is detached from its window.
244 * </td>
245 * </tr>
246 *
247 * <tr>
248 * <td><code>{@link #onWindowVisibilityChanged}</code></td>
249 * <td>Called when the visibility of the window containing the view
250 * has changed.
251 * </td>
252 * </tr>
253 * </tbody>
254 *
255 * </table>
256 * </p>
257 *
258 * <a name="IDs"></a>
259 * <h3>IDs</h3>
260 * Views may have an integer id associated with them. These ids are typically
261 * assigned in the layout XML files, and are used to find specific views within
262 * the view tree. A common pattern is to:
263 * <ul>
264 * <li>Define a Button in the layout file and assign it a unique ID.
265 * <pre>
Gilles Debunne0243caf2010-08-24 23:06:35 -0700266 * &lt;Button
267 * android:id="@+id/my_button"
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800268 * android:layout_width="wrap_content"
269 * android:layout_height="wrap_content"
270 * android:text="@string/my_button_text"/&gt;
271 * </pre></li>
272 * <li>From the onCreate method of an Activity, find the Button
273 * <pre class="prettyprint">
274 * Button myButton = (Button) findViewById(R.id.my_button);
275 * </pre></li>
276 * </ul>
277 * <p>
278 * View IDs need not be unique throughout the tree, but it is good practice to
279 * ensure that they are at least unique within the part of the tree you are
280 * searching.
281 * </p>
282 *
283 * <a name="Position"></a>
284 * <h3>Position</h3>
285 * <p>
286 * The geometry of a view is that of a rectangle. A view has a location,
287 * expressed as a pair of <em>left</em> and <em>top</em> coordinates, and
288 * two dimensions, expressed as a width and a height. The unit for location
289 * and dimensions is the pixel.
290 * </p>
291 *
292 * <p>
293 * It is possible to retrieve the location of a view by invoking the methods
294 * {@link #getLeft()} and {@link #getTop()}. The former returns the left, or X,
295 * coordinate of the rectangle representing the view. The latter returns the
296 * top, or Y, coordinate of the rectangle representing the view. These methods
297 * both return the location of the view relative to its parent. For instance,
298 * when getLeft() returns 20, that means the view is located 20 pixels to the
299 * right of the left edge of its direct parent.
300 * </p>
301 *
302 * <p>
303 * In addition, several convenience methods are offered to avoid unnecessary
304 * computations, namely {@link #getRight()} and {@link #getBottom()}.
305 * These methods return the coordinates of the right and bottom edges of the
306 * rectangle representing the view. For instance, calling {@link #getRight()}
307 * is similar to the following computation: <code>getLeft() + getWidth()</code>
308 * (see <a href="#SizePaddingMargins">Size</a> for more information about the width.)
309 * </p>
310 *
311 * <a name="SizePaddingMargins"></a>
312 * <h3>Size, padding and margins</h3>
313 * <p>
314 * The size of a view is expressed with a width and a height. A view actually
315 * possess two pairs of width and height values.
316 * </p>
317 *
318 * <p>
319 * The first pair is known as <em>measured width</em> and
320 * <em>measured height</em>. These dimensions define how big a view wants to be
321 * within its parent (see <a href="#Layout">Layout</a> for more details.) The
322 * measured dimensions can be obtained by calling {@link #getMeasuredWidth()}
323 * and {@link #getMeasuredHeight()}.
324 * </p>
325 *
326 * <p>
327 * The second pair is simply known as <em>width</em> and <em>height</em>, or
328 * sometimes <em>drawing width</em> and <em>drawing height</em>. These
329 * dimensions define the actual size of the view on screen, at drawing time and
330 * after layout. These values may, but do not have to, be different from the
331 * measured width and height. The width and height can be obtained by calling
332 * {@link #getWidth()} and {@link #getHeight()}.
333 * </p>
334 *
335 * <p>
336 * To measure its dimensions, a view takes into account its padding. The padding
337 * is expressed in pixels for the left, top, right and bottom parts of the view.
338 * Padding can be used to offset the content of the view by a specific amount of
339 * pixels. For instance, a left padding of 2 will push the view's content by
340 * 2 pixels to the right of the left edge. Padding can be set using the
341 * {@link #setPadding(int, int, int, int)} method and queried by calling
342 * {@link #getPaddingLeft()}, {@link #getPaddingTop()},
343 * {@link #getPaddingRight()} and {@link #getPaddingBottom()}.
344 * </p>
345 *
346 * <p>
347 * Even though a view can define a padding, it does not provide any support for
348 * margins. However, view groups provide such a support. Refer to
349 * {@link android.view.ViewGroup} and
350 * {@link android.view.ViewGroup.MarginLayoutParams} for further information.
351 * </p>
352 *
353 * <a name="Layout"></a>
354 * <h3>Layout</h3>
355 * <p>
356 * Layout is a two pass process: a measure pass and a layout pass. The measuring
357 * pass is implemented in {@link #measure(int, int)} and is a top-down traversal
358 * of the view tree. Each view pushes dimension specifications down the tree
359 * during the recursion. At the end of the measure pass, every view has stored
360 * its measurements. The second pass happens in
361 * {@link #layout(int,int,int,int)} and is also top-down. During
362 * this pass each parent is responsible for positioning all of its children
363 * using the sizes computed in the measure pass.
364 * </p>
365 *
366 * <p>
367 * When a view's measure() method returns, its {@link #getMeasuredWidth()} and
368 * {@link #getMeasuredHeight()} values must be set, along with those for all of
369 * that view's descendants. A view's measured width and measured height values
370 * must respect the constraints imposed by the view's parents. This guarantees
371 * that at the end of the measure pass, all parents accept all of their
372 * children's measurements. A parent view may call measure() more than once on
373 * its children. For example, the parent may measure each child once with
374 * unspecified dimensions to find out how big they want to be, then call
375 * measure() on them again with actual numbers if the sum of all the children's
376 * unconstrained sizes is too big or too small.
377 * </p>
378 *
379 * <p>
380 * The measure pass uses two classes to communicate dimensions. The
381 * {@link MeasureSpec} class is used by views to tell their parents how they
382 * want to be measured and positioned. The base LayoutParams class just
383 * describes how big the view wants to be for both width and height. For each
384 * dimension, it can specify one of:
385 * <ul>
386 * <li> an exact number
Romain Guy980a9382010-01-08 15:06:28 -0800387 * <li>MATCH_PARENT, which means the view wants to be as big as its parent
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800388 * (minus padding)
389 * <li> WRAP_CONTENT, which means that the view wants to be just big enough to
390 * enclose its content (plus padding).
391 * </ul>
392 * There are subclasses of LayoutParams for different subclasses of ViewGroup.
393 * For example, AbsoluteLayout has its own subclass of LayoutParams which adds
394 * an X and Y value.
395 * </p>
396 *
397 * <p>
398 * MeasureSpecs are used to push requirements down the tree from parent to
399 * child. A MeasureSpec can be in one of three modes:
400 * <ul>
401 * <li>UNSPECIFIED: This is used by a parent to determine the desired dimension
402 * of a child view. For example, a LinearLayout may call measure() on its child
403 * with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how
404 * tall the child view wants to be given a width of 240 pixels.
405 * <li>EXACTLY: This is used by the parent to impose an exact size on the
406 * child. The child must use this size, and guarantee that all of its
407 * descendants will fit within this size.
408 * <li>AT_MOST: This is used by the parent to impose a maximum size on the
409 * child. The child must gurantee that it and all of its descendants will fit
410 * within this size.
411 * </ul>
412 * </p>
413 *
414 * <p>
415 * To intiate a layout, call {@link #requestLayout}. This method is typically
416 * called by a view on itself when it believes that is can no longer fit within
417 * its current bounds.
418 * </p>
419 *
420 * <a name="Drawing"></a>
421 * <h3>Drawing</h3>
422 * <p>
423 * Drawing is handled by walking the tree and rendering each view that
424 * intersects the the invalid region. Because the tree is traversed in-order,
425 * this means that parents will draw before (i.e., behind) their children, with
426 * siblings drawn in the order they appear in the tree.
427 * If you set a background drawable for a View, then the View will draw it for you
428 * before calling back to its <code>onDraw()</code> method.
429 * </p>
430 *
431 * <p>
Romain Guy8506ab42009-06-11 17:35:47 -0700432 * 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 -0800433 * </p>
434 *
435 * <p>
436 * To force a view to draw, call {@link #invalidate()}.
437 * </p>
438 *
439 * <a name="EventHandlingThreading"></a>
440 * <h3>Event Handling and Threading</h3>
441 * <p>
442 * The basic cycle of a view is as follows:
443 * <ol>
444 * <li>An event comes in and is dispatched to the appropriate view. The view
445 * handles the event and notifies any listeners.</li>
446 * <li>If in the course of processing the event, the view's bounds may need
447 * to be changed, the view will call {@link #requestLayout()}.</li>
448 * <li>Similarly, if in the course of processing the event the view's appearance
449 * may need to be changed, the view will call {@link #invalidate()}.</li>
450 * <li>If either {@link #requestLayout()} or {@link #invalidate()} were called,
451 * the framework will take care of measuring, laying out, and drawing the tree
452 * as appropriate.</li>
453 * </ol>
454 * </p>
455 *
456 * <p><em>Note: The entire view tree is single threaded. You must always be on
457 * the UI thread when calling any method on any view.</em>
458 * If you are doing work on other threads and want to update the state of a view
459 * from that thread, you should use a {@link Handler}.
460 * </p>
461 *
462 * <a name="FocusHandling"></a>
463 * <h3>Focus Handling</h3>
464 * <p>
465 * The framework will handle routine focus movement in response to user input.
466 * This includes changing the focus as views are removed or hidden, or as new
467 * views become available. Views indicate their willingness to take focus
468 * through the {@link #isFocusable} method. To change whether a view can take
469 * focus, call {@link #setFocusable(boolean)}. When in touch mode (see notes below)
470 * views indicate whether they still would like focus via {@link #isFocusableInTouchMode}
471 * and can change this via {@link #setFocusableInTouchMode(boolean)}.
472 * </p>
473 * <p>
474 * Focus movement is based on an algorithm which finds the nearest neighbor in a
475 * given direction. In rare cases, the default algorithm may not match the
476 * intended behavior of the developer. In these situations, you can provide
477 * explicit overrides by using these XML attributes in the layout file:
478 * <pre>
479 * nextFocusDown
480 * nextFocusLeft
481 * nextFocusRight
482 * nextFocusUp
483 * </pre>
484 * </p>
485 *
486 *
487 * <p>
488 * To get a particular view to take focus, call {@link #requestFocus()}.
489 * </p>
490 *
491 * <a name="TouchMode"></a>
492 * <h3>Touch Mode</h3>
493 * <p>
494 * When a user is navigating a user interface via directional keys such as a D-pad, it is
495 * necessary to give focus to actionable items such as buttons so the user can see
496 * what will take input. If the device has touch capabilities, however, and the user
497 * begins interacting with the interface by touching it, it is no longer necessary to
498 * always highlight, or give focus to, a particular view. This motivates a mode
499 * for interaction named 'touch mode'.
500 * </p>
501 * <p>
502 * For a touch capable device, once the user touches the screen, the device
503 * will enter touch mode. From this point onward, only views for which
504 * {@link #isFocusableInTouchMode} is true will be focusable, such as text editing widgets.
505 * Other views that are touchable, like buttons, will not take focus when touched; they will
506 * only fire the on click listeners.
507 * </p>
508 * <p>
509 * Any time a user hits a directional key, such as a D-pad direction, the view device will
510 * exit touch mode, and find a view to take focus, so that the user may resume interacting
511 * with the user interface without touching the screen again.
512 * </p>
513 * <p>
514 * The touch mode state is maintained across {@link android.app.Activity}s. Call
515 * {@link #isInTouchMode} to see whether the device is currently in touch mode.
516 * </p>
517 *
518 * <a name="Scrolling"></a>
519 * <h3>Scrolling</h3>
520 * <p>
521 * The framework provides basic support for views that wish to internally
522 * scroll their content. This includes keeping track of the X and Y scroll
523 * offset as well as mechanisms for drawing scrollbars. See
Mike Cleronf116bf82009-09-27 19:14:12 -0700524 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and
525 * {@link #awakenScrollBars()} for more details.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800526 * </p>
527 *
528 * <a name="Tags"></a>
529 * <h3>Tags</h3>
530 * <p>
531 * Unlike IDs, tags are not used to identify views. Tags are essentially an
532 * extra piece of information that can be associated with a view. They are most
533 * often used as a convenience to store data related to views in the views
534 * themselves rather than by putting them in a separate structure.
535 * </p>
536 *
537 * <a name="Animation"></a>
538 * <h3>Animation</h3>
539 * <p>
540 * You can attach an {@link Animation} object to a view using
541 * {@link #setAnimation(Animation)} or
542 * {@link #startAnimation(Animation)}. The animation can alter the scale,
543 * rotation, translation and alpha of a view over time. If the animation is
544 * attached to a view that has children, the animation will affect the entire
545 * subtree rooted by that node. When an animation is started, the framework will
546 * take care of redrawing the appropriate views until the animation completes.
547 * </p>
Romain Guy171c5922011-01-06 10:04:23 -0800548 * <p>
549 * Starting with Android 3.0, the preferred way of animating views is to use the
550 * {@link android.animation} package APIs.
551 * </p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800552 *
Jeff Brown85a31762010-09-01 17:01:00 -0700553 * <a name="Security"></a>
554 * <h3>Security</h3>
555 * <p>
556 * Sometimes it is essential that an application be able to verify that an action
557 * is being performed with the full knowledge and consent of the user, such as
558 * granting a permission request, making a purchase or clicking on an advertisement.
559 * Unfortunately, a malicious application could try to spoof the user into
560 * performing these actions, unaware, by concealing the intended purpose of the view.
561 * As a remedy, the framework offers a touch filtering mechanism that can be used to
562 * improve the security of views that provide access to sensitive functionality.
563 * </p><p>
564 * To enable touch filtering, call {@link #setFilterTouchesWhenObscured} or set the
Jeff Brown49ed71d2010-12-06 17:13:33 -0800565 * android:filterTouchesWhenObscured layout attribute to true. When enabled, the framework
Jeff Brown85a31762010-09-01 17:01:00 -0700566 * will discard touches that are received whenever the view's window is obscured by
567 * another visible window. As a result, the view will not receive touches whenever a
568 * toast, dialog or other window appears above the view's window.
569 * </p><p>
570 * For more fine-grained control over security, consider overriding the
571 * {@link #onFilterTouchEventForSecurity} method to implement your own security policy.
572 * See also {@link MotionEvent#FLAG_WINDOW_IS_OBSCURED}.
573 * </p>
574 *
Romain Guy171c5922011-01-06 10:04:23 -0800575 * @attr ref android.R.styleable#View_alpha
Romain Guyd6a463a2009-05-21 23:10:10 -0700576 * @attr ref android.R.styleable#View_background
577 * @attr ref android.R.styleable#View_clickable
578 * @attr ref android.R.styleable#View_contentDescription
579 * @attr ref android.R.styleable#View_drawingCacheQuality
580 * @attr ref android.R.styleable#View_duplicateParentState
581 * @attr ref android.R.styleable#View_id
582 * @attr ref android.R.styleable#View_fadingEdge
583 * @attr ref android.R.styleable#View_fadingEdgeLength
Jeff Brown85a31762010-09-01 17:01:00 -0700584 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800585 * @attr ref android.R.styleable#View_fitsSystemWindows
Romain Guyd6a463a2009-05-21 23:10:10 -0700586 * @attr ref android.R.styleable#View_isScrollContainer
587 * @attr ref android.R.styleable#View_focusable
588 * @attr ref android.R.styleable#View_focusableInTouchMode
589 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
590 * @attr ref android.R.styleable#View_keepScreenOn
Romain Guy171c5922011-01-06 10:04:23 -0800591 * @attr ref android.R.styleable#View_layerType
Romain Guyd6a463a2009-05-21 23:10:10 -0700592 * @attr ref android.R.styleable#View_longClickable
593 * @attr ref android.R.styleable#View_minHeight
594 * @attr ref android.R.styleable#View_minWidth
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800595 * @attr ref android.R.styleable#View_nextFocusDown
596 * @attr ref android.R.styleable#View_nextFocusLeft
597 * @attr ref android.R.styleable#View_nextFocusRight
598 * @attr ref android.R.styleable#View_nextFocusUp
Romain Guyd6a463a2009-05-21 23:10:10 -0700599 * @attr ref android.R.styleable#View_onClick
600 * @attr ref android.R.styleable#View_padding
601 * @attr ref android.R.styleable#View_paddingBottom
602 * @attr ref android.R.styleable#View_paddingLeft
603 * @attr ref android.R.styleable#View_paddingRight
604 * @attr ref android.R.styleable#View_paddingTop
605 * @attr ref android.R.styleable#View_saveEnabled
Chet Haase73066682010-11-29 15:55:32 -0800606 * @attr ref android.R.styleable#View_rotation
607 * @attr ref android.R.styleable#View_rotationX
608 * @attr ref android.R.styleable#View_rotationY
609 * @attr ref android.R.styleable#View_scaleX
610 * @attr ref android.R.styleable#View_scaleY
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800611 * @attr ref android.R.styleable#View_scrollX
612 * @attr ref android.R.styleable#View_scrollY
Romain Guyd6a463a2009-05-21 23:10:10 -0700613 * @attr ref android.R.styleable#View_scrollbarSize
614 * @attr ref android.R.styleable#View_scrollbarStyle
615 * @attr ref android.R.styleable#View_scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -0700616 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
617 * @attr ref android.R.styleable#View_scrollbarFadeDuration
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800618 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal
619 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800620 * @attr ref android.R.styleable#View_scrollbarThumbVertical
621 * @attr ref android.R.styleable#View_scrollbarTrackVertical
622 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack
623 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack
Romain Guyd6a463a2009-05-21 23:10:10 -0700624 * @attr ref android.R.styleable#View_soundEffectsEnabled
625 * @attr ref android.R.styleable#View_tag
Chet Haase73066682010-11-29 15:55:32 -0800626 * @attr ref android.R.styleable#View_transformPivotX
627 * @attr ref android.R.styleable#View_transformPivotY
628 * @attr ref android.R.styleable#View_translationX
629 * @attr ref android.R.styleable#View_translationY
Romain Guyd6a463a2009-05-21 23:10:10 -0700630 * @attr ref android.R.styleable#View_visibility
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800631 *
632 * @see android.view.ViewGroup
633 */
svetoslavganov75986cf2009-05-14 22:28:01 -0700634public class View implements Drawable.Callback, KeyEvent.Callback, AccessibilityEventSource {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800635 private static final boolean DBG = false;
636
637 /**
638 * The logging tag used by this class with android.util.Log.
639 */
640 protected static final String VIEW_LOG_TAG = "View";
641
642 /**
643 * Used to mark a View that has no ID.
644 */
645 public static final int NO_ID = -1;
646
647 /**
648 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when
649 * calling setFlags.
650 */
651 private static final int NOT_FOCUSABLE = 0x00000000;
652
653 /**
654 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling
655 * setFlags.
656 */
657 private static final int FOCUSABLE = 0x00000001;
658
659 /**
660 * Mask for use with setFlags indicating bits used for focus.
661 */
662 private static final int FOCUSABLE_MASK = 0x00000001;
663
664 /**
665 * This view will adjust its padding to fit sytem windows (e.g. status bar)
666 */
667 private static final int FITS_SYSTEM_WINDOWS = 0x00000002;
668
669 /**
670 * This view is visible. Use with {@link #setVisibility}.
671 */
672 public static final int VISIBLE = 0x00000000;
673
674 /**
675 * This view is invisible, but it still takes up space for layout purposes.
676 * Use with {@link #setVisibility}.
677 */
678 public static final int INVISIBLE = 0x00000004;
679
680 /**
681 * This view is invisible, and it doesn't take any space for layout
682 * purposes. Use with {@link #setVisibility}.
683 */
684 public static final int GONE = 0x00000008;
685
686 /**
687 * Mask for use with setFlags indicating bits used for visibility.
688 * {@hide}
689 */
690 static final int VISIBILITY_MASK = 0x0000000C;
691
692 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE};
693
694 /**
695 * This view is enabled. Intrepretation varies by subclass.
696 * Use with ENABLED_MASK when calling setFlags.
697 * {@hide}
698 */
699 static final int ENABLED = 0x00000000;
700
701 /**
702 * This view is disabled. Intrepretation varies by subclass.
703 * Use with ENABLED_MASK when calling setFlags.
704 * {@hide}
705 */
706 static final int DISABLED = 0x00000020;
707
708 /**
709 * Mask for use with setFlags indicating bits used for indicating whether
710 * this view is enabled
711 * {@hide}
712 */
713 static final int ENABLED_MASK = 0x00000020;
714
715 /**
716 * This view won't draw. {@link #onDraw} won't be called and further
717 * optimizations
718 * will be performed. It is okay to have this flag set and a background.
719 * Use with DRAW_MASK when calling setFlags.
720 * {@hide}
721 */
722 static final int WILL_NOT_DRAW = 0x00000080;
723
724 /**
725 * Mask for use with setFlags indicating bits used for indicating whether
726 * this view is will draw
727 * {@hide}
728 */
729 static final int DRAW_MASK = 0x00000080;
730
731 /**
732 * <p>This view doesn't show scrollbars.</p>
733 * {@hide}
734 */
735 static final int SCROLLBARS_NONE = 0x00000000;
736
737 /**
738 * <p>This view shows horizontal scrollbars.</p>
739 * {@hide}
740 */
741 static final int SCROLLBARS_HORIZONTAL = 0x00000100;
742
743 /**
744 * <p>This view shows vertical scrollbars.</p>
745 * {@hide}
746 */
747 static final int SCROLLBARS_VERTICAL = 0x00000200;
748
749 /**
750 * <p>Mask for use with setFlags indicating bits used for indicating which
751 * scrollbars are enabled.</p>
752 * {@hide}
753 */
754 static final int SCROLLBARS_MASK = 0x00000300;
755
Jeff Brown85a31762010-09-01 17:01:00 -0700756 /**
757 * Indicates that the view should filter touches when its window is obscured.
758 * Refer to the class comments for more information about this security feature.
759 * {@hide}
760 */
761 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400;
762
763 // note flag value 0x00000800 is now available for next flags...
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800764
765 /**
766 * <p>This view doesn't show fading edges.</p>
767 * {@hide}
768 */
769 static final int FADING_EDGE_NONE = 0x00000000;
770
771 /**
772 * <p>This view shows horizontal fading edges.</p>
773 * {@hide}
774 */
775 static final int FADING_EDGE_HORIZONTAL = 0x00001000;
776
777 /**
778 * <p>This view shows vertical fading edges.</p>
779 * {@hide}
780 */
781 static final int FADING_EDGE_VERTICAL = 0x00002000;
782
783 /**
784 * <p>Mask for use with setFlags indicating bits used for indicating which
785 * fading edges are enabled.</p>
786 * {@hide}
787 */
788 static final int FADING_EDGE_MASK = 0x00003000;
789
790 /**
791 * <p>Indicates this view can be clicked. When clickable, a View reacts
792 * to clicks by notifying the OnClickListener.<p>
793 * {@hide}
794 */
795 static final int CLICKABLE = 0x00004000;
796
797 /**
798 * <p>Indicates this view is caching its drawing into a bitmap.</p>
799 * {@hide}
800 */
801 static final int DRAWING_CACHE_ENABLED = 0x00008000;
802
803 /**
804 * <p>Indicates that no icicle should be saved for this view.<p>
805 * {@hide}
806 */
807 static final int SAVE_DISABLED = 0x000010000;
808
809 /**
810 * <p>Mask for use with setFlags indicating bits used for the saveEnabled
811 * property.</p>
812 * {@hide}
813 */
814 static final int SAVE_DISABLED_MASK = 0x000010000;
815
816 /**
817 * <p>Indicates that no drawing cache should ever be created for this view.<p>
818 * {@hide}
819 */
820 static final int WILL_NOT_CACHE_DRAWING = 0x000020000;
821
822 /**
823 * <p>Indicates this view can take / keep focus when int touch mode.</p>
824 * {@hide}
825 */
826 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000;
827
828 /**
829 * <p>Enables low quality mode for the drawing cache.</p>
830 */
831 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000;
832
833 /**
834 * <p>Enables high quality mode for the drawing cache.</p>
835 */
836 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000;
837
838 /**
839 * <p>Enables automatic quality mode for the drawing cache.</p>
840 */
841 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000;
842
843 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = {
844 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH
845 };
846
847 /**
848 * <p>Mask for use with setFlags indicating bits used for the cache
849 * quality property.</p>
850 * {@hide}
851 */
852 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000;
853
854 /**
855 * <p>
856 * Indicates this view can be long clicked. When long clickable, a View
857 * reacts to long clicks by notifying the OnLongClickListener or showing a
858 * context menu.
859 * </p>
860 * {@hide}
861 */
862 static final int LONG_CLICKABLE = 0x00200000;
863
864 /**
865 * <p>Indicates that this view gets its drawable states from its direct parent
866 * and ignores its original internal states.</p>
867 *
868 * @hide
869 */
870 static final int DUPLICATE_PARENT_STATE = 0x00400000;
871
872 /**
873 * The scrollbar style to display the scrollbars inside the content area,
874 * without increasing the padding. The scrollbars will be overlaid with
875 * translucency on the view's content.
876 */
877 public static final int SCROLLBARS_INSIDE_OVERLAY = 0;
878
879 /**
880 * The scrollbar style to display the scrollbars inside the padded area,
881 * increasing the padding of the view. The scrollbars will not overlap the
882 * content area of the view.
883 */
884 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000;
885
886 /**
887 * The scrollbar style to display the scrollbars at the edge of the view,
888 * without increasing the padding. The scrollbars will be overlaid with
889 * translucency.
890 */
891 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000;
892
893 /**
894 * The scrollbar style to display the scrollbars at the edge of the view,
895 * increasing the padding of the view. The scrollbars will only overlap the
896 * background, if any.
897 */
898 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000;
899
900 /**
901 * Mask to check if the scrollbar style is overlay or inset.
902 * {@hide}
903 */
904 static final int SCROLLBARS_INSET_MASK = 0x01000000;
905
906 /**
907 * Mask to check if the scrollbar style is inside or outside.
908 * {@hide}
909 */
910 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000;
911
912 /**
913 * Mask for scrollbar style.
914 * {@hide}
915 */
916 static final int SCROLLBARS_STYLE_MASK = 0x03000000;
917
918 /**
919 * View flag indicating that the screen should remain on while the
920 * window containing this view is visible to the user. This effectively
921 * takes care of automatically setting the WindowManager's
922 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}.
923 */
924 public static final int KEEP_SCREEN_ON = 0x04000000;
925
926 /**
927 * View flag indicating whether this view should have sound effects enabled
928 * for events such as clicking and touching.
929 */
930 public static final int SOUND_EFFECTS_ENABLED = 0x08000000;
931
932 /**
933 * View flag indicating whether this view should have haptic feedback
934 * enabled for events such as long presses.
935 */
936 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000;
937
938 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700939 * <p>Indicates that the view hierarchy should stop saving state when
940 * it reaches this view. If state saving is initiated immediately at
941 * the view, it will be allowed.
942 * {@hide}
943 */
944 static final int PARENT_SAVE_DISABLED = 0x20000000;
945
946 /**
947 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p>
948 * {@hide}
949 */
950 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000;
951
952 /**
svetoslavganov75986cf2009-05-14 22:28:01 -0700953 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
954 * should add all focusable Views regardless if they are focusable in touch mode.
955 */
956 public static final int FOCUSABLES_ALL = 0x00000000;
957
958 /**
959 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
960 * should add only Views focusable in touch mode.
961 */
962 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001;
963
964 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800965 * Use with {@link #focusSearch}. Move focus to the previous selectable
966 * item.
967 */
968 public static final int FOCUS_BACKWARD = 0x00000001;
969
970 /**
971 * Use with {@link #focusSearch}. Move focus to the next selectable
972 * item.
973 */
974 public static final int FOCUS_FORWARD = 0x00000002;
975
976 /**
977 * Use with {@link #focusSearch}. Move focus to the left.
978 */
979 public static final int FOCUS_LEFT = 0x00000011;
980
981 /**
982 * Use with {@link #focusSearch}. Move focus up.
983 */
984 public static final int FOCUS_UP = 0x00000021;
985
986 /**
987 * Use with {@link #focusSearch}. Move focus to the right.
988 */
989 public static final int FOCUS_RIGHT = 0x00000042;
990
991 /**
992 * Use with {@link #focusSearch}. Move focus down.
993 */
994 public static final int FOCUS_DOWN = 0x00000082;
995
996 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -0800997 * Bits of {@link #getMeasuredWidthAndState()} and
998 * {@link #getMeasuredWidthAndState()} that provide the actual measured size.
999 */
1000 public static final int MEASURED_SIZE_MASK = 0x00ffffff;
1001
1002 /**
1003 * Bits of {@link #getMeasuredWidthAndState()} and
1004 * {@link #getMeasuredWidthAndState()} that provide the additional state bits.
1005 */
1006 public static final int MEASURED_STATE_MASK = 0xff000000;
1007
1008 /**
1009 * Bit shift of {@link #MEASURED_STATE_MASK} to get to the height bits
1010 * for functions that combine both width and height into a single int,
1011 * such as {@link #getMeasuredState()} and the childState argument of
1012 * {@link #resolveSizeAndState(int, int, int)}.
1013 */
1014 public static final int MEASURED_HEIGHT_STATE_SHIFT = 16;
1015
1016 /**
1017 * Bit of {@link #getMeasuredWidthAndState()} and
1018 * {@link #getMeasuredWidthAndState()} that indicates the measured size
1019 * is smaller that the space the view would like to have.
1020 */
1021 public static final int MEASURED_STATE_TOO_SMALL = 0x01000000;
1022
1023 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001024 * Base View state sets
1025 */
1026 // Singles
1027 /**
1028 * Indicates the view has no states set. States are used with
1029 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1030 * view depending on its state.
1031 *
1032 * @see android.graphics.drawable.Drawable
1033 * @see #getDrawableState()
1034 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001035 protected static final int[] EMPTY_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001036 /**
1037 * Indicates the view is enabled. States are used with
1038 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1039 * view depending on its state.
1040 *
1041 * @see android.graphics.drawable.Drawable
1042 * @see #getDrawableState()
1043 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001044 protected static final int[] ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001045 /**
1046 * Indicates the view is focused. States are used with
1047 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1048 * view depending on its state.
1049 *
1050 * @see android.graphics.drawable.Drawable
1051 * @see #getDrawableState()
1052 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001053 protected static final int[] FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001054 /**
1055 * Indicates the view is selected. States are used with
1056 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1057 * view depending on its state.
1058 *
1059 * @see android.graphics.drawable.Drawable
1060 * @see #getDrawableState()
1061 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001062 protected static final int[] SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001063 /**
1064 * Indicates the view is pressed. States are used with
1065 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1066 * view depending on its state.
1067 *
1068 * @see android.graphics.drawable.Drawable
1069 * @see #getDrawableState()
1070 * @hide
1071 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001072 protected static final int[] PRESSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001073 /**
1074 * Indicates the view's window has focus. States are used with
1075 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1076 * view depending on its state.
1077 *
1078 * @see android.graphics.drawable.Drawable
1079 * @see #getDrawableState()
1080 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001081 protected static final int[] WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001082 // Doubles
1083 /**
1084 * Indicates the view is enabled and has the focus.
1085 *
1086 * @see #ENABLED_STATE_SET
1087 * @see #FOCUSED_STATE_SET
1088 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001089 protected static final int[] ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001090 /**
1091 * Indicates the view is enabled and selected.
1092 *
1093 * @see #ENABLED_STATE_SET
1094 * @see #SELECTED_STATE_SET
1095 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001096 protected static final int[] ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001097 /**
1098 * Indicates the view is enabled and that its window has focus.
1099 *
1100 * @see #ENABLED_STATE_SET
1101 * @see #WINDOW_FOCUSED_STATE_SET
1102 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001103 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001104 /**
1105 * Indicates the view is focused and selected.
1106 *
1107 * @see #FOCUSED_STATE_SET
1108 * @see #SELECTED_STATE_SET
1109 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001110 protected static final int[] FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001111 /**
1112 * Indicates the view has the focus and that its window has the focus.
1113 *
1114 * @see #FOCUSED_STATE_SET
1115 * @see #WINDOW_FOCUSED_STATE_SET
1116 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001117 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001118 /**
1119 * Indicates the view is selected and that its window has the focus.
1120 *
1121 * @see #SELECTED_STATE_SET
1122 * @see #WINDOW_FOCUSED_STATE_SET
1123 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001124 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001125 // Triples
1126 /**
1127 * Indicates the view is enabled, focused and selected.
1128 *
1129 * @see #ENABLED_STATE_SET
1130 * @see #FOCUSED_STATE_SET
1131 * @see #SELECTED_STATE_SET
1132 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001133 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001134 /**
1135 * Indicates the view is enabled, focused and its window has the focus.
1136 *
1137 * @see #ENABLED_STATE_SET
1138 * @see #FOCUSED_STATE_SET
1139 * @see #WINDOW_FOCUSED_STATE_SET
1140 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001141 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001142 /**
1143 * Indicates the view is enabled, selected and its window has the focus.
1144 *
1145 * @see #ENABLED_STATE_SET
1146 * @see #SELECTED_STATE_SET
1147 * @see #WINDOW_FOCUSED_STATE_SET
1148 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001149 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001150 /**
1151 * Indicates the view is focused, selected and its window has the focus.
1152 *
1153 * @see #FOCUSED_STATE_SET
1154 * @see #SELECTED_STATE_SET
1155 * @see #WINDOW_FOCUSED_STATE_SET
1156 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001157 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001158 /**
1159 * Indicates the view is enabled, focused, selected and its window
1160 * has the focus.
1161 *
1162 * @see #ENABLED_STATE_SET
1163 * @see #FOCUSED_STATE_SET
1164 * @see #SELECTED_STATE_SET
1165 * @see #WINDOW_FOCUSED_STATE_SET
1166 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001167 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001168 /**
1169 * Indicates the view is pressed and its window has the focus.
1170 *
1171 * @see #PRESSED_STATE_SET
1172 * @see #WINDOW_FOCUSED_STATE_SET
1173 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001174 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001175 /**
1176 * Indicates the view is pressed and selected.
1177 *
1178 * @see #PRESSED_STATE_SET
1179 * @see #SELECTED_STATE_SET
1180 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001181 protected static final int[] PRESSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001182 /**
1183 * Indicates the view is pressed, selected and its window has the focus.
1184 *
1185 * @see #PRESSED_STATE_SET
1186 * @see #SELECTED_STATE_SET
1187 * @see #WINDOW_FOCUSED_STATE_SET
1188 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001189 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001190 /**
1191 * Indicates the view is pressed and focused.
1192 *
1193 * @see #PRESSED_STATE_SET
1194 * @see #FOCUSED_STATE_SET
1195 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001196 protected static final int[] PRESSED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001197 /**
1198 * Indicates the view is pressed, focused and its window has the focus.
1199 *
1200 * @see #PRESSED_STATE_SET
1201 * @see #FOCUSED_STATE_SET
1202 * @see #WINDOW_FOCUSED_STATE_SET
1203 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001204 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001205 /**
1206 * Indicates the view is pressed, focused and selected.
1207 *
1208 * @see #PRESSED_STATE_SET
1209 * @see #SELECTED_STATE_SET
1210 * @see #FOCUSED_STATE_SET
1211 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001212 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001213 /**
1214 * Indicates the view is pressed, focused, selected and its window has the focus.
1215 *
1216 * @see #PRESSED_STATE_SET
1217 * @see #FOCUSED_STATE_SET
1218 * @see #SELECTED_STATE_SET
1219 * @see #WINDOW_FOCUSED_STATE_SET
1220 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001221 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001222 /**
1223 * Indicates the view is pressed and enabled.
1224 *
1225 * @see #PRESSED_STATE_SET
1226 * @see #ENABLED_STATE_SET
1227 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001228 protected static final int[] PRESSED_ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001229 /**
1230 * Indicates the view is pressed, enabled and its window has the focus.
1231 *
1232 * @see #PRESSED_STATE_SET
1233 * @see #ENABLED_STATE_SET
1234 * @see #WINDOW_FOCUSED_STATE_SET
1235 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001236 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001237 /**
1238 * Indicates the view is pressed, enabled and selected.
1239 *
1240 * @see #PRESSED_STATE_SET
1241 * @see #ENABLED_STATE_SET
1242 * @see #SELECTED_STATE_SET
1243 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001244 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001245 /**
1246 * Indicates the view is pressed, enabled, selected and its window has the
1247 * focus.
1248 *
1249 * @see #PRESSED_STATE_SET
1250 * @see #ENABLED_STATE_SET
1251 * @see #SELECTED_STATE_SET
1252 * @see #WINDOW_FOCUSED_STATE_SET
1253 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001254 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001255 /**
1256 * Indicates the view is pressed, enabled and focused.
1257 *
1258 * @see #PRESSED_STATE_SET
1259 * @see #ENABLED_STATE_SET
1260 * @see #FOCUSED_STATE_SET
1261 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001262 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001263 /**
1264 * Indicates the view is pressed, enabled, focused and its window has the
1265 * focus.
1266 *
1267 * @see #PRESSED_STATE_SET
1268 * @see #ENABLED_STATE_SET
1269 * @see #FOCUSED_STATE_SET
1270 * @see #WINDOW_FOCUSED_STATE_SET
1271 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001272 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001273 /**
1274 * Indicates the view is pressed, enabled, focused and selected.
1275 *
1276 * @see #PRESSED_STATE_SET
1277 * @see #ENABLED_STATE_SET
1278 * @see #SELECTED_STATE_SET
1279 * @see #FOCUSED_STATE_SET
1280 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001281 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001282 /**
1283 * Indicates the view is pressed, enabled, focused, selected and its window
1284 * has the focus.
1285 *
1286 * @see #PRESSED_STATE_SET
1287 * @see #ENABLED_STATE_SET
1288 * @see #SELECTED_STATE_SET
1289 * @see #FOCUSED_STATE_SET
1290 * @see #WINDOW_FOCUSED_STATE_SET
1291 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001292 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001293
1294 /**
1295 * The order here is very important to {@link #getDrawableState()}
1296 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001297 private static final int[][] VIEW_STATE_SETS;
1298
Romain Guyb051e892010-09-28 19:09:36 -07001299 static final int VIEW_STATE_WINDOW_FOCUSED = 1;
1300 static final int VIEW_STATE_SELECTED = 1 << 1;
1301 static final int VIEW_STATE_FOCUSED = 1 << 2;
1302 static final int VIEW_STATE_ENABLED = 1 << 3;
1303 static final int VIEW_STATE_PRESSED = 1 << 4;
1304 static final int VIEW_STATE_ACTIVATED = 1 << 5;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001305 static final int VIEW_STATE_ACCELERATED = 1 << 6;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001306
1307 static final int[] VIEW_STATE_IDS = new int[] {
1308 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED,
1309 R.attr.state_selected, VIEW_STATE_SELECTED,
1310 R.attr.state_focused, VIEW_STATE_FOCUSED,
1311 R.attr.state_enabled, VIEW_STATE_ENABLED,
1312 R.attr.state_pressed, VIEW_STATE_PRESSED,
1313 R.attr.state_activated, VIEW_STATE_ACTIVATED,
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001314 R.attr.state_accelerated, VIEW_STATE_ACCELERATED,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001315 };
1316
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001317 static {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001318 if ((VIEW_STATE_IDS.length/2) != R.styleable.ViewDrawableStates.length) {
1319 throw new IllegalStateException(
1320 "VIEW_STATE_IDs array length does not match ViewDrawableStates style array");
1321 }
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001322 int[] orderedIds = new int[VIEW_STATE_IDS.length];
Romain Guyb051e892010-09-28 19:09:36 -07001323 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001324 int viewState = R.styleable.ViewDrawableStates[i];
Romain Guyb051e892010-09-28 19:09:36 -07001325 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001326 if (VIEW_STATE_IDS[j] == viewState) {
Romain Guyb051e892010-09-28 19:09:36 -07001327 orderedIds[i * 2] = viewState;
1328 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1];
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001329 }
1330 }
1331 }
Romain Guyb051e892010-09-28 19:09:36 -07001332 final int NUM_BITS = VIEW_STATE_IDS.length / 2;
1333 VIEW_STATE_SETS = new int[1 << NUM_BITS][];
1334 for (int i = 0; i < VIEW_STATE_SETS.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001335 int numBits = Integer.bitCount(i);
1336 int[] set = new int[numBits];
1337 int pos = 0;
Romain Guyb051e892010-09-28 19:09:36 -07001338 for (int j = 0; j < orderedIds.length; j += 2) {
1339 if ((i & orderedIds[j+1]) != 0) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001340 set[pos++] = orderedIds[j];
1341 }
1342 }
1343 VIEW_STATE_SETS[i] = set;
1344 }
1345
1346 EMPTY_STATE_SET = VIEW_STATE_SETS[0];
1347 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED];
1348 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED];
1349 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1350 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED];
1351 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED];
1352 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1353 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED];
1354 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1355 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED];
1356 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1357 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1358 | VIEW_STATE_FOCUSED];
1359 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED];
1360 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1361 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED];
1362 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1363 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED];
1364 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1365 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1366 | VIEW_STATE_ENABLED];
1367 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1368 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED];
1369 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1370 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1371 | VIEW_STATE_ENABLED];
1372 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1373 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1374 | VIEW_STATE_ENABLED];
1375 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1376 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1377 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED];
1378
1379 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED];
1380 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1381 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED];
1382 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1383 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED];
1384 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1385 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1386 | VIEW_STATE_PRESSED];
1387 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1388 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1389 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1390 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1391 | VIEW_STATE_PRESSED];
1392 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1393 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1394 | VIEW_STATE_PRESSED];
1395 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1396 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1397 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1398 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[
1399 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1400 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1401 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED
1402 | VIEW_STATE_PRESSED];
1403 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1404 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED
1405 | VIEW_STATE_PRESSED];
1406 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1407 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1408 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1409 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1410 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED
1411 | VIEW_STATE_PRESSED];
1412 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1413 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1414 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1415 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1416 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1417 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1418 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1419 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1420 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED
1421 | VIEW_STATE_PRESSED];
1422 }
1423
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001424 /**
1425 * Used by views that contain lists of items. This state indicates that
1426 * the view is showing the last item.
1427 * @hide
1428 */
1429 protected static final int[] LAST_STATE_SET = {R.attr.state_last};
1430 /**
1431 * Used by views that contain lists of items. This state indicates that
1432 * the view is showing the first item.
1433 * @hide
1434 */
1435 protected static final int[] FIRST_STATE_SET = {R.attr.state_first};
1436 /**
1437 * Used by views that contain lists of items. This state indicates that
1438 * the view is showing the middle item.
1439 * @hide
1440 */
1441 protected static final int[] MIDDLE_STATE_SET = {R.attr.state_middle};
1442 /**
1443 * Used by views that contain lists of items. This state indicates that
1444 * the view is showing only one item.
1445 * @hide
1446 */
1447 protected static final int[] SINGLE_STATE_SET = {R.attr.state_single};
1448 /**
1449 * Used by views that contain lists of items. This state indicates that
1450 * the view is pressed and showing the last item.
1451 * @hide
1452 */
1453 protected static final int[] PRESSED_LAST_STATE_SET = {R.attr.state_last, R.attr.state_pressed};
1454 /**
1455 * Used by views that contain lists of items. This state indicates that
1456 * the view is pressed and showing the first item.
1457 * @hide
1458 */
1459 protected static final int[] PRESSED_FIRST_STATE_SET = {R.attr.state_first, R.attr.state_pressed};
1460 /**
1461 * Used by views that contain lists of items. This state indicates that
1462 * the view is pressed and showing the middle item.
1463 * @hide
1464 */
1465 protected static final int[] PRESSED_MIDDLE_STATE_SET = {R.attr.state_middle, R.attr.state_pressed};
1466 /**
1467 * Used by views that contain lists of items. This state indicates that
1468 * the view is pressed and showing only one item.
1469 * @hide
1470 */
1471 protected static final int[] PRESSED_SINGLE_STATE_SET = {R.attr.state_single, R.attr.state_pressed};
1472
1473 /**
1474 * Temporary Rect currently for use in setBackground(). This will probably
1475 * be extended in the future to hold our own class with more than just
1476 * a Rect. :)
1477 */
1478 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>();
Romain Guyd90a3312009-05-06 14:54:28 -07001479
1480 /**
1481 * Map used to store views' tags.
1482 */
1483 private static WeakHashMap<View, SparseArray<Object>> sTags;
1484
1485 /**
1486 * Lock used to access sTags.
1487 */
1488 private static final Object sTagsLock = new Object();
1489
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001490 /**
1491 * The animation currently associated with this view.
1492 * @hide
1493 */
1494 protected Animation mCurrentAnimation = null;
1495
1496 /**
1497 * Width as measured during measure pass.
1498 * {@hide}
1499 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001500 @ViewDebug.ExportedProperty(category = "measurement")
Dianne Hackborn189ee182010-12-02 21:48:53 -08001501 /*package*/ int mMeasuredWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001502
1503 /**
1504 * Height as measured during measure pass.
1505 * {@hide}
1506 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001507 @ViewDebug.ExportedProperty(category = "measurement")
Dianne Hackborn189ee182010-12-02 21:48:53 -08001508 /*package*/ int mMeasuredHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001509
1510 /**
1511 * The view's identifier.
1512 * {@hide}
1513 *
1514 * @see #setId(int)
1515 * @see #getId()
1516 */
1517 @ViewDebug.ExportedProperty(resolveId = true)
1518 int mID = NO_ID;
1519
1520 /**
1521 * The view's tag.
1522 * {@hide}
1523 *
1524 * @see #setTag(Object)
1525 * @see #getTag()
1526 */
1527 protected Object mTag;
1528
1529 // for mPrivateFlags:
1530 /** {@hide} */
1531 static final int WANTS_FOCUS = 0x00000001;
1532 /** {@hide} */
1533 static final int FOCUSED = 0x00000002;
1534 /** {@hide} */
1535 static final int SELECTED = 0x00000004;
1536 /** {@hide} */
1537 static final int IS_ROOT_NAMESPACE = 0x00000008;
1538 /** {@hide} */
1539 static final int HAS_BOUNDS = 0x00000010;
1540 /** {@hide} */
1541 static final int DRAWN = 0x00000020;
1542 /**
1543 * When this flag is set, this view is running an animation on behalf of its
1544 * children and should therefore not cancel invalidate requests, even if they
1545 * lie outside of this view's bounds.
1546 *
1547 * {@hide}
1548 */
1549 static final int DRAW_ANIMATION = 0x00000040;
1550 /** {@hide} */
1551 static final int SKIP_DRAW = 0x00000080;
1552 /** {@hide} */
1553 static final int ONLY_DRAWS_BACKGROUND = 0x00000100;
1554 /** {@hide} */
1555 static final int REQUEST_TRANSPARENT_REGIONS = 0x00000200;
1556 /** {@hide} */
1557 static final int DRAWABLE_STATE_DIRTY = 0x00000400;
1558 /** {@hide} */
1559 static final int MEASURED_DIMENSION_SET = 0x00000800;
1560 /** {@hide} */
1561 static final int FORCE_LAYOUT = 0x00001000;
Konstantin Lopyrevc6dc4572010-08-06 15:01:52 -07001562 /** {@hide} */
1563 static final int LAYOUT_REQUIRED = 0x00002000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001564
1565 private static final int PRESSED = 0x00004000;
1566
1567 /** {@hide} */
1568 static final int DRAWING_CACHE_VALID = 0x00008000;
1569 /**
1570 * Flag used to indicate that this view should be drawn once more (and only once
1571 * more) after its animation has completed.
1572 * {@hide}
1573 */
1574 static final int ANIMATION_STARTED = 0x00010000;
1575
1576 private static final int SAVE_STATE_CALLED = 0x00020000;
1577
1578 /**
1579 * Indicates that the View returned true when onSetAlpha() was called and that
1580 * the alpha must be restored.
1581 * {@hide}
1582 */
1583 static final int ALPHA_SET = 0x00040000;
1584
1585 /**
1586 * Set by {@link #setScrollContainer(boolean)}.
1587 */
1588 static final int SCROLL_CONTAINER = 0x00080000;
1589
1590 /**
1591 * Set by {@link #setScrollContainer(boolean)}.
1592 */
1593 static final int SCROLL_CONTAINER_ADDED = 0x00100000;
1594
1595 /**
Romain Guy809a7f62009-05-14 15:44:42 -07001596 * View flag indicating whether this view was invalidated (fully or partially.)
1597 *
1598 * @hide
1599 */
1600 static final int DIRTY = 0x00200000;
1601
1602 /**
1603 * View flag indicating whether this view was invalidated by an opaque
1604 * invalidate request.
1605 *
1606 * @hide
1607 */
1608 static final int DIRTY_OPAQUE = 0x00400000;
1609
1610 /**
1611 * Mask for {@link #DIRTY} and {@link #DIRTY_OPAQUE}.
1612 *
1613 * @hide
1614 */
1615 static final int DIRTY_MASK = 0x00600000;
1616
1617 /**
Romain Guy8f1344f52009-05-15 16:03:59 -07001618 * Indicates whether the background is opaque.
1619 *
1620 * @hide
1621 */
1622 static final int OPAQUE_BACKGROUND = 0x00800000;
1623
1624 /**
1625 * Indicates whether the scrollbars are opaque.
1626 *
1627 * @hide
1628 */
1629 static final int OPAQUE_SCROLLBARS = 0x01000000;
1630
1631 /**
1632 * Indicates whether the view is opaque.
1633 *
1634 * @hide
1635 */
1636 static final int OPAQUE_MASK = 0x01800000;
Adam Powelle14579b2009-12-16 18:39:52 -08001637
1638 /**
1639 * Indicates a prepressed state;
1640 * the short time between ACTION_DOWN and recognizing
1641 * a 'real' press. Prepressed is used to recognize quick taps
1642 * even when they are shorter than ViewConfiguration.getTapTimeout().
1643 *
1644 * @hide
1645 */
1646 private static final int PREPRESSED = 0x02000000;
Adam Powellc9fbaab2010-02-16 17:16:19 -08001647
1648 /**
Romain Guy8afa5152010-02-26 11:56:30 -08001649 * Indicates whether the view is temporarily detached.
1650 *
1651 * @hide
1652 */
1653 static final int CANCEL_NEXT_UP_EVENT = 0x04000000;
Adam Powell8568c3a2010-04-19 14:26:11 -07001654
1655 /**
1656 * Indicates that we should awaken scroll bars once attached
1657 *
1658 * @hide
1659 */
1660 private static final int AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000;
Romain Guy8f1344f52009-05-15 16:03:59 -07001661
1662 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001663 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center
1664 * for transform operations
1665 *
1666 * @hide
1667 */
Adam Powellf37df072010-09-17 16:22:49 -07001668 private static final int PIVOT_EXPLICITLY_SET = 0x20000000;
Chet Haasefd2b0022010-08-06 13:08:56 -07001669
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001670 /** {@hide} */
Adam Powellf37df072010-09-17 16:22:49 -07001671 static final int ACTIVATED = 0x40000000;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001672
Chet Haasefd2b0022010-08-06 13:08:56 -07001673 /**
Adam Powell637d3372010-08-25 14:37:03 -07001674 * Always allow a user to over-scroll this view, provided it is a
1675 * view that can scroll.
1676 *
1677 * @see #getOverScrollMode()
1678 * @see #setOverScrollMode(int)
1679 */
1680 public static final int OVER_SCROLL_ALWAYS = 0;
1681
1682 /**
1683 * Allow a user to over-scroll this view only if the content is large
1684 * enough to meaningfully scroll, provided it is a view that can scroll.
1685 *
1686 * @see #getOverScrollMode()
1687 * @see #setOverScrollMode(int)
1688 */
1689 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1;
1690
1691 /**
1692 * Never allow a user to over-scroll this view.
1693 *
1694 * @see #getOverScrollMode()
1695 * @see #setOverScrollMode(int)
1696 */
1697 public static final int OVER_SCROLL_NEVER = 2;
1698
1699 /**
1700 * Controls the over-scroll mode for this view.
1701 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)},
1702 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS},
1703 * and {@link #OVER_SCROLL_NEVER}.
1704 */
1705 private int mOverScrollMode;
1706
1707 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001708 * The parent this view is attached to.
1709 * {@hide}
1710 *
1711 * @see #getParent()
1712 */
1713 protected ViewParent mParent;
1714
1715 /**
1716 * {@hide}
1717 */
1718 AttachInfo mAttachInfo;
1719
1720 /**
1721 * {@hide}
1722 */
Romain Guy809a7f62009-05-14 15:44:42 -07001723 @ViewDebug.ExportedProperty(flagMapping = {
1724 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT,
1725 name = "FORCE_LAYOUT"),
1726 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED,
1727 name = "LAYOUT_REQUIRED"),
1728 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07001729 name = "DRAWING_CACHE_INVALID", outputIf = false),
Romain Guy809a7f62009-05-14 15:44:42 -07001730 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true),
1731 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false),
1732 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
1733 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY")
1734 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001735 int mPrivateFlags;
1736
1737 /**
1738 * Count of how many windows this view has been attached to.
1739 */
1740 int mWindowAttachCount;
1741
1742 /**
1743 * The layout parameters associated with this view and used by the parent
1744 * {@link android.view.ViewGroup} to determine how this view should be
1745 * laid out.
1746 * {@hide}
1747 */
1748 protected ViewGroup.LayoutParams mLayoutParams;
1749
1750 /**
1751 * The view flags hold various views states.
1752 * {@hide}
1753 */
1754 @ViewDebug.ExportedProperty
1755 int mViewFlags;
1756
1757 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001758 * The transform matrix for the View. This transform is calculated internally
1759 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1760 * is used by default. Do *not* use this variable directly; instead call
1761 * getMatrix(), which will automatically recalculate the matrix if necessary
1762 * to get the correct matrix based on the latest rotation and scale properties.
1763 */
1764 private final Matrix mMatrix = new Matrix();
1765
1766 /**
1767 * The transform matrix for the View. This transform is calculated internally
1768 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1769 * is used by default. Do *not* use this variable directly; instead call
Jeff Brown86671742010-09-30 20:00:15 -07001770 * getInverseMatrix(), which will automatically recalculate the matrix if necessary
Chet Haasec3aa3612010-06-17 08:50:37 -07001771 * to get the correct matrix based on the latest rotation and scale properties.
1772 */
1773 private Matrix mInverseMatrix;
1774
1775 /**
1776 * An internal variable that tracks whether we need to recalculate the
1777 * transform matrix, based on whether the rotation or scaleX/Y properties
1778 * have changed since the matrix was last calculated.
1779 */
1780 private boolean mMatrixDirty = false;
1781
1782 /**
1783 * An internal variable that tracks whether we need to recalculate the
1784 * transform matrix, based on whether the rotation or scaleX/Y properties
1785 * have changed since the matrix was last calculated.
1786 */
1787 private boolean mInverseMatrixDirty = true;
1788
1789 /**
1790 * A variable that tracks whether we need to recalculate the
1791 * transform matrix, based on whether the rotation or scaleX/Y properties
1792 * have changed since the matrix was last calculated. This variable
Jeff Brown86671742010-09-30 20:00:15 -07001793 * is only valid after a call to updateMatrix() or to a function that
1794 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix().
Chet Haasec3aa3612010-06-17 08:50:37 -07001795 */
Romain Guy33e72ae2010-07-17 12:40:29 -07001796 private boolean mMatrixIsIdentity = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07001797
1798 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001799 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set.
1800 */
1801 private Camera mCamera = null;
1802
1803 /**
1804 * This matrix is used when computing the matrix for 3D rotations.
1805 */
1806 private Matrix matrix3D = null;
1807
1808 /**
1809 * These prev values are used to recalculate a centered pivot point when necessary. The
1810 * pivot point is only used in matrix operations (when rotation, scale, or translation are
1811 * set), so thes values are only used then as well.
1812 */
1813 private int mPrevWidth = -1;
1814 private int mPrevHeight = -1;
1815
1816 /**
1817 * Convenience value to check for float values that are close enough to zero to be considered
1818 * zero.
1819 */
Romain Guy2542d192010-08-18 11:47:12 -07001820 private static final float NONZERO_EPSILON = .001f;
Chet Haasefd2b0022010-08-06 13:08:56 -07001821
1822 /**
1823 * The degrees rotation around the vertical axis through the pivot point.
1824 */
1825 @ViewDebug.ExportedProperty
1826 private float mRotationY = 0f;
1827
1828 /**
1829 * The degrees rotation around the horizontal axis through the pivot point.
1830 */
1831 @ViewDebug.ExportedProperty
1832 private float mRotationX = 0f;
1833
1834 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001835 * The degrees rotation around the pivot point.
1836 */
1837 @ViewDebug.ExportedProperty
1838 private float mRotation = 0f;
1839
1840 /**
Chet Haasedf030d22010-07-30 17:22:38 -07001841 * The amount of translation of the object away from its left property (post-layout).
1842 */
1843 @ViewDebug.ExportedProperty
1844 private float mTranslationX = 0f;
1845
1846 /**
1847 * The amount of translation of the object away from its top property (post-layout).
1848 */
1849 @ViewDebug.ExportedProperty
1850 private float mTranslationY = 0f;
1851
1852 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001853 * The amount of scale in the x direction around the pivot point. A
1854 * value of 1 means no scaling is applied.
1855 */
1856 @ViewDebug.ExportedProperty
1857 private float mScaleX = 1f;
1858
1859 /**
1860 * The amount of scale in the y direction around the pivot point. A
1861 * value of 1 means no scaling is applied.
1862 */
1863 @ViewDebug.ExportedProperty
1864 private float mScaleY = 1f;
1865
1866 /**
1867 * The amount of scale in the x direction around the pivot point. A
1868 * value of 1 means no scaling is applied.
1869 */
1870 @ViewDebug.ExportedProperty
1871 private float mPivotX = 0f;
1872
1873 /**
1874 * The amount of scale in the y direction around the pivot point. A
1875 * value of 1 means no scaling is applied.
1876 */
1877 @ViewDebug.ExportedProperty
1878 private float mPivotY = 0f;
1879
1880 /**
1881 * The opacity of the View. This is a value from 0 to 1, where 0 means
1882 * completely transparent and 1 means completely opaque.
1883 */
1884 @ViewDebug.ExportedProperty
1885 private float mAlpha = 1f;
1886
1887 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001888 * The distance in pixels from the left edge of this view's parent
1889 * to the left edge of this view.
1890 * {@hide}
1891 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001892 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001893 protected int mLeft;
1894 /**
1895 * The distance in pixels from the left edge of this view's parent
1896 * to the right edge of this view.
1897 * {@hide}
1898 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001899 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001900 protected int mRight;
1901 /**
1902 * The distance in pixels from the top edge of this view's parent
1903 * to the top edge of this view.
1904 * {@hide}
1905 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001906 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001907 protected int mTop;
1908 /**
1909 * The distance in pixels from the top edge of this view's parent
1910 * to the bottom edge of this view.
1911 * {@hide}
1912 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001913 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001914 protected int mBottom;
1915
1916 /**
1917 * The offset, in pixels, by which the content of this view is scrolled
1918 * horizontally.
1919 * {@hide}
1920 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001921 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001922 protected int mScrollX;
1923 /**
1924 * The offset, in pixels, by which the content of this view is scrolled
1925 * vertically.
1926 * {@hide}
1927 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001928 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001929 protected int mScrollY;
1930
1931 /**
1932 * The left padding in pixels, that is the distance in pixels between the
1933 * left edge of this view and the left edge of its content.
1934 * {@hide}
1935 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001936 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001937 protected int mPaddingLeft;
1938 /**
1939 * The right padding in pixels, that is the distance in pixels between the
1940 * right edge of this view and the right edge of its content.
1941 * {@hide}
1942 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001943 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001944 protected int mPaddingRight;
1945 /**
1946 * The top padding in pixels, that is the distance in pixels between the
1947 * top edge of this view and the top edge of its content.
1948 * {@hide}
1949 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001950 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001951 protected int mPaddingTop;
1952 /**
1953 * The bottom padding in pixels, that is the distance in pixels between the
1954 * bottom edge of this view and the bottom edge of its content.
1955 * {@hide}
1956 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001957 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001958 protected int mPaddingBottom;
1959
1960 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07001961 * Briefly describes the view and is primarily used for accessibility support.
1962 */
1963 private CharSequence mContentDescription;
1964
1965 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001966 * Cache the paddingRight set by the user to append to the scrollbar's size.
1967 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001968 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001969 int mUserPaddingRight;
1970
1971 /**
1972 * Cache the paddingBottom set by the user to append to the scrollbar's size.
1973 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001974 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001975 int mUserPaddingBottom;
1976
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07001977 /**
Adam Powell20232d02010-12-08 21:08:53 -08001978 * Cache the paddingLeft set by the user to append to the scrollbar's size.
1979 */
1980 @ViewDebug.ExportedProperty(category = "padding")
1981 int mUserPaddingLeft;
1982
1983 /**
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07001984 * @hide
1985 */
1986 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
1987 /**
1988 * @hide
1989 */
1990 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001991
1992 private Resources mResources = null;
1993
1994 private Drawable mBGDrawable;
1995
1996 private int mBackgroundResource;
1997 private boolean mBackgroundSizeChanged;
1998
1999 /**
2000 * Listener used to dispatch focus change events.
2001 * This field should be made private, so it is hidden from the SDK.
2002 * {@hide}
2003 */
2004 protected OnFocusChangeListener mOnFocusChangeListener;
2005
2006 /**
Chet Haase21cd1382010-09-01 17:42:29 -07002007 * Listeners for layout change events.
2008 */
2009 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
2010
2011 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002012 * Listener used to dispatch click events.
2013 * This field should be made private, so it is hidden from the SDK.
2014 * {@hide}
2015 */
2016 protected OnClickListener mOnClickListener;
2017
2018 /**
2019 * Listener used to dispatch long click events.
2020 * This field should be made private, so it is hidden from the SDK.
2021 * {@hide}
2022 */
2023 protected OnLongClickListener mOnLongClickListener;
2024
2025 /**
2026 * Listener used to build the context menu.
2027 * This field should be made private, so it is hidden from the SDK.
2028 * {@hide}
2029 */
2030 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
2031
2032 private OnKeyListener mOnKeyListener;
2033
2034 private OnTouchListener mOnTouchListener;
2035
Chris Tate32affef2010-10-18 15:29:21 -07002036 private OnDragListener mOnDragListener;
2037
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002038 /**
2039 * The application environment this view lives in.
2040 * This field should be made private, so it is hidden from the SDK.
2041 * {@hide}
2042 */
2043 protected Context mContext;
2044
2045 private ScrollabilityCache mScrollCache;
2046
2047 private int[] mDrawableState = null;
2048
Romain Guy02890fd2010-08-06 17:58:44 -07002049 private Bitmap mDrawingCache;
2050 private Bitmap mUnscaledDrawingCache;
Romain Guyb051e892010-09-28 19:09:36 -07002051 private DisplayList mDisplayList;
Romain Guy6c319ca2011-01-11 14:29:25 -08002052 private HardwareLayer mHardwareLayer;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002053
2054 /**
2055 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
2056 * the user may specify which view to go to next.
2057 */
2058 private int mNextFocusLeftId = View.NO_ID;
2059
2060 /**
2061 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
2062 * the user may specify which view to go to next.
2063 */
2064 private int mNextFocusRightId = View.NO_ID;
2065
2066 /**
2067 * When this view has focus and the next focus is {@link #FOCUS_UP},
2068 * the user may specify which view to go to next.
2069 */
2070 private int mNextFocusUpId = View.NO_ID;
2071
2072 /**
2073 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
2074 * the user may specify which view to go to next.
2075 */
2076 private int mNextFocusDownId = View.NO_ID;
2077
Jeff Brown4e6319b2010-12-13 10:36:51 -08002078 /**
2079 * When this view has focus and the next focus is {@link #FOCUS_FORWARD},
2080 * the user may specify which view to go to next.
2081 */
2082 int mNextFocusForwardId = View.NO_ID;
2083
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002084 private CheckForLongPress mPendingCheckForLongPress;
Adam Powelle14579b2009-12-16 18:39:52 -08002085 private CheckForTap mPendingCheckForTap = null;
Adam Powella35d7682010-03-12 14:48:13 -08002086 private PerformClick mPerformClick;
Adam Powelle14579b2009-12-16 18:39:52 -08002087
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002088 private UnsetPressedState mUnsetPressedState;
2089
2090 /**
2091 * Whether the long press's action has been invoked. The tap's action is invoked on the
2092 * up event while a long press is invoked as soon as the long press duration is reached, so
2093 * a long press could be performed before the tap is checked, in which case the tap's action
2094 * should not be invoked.
2095 */
2096 private boolean mHasPerformedLongPress;
2097
2098 /**
2099 * The minimum height of the view. We'll try our best to have the height
2100 * of this view to at least this amount.
2101 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002102 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002103 private int mMinHeight;
2104
2105 /**
2106 * The minimum width of the view. We'll try our best to have the width
2107 * of this view to at least this amount.
2108 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002109 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002110 private int mMinWidth;
2111
2112 /**
2113 * The delegate to handle touch events that are physically in this view
2114 * but should be handled by another view.
2115 */
2116 private TouchDelegate mTouchDelegate = null;
2117
2118 /**
2119 * Solid color to use as a background when creating the drawing cache. Enables
2120 * the cache to use 16 bit bitmaps instead of 32 bit.
2121 */
2122 private int mDrawingCacheBackgroundColor = 0;
2123
2124 /**
2125 * Special tree observer used when mAttachInfo is null.
2126 */
2127 private ViewTreeObserver mFloatingTreeObserver;
Adam Powelle14579b2009-12-16 18:39:52 -08002128
2129 /**
2130 * Cache the touch slop from the context that created the view.
2131 */
2132 private int mTouchSlop;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002133
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002134 /**
Christopher Tatea53146c2010-09-07 11:57:52 -07002135 * Cache drag/drop state
2136 *
2137 */
2138 boolean mCanAcceptDrop;
Christopher Tatea53146c2010-09-07 11:57:52 -07002139
2140 /**
Christopher Tate02d2b3b2011-01-10 20:43:53 -08002141 * Flag indicating that a drag can cross window boundaries
2142 * @hide
2143 */
2144 public static final int DRAG_FLAG_GLOBAL = 1;
2145
2146 /**
Adam Powell20232d02010-12-08 21:08:53 -08002147 * Position of the vertical scroll bar.
2148 */
2149 private int mVerticalScrollbarPosition;
2150
2151 /**
2152 * Position the scroll bar at the default position as determined by the system.
2153 */
2154 public static final int SCROLLBAR_POSITION_DEFAULT = 0;
2155
2156 /**
2157 * Position the scroll bar along the left edge.
2158 */
2159 public static final int SCROLLBAR_POSITION_LEFT = 1;
2160
2161 /**
2162 * Position the scroll bar along the right edge.
2163 */
2164 public static final int SCROLLBAR_POSITION_RIGHT = 2;
2165
2166 /**
Romain Guy171c5922011-01-06 10:04:23 -08002167 * Indicates that the view does not have a layer.
2168 *
2169 * @see #getLayerType()
2170 * @see #setLayerType(int, android.graphics.Paint)
2171 * @see #LAYER_TYPE_SOFTWARE
2172 * @see #LAYER_TYPE_HARDWARE
2173 */
2174 public static final int LAYER_TYPE_NONE = 0;
2175
2176 /**
2177 * <p>Indicates that the view has a software layer. A software layer is backed
2178 * by a bitmap and causes the view to be rendered using Android's software
2179 * rendering pipeline, even if hardware acceleration is enabled.</p>
2180 *
2181 * <p>Software layers have various usages:</p>
2182 * <p>When the application is not using hardware acceleration, a software layer
2183 * is useful to apply a specific color filter and/or blending mode and/or
2184 * translucency to a view and all its children.</p>
2185 * <p>When the application is using hardware acceleration, a software layer
2186 * is useful to render drawing primitives not supported by the hardware
2187 * accelerated pipeline. It can also be used to cache a complex view tree
2188 * into a texture and reduce the complexity of drawing operations. For instance,
2189 * when animating a complex view tree with a translation, a software layer can
2190 * be used to render the view tree only once.</p>
2191 * <p>Software layers should be avoided when the affected view tree updates
2192 * often. Every update will require to re-render the software layer, which can
2193 * potentially be slow (particularly when hardware acceleration is turned on
2194 * since the layer will have to be uploaded into a hardware texture after every
2195 * update.)</p>
2196 *
2197 * @see #getLayerType()
2198 * @see #setLayerType(int, android.graphics.Paint)
2199 * @see #LAYER_TYPE_NONE
2200 * @see #LAYER_TYPE_HARDWARE
2201 */
2202 public static final int LAYER_TYPE_SOFTWARE = 1;
2203
2204 /**
2205 * <p>Indicates that the view has a hardware layer. A hardware layer is backed
2206 * by a hardware specific texture (generally Frame Buffer Objects or FBO on
2207 * OpenGL hardware) and causes the view to be rendered using Android's hardware
2208 * rendering pipeline, but only if hardware acceleration is turned on for the
2209 * view hierarchy. When hardware acceleration is turned off, hardware layers
2210 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p>
2211 *
2212 * <p>A hardware layer is useful to apply a specific color filter and/or
2213 * blending mode and/or translucency to a view and all its children.</p>
Romain Guy6c319ca2011-01-11 14:29:25 -08002214 * <p>A hardware layer can be used to cache a complex view tree into a
2215 * texture and reduce the complexity of drawing operations. For instance,
2216 * when animating a complex view tree with a translation, a hardware layer can
2217 * be used to render the view tree only once.</p>
Romain Guy171c5922011-01-06 10:04:23 -08002218 * <p>A hardware layer can also be used to increase the rendering quality when
2219 * rotation transformations are applied on a view. It can also be used to
2220 * prevent potential clipping issues when applying 3D transforms on a view.</p>
2221 *
2222 * @see #getLayerType()
2223 * @see #setLayerType(int, android.graphics.Paint)
2224 * @see #LAYER_TYPE_NONE
2225 * @see #LAYER_TYPE_SOFTWARE
2226 */
2227 public static final int LAYER_TYPE_HARDWARE = 2;
2228
Romain Guy3aaff3a2011-01-12 14:18:47 -08002229 @ViewDebug.ExportedProperty(category = "drawing", mapping = {
2230 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"),
2231 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"),
2232 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE")
2233 })
Romain Guy171c5922011-01-06 10:04:23 -08002234 int mLayerType = LAYER_TYPE_NONE;
2235 Paint mLayerPaint;
2236
2237 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002238 * Simple constructor to use when creating a view from code.
2239 *
2240 * @param context The Context the view is running in, through which it can
2241 * access the current theme, resources, etc.
2242 */
2243 public View(Context context) {
2244 mContext = context;
2245 mResources = context != null ? context.getResources() : null;
Romain Guy8f1344f52009-05-15 16:03:59 -07002246 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED;
Adam Powelle14579b2009-12-16 18:39:52 -08002247 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop();
Adam Powell637d3372010-08-25 14:37:03 -07002248 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002249 }
2250
2251 /**
2252 * Constructor that is called when inflating a view from XML. This is called
2253 * when a view is being constructed from an XML file, supplying attributes
2254 * that were specified in the XML file. This version uses a default style of
2255 * 0, so the only attribute values applied are those in the Context's Theme
2256 * and the given AttributeSet.
2257 *
2258 * <p>
2259 * The method onFinishInflate() will be called after all children have been
2260 * added.
2261 *
2262 * @param context The Context the view is running in, through which it can
2263 * access the current theme, resources, etc.
2264 * @param attrs The attributes of the XML tag that is inflating the view.
2265 * @see #View(Context, AttributeSet, int)
2266 */
2267 public View(Context context, AttributeSet attrs) {
2268 this(context, attrs, 0);
2269 }
2270
2271 /**
2272 * Perform inflation from XML and apply a class-specific base style. This
2273 * constructor of View allows subclasses to use their own base style when
2274 * they are inflating. For example, a Button class's constructor would call
2275 * this version of the super class constructor and supply
2276 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
2277 * the theme's button style to modify all of the base view attributes (in
2278 * particular its background) as well as the Button class's attributes.
2279 *
2280 * @param context The Context the view is running in, through which it can
2281 * access the current theme, resources, etc.
2282 * @param attrs The attributes of the XML tag that is inflating the view.
2283 * @param defStyle The default style to apply to this view. If 0, no style
2284 * will be applied (beyond what is included in the theme). This may
2285 * either be an attribute resource, whose value will be retrieved
2286 * from the current theme, or an explicit style resource.
2287 * @see #View(Context, AttributeSet)
2288 */
2289 public View(Context context, AttributeSet attrs, int defStyle) {
2290 this(context);
2291
2292 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
2293 defStyle, 0);
2294
2295 Drawable background = null;
2296
2297 int leftPadding = -1;
2298 int topPadding = -1;
2299 int rightPadding = -1;
2300 int bottomPadding = -1;
2301
2302 int padding = -1;
2303
2304 int viewFlagValues = 0;
2305 int viewFlagMasks = 0;
2306
2307 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07002308
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002309 int x = 0;
2310 int y = 0;
2311
Chet Haase73066682010-11-29 15:55:32 -08002312 float tx = 0;
2313 float ty = 0;
2314 float rotation = 0;
2315 float rotationX = 0;
2316 float rotationY = 0;
2317 float sx = 1f;
2318 float sy = 1f;
2319 boolean transformSet = false;
2320
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002321 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
2322
Adam Powell637d3372010-08-25 14:37:03 -07002323 int overScrollMode = mOverScrollMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002324 final int N = a.getIndexCount();
2325 for (int i = 0; i < N; i++) {
2326 int attr = a.getIndex(i);
2327 switch (attr) {
2328 case com.android.internal.R.styleable.View_background:
2329 background = a.getDrawable(attr);
2330 break;
2331 case com.android.internal.R.styleable.View_padding:
2332 padding = a.getDimensionPixelSize(attr, -1);
2333 break;
2334 case com.android.internal.R.styleable.View_paddingLeft:
2335 leftPadding = a.getDimensionPixelSize(attr, -1);
2336 break;
2337 case com.android.internal.R.styleable.View_paddingTop:
2338 topPadding = a.getDimensionPixelSize(attr, -1);
2339 break;
2340 case com.android.internal.R.styleable.View_paddingRight:
2341 rightPadding = a.getDimensionPixelSize(attr, -1);
2342 break;
2343 case com.android.internal.R.styleable.View_paddingBottom:
2344 bottomPadding = a.getDimensionPixelSize(attr, -1);
2345 break;
2346 case com.android.internal.R.styleable.View_scrollX:
2347 x = a.getDimensionPixelOffset(attr, 0);
2348 break;
2349 case com.android.internal.R.styleable.View_scrollY:
2350 y = a.getDimensionPixelOffset(attr, 0);
2351 break;
Chet Haase73066682010-11-29 15:55:32 -08002352 case com.android.internal.R.styleable.View_alpha:
2353 setAlpha(a.getFloat(attr, 1f));
2354 break;
2355 case com.android.internal.R.styleable.View_transformPivotX:
2356 setPivotX(a.getDimensionPixelOffset(attr, 0));
2357 break;
2358 case com.android.internal.R.styleable.View_transformPivotY:
2359 setPivotY(a.getDimensionPixelOffset(attr, 0));
2360 break;
2361 case com.android.internal.R.styleable.View_translationX:
2362 tx = a.getDimensionPixelOffset(attr, 0);
2363 transformSet = true;
2364 break;
2365 case com.android.internal.R.styleable.View_translationY:
2366 ty = a.getDimensionPixelOffset(attr, 0);
2367 transformSet = true;
2368 break;
2369 case com.android.internal.R.styleable.View_rotation:
2370 rotation = a.getFloat(attr, 0);
2371 transformSet = true;
2372 break;
2373 case com.android.internal.R.styleable.View_rotationX:
2374 rotationX = a.getFloat(attr, 0);
2375 transformSet = true;
2376 break;
2377 case com.android.internal.R.styleable.View_rotationY:
2378 rotationY = a.getFloat(attr, 0);
2379 transformSet = true;
2380 break;
2381 case com.android.internal.R.styleable.View_scaleX:
2382 sx = a.getFloat(attr, 1f);
2383 transformSet = true;
2384 break;
2385 case com.android.internal.R.styleable.View_scaleY:
2386 sy = a.getFloat(attr, 1f);
2387 transformSet = true;
2388 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002389 case com.android.internal.R.styleable.View_id:
2390 mID = a.getResourceId(attr, NO_ID);
2391 break;
2392 case com.android.internal.R.styleable.View_tag:
2393 mTag = a.getText(attr);
2394 break;
2395 case com.android.internal.R.styleable.View_fitsSystemWindows:
2396 if (a.getBoolean(attr, false)) {
2397 viewFlagValues |= FITS_SYSTEM_WINDOWS;
2398 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
2399 }
2400 break;
2401 case com.android.internal.R.styleable.View_focusable:
2402 if (a.getBoolean(attr, false)) {
2403 viewFlagValues |= FOCUSABLE;
2404 viewFlagMasks |= FOCUSABLE_MASK;
2405 }
2406 break;
2407 case com.android.internal.R.styleable.View_focusableInTouchMode:
2408 if (a.getBoolean(attr, false)) {
2409 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
2410 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
2411 }
2412 break;
2413 case com.android.internal.R.styleable.View_clickable:
2414 if (a.getBoolean(attr, false)) {
2415 viewFlagValues |= CLICKABLE;
2416 viewFlagMasks |= CLICKABLE;
2417 }
2418 break;
2419 case com.android.internal.R.styleable.View_longClickable:
2420 if (a.getBoolean(attr, false)) {
2421 viewFlagValues |= LONG_CLICKABLE;
2422 viewFlagMasks |= LONG_CLICKABLE;
2423 }
2424 break;
2425 case com.android.internal.R.styleable.View_saveEnabled:
2426 if (!a.getBoolean(attr, true)) {
2427 viewFlagValues |= SAVE_DISABLED;
2428 viewFlagMasks |= SAVE_DISABLED_MASK;
2429 }
2430 break;
2431 case com.android.internal.R.styleable.View_duplicateParentState:
2432 if (a.getBoolean(attr, false)) {
2433 viewFlagValues |= DUPLICATE_PARENT_STATE;
2434 viewFlagMasks |= DUPLICATE_PARENT_STATE;
2435 }
2436 break;
2437 case com.android.internal.R.styleable.View_visibility:
2438 final int visibility = a.getInt(attr, 0);
2439 if (visibility != 0) {
2440 viewFlagValues |= VISIBILITY_FLAGS[visibility];
2441 viewFlagMasks |= VISIBILITY_MASK;
2442 }
2443 break;
2444 case com.android.internal.R.styleable.View_drawingCacheQuality:
2445 final int cacheQuality = a.getInt(attr, 0);
2446 if (cacheQuality != 0) {
2447 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
2448 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
2449 }
2450 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07002451 case com.android.internal.R.styleable.View_contentDescription:
2452 mContentDescription = a.getString(attr);
2453 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002454 case com.android.internal.R.styleable.View_soundEffectsEnabled:
2455 if (!a.getBoolean(attr, true)) {
2456 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
2457 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
2458 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002459 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002460 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
2461 if (!a.getBoolean(attr, true)) {
2462 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
2463 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
2464 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002465 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002466 case R.styleable.View_scrollbars:
2467 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
2468 if (scrollbars != SCROLLBARS_NONE) {
2469 viewFlagValues |= scrollbars;
2470 viewFlagMasks |= SCROLLBARS_MASK;
2471 initializeScrollbars(a);
2472 }
2473 break;
2474 case R.styleable.View_fadingEdge:
2475 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
2476 if (fadingEdge != FADING_EDGE_NONE) {
2477 viewFlagValues |= fadingEdge;
2478 viewFlagMasks |= FADING_EDGE_MASK;
2479 initializeFadingEdge(a);
2480 }
2481 break;
2482 case R.styleable.View_scrollbarStyle:
2483 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
2484 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2485 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
2486 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
2487 }
2488 break;
2489 case R.styleable.View_isScrollContainer:
2490 setScrollContainer = true;
2491 if (a.getBoolean(attr, false)) {
2492 setScrollContainer(true);
2493 }
2494 break;
2495 case com.android.internal.R.styleable.View_keepScreenOn:
2496 if (a.getBoolean(attr, false)) {
2497 viewFlagValues |= KEEP_SCREEN_ON;
2498 viewFlagMasks |= KEEP_SCREEN_ON;
2499 }
2500 break;
Jeff Brown85a31762010-09-01 17:01:00 -07002501 case R.styleable.View_filterTouchesWhenObscured:
2502 if (a.getBoolean(attr, false)) {
2503 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED;
2504 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED;
2505 }
2506 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002507 case R.styleable.View_nextFocusLeft:
2508 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
2509 break;
2510 case R.styleable.View_nextFocusRight:
2511 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
2512 break;
2513 case R.styleable.View_nextFocusUp:
2514 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
2515 break;
2516 case R.styleable.View_nextFocusDown:
2517 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
2518 break;
Jeff Brown4e6319b2010-12-13 10:36:51 -08002519 case R.styleable.View_nextFocusForward:
2520 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID);
2521 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002522 case R.styleable.View_minWidth:
2523 mMinWidth = a.getDimensionPixelSize(attr, 0);
2524 break;
2525 case R.styleable.View_minHeight:
2526 mMinHeight = a.getDimensionPixelSize(attr, 0);
2527 break;
Romain Guy9a817362009-05-01 10:57:14 -07002528 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07002529 if (context.isRestricted()) {
2530 throw new IllegalStateException("The android:onClick attribute cannot "
2531 + "be used within a restricted context");
2532 }
2533
Romain Guy9a817362009-05-01 10:57:14 -07002534 final String handlerName = a.getString(attr);
2535 if (handlerName != null) {
2536 setOnClickListener(new OnClickListener() {
2537 private Method mHandler;
2538
2539 public void onClick(View v) {
2540 if (mHandler == null) {
2541 try {
2542 mHandler = getContext().getClass().getMethod(handlerName,
2543 View.class);
2544 } catch (NoSuchMethodException e) {
Joe Onorato42e14d72010-03-11 14:51:17 -08002545 int id = getId();
2546 String idText = id == NO_ID ? "" : " with id '"
2547 + getContext().getResources().getResourceEntryName(
2548 id) + "'";
Romain Guy9a817362009-05-01 10:57:14 -07002549 throw new IllegalStateException("Could not find a method " +
Joe Onorato42e14d72010-03-11 14:51:17 -08002550 handlerName + "(View) in the activity "
2551 + getContext().getClass() + " for onClick handler"
2552 + " on view " + View.this.getClass() + idText, e);
Romain Guy9a817362009-05-01 10:57:14 -07002553 }
2554 }
2555
2556 try {
2557 mHandler.invoke(getContext(), View.this);
2558 } catch (IllegalAccessException e) {
2559 throw new IllegalStateException("Could not execute non "
2560 + "public method of the activity", e);
2561 } catch (InvocationTargetException e) {
2562 throw new IllegalStateException("Could not execute "
2563 + "method of the activity", e);
2564 }
2565 }
2566 });
2567 }
2568 break;
Adam Powell637d3372010-08-25 14:37:03 -07002569 case R.styleable.View_overScrollMode:
2570 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS);
2571 break;
Adam Powell20232d02010-12-08 21:08:53 -08002572 case R.styleable.View_verticalScrollbarPosition:
2573 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT);
2574 break;
Romain Guy171c5922011-01-06 10:04:23 -08002575 case R.styleable.View_layerType:
2576 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null);
2577 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002578 }
2579 }
2580
Adam Powell637d3372010-08-25 14:37:03 -07002581 setOverScrollMode(overScrollMode);
2582
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002583 if (background != null) {
2584 setBackgroundDrawable(background);
2585 }
2586
2587 if (padding >= 0) {
2588 leftPadding = padding;
2589 topPadding = padding;
2590 rightPadding = padding;
2591 bottomPadding = padding;
2592 }
2593
2594 // If the user specified the padding (either with android:padding or
2595 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
2596 // use the default padding or the padding from the background drawable
2597 // (stored at this point in mPadding*)
2598 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
2599 topPadding >= 0 ? topPadding : mPaddingTop,
2600 rightPadding >= 0 ? rightPadding : mPaddingRight,
2601 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
2602
2603 if (viewFlagMasks != 0) {
2604 setFlags(viewFlagValues, viewFlagMasks);
2605 }
2606
2607 // Needs to be called after mViewFlags is set
2608 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2609 recomputePadding();
2610 }
2611
2612 if (x != 0 || y != 0) {
2613 scrollTo(x, y);
2614 }
2615
Chet Haase73066682010-11-29 15:55:32 -08002616 if (transformSet) {
2617 setTranslationX(tx);
2618 setTranslationY(ty);
2619 setRotation(rotation);
2620 setRotationX(rotationX);
2621 setRotationY(rotationY);
2622 setScaleX(sx);
2623 setScaleY(sy);
2624 }
2625
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002626 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
2627 setScrollContainer(true);
2628 }
Romain Guy8f1344f52009-05-15 16:03:59 -07002629
2630 computeOpaqueFlags();
2631
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002632 a.recycle();
2633 }
2634
2635 /**
2636 * Non-public constructor for use in testing
2637 */
2638 View() {
2639 }
2640
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002641 /**
2642 * <p>
2643 * Initializes the fading edges from a given set of styled attributes. This
2644 * method should be called by subclasses that need fading edges and when an
2645 * instance of these subclasses is created programmatically rather than
2646 * being inflated from XML. This method is automatically called when the XML
2647 * is inflated.
2648 * </p>
2649 *
2650 * @param a the styled attributes set to initialize the fading edges from
2651 */
2652 protected void initializeFadingEdge(TypedArray a) {
2653 initScrollCache();
2654
2655 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
2656 R.styleable.View_fadingEdgeLength,
2657 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
2658 }
2659
2660 /**
2661 * Returns the size of the vertical faded edges used to indicate that more
2662 * content in this view is visible.
2663 *
2664 * @return The size in pixels of the vertical faded edge or 0 if vertical
2665 * faded edges are not enabled for this view.
2666 * @attr ref android.R.styleable#View_fadingEdgeLength
2667 */
2668 public int getVerticalFadingEdgeLength() {
2669 if (isVerticalFadingEdgeEnabled()) {
2670 ScrollabilityCache cache = mScrollCache;
2671 if (cache != null) {
2672 return cache.fadingEdgeLength;
2673 }
2674 }
2675 return 0;
2676 }
2677
2678 /**
2679 * Set the size of the faded edge used to indicate that more content in this
2680 * view is available. Will not change whether the fading edge is enabled; use
2681 * {@link #setVerticalFadingEdgeEnabled} or {@link #setHorizontalFadingEdgeEnabled}
2682 * to enable the fading edge for the vertical or horizontal fading edges.
2683 *
2684 * @param length The size in pixels of the faded edge used to indicate that more
2685 * content in this view is visible.
2686 */
2687 public void setFadingEdgeLength(int length) {
2688 initScrollCache();
2689 mScrollCache.fadingEdgeLength = length;
2690 }
2691
2692 /**
2693 * Returns the size of the horizontal faded edges used to indicate that more
2694 * content in this view is visible.
2695 *
2696 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
2697 * faded edges are not enabled for this view.
2698 * @attr ref android.R.styleable#View_fadingEdgeLength
2699 */
2700 public int getHorizontalFadingEdgeLength() {
2701 if (isHorizontalFadingEdgeEnabled()) {
2702 ScrollabilityCache cache = mScrollCache;
2703 if (cache != null) {
2704 return cache.fadingEdgeLength;
2705 }
2706 }
2707 return 0;
2708 }
2709
2710 /**
2711 * Returns the width of the vertical scrollbar.
2712 *
2713 * @return The width in pixels of the vertical scrollbar or 0 if there
2714 * is no vertical scrollbar.
2715 */
2716 public int getVerticalScrollbarWidth() {
2717 ScrollabilityCache cache = mScrollCache;
2718 if (cache != null) {
2719 ScrollBarDrawable scrollBar = cache.scrollBar;
2720 if (scrollBar != null) {
2721 int size = scrollBar.getSize(true);
2722 if (size <= 0) {
2723 size = cache.scrollBarSize;
2724 }
2725 return size;
2726 }
2727 return 0;
2728 }
2729 return 0;
2730 }
2731
2732 /**
2733 * Returns the height of the horizontal scrollbar.
2734 *
2735 * @return The height in pixels of the horizontal scrollbar or 0 if
2736 * there is no horizontal scrollbar.
2737 */
2738 protected int getHorizontalScrollbarHeight() {
2739 ScrollabilityCache cache = mScrollCache;
2740 if (cache != null) {
2741 ScrollBarDrawable scrollBar = cache.scrollBar;
2742 if (scrollBar != null) {
2743 int size = scrollBar.getSize(false);
2744 if (size <= 0) {
2745 size = cache.scrollBarSize;
2746 }
2747 return size;
2748 }
2749 return 0;
2750 }
2751 return 0;
2752 }
2753
2754 /**
2755 * <p>
2756 * Initializes the scrollbars from a given set of styled attributes. This
2757 * method should be called by subclasses that need scrollbars and when an
2758 * instance of these subclasses is created programmatically rather than
2759 * being inflated from XML. This method is automatically called when the XML
2760 * is inflated.
2761 * </p>
2762 *
2763 * @param a the styled attributes set to initialize the scrollbars from
2764 */
2765 protected void initializeScrollbars(TypedArray a) {
2766 initScrollCache();
2767
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002768 final ScrollabilityCache scrollabilityCache = mScrollCache;
Mike Cleronf116bf82009-09-27 19:14:12 -07002769
2770 if (scrollabilityCache.scrollBar == null) {
2771 scrollabilityCache.scrollBar = new ScrollBarDrawable();
2772 }
2773
Romain Guy8bda2482010-03-02 11:42:11 -08002774 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002775
Mike Cleronf116bf82009-09-27 19:14:12 -07002776 if (!fadeScrollbars) {
2777 scrollabilityCache.state = ScrollabilityCache.ON;
2778 }
2779 scrollabilityCache.fadeScrollBars = fadeScrollbars;
2780
2781
2782 scrollabilityCache.scrollBarFadeDuration = a.getInt(
2783 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
2784 .getScrollBarFadeDuration());
2785 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
2786 R.styleable.View_scrollbarDefaultDelayBeforeFade,
2787 ViewConfiguration.getScrollDefaultDelay());
2788
2789
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002790 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
2791 com.android.internal.R.styleable.View_scrollbarSize,
2792 ViewConfiguration.get(mContext).getScaledScrollBarSize());
2793
2794 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
2795 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
2796
2797 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
2798 if (thumb != null) {
2799 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
2800 }
2801
2802 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
2803 false);
2804 if (alwaysDraw) {
2805 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
2806 }
2807
2808 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
2809 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
2810
2811 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
2812 if (thumb != null) {
2813 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
2814 }
2815
2816 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
2817 false);
2818 if (alwaysDraw) {
2819 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
2820 }
2821
2822 // Re-apply user/background padding so that scrollbar(s) get added
2823 recomputePadding();
2824 }
2825
2826 /**
2827 * <p>
2828 * Initalizes the scrollability cache if necessary.
2829 * </p>
2830 */
2831 private void initScrollCache() {
2832 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07002833 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002834 }
2835 }
2836
2837 /**
Adam Powell20232d02010-12-08 21:08:53 -08002838 * Set the position of the vertical scroll bar. Should be one of
2839 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or
2840 * {@link #SCROLLBAR_POSITION_RIGHT}.
2841 *
2842 * @param position Where the vertical scroll bar should be positioned.
2843 */
2844 public void setVerticalScrollbarPosition(int position) {
2845 if (mVerticalScrollbarPosition != position) {
2846 mVerticalScrollbarPosition = position;
2847 computeOpaqueFlags();
2848 recomputePadding();
2849 }
2850 }
2851
2852 /**
2853 * @return The position where the vertical scroll bar will show, if applicable.
2854 * @see #setVerticalScrollbarPosition(int)
2855 */
2856 public int getVerticalScrollbarPosition() {
2857 return mVerticalScrollbarPosition;
2858 }
2859
2860 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002861 * Register a callback to be invoked when focus of this view changed.
2862 *
2863 * @param l The callback that will run.
2864 */
2865 public void setOnFocusChangeListener(OnFocusChangeListener l) {
2866 mOnFocusChangeListener = l;
2867 }
2868
2869 /**
Chet Haase21cd1382010-09-01 17:42:29 -07002870 * Add a listener that will be called when the bounds of the view change due to
2871 * layout processing.
2872 *
2873 * @param listener The listener that will be called when layout bounds change.
2874 */
2875 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) {
2876 if (mOnLayoutChangeListeners == null) {
2877 mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>();
2878 }
2879 mOnLayoutChangeListeners.add(listener);
2880 }
2881
2882 /**
2883 * Remove a listener for layout changes.
2884 *
2885 * @param listener The listener for layout bounds change.
2886 */
2887 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) {
2888 if (mOnLayoutChangeListeners == null) {
2889 return;
2890 }
2891 mOnLayoutChangeListeners.remove(listener);
2892 }
2893
2894 /**
2895 * Gets the current list of listeners for layout changes.
Chet Haase21cd1382010-09-01 17:42:29 -07002896 */
2897 public List<OnLayoutChangeListener> getOnLayoutChangeListeners() {
2898 return mOnLayoutChangeListeners;
2899 }
2900
2901 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002902 * Returns the focus-change callback registered for this view.
2903 *
2904 * @return The callback, or null if one is not registered.
2905 */
2906 public OnFocusChangeListener getOnFocusChangeListener() {
2907 return mOnFocusChangeListener;
2908 }
2909
2910 /**
2911 * Register a callback to be invoked when this view is clicked. If this view is not
2912 * clickable, it becomes clickable.
2913 *
2914 * @param l The callback that will run
2915 *
2916 * @see #setClickable(boolean)
2917 */
2918 public void setOnClickListener(OnClickListener l) {
2919 if (!isClickable()) {
2920 setClickable(true);
2921 }
2922 mOnClickListener = l;
2923 }
2924
2925 /**
2926 * Register a callback to be invoked when this view is clicked and held. If this view is not
2927 * long clickable, it becomes long clickable.
2928 *
2929 * @param l The callback that will run
2930 *
2931 * @see #setLongClickable(boolean)
2932 */
2933 public void setOnLongClickListener(OnLongClickListener l) {
2934 if (!isLongClickable()) {
2935 setLongClickable(true);
2936 }
2937 mOnLongClickListener = l;
2938 }
2939
2940 /**
2941 * Register a callback to be invoked when the context menu for this view is
2942 * being built. If this view is not long clickable, it becomes long clickable.
2943 *
2944 * @param l The callback that will run
2945 *
2946 */
2947 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
2948 if (!isLongClickable()) {
2949 setLongClickable(true);
2950 }
2951 mOnCreateContextMenuListener = l;
2952 }
2953
2954 /**
2955 * Call this view's OnClickListener, if it is defined.
2956 *
2957 * @return True there was an assigned OnClickListener that was called, false
2958 * otherwise is returned.
2959 */
2960 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07002961 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
2962
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002963 if (mOnClickListener != null) {
2964 playSoundEffect(SoundEffectConstants.CLICK);
2965 mOnClickListener.onClick(this);
2966 return true;
2967 }
2968
2969 return false;
2970 }
2971
2972 /**
Gilles Debunnef788a9f2010-07-22 10:17:23 -07002973 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the
2974 * OnLongClickListener did not consume the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002975 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07002976 * @return True if one of the above receivers consumed the event, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002977 */
2978 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07002979 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
2980
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002981 boolean handled = false;
2982 if (mOnLongClickListener != null) {
2983 handled = mOnLongClickListener.onLongClick(View.this);
2984 }
2985 if (!handled) {
2986 handled = showContextMenu();
2987 }
2988 if (handled) {
2989 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
2990 }
2991 return handled;
2992 }
2993
2994 /**
2995 * Bring up the context menu for this view.
2996 *
2997 * @return Whether a context menu was displayed.
2998 */
2999 public boolean showContextMenu() {
3000 return getParent().showContextMenuForChild(this);
3001 }
3002
3003 /**
Adam Powell6e346362010-07-23 10:18:23 -07003004 * Start an action mode.
3005 *
3006 * @param callback Callback that will control the lifecycle of the action mode
3007 * @return The new action mode if it is started, null otherwise
3008 *
3009 * @see ActionMode
3010 */
3011 public ActionMode startActionMode(ActionMode.Callback callback) {
3012 return getParent().startActionModeForChild(this, callback);
3013 }
3014
3015 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003016 * Register a callback to be invoked when a key is pressed in this view.
3017 * @param l the key listener to attach to this view
3018 */
3019 public void setOnKeyListener(OnKeyListener l) {
3020 mOnKeyListener = l;
3021 }
3022
3023 /**
3024 * Register a callback to be invoked when a touch event is sent to this view.
3025 * @param l the touch listener to attach to this view
3026 */
3027 public void setOnTouchListener(OnTouchListener l) {
3028 mOnTouchListener = l;
3029 }
3030
3031 /**
Chris Tate32affef2010-10-18 15:29:21 -07003032 * Register a callback to be invoked when a drag event is sent to this view.
3033 * @param l The drag listener to attach to this view
3034 */
3035 public void setOnDragListener(OnDragListener l) {
3036 mOnDragListener = l;
3037 }
3038
3039 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003040 * Give this view focus. This will cause {@link #onFocusChanged} to be called.
3041 *
3042 * Note: this does not check whether this {@link View} should get focus, it just
3043 * gives it focus no matter what. It should only be called internally by framework
3044 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
3045 *
3046 * @param direction values are View.FOCUS_UP, View.FOCUS_DOWN,
3047 * View.FOCUS_LEFT or View.FOCUS_RIGHT. This is the direction which
3048 * focus moved when requestFocus() is called. It may not always
3049 * apply, in which case use the default View.FOCUS_DOWN.
3050 * @param previouslyFocusedRect The rectangle of the view that had focus
3051 * prior in this View's coordinate system.
3052 */
3053 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
3054 if (DBG) {
3055 System.out.println(this + " requestFocus()");
3056 }
3057
3058 if ((mPrivateFlags & FOCUSED) == 0) {
3059 mPrivateFlags |= FOCUSED;
3060
3061 if (mParent != null) {
3062 mParent.requestChildFocus(this, this);
3063 }
3064
3065 onFocusChanged(true, direction, previouslyFocusedRect);
3066 refreshDrawableState();
3067 }
3068 }
3069
3070 /**
3071 * Request that a rectangle of this view be visible on the screen,
3072 * scrolling if necessary just enough.
3073 *
3074 * <p>A View should call this if it maintains some notion of which part
3075 * of its content is interesting. For example, a text editing view
3076 * should call this when its cursor moves.
3077 *
3078 * @param rectangle The rectangle.
3079 * @return Whether any parent scrolled.
3080 */
3081 public boolean requestRectangleOnScreen(Rect rectangle) {
3082 return requestRectangleOnScreen(rectangle, false);
3083 }
3084
3085 /**
3086 * Request that a rectangle of this view be visible on the screen,
3087 * scrolling if necessary just enough.
3088 *
3089 * <p>A View should call this if it maintains some notion of which part
3090 * of its content is interesting. For example, a text editing view
3091 * should call this when its cursor moves.
3092 *
3093 * <p>When <code>immediate</code> is set to true, scrolling will not be
3094 * animated.
3095 *
3096 * @param rectangle The rectangle.
3097 * @param immediate True to forbid animated scrolling, false otherwise
3098 * @return Whether any parent scrolled.
3099 */
3100 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
3101 View child = this;
3102 ViewParent parent = mParent;
3103 boolean scrolled = false;
3104 while (parent != null) {
3105 scrolled |= parent.requestChildRectangleOnScreen(child,
3106 rectangle, immediate);
3107
3108 // offset rect so next call has the rectangle in the
3109 // coordinate system of its direct child.
3110 rectangle.offset(child.getLeft(), child.getTop());
3111 rectangle.offset(-child.getScrollX(), -child.getScrollY());
3112
3113 if (!(parent instanceof View)) {
3114 break;
3115 }
Romain Guy8506ab42009-06-11 17:35:47 -07003116
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003117 child = (View) parent;
3118 parent = child.getParent();
3119 }
3120 return scrolled;
3121 }
3122
3123 /**
3124 * Called when this view wants to give up focus. This will cause
3125 * {@link #onFocusChanged} to be called.
3126 */
3127 public void clearFocus() {
3128 if (DBG) {
3129 System.out.println(this + " clearFocus()");
3130 }
3131
3132 if ((mPrivateFlags & FOCUSED) != 0) {
3133 mPrivateFlags &= ~FOCUSED;
3134
3135 if (mParent != null) {
3136 mParent.clearChildFocus(this);
3137 }
3138
3139 onFocusChanged(false, 0, null);
3140 refreshDrawableState();
3141 }
3142 }
3143
3144 /**
3145 * Called to clear the focus of a view that is about to be removed.
3146 * Doesn't call clearChildFocus, which prevents this view from taking
3147 * focus again before it has been removed from the parent
3148 */
3149 void clearFocusForRemoval() {
3150 if ((mPrivateFlags & FOCUSED) != 0) {
3151 mPrivateFlags &= ~FOCUSED;
3152
3153 onFocusChanged(false, 0, null);
3154 refreshDrawableState();
3155 }
3156 }
3157
3158 /**
3159 * Called internally by the view system when a new view is getting focus.
3160 * This is what clears the old focus.
3161 */
3162 void unFocus() {
3163 if (DBG) {
3164 System.out.println(this + " unFocus()");
3165 }
3166
3167 if ((mPrivateFlags & FOCUSED) != 0) {
3168 mPrivateFlags &= ~FOCUSED;
3169
3170 onFocusChanged(false, 0, null);
3171 refreshDrawableState();
3172 }
3173 }
3174
3175 /**
3176 * Returns true if this view has focus iteself, or is the ancestor of the
3177 * view that has focus.
3178 *
3179 * @return True if this view has or contains focus, false otherwise.
3180 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003181 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003182 public boolean hasFocus() {
3183 return (mPrivateFlags & FOCUSED) != 0;
3184 }
3185
3186 /**
3187 * Returns true if this view is focusable or if it contains a reachable View
3188 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
3189 * is a View whose parents do not block descendants focus.
3190 *
3191 * Only {@link #VISIBLE} views are considered focusable.
3192 *
3193 * @return True if the view is focusable or if the view contains a focusable
3194 * View, false otherwise.
3195 *
3196 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
3197 */
3198 public boolean hasFocusable() {
3199 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
3200 }
3201
3202 /**
3203 * Called by the view system when the focus state of this view changes.
3204 * When the focus change event is caused by directional navigation, direction
3205 * and previouslyFocusedRect provide insight into where the focus is coming from.
3206 * When overriding, be sure to call up through to the super class so that
3207 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07003208 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003209 * @param gainFocus True if the View has focus; false otherwise.
3210 * @param direction The direction focus has moved when requestFocus()
3211 * is called to give this view focus. Values are
Jeff Brown4e6319b2010-12-13 10:36:51 -08003212 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT},
3213 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}.
3214 * It may not always apply, in which case use the default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003215 * @param previouslyFocusedRect The rectangle, in this view's coordinate
3216 * system, of the previously focused view. If applicable, this will be
3217 * passed in as finer grained information about where the focus is coming
3218 * from (in addition to direction). Will be <code>null</code> otherwise.
3219 */
3220 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07003221 if (gainFocus) {
3222 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
3223 }
3224
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003225 InputMethodManager imm = InputMethodManager.peekInstance();
3226 if (!gainFocus) {
3227 if (isPressed()) {
3228 setPressed(false);
3229 }
3230 if (imm != null && mAttachInfo != null
3231 && mAttachInfo.mHasWindowFocus) {
3232 imm.focusOut(this);
3233 }
Romain Guya2431d02009-04-30 16:30:00 -07003234 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003235 } else if (imm != null && mAttachInfo != null
3236 && mAttachInfo.mHasWindowFocus) {
3237 imm.focusIn(this);
3238 }
Romain Guy8506ab42009-06-11 17:35:47 -07003239
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003240 invalidate();
3241 if (mOnFocusChangeListener != null) {
3242 mOnFocusChangeListener.onFocusChange(this, gainFocus);
3243 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07003244
3245 if (mAttachInfo != null) {
3246 mAttachInfo.mKeyDispatchState.reset(this);
3247 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003248 }
3249
3250 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07003251 * {@inheritDoc}
3252 */
3253 public void sendAccessibilityEvent(int eventType) {
3254 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
3255 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
3256 }
3257 }
3258
3259 /**
3260 * {@inheritDoc}
3261 */
3262 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
3263 event.setClassName(getClass().getName());
3264 event.setPackageName(getContext().getPackageName());
3265 event.setEnabled(isEnabled());
3266 event.setContentDescription(mContentDescription);
3267
3268 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) {
3269 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList;
3270 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, FOCUSABLES_ALL);
3271 event.setItemCount(focusablesTempList.size());
3272 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
3273 focusablesTempList.clear();
3274 }
3275
3276 dispatchPopulateAccessibilityEvent(event);
3277
3278 AccessibilityManager.getInstance(mContext).sendAccessibilityEvent(event);
3279 }
3280
3281 /**
3282 * Dispatches an {@link AccessibilityEvent} to the {@link View} children
3283 * to be populated.
3284 *
3285 * @param event The event.
3286 *
3287 * @return True if the event population was completed.
3288 */
3289 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
3290 return false;
3291 }
3292
3293 /**
3294 * Gets the {@link View} description. It briefly describes the view and is
3295 * primarily used for accessibility support. Set this property to enable
3296 * better accessibility support for your application. This is especially
3297 * true for views that do not have textual representation (For example,
3298 * ImageButton).
3299 *
3300 * @return The content descriptiopn.
3301 *
3302 * @attr ref android.R.styleable#View_contentDescription
3303 */
3304 public CharSequence getContentDescription() {
3305 return mContentDescription;
3306 }
3307
3308 /**
3309 * Sets the {@link View} description. It briefly describes the view and is
3310 * primarily used for accessibility support. Set this property to enable
3311 * better accessibility support for your application. This is especially
3312 * true for views that do not have textual representation (For example,
3313 * ImageButton).
3314 *
3315 * @param contentDescription The content description.
3316 *
3317 * @attr ref android.R.styleable#View_contentDescription
3318 */
3319 public void setContentDescription(CharSequence contentDescription) {
3320 mContentDescription = contentDescription;
3321 }
3322
3323 /**
Romain Guya2431d02009-04-30 16:30:00 -07003324 * Invoked whenever this view loses focus, either by losing window focus or by losing
3325 * focus within its window. This method can be used to clear any state tied to the
3326 * focus. For instance, if a button is held pressed with the trackball and the window
3327 * loses focus, this method can be used to cancel the press.
3328 *
3329 * Subclasses of View overriding this method should always call super.onFocusLost().
3330 *
3331 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07003332 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07003333 *
3334 * @hide pending API council approval
3335 */
3336 protected void onFocusLost() {
3337 resetPressedState();
3338 }
3339
3340 private void resetPressedState() {
3341 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
3342 return;
3343 }
3344
3345 if (isPressed()) {
3346 setPressed(false);
3347
3348 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05003349 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07003350 }
3351 }
3352 }
3353
3354 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003355 * Returns true if this view has focus
3356 *
3357 * @return True if this view has focus, false otherwise.
3358 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003359 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003360 public boolean isFocused() {
3361 return (mPrivateFlags & FOCUSED) != 0;
3362 }
3363
3364 /**
3365 * Find the view in the hierarchy rooted at this view that currently has
3366 * focus.
3367 *
3368 * @return The view that currently has focus, or null if no focused view can
3369 * be found.
3370 */
3371 public View findFocus() {
3372 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
3373 }
3374
3375 /**
3376 * Change whether this view is one of the set of scrollable containers in
3377 * its window. This will be used to determine whether the window can
3378 * resize or must pan when a soft input area is open -- scrollable
3379 * containers allow the window to use resize mode since the container
3380 * will appropriately shrink.
3381 */
3382 public void setScrollContainer(boolean isScrollContainer) {
3383 if (isScrollContainer) {
3384 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
3385 mAttachInfo.mScrollContainers.add(this);
3386 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
3387 }
3388 mPrivateFlags |= SCROLL_CONTAINER;
3389 } else {
3390 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
3391 mAttachInfo.mScrollContainers.remove(this);
3392 }
3393 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
3394 }
3395 }
3396
3397 /**
3398 * Returns the quality of the drawing cache.
3399 *
3400 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3401 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3402 *
3403 * @see #setDrawingCacheQuality(int)
3404 * @see #setDrawingCacheEnabled(boolean)
3405 * @see #isDrawingCacheEnabled()
3406 *
3407 * @attr ref android.R.styleable#View_drawingCacheQuality
3408 */
3409 public int getDrawingCacheQuality() {
3410 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
3411 }
3412
3413 /**
3414 * Set the drawing cache quality of this view. This value is used only when the
3415 * drawing cache is enabled
3416 *
3417 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3418 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3419 *
3420 * @see #getDrawingCacheQuality()
3421 * @see #setDrawingCacheEnabled(boolean)
3422 * @see #isDrawingCacheEnabled()
3423 *
3424 * @attr ref android.R.styleable#View_drawingCacheQuality
3425 */
3426 public void setDrawingCacheQuality(int quality) {
3427 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
3428 }
3429
3430 /**
3431 * Returns whether the screen should remain on, corresponding to the current
3432 * value of {@link #KEEP_SCREEN_ON}.
3433 *
3434 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
3435 *
3436 * @see #setKeepScreenOn(boolean)
3437 *
3438 * @attr ref android.R.styleable#View_keepScreenOn
3439 */
3440 public boolean getKeepScreenOn() {
3441 return (mViewFlags & KEEP_SCREEN_ON) != 0;
3442 }
3443
3444 /**
3445 * Controls whether the screen should remain on, modifying the
3446 * value of {@link #KEEP_SCREEN_ON}.
3447 *
3448 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
3449 *
3450 * @see #getKeepScreenOn()
3451 *
3452 * @attr ref android.R.styleable#View_keepScreenOn
3453 */
3454 public void setKeepScreenOn(boolean keepScreenOn) {
3455 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
3456 }
3457
3458 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003459 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
3460 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003461 *
3462 * @attr ref android.R.styleable#View_nextFocusLeft
3463 */
3464 public int getNextFocusLeftId() {
3465 return mNextFocusLeftId;
3466 }
3467
3468 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003469 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
3470 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
3471 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003472 *
3473 * @attr ref android.R.styleable#View_nextFocusLeft
3474 */
3475 public void setNextFocusLeftId(int nextFocusLeftId) {
3476 mNextFocusLeftId = nextFocusLeftId;
3477 }
3478
3479 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003480 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
3481 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003482 *
3483 * @attr ref android.R.styleable#View_nextFocusRight
3484 */
3485 public int getNextFocusRightId() {
3486 return mNextFocusRightId;
3487 }
3488
3489 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003490 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
3491 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
3492 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003493 *
3494 * @attr ref android.R.styleable#View_nextFocusRight
3495 */
3496 public void setNextFocusRightId(int nextFocusRightId) {
3497 mNextFocusRightId = nextFocusRightId;
3498 }
3499
3500 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003501 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
3502 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003503 *
3504 * @attr ref android.R.styleable#View_nextFocusUp
3505 */
3506 public int getNextFocusUpId() {
3507 return mNextFocusUpId;
3508 }
3509
3510 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003511 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
3512 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
3513 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003514 *
3515 * @attr ref android.R.styleable#View_nextFocusUp
3516 */
3517 public void setNextFocusUpId(int nextFocusUpId) {
3518 mNextFocusUpId = nextFocusUpId;
3519 }
3520
3521 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003522 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
3523 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003524 *
3525 * @attr ref android.R.styleable#View_nextFocusDown
3526 */
3527 public int getNextFocusDownId() {
3528 return mNextFocusDownId;
3529 }
3530
3531 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003532 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
3533 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
3534 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003535 *
3536 * @attr ref android.R.styleable#View_nextFocusDown
3537 */
3538 public void setNextFocusDownId(int nextFocusDownId) {
3539 mNextFocusDownId = nextFocusDownId;
3540 }
3541
3542 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003543 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
3544 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
3545 *
3546 * @attr ref android.R.styleable#View_nextFocusForward
3547 */
3548 public int getNextFocusForwardId() {
3549 return mNextFocusForwardId;
3550 }
3551
3552 /**
3553 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
3554 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
3555 * decide automatically.
3556 *
3557 * @attr ref android.R.styleable#View_nextFocusForward
3558 */
3559 public void setNextFocusForwardId(int nextFocusForwardId) {
3560 mNextFocusForwardId = nextFocusForwardId;
3561 }
3562
3563 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003564 * Returns the visibility of this view and all of its ancestors
3565 *
3566 * @return True if this view and all of its ancestors are {@link #VISIBLE}
3567 */
3568 public boolean isShown() {
3569 View current = this;
3570 //noinspection ConstantConditions
3571 do {
3572 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
3573 return false;
3574 }
3575 ViewParent parent = current.mParent;
3576 if (parent == null) {
3577 return false; // We are not attached to the view root
3578 }
3579 if (!(parent instanceof View)) {
3580 return true;
3581 }
3582 current = (View) parent;
3583 } while (current != null);
3584
3585 return false;
3586 }
3587
3588 /**
3589 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag
3590 * is set
3591 *
3592 * @param insets Insets for system windows
3593 *
3594 * @return True if this view applied the insets, false otherwise
3595 */
3596 protected boolean fitSystemWindows(Rect insets) {
3597 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
3598 mPaddingLeft = insets.left;
3599 mPaddingTop = insets.top;
3600 mPaddingRight = insets.right;
3601 mPaddingBottom = insets.bottom;
3602 requestLayout();
3603 return true;
3604 }
3605 return false;
3606 }
3607
3608 /**
Jim Miller0b2a6d02010-07-13 18:01:29 -07003609 * Determine if this view has the FITS_SYSTEM_WINDOWS flag set.
3610 * @return True if window has FITS_SYSTEM_WINDOWS set
3611 *
3612 * @hide
3613 */
3614 public boolean isFitsSystemWindowsFlagSet() {
3615 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
3616 }
3617
3618 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003619 * Returns the visibility status for this view.
3620 *
3621 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3622 * @attr ref android.R.styleable#View_visibility
3623 */
3624 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07003625 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
3626 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
3627 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003628 })
3629 public int getVisibility() {
3630 return mViewFlags & VISIBILITY_MASK;
3631 }
3632
3633 /**
3634 * Set the enabled state of this view.
3635 *
3636 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3637 * @attr ref android.R.styleable#View_visibility
3638 */
3639 @RemotableViewMethod
3640 public void setVisibility(int visibility) {
3641 setFlags(visibility, VISIBILITY_MASK);
3642 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false);
3643 }
3644
3645 /**
3646 * Returns the enabled status for this view. The interpretation of the
3647 * enabled state varies by subclass.
3648 *
3649 * @return True if this view is enabled, false otherwise.
3650 */
3651 @ViewDebug.ExportedProperty
3652 public boolean isEnabled() {
3653 return (mViewFlags & ENABLED_MASK) == ENABLED;
3654 }
3655
3656 /**
3657 * Set the enabled state of this view. The interpretation of the enabled
3658 * state varies by subclass.
3659 *
3660 * @param enabled True if this view is enabled, false otherwise.
3661 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08003662 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003663 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07003664 if (enabled == isEnabled()) return;
3665
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003666 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
3667
3668 /*
3669 * The View most likely has to change its appearance, so refresh
3670 * the drawable state.
3671 */
3672 refreshDrawableState();
3673
3674 // Invalidate too, since the default behavior for views is to be
3675 // be drawn at 50% alpha rather than to change the drawable.
3676 invalidate();
3677 }
3678
3679 /**
3680 * Set whether this view can receive the focus.
3681 *
3682 * Setting this to false will also ensure that this view is not focusable
3683 * in touch mode.
3684 *
3685 * @param focusable If true, this view can receive the focus.
3686 *
3687 * @see #setFocusableInTouchMode(boolean)
3688 * @attr ref android.R.styleable#View_focusable
3689 */
3690 public void setFocusable(boolean focusable) {
3691 if (!focusable) {
3692 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
3693 }
3694 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
3695 }
3696
3697 /**
3698 * Set whether this view can receive focus while in touch mode.
3699 *
3700 * Setting this to true will also ensure that this view is focusable.
3701 *
3702 * @param focusableInTouchMode If true, this view can receive the focus while
3703 * in touch mode.
3704 *
3705 * @see #setFocusable(boolean)
3706 * @attr ref android.R.styleable#View_focusableInTouchMode
3707 */
3708 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
3709 // Focusable in touch mode should always be set before the focusable flag
3710 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
3711 // which, in touch mode, will not successfully request focus on this view
3712 // because the focusable in touch mode flag is not set
3713 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
3714 if (focusableInTouchMode) {
3715 setFlags(FOCUSABLE, FOCUSABLE_MASK);
3716 }
3717 }
3718
3719 /**
3720 * Set whether this view should have sound effects enabled for events such as
3721 * clicking and touching.
3722 *
3723 * <p>You may wish to disable sound effects for a view if you already play sounds,
3724 * for instance, a dial key that plays dtmf tones.
3725 *
3726 * @param soundEffectsEnabled whether sound effects are enabled for this view.
3727 * @see #isSoundEffectsEnabled()
3728 * @see #playSoundEffect(int)
3729 * @attr ref android.R.styleable#View_soundEffectsEnabled
3730 */
3731 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
3732 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
3733 }
3734
3735 /**
3736 * @return whether this view should have sound effects enabled for events such as
3737 * clicking and touching.
3738 *
3739 * @see #setSoundEffectsEnabled(boolean)
3740 * @see #playSoundEffect(int)
3741 * @attr ref android.R.styleable#View_soundEffectsEnabled
3742 */
3743 @ViewDebug.ExportedProperty
3744 public boolean isSoundEffectsEnabled() {
3745 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
3746 }
3747
3748 /**
3749 * Set whether this view should have haptic feedback for events such as
3750 * long presses.
3751 *
3752 * <p>You may wish to disable haptic feedback if your view already controls
3753 * its own haptic feedback.
3754 *
3755 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
3756 * @see #isHapticFeedbackEnabled()
3757 * @see #performHapticFeedback(int)
3758 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3759 */
3760 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
3761 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
3762 }
3763
3764 /**
3765 * @return whether this view should have haptic feedback enabled for events
3766 * long presses.
3767 *
3768 * @see #setHapticFeedbackEnabled(boolean)
3769 * @see #performHapticFeedback(int)
3770 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3771 */
3772 @ViewDebug.ExportedProperty
3773 public boolean isHapticFeedbackEnabled() {
3774 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
3775 }
3776
3777 /**
3778 * If this view doesn't do any drawing on its own, set this flag to
3779 * allow further optimizations. By default, this flag is not set on
3780 * View, but could be set on some View subclasses such as ViewGroup.
3781 *
3782 * Typically, if you override {@link #onDraw} you should clear this flag.
3783 *
3784 * @param willNotDraw whether or not this View draw on its own
3785 */
3786 public void setWillNotDraw(boolean willNotDraw) {
3787 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
3788 }
3789
3790 /**
3791 * Returns whether or not this View draws on its own.
3792 *
3793 * @return true if this view has nothing to draw, false otherwise
3794 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003795 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003796 public boolean willNotDraw() {
3797 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
3798 }
3799
3800 /**
3801 * When a View's drawing cache is enabled, drawing is redirected to an
3802 * offscreen bitmap. Some views, like an ImageView, must be able to
3803 * bypass this mechanism if they already draw a single bitmap, to avoid
3804 * unnecessary usage of the memory.
3805 *
3806 * @param willNotCacheDrawing true if this view does not cache its
3807 * drawing, false otherwise
3808 */
3809 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
3810 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
3811 }
3812
3813 /**
3814 * Returns whether or not this View can cache its drawing or not.
3815 *
3816 * @return true if this view does not cache its drawing, false otherwise
3817 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003818 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003819 public boolean willNotCacheDrawing() {
3820 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
3821 }
3822
3823 /**
3824 * Indicates whether this view reacts to click events or not.
3825 *
3826 * @return true if the view is clickable, false otherwise
3827 *
3828 * @see #setClickable(boolean)
3829 * @attr ref android.R.styleable#View_clickable
3830 */
3831 @ViewDebug.ExportedProperty
3832 public boolean isClickable() {
3833 return (mViewFlags & CLICKABLE) == CLICKABLE;
3834 }
3835
3836 /**
3837 * Enables or disables click events for this view. When a view
3838 * is clickable it will change its state to "pressed" on every click.
3839 * Subclasses should set the view clickable to visually react to
3840 * user's clicks.
3841 *
3842 * @param clickable true to make the view clickable, false otherwise
3843 *
3844 * @see #isClickable()
3845 * @attr ref android.R.styleable#View_clickable
3846 */
3847 public void setClickable(boolean clickable) {
3848 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
3849 }
3850
3851 /**
3852 * Indicates whether this view reacts to long click events or not.
3853 *
3854 * @return true if the view is long clickable, false otherwise
3855 *
3856 * @see #setLongClickable(boolean)
3857 * @attr ref android.R.styleable#View_longClickable
3858 */
3859 public boolean isLongClickable() {
3860 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
3861 }
3862
3863 /**
3864 * Enables or disables long click events for this view. When a view is long
3865 * clickable it reacts to the user holding down the button for a longer
3866 * duration than a tap. This event can either launch the listener or a
3867 * context menu.
3868 *
3869 * @param longClickable true to make the view long clickable, false otherwise
3870 * @see #isLongClickable()
3871 * @attr ref android.R.styleable#View_longClickable
3872 */
3873 public void setLongClickable(boolean longClickable) {
3874 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
3875 }
3876
3877 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07003878 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003879 *
3880 * @see #isClickable()
3881 * @see #setClickable(boolean)
3882 *
3883 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
3884 * the View's internal state from a previously set "pressed" state.
3885 */
3886 public void setPressed(boolean pressed) {
3887 if (pressed) {
3888 mPrivateFlags |= PRESSED;
3889 } else {
3890 mPrivateFlags &= ~PRESSED;
3891 }
3892 refreshDrawableState();
3893 dispatchSetPressed(pressed);
3894 }
3895
3896 /**
3897 * Dispatch setPressed to all of this View's children.
3898 *
3899 * @see #setPressed(boolean)
3900 *
3901 * @param pressed The new pressed state
3902 */
3903 protected void dispatchSetPressed(boolean pressed) {
3904 }
3905
3906 /**
3907 * Indicates whether the view is currently in pressed state. Unless
3908 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
3909 * the pressed state.
3910 *
3911 * @see #setPressed
3912 * @see #isClickable()
3913 * @see #setClickable(boolean)
3914 *
3915 * @return true if the view is currently pressed, false otherwise
3916 */
3917 public boolean isPressed() {
3918 return (mPrivateFlags & PRESSED) == PRESSED;
3919 }
3920
3921 /**
3922 * Indicates whether this view will save its state (that is,
3923 * whether its {@link #onSaveInstanceState} method will be called).
3924 *
3925 * @return Returns true if the view state saving is enabled, else false.
3926 *
3927 * @see #setSaveEnabled(boolean)
3928 * @attr ref android.R.styleable#View_saveEnabled
3929 */
3930 public boolean isSaveEnabled() {
3931 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
3932 }
3933
3934 /**
3935 * Controls whether the saving of this view's state is
3936 * enabled (that is, whether its {@link #onSaveInstanceState} method
3937 * will be called). Note that even if freezing is enabled, the
3938 * view still must have an id assigned to it (via {@link #setId setId()})
3939 * for its state to be saved. This flag can only disable the
3940 * saving of this view; any child views may still have their state saved.
3941 *
3942 * @param enabled Set to false to <em>disable</em> state saving, or true
3943 * (the default) to allow it.
3944 *
3945 * @see #isSaveEnabled()
3946 * @see #setId(int)
3947 * @see #onSaveInstanceState()
3948 * @attr ref android.R.styleable#View_saveEnabled
3949 */
3950 public void setSaveEnabled(boolean enabled) {
3951 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
3952 }
3953
Jeff Brown85a31762010-09-01 17:01:00 -07003954 /**
3955 * Gets whether the framework should discard touches when the view's
3956 * window is obscured by another visible window.
3957 * Refer to the {@link View} security documentation for more details.
3958 *
3959 * @return True if touch filtering is enabled.
3960 *
3961 * @see #setFilterTouchesWhenObscured(boolean)
3962 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
3963 */
3964 @ViewDebug.ExportedProperty
3965 public boolean getFilterTouchesWhenObscured() {
3966 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
3967 }
3968
3969 /**
3970 * Sets whether the framework should discard touches when the view's
3971 * window is obscured by another visible window.
3972 * Refer to the {@link View} security documentation for more details.
3973 *
3974 * @param enabled True if touch filtering should be enabled.
3975 *
3976 * @see #getFilterTouchesWhenObscured
3977 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
3978 */
3979 public void setFilterTouchesWhenObscured(boolean enabled) {
3980 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
3981 FILTER_TOUCHES_WHEN_OBSCURED);
3982 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003983
3984 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07003985 * Indicates whether the entire hierarchy under this view will save its
3986 * state when a state saving traversal occurs from its parent. The default
3987 * is true; if false, these views will not be saved unless
3988 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
3989 *
3990 * @return Returns true if the view state saving from parent is enabled, else false.
3991 *
3992 * @see #setSaveFromParentEnabled(boolean)
3993 */
3994 public boolean isSaveFromParentEnabled() {
3995 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
3996 }
3997
3998 /**
3999 * Controls whether the entire hierarchy under this view will save its
4000 * state when a state saving traversal occurs from its parent. The default
4001 * is true; if false, these views will not be saved unless
4002 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4003 *
4004 * @param enabled Set to false to <em>disable</em> state saving, or true
4005 * (the default) to allow it.
4006 *
4007 * @see #isSaveFromParentEnabled()
4008 * @see #setId(int)
4009 * @see #onSaveInstanceState()
4010 */
4011 public void setSaveFromParentEnabled(boolean enabled) {
4012 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
4013 }
4014
4015
4016 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004017 * Returns whether this View is able to take focus.
4018 *
4019 * @return True if this view can take focus, or false otherwise.
4020 * @attr ref android.R.styleable#View_focusable
4021 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004022 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004023 public final boolean isFocusable() {
4024 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
4025 }
4026
4027 /**
4028 * When a view is focusable, it may not want to take focus when in touch mode.
4029 * For example, a button would like focus when the user is navigating via a D-pad
4030 * so that the user can click on it, but once the user starts touching the screen,
4031 * the button shouldn't take focus
4032 * @return Whether the view is focusable in touch mode.
4033 * @attr ref android.R.styleable#View_focusableInTouchMode
4034 */
4035 @ViewDebug.ExportedProperty
4036 public final boolean isFocusableInTouchMode() {
4037 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
4038 }
4039
4040 /**
4041 * Find the nearest view in the specified direction that can take focus.
4042 * This does not actually give focus to that view.
4043 *
4044 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4045 *
4046 * @return The nearest focusable in the specified direction, or null if none
4047 * can be found.
4048 */
4049 public View focusSearch(int direction) {
4050 if (mParent != null) {
4051 return mParent.focusSearch(this, direction);
4052 } else {
4053 return null;
4054 }
4055 }
4056
4057 /**
4058 * This method is the last chance for the focused view and its ancestors to
4059 * respond to an arrow key. This is called when the focused view did not
4060 * consume the key internally, nor could the view system find a new view in
4061 * the requested direction to give focus to.
4062 *
4063 * @param focused The currently focused view.
4064 * @param direction The direction focus wants to move. One of FOCUS_UP,
4065 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
4066 * @return True if the this view consumed this unhandled move.
4067 */
4068 public boolean dispatchUnhandledMove(View focused, int direction) {
4069 return false;
4070 }
4071
4072 /**
4073 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08004074 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004075 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08004076 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
4077 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004078 * @return The user specified next view, or null if there is none.
4079 */
4080 View findUserSetNextFocus(View root, int direction) {
4081 switch (direction) {
4082 case FOCUS_LEFT:
4083 if (mNextFocusLeftId == View.NO_ID) return null;
4084 return findViewShouldExist(root, mNextFocusLeftId);
4085 case FOCUS_RIGHT:
4086 if (mNextFocusRightId == View.NO_ID) return null;
4087 return findViewShouldExist(root, mNextFocusRightId);
4088 case FOCUS_UP:
4089 if (mNextFocusUpId == View.NO_ID) return null;
4090 return findViewShouldExist(root, mNextFocusUpId);
4091 case FOCUS_DOWN:
4092 if (mNextFocusDownId == View.NO_ID) return null;
4093 return findViewShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08004094 case FOCUS_FORWARD:
4095 if (mNextFocusForwardId == View.NO_ID) return null;
4096 return findViewShouldExist(root, mNextFocusForwardId);
4097 case FOCUS_BACKWARD: {
4098 final int id = mID;
4099 return root.findViewByPredicate(new Predicate<View>() {
4100 @Override
4101 public boolean apply(View t) {
4102 return t.mNextFocusForwardId == id;
4103 }
4104 });
4105 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004106 }
4107 return null;
4108 }
4109
4110 private static View findViewShouldExist(View root, int childViewId) {
4111 View result = root.findViewById(childViewId);
4112 if (result == null) {
4113 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
4114 + "by user for id " + childViewId);
4115 }
4116 return result;
4117 }
4118
4119 /**
4120 * Find and return all focusable views that are descendants of this view,
4121 * possibly including this view if it is focusable itself.
4122 *
4123 * @param direction The direction of the focus
4124 * @return A list of focusable views
4125 */
4126 public ArrayList<View> getFocusables(int direction) {
4127 ArrayList<View> result = new ArrayList<View>(24);
4128 addFocusables(result, direction);
4129 return result;
4130 }
4131
4132 /**
4133 * Add any focusable views that are descendants of this view (possibly
4134 * including this view if it is focusable itself) to views. If we are in touch mode,
4135 * only add views that are also focusable in touch mode.
4136 *
4137 * @param views Focusable views found so far
4138 * @param direction The direction of the focus
4139 */
4140 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004141 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
4142 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004143
svetoslavganov75986cf2009-05-14 22:28:01 -07004144 /**
4145 * Adds any focusable views that are descendants of this view (possibly
4146 * including this view if it is focusable itself) to views. This method
4147 * adds all focusable views regardless if we are in touch mode or
4148 * only views focusable in touch mode if we are in touch mode depending on
4149 * the focusable mode paramater.
4150 *
4151 * @param views Focusable views found so far or null if all we are interested is
4152 * the number of focusables.
4153 * @param direction The direction of the focus.
4154 * @param focusableMode The type of focusables to be added.
4155 *
4156 * @see #FOCUSABLES_ALL
4157 * @see #FOCUSABLES_TOUCH_MODE
4158 */
4159 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
4160 if (!isFocusable()) {
4161 return;
4162 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004163
svetoslavganov75986cf2009-05-14 22:28:01 -07004164 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE &&
4165 isInTouchMode() && !isFocusableInTouchMode()) {
4166 return;
4167 }
4168
4169 if (views != null) {
4170 views.add(this);
4171 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004172 }
4173
4174 /**
4175 * Find and return all touchable views that are descendants of this view,
4176 * possibly including this view if it is touchable itself.
4177 *
4178 * @return A list of touchable views
4179 */
4180 public ArrayList<View> getTouchables() {
4181 ArrayList<View> result = new ArrayList<View>();
4182 addTouchables(result);
4183 return result;
4184 }
4185
4186 /**
4187 * Add any touchable views that are descendants of this view (possibly
4188 * including this view if it is touchable itself) to views.
4189 *
4190 * @param views Touchable views found so far
4191 */
4192 public void addTouchables(ArrayList<View> views) {
4193 final int viewFlags = mViewFlags;
4194
4195 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
4196 && (viewFlags & ENABLED_MASK) == ENABLED) {
4197 views.add(this);
4198 }
4199 }
4200
4201 /**
4202 * Call this to try to give focus to a specific view or to one of its
4203 * descendants.
4204 *
4205 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4206 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4207 * while the device is in touch mode.
4208 *
4209 * See also {@link #focusSearch}, which is what you call to say that you
4210 * have focus, and you want your parent to look for the next one.
4211 *
4212 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
4213 * {@link #FOCUS_DOWN} and <code>null</code>.
4214 *
4215 * @return Whether this view or one of its descendants actually took focus.
4216 */
4217 public final boolean requestFocus() {
4218 return requestFocus(View.FOCUS_DOWN);
4219 }
4220
4221
4222 /**
4223 * Call this to try to give focus to a specific view or to one of its
4224 * descendants and give it a hint about what direction focus is heading.
4225 *
4226 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4227 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4228 * while the device is in touch mode.
4229 *
4230 * See also {@link #focusSearch}, which is what you call to say that you
4231 * have focus, and you want your parent to look for the next one.
4232 *
4233 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
4234 * <code>null</code> set for the previously focused rectangle.
4235 *
4236 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4237 * @return Whether this view or one of its descendants actually took focus.
4238 */
4239 public final boolean requestFocus(int direction) {
4240 return requestFocus(direction, null);
4241 }
4242
4243 /**
4244 * Call this to try to give focus to a specific view or to one of its descendants
4245 * and give it hints about the direction and a specific rectangle that the focus
4246 * is coming from. The rectangle can help give larger views a finer grained hint
4247 * about where focus is coming from, and therefore, where to show selection, or
4248 * forward focus change internally.
4249 *
4250 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4251 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4252 * while the device is in touch mode.
4253 *
4254 * A View will not take focus if it is not visible.
4255 *
4256 * A View will not take focus if one of its parents has {@link android.view.ViewGroup#getDescendantFocusability()}
4257 * equal to {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
4258 *
4259 * See also {@link #focusSearch}, which is what you call to say that you
4260 * have focus, and you want your parent to look for the next one.
4261 *
4262 * You may wish to override this method if your custom {@link View} has an internal
4263 * {@link View} that it wishes to forward the request to.
4264 *
4265 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4266 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
4267 * to give a finer grained hint about where focus is coming from. May be null
4268 * if there is no hint.
4269 * @return Whether this view or one of its descendants actually took focus.
4270 */
4271 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
4272 // need to be focusable
4273 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
4274 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
4275 return false;
4276 }
4277
4278 // need to be focusable in touch mode if in touch mode
4279 if (isInTouchMode() &&
4280 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
4281 return false;
4282 }
4283
4284 // need to not have any parents blocking us
4285 if (hasAncestorThatBlocksDescendantFocus()) {
4286 return false;
4287 }
4288
4289 handleFocusGainInternal(direction, previouslyFocusedRect);
4290 return true;
4291 }
4292
Christopher Tate2c095f32010-10-04 14:13:40 -07004293 /** Gets the ViewRoot, or null if not attached. */
4294 /*package*/ ViewRoot getViewRoot() {
4295 View root = getRootView();
4296 return root != null ? (ViewRoot)root.getParent() : null;
4297 }
4298
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004299 /**
4300 * Call this to try to give focus to a specific view or to one of its descendants. This is a
4301 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
4302 * touch mode to request focus when they are touched.
4303 *
4304 * @return Whether this view or one of its descendants actually took focus.
4305 *
4306 * @see #isInTouchMode()
4307 *
4308 */
4309 public final boolean requestFocusFromTouch() {
4310 // Leave touch mode if we need to
4311 if (isInTouchMode()) {
Christopher Tate2c095f32010-10-04 14:13:40 -07004312 ViewRoot viewRoot = getViewRoot();
4313 if (viewRoot != null) {
4314 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004315 }
4316 }
4317 return requestFocus(View.FOCUS_DOWN);
4318 }
4319
4320 /**
4321 * @return Whether any ancestor of this view blocks descendant focus.
4322 */
4323 private boolean hasAncestorThatBlocksDescendantFocus() {
4324 ViewParent ancestor = mParent;
4325 while (ancestor instanceof ViewGroup) {
4326 final ViewGroup vgAncestor = (ViewGroup) ancestor;
4327 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
4328 return true;
4329 } else {
4330 ancestor = vgAncestor.getParent();
4331 }
4332 }
4333 return false;
4334 }
4335
4336 /**
Romain Guya440b002010-02-24 15:57:54 -08004337 * @hide
4338 */
4339 public void dispatchStartTemporaryDetach() {
4340 onStartTemporaryDetach();
4341 }
4342
4343 /**
4344 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004345 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
4346 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08004347 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004348 */
4349 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08004350 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08004351 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08004352 }
4353
4354 /**
4355 * @hide
4356 */
4357 public void dispatchFinishTemporaryDetach() {
4358 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004359 }
Romain Guy8506ab42009-06-11 17:35:47 -07004360
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004361 /**
4362 * Called after {@link #onStartTemporaryDetach} when the container is done
4363 * changing the view.
4364 */
4365 public void onFinishTemporaryDetach() {
4366 }
Romain Guy8506ab42009-06-11 17:35:47 -07004367
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004368 /**
4369 * capture information of this view for later analysis: developement only
4370 * check dynamic switch to make sure we only dump view
4371 * when ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW) is set
4372 */
4373 private static void captureViewInfo(String subTag, View v) {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07004374 if (v == null || SystemProperties.getInt(ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW, 0) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004375 return;
4376 }
4377 ViewDebug.dumpCapturedView(subTag, v);
4378 }
4379
4380 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004381 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
4382 * for this view's window. Returns null if the view is not currently attached
4383 * to the window. Normally you will not need to use this directly, but
4384 * just use the standard high-level event callbacks like {@link #onKeyDown}.
4385 */
4386 public KeyEvent.DispatcherState getKeyDispatcherState() {
4387 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
4388 }
4389
4390 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004391 * Dispatch a key event before it is processed by any input method
4392 * associated with the view hierarchy. This can be used to intercept
4393 * key events in special situations before the IME consumes them; a
4394 * typical example would be handling the BACK key to update the application's
4395 * UI instead of allowing the IME to see it and close itself.
4396 *
4397 * @param event The key event to be dispatched.
4398 * @return True if the event was handled, false otherwise.
4399 */
4400 public boolean dispatchKeyEventPreIme(KeyEvent event) {
4401 return onKeyPreIme(event.getKeyCode(), event);
4402 }
4403
4404 /**
4405 * Dispatch a key event to the next view on the focus path. This path runs
4406 * from the top of the view tree down to the currently focused view. If this
4407 * view has focus, it will dispatch to itself. Otherwise it will dispatch
4408 * the next node down the focus path. This method also fires any key
4409 * listeners.
4410 *
4411 * @param event The key event to be dispatched.
4412 * @return True if the event was handled, false otherwise.
4413 */
4414 public boolean dispatchKeyEvent(KeyEvent event) {
4415 // If any attached key listener a first crack at the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004416
Romain Guyf607bdc2010-09-10 19:20:06 -07004417 //noinspection SimplifiableIfStatement,deprecation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004418 if (android.util.Config.LOGV) {
4419 captureViewInfo("captureViewKeyEvent", this);
4420 }
4421
Romain Guyf607bdc2010-09-10 19:20:06 -07004422 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004423 if (mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
4424 && mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
4425 return true;
4426 }
4427
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004428 return event.dispatch(this, mAttachInfo != null
4429 ? mAttachInfo.mKeyDispatchState : null, this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004430 }
4431
4432 /**
4433 * Dispatches a key shortcut event.
4434 *
4435 * @param event The key event to be dispatched.
4436 * @return True if the event was handled by the view, false otherwise.
4437 */
4438 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
4439 return onKeyShortcut(event.getKeyCode(), event);
4440 }
4441
4442 /**
4443 * Pass the touch screen motion event down to the target view, or this
4444 * view if it is the target.
4445 *
4446 * @param event The motion event to be dispatched.
4447 * @return True if the event was handled by the view, false otherwise.
4448 */
4449 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown85a31762010-09-01 17:01:00 -07004450 if (!onFilterTouchEventForSecurity(event)) {
4451 return false;
4452 }
4453
Romain Guyf607bdc2010-09-10 19:20:06 -07004454 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004455 if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED &&
4456 mOnTouchListener.onTouch(this, event)) {
4457 return true;
4458 }
4459 return onTouchEvent(event);
4460 }
4461
4462 /**
Jeff Brown85a31762010-09-01 17:01:00 -07004463 * Filter the touch event to apply security policies.
4464 *
4465 * @param event The motion event to be filtered.
4466 * @return True if the event should be dispatched, false if the event should be dropped.
4467 *
4468 * @see #getFilterTouchesWhenObscured
4469 */
4470 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07004471 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07004472 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
4473 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
4474 // Window is obscured, drop this touch.
4475 return false;
4476 }
4477 return true;
4478 }
4479
4480 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004481 * Pass a trackball motion event down to the focused view.
4482 *
4483 * @param event The motion event to be dispatched.
4484 * @return True if the event was handled by the view, false otherwise.
4485 */
4486 public boolean dispatchTrackballEvent(MotionEvent event) {
4487 //Log.i("view", "view=" + this + ", " + event.toString());
4488 return onTrackballEvent(event);
4489 }
4490
4491 /**
4492 * Called when the window containing this view gains or loses window focus.
4493 * ViewGroups should override to route to their children.
4494 *
4495 * @param hasFocus True if the window containing this view now has focus,
4496 * false otherwise.
4497 */
4498 public void dispatchWindowFocusChanged(boolean hasFocus) {
4499 onWindowFocusChanged(hasFocus);
4500 }
4501
4502 /**
4503 * Called when the window containing this view gains or loses focus. Note
4504 * that this is separate from view focus: to receive key events, both
4505 * your view and its window must have focus. If a window is displayed
4506 * on top of yours that takes input focus, then your own window will lose
4507 * focus but the view focus will remain unchanged.
4508 *
4509 * @param hasWindowFocus True if the window containing this view now has
4510 * focus, false otherwise.
4511 */
4512 public void onWindowFocusChanged(boolean hasWindowFocus) {
4513 InputMethodManager imm = InputMethodManager.peekInstance();
4514 if (!hasWindowFocus) {
4515 if (isPressed()) {
4516 setPressed(false);
4517 }
4518 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4519 imm.focusOut(this);
4520 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05004521 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08004522 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004523 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004524 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4525 imm.focusIn(this);
4526 }
4527 refreshDrawableState();
4528 }
4529
4530 /**
4531 * Returns true if this view is in a window that currently has window focus.
4532 * Note that this is not the same as the view itself having focus.
4533 *
4534 * @return True if this view is in a window that currently has window focus.
4535 */
4536 public boolean hasWindowFocus() {
4537 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
4538 }
4539
4540 /**
Adam Powell326d8082009-12-09 15:10:07 -08004541 * Dispatch a view visibility change down the view hierarchy.
4542 * ViewGroups should override to route to their children.
4543 * @param changedView The view whose visibility changed. Could be 'this' or
4544 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004545 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4546 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004547 */
4548 protected void dispatchVisibilityChanged(View changedView, int visibility) {
4549 onVisibilityChanged(changedView, visibility);
4550 }
4551
4552 /**
4553 * Called when the visibility of the view or an ancestor of the view is changed.
4554 * @param changedView The view whose visibility changed. Could be 'this' or
4555 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004556 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4557 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004558 */
4559 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004560 if (visibility == VISIBLE) {
4561 if (mAttachInfo != null) {
4562 initialAwakenScrollBars();
4563 } else {
4564 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
4565 }
4566 }
Adam Powell326d8082009-12-09 15:10:07 -08004567 }
4568
4569 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08004570 * Dispatch a hint about whether this view is displayed. For instance, when
4571 * a View moves out of the screen, it might receives a display hint indicating
4572 * the view is not displayed. Applications should not <em>rely</em> on this hint
4573 * as there is no guarantee that they will receive one.
4574 *
4575 * @param hint A hint about whether or not this view is displayed:
4576 * {@link #VISIBLE} or {@link #INVISIBLE}.
4577 */
4578 public void dispatchDisplayHint(int hint) {
4579 onDisplayHint(hint);
4580 }
4581
4582 /**
4583 * Gives this view a hint about whether is displayed or not. For instance, when
4584 * a View moves out of the screen, it might receives a display hint indicating
4585 * the view is not displayed. Applications should not <em>rely</em> on this hint
4586 * as there is no guarantee that they will receive one.
4587 *
4588 * @param hint A hint about whether or not this view is displayed:
4589 * {@link #VISIBLE} or {@link #INVISIBLE}.
4590 */
4591 protected void onDisplayHint(int hint) {
4592 }
4593
4594 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004595 * Dispatch a window visibility change down the view hierarchy.
4596 * ViewGroups should override to route to their children.
4597 *
4598 * @param visibility The new visibility of the window.
4599 *
4600 * @see #onWindowVisibilityChanged
4601 */
4602 public void dispatchWindowVisibilityChanged(int visibility) {
4603 onWindowVisibilityChanged(visibility);
4604 }
4605
4606 /**
4607 * Called when the window containing has change its visibility
4608 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
4609 * that this tells you whether or not your window is being made visible
4610 * to the window manager; this does <em>not</em> tell you whether or not
4611 * your window is obscured by other windows on the screen, even if it
4612 * is itself visible.
4613 *
4614 * @param visibility The new visibility of the window.
4615 */
4616 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004617 if (visibility == VISIBLE) {
4618 initialAwakenScrollBars();
4619 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004620 }
4621
4622 /**
4623 * Returns the current visibility of the window this view is attached to
4624 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
4625 *
4626 * @return Returns the current visibility of the view's window.
4627 */
4628 public int getWindowVisibility() {
4629 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
4630 }
4631
4632 /**
4633 * Retrieve the overall visible display size in which the window this view is
4634 * attached to has been positioned in. This takes into account screen
4635 * decorations above the window, for both cases where the window itself
4636 * is being position inside of them or the window is being placed under
4637 * then and covered insets are used for the window to position its content
4638 * inside. In effect, this tells you the available area where content can
4639 * be placed and remain visible to users.
4640 *
4641 * <p>This function requires an IPC back to the window manager to retrieve
4642 * the requested information, so should not be used in performance critical
4643 * code like drawing.
4644 *
4645 * @param outRect Filled in with the visible display frame. If the view
4646 * is not attached to a window, this is simply the raw display size.
4647 */
4648 public void getWindowVisibleDisplayFrame(Rect outRect) {
4649 if (mAttachInfo != null) {
4650 try {
4651 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
4652 } catch (RemoteException e) {
4653 return;
4654 }
4655 // XXX This is really broken, and probably all needs to be done
4656 // in the window manager, and we need to know more about whether
4657 // we want the area behind or in front of the IME.
4658 final Rect insets = mAttachInfo.mVisibleInsets;
4659 outRect.left += insets.left;
4660 outRect.top += insets.top;
4661 outRect.right -= insets.right;
4662 outRect.bottom -= insets.bottom;
4663 return;
4664 }
4665 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
4666 outRect.set(0, 0, d.getWidth(), d.getHeight());
4667 }
4668
4669 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08004670 * Dispatch a notification about a resource configuration change down
4671 * the view hierarchy.
4672 * ViewGroups should override to route to their children.
4673 *
4674 * @param newConfig The new resource configuration.
4675 *
4676 * @see #onConfigurationChanged
4677 */
4678 public void dispatchConfigurationChanged(Configuration newConfig) {
4679 onConfigurationChanged(newConfig);
4680 }
4681
4682 /**
4683 * Called when the current configuration of the resources being used
4684 * by the application have changed. You can use this to decide when
4685 * to reload resources that can changed based on orientation and other
4686 * configuration characterstics. You only need to use this if you are
4687 * not relying on the normal {@link android.app.Activity} mechanism of
4688 * recreating the activity instance upon a configuration change.
4689 *
4690 * @param newConfig The new resource configuration.
4691 */
4692 protected void onConfigurationChanged(Configuration newConfig) {
4693 }
4694
4695 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004696 * Private function to aggregate all per-view attributes in to the view
4697 * root.
4698 */
4699 void dispatchCollectViewAttributes(int visibility) {
4700 performCollectViewAttributes(visibility);
4701 }
4702
4703 void performCollectViewAttributes(int visibility) {
4704 //noinspection PointlessBitwiseExpression
4705 if (((visibility | mViewFlags) & (VISIBILITY_MASK | KEEP_SCREEN_ON))
4706 == (VISIBLE | KEEP_SCREEN_ON)) {
4707 mAttachInfo.mKeepScreenOn = true;
4708 }
4709 }
4710
4711 void needGlobalAttributesUpdate(boolean force) {
4712 AttachInfo ai = mAttachInfo;
4713 if (ai != null) {
4714 if (ai.mKeepScreenOn || force) {
4715 ai.mRecomputeGlobalAttributes = true;
4716 }
4717 }
4718 }
4719
4720 /**
4721 * Returns whether the device is currently in touch mode. Touch mode is entered
4722 * once the user begins interacting with the device by touch, and affects various
4723 * things like whether focus is always visible to the user.
4724 *
4725 * @return Whether the device is in touch mode.
4726 */
4727 @ViewDebug.ExportedProperty
4728 public boolean isInTouchMode() {
4729 if (mAttachInfo != null) {
4730 return mAttachInfo.mInTouchMode;
4731 } else {
4732 return ViewRoot.isInTouchMode();
4733 }
4734 }
4735
4736 /**
4737 * Returns the context the view is running in, through which it can
4738 * access the current theme, resources, etc.
4739 *
4740 * @return The view's Context.
4741 */
4742 @ViewDebug.CapturedViewProperty
4743 public final Context getContext() {
4744 return mContext;
4745 }
4746
4747 /**
4748 * Handle a key event before it is processed by any input method
4749 * associated with the view hierarchy. This can be used to intercept
4750 * key events in special situations before the IME consumes them; a
4751 * typical example would be handling the BACK key to update the application's
4752 * UI instead of allowing the IME to see it and close itself.
4753 *
4754 * @param keyCode The value in event.getKeyCode().
4755 * @param event Description of the key event.
4756 * @return If you handled the event, return true. If you want to allow the
4757 * event to be handled by the next receiver, return false.
4758 */
4759 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
4760 return false;
4761 }
4762
4763 /**
Jeff Brown995e7742010-12-22 16:59:36 -08004764 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
4765 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004766 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
4767 * is released, if the view is enabled and clickable.
4768 *
4769 * @param keyCode A key code that represents the button pressed, from
4770 * {@link android.view.KeyEvent}.
4771 * @param event The KeyEvent object that defines the button action.
4772 */
4773 public boolean onKeyDown(int keyCode, KeyEvent event) {
4774 boolean result = false;
4775
4776 switch (keyCode) {
4777 case KeyEvent.KEYCODE_DPAD_CENTER:
4778 case KeyEvent.KEYCODE_ENTER: {
4779 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4780 return true;
4781 }
4782 // Long clickable items don't necessarily have to be clickable
4783 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
4784 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
4785 (event.getRepeatCount() == 0)) {
4786 setPressed(true);
4787 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
Adam Powelle14579b2009-12-16 18:39:52 -08004788 postCheckForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004789 }
4790 return true;
4791 }
4792 break;
4793 }
4794 }
4795 return result;
4796 }
4797
4798 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004799 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
4800 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
4801 * the event).
4802 */
4803 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
4804 return false;
4805 }
4806
4807 /**
Jeff Brown995e7742010-12-22 16:59:36 -08004808 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
4809 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004810 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
4811 * {@link KeyEvent#KEYCODE_ENTER} is released.
4812 *
4813 * @param keyCode A key code that represents the button pressed, from
4814 * {@link android.view.KeyEvent}.
4815 * @param event The KeyEvent object that defines the button action.
4816 */
4817 public boolean onKeyUp(int keyCode, KeyEvent event) {
4818 boolean result = false;
4819
4820 switch (keyCode) {
4821 case KeyEvent.KEYCODE_DPAD_CENTER:
4822 case KeyEvent.KEYCODE_ENTER: {
4823 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4824 return true;
4825 }
4826 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
4827 setPressed(false);
4828
4829 if (!mHasPerformedLongPress) {
4830 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05004831 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004832
4833 result = performClick();
4834 }
4835 }
4836 break;
4837 }
4838 }
4839 return result;
4840 }
4841
4842 /**
4843 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
4844 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
4845 * the event).
4846 *
4847 * @param keyCode A key code that represents the button pressed, from
4848 * {@link android.view.KeyEvent}.
4849 * @param repeatCount The number of times the action was made.
4850 * @param event The KeyEvent object that defines the button action.
4851 */
4852 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
4853 return false;
4854 }
4855
4856 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08004857 * Called on the focused view when a key shortcut event is not handled.
4858 * Override this method to implement local key shortcuts for the View.
4859 * Key shortcuts can also be implemented by setting the
4860 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004861 *
4862 * @param keyCode The value in event.getKeyCode().
4863 * @param event Description of the key event.
4864 * @return If you handled the event, return true. If you want to allow the
4865 * event to be handled by the next receiver, return false.
4866 */
4867 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
4868 return false;
4869 }
4870
4871 /**
4872 * Check whether the called view is a text editor, in which case it
4873 * would make sense to automatically display a soft input window for
4874 * it. Subclasses should override this if they implement
4875 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004876 * a call on that method would return a non-null InputConnection, and
4877 * they are really a first-class editor that the user would normally
4878 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07004879 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004880 * <p>The default implementation always returns false. This does
4881 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
4882 * will not be called or the user can not otherwise perform edits on your
4883 * view; it is just a hint to the system that this is not the primary
4884 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07004885 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004886 * @return Returns true if this view is a text editor, else false.
4887 */
4888 public boolean onCheckIsTextEditor() {
4889 return false;
4890 }
Romain Guy8506ab42009-06-11 17:35:47 -07004891
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004892 /**
4893 * Create a new InputConnection for an InputMethod to interact
4894 * with the view. The default implementation returns null, since it doesn't
4895 * support input methods. You can override this to implement such support.
4896 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07004897 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004898 * <p>When implementing this, you probably also want to implement
4899 * {@link #onCheckIsTextEditor()} to indicate you will return a
4900 * non-null InputConnection.
4901 *
4902 * @param outAttrs Fill in with attribute information about the connection.
4903 */
4904 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
4905 return null;
4906 }
4907
4908 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004909 * Called by the {@link android.view.inputmethod.InputMethodManager}
4910 * when a view who is not the current
4911 * input connection target is trying to make a call on the manager. The
4912 * default implementation returns false; you can override this to return
4913 * true for certain views if you are performing InputConnection proxying
4914 * to them.
4915 * @param view The View that is making the InputMethodManager call.
4916 * @return Return true to allow the call, false to reject.
4917 */
4918 public boolean checkInputConnectionProxy(View view) {
4919 return false;
4920 }
Romain Guy8506ab42009-06-11 17:35:47 -07004921
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004922 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004923 * Show the context menu for this view. It is not safe to hold on to the
4924 * menu after returning from this method.
4925 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07004926 * You should normally not overload this method. Overload
4927 * {@link #onCreateContextMenu(ContextMenu)} or define an
4928 * {@link OnCreateContextMenuListener} to add items to the context menu.
4929 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004930 * @param menu The context menu to populate
4931 */
4932 public void createContextMenu(ContextMenu menu) {
4933 ContextMenuInfo menuInfo = getContextMenuInfo();
4934
4935 // Sets the current menu info so all items added to menu will have
4936 // my extra info set.
4937 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
4938
4939 onCreateContextMenu(menu);
4940 if (mOnCreateContextMenuListener != null) {
4941 mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
4942 }
4943
4944 // Clear the extra information so subsequent items that aren't mine don't
4945 // have my extra info.
4946 ((MenuBuilder)menu).setCurrentMenuInfo(null);
4947
4948 if (mParent != null) {
4949 mParent.createContextMenu(menu);
4950 }
4951 }
4952
4953 /**
4954 * Views should implement this if they have extra information to associate
4955 * with the context menu. The return result is supplied as a parameter to
4956 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
4957 * callback.
4958 *
4959 * @return Extra information about the item for which the context menu
4960 * should be shown. This information will vary across different
4961 * subclasses of View.
4962 */
4963 protected ContextMenuInfo getContextMenuInfo() {
4964 return null;
4965 }
4966
4967 /**
4968 * Views should implement this if the view itself is going to add items to
4969 * the context menu.
4970 *
4971 * @param menu the context menu to populate
4972 */
4973 protected void onCreateContextMenu(ContextMenu menu) {
4974 }
4975
4976 /**
4977 * Implement this method to handle trackball motion events. The
4978 * <em>relative</em> movement of the trackball since the last event
4979 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
4980 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
4981 * that a movement of 1 corresponds to the user pressing one DPAD key (so
4982 * they will often be fractional values, representing the more fine-grained
4983 * movement information available from a trackball).
4984 *
4985 * @param event The motion event.
4986 * @return True if the event was handled, false otherwise.
4987 */
4988 public boolean onTrackballEvent(MotionEvent event) {
4989 return false;
4990 }
4991
4992 /**
4993 * Implement this method to handle touch screen motion events.
4994 *
4995 * @param event The motion event.
4996 * @return True if the event was handled, false otherwise.
4997 */
4998 public boolean onTouchEvent(MotionEvent event) {
4999 final int viewFlags = mViewFlags;
5000
5001 if ((viewFlags & ENABLED_MASK) == DISABLED) {
5002 // A disabled view that is clickable still consumes the touch
5003 // events, it just doesn't respond to them.
5004 return (((viewFlags & CLICKABLE) == CLICKABLE ||
5005 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
5006 }
5007
5008 if (mTouchDelegate != null) {
5009 if (mTouchDelegate.onTouchEvent(event)) {
5010 return true;
5011 }
5012 }
5013
5014 if (((viewFlags & CLICKABLE) == CLICKABLE ||
5015 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
5016 switch (event.getAction()) {
5017 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08005018 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
5019 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005020 // take focus if we don't have it already and we should in
5021 // touch mode.
5022 boolean focusTaken = false;
5023 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
5024 focusTaken = requestFocus();
5025 }
5026
5027 if (!mHasPerformedLongPress) {
5028 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05005029 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005030
5031 // Only perform take click actions if we were in the pressed state
5032 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08005033 // Use a Runnable and post this rather than calling
5034 // performClick directly. This lets other visual state
5035 // of the view update before click actions start.
5036 if (mPerformClick == null) {
5037 mPerformClick = new PerformClick();
5038 }
5039 if (!post(mPerformClick)) {
5040 performClick();
5041 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005042 }
5043 }
5044
5045 if (mUnsetPressedState == null) {
5046 mUnsetPressedState = new UnsetPressedState();
5047 }
5048
Adam Powelle14579b2009-12-16 18:39:52 -08005049 if (prepressed) {
5050 mPrivateFlags |= PRESSED;
5051 refreshDrawableState();
5052 postDelayed(mUnsetPressedState,
5053 ViewConfiguration.getPressedStateDuration());
5054 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005055 // If the post failed, unpress right now
5056 mUnsetPressedState.run();
5057 }
Adam Powelle14579b2009-12-16 18:39:52 -08005058 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005059 }
5060 break;
5061
5062 case MotionEvent.ACTION_DOWN:
Adam Powelle14579b2009-12-16 18:39:52 -08005063 if (mPendingCheckForTap == null) {
5064 mPendingCheckForTap = new CheckForTap();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005065 }
Adam Powelle14579b2009-12-16 18:39:52 -08005066 mPrivateFlags |= PREPRESSED;
Adam Powell3b023392010-03-11 16:30:28 -08005067 mHasPerformedLongPress = false;
Adam Powelle14579b2009-12-16 18:39:52 -08005068 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005069 break;
5070
5071 case MotionEvent.ACTION_CANCEL:
5072 mPrivateFlags &= ~PRESSED;
5073 refreshDrawableState();
Adam Powelle14579b2009-12-16 18:39:52 -08005074 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005075 break;
5076
5077 case MotionEvent.ACTION_MOVE:
5078 final int x = (int) event.getX();
5079 final int y = (int) event.getY();
5080
5081 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07005082 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005083 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08005084 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005085 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08005086 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05005087 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005088
5089 // Need to switch from pressed to not pressed
5090 mPrivateFlags &= ~PRESSED;
5091 refreshDrawableState();
5092 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005093 }
5094 break;
5095 }
5096 return true;
5097 }
5098
5099 return false;
5100 }
5101
5102 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05005103 * Remove the longpress detection timer.
5104 */
5105 private void removeLongPressCallback() {
5106 if (mPendingCheckForLongPress != null) {
5107 removeCallbacks(mPendingCheckForLongPress);
5108 }
5109 }
Adam Powelle14579b2009-12-16 18:39:52 -08005110
5111 /**
Romain Guya440b002010-02-24 15:57:54 -08005112 * Remove the prepress detection timer.
5113 */
5114 private void removeUnsetPressCallback() {
5115 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
5116 setPressed(false);
5117 removeCallbacks(mUnsetPressedState);
5118 }
5119 }
5120
5121 /**
Adam Powelle14579b2009-12-16 18:39:52 -08005122 * Remove the tap detection timer.
5123 */
5124 private void removeTapCallback() {
5125 if (mPendingCheckForTap != null) {
5126 mPrivateFlags &= ~PREPRESSED;
5127 removeCallbacks(mPendingCheckForTap);
5128 }
5129 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05005130
5131 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005132 * Cancels a pending long press. Your subclass can use this if you
5133 * want the context menu to come up if the user presses and holds
5134 * at the same place, but you don't want it to come up if they press
5135 * and then move around enough to cause scrolling.
5136 */
5137 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05005138 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08005139
5140 /*
5141 * The prepressed state handled by the tap callback is a display
5142 * construct, but the tap callback will post a long press callback
5143 * less its own timeout. Remove it here.
5144 */
5145 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005146 }
5147
5148 /**
5149 * Sets the TouchDelegate for this View.
5150 */
5151 public void setTouchDelegate(TouchDelegate delegate) {
5152 mTouchDelegate = delegate;
5153 }
5154
5155 /**
5156 * Gets the TouchDelegate for this View.
5157 */
5158 public TouchDelegate getTouchDelegate() {
5159 return mTouchDelegate;
5160 }
5161
5162 /**
5163 * Set flags controlling behavior of this view.
5164 *
5165 * @param flags Constant indicating the value which should be set
5166 * @param mask Constant indicating the bit range that should be changed
5167 */
5168 void setFlags(int flags, int mask) {
5169 int old = mViewFlags;
5170 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
5171
5172 int changed = mViewFlags ^ old;
5173 if (changed == 0) {
5174 return;
5175 }
5176 int privateFlags = mPrivateFlags;
5177
5178 /* Check if the FOCUSABLE bit has changed */
5179 if (((changed & FOCUSABLE_MASK) != 0) &&
5180 ((privateFlags & HAS_BOUNDS) !=0)) {
5181 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
5182 && ((privateFlags & FOCUSED) != 0)) {
5183 /* Give up focus if we are no longer focusable */
5184 clearFocus();
5185 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
5186 && ((privateFlags & FOCUSED) == 0)) {
5187 /*
5188 * Tell the view system that we are now available to take focus
5189 * if no one else already has it.
5190 */
5191 if (mParent != null) mParent.focusableViewAvailable(this);
5192 }
5193 }
5194
5195 if ((flags & VISIBILITY_MASK) == VISIBLE) {
5196 if ((changed & VISIBILITY_MASK) != 0) {
5197 /*
5198 * If this view is becoming visible, set the DRAWN flag so that
5199 * the next invalidate() will not be skipped.
5200 */
5201 mPrivateFlags |= DRAWN;
5202
5203 needGlobalAttributesUpdate(true);
5204
5205 // a view becoming visible is worth notifying the parent
5206 // about in case nothing has focus. even if this specific view
5207 // isn't focusable, it may contain something that is, so let
5208 // the root view try to give this focus if nothing else does.
5209 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
5210 mParent.focusableViewAvailable(this);
5211 }
5212 }
5213 }
5214
5215 /* Check if the GONE bit has changed */
5216 if ((changed & GONE) != 0) {
5217 needGlobalAttributesUpdate(false);
5218 requestLayout();
5219 invalidate();
5220
Romain Guyecd80ee2009-12-03 17:13:02 -08005221 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
5222 if (hasFocus()) clearFocus();
5223 destroyDrawingCache();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005224 }
5225 if (mAttachInfo != null) {
5226 mAttachInfo.mViewVisibilityChanged = true;
5227 }
5228 }
5229
5230 /* Check if the VISIBLE bit has changed */
5231 if ((changed & INVISIBLE) != 0) {
5232 needGlobalAttributesUpdate(false);
5233 invalidate();
5234
5235 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
5236 // root view becoming invisible shouldn't clear focus
5237 if (getRootView() != this) {
5238 clearFocus();
5239 }
5240 }
5241 if (mAttachInfo != null) {
5242 mAttachInfo.mViewVisibilityChanged = true;
5243 }
5244 }
5245
Adam Powell326d8082009-12-09 15:10:07 -08005246 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07005247 if (mParent instanceof ViewGroup) {
5248 ((ViewGroup)mParent).onChildVisibilityChanged(this, (flags & VISIBILITY_MASK));
5249 }
Adam Powell326d8082009-12-09 15:10:07 -08005250 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
5251 }
5252
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005253 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
5254 destroyDrawingCache();
5255 }
5256
5257 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
5258 destroyDrawingCache();
5259 mPrivateFlags &= ~DRAWING_CACHE_VALID;
5260 }
5261
5262 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
5263 destroyDrawingCache();
5264 mPrivateFlags &= ~DRAWING_CACHE_VALID;
5265 }
5266
5267 if ((changed & DRAW_MASK) != 0) {
5268 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
5269 if (mBGDrawable != null) {
5270 mPrivateFlags &= ~SKIP_DRAW;
5271 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
5272 } else {
5273 mPrivateFlags |= SKIP_DRAW;
5274 }
5275 } else {
5276 mPrivateFlags &= ~SKIP_DRAW;
5277 }
5278 requestLayout();
5279 invalidate();
5280 }
5281
5282 if ((changed & KEEP_SCREEN_ON) != 0) {
5283 if (mParent != null) {
5284 mParent.recomputeViewAttributes(this);
5285 }
5286 }
5287 }
5288
5289 /**
5290 * Change the view's z order in the tree, so it's on top of other sibling
5291 * views
5292 */
5293 public void bringToFront() {
5294 if (mParent != null) {
5295 mParent.bringChildToFront(this);
5296 }
5297 }
5298
5299 /**
5300 * This is called in response to an internal scroll in this view (i.e., the
5301 * view scrolled its own contents). This is typically as a result of
5302 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
5303 * called.
5304 *
5305 * @param l Current horizontal scroll origin.
5306 * @param t Current vertical scroll origin.
5307 * @param oldl Previous horizontal scroll origin.
5308 * @param oldt Previous vertical scroll origin.
5309 */
5310 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
5311 mBackgroundSizeChanged = true;
5312
5313 final AttachInfo ai = mAttachInfo;
5314 if (ai != null) {
5315 ai.mViewScrollChanged = true;
5316 }
5317 }
5318
5319 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005320 * Interface definition for a callback to be invoked when the layout bounds of a view
5321 * changes due to layout processing.
5322 */
5323 public interface OnLayoutChangeListener {
5324 /**
5325 * Called when the focus state of a view has changed.
5326 *
5327 * @param v The view whose state has changed.
5328 * @param left The new value of the view's left property.
5329 * @param top The new value of the view's top property.
5330 * @param right The new value of the view's right property.
5331 * @param bottom The new value of the view's bottom property.
5332 * @param oldLeft The previous value of the view's left property.
5333 * @param oldTop The previous value of the view's top property.
5334 * @param oldRight The previous value of the view's right property.
5335 * @param oldBottom The previous value of the view's bottom property.
5336 */
5337 void onLayoutChange(View v, int left, int top, int right, int bottom,
5338 int oldLeft, int oldTop, int oldRight, int oldBottom);
5339 }
5340
5341 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005342 * This is called during layout when the size of this view has changed. If
5343 * you were just added to the view hierarchy, you're called with the old
5344 * values of 0.
5345 *
5346 * @param w Current width of this view.
5347 * @param h Current height of this view.
5348 * @param oldw Old width of this view.
5349 * @param oldh Old height of this view.
5350 */
5351 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
5352 }
5353
5354 /**
5355 * Called by draw to draw the child views. This may be overridden
5356 * by derived classes to gain control just before its children are drawn
5357 * (but after its own view has been drawn).
5358 * @param canvas the canvas on which to draw the view
5359 */
5360 protected void dispatchDraw(Canvas canvas) {
5361 }
5362
5363 /**
5364 * Gets the parent of this view. Note that the parent is a
5365 * ViewParent and not necessarily a View.
5366 *
5367 * @return Parent of this view.
5368 */
5369 public final ViewParent getParent() {
5370 return mParent;
5371 }
5372
5373 /**
5374 * Return the scrolled left position of this view. This is the left edge of
5375 * the displayed part of your view. You do not need to draw any pixels
5376 * farther left, since those are outside of the frame of your view on
5377 * screen.
5378 *
5379 * @return The left edge of the displayed part of your view, in pixels.
5380 */
5381 public final int getScrollX() {
5382 return mScrollX;
5383 }
5384
5385 /**
5386 * Return the scrolled top position of this view. This is the top edge of
5387 * the displayed part of your view. You do not need to draw any pixels above
5388 * it, since those are outside of the frame of your view on screen.
5389 *
5390 * @return The top edge of the displayed part of your view, in pixels.
5391 */
5392 public final int getScrollY() {
5393 return mScrollY;
5394 }
5395
5396 /**
5397 * Return the width of the your view.
5398 *
5399 * @return The width of your view, in pixels.
5400 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005401 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005402 public final int getWidth() {
5403 return mRight - mLeft;
5404 }
5405
5406 /**
5407 * Return the height of your view.
5408 *
5409 * @return The height of your view, in pixels.
5410 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005411 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005412 public final int getHeight() {
5413 return mBottom - mTop;
5414 }
5415
5416 /**
5417 * Return the visible drawing bounds of your view. Fills in the output
5418 * rectangle with the values from getScrollX(), getScrollY(),
5419 * getWidth(), and getHeight().
5420 *
5421 * @param outRect The (scrolled) drawing bounds of the view.
5422 */
5423 public void getDrawingRect(Rect outRect) {
5424 outRect.left = mScrollX;
5425 outRect.top = mScrollY;
5426 outRect.right = mScrollX + (mRight - mLeft);
5427 outRect.bottom = mScrollY + (mBottom - mTop);
5428 }
5429
5430 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005431 * Like {@link #getMeasuredWidthAndState()}, but only returns the
5432 * raw width component (that is the result is masked by
5433 * {@link #MEASURED_SIZE_MASK}).
5434 *
5435 * @return The raw measured width of this view.
5436 */
5437 public final int getMeasuredWidth() {
5438 return mMeasuredWidth & MEASURED_SIZE_MASK;
5439 }
5440
5441 /**
5442 * Return the full width measurement information for this view as computed
5443 * by the most recent call to {@link #measure}. This result is a bit mask
5444 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005445 * This should be used during measurement and layout calculations only. Use
5446 * {@link #getWidth()} to see how wide a view is after layout.
5447 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08005448 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005449 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08005450 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005451 return mMeasuredWidth;
5452 }
5453
5454 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005455 * Like {@link #getMeasuredHeightAndState()}, but only returns the
5456 * raw width component (that is the result is masked by
5457 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005458 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08005459 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005460 */
5461 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08005462 return mMeasuredHeight & MEASURED_SIZE_MASK;
5463 }
5464
5465 /**
5466 * Return the full height measurement information for this view as computed
5467 * by the most recent call to {@link #measure}. This result is a bit mask
5468 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
5469 * This should be used during measurement and layout calculations only. Use
5470 * {@link #getHeight()} to see how wide a view is after layout.
5471 *
5472 * @return The measured width of this view as a bit mask.
5473 */
5474 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005475 return mMeasuredHeight;
5476 }
5477
5478 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005479 * Return only the state bits of {@link #getMeasuredWidthAndState()}
5480 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
5481 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
5482 * and the height component is at the shifted bits
5483 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
5484 */
5485 public final int getMeasuredState() {
5486 return (mMeasuredWidth&MEASURED_STATE_MASK)
5487 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
5488 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
5489 }
5490
5491 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005492 * The transform matrix of this view, which is calculated based on the current
5493 * roation, scale, and pivot properties.
5494 *
5495 * @see #getRotation()
5496 * @see #getScaleX()
5497 * @see #getScaleY()
5498 * @see #getPivotX()
5499 * @see #getPivotY()
5500 * @return The current transform matrix for the view
5501 */
5502 public Matrix getMatrix() {
Jeff Brown86671742010-09-30 20:00:15 -07005503 updateMatrix();
Romain Guy33e72ae2010-07-17 12:40:29 -07005504 return mMatrix;
5505 }
5506
5507 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005508 * Utility function to determine if the value is far enough away from zero to be
5509 * considered non-zero.
5510 * @param value A floating point value to check for zero-ness
5511 * @return whether the passed-in value is far enough away from zero to be considered non-zero
5512 */
5513 private static boolean nonzero(float value) {
5514 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
5515 }
5516
5517 /**
Jeff Brown86671742010-09-30 20:00:15 -07005518 * Returns true if the transform matrix is the identity matrix.
5519 * Recomputes the matrix if necessary.
Romain Guy33e72ae2010-07-17 12:40:29 -07005520 *
5521 * @return True if the transform matrix is the identity matrix, false otherwise.
5522 */
Jeff Brown86671742010-09-30 20:00:15 -07005523 final boolean hasIdentityMatrix() {
5524 updateMatrix();
5525 return mMatrixIsIdentity;
5526 }
5527
5528 /**
5529 * Recomputes the transform matrix if necessary.
5530 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07005531 private void updateMatrix() {
Chet Haasec3aa3612010-06-17 08:50:37 -07005532 if (mMatrixDirty) {
5533 // transform-related properties have changed since the last time someone
5534 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07005535
5536 // Figure out if we need to update the pivot point
5537 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08005538 if ((mRight - mLeft) != mPrevWidth || (mBottom - mTop) != mPrevHeight) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005539 mPrevWidth = mRight - mLeft;
5540 mPrevHeight = mBottom - mTop;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -08005541 mPivotX = mPrevWidth / 2f;
5542 mPivotY = mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07005543 }
5544 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005545 mMatrix.reset();
Chet Haase897247b2010-09-09 14:54:47 -07005546 if (!nonzero(mRotationX) && !nonzero(mRotationY)) {
5547 mMatrix.setTranslate(mTranslationX, mTranslationY);
5548 mMatrix.preRotate(mRotation, mPivotX, mPivotY);
5549 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
5550 } else {
Chet Haasefd2b0022010-08-06 13:08:56 -07005551 if (mCamera == null) {
5552 mCamera = new Camera();
5553 matrix3D = new Matrix();
5554 }
5555 mCamera.save();
Chet Haase897247b2010-09-09 14:54:47 -07005556 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
Chet Haasefd2b0022010-08-06 13:08:56 -07005557 mCamera.rotateX(mRotationX);
5558 mCamera.rotateY(mRotationY);
Chet Haase897247b2010-09-09 14:54:47 -07005559 mCamera.rotateZ(-mRotation);
Chet Haasefd2b0022010-08-06 13:08:56 -07005560 mCamera.getMatrix(matrix3D);
5561 matrix3D.preTranslate(-mPivotX, -mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07005562 matrix3D.postTranslate(mPivotX + mTranslationX, mPivotY + mTranslationY);
Chet Haasefd2b0022010-08-06 13:08:56 -07005563 mMatrix.postConcat(matrix3D);
5564 mCamera.restore();
5565 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005566 mMatrixDirty = false;
5567 mMatrixIsIdentity = mMatrix.isIdentity();
5568 mInverseMatrixDirty = true;
5569 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005570 }
5571
5572 /**
5573 * Utility method to retrieve the inverse of the current mMatrix property.
5574 * We cache the matrix to avoid recalculating it when transform properties
5575 * have not changed.
5576 *
5577 * @return The inverse of the current matrix of this view.
5578 */
Jeff Brown86671742010-09-30 20:00:15 -07005579 final Matrix getInverseMatrix() {
5580 updateMatrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07005581 if (mInverseMatrixDirty) {
5582 if (mInverseMatrix == null) {
5583 mInverseMatrix = new Matrix();
5584 }
5585 mMatrix.invert(mInverseMatrix);
5586 mInverseMatrixDirty = false;
5587 }
5588 return mInverseMatrix;
5589 }
5590
5591 /**
5592 * The degrees that the view is rotated around the pivot point.
5593 *
5594 * @see #getPivotX()
5595 * @see #getPivotY()
5596 * @return The degrees of rotation.
5597 */
5598 public float getRotation() {
5599 return mRotation;
5600 }
5601
5602 /**
Chet Haase897247b2010-09-09 14:54:47 -07005603 * Sets the degrees that the view is rotated around the pivot point. Increasing values
5604 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07005605 *
5606 * @param rotation The degrees of rotation.
5607 * @see #getPivotX()
5608 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005609 *
5610 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07005611 */
5612 public void setRotation(float rotation) {
5613 if (mRotation != rotation) {
5614 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005615 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005616 mRotation = rotation;
5617 mMatrixDirty = true;
5618 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005619 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005620 }
5621 }
5622
5623 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005624 * The degrees that the view is rotated around the vertical axis through the pivot point.
5625 *
5626 * @see #getPivotX()
5627 * @see #getPivotY()
5628 * @return The degrees of Y rotation.
5629 */
5630 public float getRotationY() {
5631 return mRotationY;
5632 }
5633
5634 /**
Chet Haase897247b2010-09-09 14:54:47 -07005635 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
5636 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
5637 * down the y axis.
Chet Haasefd2b0022010-08-06 13:08:56 -07005638 *
5639 * @param rotationY The degrees of Y rotation.
5640 * @see #getPivotX()
5641 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005642 *
5643 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07005644 */
5645 public void setRotationY(float rotationY) {
5646 if (mRotationY != rotationY) {
5647 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005648 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005649 mRotationY = rotationY;
5650 mMatrixDirty = true;
5651 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005652 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005653 }
5654 }
5655
5656 /**
5657 * The degrees that the view is rotated around the horizontal axis through the pivot point.
5658 *
5659 * @see #getPivotX()
5660 * @see #getPivotY()
5661 * @return The degrees of X rotation.
5662 */
5663 public float getRotationX() {
5664 return mRotationX;
5665 }
5666
5667 /**
Chet Haase897247b2010-09-09 14:54:47 -07005668 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
5669 * Increasing values result in clockwise rotation from the viewpoint of looking down the
5670 * x axis.
Chet Haasefd2b0022010-08-06 13:08:56 -07005671 *
5672 * @param rotationX The degrees of X rotation.
5673 * @see #getPivotX()
5674 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005675 *
5676 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07005677 */
5678 public void setRotationX(float rotationX) {
5679 if (mRotationX != rotationX) {
5680 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005681 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005682 mRotationX = rotationX;
5683 mMatrixDirty = true;
5684 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005685 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005686 }
5687 }
5688
5689 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005690 * The amount that the view is scaled in x around the pivot point, as a proportion of
5691 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
5692 *
Joe Onorato93162322010-09-16 15:42:01 -04005693 * <p>By default, this is 1.0f.
5694 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005695 * @see #getPivotX()
5696 * @see #getPivotY()
5697 * @return The scaling factor.
5698 */
5699 public float getScaleX() {
5700 return mScaleX;
5701 }
5702
5703 /**
5704 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
5705 * the view's unscaled width. A value of 1 means that no scaling is applied.
5706 *
5707 * @param scaleX The scaling factor.
5708 * @see #getPivotX()
5709 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005710 *
5711 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07005712 */
5713 public void setScaleX(float scaleX) {
5714 if (mScaleX != scaleX) {
5715 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005716 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005717 mScaleX = scaleX;
5718 mMatrixDirty = true;
5719 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005720 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005721 }
5722 }
5723
5724 /**
5725 * The amount that the view is scaled in y around the pivot point, as a proportion of
5726 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
5727 *
Joe Onorato93162322010-09-16 15:42:01 -04005728 * <p>By default, this is 1.0f.
5729 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005730 * @see #getPivotX()
5731 * @see #getPivotY()
5732 * @return The scaling factor.
5733 */
5734 public float getScaleY() {
5735 return mScaleY;
5736 }
5737
5738 /**
5739 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
5740 * the view's unscaled width. A value of 1 means that no scaling is applied.
5741 *
5742 * @param scaleY The scaling factor.
5743 * @see #getPivotX()
5744 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005745 *
5746 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07005747 */
5748 public void setScaleY(float scaleY) {
5749 if (mScaleY != scaleY) {
5750 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005751 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005752 mScaleY = scaleY;
5753 mMatrixDirty = true;
5754 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005755 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005756 }
5757 }
5758
5759 /**
5760 * The x location of the point around which the view is {@link #setRotation(float) rotated}
5761 * and {@link #setScaleX(float) scaled}.
5762 *
5763 * @see #getRotation()
5764 * @see #getScaleX()
5765 * @see #getScaleY()
5766 * @see #getPivotY()
5767 * @return The x location of the pivot point.
5768 */
5769 public float getPivotX() {
5770 return mPivotX;
5771 }
5772
5773 /**
5774 * Sets the x location of the point around which the view is
5775 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07005776 * By default, the pivot point is centered on the object.
5777 * Setting this property disables this behavior and causes the view to use only the
5778 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07005779 *
5780 * @param pivotX The x location of the pivot point.
5781 * @see #getRotation()
5782 * @see #getScaleX()
5783 * @see #getScaleY()
5784 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005785 *
5786 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07005787 */
5788 public void setPivotX(float pivotX) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005789 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07005790 if (mPivotX != pivotX) {
5791 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005792 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005793 mPivotX = pivotX;
5794 mMatrixDirty = true;
5795 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005796 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005797 }
5798 }
5799
5800 /**
5801 * The y location of the point around which the view is {@link #setRotation(float) rotated}
5802 * and {@link #setScaleY(float) scaled}.
5803 *
5804 * @see #getRotation()
5805 * @see #getScaleX()
5806 * @see #getScaleY()
5807 * @see #getPivotY()
5808 * @return The y location of the pivot point.
5809 */
5810 public float getPivotY() {
5811 return mPivotY;
5812 }
5813
5814 /**
5815 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07005816 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
5817 * Setting this property disables this behavior and causes the view to use only the
5818 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07005819 *
5820 * @param pivotY The y location of the pivot point.
5821 * @see #getRotation()
5822 * @see #getScaleX()
5823 * @see #getScaleY()
5824 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005825 *
5826 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07005827 */
5828 public void setPivotY(float pivotY) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005829 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07005830 if (mPivotY != pivotY) {
5831 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005832 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005833 mPivotY = pivotY;
5834 mMatrixDirty = true;
5835 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005836 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005837 }
5838 }
5839
5840 /**
5841 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
5842 * completely transparent and 1 means the view is completely opaque.
5843 *
Joe Onorato93162322010-09-16 15:42:01 -04005844 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07005845 * @return The opacity of the view.
5846 */
5847 public float getAlpha() {
5848 return mAlpha;
5849 }
5850
5851 /**
Romain Guy171c5922011-01-06 10:04:23 -08005852 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
5853 * completely transparent and 1 means the view is completely opaque.</p>
5854 *
5855 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
5856 * responsible for applying the opacity itself. Otherwise, calling this method is
5857 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
5858 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07005859 *
5860 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08005861 *
Romain Guy171c5922011-01-06 10:04:23 -08005862 * @see #setLayerType(int, android.graphics.Paint)
5863 *
Chet Haase73066682010-11-29 15:55:32 -08005864 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07005865 */
5866 public void setAlpha(float alpha) {
5867 mAlpha = alpha;
Chet Haaseed032702010-10-01 14:05:54 -07005868 if (onSetAlpha((int) (alpha * 255))) {
Romain Guya3496a92010-10-12 11:53:24 -07005869 mPrivateFlags |= ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07005870 // subclass is handling alpha - don't optimize rendering cache invalidation
5871 invalidate();
5872 } else {
Romain Guya3496a92010-10-12 11:53:24 -07005873 mPrivateFlags &= ~ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07005874 invalidate(false);
5875 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005876 }
5877
5878 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005879 * Top position of this view relative to its parent.
5880 *
5881 * @return The top of this view, in pixels.
5882 */
5883 @ViewDebug.CapturedViewProperty
5884 public final int getTop() {
5885 return mTop;
5886 }
5887
5888 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005889 * Sets the top position of this view relative to its parent. This method is meant to be called
5890 * by the layout system and should not generally be called otherwise, because the property
5891 * may be changed at any time by the layout.
5892 *
5893 * @param top The top of this view, in pixels.
5894 */
5895 public final void setTop(int top) {
5896 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07005897 updateMatrix();
5898 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07005899 final ViewParent p = mParent;
5900 if (p != null && mAttachInfo != null) {
5901 final Rect r = mAttachInfo.mTmpInvalRect;
5902 int minTop;
5903 int yLoc;
5904 if (top < mTop) {
5905 minTop = top;
5906 yLoc = top - mTop;
5907 } else {
5908 minTop = mTop;
5909 yLoc = 0;
5910 }
5911 r.set(0, yLoc, mRight - mLeft, mBottom - minTop);
5912 p.invalidateChild(this, r);
5913 }
5914 } else {
5915 // Double-invalidation is necessary to capture view's old and new areas
5916 invalidate();
5917 }
5918
Chet Haaseed032702010-10-01 14:05:54 -07005919 int width = mRight - mLeft;
5920 int oldHeight = mBottom - mTop;
5921
Chet Haase21cd1382010-09-01 17:42:29 -07005922 mTop = top;
5923
Chet Haaseed032702010-10-01 14:05:54 -07005924 onSizeChanged(width, mBottom - mTop, width, oldHeight);
5925
Chet Haase21cd1382010-09-01 17:42:29 -07005926 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08005927 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
5928 // A change in dimension means an auto-centered pivot point changes, too
5929 mMatrixDirty = true;
5930 }
Chet Haase21cd1382010-09-01 17:42:29 -07005931 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
5932 invalidate();
5933 }
Chet Haase55dbb652010-12-21 20:15:08 -08005934 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07005935 }
5936 }
5937
5938 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005939 * Bottom position of this view relative to its parent.
5940 *
5941 * @return The bottom of this view, in pixels.
5942 */
5943 @ViewDebug.CapturedViewProperty
5944 public final int getBottom() {
5945 return mBottom;
5946 }
5947
5948 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08005949 * True if this view has changed since the last time being drawn.
5950 *
5951 * @return The dirty state of this view.
5952 */
5953 public boolean isDirty() {
5954 return (mPrivateFlags & DIRTY_MASK) != 0;
5955 }
5956
5957 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005958 * Sets the bottom position of this view relative to its parent. This method is meant to be
5959 * called by the layout system and should not generally be called otherwise, because the
5960 * property may be changed at any time by the layout.
5961 *
5962 * @param bottom The bottom of this view, in pixels.
5963 */
5964 public final void setBottom(int bottom) {
5965 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07005966 updateMatrix();
5967 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07005968 final ViewParent p = mParent;
5969 if (p != null && mAttachInfo != null) {
5970 final Rect r = mAttachInfo.mTmpInvalRect;
5971 int maxBottom;
5972 if (bottom < mBottom) {
5973 maxBottom = mBottom;
5974 } else {
5975 maxBottom = bottom;
5976 }
5977 r.set(0, 0, mRight - mLeft, maxBottom - mTop);
5978 p.invalidateChild(this, r);
5979 }
5980 } else {
5981 // Double-invalidation is necessary to capture view's old and new areas
5982 invalidate();
5983 }
5984
Chet Haaseed032702010-10-01 14:05:54 -07005985 int width = mRight - mLeft;
5986 int oldHeight = mBottom - mTop;
5987
Chet Haase21cd1382010-09-01 17:42:29 -07005988 mBottom = bottom;
5989
Chet Haaseed032702010-10-01 14:05:54 -07005990 onSizeChanged(width, mBottom - mTop, width, oldHeight);
5991
Chet Haase21cd1382010-09-01 17:42:29 -07005992 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08005993 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
5994 // A change in dimension means an auto-centered pivot point changes, too
5995 mMatrixDirty = true;
5996 }
Chet Haase21cd1382010-09-01 17:42:29 -07005997 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
5998 invalidate();
5999 }
Chet Haase55dbb652010-12-21 20:15:08 -08006000 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07006001 }
6002 }
6003
6004 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006005 * Left position of this view relative to its parent.
6006 *
6007 * @return The left edge of this view, in pixels.
6008 */
6009 @ViewDebug.CapturedViewProperty
6010 public final int getLeft() {
6011 return mLeft;
6012 }
6013
6014 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006015 * Sets the left position of this view relative to its parent. This method is meant to be called
6016 * by the layout system and should not generally be called otherwise, because the property
6017 * may be changed at any time by the layout.
6018 *
6019 * @param left The bottom of this view, in pixels.
6020 */
6021 public final void setLeft(int left) {
6022 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07006023 updateMatrix();
6024 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07006025 final ViewParent p = mParent;
6026 if (p != null && mAttachInfo != null) {
6027 final Rect r = mAttachInfo.mTmpInvalRect;
6028 int minLeft;
6029 int xLoc;
6030 if (left < mLeft) {
6031 minLeft = left;
6032 xLoc = left - mLeft;
6033 } else {
6034 minLeft = mLeft;
6035 xLoc = 0;
6036 }
6037 r.set(xLoc, 0, mRight - minLeft, mBottom - mTop);
6038 p.invalidateChild(this, r);
6039 }
6040 } else {
6041 // Double-invalidation is necessary to capture view's old and new areas
6042 invalidate();
6043 }
6044
Chet Haaseed032702010-10-01 14:05:54 -07006045 int oldWidth = mRight - mLeft;
6046 int height = mBottom - mTop;
6047
Chet Haase21cd1382010-09-01 17:42:29 -07006048 mLeft = left;
6049
Chet Haaseed032702010-10-01 14:05:54 -07006050 onSizeChanged(mRight - mLeft, height, oldWidth, height);
6051
Chet Haase21cd1382010-09-01 17:42:29 -07006052 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006053 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6054 // A change in dimension means an auto-centered pivot point changes, too
6055 mMatrixDirty = true;
6056 }
Chet Haase21cd1382010-09-01 17:42:29 -07006057 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
6058 invalidate();
6059 }
Chet Haase55dbb652010-12-21 20:15:08 -08006060 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07006061 }
6062 }
6063
6064 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006065 * Right position of this view relative to its parent.
6066 *
6067 * @return The right edge of this view, in pixels.
6068 */
6069 @ViewDebug.CapturedViewProperty
6070 public final int getRight() {
6071 return mRight;
6072 }
6073
6074 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006075 * Sets the right position of this view relative to its parent. This method is meant to be called
6076 * by the layout system and should not generally be called otherwise, because the property
6077 * may be changed at any time by the layout.
6078 *
6079 * @param right The bottom of this view, in pixels.
6080 */
6081 public final void setRight(int right) {
6082 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07006083 updateMatrix();
6084 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07006085 final ViewParent p = mParent;
6086 if (p != null && mAttachInfo != null) {
6087 final Rect r = mAttachInfo.mTmpInvalRect;
6088 int maxRight;
6089 if (right < mRight) {
6090 maxRight = mRight;
6091 } else {
6092 maxRight = right;
6093 }
6094 r.set(0, 0, maxRight - mLeft, mBottom - mTop);
6095 p.invalidateChild(this, r);
6096 }
6097 } else {
6098 // Double-invalidation is necessary to capture view's old and new areas
6099 invalidate();
6100 }
6101
Chet Haaseed032702010-10-01 14:05:54 -07006102 int oldWidth = mRight - mLeft;
6103 int height = mBottom - mTop;
6104
Chet Haase21cd1382010-09-01 17:42:29 -07006105 mRight = right;
6106
Chet Haaseed032702010-10-01 14:05:54 -07006107 onSizeChanged(mRight - mLeft, height, oldWidth, height);
6108
Chet Haase21cd1382010-09-01 17:42:29 -07006109 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006110 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6111 // A change in dimension means an auto-centered pivot point changes, too
6112 mMatrixDirty = true;
6113 }
Chet Haase21cd1382010-09-01 17:42:29 -07006114 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
6115 invalidate();
6116 }
Chet Haase55dbb652010-12-21 20:15:08 -08006117 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07006118 }
6119 }
6120
6121 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006122 * The visual x position of this view, in pixels. This is equivalent to the
6123 * {@link #setTranslationX(float) translationX} property plus the current
6124 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07006125 *
Chet Haasedf030d22010-07-30 17:22:38 -07006126 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07006127 */
Chet Haasedf030d22010-07-30 17:22:38 -07006128 public float getX() {
6129 return mLeft + mTranslationX;
6130 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006131
Chet Haasedf030d22010-07-30 17:22:38 -07006132 /**
6133 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
6134 * {@link #setTranslationX(float) translationX} property to be the difference between
6135 * the x value passed in and the current {@link #getLeft() left} property.
6136 *
6137 * @param x The visual x position of this view, in pixels.
6138 */
6139 public void setX(float x) {
6140 setTranslationX(x - mLeft);
6141 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006142
Chet Haasedf030d22010-07-30 17:22:38 -07006143 /**
6144 * The visual y position of this view, in pixels. This is equivalent to the
6145 * {@link #setTranslationY(float) translationY} property plus the current
6146 * {@link #getTop() top} property.
6147 *
6148 * @return The visual y position of this view, in pixels.
6149 */
6150 public float getY() {
6151 return mTop + mTranslationY;
6152 }
6153
6154 /**
6155 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
6156 * {@link #setTranslationY(float) translationY} property to be the difference between
6157 * the y value passed in and the current {@link #getTop() top} property.
6158 *
6159 * @param y The visual y position of this view, in pixels.
6160 */
6161 public void setY(float y) {
6162 setTranslationY(y - mTop);
6163 }
6164
6165
6166 /**
6167 * The horizontal location of this view relative to its {@link #getLeft() left} position.
6168 * This position is post-layout, in addition to wherever the object's
6169 * layout placed it.
6170 *
6171 * @return The horizontal position of this view relative to its left position, in pixels.
6172 */
6173 public float getTranslationX() {
6174 return mTranslationX;
6175 }
6176
6177 /**
6178 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
6179 * This effectively positions the object post-layout, in addition to wherever the object's
6180 * layout placed it.
6181 *
6182 * @param translationX The horizontal position of this view relative to its left position,
6183 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08006184 *
6185 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07006186 */
6187 public void setTranslationX(float translationX) {
6188 if (mTranslationX != translationX) {
6189 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006190 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006191 mTranslationX = translationX;
6192 mMatrixDirty = true;
6193 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006194 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006195 }
6196 }
6197
6198 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006199 * The horizontal location of this view relative to its {@link #getTop() top} position.
6200 * This position is post-layout, in addition to wherever the object's
6201 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07006202 *
Chet Haasedf030d22010-07-30 17:22:38 -07006203 * @return The vertical position of this view relative to its top position,
6204 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07006205 */
Chet Haasedf030d22010-07-30 17:22:38 -07006206 public float getTranslationY() {
6207 return mTranslationY;
Chet Haasec3aa3612010-06-17 08:50:37 -07006208 }
6209
6210 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006211 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
6212 * This effectively positions the object post-layout, in addition to wherever the object's
6213 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07006214 *
Chet Haasedf030d22010-07-30 17:22:38 -07006215 * @param translationY The vertical position of this view relative to its top position,
6216 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08006217 *
6218 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07006219 */
Chet Haasedf030d22010-07-30 17:22:38 -07006220 public void setTranslationY(float translationY) {
6221 if (mTranslationY != translationY) {
6222 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006223 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006224 mTranslationY = translationY;
6225 mMatrixDirty = true;
6226 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006227 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006228 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006229 }
6230
6231 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006232 * Hit rectangle in parent's coordinates
6233 *
6234 * @param outRect The hit rectangle of the view.
6235 */
6236 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07006237 updateMatrix();
6238 if (mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006239 outRect.set(mLeft, mTop, mRight, mBottom);
6240 } else {
6241 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Romain Guy33e72ae2010-07-17 12:40:29 -07006242 tmpRect.set(-mPivotX, -mPivotY, getWidth() - mPivotX, getHeight() - mPivotY);
Jeff Brown86671742010-09-30 20:00:15 -07006243 mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07006244 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
6245 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07006246 }
6247 }
6248
6249 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07006250 * Determines whether the given point, in local coordinates is inside the view.
6251 */
6252 /*package*/ final boolean pointInView(float localX, float localY) {
6253 return localX >= 0 && localX < (mRight - mLeft)
6254 && localY >= 0 && localY < (mBottom - mTop);
6255 }
6256
6257 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07006258 * Utility method to determine whether the given point, in local coordinates,
6259 * is inside the view, where the area of the view is expanded by the slop factor.
6260 * This method is called while processing touch-move events to determine if the event
6261 * is still within the view.
6262 */
6263 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07006264 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07006265 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006266 }
6267
6268 /**
6269 * When a view has focus and the user navigates away from it, the next view is searched for
6270 * starting from the rectangle filled in by this method.
6271 *
6272 * By default, the rectange is the {@link #getDrawingRect})of the view. However, if your
6273 * view maintains some idea of internal selection, such as a cursor, or a selected row
6274 * or column, you should override this method and fill in a more specific rectangle.
6275 *
6276 * @param r The rectangle to fill in, in this view's coordinates.
6277 */
6278 public void getFocusedRect(Rect r) {
6279 getDrawingRect(r);
6280 }
6281
6282 /**
6283 * If some part of this view is not clipped by any of its parents, then
6284 * return that area in r in global (root) coordinates. To convert r to local
6285 * coordinates, offset it by -globalOffset (e.g. r.offset(-globalOffset.x,
6286 * -globalOffset.y)) If the view is completely clipped or translated out,
6287 * return false.
6288 *
6289 * @param r If true is returned, r holds the global coordinates of the
6290 * visible portion of this view.
6291 * @param globalOffset If true is returned, globalOffset holds the dx,dy
6292 * between this view and its root. globalOffet may be null.
6293 * @return true if r is non-empty (i.e. part of the view is visible at the
6294 * root level.
6295 */
6296 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
6297 int width = mRight - mLeft;
6298 int height = mBottom - mTop;
6299 if (width > 0 && height > 0) {
6300 r.set(0, 0, width, height);
6301 if (globalOffset != null) {
6302 globalOffset.set(-mScrollX, -mScrollY);
6303 }
6304 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
6305 }
6306 return false;
6307 }
6308
6309 public final boolean getGlobalVisibleRect(Rect r) {
6310 return getGlobalVisibleRect(r, null);
6311 }
6312
6313 public final boolean getLocalVisibleRect(Rect r) {
6314 Point offset = new Point();
6315 if (getGlobalVisibleRect(r, offset)) {
6316 r.offset(-offset.x, -offset.y); // make r local
6317 return true;
6318 }
6319 return false;
6320 }
6321
6322 /**
6323 * Offset this view's vertical location by the specified number of pixels.
6324 *
6325 * @param offset the number of pixels to offset the view by
6326 */
6327 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006328 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07006329 updateMatrix();
6330 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006331 final ViewParent p = mParent;
6332 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006333 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006334 int minTop;
6335 int maxBottom;
6336 int yLoc;
6337 if (offset < 0) {
6338 minTop = mTop + offset;
6339 maxBottom = mBottom;
6340 yLoc = offset;
6341 } else {
6342 minTop = mTop;
6343 maxBottom = mBottom + offset;
6344 yLoc = 0;
6345 }
6346 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
6347 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07006348 }
6349 } else {
Chet Haaseed032702010-10-01 14:05:54 -07006350 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006351 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006352
Chet Haasec3aa3612010-06-17 08:50:37 -07006353 mTop += offset;
6354 mBottom += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07006355
Chet Haasec3aa3612010-06-17 08:50:37 -07006356 if (!mMatrixIsIdentity) {
6357 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006358 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006359 }
6360 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006361 }
6362
6363 /**
6364 * Offset this view's horizontal location by the specified amount of pixels.
6365 *
6366 * @param offset the numer of pixels to offset the view by
6367 */
6368 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006369 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07006370 updateMatrix();
6371 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006372 final ViewParent p = mParent;
6373 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006374 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006375 int minLeft;
6376 int maxRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006377 if (offset < 0) {
6378 minLeft = mLeft + offset;
6379 maxRight = mRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006380 } else {
6381 minLeft = mLeft;
6382 maxRight = mRight + offset;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006383 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006384 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
Chet Haase8fbf8d22010-07-30 15:01:32 -07006385 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07006386 }
6387 } else {
Chet Haaseed032702010-10-01 14:05:54 -07006388 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006389 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006390
Chet Haasec3aa3612010-06-17 08:50:37 -07006391 mLeft += offset;
6392 mRight += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07006393
Chet Haasec3aa3612010-06-17 08:50:37 -07006394 if (!mMatrixIsIdentity) {
6395 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006396 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006397 }
6398 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006399 }
6400
6401 /**
6402 * Get the LayoutParams associated with this view. All views should have
6403 * layout parameters. These supply parameters to the <i>parent</i> of this
6404 * view specifying how it should be arranged. There are many subclasses of
6405 * ViewGroup.LayoutParams, and these correspond to the different subclasses
6406 * of ViewGroup that are responsible for arranging their children.
6407 * @return The LayoutParams associated with this view
6408 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07006409 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006410 public ViewGroup.LayoutParams getLayoutParams() {
6411 return mLayoutParams;
6412 }
6413
6414 /**
6415 * Set the layout parameters associated with this view. These supply
6416 * parameters to the <i>parent</i> of this view specifying how it should be
6417 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
6418 * correspond to the different subclasses of ViewGroup that are responsible
6419 * for arranging their children.
6420 *
6421 * @param params the layout parameters for this view
6422 */
6423 public void setLayoutParams(ViewGroup.LayoutParams params) {
6424 if (params == null) {
6425 throw new NullPointerException("params == null");
6426 }
6427 mLayoutParams = params;
6428 requestLayout();
6429 }
6430
6431 /**
6432 * Set the scrolled position of your view. This will cause a call to
6433 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6434 * invalidated.
6435 * @param x the x position to scroll to
6436 * @param y the y position to scroll to
6437 */
6438 public void scrollTo(int x, int y) {
6439 if (mScrollX != x || mScrollY != y) {
6440 int oldX = mScrollX;
6441 int oldY = mScrollY;
6442 mScrollX = x;
6443 mScrollY = y;
6444 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07006445 if (!awakenScrollBars()) {
6446 invalidate();
6447 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006448 }
6449 }
6450
6451 /**
6452 * Move the scrolled position of your view. This will cause a call to
6453 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6454 * invalidated.
6455 * @param x the amount of pixels to scroll by horizontally
6456 * @param y the amount of pixels to scroll by vertically
6457 */
6458 public void scrollBy(int x, int y) {
6459 scrollTo(mScrollX + x, mScrollY + y);
6460 }
6461
6462 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006463 * <p>Trigger the scrollbars to draw. When invoked this method starts an
6464 * animation to fade the scrollbars out after a default delay. If a subclass
6465 * provides animated scrolling, the start delay should equal the duration
6466 * of the scrolling animation.</p>
6467 *
6468 * <p>The animation starts only if at least one of the scrollbars is
6469 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
6470 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6471 * this method returns true, and false otherwise. If the animation is
6472 * started, this method calls {@link #invalidate()}; in that case the
6473 * caller should not call {@link #invalidate()}.</p>
6474 *
6475 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07006476 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07006477 *
6478 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
6479 * and {@link #scrollTo(int, int)}.</p>
6480 *
6481 * @return true if the animation is played, false otherwise
6482 *
6483 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07006484 * @see #scrollBy(int, int)
6485 * @see #scrollTo(int, int)
6486 * @see #isHorizontalScrollBarEnabled()
6487 * @see #isVerticalScrollBarEnabled()
6488 * @see #setHorizontalScrollBarEnabled(boolean)
6489 * @see #setVerticalScrollBarEnabled(boolean)
6490 */
6491 protected boolean awakenScrollBars() {
6492 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07006493 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07006494 }
6495
6496 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07006497 * Trigger the scrollbars to draw.
6498 * This method differs from awakenScrollBars() only in its default duration.
6499 * initialAwakenScrollBars() will show the scroll bars for longer than
6500 * usual to give the user more of a chance to notice them.
6501 *
6502 * @return true if the animation is played, false otherwise.
6503 */
6504 private boolean initialAwakenScrollBars() {
6505 return mScrollCache != null &&
6506 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
6507 }
6508
6509 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006510 * <p>
6511 * Trigger the scrollbars to draw. When invoked this method starts an
6512 * animation to fade the scrollbars out after a fixed delay. If a subclass
6513 * provides animated scrolling, the start delay should equal the duration of
6514 * the scrolling animation.
6515 * </p>
6516 *
6517 * <p>
6518 * The animation starts only if at least one of the scrollbars is enabled,
6519 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6520 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6521 * this method returns true, and false otherwise. If the animation is
6522 * started, this method calls {@link #invalidate()}; in that case the caller
6523 * should not call {@link #invalidate()}.
6524 * </p>
6525 *
6526 * <p>
6527 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07006528 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07006529 * </p>
6530 *
6531 * @param startDelay the delay, in milliseconds, after which the animation
6532 * should start; when the delay is 0, the animation starts
6533 * immediately
6534 * @return true if the animation is played, false otherwise
6535 *
Mike Cleronf116bf82009-09-27 19:14:12 -07006536 * @see #scrollBy(int, int)
6537 * @see #scrollTo(int, int)
6538 * @see #isHorizontalScrollBarEnabled()
6539 * @see #isVerticalScrollBarEnabled()
6540 * @see #setHorizontalScrollBarEnabled(boolean)
6541 * @see #setVerticalScrollBarEnabled(boolean)
6542 */
6543 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07006544 return awakenScrollBars(startDelay, true);
6545 }
6546
6547 /**
6548 * <p>
6549 * Trigger the scrollbars to draw. When invoked this method starts an
6550 * animation to fade the scrollbars out after a fixed delay. If a subclass
6551 * provides animated scrolling, the start delay should equal the duration of
6552 * the scrolling animation.
6553 * </p>
6554 *
6555 * <p>
6556 * The animation starts only if at least one of the scrollbars is enabled,
6557 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6558 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6559 * this method returns true, and false otherwise. If the animation is
6560 * started, this method calls {@link #invalidate()} if the invalidate parameter
6561 * is set to true; in that case the caller
6562 * should not call {@link #invalidate()}.
6563 * </p>
6564 *
6565 * <p>
6566 * This method should be invoked everytime a subclass directly updates the
6567 * scroll parameters.
6568 * </p>
6569 *
6570 * @param startDelay the delay, in milliseconds, after which the animation
6571 * should start; when the delay is 0, the animation starts
6572 * immediately
6573 *
6574 * @param invalidate Wheter this method should call invalidate
6575 *
6576 * @return true if the animation is played, false otherwise
6577 *
6578 * @see #scrollBy(int, int)
6579 * @see #scrollTo(int, int)
6580 * @see #isHorizontalScrollBarEnabled()
6581 * @see #isVerticalScrollBarEnabled()
6582 * @see #setHorizontalScrollBarEnabled(boolean)
6583 * @see #setVerticalScrollBarEnabled(boolean)
6584 */
6585 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07006586 final ScrollabilityCache scrollCache = mScrollCache;
6587
6588 if (scrollCache == null || !scrollCache.fadeScrollBars) {
6589 return false;
6590 }
6591
6592 if (scrollCache.scrollBar == null) {
6593 scrollCache.scrollBar = new ScrollBarDrawable();
6594 }
6595
6596 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
6597
Mike Cleron290947b2009-09-29 18:34:32 -07006598 if (invalidate) {
6599 // Invalidate to show the scrollbars
6600 invalidate();
6601 }
Mike Cleronf116bf82009-09-27 19:14:12 -07006602
6603 if (scrollCache.state == ScrollabilityCache.OFF) {
6604 // FIXME: this is copied from WindowManagerService.
6605 // We should get this value from the system when it
6606 // is possible to do so.
6607 final int KEY_REPEAT_FIRST_DELAY = 750;
6608 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
6609 }
6610
6611 // Tell mScrollCache when we should start fading. This may
6612 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07006613 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07006614 scrollCache.fadeStartTime = fadeStartTime;
6615 scrollCache.state = ScrollabilityCache.ON;
6616
6617 // Schedule our fader to run, unscheduling any old ones first
6618 if (mAttachInfo != null) {
6619 mAttachInfo.mHandler.removeCallbacks(scrollCache);
6620 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
6621 }
6622
6623 return true;
6624 }
6625
6626 return false;
6627 }
6628
6629 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006630 * Mark the the area defined by dirty as needing to be drawn. If the view is
6631 * visible, {@link #onDraw} will be called at some point in the future.
6632 * This must be called from a UI thread. To call from a non-UI thread, call
6633 * {@link #postInvalidate()}.
6634 *
6635 * WARNING: This method is destructive to dirty.
6636 * @param dirty the rectangle representing the bounds of the dirty region
6637 */
6638 public void invalidate(Rect dirty) {
6639 if (ViewDebug.TRACE_HIERARCHY) {
6640 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6641 }
6642
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006643 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
6644 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006645 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6646 final ViewParent p = mParent;
6647 final AttachInfo ai = mAttachInfo;
Romain Guyaf636eb2010-12-09 17:47:21 -08006648 if (p != null && ai != null && ai.mHardwareAccelerated) {
6649 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6650 // with a null dirty rect, which tells the ViewRoot to redraw everything
6651 p.invalidateChild(this, null);
6652 return;
6653 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006654 if (p != null && ai != null) {
6655 final int scrollX = mScrollX;
6656 final int scrollY = mScrollY;
6657 final Rect r = ai.mTmpInvalRect;
6658 r.set(dirty.left - scrollX, dirty.top - scrollY,
6659 dirty.right - scrollX, dirty.bottom - scrollY);
6660 mParent.invalidateChild(this, r);
6661 }
6662 }
6663 }
6664
6665 /**
6666 * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
6667 * The coordinates of the dirty rect are relative to the view.
6668 * If the view is visible, {@link #onDraw} will be called at some point
6669 * in the future. This must be called from a UI thread. To call
6670 * from a non-UI thread, call {@link #postInvalidate()}.
6671 * @param l the left position of the dirty region
6672 * @param t the top position of the dirty region
6673 * @param r the right position of the dirty region
6674 * @param b the bottom position of the dirty region
6675 */
6676 public void invalidate(int l, int t, int r, int b) {
6677 if (ViewDebug.TRACE_HIERARCHY) {
6678 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6679 }
6680
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006681 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
6682 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006683 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6684 final ViewParent p = mParent;
6685 final AttachInfo ai = mAttachInfo;
Chet Haasef2f7d8f2010-12-03 14:08:14 -08006686 if (p != null && ai != null && ai.mHardwareAccelerated) {
6687 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6688 // with a null dirty rect, which tells the ViewRoot to redraw everything
6689 p.invalidateChild(this, null);
6690 return;
6691 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006692 if (p != null && ai != null && l < r && t < b) {
6693 final int scrollX = mScrollX;
6694 final int scrollY = mScrollY;
6695 final Rect tmpr = ai.mTmpInvalRect;
6696 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
6697 p.invalidateChild(this, tmpr);
6698 }
6699 }
6700 }
6701
6702 /**
6703 * Invalidate the whole view. If the view is visible, {@link #onDraw} will
6704 * be called at some point in the future. This must be called from a
6705 * UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
6706 */
6707 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -07006708 invalidate(true);
6709 }
6710
6711 /**
6712 * This is where the invalidate() work actually happens. A full invalidate()
6713 * causes the drawing cache to be invalidated, but this function can be called with
6714 * invalidateCache set to false to skip that invalidation step for cases that do not
6715 * need it (for example, a component that remains at the same dimensions with the same
6716 * content).
6717 *
6718 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
6719 * well. This is usually true for a full invalidate, but may be set to false if the
6720 * View's contents or dimensions have not changed.
6721 */
6722 private void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006723 if (ViewDebug.TRACE_HIERARCHY) {
6724 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6725 }
6726
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006727 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
6728 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID)) {
Chet Haaseed032702010-10-01 14:05:54 -07006729 mPrivateFlags &= ~DRAWN;
6730 if (invalidateCache) {
6731 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6732 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006733 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -07006734 final ViewParent p = mParent;
Chet Haasef2f7d8f2010-12-03 14:08:14 -08006735 if (p != null && ai != null && ai.mHardwareAccelerated) {
6736 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6737 // with a null dirty rect, which tells the ViewRoot to redraw everything
6738 p.invalidateChild(this, null);
6739 return;
6740 }
Michael Jurkaebefea42010-11-15 16:04:01 -08006741
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006742 if (p != null && ai != null) {
6743 final Rect r = ai.mTmpInvalRect;
6744 r.set(0, 0, mRight - mLeft, mBottom - mTop);
6745 // Don't call invalidate -- we don't want to internally scroll
6746 // our own bounds
6747 p.invalidateChild(this, r);
6748 }
6749 }
6750 }
6751
6752 /**
Romain Guy24443ea2009-05-11 11:56:30 -07006753 * Indicates whether this View is opaque. An opaque View guarantees that it will
6754 * draw all the pixels overlapping its bounds using a fully opaque color.
6755 *
6756 * Subclasses of View should override this method whenever possible to indicate
6757 * whether an instance is opaque. Opaque Views are treated in a special way by
6758 * the View hierarchy, possibly allowing it to perform optimizations during
6759 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -07006760 *
Romain Guy24443ea2009-05-11 11:56:30 -07006761 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -07006762 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07006763 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -07006764 public boolean isOpaque() {
Chet Haase70d4ba12010-10-06 09:46:45 -07006765 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK &&
6766 (mAlpha >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD);
Romain Guy8f1344f52009-05-15 16:03:59 -07006767 }
6768
Adam Powell20232d02010-12-08 21:08:53 -08006769 /**
6770 * @hide
6771 */
6772 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -07006773 // Opaque if:
6774 // - Has a background
6775 // - Background is opaque
6776 // - Doesn't have scrollbars or scrollbars are inside overlay
6777
6778 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) {
6779 mPrivateFlags |= OPAQUE_BACKGROUND;
6780 } else {
6781 mPrivateFlags &= ~OPAQUE_BACKGROUND;
6782 }
6783
6784 final int flags = mViewFlags;
6785 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
6786 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
6787 mPrivateFlags |= OPAQUE_SCROLLBARS;
6788 } else {
6789 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
6790 }
6791 }
6792
6793 /**
6794 * @hide
6795 */
6796 protected boolean hasOpaqueScrollbars() {
6797 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -07006798 }
6799
6800 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006801 * @return A handler associated with the thread running the View. This
6802 * handler can be used to pump events in the UI events queue.
6803 */
6804 public Handler getHandler() {
6805 if (mAttachInfo != null) {
6806 return mAttachInfo.mHandler;
6807 }
6808 return null;
6809 }
6810
6811 /**
6812 * Causes the Runnable to be added to the message queue.
6813 * The runnable will be run on the user interface thread.
6814 *
6815 * @param action The Runnable that will be executed.
6816 *
6817 * @return Returns true if the Runnable was successfully placed in to the
6818 * message queue. Returns false on failure, usually because the
6819 * looper processing the message queue is exiting.
6820 */
6821 public boolean post(Runnable action) {
6822 Handler handler;
6823 if (mAttachInfo != null) {
6824 handler = mAttachInfo.mHandler;
6825 } else {
6826 // Assume that post will succeed later
6827 ViewRoot.getRunQueue().post(action);
6828 return true;
6829 }
6830
6831 return handler.post(action);
6832 }
6833
6834 /**
6835 * Causes the Runnable to be added to the message queue, to be run
6836 * after the specified amount of time elapses.
6837 * The runnable will be run on the user interface thread.
6838 *
6839 * @param action The Runnable that will be executed.
6840 * @param delayMillis The delay (in milliseconds) until the Runnable
6841 * will be executed.
6842 *
6843 * @return true if the Runnable was successfully placed in to the
6844 * message queue. Returns false on failure, usually because the
6845 * looper processing the message queue is exiting. Note that a
6846 * result of true does not mean the Runnable will be processed --
6847 * if the looper is quit before the delivery time of the message
6848 * occurs then the message will be dropped.
6849 */
6850 public boolean postDelayed(Runnable action, long delayMillis) {
6851 Handler handler;
6852 if (mAttachInfo != null) {
6853 handler = mAttachInfo.mHandler;
6854 } else {
6855 // Assume that post will succeed later
6856 ViewRoot.getRunQueue().postDelayed(action, delayMillis);
6857 return true;
6858 }
6859
6860 return handler.postDelayed(action, delayMillis);
6861 }
6862
6863 /**
6864 * Removes the specified Runnable from the message queue.
6865 *
6866 * @param action The Runnable to remove from the message handling queue
6867 *
6868 * @return true if this view could ask the Handler to remove the Runnable,
6869 * false otherwise. When the returned value is true, the Runnable
6870 * may or may not have been actually removed from the message queue
6871 * (for instance, if the Runnable was not in the queue already.)
6872 */
6873 public boolean removeCallbacks(Runnable action) {
6874 Handler handler;
6875 if (mAttachInfo != null) {
6876 handler = mAttachInfo.mHandler;
6877 } else {
6878 // Assume that post will succeed later
6879 ViewRoot.getRunQueue().removeCallbacks(action);
6880 return true;
6881 }
6882
6883 handler.removeCallbacks(action);
6884 return true;
6885 }
6886
6887 /**
6888 * Cause an invalidate to happen on a subsequent cycle through the event loop.
6889 * Use this to invalidate the View from a non-UI thread.
6890 *
6891 * @see #invalidate()
6892 */
6893 public void postInvalidate() {
6894 postInvalidateDelayed(0);
6895 }
6896
6897 /**
6898 * Cause an invalidate of the specified area to happen on a subsequent cycle
6899 * through the event loop. Use this to invalidate the View from a non-UI thread.
6900 *
6901 * @param left The left coordinate of the rectangle to invalidate.
6902 * @param top The top coordinate of the rectangle to invalidate.
6903 * @param right The right coordinate of the rectangle to invalidate.
6904 * @param bottom The bottom coordinate of the rectangle to invalidate.
6905 *
6906 * @see #invalidate(int, int, int, int)
6907 * @see #invalidate(Rect)
6908 */
6909 public void postInvalidate(int left, int top, int right, int bottom) {
6910 postInvalidateDelayed(0, left, top, right, bottom);
6911 }
6912
6913 /**
6914 * Cause an invalidate to happen on a subsequent cycle through the event
6915 * loop. Waits for the specified amount of time.
6916 *
6917 * @param delayMilliseconds the duration in milliseconds to delay the
6918 * invalidation by
6919 */
6920 public void postInvalidateDelayed(long delayMilliseconds) {
6921 // We try only with the AttachInfo because there's no point in invalidating
6922 // if we are not attached to our window
6923 if (mAttachInfo != null) {
6924 Message msg = Message.obtain();
6925 msg.what = AttachInfo.INVALIDATE_MSG;
6926 msg.obj = this;
6927 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
6928 }
6929 }
6930
6931 /**
6932 * Cause an invalidate of the specified area to happen on a subsequent cycle
6933 * through the event loop. Waits for the specified amount of time.
6934 *
6935 * @param delayMilliseconds the duration in milliseconds to delay the
6936 * invalidation by
6937 * @param left The left coordinate of the rectangle to invalidate.
6938 * @param top The top coordinate of the rectangle to invalidate.
6939 * @param right The right coordinate of the rectangle to invalidate.
6940 * @param bottom The bottom coordinate of the rectangle to invalidate.
6941 */
6942 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
6943 int right, int bottom) {
6944
6945 // We try only with the AttachInfo because there's no point in invalidating
6946 // if we are not attached to our window
6947 if (mAttachInfo != null) {
6948 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
6949 info.target = this;
6950 info.left = left;
6951 info.top = top;
6952 info.right = right;
6953 info.bottom = bottom;
6954
6955 final Message msg = Message.obtain();
6956 msg.what = AttachInfo.INVALIDATE_RECT_MSG;
6957 msg.obj = info;
6958 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
6959 }
6960 }
6961
6962 /**
6963 * Called by a parent to request that a child update its values for mScrollX
6964 * and mScrollY if necessary. This will typically be done if the child is
6965 * animating a scroll using a {@link android.widget.Scroller Scroller}
6966 * object.
6967 */
6968 public void computeScroll() {
6969 }
6970
6971 /**
6972 * <p>Indicate whether the horizontal edges are faded when the view is
6973 * scrolled horizontally.</p>
6974 *
6975 * @return true if the horizontal edges should are faded on scroll, false
6976 * otherwise
6977 *
6978 * @see #setHorizontalFadingEdgeEnabled(boolean)
6979 * @attr ref android.R.styleable#View_fadingEdge
6980 */
6981 public boolean isHorizontalFadingEdgeEnabled() {
6982 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
6983 }
6984
6985 /**
6986 * <p>Define whether the horizontal edges should be faded when this view
6987 * is scrolled horizontally.</p>
6988 *
6989 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
6990 * be faded when the view is scrolled
6991 * horizontally
6992 *
6993 * @see #isHorizontalFadingEdgeEnabled()
6994 * @attr ref android.R.styleable#View_fadingEdge
6995 */
6996 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
6997 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
6998 if (horizontalFadingEdgeEnabled) {
6999 initScrollCache();
7000 }
7001
7002 mViewFlags ^= FADING_EDGE_HORIZONTAL;
7003 }
7004 }
7005
7006 /**
7007 * <p>Indicate whether the vertical edges are faded when the view is
7008 * scrolled horizontally.</p>
7009 *
7010 * @return true if the vertical edges should are faded on scroll, false
7011 * otherwise
7012 *
7013 * @see #setVerticalFadingEdgeEnabled(boolean)
7014 * @attr ref android.R.styleable#View_fadingEdge
7015 */
7016 public boolean isVerticalFadingEdgeEnabled() {
7017 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
7018 }
7019
7020 /**
7021 * <p>Define whether the vertical edges should be faded when this view
7022 * is scrolled vertically.</p>
7023 *
7024 * @param verticalFadingEdgeEnabled true if the vertical edges should
7025 * be faded when the view is scrolled
7026 * vertically
7027 *
7028 * @see #isVerticalFadingEdgeEnabled()
7029 * @attr ref android.R.styleable#View_fadingEdge
7030 */
7031 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
7032 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
7033 if (verticalFadingEdgeEnabled) {
7034 initScrollCache();
7035 }
7036
7037 mViewFlags ^= FADING_EDGE_VERTICAL;
7038 }
7039 }
7040
7041 /**
7042 * Returns the strength, or intensity, of the top faded edge. The strength is
7043 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7044 * returns 0.0 or 1.0 but no value in between.
7045 *
7046 * Subclasses should override this method to provide a smoother fade transition
7047 * when scrolling occurs.
7048 *
7049 * @return the intensity of the top fade as a float between 0.0f and 1.0f
7050 */
7051 protected float getTopFadingEdgeStrength() {
7052 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
7053 }
7054
7055 /**
7056 * Returns the strength, or intensity, of the bottom faded edge. The strength is
7057 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7058 * returns 0.0 or 1.0 but no value in between.
7059 *
7060 * Subclasses should override this method to provide a smoother fade transition
7061 * when scrolling occurs.
7062 *
7063 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
7064 */
7065 protected float getBottomFadingEdgeStrength() {
7066 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
7067 computeVerticalScrollRange() ? 1.0f : 0.0f;
7068 }
7069
7070 /**
7071 * Returns the strength, or intensity, of the left faded edge. The strength is
7072 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7073 * returns 0.0 or 1.0 but no value in between.
7074 *
7075 * Subclasses should override this method to provide a smoother fade transition
7076 * when scrolling occurs.
7077 *
7078 * @return the intensity of the left fade as a float between 0.0f and 1.0f
7079 */
7080 protected float getLeftFadingEdgeStrength() {
7081 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
7082 }
7083
7084 /**
7085 * Returns the strength, or intensity, of the right faded edge. The strength is
7086 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7087 * returns 0.0 or 1.0 but no value in between.
7088 *
7089 * Subclasses should override this method to provide a smoother fade transition
7090 * when scrolling occurs.
7091 *
7092 * @return the intensity of the right fade as a float between 0.0f and 1.0f
7093 */
7094 protected float getRightFadingEdgeStrength() {
7095 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
7096 computeHorizontalScrollRange() ? 1.0f : 0.0f;
7097 }
7098
7099 /**
7100 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
7101 * scrollbar is not drawn by default.</p>
7102 *
7103 * @return true if the horizontal scrollbar should be painted, false
7104 * otherwise
7105 *
7106 * @see #setHorizontalScrollBarEnabled(boolean)
7107 */
7108 public boolean isHorizontalScrollBarEnabled() {
7109 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
7110 }
7111
7112 /**
7113 * <p>Define whether the horizontal scrollbar should be drawn or not. The
7114 * scrollbar is not drawn by default.</p>
7115 *
7116 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
7117 * be painted
7118 *
7119 * @see #isHorizontalScrollBarEnabled()
7120 */
7121 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
7122 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
7123 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07007124 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007125 recomputePadding();
7126 }
7127 }
7128
7129 /**
7130 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
7131 * scrollbar is not drawn by default.</p>
7132 *
7133 * @return true if the vertical scrollbar should be painted, false
7134 * otherwise
7135 *
7136 * @see #setVerticalScrollBarEnabled(boolean)
7137 */
7138 public boolean isVerticalScrollBarEnabled() {
7139 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
7140 }
7141
7142 /**
7143 * <p>Define whether the vertical scrollbar should be drawn or not. The
7144 * scrollbar is not drawn by default.</p>
7145 *
7146 * @param verticalScrollBarEnabled true if the vertical scrollbar should
7147 * be painted
7148 *
7149 * @see #isVerticalScrollBarEnabled()
7150 */
7151 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
7152 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
7153 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07007154 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007155 recomputePadding();
7156 }
7157 }
7158
Adam Powell20232d02010-12-08 21:08:53 -08007159 /**
7160 * @hide
7161 */
7162 protected void recomputePadding() {
7163 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007164 }
Mike Cleronfe81d382009-09-28 14:22:16 -07007165
7166 /**
7167 * Define whether scrollbars will fade when the view is not scrolling.
7168 *
7169 * @param fadeScrollbars wheter to enable fading
7170 *
7171 */
7172 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
7173 initScrollCache();
7174 final ScrollabilityCache scrollabilityCache = mScrollCache;
7175 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -07007176 if (fadeScrollbars) {
7177 scrollabilityCache.state = ScrollabilityCache.OFF;
7178 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -07007179 scrollabilityCache.state = ScrollabilityCache.ON;
7180 }
7181 }
7182
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007183 /**
Mike Cleron52f0a642009-09-28 18:21:37 -07007184 *
7185 * Returns true if scrollbars will fade when this view is not scrolling
7186 *
7187 * @return true if scrollbar fading is enabled
7188 */
7189 public boolean isScrollbarFadingEnabled() {
7190 return mScrollCache != null && mScrollCache.fadeScrollBars;
7191 }
7192
7193 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007194 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
7195 * inset. When inset, they add to the padding of the view. And the scrollbars
7196 * can be drawn inside the padding area or on the edge of the view. For example,
7197 * if a view has a background drawable and you want to draw the scrollbars
7198 * inside the padding specified by the drawable, you can use
7199 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
7200 * appear at the edge of the view, ignoring the padding, then you can use
7201 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
7202 * @param style the style of the scrollbars. Should be one of
7203 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
7204 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
7205 * @see #SCROLLBARS_INSIDE_OVERLAY
7206 * @see #SCROLLBARS_INSIDE_INSET
7207 * @see #SCROLLBARS_OUTSIDE_OVERLAY
7208 * @see #SCROLLBARS_OUTSIDE_INSET
7209 */
7210 public void setScrollBarStyle(int style) {
7211 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
7212 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -07007213 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007214 recomputePadding();
7215 }
7216 }
7217
7218 /**
7219 * <p>Returns the current scrollbar style.</p>
7220 * @return the current scrollbar style
7221 * @see #SCROLLBARS_INSIDE_OVERLAY
7222 * @see #SCROLLBARS_INSIDE_INSET
7223 * @see #SCROLLBARS_OUTSIDE_OVERLAY
7224 * @see #SCROLLBARS_OUTSIDE_INSET
7225 */
7226 public int getScrollBarStyle() {
7227 return mViewFlags & SCROLLBARS_STYLE_MASK;
7228 }
7229
7230 /**
7231 * <p>Compute the horizontal range that the horizontal scrollbar
7232 * represents.</p>
7233 *
7234 * <p>The range is expressed in arbitrary units that must be the same as the
7235 * units used by {@link #computeHorizontalScrollExtent()} and
7236 * {@link #computeHorizontalScrollOffset()}.</p>
7237 *
7238 * <p>The default range is the drawing width of this view.</p>
7239 *
7240 * @return the total horizontal range represented by the horizontal
7241 * scrollbar
7242 *
7243 * @see #computeHorizontalScrollExtent()
7244 * @see #computeHorizontalScrollOffset()
7245 * @see android.widget.ScrollBarDrawable
7246 */
7247 protected int computeHorizontalScrollRange() {
7248 return getWidth();
7249 }
7250
7251 /**
7252 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
7253 * within the horizontal range. This value is used to compute the position
7254 * of the thumb within the scrollbar's track.</p>
7255 *
7256 * <p>The range is expressed in arbitrary units that must be the same as the
7257 * units used by {@link #computeHorizontalScrollRange()} and
7258 * {@link #computeHorizontalScrollExtent()}.</p>
7259 *
7260 * <p>The default offset is the scroll offset of this view.</p>
7261 *
7262 * @return the horizontal offset of the scrollbar's thumb
7263 *
7264 * @see #computeHorizontalScrollRange()
7265 * @see #computeHorizontalScrollExtent()
7266 * @see android.widget.ScrollBarDrawable
7267 */
7268 protected int computeHorizontalScrollOffset() {
7269 return mScrollX;
7270 }
7271
7272 /**
7273 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
7274 * within the horizontal range. This value is used to compute the length
7275 * of the thumb within the scrollbar's track.</p>
7276 *
7277 * <p>The range is expressed in arbitrary units that must be the same as the
7278 * units used by {@link #computeHorizontalScrollRange()} and
7279 * {@link #computeHorizontalScrollOffset()}.</p>
7280 *
7281 * <p>The default extent is the drawing width of this view.</p>
7282 *
7283 * @return the horizontal extent of the scrollbar's thumb
7284 *
7285 * @see #computeHorizontalScrollRange()
7286 * @see #computeHorizontalScrollOffset()
7287 * @see android.widget.ScrollBarDrawable
7288 */
7289 protected int computeHorizontalScrollExtent() {
7290 return getWidth();
7291 }
7292
7293 /**
7294 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
7295 *
7296 * <p>The range is expressed in arbitrary units that must be the same as the
7297 * units used by {@link #computeVerticalScrollExtent()} and
7298 * {@link #computeVerticalScrollOffset()}.</p>
7299 *
7300 * @return the total vertical range represented by the vertical scrollbar
7301 *
7302 * <p>The default range is the drawing height of this view.</p>
7303 *
7304 * @see #computeVerticalScrollExtent()
7305 * @see #computeVerticalScrollOffset()
7306 * @see android.widget.ScrollBarDrawable
7307 */
7308 protected int computeVerticalScrollRange() {
7309 return getHeight();
7310 }
7311
7312 /**
7313 * <p>Compute the vertical offset of the vertical scrollbar's thumb
7314 * within the horizontal range. This value is used to compute the position
7315 * of the thumb within the scrollbar's track.</p>
7316 *
7317 * <p>The range is expressed in arbitrary units that must be the same as the
7318 * units used by {@link #computeVerticalScrollRange()} and
7319 * {@link #computeVerticalScrollExtent()}.</p>
7320 *
7321 * <p>The default offset is the scroll offset of this view.</p>
7322 *
7323 * @return the vertical offset of the scrollbar's thumb
7324 *
7325 * @see #computeVerticalScrollRange()
7326 * @see #computeVerticalScrollExtent()
7327 * @see android.widget.ScrollBarDrawable
7328 */
7329 protected int computeVerticalScrollOffset() {
7330 return mScrollY;
7331 }
7332
7333 /**
7334 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
7335 * within the vertical range. This value is used to compute the length
7336 * of the thumb within the scrollbar's track.</p>
7337 *
7338 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -08007339 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007340 * {@link #computeVerticalScrollOffset()}.</p>
7341 *
7342 * <p>The default extent is the drawing height of this view.</p>
7343 *
7344 * @return the vertical extent of the scrollbar's thumb
7345 *
7346 * @see #computeVerticalScrollRange()
7347 * @see #computeVerticalScrollOffset()
7348 * @see android.widget.ScrollBarDrawable
7349 */
7350 protected int computeVerticalScrollExtent() {
7351 return getHeight();
7352 }
7353
7354 /**
7355 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
7356 * scrollbars are painted only if they have been awakened first.</p>
7357 *
7358 * @param canvas the canvas on which to draw the scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -07007359 *
7360 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007361 */
Romain Guy1d5b3a62009-11-05 18:44:12 -08007362 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007363 // scrollbars are drawn only when the animation is running
7364 final ScrollabilityCache cache = mScrollCache;
7365 if (cache != null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07007366
7367 int state = cache.state;
7368
7369 if (state == ScrollabilityCache.OFF) {
7370 return;
7371 }
7372
7373 boolean invalidate = false;
7374
7375 if (state == ScrollabilityCache.FADING) {
7376 // We're fading -- get our fade interpolation
7377 if (cache.interpolatorValues == null) {
7378 cache.interpolatorValues = new float[1];
7379 }
7380
7381 float[] values = cache.interpolatorValues;
7382
7383 // Stops the animation if we're done
7384 if (cache.scrollBarInterpolator.timeToValues(values) ==
7385 Interpolator.Result.FREEZE_END) {
7386 cache.state = ScrollabilityCache.OFF;
7387 } else {
7388 cache.scrollBar.setAlpha(Math.round(values[0]));
7389 }
7390
7391 // This will make the scroll bars inval themselves after
7392 // drawing. We only want this when we're fading so that
7393 // we prevent excessive redraws
7394 invalidate = true;
7395 } else {
7396 // We're just on -- but we may have been fading before so
7397 // reset alpha
7398 cache.scrollBar.setAlpha(255);
7399 }
7400
7401
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007402 final int viewFlags = mViewFlags;
7403
7404 final boolean drawHorizontalScrollBar =
7405 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
7406 final boolean drawVerticalScrollBar =
7407 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
7408 && !isVerticalScrollBarHidden();
7409
7410 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
7411 final int width = mRight - mLeft;
7412 final int height = mBottom - mTop;
7413
7414 final ScrollBarDrawable scrollBar = cache.scrollBar;
7415 int size = scrollBar.getSize(false);
7416 if (size <= 0) {
7417 size = cache.scrollBarSize;
7418 }
7419
Mike Reede8853fc2009-09-04 14:01:48 -04007420 final int scrollX = mScrollX;
7421 final int scrollY = mScrollY;
7422 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
7423
Mike Cleronf116bf82009-09-27 19:14:12 -07007424 int left, top, right, bottom;
7425
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007426 if (drawHorizontalScrollBar) {
Mike Cleronf116bf82009-09-27 19:14:12 -07007427 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -04007428 computeHorizontalScrollOffset(),
7429 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -04007430 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -07007431 getVerticalScrollbarWidth() : 0;
7432 top = scrollY + height - size - (mUserPaddingBottom & inside);
7433 left = scrollX + (mPaddingLeft & inside);
7434 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
7435 bottom = top + size;
7436 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
7437 if (invalidate) {
7438 invalidate(left, top, right, bottom);
7439 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007440 }
7441
7442 if (drawVerticalScrollBar) {
Mike Reede8853fc2009-09-04 14:01:48 -04007443 scrollBar.setParameters(computeVerticalScrollRange(),
7444 computeVerticalScrollOffset(),
7445 computeVerticalScrollExtent(), true);
Adam Powell20232d02010-12-08 21:08:53 -08007446 switch (mVerticalScrollbarPosition) {
7447 default:
7448 case SCROLLBAR_POSITION_DEFAULT:
7449 case SCROLLBAR_POSITION_RIGHT:
7450 left = scrollX + width - size - (mUserPaddingRight & inside);
7451 break;
7452 case SCROLLBAR_POSITION_LEFT:
7453 left = scrollX + (mUserPaddingLeft & inside);
7454 break;
7455 }
Mike Cleronf116bf82009-09-27 19:14:12 -07007456 top = scrollY + (mPaddingTop & inside);
7457 right = left + size;
7458 bottom = scrollY + height - (mUserPaddingBottom & inside);
7459 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
7460 if (invalidate) {
7461 invalidate(left, top, right, bottom);
7462 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007463 }
7464 }
7465 }
7466 }
Romain Guy8506ab42009-06-11 17:35:47 -07007467
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007468 /**
Romain Guy8506ab42009-06-11 17:35:47 -07007469 * 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 -08007470 * FastScroller is visible.
7471 * @return whether to temporarily hide the vertical scrollbar
7472 * @hide
7473 */
7474 protected boolean isVerticalScrollBarHidden() {
7475 return false;
7476 }
7477
7478 /**
7479 * <p>Draw the horizontal scrollbar if
7480 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
7481 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007482 * @param canvas the canvas on which to draw the scrollbar
7483 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007484 *
7485 * @see #isHorizontalScrollBarEnabled()
7486 * @see #computeHorizontalScrollRange()
7487 * @see #computeHorizontalScrollExtent()
7488 * @see #computeHorizontalScrollOffset()
7489 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -07007490 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007491 */
Romain Guy8fb95422010-08-17 18:38:51 -07007492 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
7493 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007494 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007495 scrollBar.draw(canvas);
7496 }
Mike Reede8853fc2009-09-04 14:01:48 -04007497
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007498 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007499 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
7500 * returns true.</p>
7501 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007502 * @param canvas the canvas on which to draw the scrollbar
7503 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007504 *
7505 * @see #isVerticalScrollBarEnabled()
7506 * @see #computeVerticalScrollRange()
7507 * @see #computeVerticalScrollExtent()
7508 * @see #computeVerticalScrollOffset()
7509 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -04007510 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007511 */
Romain Guy8fb95422010-08-17 18:38:51 -07007512 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
7513 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -04007514 scrollBar.setBounds(l, t, r, b);
7515 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007516 }
7517
7518 /**
7519 * Implement this to do your drawing.
7520 *
7521 * @param canvas the canvas on which the background will be drawn
7522 */
7523 protected void onDraw(Canvas canvas) {
7524 }
7525
7526 /*
7527 * Caller is responsible for calling requestLayout if necessary.
7528 * (This allows addViewInLayout to not request a new layout.)
7529 */
7530 void assignParent(ViewParent parent) {
7531 if (mParent == null) {
7532 mParent = parent;
7533 } else if (parent == null) {
7534 mParent = null;
7535 } else {
7536 throw new RuntimeException("view " + this + " being added, but"
7537 + " it already has a parent");
7538 }
7539 }
7540
7541 /**
7542 * This is called when the view is attached to a window. At this point it
7543 * has a Surface and will start drawing. Note that this function is
7544 * guaranteed to be called before {@link #onDraw}, however it may be called
7545 * any time before the first onDraw -- including before or after
7546 * {@link #onMeasure}.
7547 *
7548 * @see #onDetachedFromWindow()
7549 */
7550 protected void onAttachedToWindow() {
7551 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
7552 mParent.requestTransparentRegion(this);
7553 }
Adam Powell8568c3a2010-04-19 14:26:11 -07007554 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
7555 initialAwakenScrollBars();
7556 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
7557 }
Chet Haasea9b61ac2010-12-20 07:40:25 -08007558 jumpDrawablesToCurrentState();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007559 }
7560
7561 /**
7562 * This is called when the view is detached from a window. At this point it
7563 * no longer has a surface for drawing.
7564 *
7565 * @see #onAttachedToWindow()
7566 */
7567 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -08007568 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -08007569
Romain Guya440b002010-02-24 15:57:54 -08007570 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -05007571 removeLongPressCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -08007572
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007573 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -08007574
7575 if (mHardwareLayer != null) {
7576 mHardwareLayer.destroy();
7577 mHardwareLayer = null;
7578 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007579 }
7580
7581 /**
7582 * @return The number of times this view has been attached to a window
7583 */
7584 protected int getWindowAttachCount() {
7585 return mWindowAttachCount;
7586 }
7587
7588 /**
7589 * Retrieve a unique token identifying the window this view is attached to.
7590 * @return Return the window's token for use in
7591 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
7592 */
7593 public IBinder getWindowToken() {
7594 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
7595 }
7596
7597 /**
7598 * Retrieve a unique token identifying the top-level "real" window of
7599 * the window that this view is attached to. That is, this is like
7600 * {@link #getWindowToken}, except if the window this view in is a panel
7601 * window (attached to another containing window), then the token of
7602 * the containing window is returned instead.
7603 *
7604 * @return Returns the associated window token, either
7605 * {@link #getWindowToken()} or the containing window's token.
7606 */
7607 public IBinder getApplicationWindowToken() {
7608 AttachInfo ai = mAttachInfo;
7609 if (ai != null) {
7610 IBinder appWindowToken = ai.mPanelParentWindowToken;
7611 if (appWindowToken == null) {
7612 appWindowToken = ai.mWindowToken;
7613 }
7614 return appWindowToken;
7615 }
7616 return null;
7617 }
7618
7619 /**
7620 * Retrieve private session object this view hierarchy is using to
7621 * communicate with the window manager.
7622 * @return the session object to communicate with the window manager
7623 */
7624 /*package*/ IWindowSession getWindowSession() {
7625 return mAttachInfo != null ? mAttachInfo.mSession : null;
7626 }
7627
7628 /**
7629 * @param info the {@link android.view.View.AttachInfo} to associated with
7630 * this view
7631 */
7632 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
7633 //System.out.println("Attached! " + this);
7634 mAttachInfo = info;
7635 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08007636 // We will need to evaluate the drawable state at least once.
7637 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007638 if (mFloatingTreeObserver != null) {
7639 info.mTreeObserver.merge(mFloatingTreeObserver);
7640 mFloatingTreeObserver = null;
7641 }
7642 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
7643 mAttachInfo.mScrollContainers.add(this);
7644 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
7645 }
7646 performCollectViewAttributes(visibility);
7647 onAttachedToWindow();
7648 int vis = info.mWindowVisibility;
7649 if (vis != GONE) {
7650 onWindowVisibilityChanged(vis);
7651 }
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08007652 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) {
7653 // If nobody has evaluated the drawable state yet, then do it now.
7654 refreshDrawableState();
7655 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007656 }
7657
7658 void dispatchDetachedFromWindow() {
7659 //System.out.println("Detached! " + this);
7660 AttachInfo info = mAttachInfo;
7661 if (info != null) {
7662 int vis = info.mWindowVisibility;
7663 if (vis != GONE) {
7664 onWindowVisibilityChanged(GONE);
7665 }
7666 }
7667
7668 onDetachedFromWindow();
7669 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
7670 mAttachInfo.mScrollContainers.remove(this);
7671 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
7672 }
7673 mAttachInfo = null;
7674 }
7675
7676 /**
7677 * Store this view hierarchy's frozen state into the given container.
7678 *
7679 * @param container The SparseArray in which to save the view's state.
7680 *
7681 * @see #restoreHierarchyState
7682 * @see #dispatchSaveInstanceState
7683 * @see #onSaveInstanceState
7684 */
7685 public void saveHierarchyState(SparseArray<Parcelable> container) {
7686 dispatchSaveInstanceState(container);
7687 }
7688
7689 /**
7690 * Called by {@link #saveHierarchyState} to store the state for this view and its children.
7691 * May be overridden to modify how freezing happens to a view's children; for example, some
7692 * views may want to not store state for their children.
7693 *
7694 * @param container The SparseArray in which to save the view's state.
7695 *
7696 * @see #dispatchRestoreInstanceState
7697 * @see #saveHierarchyState
7698 * @see #onSaveInstanceState
7699 */
7700 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
7701 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
7702 mPrivateFlags &= ~SAVE_STATE_CALLED;
7703 Parcelable state = onSaveInstanceState();
7704 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
7705 throw new IllegalStateException(
7706 "Derived class did not call super.onSaveInstanceState()");
7707 }
7708 if (state != null) {
7709 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
7710 // + ": " + state);
7711 container.put(mID, state);
7712 }
7713 }
7714 }
7715
7716 /**
7717 * Hook allowing a view to generate a representation of its internal state
7718 * that can later be used to create a new instance with that same state.
7719 * This state should only contain information that is not persistent or can
7720 * not be reconstructed later. For example, you will never store your
7721 * current position on screen because that will be computed again when a
7722 * new instance of the view is placed in its view hierarchy.
7723 * <p>
7724 * Some examples of things you may store here: the current cursor position
7725 * in a text view (but usually not the text itself since that is stored in a
7726 * content provider or other persistent storage), the currently selected
7727 * item in a list view.
7728 *
7729 * @return Returns a Parcelable object containing the view's current dynamic
7730 * state, or null if there is nothing interesting to save. The
7731 * default implementation returns null.
7732 * @see #onRestoreInstanceState
7733 * @see #saveHierarchyState
7734 * @see #dispatchSaveInstanceState
7735 * @see #setSaveEnabled(boolean)
7736 */
7737 protected Parcelable onSaveInstanceState() {
7738 mPrivateFlags |= SAVE_STATE_CALLED;
7739 return BaseSavedState.EMPTY_STATE;
7740 }
7741
7742 /**
7743 * Restore this view hierarchy's frozen state from the given container.
7744 *
7745 * @param container The SparseArray which holds previously frozen states.
7746 *
7747 * @see #saveHierarchyState
7748 * @see #dispatchRestoreInstanceState
7749 * @see #onRestoreInstanceState
7750 */
7751 public void restoreHierarchyState(SparseArray<Parcelable> container) {
7752 dispatchRestoreInstanceState(container);
7753 }
7754
7755 /**
7756 * Called by {@link #restoreHierarchyState} to retrieve the state for this view and its
7757 * children. May be overridden to modify how restoreing happens to a view's children; for
7758 * example, some views may want to not store state for their children.
7759 *
7760 * @param container The SparseArray which holds previously saved state.
7761 *
7762 * @see #dispatchSaveInstanceState
7763 * @see #restoreHierarchyState
7764 * @see #onRestoreInstanceState
7765 */
7766 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
7767 if (mID != NO_ID) {
7768 Parcelable state = container.get(mID);
7769 if (state != null) {
7770 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
7771 // + ": " + state);
7772 mPrivateFlags &= ~SAVE_STATE_CALLED;
7773 onRestoreInstanceState(state);
7774 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
7775 throw new IllegalStateException(
7776 "Derived class did not call super.onRestoreInstanceState()");
7777 }
7778 }
7779 }
7780 }
7781
7782 /**
7783 * Hook allowing a view to re-apply a representation of its internal state that had previously
7784 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
7785 * null state.
7786 *
7787 * @param state The frozen state that had previously been returned by
7788 * {@link #onSaveInstanceState}.
7789 *
7790 * @see #onSaveInstanceState
7791 * @see #restoreHierarchyState
7792 * @see #dispatchRestoreInstanceState
7793 */
7794 protected void onRestoreInstanceState(Parcelable state) {
7795 mPrivateFlags |= SAVE_STATE_CALLED;
7796 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -08007797 throw new IllegalArgumentException("Wrong state class, expecting View State but "
7798 + "received " + state.getClass().toString() + " instead. This usually happens "
7799 + "when two views of different type have the same id in the same hierarchy. "
7800 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
7801 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007802 }
7803 }
7804
7805 /**
7806 * <p>Return the time at which the drawing of the view hierarchy started.</p>
7807 *
7808 * @return the drawing start time in milliseconds
7809 */
7810 public long getDrawingTime() {
7811 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
7812 }
7813
7814 /**
7815 * <p>Enables or disables the duplication of the parent's state into this view. When
7816 * duplication is enabled, this view gets its drawable state from its parent rather
7817 * than from its own internal properties.</p>
7818 *
7819 * <p>Note: in the current implementation, setting this property to true after the
7820 * view was added to a ViewGroup might have no effect at all. This property should
7821 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
7822 *
7823 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
7824 * property is enabled, an exception will be thrown.</p>
7825 *
7826 * @param enabled True to enable duplication of the parent's drawable state, false
7827 * to disable it.
7828 *
7829 * @see #getDrawableState()
7830 * @see #isDuplicateParentStateEnabled()
7831 */
7832 public void setDuplicateParentStateEnabled(boolean enabled) {
7833 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
7834 }
7835
7836 /**
7837 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
7838 *
7839 * @return True if this view's drawable state is duplicated from the parent,
7840 * false otherwise
7841 *
7842 * @see #getDrawableState()
7843 * @see #setDuplicateParentStateEnabled(boolean)
7844 */
7845 public boolean isDuplicateParentStateEnabled() {
7846 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
7847 }
7848
7849 /**
Romain Guy171c5922011-01-06 10:04:23 -08007850 * <p>Specifies the type of layer backing this view. The layer can be
7851 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
7852 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
7853 *
7854 * <p>A layer is associated with an optional {@link android.graphics.Paint}
7855 * instance that controls how the layer is composed on screen. The following
7856 * properties of the paint are taken into account when composing the layer:</p>
7857 * <ul>
7858 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
7859 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
7860 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
7861 * </ul>
7862 *
7863 * <p>If this view has an alpha value set to < 1.0 by calling
7864 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
7865 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
7866 * equivalent to setting a hardware layer on this view and providing a paint with
7867 * the desired alpha value.<p>
7868 *
7869 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
7870 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
7871 * for more information on when and how to use layers.</p>
7872 *
7873 * @param layerType The ype of layer to use with this view, must be one of
7874 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
7875 * {@link #LAYER_TYPE_HARDWARE}
7876 * @param paint The paint used to compose the layer. This argument is optional
7877 * and can be null. It is ignored when the layer type is
7878 * {@link #LAYER_TYPE_NONE}
7879 *
7880 * @see #getLayerType()
7881 * @see #LAYER_TYPE_NONE
7882 * @see #LAYER_TYPE_SOFTWARE
7883 * @see #LAYER_TYPE_HARDWARE
7884 * @see #setAlpha(float)
7885 *
7886 * @attr ref android.R.styleable#View_layerType
7887 */
7888 public void setLayerType(int layerType, Paint paint) {
7889 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
7890 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
7891 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
7892 }
Romain Guy6c319ca2011-01-11 14:29:25 -08007893
7894 if (layerType == mLayerType) return;
Romain Guy171c5922011-01-06 10:04:23 -08007895
7896 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -08007897 switch (mLayerType) {
7898 case LAYER_TYPE_SOFTWARE:
7899 if (mDrawingCache != null) {
7900 mDrawingCache.recycle();
7901 mDrawingCache = null;
7902 }
7903
7904 if (mUnscaledDrawingCache != null) {
7905 mUnscaledDrawingCache.recycle();
7906 mUnscaledDrawingCache = null;
7907 }
7908 break;
7909 case LAYER_TYPE_HARDWARE:
7910 if (mHardwareLayer != null) {
7911 mHardwareLayer.destroy();
7912 mHardwareLayer = null;
7913 }
7914 break;
7915 default:
7916 break;
Romain Guy171c5922011-01-06 10:04:23 -08007917 }
7918
7919 mLayerType = layerType;
7920 mLayerPaint = mLayerType == LAYER_TYPE_NONE ? null : paint;
7921
Romain Guy6c319ca2011-01-11 14:29:25 -08007922 // TODO: Make sure we invalidate the parent's display list
Romain Guy171c5922011-01-06 10:04:23 -08007923 invalidate();
7924 }
7925
7926 /**
7927 * Indicates what type of layer is currently associated with this view. By default
7928 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
7929 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
7930 * for more information on the different types of layers.
7931 *
7932 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
7933 * {@link #LAYER_TYPE_HARDWARE}
7934 *
7935 * @see #setLayerType(int, android.graphics.Paint)
7936 * @see #LAYER_TYPE_NONE
7937 * @see #LAYER_TYPE_SOFTWARE
7938 * @see #LAYER_TYPE_HARDWARE
7939 */
7940 public int getLayerType() {
7941 return mLayerType;
7942 }
Romain Guy6c319ca2011-01-11 14:29:25 -08007943
7944 /**
7945 * <p>Returns a hardware layer that can be used to draw this view again
7946 * without executing its draw method.</p>
7947 *
7948 * @return A HardwareLayer ready to render, or null if an error occurred.
7949 */
7950 HardwareLayer getHardwareLayer(Canvas currentCanvas) {
7951 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) {
7952 return null;
7953 }
7954
7955 final int width = mRight - mLeft;
7956 final int height = mBottom - mTop;
7957
7958 if (width == 0 || height == 0) {
7959 return null;
7960 }
7961
7962 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
7963 if (mHardwareLayer == null) {
7964 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
7965 width, height, isOpaque());
7966 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
7967 mHardwareLayer.resize(width, height);
7968 }
7969
7970 final HardwareCanvas canvas = mHardwareLayer.start(currentCanvas);
7971 try {
7972 canvas.setViewport(width, height);
7973 canvas.onPreDraw();
7974
7975 computeScroll();
7976 canvas.translate(-mScrollX, -mScrollY);
7977
7978 final int restoreCount = canvas.save();
7979
7980 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
7981
7982 // Fast path for layouts with no backgrounds
7983 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
7984 mPrivateFlags &= ~DIRTY_MASK;
7985 dispatchDraw(canvas);
7986 } else {
7987 draw(canvas);
7988 }
7989
7990 canvas.restoreToCount(restoreCount);
7991 } finally {
7992 canvas.onPostDraw();
7993 mHardwareLayer.end(currentCanvas);
7994 }
7995 }
7996
7997 return mHardwareLayer;
7998 }
Romain Guy171c5922011-01-06 10:04:23 -08007999
8000 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008001 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
8002 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
8003 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
8004 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
8005 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
8006 * null.</p>
Romain Guy171c5922011-01-06 10:04:23 -08008007 *
8008 * <p>Enabling the drawing cache is similar to
8009 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
8010 * acceleration is turned off. When hardware acceleration is turned on enabling the
8011 * drawing cache has either no effect or the cache used at drawing time is not a bitmap.
8012 * This API can however be used to manually generate a bitmap copy of this view.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008013 *
8014 * @param enabled true to enable the drawing cache, false otherwise
8015 *
8016 * @see #isDrawingCacheEnabled()
8017 * @see #getDrawingCache()
8018 * @see #buildDrawingCache()
Romain Guy171c5922011-01-06 10:04:23 -08008019 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008020 */
8021 public void setDrawingCacheEnabled(boolean enabled) {
8022 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
8023 }
8024
8025 /**
8026 * <p>Indicates whether the drawing cache is enabled for this view.</p>
8027 *
8028 * @return true if the drawing cache is enabled
8029 *
8030 * @see #setDrawingCacheEnabled(boolean)
8031 * @see #getDrawingCache()
8032 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008033 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008034 public boolean isDrawingCacheEnabled() {
8035 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
8036 }
8037
8038 /**
Romain Guyb051e892010-09-28 19:09:36 -07008039 * <p>Returns a display list that can be used to draw this view again
8040 * without executing its draw method.</p>
8041 *
8042 * @return A DisplayList ready to replay, or null if caching is not enabled.
8043 */
8044 DisplayList getDisplayList() {
8045 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
8046 return null;
8047 }
Romain Guyb051e892010-09-28 19:09:36 -07008048 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) {
8049 return null;
8050 }
8051
8052 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED &&
Chet Haase9e90a992011-01-04 16:23:21 -08008053 ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 ||
8054 mDisplayList == null || !mDisplayList.isValid())) {
Romain Guyb051e892010-09-28 19:09:36 -07008055
Chet Haase9e90a992011-01-04 16:23:21 -08008056 if (mDisplayList == null) {
8057 mDisplayList = mAttachInfo.mHardwareRenderer.createDisplayList();
8058 }
Romain Guyb051e892010-09-28 19:09:36 -07008059
8060 final HardwareCanvas canvas = mDisplayList.start();
8061 try {
8062 int width = mRight - mLeft;
8063 int height = mBottom - mTop;
8064
8065 canvas.setViewport(width, height);
8066 canvas.onPreDraw();
8067
8068 final int restoreCount = canvas.save();
8069
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008070 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
Romain Guyb051e892010-09-28 19:09:36 -07008071
8072 // Fast path for layouts with no backgrounds
8073 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8074 mPrivateFlags &= ~DIRTY_MASK;
8075 dispatchDraw(canvas);
8076 } else {
8077 draw(canvas);
8078 }
8079
8080 canvas.restoreToCount(restoreCount);
8081 } finally {
8082 canvas.onPostDraw();
8083
8084 mDisplayList.end();
Romain Guyb051e892010-09-28 19:09:36 -07008085 }
8086 }
8087
8088 return mDisplayList;
8089 }
8090
8091 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07008092 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
8093 *
8094 * @return A non-scaled bitmap representing this view or null if cache is disabled.
8095 *
8096 * @see #getDrawingCache(boolean)
8097 */
8098 public Bitmap getDrawingCache() {
8099 return getDrawingCache(false);
8100 }
8101
8102 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008103 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
8104 * is null when caching is disabled. If caching is enabled and the cache is not ready,
8105 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
8106 * draw from the cache when the cache is enabled. To benefit from the cache, you must
8107 * request the drawing cache by calling this method and draw it on screen if the
8108 * returned bitmap is not null.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07008109 *
8110 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
8111 * this method will create a bitmap of the same size as this view. Because this bitmap
8112 * will be drawn scaled by the parent ViewGroup, the result on screen might show
8113 * scaling artifacts. To avoid such artifacts, you should call this method by setting
8114 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
8115 * size than the view. This implies that your application must be able to handle this
8116 * size.</p>
8117 *
8118 * @param autoScale Indicates whether the generated bitmap should be scaled based on
8119 * the current density of the screen when the application is in compatibility
8120 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008121 *
Romain Guyfbd8f692009-06-26 14:51:58 -07008122 * @return A bitmap representing this view or null if cache is disabled.
8123 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008124 * @see #setDrawingCacheEnabled(boolean)
8125 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -07008126 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008127 * @see #destroyDrawingCache()
8128 */
Romain Guyfbd8f692009-06-26 14:51:58 -07008129 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008130 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
8131 return null;
8132 }
8133 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008134 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008135 }
Romain Guy02890fd2010-08-06 17:58:44 -07008136 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008137 }
8138
8139 /**
8140 * <p>Frees the resources used by the drawing cache. If you call
8141 * {@link #buildDrawingCache()} manually without calling
8142 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
8143 * should cleanup the cache with this method afterwards.</p>
8144 *
8145 * @see #setDrawingCacheEnabled(boolean)
8146 * @see #buildDrawingCache()
8147 * @see #getDrawingCache()
8148 */
8149 public void destroyDrawingCache() {
8150 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07008151 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008152 mDrawingCache = null;
8153 }
Romain Guyfbd8f692009-06-26 14:51:58 -07008154 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07008155 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -07008156 mUnscaledDrawingCache = null;
8157 }
Romain Guyb051e892010-09-28 19:09:36 -07008158 if (mDisplayList != null) {
Chet Haase9e90a992011-01-04 16:23:21 -08008159 mDisplayList.invalidate();
Romain Guyb051e892010-09-28 19:09:36 -07008160 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008161 }
8162
8163 /**
8164 * Setting a solid background color for the drawing cache's bitmaps will improve
8165 * perfromance and memory usage. Note, though that this should only be used if this
8166 * view will always be drawn on top of a solid color.
8167 *
8168 * @param color The background color to use for the drawing cache's bitmap
8169 *
8170 * @see #setDrawingCacheEnabled(boolean)
8171 * @see #buildDrawingCache()
8172 * @see #getDrawingCache()
8173 */
8174 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -08008175 if (color != mDrawingCacheBackgroundColor) {
8176 mDrawingCacheBackgroundColor = color;
8177 mPrivateFlags &= ~DRAWING_CACHE_VALID;
8178 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008179 }
8180
8181 /**
8182 * @see #setDrawingCacheBackgroundColor(int)
8183 *
8184 * @return The background color to used for the drawing cache's bitmap
8185 */
8186 public int getDrawingCacheBackgroundColor() {
8187 return mDrawingCacheBackgroundColor;
8188 }
8189
8190 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07008191 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
8192 *
8193 * @see #buildDrawingCache(boolean)
8194 */
8195 public void buildDrawingCache() {
8196 buildDrawingCache(false);
8197 }
8198
8199 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008200 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
8201 *
8202 * <p>If you call {@link #buildDrawingCache()} manually without calling
8203 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
8204 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07008205 *
8206 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
8207 * this method will create a bitmap of the same size as this view. Because this bitmap
8208 * will be drawn scaled by the parent ViewGroup, the result on screen might show
8209 * scaling artifacts. To avoid such artifacts, you should call this method by setting
8210 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
8211 * size than the view. This implies that your application must be able to handle this
8212 * size.</p>
Romain Guy0d9275e2010-10-26 14:22:30 -07008213 *
8214 * <p>You should avoid calling this method when hardware acceleration is enabled. If
8215 * you do not need the drawing cache bitmap, calling this method will increase memory
8216 * usage and cause the view to be rendered in software once, thus negatively impacting
8217 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008218 *
8219 * @see #getDrawingCache()
8220 * @see #destroyDrawingCache()
8221 */
Romain Guyfbd8f692009-06-26 14:51:58 -07008222 public void buildDrawingCache(boolean autoScale) {
8223 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -07008224 mDrawingCache == null : mUnscaledDrawingCache == null)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008225
8226 if (ViewDebug.TRACE_HIERARCHY) {
8227 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
8228 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008229
Romain Guy8506ab42009-06-11 17:35:47 -07008230 int width = mRight - mLeft;
8231 int height = mBottom - mTop;
8232
8233 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -07008234 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -07008235
Romain Guye1123222009-06-29 14:24:56 -07008236 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008237 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
8238 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -07008239 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008240
8241 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -07008242 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -08008243 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008244
8245 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -07008246 // Projected bitmap size in bytes
Adam Powell26153a32010-11-08 15:22:27 -08008247 (width * height * (opaque && !use32BitCache ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008248 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
8249 destroyDrawingCache();
8250 return;
8251 }
8252
8253 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -07008254 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008255
8256 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008257 Bitmap.Config quality;
8258 if (!opaque) {
8259 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
8260 case DRAWING_CACHE_QUALITY_AUTO:
8261 quality = Bitmap.Config.ARGB_8888;
8262 break;
8263 case DRAWING_CACHE_QUALITY_LOW:
8264 quality = Bitmap.Config.ARGB_4444;
8265 break;
8266 case DRAWING_CACHE_QUALITY_HIGH:
8267 quality = Bitmap.Config.ARGB_8888;
8268 break;
8269 default:
8270 quality = Bitmap.Config.ARGB_8888;
8271 break;
8272 }
8273 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -07008274 // Optimization for translucent windows
8275 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -08008276 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008277 }
8278
8279 // Try to cleanup memory
8280 if (bitmap != null) bitmap.recycle();
8281
8282 try {
8283 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -07008284 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -07008285 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -07008286 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07008287 } else {
Romain Guy02890fd2010-08-06 17:58:44 -07008288 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07008289 }
Adam Powell26153a32010-11-08 15:22:27 -08008290 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008291 } catch (OutOfMemoryError e) {
8292 // If there is not enough memory to create the bitmap cache, just
8293 // ignore the issue as bitmap caches are not required to draw the
8294 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -07008295 if (autoScale) {
8296 mDrawingCache = null;
8297 } else {
8298 mUnscaledDrawingCache = null;
8299 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008300 return;
8301 }
8302
8303 clear = drawingCacheBackgroundColor != 0;
8304 }
8305
8306 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008307 if (attachInfo != null) {
8308 canvas = attachInfo.mCanvas;
8309 if (canvas == null) {
8310 canvas = new Canvas();
8311 }
8312 canvas.setBitmap(bitmap);
8313 // Temporarily clobber the cached Canvas in case one of our children
8314 // is also using a drawing cache. Without this, the children would
8315 // steal the canvas by attaching their own bitmap to it and bad, bad
8316 // thing would happen (invisible views, corrupted drawings, etc.)
8317 attachInfo.mCanvas = null;
8318 } else {
8319 // This case should hopefully never or seldom happen
8320 canvas = new Canvas(bitmap);
8321 }
8322
8323 if (clear) {
8324 bitmap.eraseColor(drawingCacheBackgroundColor);
8325 }
8326
8327 computeScroll();
8328 final int restoreCount = canvas.save();
Romain Guyfbd8f692009-06-26 14:51:58 -07008329
Romain Guye1123222009-06-29 14:24:56 -07008330 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008331 final float scale = attachInfo.mApplicationScale;
8332 canvas.scale(scale, scale);
8333 }
8334
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008335 canvas.translate(-mScrollX, -mScrollY);
8336
Romain Guy5bcdff42009-05-14 21:27:18 -07008337 mPrivateFlags |= DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -08008338 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
8339 mLayerType != LAYER_TYPE_NONE) {
Romain Guy0d9275e2010-10-26 14:22:30 -07008340 mPrivateFlags |= DRAWING_CACHE_VALID;
8341 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008342
8343 // Fast path for layouts with no backgrounds
8344 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8345 if (ViewDebug.TRACE_HIERARCHY) {
8346 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
8347 }
Romain Guy5bcdff42009-05-14 21:27:18 -07008348 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008349 dispatchDraw(canvas);
8350 } else {
8351 draw(canvas);
8352 }
8353
8354 canvas.restoreToCount(restoreCount);
8355
8356 if (attachInfo != null) {
8357 // Restore the cached Canvas for our siblings
8358 attachInfo.mCanvas = canvas;
8359 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008360 }
8361 }
8362
8363 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008364 * Create a snapshot of the view into a bitmap. We should probably make
8365 * some form of this public, but should think about the API.
8366 */
Romain Guy223ff5c2010-03-02 17:07:47 -08008367 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008368 int width = mRight - mLeft;
8369 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008370
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008371 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -07008372 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008373 width = (int) ((width * scale) + 0.5f);
8374 height = (int) ((height * scale) + 0.5f);
8375
Romain Guy8c11e312009-09-14 15:15:30 -07008376 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008377 if (bitmap == null) {
8378 throw new OutOfMemoryError();
8379 }
8380
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008381 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
8382
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008383 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008384 if (attachInfo != null) {
8385 canvas = attachInfo.mCanvas;
8386 if (canvas == null) {
8387 canvas = new Canvas();
8388 }
8389 canvas.setBitmap(bitmap);
8390 // Temporarily clobber the cached Canvas in case one of our children
8391 // is also using a drawing cache. Without this, the children would
8392 // steal the canvas by attaching their own bitmap to it and bad, bad
8393 // things would happen (invisible views, corrupted drawings, etc.)
8394 attachInfo.mCanvas = null;
8395 } else {
8396 // This case should hopefully never or seldom happen
8397 canvas = new Canvas(bitmap);
8398 }
8399
Romain Guy5bcdff42009-05-14 21:27:18 -07008400 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008401 bitmap.eraseColor(backgroundColor);
8402 }
8403
8404 computeScroll();
8405 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008406 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008407 canvas.translate(-mScrollX, -mScrollY);
8408
Romain Guy5bcdff42009-05-14 21:27:18 -07008409 // Temporarily remove the dirty mask
8410 int flags = mPrivateFlags;
8411 mPrivateFlags &= ~DIRTY_MASK;
8412
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008413 // Fast path for layouts with no backgrounds
8414 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8415 dispatchDraw(canvas);
8416 } else {
8417 draw(canvas);
8418 }
8419
Romain Guy5bcdff42009-05-14 21:27:18 -07008420 mPrivateFlags = flags;
8421
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008422 canvas.restoreToCount(restoreCount);
8423
8424 if (attachInfo != null) {
8425 // Restore the cached Canvas for our siblings
8426 attachInfo.mCanvas = canvas;
8427 }
Romain Guy8506ab42009-06-11 17:35:47 -07008428
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008429 return bitmap;
8430 }
8431
8432 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008433 * Indicates whether this View is currently in edit mode. A View is usually
8434 * in edit mode when displayed within a developer tool. For instance, if
8435 * this View is being drawn by a visual user interface builder, this method
8436 * should return true.
8437 *
8438 * Subclasses should check the return value of this method to provide
8439 * different behaviors if their normal behavior might interfere with the
8440 * host environment. For instance: the class spawns a thread in its
8441 * constructor, the drawing code relies on device-specific features, etc.
8442 *
8443 * This method is usually checked in the drawing code of custom widgets.
8444 *
8445 * @return True if this View is in edit mode, false otherwise.
8446 */
8447 public boolean isInEditMode() {
8448 return false;
8449 }
8450
8451 /**
8452 * If the View draws content inside its padding and enables fading edges,
8453 * it needs to support padding offsets. Padding offsets are added to the
8454 * fading edges to extend the length of the fade so that it covers pixels
8455 * drawn inside the padding.
8456 *
8457 * Subclasses of this class should override this method if they need
8458 * to draw content inside the padding.
8459 *
8460 * @return True if padding offset must be applied, false otherwise.
8461 *
8462 * @see #getLeftPaddingOffset()
8463 * @see #getRightPaddingOffset()
8464 * @see #getTopPaddingOffset()
8465 * @see #getBottomPaddingOffset()
8466 *
8467 * @since CURRENT
8468 */
8469 protected boolean isPaddingOffsetRequired() {
8470 return false;
8471 }
8472
8473 /**
8474 * Amount by which to extend the left fading region. Called only when
8475 * {@link #isPaddingOffsetRequired()} returns true.
8476 *
8477 * @return The left padding offset in pixels.
8478 *
8479 * @see #isPaddingOffsetRequired()
8480 *
8481 * @since CURRENT
8482 */
8483 protected int getLeftPaddingOffset() {
8484 return 0;
8485 }
8486
8487 /**
8488 * Amount by which to extend the right fading region. Called only when
8489 * {@link #isPaddingOffsetRequired()} returns true.
8490 *
8491 * @return The right padding offset in pixels.
8492 *
8493 * @see #isPaddingOffsetRequired()
8494 *
8495 * @since CURRENT
8496 */
8497 protected int getRightPaddingOffset() {
8498 return 0;
8499 }
8500
8501 /**
8502 * Amount by which to extend the top fading region. Called only when
8503 * {@link #isPaddingOffsetRequired()} returns true.
8504 *
8505 * @return The top padding offset in pixels.
8506 *
8507 * @see #isPaddingOffsetRequired()
8508 *
8509 * @since CURRENT
8510 */
8511 protected int getTopPaddingOffset() {
8512 return 0;
8513 }
8514
8515 /**
8516 * Amount by which to extend the bottom fading region. Called only when
8517 * {@link #isPaddingOffsetRequired()} returns true.
8518 *
8519 * @return The bottom padding offset in pixels.
8520 *
8521 * @see #isPaddingOffsetRequired()
8522 *
8523 * @since CURRENT
8524 */
8525 protected int getBottomPaddingOffset() {
8526 return 0;
8527 }
8528
8529 /**
Romain Guy2bffd262010-09-12 17:40:02 -07008530 * <p>Indicates whether this view is attached to an hardware accelerated
8531 * window or not.</p>
8532 *
8533 * <p>Even if this method returns true, it does not mean that every call
8534 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
8535 * accelerated {@link android.graphics.Canvas}. For instance, if this view
8536 * is drawn onto an offscren {@link android.graphics.Bitmap} and its
8537 * window is hardware accelerated,
8538 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
8539 * return false, and this method will return true.</p>
8540 *
8541 * @return True if the view is attached to a window and the window is
8542 * hardware accelerated; false in any other case.
8543 */
8544 public boolean isHardwareAccelerated() {
8545 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
8546 }
8547
8548 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008549 * Manually render this view (and all of its children) to the given Canvas.
8550 * The view must have already done a full layout before this function is
Chet Haasec75ec332010-12-17 07:44:30 -08008551 * called. When implementing a view, implement {@link #onDraw} instead of
8552 * overriding this method. If you do need to override this method, call
8553 * the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008554 *
8555 * @param canvas The Canvas to which the View is rendered.
8556 */
8557 public void draw(Canvas canvas) {
8558 if (ViewDebug.TRACE_HIERARCHY) {
8559 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
8560 }
8561
Romain Guy5bcdff42009-05-14 21:27:18 -07008562 final int privateFlags = mPrivateFlags;
8563 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
8564 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
8565 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -07008566
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008567 /*
8568 * Draw traversal performs several drawing steps which must be executed
8569 * in the appropriate order:
8570 *
8571 * 1. Draw the background
8572 * 2. If necessary, save the canvas' layers to prepare for fading
8573 * 3. Draw view's content
8574 * 4. Draw children
8575 * 5. If necessary, draw the fading edges and restore layers
8576 * 6. Draw decorations (scrollbars for instance)
8577 */
8578
8579 // Step 1, draw the background, if needed
8580 int saveCount;
8581
Romain Guy24443ea2009-05-11 11:56:30 -07008582 if (!dirtyOpaque) {
8583 final Drawable background = mBGDrawable;
8584 if (background != null) {
8585 final int scrollX = mScrollX;
8586 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008587
Romain Guy24443ea2009-05-11 11:56:30 -07008588 if (mBackgroundSizeChanged) {
8589 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
8590 mBackgroundSizeChanged = false;
8591 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008592
Romain Guy24443ea2009-05-11 11:56:30 -07008593 if ((scrollX | scrollY) == 0) {
8594 background.draw(canvas);
8595 } else {
8596 canvas.translate(scrollX, scrollY);
8597 background.draw(canvas);
8598 canvas.translate(-scrollX, -scrollY);
8599 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008600 }
8601 }
8602
8603 // skip step 2 & 5 if possible (common case)
8604 final int viewFlags = mViewFlags;
8605 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
8606 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
8607 if (!verticalEdges && !horizontalEdges) {
8608 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07008609 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008610
8611 // Step 4, draw the children
8612 dispatchDraw(canvas);
8613
8614 // Step 6, draw decorations (scrollbars)
8615 onDrawScrollBars(canvas);
8616
8617 // we're done...
8618 return;
8619 }
8620
8621 /*
8622 * Here we do the full fledged routine...
8623 * (this is an uncommon case where speed matters less,
8624 * this is why we repeat some of the tests that have been
8625 * done above)
8626 */
8627
8628 boolean drawTop = false;
8629 boolean drawBottom = false;
8630 boolean drawLeft = false;
8631 boolean drawRight = false;
8632
8633 float topFadeStrength = 0.0f;
8634 float bottomFadeStrength = 0.0f;
8635 float leftFadeStrength = 0.0f;
8636 float rightFadeStrength = 0.0f;
8637
8638 // Step 2, save the canvas' layers
8639 int paddingLeft = mPaddingLeft;
8640 int paddingTop = mPaddingTop;
8641
8642 final boolean offsetRequired = isPaddingOffsetRequired();
8643 if (offsetRequired) {
8644 paddingLeft += getLeftPaddingOffset();
8645 paddingTop += getTopPaddingOffset();
8646 }
8647
8648 int left = mScrollX + paddingLeft;
8649 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
8650 int top = mScrollY + paddingTop;
8651 int bottom = top + mBottom - mTop - mPaddingBottom - paddingTop;
8652
8653 if (offsetRequired) {
8654 right += getRightPaddingOffset();
8655 bottom += getBottomPaddingOffset();
8656 }
8657
8658 final ScrollabilityCache scrollabilityCache = mScrollCache;
8659 int length = scrollabilityCache.fadingEdgeLength;
8660
8661 // clip the fade length if top and bottom fades overlap
8662 // overlapping fades produce odd-looking artifacts
8663 if (verticalEdges && (top + length > bottom - length)) {
8664 length = (bottom - top) / 2;
8665 }
8666
8667 // also clip horizontal fades if necessary
8668 if (horizontalEdges && (left + length > right - length)) {
8669 length = (right - left) / 2;
8670 }
8671
8672 if (verticalEdges) {
8673 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008674 drawTop = topFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008675 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008676 drawBottom = bottomFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008677 }
8678
8679 if (horizontalEdges) {
8680 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008681 drawLeft = leftFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008682 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008683 drawRight = rightFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008684 }
8685
8686 saveCount = canvas.getSaveCount();
8687
8688 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -07008689 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008690 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
8691
8692 if (drawTop) {
8693 canvas.saveLayer(left, top, right, top + length, null, flags);
8694 }
8695
8696 if (drawBottom) {
8697 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
8698 }
8699
8700 if (drawLeft) {
8701 canvas.saveLayer(left, top, left + length, bottom, null, flags);
8702 }
8703
8704 if (drawRight) {
8705 canvas.saveLayer(right - length, top, right, bottom, null, flags);
8706 }
8707 } else {
8708 scrollabilityCache.setFadeColor(solidColor);
8709 }
8710
8711 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07008712 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008713
8714 // Step 4, draw the children
8715 dispatchDraw(canvas);
8716
8717 // Step 5, draw the fade effect and restore layers
8718 final Paint p = scrollabilityCache.paint;
8719 final Matrix matrix = scrollabilityCache.matrix;
8720 final Shader fade = scrollabilityCache.shader;
8721 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
8722
8723 if (drawTop) {
8724 matrix.setScale(1, fadeHeight * topFadeStrength);
8725 matrix.postTranslate(left, top);
8726 fade.setLocalMatrix(matrix);
8727 canvas.drawRect(left, top, right, top + length, p);
8728 }
8729
8730 if (drawBottom) {
8731 matrix.setScale(1, fadeHeight * bottomFadeStrength);
8732 matrix.postRotate(180);
8733 matrix.postTranslate(left, bottom);
8734 fade.setLocalMatrix(matrix);
8735 canvas.drawRect(left, bottom - length, right, bottom, p);
8736 }
8737
8738 if (drawLeft) {
8739 matrix.setScale(1, fadeHeight * leftFadeStrength);
8740 matrix.postRotate(-90);
8741 matrix.postTranslate(left, top);
8742 fade.setLocalMatrix(matrix);
8743 canvas.drawRect(left, top, left + length, bottom, p);
8744 }
8745
8746 if (drawRight) {
8747 matrix.setScale(1, fadeHeight * rightFadeStrength);
8748 matrix.postRotate(90);
8749 matrix.postTranslate(right, top);
8750 fade.setLocalMatrix(matrix);
8751 canvas.drawRect(right - length, top, right, bottom, p);
8752 }
8753
8754 canvas.restoreToCount(saveCount);
8755
8756 // Step 6, draw decorations (scrollbars)
8757 onDrawScrollBars(canvas);
8758 }
8759
8760 /**
8761 * Override this if your view is known to always be drawn on top of a solid color background,
8762 * and needs to draw fading edges. Returning a non-zero color enables the view system to
8763 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
8764 * should be set to 0xFF.
8765 *
8766 * @see #setVerticalFadingEdgeEnabled
8767 * @see #setHorizontalFadingEdgeEnabled
8768 *
8769 * @return The known solid color background for this view, or 0 if the color may vary
8770 */
8771 public int getSolidColor() {
8772 return 0;
8773 }
8774
8775 /**
8776 * Build a human readable string representation of the specified view flags.
8777 *
8778 * @param flags the view flags to convert to a string
8779 * @return a String representing the supplied flags
8780 */
8781 private static String printFlags(int flags) {
8782 String output = "";
8783 int numFlags = 0;
8784 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
8785 output += "TAKES_FOCUS";
8786 numFlags++;
8787 }
8788
8789 switch (flags & VISIBILITY_MASK) {
8790 case INVISIBLE:
8791 if (numFlags > 0) {
8792 output += " ";
8793 }
8794 output += "INVISIBLE";
8795 // USELESS HERE numFlags++;
8796 break;
8797 case GONE:
8798 if (numFlags > 0) {
8799 output += " ";
8800 }
8801 output += "GONE";
8802 // USELESS HERE numFlags++;
8803 break;
8804 default:
8805 break;
8806 }
8807 return output;
8808 }
8809
8810 /**
8811 * Build a human readable string representation of the specified private
8812 * view flags.
8813 *
8814 * @param privateFlags the private view flags to convert to a string
8815 * @return a String representing the supplied flags
8816 */
8817 private static String printPrivateFlags(int privateFlags) {
8818 String output = "";
8819 int numFlags = 0;
8820
8821 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
8822 output += "WANTS_FOCUS";
8823 numFlags++;
8824 }
8825
8826 if ((privateFlags & FOCUSED) == FOCUSED) {
8827 if (numFlags > 0) {
8828 output += " ";
8829 }
8830 output += "FOCUSED";
8831 numFlags++;
8832 }
8833
8834 if ((privateFlags & SELECTED) == SELECTED) {
8835 if (numFlags > 0) {
8836 output += " ";
8837 }
8838 output += "SELECTED";
8839 numFlags++;
8840 }
8841
8842 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
8843 if (numFlags > 0) {
8844 output += " ";
8845 }
8846 output += "IS_ROOT_NAMESPACE";
8847 numFlags++;
8848 }
8849
8850 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
8851 if (numFlags > 0) {
8852 output += " ";
8853 }
8854 output += "HAS_BOUNDS";
8855 numFlags++;
8856 }
8857
8858 if ((privateFlags & DRAWN) == DRAWN) {
8859 if (numFlags > 0) {
8860 output += " ";
8861 }
8862 output += "DRAWN";
8863 // USELESS HERE numFlags++;
8864 }
8865 return output;
8866 }
8867
8868 /**
8869 * <p>Indicates whether or not this view's layout will be requested during
8870 * the next hierarchy layout pass.</p>
8871 *
8872 * @return true if the layout will be forced during next layout pass
8873 */
8874 public boolean isLayoutRequested() {
8875 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
8876 }
8877
8878 /**
8879 * Assign a size and position to a view and all of its
8880 * descendants
8881 *
8882 * <p>This is the second phase of the layout mechanism.
8883 * (The first is measuring). In this phase, each parent calls
8884 * layout on all of its children to position them.
8885 * This is typically done using the child measurements
8886 * that were stored in the measure pass().
8887 *
8888 * Derived classes with children should override
8889 * onLayout. In that method, they should
Chet Haase21cd1382010-09-01 17:42:29 -07008890 * call layout on each of their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008891 *
8892 * @param l Left position, relative to parent
8893 * @param t Top position, relative to parent
8894 * @param r Right position, relative to parent
8895 * @param b Bottom position, relative to parent
8896 */
Romain Guy5429e1d2010-09-07 12:38:00 -07008897 @SuppressWarnings({"unchecked"})
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008898 public final void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -07008899 int oldL = mLeft;
8900 int oldT = mTop;
8901 int oldB = mBottom;
8902 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008903 boolean changed = setFrame(l, t, r, b);
8904 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
8905 if (ViewDebug.TRACE_HIERARCHY) {
8906 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
8907 }
8908
8909 onLayout(changed, l, t, r, b);
8910 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -07008911
8912 if (mOnLayoutChangeListeners != null) {
8913 ArrayList<OnLayoutChangeListener> listenersCopy =
8914 (ArrayList<OnLayoutChangeListener>) mOnLayoutChangeListeners.clone();
8915 int numListeners = listenersCopy.size();
8916 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -07008917 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -07008918 }
8919 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008920 }
8921 mPrivateFlags &= ~FORCE_LAYOUT;
8922 }
8923
8924 /**
8925 * Called from layout when this view should
8926 * assign a size and position to each of its children.
8927 *
8928 * Derived classes with children should override
8929 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -07008930 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008931 * @param changed This is a new size or position for this view
8932 * @param left Left position, relative to parent
8933 * @param top Top position, relative to parent
8934 * @param right Right position, relative to parent
8935 * @param bottom Bottom position, relative to parent
8936 */
8937 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
8938 }
8939
8940 /**
8941 * Assign a size and position to this view.
8942 *
8943 * This is called from layout.
8944 *
8945 * @param left Left position, relative to parent
8946 * @param top Top position, relative to parent
8947 * @param right Right position, relative to parent
8948 * @param bottom Bottom position, relative to parent
8949 * @return true if the new size and position are different than the
8950 * previous ones
8951 * {@hide}
8952 */
8953 protected boolean setFrame(int left, int top, int right, int bottom) {
8954 boolean changed = false;
8955
8956 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -07008957 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008958 + right + "," + bottom + ")");
8959 }
8960
8961 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
8962 changed = true;
8963
8964 // Remember our drawn bit
8965 int drawn = mPrivateFlags & DRAWN;
8966
8967 // Invalidate our old position
8968 invalidate();
8969
8970
8971 int oldWidth = mRight - mLeft;
8972 int oldHeight = mBottom - mTop;
8973
8974 mLeft = left;
8975 mTop = top;
8976 mRight = right;
8977 mBottom = bottom;
8978
8979 mPrivateFlags |= HAS_BOUNDS;
8980
8981 int newWidth = right - left;
8982 int newHeight = bottom - top;
8983
8984 if (newWidth != oldWidth || newHeight != oldHeight) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08008985 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
8986 // A change in dimension means an auto-centered pivot point changes, too
8987 mMatrixDirty = true;
8988 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008989 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
8990 }
8991
8992 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
8993 // If we are visible, force the DRAWN bit to on so that
8994 // this invalidate will go through (at least to our parent).
8995 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -08008996 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008997 // the DRAWN bit.
8998 mPrivateFlags |= DRAWN;
8999 invalidate();
9000 }
9001
9002 // Reset drawn bit to original value (invalidate turns it off)
9003 mPrivateFlags |= drawn;
9004
9005 mBackgroundSizeChanged = true;
9006 }
9007 return changed;
9008 }
9009
9010 /**
9011 * Finalize inflating a view from XML. This is called as the last phase
9012 * of inflation, after all child views have been added.
9013 *
9014 * <p>Even if the subclass overrides onFinishInflate, they should always be
9015 * sure to call the super method, so that we get called.
9016 */
9017 protected void onFinishInflate() {
9018 }
9019
9020 /**
9021 * Returns the resources associated with this view.
9022 *
9023 * @return Resources object.
9024 */
9025 public Resources getResources() {
9026 return mResources;
9027 }
9028
9029 /**
9030 * Invalidates the specified Drawable.
9031 *
9032 * @param drawable the drawable to invalidate
9033 */
9034 public void invalidateDrawable(Drawable drawable) {
9035 if (verifyDrawable(drawable)) {
9036 final Rect dirty = drawable.getBounds();
9037 final int scrollX = mScrollX;
9038 final int scrollY = mScrollY;
9039
9040 invalidate(dirty.left + scrollX, dirty.top + scrollY,
9041 dirty.right + scrollX, dirty.bottom + scrollY);
9042 }
9043 }
9044
9045 /**
9046 * Schedules an action on a drawable to occur at a specified time.
9047 *
9048 * @param who the recipient of the action
9049 * @param what the action to run on the drawable
9050 * @param when the time at which the action must occur. Uses the
9051 * {@link SystemClock#uptimeMillis} timebase.
9052 */
9053 public void scheduleDrawable(Drawable who, Runnable what, long when) {
9054 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
9055 mAttachInfo.mHandler.postAtTime(what, who, when);
9056 }
9057 }
9058
9059 /**
9060 * Cancels a scheduled action on a drawable.
9061 *
9062 * @param who the recipient of the action
9063 * @param what the action to cancel
9064 */
9065 public void unscheduleDrawable(Drawable who, Runnable what) {
9066 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
9067 mAttachInfo.mHandler.removeCallbacks(what, who);
9068 }
9069 }
9070
9071 /**
9072 * Unschedule any events associated with the given Drawable. This can be
9073 * used when selecting a new Drawable into a view, so that the previous
9074 * one is completely unscheduled.
9075 *
9076 * @param who The Drawable to unschedule.
9077 *
9078 * @see #drawableStateChanged
9079 */
9080 public void unscheduleDrawable(Drawable who) {
9081 if (mAttachInfo != null) {
9082 mAttachInfo.mHandler.removeCallbacksAndMessages(who);
9083 }
9084 }
9085
9086 /**
9087 * If your view subclass is displaying its own Drawable objects, it should
9088 * override this function and return true for any Drawable it is
9089 * displaying. This allows animations for those drawables to be
9090 * scheduled.
9091 *
9092 * <p>Be sure to call through to the super class when overriding this
9093 * function.
9094 *
9095 * @param who The Drawable to verify. Return true if it is one you are
9096 * displaying, else return the result of calling through to the
9097 * super class.
9098 *
9099 * @return boolean If true than the Drawable is being displayed in the
9100 * view; else false and it is not allowed to animate.
9101 *
9102 * @see #unscheduleDrawable
9103 * @see #drawableStateChanged
9104 */
9105 protected boolean verifyDrawable(Drawable who) {
9106 return who == mBGDrawable;
9107 }
9108
9109 /**
9110 * This function is called whenever the state of the view changes in such
9111 * a way that it impacts the state of drawables being shown.
9112 *
9113 * <p>Be sure to call through to the superclass when overriding this
9114 * function.
9115 *
9116 * @see Drawable#setState
9117 */
9118 protected void drawableStateChanged() {
9119 Drawable d = mBGDrawable;
9120 if (d != null && d.isStateful()) {
9121 d.setState(getDrawableState());
9122 }
9123 }
9124
9125 /**
9126 * Call this to force a view to update its drawable state. This will cause
9127 * drawableStateChanged to be called on this view. Views that are interested
9128 * in the new state should call getDrawableState.
9129 *
9130 * @see #drawableStateChanged
9131 * @see #getDrawableState
9132 */
9133 public void refreshDrawableState() {
9134 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
9135 drawableStateChanged();
9136
9137 ViewParent parent = mParent;
9138 if (parent != null) {
9139 parent.childDrawableStateChanged(this);
9140 }
9141 }
9142
9143 /**
9144 * Return an array of resource IDs of the drawable states representing the
9145 * current state of the view.
9146 *
9147 * @return The current drawable state
9148 *
9149 * @see Drawable#setState
9150 * @see #drawableStateChanged
9151 * @see #onCreateDrawableState
9152 */
9153 public final int[] getDrawableState() {
9154 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
9155 return mDrawableState;
9156 } else {
9157 mDrawableState = onCreateDrawableState(0);
9158 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
9159 return mDrawableState;
9160 }
9161 }
9162
9163 /**
9164 * Generate the new {@link android.graphics.drawable.Drawable} state for
9165 * this view. This is called by the view
9166 * system when the cached Drawable state is determined to be invalid. To
9167 * retrieve the current state, you should use {@link #getDrawableState}.
9168 *
9169 * @param extraSpace if non-zero, this is the number of extra entries you
9170 * would like in the returned array in which you can place your own
9171 * states.
9172 *
9173 * @return Returns an array holding the current {@link Drawable} state of
9174 * the view.
9175 *
9176 * @see #mergeDrawableStates
9177 */
9178 protected int[] onCreateDrawableState(int extraSpace) {
9179 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
9180 mParent instanceof View) {
9181 return ((View) mParent).onCreateDrawableState(extraSpace);
9182 }
9183
9184 int[] drawableState;
9185
9186 int privateFlags = mPrivateFlags;
9187
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009188 int viewStateIndex = 0;
9189 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
9190 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
9191 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -07009192 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009193 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
9194 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08009195 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested) {
9196 // This is set if HW acceleration is requested, even if the current
9197 // process doesn't allow it. This is just to allow app preview
9198 // windows to better match their app.
9199 viewStateIndex |= VIEW_STATE_ACCELERATED;
9200 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009201
9202 drawableState = VIEW_STATE_SETS[viewStateIndex];
9203
9204 //noinspection ConstantIfStatement
9205 if (false) {
9206 Log.i("View", "drawableStateIndex=" + viewStateIndex);
9207 Log.i("View", toString()
9208 + " pressed=" + ((privateFlags & PRESSED) != 0)
9209 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
9210 + " fo=" + hasFocus()
9211 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009212 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009213 + ": " + Arrays.toString(drawableState));
9214 }
9215
9216 if (extraSpace == 0) {
9217 return drawableState;
9218 }
9219
9220 final int[] fullState;
9221 if (drawableState != null) {
9222 fullState = new int[drawableState.length + extraSpace];
9223 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
9224 } else {
9225 fullState = new int[extraSpace];
9226 }
9227
9228 return fullState;
9229 }
9230
9231 /**
9232 * Merge your own state values in <var>additionalState</var> into the base
9233 * state values <var>baseState</var> that were returned by
9234 * {@link #onCreateDrawableState}.
9235 *
9236 * @param baseState The base state values returned by
9237 * {@link #onCreateDrawableState}, which will be modified to also hold your
9238 * own additional state values.
9239 *
9240 * @param additionalState The additional state values you would like
9241 * added to <var>baseState</var>; this array is not modified.
9242 *
9243 * @return As a convenience, the <var>baseState</var> array you originally
9244 * passed into the function is returned.
9245 *
9246 * @see #onCreateDrawableState
9247 */
9248 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
9249 final int N = baseState.length;
9250 int i = N - 1;
9251 while (i >= 0 && baseState[i] == 0) {
9252 i--;
9253 }
9254 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
9255 return baseState;
9256 }
9257
9258 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -07009259 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
9260 * on all Drawable objects associated with this view.
9261 */
9262 public void jumpDrawablesToCurrentState() {
9263 if (mBGDrawable != null) {
9264 mBGDrawable.jumpToCurrentState();
9265 }
9266 }
9267
9268 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009269 * Sets the background color for this view.
9270 * @param color the color of the background
9271 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00009272 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009273 public void setBackgroundColor(int color) {
Chet Haase70d4ba12010-10-06 09:46:45 -07009274 if (mBGDrawable instanceof ColorDrawable) {
9275 ((ColorDrawable) mBGDrawable).setColor(color);
9276 } else {
9277 setBackgroundDrawable(new ColorDrawable(color));
9278 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009279 }
9280
9281 /**
9282 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -07009283 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009284 * @param resid The identifier of the resource.
9285 * @attr ref android.R.styleable#View_background
9286 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00009287 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009288 public void setBackgroundResource(int resid) {
9289 if (resid != 0 && resid == mBackgroundResource) {
9290 return;
9291 }
9292
9293 Drawable d= null;
9294 if (resid != 0) {
9295 d = mResources.getDrawable(resid);
9296 }
9297 setBackgroundDrawable(d);
9298
9299 mBackgroundResource = resid;
9300 }
9301
9302 /**
9303 * Set the background to a given Drawable, or remove the background. If the
9304 * background has padding, this View's padding is set to the background's
9305 * padding. However, when a background is removed, this View's padding isn't
9306 * touched. If setting the padding is desired, please use
9307 * {@link #setPadding(int, int, int, int)}.
9308 *
9309 * @param d The Drawable to use as the background, or null to remove the
9310 * background
9311 */
9312 public void setBackgroundDrawable(Drawable d) {
9313 boolean requestLayout = false;
9314
9315 mBackgroundResource = 0;
9316
9317 /*
9318 * Regardless of whether we're setting a new background or not, we want
9319 * to clear the previous drawable.
9320 */
9321 if (mBGDrawable != null) {
9322 mBGDrawable.setCallback(null);
9323 unscheduleDrawable(mBGDrawable);
9324 }
9325
9326 if (d != null) {
9327 Rect padding = sThreadLocal.get();
9328 if (padding == null) {
9329 padding = new Rect();
9330 sThreadLocal.set(padding);
9331 }
9332 if (d.getPadding(padding)) {
9333 setPadding(padding.left, padding.top, padding.right, padding.bottom);
9334 }
9335
9336 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
9337 // if it has a different minimum size, we should layout again
9338 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() ||
9339 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) {
9340 requestLayout = true;
9341 }
9342
9343 d.setCallback(this);
9344 if (d.isStateful()) {
9345 d.setState(getDrawableState());
9346 }
9347 d.setVisible(getVisibility() == VISIBLE, false);
9348 mBGDrawable = d;
9349
9350 if ((mPrivateFlags & SKIP_DRAW) != 0) {
9351 mPrivateFlags &= ~SKIP_DRAW;
9352 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
9353 requestLayout = true;
9354 }
9355 } else {
9356 /* Remove the background */
9357 mBGDrawable = null;
9358
9359 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
9360 /*
9361 * This view ONLY drew the background before and we're removing
9362 * the background, so now it won't draw anything
9363 * (hence we SKIP_DRAW)
9364 */
9365 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
9366 mPrivateFlags |= SKIP_DRAW;
9367 }
9368
9369 /*
9370 * When the background is set, we try to apply its padding to this
9371 * View. When the background is removed, we don't touch this View's
9372 * padding. This is noted in the Javadocs. Hence, we don't need to
9373 * requestLayout(), the invalidate() below is sufficient.
9374 */
9375
9376 // The old background's minimum size could have affected this
9377 // View's layout, so let's requestLayout
9378 requestLayout = true;
9379 }
9380
Romain Guy8f1344f52009-05-15 16:03:59 -07009381 computeOpaqueFlags();
9382
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009383 if (requestLayout) {
9384 requestLayout();
9385 }
9386
9387 mBackgroundSizeChanged = true;
9388 invalidate();
9389 }
9390
9391 /**
9392 * Gets the background drawable
9393 * @return The drawable used as the background for this view, if any.
9394 */
9395 public Drawable getBackground() {
9396 return mBGDrawable;
9397 }
9398
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009399 /**
9400 * Sets the padding. The view may add on the space required to display
9401 * the scrollbars, depending on the style and visibility of the scrollbars.
9402 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
9403 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
9404 * from the values set in this call.
9405 *
9406 * @attr ref android.R.styleable#View_padding
9407 * @attr ref android.R.styleable#View_paddingBottom
9408 * @attr ref android.R.styleable#View_paddingLeft
9409 * @attr ref android.R.styleable#View_paddingRight
9410 * @attr ref android.R.styleable#View_paddingTop
9411 * @param left the left padding in pixels
9412 * @param top the top padding in pixels
9413 * @param right the right padding in pixels
9414 * @param bottom the bottom padding in pixels
9415 */
9416 public void setPadding(int left, int top, int right, int bottom) {
9417 boolean changed = false;
9418
Adam Powell20232d02010-12-08 21:08:53 -08009419 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009420 mUserPaddingRight = right;
9421 mUserPaddingBottom = bottom;
9422
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009423 final int viewFlags = mViewFlags;
Romain Guy8506ab42009-06-11 17:35:47 -07009424
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009425 // Common case is there are no scroll bars.
9426 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009427 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -08009428 // TODO Determine what to do with SCROLLBAR_POSITION_DEFAULT based on RTL settings.
9429 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009430 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -08009431 switch (mVerticalScrollbarPosition) {
9432 case SCROLLBAR_POSITION_DEFAULT:
9433 case SCROLLBAR_POSITION_RIGHT:
9434 right += offset;
9435 break;
9436 case SCROLLBAR_POSITION_LEFT:
9437 left += offset;
9438 break;
9439 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009440 }
Adam Powell20232d02010-12-08 21:08:53 -08009441 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009442 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
9443 ? 0 : getHorizontalScrollbarHeight();
9444 }
9445 }
Romain Guy8506ab42009-06-11 17:35:47 -07009446
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009447 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009448 changed = true;
9449 mPaddingLeft = left;
9450 }
9451 if (mPaddingTop != top) {
9452 changed = true;
9453 mPaddingTop = top;
9454 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009455 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009456 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009457 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009458 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009459 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009460 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009461 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009462 }
9463
9464 if (changed) {
9465 requestLayout();
9466 }
9467 }
9468
9469 /**
9470 * Returns the top padding of this view.
9471 *
9472 * @return the top padding in pixels
9473 */
9474 public int getPaddingTop() {
9475 return mPaddingTop;
9476 }
9477
9478 /**
9479 * Returns the bottom padding of this view. If there are inset and enabled
9480 * scrollbars, this value may include the space required to display the
9481 * scrollbars as well.
9482 *
9483 * @return the bottom padding in pixels
9484 */
9485 public int getPaddingBottom() {
9486 return mPaddingBottom;
9487 }
9488
9489 /**
9490 * Returns the left padding of this view. If there are inset and enabled
9491 * scrollbars, this value may include the space required to display the
9492 * scrollbars as well.
9493 *
9494 * @return the left padding in pixels
9495 */
9496 public int getPaddingLeft() {
9497 return mPaddingLeft;
9498 }
9499
9500 /**
9501 * Returns the right padding of this view. If there are inset and enabled
9502 * scrollbars, this value may include the space required to display the
9503 * scrollbars as well.
9504 *
9505 * @return the right padding in pixels
9506 */
9507 public int getPaddingRight() {
9508 return mPaddingRight;
9509 }
9510
9511 /**
9512 * Changes the selection state of this view. A view can be selected or not.
9513 * Note that selection is not the same as focus. Views are typically
9514 * selected in the context of an AdapterView like ListView or GridView;
9515 * the selected view is the view that is highlighted.
9516 *
9517 * @param selected true if the view must be selected, false otherwise
9518 */
9519 public void setSelected(boolean selected) {
9520 if (((mPrivateFlags & SELECTED) != 0) != selected) {
9521 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -07009522 if (!selected) resetPressedState();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009523 invalidate();
9524 refreshDrawableState();
9525 dispatchSetSelected(selected);
9526 }
9527 }
9528
9529 /**
9530 * Dispatch setSelected to all of this View's children.
9531 *
9532 * @see #setSelected(boolean)
9533 *
9534 * @param selected The new selected state
9535 */
9536 protected void dispatchSetSelected(boolean selected) {
9537 }
9538
9539 /**
9540 * Indicates the selection state of this view.
9541 *
9542 * @return true if the view is selected, false otherwise
9543 */
9544 @ViewDebug.ExportedProperty
9545 public boolean isSelected() {
9546 return (mPrivateFlags & SELECTED) != 0;
9547 }
9548
9549 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009550 * Changes the activated state of this view. A view can be activated or not.
9551 * Note that activation is not the same as selection. Selection is
9552 * a transient property, representing the view (hierarchy) the user is
9553 * currently interacting with. Activation is a longer-term state that the
9554 * user can move views in and out of. For example, in a list view with
9555 * single or multiple selection enabled, the views in the current selection
9556 * set are activated. (Um, yeah, we are deeply sorry about the terminology
9557 * here.) The activated state is propagated down to children of the view it
9558 * is set on.
9559 *
9560 * @param activated true if the view must be activated, false otherwise
9561 */
9562 public void setActivated(boolean activated) {
9563 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
9564 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
9565 invalidate();
9566 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -07009567 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009568 }
9569 }
9570
9571 /**
9572 * Dispatch setActivated to all of this View's children.
9573 *
9574 * @see #setActivated(boolean)
9575 *
9576 * @param activated The new activated state
9577 */
9578 protected void dispatchSetActivated(boolean activated) {
9579 }
9580
9581 /**
9582 * Indicates the activation state of this view.
9583 *
9584 * @return true if the view is activated, false otherwise
9585 */
9586 @ViewDebug.ExportedProperty
9587 public boolean isActivated() {
9588 return (mPrivateFlags & ACTIVATED) != 0;
9589 }
9590
9591 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009592 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
9593 * observer can be used to get notifications when global events, like
9594 * layout, happen.
9595 *
9596 * The returned ViewTreeObserver observer is not guaranteed to remain
9597 * valid for the lifetime of this View. If the caller of this method keeps
9598 * a long-lived reference to ViewTreeObserver, it should always check for
9599 * the return value of {@link ViewTreeObserver#isAlive()}.
9600 *
9601 * @return The ViewTreeObserver for this view's hierarchy.
9602 */
9603 public ViewTreeObserver getViewTreeObserver() {
9604 if (mAttachInfo != null) {
9605 return mAttachInfo.mTreeObserver;
9606 }
9607 if (mFloatingTreeObserver == null) {
9608 mFloatingTreeObserver = new ViewTreeObserver();
9609 }
9610 return mFloatingTreeObserver;
9611 }
9612
9613 /**
9614 * <p>Finds the topmost view in the current view hierarchy.</p>
9615 *
9616 * @return the topmost view containing this view
9617 */
9618 public View getRootView() {
9619 if (mAttachInfo != null) {
9620 final View v = mAttachInfo.mRootView;
9621 if (v != null) {
9622 return v;
9623 }
9624 }
Romain Guy8506ab42009-06-11 17:35:47 -07009625
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009626 View parent = this;
9627
9628 while (parent.mParent != null && parent.mParent instanceof View) {
9629 parent = (View) parent.mParent;
9630 }
9631
9632 return parent;
9633 }
9634
9635 /**
9636 * <p>Computes the coordinates of this view on the screen. The argument
9637 * must be an array of two integers. After the method returns, the array
9638 * contains the x and y location in that order.</p>
9639 *
9640 * @param location an array of two integers in which to hold the coordinates
9641 */
9642 public void getLocationOnScreen(int[] location) {
9643 getLocationInWindow(location);
9644
9645 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -07009646 if (info != null) {
9647 location[0] += info.mWindowLeft;
9648 location[1] += info.mWindowTop;
9649 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009650 }
9651
9652 /**
9653 * <p>Computes the coordinates of this view in its window. The argument
9654 * must be an array of two integers. After the method returns, the array
9655 * contains the x and y location in that order.</p>
9656 *
9657 * @param location an array of two integers in which to hold the coordinates
9658 */
9659 public void getLocationInWindow(int[] location) {
9660 if (location == null || location.length < 2) {
9661 throw new IllegalArgumentException("location must be an array of "
9662 + "two integers");
9663 }
9664
Michael Jurka4d2bd4c2010-11-30 18:15:11 -08009665 location[0] = mLeft + (int) (mTranslationX + 0.5f);
9666 location[1] = mTop + (int) (mTranslationY + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009667
9668 ViewParent viewParent = mParent;
9669 while (viewParent instanceof View) {
9670 final View view = (View)viewParent;
Michael Jurka4d2bd4c2010-11-30 18:15:11 -08009671 location[0] += view.mLeft + (int) (view.mTranslationX + 0.5f) - view.mScrollX;
9672 location[1] += view.mTop + (int) (view.mTranslationY + 0.5f) - view.mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009673 viewParent = view.mParent;
9674 }
Romain Guy8506ab42009-06-11 17:35:47 -07009675
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009676 if (viewParent instanceof ViewRoot) {
9677 // *cough*
9678 final ViewRoot vr = (ViewRoot)viewParent;
9679 location[1] -= vr.mCurScrollY;
9680 }
9681 }
9682
9683 /**
9684 * {@hide}
9685 * @param id the id of the view to be found
9686 * @return the view of the specified id, null if cannot be found
9687 */
9688 protected View findViewTraversal(int id) {
9689 if (id == mID) {
9690 return this;
9691 }
9692 return null;
9693 }
9694
9695 /**
9696 * {@hide}
9697 * @param tag the tag of the view to be found
9698 * @return the view of specified tag, null if cannot be found
9699 */
9700 protected View findViewWithTagTraversal(Object tag) {
9701 if (tag != null && tag.equals(mTag)) {
9702 return this;
9703 }
9704 return null;
9705 }
9706
9707 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08009708 * {@hide}
9709 * @param predicate The predicate to evaluate.
9710 * @return The first view that matches the predicate or null.
9711 */
9712 protected View findViewByPredicateTraversal(Predicate<View> predicate) {
9713 if (predicate.apply(this)) {
9714 return this;
9715 }
9716 return null;
9717 }
9718
9719 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009720 * Look for a child view with the given id. If this view has the given
9721 * id, return this view.
9722 *
9723 * @param id The id to search for.
9724 * @return The view that has the given id in the hierarchy or null
9725 */
9726 public final View findViewById(int id) {
9727 if (id < 0) {
9728 return null;
9729 }
9730 return findViewTraversal(id);
9731 }
9732
9733 /**
9734 * Look for a child view with the given tag. If this view has the given
9735 * tag, return this view.
9736 *
9737 * @param tag The tag to search for, using "tag.equals(getTag())".
9738 * @return The View that has the given tag in the hierarchy or null
9739 */
9740 public final View findViewWithTag(Object tag) {
9741 if (tag == null) {
9742 return null;
9743 }
9744 return findViewWithTagTraversal(tag);
9745 }
9746
9747 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08009748 * {@hide}
9749 * Look for a child view that matches the specified predicate.
9750 * If this view matches the predicate, return this view.
9751 *
9752 * @param predicate The predicate to evaluate.
9753 * @return The first view that matches the predicate or null.
9754 */
9755 public final View findViewByPredicate(Predicate<View> predicate) {
9756 return findViewByPredicateTraversal(predicate);
9757 }
9758
9759 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009760 * Sets the identifier for this view. The identifier does not have to be
9761 * unique in this view's hierarchy. The identifier should be a positive
9762 * number.
9763 *
9764 * @see #NO_ID
9765 * @see #getId
9766 * @see #findViewById
9767 *
9768 * @param id a number used to identify the view
9769 *
9770 * @attr ref android.R.styleable#View_id
9771 */
9772 public void setId(int id) {
9773 mID = id;
9774 }
9775
9776 /**
9777 * {@hide}
9778 *
9779 * @param isRoot true if the view belongs to the root namespace, false
9780 * otherwise
9781 */
9782 public void setIsRootNamespace(boolean isRoot) {
9783 if (isRoot) {
9784 mPrivateFlags |= IS_ROOT_NAMESPACE;
9785 } else {
9786 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
9787 }
9788 }
9789
9790 /**
9791 * {@hide}
9792 *
9793 * @return true if the view belongs to the root namespace, false otherwise
9794 */
9795 public boolean isRootNamespace() {
9796 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
9797 }
9798
9799 /**
9800 * Returns this view's identifier.
9801 *
9802 * @return a positive integer used to identify the view or {@link #NO_ID}
9803 * if the view has no ID
9804 *
9805 * @see #setId
9806 * @see #findViewById
9807 * @attr ref android.R.styleable#View_id
9808 */
9809 @ViewDebug.CapturedViewProperty
9810 public int getId() {
9811 return mID;
9812 }
9813
9814 /**
9815 * Returns this view's tag.
9816 *
9817 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -07009818 *
9819 * @see #setTag(Object)
9820 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009821 */
9822 @ViewDebug.ExportedProperty
9823 public Object getTag() {
9824 return mTag;
9825 }
9826
9827 /**
9828 * Sets the tag associated with this view. A tag can be used to mark
9829 * a view in its hierarchy and does not have to be unique within the
9830 * hierarchy. Tags can also be used to store data within a view without
9831 * resorting to another data structure.
9832 *
9833 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -07009834 *
9835 * @see #getTag()
9836 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009837 */
9838 public void setTag(final Object tag) {
9839 mTag = tag;
9840 }
9841
9842 /**
Romain Guyd90a3312009-05-06 14:54:28 -07009843 * Returns the tag associated with this view and the specified key.
9844 *
9845 * @param key The key identifying the tag
9846 *
9847 * @return the Object stored in this view as a tag
9848 *
9849 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -07009850 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -07009851 */
9852 public Object getTag(int key) {
9853 SparseArray<Object> tags = null;
9854 synchronized (sTagsLock) {
9855 if (sTags != null) {
9856 tags = sTags.get(this);
9857 }
9858 }
9859
9860 if (tags != null) return tags.get(key);
9861 return null;
9862 }
9863
9864 /**
9865 * Sets a tag associated with this view and a key. A tag can be used
9866 * to mark a view in its hierarchy and does not have to be unique within
9867 * the hierarchy. Tags can also be used to store data within a view
9868 * without resorting to another data structure.
9869 *
9870 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -07009871 * application to ensure it is unique (see the <a
9872 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
9873 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -07009874 * the Android framework or not associated with any package will cause
9875 * an {@link IllegalArgumentException} to be thrown.
9876 *
9877 * @param key The key identifying the tag
9878 * @param tag An Object to tag the view with
9879 *
9880 * @throws IllegalArgumentException If they specified key is not valid
9881 *
9882 * @see #setTag(Object)
9883 * @see #getTag(int)
9884 */
9885 public void setTag(int key, final Object tag) {
9886 // If the package id is 0x00 or 0x01, it's either an undefined package
9887 // or a framework id
9888 if ((key >>> 24) < 2) {
9889 throw new IllegalArgumentException("The key must be an application-specific "
9890 + "resource id.");
9891 }
9892
9893 setTagInternal(this, key, tag);
9894 }
9895
9896 /**
9897 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
9898 * framework id.
9899 *
9900 * @hide
9901 */
9902 public void setTagInternal(int key, Object tag) {
9903 if ((key >>> 24) != 0x1) {
9904 throw new IllegalArgumentException("The key must be a framework-specific "
9905 + "resource id.");
9906 }
9907
Romain Guy8506ab42009-06-11 17:35:47 -07009908 setTagInternal(this, key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -07009909 }
9910
9911 private static void setTagInternal(View view, int key, Object tag) {
9912 SparseArray<Object> tags = null;
9913 synchronized (sTagsLock) {
9914 if (sTags == null) {
9915 sTags = new WeakHashMap<View, SparseArray<Object>>();
9916 } else {
9917 tags = sTags.get(view);
9918 }
9919 }
9920
9921 if (tags == null) {
9922 tags = new SparseArray<Object>(2);
9923 synchronized (sTagsLock) {
9924 sTags.put(view, tags);
9925 }
9926 }
9927
9928 tags.put(key, tag);
9929 }
9930
9931 /**
Romain Guy13922e02009-05-12 17:56:14 -07009932 * @param consistency The type of consistency. See ViewDebug for more information.
9933 *
9934 * @hide
9935 */
9936 protected boolean dispatchConsistencyCheck(int consistency) {
9937 return onConsistencyCheck(consistency);
9938 }
9939
9940 /**
9941 * Method that subclasses should implement to check their consistency. The type of
9942 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -07009943 *
Romain Guy13922e02009-05-12 17:56:14 -07009944 * @param consistency The type of consistency. See ViewDebug for more information.
9945 *
9946 * @throws IllegalStateException if the view is in an inconsistent state.
9947 *
9948 * @hide
9949 */
9950 protected boolean onConsistencyCheck(int consistency) {
9951 boolean result = true;
9952
9953 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
9954 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
9955
9956 if (checkLayout) {
9957 if (getParent() == null) {
9958 result = false;
9959 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
9960 "View " + this + " does not have a parent.");
9961 }
9962
9963 if (mAttachInfo == null) {
9964 result = false;
9965 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
9966 "View " + this + " is not attached to a window.");
9967 }
9968 }
9969
9970 if (checkDrawing) {
9971 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
9972 // from their draw() method
9973
9974 if ((mPrivateFlags & DRAWN) != DRAWN &&
9975 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
9976 result = false;
9977 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
9978 "View " + this + " was invalidated but its drawing cache is valid.");
9979 }
9980 }
9981
9982 return result;
9983 }
9984
9985 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009986 * Prints information about this view in the log output, with the tag
9987 * {@link #VIEW_LOG_TAG}.
9988 *
9989 * @hide
9990 */
9991 public void debug() {
9992 debug(0);
9993 }
9994
9995 /**
9996 * Prints information about this view in the log output, with the tag
9997 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
9998 * indentation defined by the <code>depth</code>.
9999 *
10000 * @param depth the indentation level
10001 *
10002 * @hide
10003 */
10004 protected void debug(int depth) {
10005 String output = debugIndent(depth - 1);
10006
10007 output += "+ " + this;
10008 int id = getId();
10009 if (id != -1) {
10010 output += " (id=" + id + ")";
10011 }
10012 Object tag = getTag();
10013 if (tag != null) {
10014 output += " (tag=" + tag + ")";
10015 }
10016 Log.d(VIEW_LOG_TAG, output);
10017
10018 if ((mPrivateFlags & FOCUSED) != 0) {
10019 output = debugIndent(depth) + " FOCUSED";
10020 Log.d(VIEW_LOG_TAG, output);
10021 }
10022
10023 output = debugIndent(depth);
10024 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
10025 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
10026 + "} ";
10027 Log.d(VIEW_LOG_TAG, output);
10028
10029 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
10030 || mPaddingBottom != 0) {
10031 output = debugIndent(depth);
10032 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
10033 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
10034 Log.d(VIEW_LOG_TAG, output);
10035 }
10036
10037 output = debugIndent(depth);
10038 output += "mMeasureWidth=" + mMeasuredWidth +
10039 " mMeasureHeight=" + mMeasuredHeight;
10040 Log.d(VIEW_LOG_TAG, output);
10041
10042 output = debugIndent(depth);
10043 if (mLayoutParams == null) {
10044 output += "BAD! no layout params";
10045 } else {
10046 output = mLayoutParams.debug(output);
10047 }
10048 Log.d(VIEW_LOG_TAG, output);
10049
10050 output = debugIndent(depth);
10051 output += "flags={";
10052 output += View.printFlags(mViewFlags);
10053 output += "}";
10054 Log.d(VIEW_LOG_TAG, output);
10055
10056 output = debugIndent(depth);
10057 output += "privateFlags={";
10058 output += View.printPrivateFlags(mPrivateFlags);
10059 output += "}";
10060 Log.d(VIEW_LOG_TAG, output);
10061 }
10062
10063 /**
10064 * Creates an string of whitespaces used for indentation.
10065 *
10066 * @param depth the indentation level
10067 * @return a String containing (depth * 2 + 3) * 2 white spaces
10068 *
10069 * @hide
10070 */
10071 protected static String debugIndent(int depth) {
10072 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
10073 for (int i = 0; i < (depth * 2) + 3; i++) {
10074 spaces.append(' ').append(' ');
10075 }
10076 return spaces.toString();
10077 }
10078
10079 /**
10080 * <p>Return the offset of the widget's text baseline from the widget's top
10081 * boundary. If this widget does not support baseline alignment, this
10082 * method returns -1. </p>
10083 *
10084 * @return the offset of the baseline within the widget's bounds or -1
10085 * if baseline alignment is not supported
10086 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070010087 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010088 public int getBaseline() {
10089 return -1;
10090 }
10091
10092 /**
10093 * Call this when something has changed which has invalidated the
10094 * layout of this view. This will schedule a layout pass of the view
10095 * tree.
10096 */
10097 public void requestLayout() {
10098 if (ViewDebug.TRACE_HIERARCHY) {
10099 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
10100 }
10101
10102 mPrivateFlags |= FORCE_LAYOUT;
10103
10104 if (mParent != null && !mParent.isLayoutRequested()) {
10105 mParent.requestLayout();
10106 }
10107 }
10108
10109 /**
10110 * Forces this view to be laid out during the next layout pass.
10111 * This method does not call requestLayout() or forceLayout()
10112 * on the parent.
10113 */
10114 public void forceLayout() {
10115 mPrivateFlags |= FORCE_LAYOUT;
10116 }
10117
10118 /**
10119 * <p>
10120 * This is called to find out how big a view should be. The parent
10121 * supplies constraint information in the width and height parameters.
10122 * </p>
10123 *
10124 * <p>
10125 * The actual mesurement work of a view is performed in
10126 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
10127 * {@link #onMeasure(int, int)} can and must be overriden by subclasses.
10128 * </p>
10129 *
10130 *
10131 * @param widthMeasureSpec Horizontal space requirements as imposed by the
10132 * parent
10133 * @param heightMeasureSpec Vertical space requirements as imposed by the
10134 * parent
10135 *
10136 * @see #onMeasure(int, int)
10137 */
10138 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
10139 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
10140 widthMeasureSpec != mOldWidthMeasureSpec ||
10141 heightMeasureSpec != mOldHeightMeasureSpec) {
10142
10143 // first clears the measured dimension flag
10144 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
10145
10146 if (ViewDebug.TRACE_HIERARCHY) {
10147 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
10148 }
10149
10150 // measure ourselves, this should set the measured dimension flag back
10151 onMeasure(widthMeasureSpec, heightMeasureSpec);
10152
10153 // flag not set, setMeasuredDimension() was not invoked, we raise
10154 // an exception to warn the developer
10155 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
10156 throw new IllegalStateException("onMeasure() did not set the"
10157 + " measured dimension by calling"
10158 + " setMeasuredDimension()");
10159 }
10160
10161 mPrivateFlags |= LAYOUT_REQUIRED;
10162 }
10163
10164 mOldWidthMeasureSpec = widthMeasureSpec;
10165 mOldHeightMeasureSpec = heightMeasureSpec;
10166 }
10167
10168 /**
10169 * <p>
10170 * Measure the view and its content to determine the measured width and the
10171 * measured height. This method is invoked by {@link #measure(int, int)} and
10172 * should be overriden by subclasses to provide accurate and efficient
10173 * measurement of their contents.
10174 * </p>
10175 *
10176 * <p>
10177 * <strong>CONTRACT:</strong> When overriding this method, you
10178 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
10179 * measured width and height of this view. Failure to do so will trigger an
10180 * <code>IllegalStateException</code>, thrown by
10181 * {@link #measure(int, int)}. Calling the superclass'
10182 * {@link #onMeasure(int, int)} is a valid use.
10183 * </p>
10184 *
10185 * <p>
10186 * The base class implementation of measure defaults to the background size,
10187 * unless a larger size is allowed by the MeasureSpec. Subclasses should
10188 * override {@link #onMeasure(int, int)} to provide better measurements of
10189 * their content.
10190 * </p>
10191 *
10192 * <p>
10193 * If this method is overridden, it is the subclass's responsibility to make
10194 * sure the measured height and width are at least the view's minimum height
10195 * and width ({@link #getSuggestedMinimumHeight()} and
10196 * {@link #getSuggestedMinimumWidth()}).
10197 * </p>
10198 *
10199 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
10200 * The requirements are encoded with
10201 * {@link android.view.View.MeasureSpec}.
10202 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
10203 * The requirements are encoded with
10204 * {@link android.view.View.MeasureSpec}.
10205 *
10206 * @see #getMeasuredWidth()
10207 * @see #getMeasuredHeight()
10208 * @see #setMeasuredDimension(int, int)
10209 * @see #getSuggestedMinimumHeight()
10210 * @see #getSuggestedMinimumWidth()
10211 * @see android.view.View.MeasureSpec#getMode(int)
10212 * @see android.view.View.MeasureSpec#getSize(int)
10213 */
10214 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
10215 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
10216 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
10217 }
10218
10219 /**
10220 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
10221 * measured width and measured height. Failing to do so will trigger an
10222 * exception at measurement time.</p>
10223 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080010224 * @param measuredWidth The measured width of this view. May be a complex
10225 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
10226 * {@link #MEASURED_STATE_TOO_SMALL}.
10227 * @param measuredHeight The measured height of this view. May be a complex
10228 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
10229 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010230 */
10231 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
10232 mMeasuredWidth = measuredWidth;
10233 mMeasuredHeight = measuredHeight;
10234
10235 mPrivateFlags |= MEASURED_DIMENSION_SET;
10236 }
10237
10238 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080010239 * Merge two states as returned by {@link #getMeasuredState()}.
10240 * @param curState The current state as returned from a view or the result
10241 * of combining multiple views.
10242 * @param newState The new view state to combine.
10243 * @return Returns a new integer reflecting the combination of the two
10244 * states.
10245 */
10246 public static int combineMeasuredStates(int curState, int newState) {
10247 return curState | newState;
10248 }
10249
10250 /**
10251 * Version of {@link #resolveSizeAndState(int, int, int)}
10252 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
10253 */
10254 public static int resolveSize(int size, int measureSpec) {
10255 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
10256 }
10257
10258 /**
10259 * Utility to reconcile a desired size and state, with constraints imposed
10260 * by a MeasureSpec. Will take the desired size, unless a different size
10261 * is imposed by the constraints. The returned value is a compound integer,
10262 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
10263 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
10264 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010265 *
10266 * @param size How big the view wants to be
10267 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080010268 * @return Size information bit mask as defined by
10269 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010270 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080010271 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010272 int result = size;
10273 int specMode = MeasureSpec.getMode(measureSpec);
10274 int specSize = MeasureSpec.getSize(measureSpec);
10275 switch (specMode) {
10276 case MeasureSpec.UNSPECIFIED:
10277 result = size;
10278 break;
10279 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080010280 if (specSize < size) {
10281 result = specSize | MEASURED_STATE_TOO_SMALL;
10282 } else {
10283 result = size;
10284 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010285 break;
10286 case MeasureSpec.EXACTLY:
10287 result = specSize;
10288 break;
10289 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080010290 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010291 }
10292
10293 /**
10294 * Utility to return a default size. Uses the supplied size if the
10295 * MeasureSpec imposed no contraints. Will get larger if allowed
10296 * by the MeasureSpec.
10297 *
10298 * @param size Default size for this view
10299 * @param measureSpec Constraints imposed by the parent
10300 * @return The size this view should be.
10301 */
10302 public static int getDefaultSize(int size, int measureSpec) {
10303 int result = size;
10304 int specMode = MeasureSpec.getMode(measureSpec);
10305 int specSize = MeasureSpec.getSize(measureSpec);
10306
10307 switch (specMode) {
10308 case MeasureSpec.UNSPECIFIED:
10309 result = size;
10310 break;
10311 case MeasureSpec.AT_MOST:
10312 case MeasureSpec.EXACTLY:
10313 result = specSize;
10314 break;
10315 }
10316 return result;
10317 }
10318
10319 /**
10320 * Returns the suggested minimum height that the view should use. This
10321 * returns the maximum of the view's minimum height
10322 * and the background's minimum height
10323 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
10324 * <p>
10325 * When being used in {@link #onMeasure(int, int)}, the caller should still
10326 * ensure the returned height is within the requirements of the parent.
10327 *
10328 * @return The suggested minimum height of the view.
10329 */
10330 protected int getSuggestedMinimumHeight() {
10331 int suggestedMinHeight = mMinHeight;
10332
10333 if (mBGDrawable != null) {
10334 final int bgMinHeight = mBGDrawable.getMinimumHeight();
10335 if (suggestedMinHeight < bgMinHeight) {
10336 suggestedMinHeight = bgMinHeight;
10337 }
10338 }
10339
10340 return suggestedMinHeight;
10341 }
10342
10343 /**
10344 * Returns the suggested minimum width that the view should use. This
10345 * returns the maximum of the view's minimum width)
10346 * and the background's minimum width
10347 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
10348 * <p>
10349 * When being used in {@link #onMeasure(int, int)}, the caller should still
10350 * ensure the returned width is within the requirements of the parent.
10351 *
10352 * @return The suggested minimum width of the view.
10353 */
10354 protected int getSuggestedMinimumWidth() {
10355 int suggestedMinWidth = mMinWidth;
10356
10357 if (mBGDrawable != null) {
10358 final int bgMinWidth = mBGDrawable.getMinimumWidth();
10359 if (suggestedMinWidth < bgMinWidth) {
10360 suggestedMinWidth = bgMinWidth;
10361 }
10362 }
10363
10364 return suggestedMinWidth;
10365 }
10366
10367 /**
10368 * Sets the minimum height of the view. It is not guaranteed the view will
10369 * be able to achieve this minimum height (for example, if its parent layout
10370 * constrains it with less available height).
10371 *
10372 * @param minHeight The minimum height the view will try to be.
10373 */
10374 public void setMinimumHeight(int minHeight) {
10375 mMinHeight = minHeight;
10376 }
10377
10378 /**
10379 * Sets the minimum width of the view. It is not guaranteed the view will
10380 * be able to achieve this minimum width (for example, if its parent layout
10381 * constrains it with less available width).
10382 *
10383 * @param minWidth The minimum width the view will try to be.
10384 */
10385 public void setMinimumWidth(int minWidth) {
10386 mMinWidth = minWidth;
10387 }
10388
10389 /**
10390 * Get the animation currently associated with this view.
10391 *
10392 * @return The animation that is currently playing or
10393 * scheduled to play for this view.
10394 */
10395 public Animation getAnimation() {
10396 return mCurrentAnimation;
10397 }
10398
10399 /**
10400 * Start the specified animation now.
10401 *
10402 * @param animation the animation to start now
10403 */
10404 public void startAnimation(Animation animation) {
10405 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
10406 setAnimation(animation);
10407 invalidate();
10408 }
10409
10410 /**
10411 * Cancels any animations for this view.
10412 */
10413 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080010414 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080010415 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080010416 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010417 mCurrentAnimation = null;
10418 }
10419
10420 /**
10421 * Sets the next animation to play for this view.
10422 * If you want the animation to play immediately, use
10423 * startAnimation. This method provides allows fine-grained
10424 * control over the start time and invalidation, but you
10425 * must make sure that 1) the animation has a start time set, and
10426 * 2) the view will be invalidated when the animation is supposed to
10427 * start.
10428 *
10429 * @param animation The next animation, or null.
10430 */
10431 public void setAnimation(Animation animation) {
10432 mCurrentAnimation = animation;
10433 if (animation != null) {
10434 animation.reset();
10435 }
10436 }
10437
10438 /**
10439 * Invoked by a parent ViewGroup to notify the start of the animation
10440 * currently associated with this view. If you override this method,
10441 * always call super.onAnimationStart();
10442 *
10443 * @see #setAnimation(android.view.animation.Animation)
10444 * @see #getAnimation()
10445 */
10446 protected void onAnimationStart() {
10447 mPrivateFlags |= ANIMATION_STARTED;
10448 }
10449
10450 /**
10451 * Invoked by a parent ViewGroup to notify the end of the animation
10452 * currently associated with this view. If you override this method,
10453 * always call super.onAnimationEnd();
10454 *
10455 * @see #setAnimation(android.view.animation.Animation)
10456 * @see #getAnimation()
10457 */
10458 protected void onAnimationEnd() {
10459 mPrivateFlags &= ~ANIMATION_STARTED;
10460 }
10461
10462 /**
10463 * Invoked if there is a Transform that involves alpha. Subclass that can
10464 * draw themselves with the specified alpha should return true, and then
10465 * respect that alpha when their onDraw() is called. If this returns false
10466 * then the view may be redirected to draw into an offscreen buffer to
10467 * fulfill the request, which will look fine, but may be slower than if the
10468 * subclass handles it internally. The default implementation returns false.
10469 *
10470 * @param alpha The alpha (0..255) to apply to the view's drawing
10471 * @return true if the view can draw with the specified alpha.
10472 */
10473 protected boolean onSetAlpha(int alpha) {
10474 return false;
10475 }
10476
10477 /**
10478 * This is used by the RootView to perform an optimization when
10479 * the view hierarchy contains one or several SurfaceView.
10480 * SurfaceView is always considered transparent, but its children are not,
10481 * therefore all View objects remove themselves from the global transparent
10482 * region (passed as a parameter to this function).
10483 *
10484 * @param region The transparent region for this ViewRoot (window).
10485 *
10486 * @return Returns true if the effective visibility of the view at this
10487 * point is opaque, regardless of the transparent region; returns false
10488 * if it is possible for underlying windows to be seen behind the view.
10489 *
10490 * {@hide}
10491 */
10492 public boolean gatherTransparentRegion(Region region) {
10493 final AttachInfo attachInfo = mAttachInfo;
10494 if (region != null && attachInfo != null) {
10495 final int pflags = mPrivateFlags;
10496 if ((pflags & SKIP_DRAW) == 0) {
10497 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
10498 // remove it from the transparent region.
10499 final int[] location = attachInfo.mTransparentLocation;
10500 getLocationInWindow(location);
10501 region.op(location[0], location[1], location[0] + mRight - mLeft,
10502 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
10503 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) {
10504 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
10505 // exists, so we remove the background drawable's non-transparent
10506 // parts from this transparent region.
10507 applyDrawableToTransparentRegion(mBGDrawable, region);
10508 }
10509 }
10510 return true;
10511 }
10512
10513 /**
10514 * Play a sound effect for this view.
10515 *
10516 * <p>The framework will play sound effects for some built in actions, such as
10517 * clicking, but you may wish to play these effects in your widget,
10518 * for instance, for internal navigation.
10519 *
10520 * <p>The sound effect will only be played if sound effects are enabled by the user, and
10521 * {@link #isSoundEffectsEnabled()} is true.
10522 *
10523 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
10524 */
10525 public void playSoundEffect(int soundConstant) {
10526 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
10527 return;
10528 }
10529 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
10530 }
10531
10532 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010533 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070010534 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010535 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010536 *
10537 * <p>The framework will provide haptic feedback for some built in actions,
10538 * such as long presses, but you may wish to provide feedback for your
10539 * own widget.
10540 *
10541 * <p>The feedback will only be performed if
10542 * {@link #isHapticFeedbackEnabled()} is true.
10543 *
10544 * @param feedbackConstant One of the constants defined in
10545 * {@link HapticFeedbackConstants}
10546 */
10547 public boolean performHapticFeedback(int feedbackConstant) {
10548 return performHapticFeedback(feedbackConstant, 0);
10549 }
10550
10551 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010552 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070010553 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010554 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010555 *
10556 * @param feedbackConstant One of the constants defined in
10557 * {@link HapticFeedbackConstants}
10558 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
10559 */
10560 public boolean performHapticFeedback(int feedbackConstant, int flags) {
10561 if (mAttachInfo == null) {
10562 return false;
10563 }
Romain Guyf607bdc2010-09-10 19:20:06 -070010564 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070010565 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010566 && !isHapticFeedbackEnabled()) {
10567 return false;
10568 }
Romain Guy812ccbe2010-06-01 14:07:24 -070010569 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
10570 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010571 }
10572
10573 /**
Christopher Tate2c095f32010-10-04 14:13:40 -070010574 * !!! TODO: real docs
10575 *
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010576 * The base class implementation makes the shadow the same size and appearance
Christopher Tate2c095f32010-10-04 14:13:40 -070010577 * as the view itself, and positions it with its center at the touch point.
10578 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010579 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070010580 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070010581
10582 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010583 * Construct a shadow builder object for use with the given view.
Christopher Tate2c095f32010-10-04 14:13:40 -070010584 * @param view
10585 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010586 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070010587 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070010588 }
10589
Chris Tate6b391282010-10-14 15:48:59 -070010590 final public View getView() {
10591 return mView.get();
10592 }
10593
Christopher Tate2c095f32010-10-04 14:13:40 -070010594 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010595 * Provide the draggable-shadow metrics for the operation: the dimensions of
10596 * the shadow image itself, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070010597 * be centered under the touch location while dragging.
10598 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010599 * The default implementation sets the dimensions of the shadow to be the
10600 * same as the dimensions of the View itself and centers the shadow under
Christopher Tate2c095f32010-10-04 14:13:40 -070010601 * the touch point.
10602 *
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010603 * @param shadowSize The application should set the {@code x} member of this
10604 * parameter to the desired shadow width, and the {@code y} member to
Christopher Tate2c095f32010-10-04 14:13:40 -070010605 * the desired height.
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010606 * @param shadowTouchPoint The application should set this point to be the
10607 * location within the shadow that should track directly underneath
Christopher Tate2c095f32010-10-04 14:13:40 -070010608 * the touch point on the screen during a drag.
10609 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010610 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070010611 final View view = mView.get();
10612 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010613 shadowSize.set(view.getWidth(), view.getHeight());
10614 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070010615 } else {
10616 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
10617 }
Christopher Tate2c095f32010-10-04 14:13:40 -070010618 }
10619
10620 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010621 * Draw the shadow image for the upcoming drag. The shadow canvas was
10622 * created with the dimensions supplied by the
10623 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate2c095f32010-10-04 14:13:40 -070010624 *
10625 * @param canvas
10626 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010627 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070010628 final View view = mView.get();
10629 if (view != null) {
10630 view.draw(canvas);
10631 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010632 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070010633 }
Christopher Tate2c095f32010-10-04 14:13:40 -070010634 }
10635 }
10636
10637 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010638 * Drag and drop. App calls startDrag(), then callbacks to the shadow builder's
10639 * {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} and
10640 * {@link DragShadowBuilder#onDrawShadow(Canvas)} methods happen, then the drag
Christopher Tate5ada6cb2010-10-05 14:15:29 -070010641 * operation is handed over to the OS.
Christopher Tatea53146c2010-09-07 11:57:52 -070010642 * !!! TODO: real docs
Christopher Tate407b4e92010-11-30 17:14:08 -080010643 *
10644 * @param data !!! TODO
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010645 * @param shadowBuilder !!! TODO
Christopher Tate407b4e92010-11-30 17:14:08 -080010646 * @param myLocalState An arbitrary object that will be passed as part of every DragEvent
10647 * delivered to the calling application during the course of the current drag operation.
10648 * This object is private to the application that called startDrag(), and is not
10649 * visible to other applications. It provides a lightweight way for the application to
10650 * propagate information from the initiator to the recipient of a drag within its own
10651 * application; for example, to help disambiguate between 'copy' and 'move' semantics.
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010652 * @param flags Flags affecting the drag operation. At present no flags are defined;
10653 * pass 0 for this parameter.
Christopher Tate407b4e92010-11-30 17:14:08 -080010654 * @return {@code true} if the drag operation was initiated successfully; {@code false} if
10655 * an error prevented the drag from taking place.
Christopher Tatea53146c2010-09-07 11:57:52 -070010656 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010657 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010658 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070010659 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010660 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070010661 }
10662 boolean okay = false;
10663
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010664 Point shadowSize = new Point();
10665 Point shadowTouchPoint = new Point();
10666 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070010667
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010668 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
10669 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
10670 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070010671 }
Christopher Tatea53146c2010-09-07 11:57:52 -070010672
Chris Tatea32dcf72010-10-14 12:13:50 -070010673 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010674 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
10675 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070010676 }
Christopher Tatea53146c2010-09-07 11:57:52 -070010677 Surface surface = new Surface();
10678 try {
10679 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010680 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070010681 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070010682 + " surface=" + surface);
10683 if (token != null) {
10684 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070010685 try {
Chris Tate6b391282010-10-14 15:48:59 -070010686 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010687 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070010688 } finally {
10689 surface.unlockCanvasAndPost(canvas);
10690 }
Christopher Tatea53146c2010-09-07 11:57:52 -070010691
Christopher Tate407b4e92010-11-30 17:14:08 -080010692 final ViewRoot root = getViewRoot();
10693
10694 // Cache the local state object for delivery with DragEvents
10695 root.setLocalDragState(myLocalState);
10696
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010697 // repurpose 'shadowSize' for the last touch point
10698 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070010699
Christopher Tatea53146c2010-09-07 11:57:52 -070010700 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010701 shadowSize.x, shadowSize.y,
10702 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070010703 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tatea53146c2010-09-07 11:57:52 -070010704 }
10705 } catch (Exception e) {
10706 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
10707 surface.destroy();
10708 }
10709
10710 return okay;
10711 }
10712
Christopher Tatea53146c2010-09-07 11:57:52 -070010713 /**
10714 * Drag-and-drop event dispatch. The event.getAction() verb is one of the DragEvent
10715 * constants DRAG_STARTED_EVENT, DRAG_EVENT, DROP_EVENT, and DRAG_ENDED_EVENT.
10716 *
10717 * For DRAG_STARTED_EVENT, event.getClipDescription() describes the content
10718 * being dragged. onDragEvent() should return 'true' if the view can handle
10719 * a drop of that content. A view that returns 'false' here will receive no
10720 * further calls to onDragEvent() about the drag/drop operation.
10721 *
10722 * For DRAG_ENTERED, event.getClipDescription() describes the content being
10723 * dragged. This will be the same content description passed in the
10724 * DRAG_STARTED_EVENT invocation.
10725 *
10726 * For DRAG_EXITED, event.getClipDescription() describes the content being
10727 * dragged. This will be the same content description passed in the
10728 * DRAG_STARTED_EVENT invocation. The view should return to its approriate
10729 * drag-acceptance visual state.
10730 *
10731 * For DRAG_LOCATION_EVENT, event.getX() and event.getY() give the location in View
10732 * coordinates of the current drag point. The view must return 'true' if it
10733 * can accept a drop of the current drag content, false otherwise.
10734 *
10735 * For DROP_EVENT, event.getX() and event.getY() give the location of the drop
10736 * within the view; also, event.getClipData() returns the full data payload
10737 * being dropped. The view should return 'true' if it consumed the dropped
10738 * content, 'false' if it did not.
10739 *
10740 * For DRAG_ENDED_EVENT, the 'event' argument may be null. The view should return
10741 * to its normal visual state.
10742 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070010743 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070010744 return false;
10745 }
10746
10747 /**
10748 * Views typically don't need to override dispatchDragEvent(); it just calls
Chris Tate32affef2010-10-18 15:29:21 -070010749 * onDragEvent(event) and passes the result up appropriately.
Christopher Tatea53146c2010-09-07 11:57:52 -070010750 */
10751 public boolean dispatchDragEvent(DragEvent event) {
Chris Tate32affef2010-10-18 15:29:21 -070010752 if (mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
10753 && mOnDragListener.onDrag(this, event)) {
10754 return true;
10755 }
Christopher Tatea53146c2010-09-07 11:57:52 -070010756 return onDragEvent(event);
10757 }
10758
10759 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070010760 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
10761 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070010762 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070010763 */
10764 public void onCloseSystemDialogs(String reason) {
10765 }
10766
10767 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010768 * Given a Drawable whose bounds have been set to draw into this view,
10769 * update a Region being computed for {@link #gatherTransparentRegion} so
10770 * that any non-transparent parts of the Drawable are removed from the
10771 * given transparent region.
10772 *
10773 * @param dr The Drawable whose transparency is to be applied to the region.
10774 * @param region A Region holding the current transparency information,
10775 * where any parts of the region that are set are considered to be
10776 * transparent. On return, this region will be modified to have the
10777 * transparency information reduced by the corresponding parts of the
10778 * Drawable that are not transparent.
10779 * {@hide}
10780 */
10781 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
10782 if (DBG) {
10783 Log.i("View", "Getting transparent region for: " + this);
10784 }
10785 final Region r = dr.getTransparentRegion();
10786 final Rect db = dr.getBounds();
10787 final AttachInfo attachInfo = mAttachInfo;
10788 if (r != null && attachInfo != null) {
10789 final int w = getRight()-getLeft();
10790 final int h = getBottom()-getTop();
10791 if (db.left > 0) {
10792 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
10793 r.op(0, 0, db.left, h, Region.Op.UNION);
10794 }
10795 if (db.right < w) {
10796 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
10797 r.op(db.right, 0, w, h, Region.Op.UNION);
10798 }
10799 if (db.top > 0) {
10800 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
10801 r.op(0, 0, w, db.top, Region.Op.UNION);
10802 }
10803 if (db.bottom < h) {
10804 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
10805 r.op(0, db.bottom, w, h, Region.Op.UNION);
10806 }
10807 final int[] location = attachInfo.mTransparentLocation;
10808 getLocationInWindow(location);
10809 r.translate(location[0], location[1]);
10810 region.op(r, Region.Op.INTERSECT);
10811 } else {
10812 region.op(db, Region.Op.DIFFERENCE);
10813 }
10814 }
10815
Adam Powelle14579b2009-12-16 18:39:52 -080010816 private void postCheckForLongClick(int delayOffset) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010817 mHasPerformedLongPress = false;
10818
10819 if (mPendingCheckForLongPress == null) {
10820 mPendingCheckForLongPress = new CheckForLongPress();
10821 }
10822 mPendingCheckForLongPress.rememberWindowAttachCount();
Adam Powelle14579b2009-12-16 18:39:52 -080010823 postDelayed(mPendingCheckForLongPress,
10824 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010825 }
10826
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010827 /**
10828 * Inflate a view from an XML resource. This convenience method wraps the {@link
10829 * LayoutInflater} class, which provides a full range of options for view inflation.
10830 *
10831 * @param context The Context object for your activity or application.
10832 * @param resource The resource ID to inflate
10833 * @param root A view group that will be the parent. Used to properly inflate the
10834 * layout_* parameters.
10835 * @see LayoutInflater
10836 */
10837 public static View inflate(Context context, int resource, ViewGroup root) {
10838 LayoutInflater factory = LayoutInflater.from(context);
10839 return factory.inflate(resource, root);
10840 }
Romain Guy33e72ae2010-07-17 12:40:29 -070010841
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010842 /**
Adam Powell637d3372010-08-25 14:37:03 -070010843 * Scroll the view with standard behavior for scrolling beyond the normal
10844 * content boundaries. Views that call this method should override
10845 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
10846 * results of an over-scroll operation.
10847 *
10848 * Views can use this method to handle any touch or fling-based scrolling.
10849 *
10850 * @param deltaX Change in X in pixels
10851 * @param deltaY Change in Y in pixels
10852 * @param scrollX Current X scroll value in pixels before applying deltaX
10853 * @param scrollY Current Y scroll value in pixels before applying deltaY
10854 * @param scrollRangeX Maximum content scroll range along the X axis
10855 * @param scrollRangeY Maximum content scroll range along the Y axis
10856 * @param maxOverScrollX Number of pixels to overscroll by in either direction
10857 * along the X axis.
10858 * @param maxOverScrollY Number of pixels to overscroll by in either direction
10859 * along the Y axis.
10860 * @param isTouchEvent true if this scroll operation is the result of a touch event.
10861 * @return true if scrolling was clamped to an over-scroll boundary along either
10862 * axis, false otherwise.
10863 */
10864 protected boolean overScrollBy(int deltaX, int deltaY,
10865 int scrollX, int scrollY,
10866 int scrollRangeX, int scrollRangeY,
10867 int maxOverScrollX, int maxOverScrollY,
10868 boolean isTouchEvent) {
10869 final int overScrollMode = mOverScrollMode;
10870 final boolean canScrollHorizontal =
10871 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
10872 final boolean canScrollVertical =
10873 computeVerticalScrollRange() > computeVerticalScrollExtent();
10874 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
10875 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
10876 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
10877 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
10878
10879 int newScrollX = scrollX + deltaX;
10880 if (!overScrollHorizontal) {
10881 maxOverScrollX = 0;
10882 }
10883
10884 int newScrollY = scrollY + deltaY;
10885 if (!overScrollVertical) {
10886 maxOverScrollY = 0;
10887 }
10888
10889 // Clamp values if at the limits and record
10890 final int left = -maxOverScrollX;
10891 final int right = maxOverScrollX + scrollRangeX;
10892 final int top = -maxOverScrollY;
10893 final int bottom = maxOverScrollY + scrollRangeY;
10894
10895 boolean clampedX = false;
10896 if (newScrollX > right) {
10897 newScrollX = right;
10898 clampedX = true;
10899 } else if (newScrollX < left) {
10900 newScrollX = left;
10901 clampedX = true;
10902 }
10903
10904 boolean clampedY = false;
10905 if (newScrollY > bottom) {
10906 newScrollY = bottom;
10907 clampedY = true;
10908 } else if (newScrollY < top) {
10909 newScrollY = top;
10910 clampedY = true;
10911 }
10912
10913 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
10914
10915 return clampedX || clampedY;
10916 }
10917
10918 /**
10919 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
10920 * respond to the results of an over-scroll operation.
10921 *
10922 * @param scrollX New X scroll value in pixels
10923 * @param scrollY New Y scroll value in pixels
10924 * @param clampedX True if scrollX was clamped to an over-scroll boundary
10925 * @param clampedY True if scrollY was clamped to an over-scroll boundary
10926 */
10927 protected void onOverScrolled(int scrollX, int scrollY,
10928 boolean clampedX, boolean clampedY) {
10929 // Intentionally empty.
10930 }
10931
10932 /**
10933 * Returns the over-scroll mode for this view. The result will be
10934 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
10935 * (allow over-scrolling only if the view content is larger than the container),
10936 * or {@link #OVER_SCROLL_NEVER}.
10937 *
10938 * @return This view's over-scroll mode.
10939 */
10940 public int getOverScrollMode() {
10941 return mOverScrollMode;
10942 }
10943
10944 /**
10945 * Set the over-scroll mode for this view. Valid over-scroll modes are
10946 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
10947 * (allow over-scrolling only if the view content is larger than the container),
10948 * or {@link #OVER_SCROLL_NEVER}.
10949 *
10950 * Setting the over-scroll mode of a view will have an effect only if the
10951 * view is capable of scrolling.
10952 *
10953 * @param overScrollMode The new over-scroll mode for this view.
10954 */
10955 public void setOverScrollMode(int overScrollMode) {
10956 if (overScrollMode != OVER_SCROLL_ALWAYS &&
10957 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
10958 overScrollMode != OVER_SCROLL_NEVER) {
10959 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
10960 }
10961 mOverScrollMode = overScrollMode;
10962 }
10963
10964 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010965 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
10966 * Each MeasureSpec represents a requirement for either the width or the height.
10967 * A MeasureSpec is comprised of a size and a mode. There are three possible
10968 * modes:
10969 * <dl>
10970 * <dt>UNSPECIFIED</dt>
10971 * <dd>
10972 * The parent has not imposed any constraint on the child. It can be whatever size
10973 * it wants.
10974 * </dd>
10975 *
10976 * <dt>EXACTLY</dt>
10977 * <dd>
10978 * The parent has determined an exact size for the child. The child is going to be
10979 * given those bounds regardless of how big it wants to be.
10980 * </dd>
10981 *
10982 * <dt>AT_MOST</dt>
10983 * <dd>
10984 * The child can be as large as it wants up to the specified size.
10985 * </dd>
10986 * </dl>
10987 *
10988 * MeasureSpecs are implemented as ints to reduce object allocation. This class
10989 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
10990 */
10991 public static class MeasureSpec {
10992 private static final int MODE_SHIFT = 30;
10993 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
10994
10995 /**
10996 * Measure specification mode: The parent has not imposed any constraint
10997 * on the child. It can be whatever size it wants.
10998 */
10999 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
11000
11001 /**
11002 * Measure specification mode: The parent has determined an exact size
11003 * for the child. The child is going to be given those bounds regardless
11004 * of how big it wants to be.
11005 */
11006 public static final int EXACTLY = 1 << MODE_SHIFT;
11007
11008 /**
11009 * Measure specification mode: The child can be as large as it wants up
11010 * to the specified size.
11011 */
11012 public static final int AT_MOST = 2 << MODE_SHIFT;
11013
11014 /**
11015 * Creates a measure specification based on the supplied size and mode.
11016 *
11017 * The mode must always be one of the following:
11018 * <ul>
11019 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
11020 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
11021 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
11022 * </ul>
11023 *
11024 * @param size the size of the measure specification
11025 * @param mode the mode of the measure specification
11026 * @return the measure specification based on size and mode
11027 */
11028 public static int makeMeasureSpec(int size, int mode) {
11029 return size + mode;
11030 }
11031
11032 /**
11033 * Extracts the mode from the supplied measure specification.
11034 *
11035 * @param measureSpec the measure specification to extract the mode from
11036 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
11037 * {@link android.view.View.MeasureSpec#AT_MOST} or
11038 * {@link android.view.View.MeasureSpec#EXACTLY}
11039 */
11040 public static int getMode(int measureSpec) {
11041 return (measureSpec & MODE_MASK);
11042 }
11043
11044 /**
11045 * Extracts the size from the supplied measure specification.
11046 *
11047 * @param measureSpec the measure specification to extract the size from
11048 * @return the size in pixels defined in the supplied measure specification
11049 */
11050 public static int getSize(int measureSpec) {
11051 return (measureSpec & ~MODE_MASK);
11052 }
11053
11054 /**
11055 * Returns a String representation of the specified measure
11056 * specification.
11057 *
11058 * @param measureSpec the measure specification to convert to a String
11059 * @return a String with the following format: "MeasureSpec: MODE SIZE"
11060 */
11061 public static String toString(int measureSpec) {
11062 int mode = getMode(measureSpec);
11063 int size = getSize(measureSpec);
11064
11065 StringBuilder sb = new StringBuilder("MeasureSpec: ");
11066
11067 if (mode == UNSPECIFIED)
11068 sb.append("UNSPECIFIED ");
11069 else if (mode == EXACTLY)
11070 sb.append("EXACTLY ");
11071 else if (mode == AT_MOST)
11072 sb.append("AT_MOST ");
11073 else
11074 sb.append(mode).append(" ");
11075
11076 sb.append(size);
11077 return sb.toString();
11078 }
11079 }
11080
11081 class CheckForLongPress implements Runnable {
11082
11083 private int mOriginalWindowAttachCount;
11084
11085 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070011086 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011087 && mOriginalWindowAttachCount == mWindowAttachCount) {
11088 if (performLongClick()) {
11089 mHasPerformedLongPress = true;
11090 }
11091 }
11092 }
11093
11094 public void rememberWindowAttachCount() {
11095 mOriginalWindowAttachCount = mWindowAttachCount;
11096 }
11097 }
Adam Powelle14579b2009-12-16 18:39:52 -080011098
11099 private final class CheckForTap implements Runnable {
11100 public void run() {
11101 mPrivateFlags &= ~PREPRESSED;
11102 mPrivateFlags |= PRESSED;
11103 refreshDrawableState();
11104 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
11105 postCheckForLongClick(ViewConfiguration.getTapTimeout());
11106 }
11107 }
11108 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011109
Adam Powella35d7682010-03-12 14:48:13 -080011110 private final class PerformClick implements Runnable {
11111 public void run() {
11112 performClick();
11113 }
11114 }
11115
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011116 /**
11117 * Interface definition for a callback to be invoked when a key event is
11118 * dispatched to this view. The callback will be invoked before the key
11119 * event is given to the view.
11120 */
11121 public interface OnKeyListener {
11122 /**
11123 * Called when a key is dispatched to a view. This allows listeners to
11124 * get a chance to respond before the target view.
11125 *
11126 * @param v The view the key has been dispatched to.
11127 * @param keyCode The code for the physical key that was pressed
11128 * @param event The KeyEvent object containing full information about
11129 * the event.
11130 * @return True if the listener has consumed the event, false otherwise.
11131 */
11132 boolean onKey(View v, int keyCode, KeyEvent event);
11133 }
11134
11135 /**
11136 * Interface definition for a callback to be invoked when a touch event is
11137 * dispatched to this view. The callback will be invoked before the touch
11138 * event is given to the view.
11139 */
11140 public interface OnTouchListener {
11141 /**
11142 * Called when a touch event is dispatched to a view. This allows listeners to
11143 * get a chance to respond before the target view.
11144 *
11145 * @param v The view the touch event has been dispatched to.
11146 * @param event The MotionEvent object containing full information about
11147 * the event.
11148 * @return True if the listener has consumed the event, false otherwise.
11149 */
11150 boolean onTouch(View v, MotionEvent event);
11151 }
11152
11153 /**
11154 * Interface definition for a callback to be invoked when a view has been clicked and held.
11155 */
11156 public interface OnLongClickListener {
11157 /**
11158 * Called when a view has been clicked and held.
11159 *
11160 * @param v The view that was clicked and held.
11161 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080011162 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011163 */
11164 boolean onLongClick(View v);
11165 }
11166
11167 /**
Chris Tate32affef2010-10-18 15:29:21 -070011168 * Interface definition for a callback to be invoked when a drag is being dispatched
11169 * to this view. The callback will be invoked before the hosting view's own
11170 * onDrag(event) method. If the listener wants to fall back to the hosting view's
11171 * onDrag(event) behavior, it should return 'false' from this callback.
11172 */
11173 public interface OnDragListener {
11174 /**
11175 * Called when a drag event is dispatched to a view. This allows listeners
11176 * to get a chance to override base View behavior.
11177 *
11178 * @param v The view the drag has been dispatched to.
11179 * @param event The DragEvent object containing full information
11180 * about the event.
11181 * @return true if the listener consumed the DragEvent, false in order to fall
11182 * back to the view's default handling.
11183 */
11184 boolean onDrag(View v, DragEvent event);
11185 }
11186
11187 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011188 * Interface definition for a callback to be invoked when the focus state of
11189 * a view changed.
11190 */
11191 public interface OnFocusChangeListener {
11192 /**
11193 * Called when the focus state of a view has changed.
11194 *
11195 * @param v The view whose state has changed.
11196 * @param hasFocus The new focus state of v.
11197 */
11198 void onFocusChange(View v, boolean hasFocus);
11199 }
11200
11201 /**
11202 * Interface definition for a callback to be invoked when a view is clicked.
11203 */
11204 public interface OnClickListener {
11205 /**
11206 * Called when a view has been clicked.
11207 *
11208 * @param v The view that was clicked.
11209 */
11210 void onClick(View v);
11211 }
11212
11213 /**
11214 * Interface definition for a callback to be invoked when the context menu
11215 * for this view is being built.
11216 */
11217 public interface OnCreateContextMenuListener {
11218 /**
11219 * Called when the context menu for this view is being built. It is not
11220 * safe to hold onto the menu after this method returns.
11221 *
11222 * @param menu The context menu that is being built
11223 * @param v The view for which the context menu is being built
11224 * @param menuInfo Extra information about the item for which the
11225 * context menu should be shown. This information will vary
11226 * depending on the class of v.
11227 */
11228 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
11229 }
11230
11231 private final class UnsetPressedState implements Runnable {
11232 public void run() {
11233 setPressed(false);
11234 }
11235 }
11236
11237 /**
11238 * Base class for derived classes that want to save and restore their own
11239 * state in {@link android.view.View#onSaveInstanceState()}.
11240 */
11241 public static class BaseSavedState extends AbsSavedState {
11242 /**
11243 * Constructor used when reading from a parcel. Reads the state of the superclass.
11244 *
11245 * @param source
11246 */
11247 public BaseSavedState(Parcel source) {
11248 super(source);
11249 }
11250
11251 /**
11252 * Constructor called by derived classes when creating their SavedState objects
11253 *
11254 * @param superState The state of the superclass of this view
11255 */
11256 public BaseSavedState(Parcelable superState) {
11257 super(superState);
11258 }
11259
11260 public static final Parcelable.Creator<BaseSavedState> CREATOR =
11261 new Parcelable.Creator<BaseSavedState>() {
11262 public BaseSavedState createFromParcel(Parcel in) {
11263 return new BaseSavedState(in);
11264 }
11265
11266 public BaseSavedState[] newArray(int size) {
11267 return new BaseSavedState[size];
11268 }
11269 };
11270 }
11271
11272 /**
11273 * A set of information given to a view when it is attached to its parent
11274 * window.
11275 */
11276 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011277 interface Callbacks {
11278 void playSoundEffect(int effectId);
11279 boolean performHapticFeedback(int effectId, boolean always);
11280 }
11281
11282 /**
11283 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
11284 * to a Handler. This class contains the target (View) to invalidate and
11285 * the coordinates of the dirty rectangle.
11286 *
11287 * For performance purposes, this class also implements a pool of up to
11288 * POOL_LIMIT objects that get reused. This reduces memory allocations
11289 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011290 */
Romain Guyd928d682009-03-31 17:52:16 -070011291 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011292 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070011293 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
11294 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070011295 public InvalidateInfo newInstance() {
11296 return new InvalidateInfo();
11297 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011298
Romain Guyd928d682009-03-31 17:52:16 -070011299 public void onAcquired(InvalidateInfo element) {
11300 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011301
Romain Guyd928d682009-03-31 17:52:16 -070011302 public void onReleased(InvalidateInfo element) {
11303 }
11304 }, POOL_LIMIT)
11305 );
11306
11307 private InvalidateInfo mNext;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011308
11309 View target;
11310
11311 int left;
11312 int top;
11313 int right;
11314 int bottom;
11315
Romain Guyd928d682009-03-31 17:52:16 -070011316 public void setNextPoolable(InvalidateInfo element) {
11317 mNext = element;
11318 }
11319
11320 public InvalidateInfo getNextPoolable() {
11321 return mNext;
11322 }
11323
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011324 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070011325 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011326 }
11327
11328 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070011329 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011330 }
11331 }
11332
11333 final IWindowSession mSession;
11334
11335 final IWindow mWindow;
11336
11337 final IBinder mWindowToken;
11338
11339 final Callbacks mRootCallbacks;
11340
11341 /**
11342 * The top view of the hierarchy.
11343 */
11344 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070011345
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011346 IBinder mPanelParentWindowToken;
11347 Surface mSurface;
11348
Romain Guyb051e892010-09-28 19:09:36 -070011349 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011350 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070011351 HardwareRenderer mHardwareRenderer;
Romain Guy2bffd262010-09-12 17:40:02 -070011352
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011353 /**
Romain Guy8506ab42009-06-11 17:35:47 -070011354 * Scale factor used by the compatibility mode
11355 */
11356 float mApplicationScale;
11357
11358 /**
11359 * Indicates whether the application is in compatibility mode
11360 */
11361 boolean mScalingRequired;
11362
11363 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011364 * Left position of this view's window
11365 */
11366 int mWindowLeft;
11367
11368 /**
11369 * Top position of this view's window
11370 */
11371 int mWindowTop;
11372
11373 /**
Adam Powell26153a32010-11-08 15:22:27 -080011374 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070011375 */
Adam Powell26153a32010-11-08 15:22:27 -080011376 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070011377
11378 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011379 * For windows that are full-screen but using insets to layout inside
11380 * of the screen decorations, these are the current insets for the
11381 * content of the window.
11382 */
11383 final Rect mContentInsets = new Rect();
11384
11385 /**
11386 * For windows that are full-screen but using insets to layout inside
11387 * of the screen decorations, these are the current insets for the
11388 * actual visible parts of the window.
11389 */
11390 final Rect mVisibleInsets = new Rect();
11391
11392 /**
11393 * The internal insets given by this window. This value is
11394 * supplied by the client (through
11395 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
11396 * be given to the window manager when changed to be used in laying
11397 * out windows behind it.
11398 */
11399 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
11400 = new ViewTreeObserver.InternalInsetsInfo();
11401
11402 /**
11403 * All views in the window's hierarchy that serve as scroll containers,
11404 * used to determine if the window can be resized or must be panned
11405 * to adjust for a soft input area.
11406 */
11407 final ArrayList<View> mScrollContainers = new ArrayList<View>();
11408
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070011409 final KeyEvent.DispatcherState mKeyDispatchState
11410 = new KeyEvent.DispatcherState();
11411
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011412 /**
11413 * Indicates whether the view's window currently has the focus.
11414 */
11415 boolean mHasWindowFocus;
11416
11417 /**
11418 * The current visibility of the window.
11419 */
11420 int mWindowVisibility;
11421
11422 /**
11423 * Indicates the time at which drawing started to occur.
11424 */
11425 long mDrawingTime;
11426
11427 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070011428 * Indicates whether or not ignoring the DIRTY_MASK flags.
11429 */
11430 boolean mIgnoreDirtyState;
11431
11432 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011433 * Indicates whether the view's window is currently in touch mode.
11434 */
11435 boolean mInTouchMode;
11436
11437 /**
11438 * Indicates that ViewRoot should trigger a global layout change
11439 * the next time it performs a traversal
11440 */
11441 boolean mRecomputeGlobalAttributes;
11442
11443 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011444 * Set during a traveral if any views want to keep the screen on.
11445 */
11446 boolean mKeepScreenOn;
11447
11448 /**
11449 * Set if the visibility of any views has changed.
11450 */
11451 boolean mViewVisibilityChanged;
11452
11453 /**
11454 * Set to true if a view has been scrolled.
11455 */
11456 boolean mViewScrollChanged;
11457
11458 /**
11459 * Global to the view hierarchy used as a temporary for dealing with
11460 * x/y points in the transparent region computations.
11461 */
11462 final int[] mTransparentLocation = new int[2];
11463
11464 /**
11465 * Global to the view hierarchy used as a temporary for dealing with
11466 * x/y points in the ViewGroup.invalidateChild implementation.
11467 */
11468 final int[] mInvalidateChildLocation = new int[2];
11469
Chet Haasec3aa3612010-06-17 08:50:37 -070011470
11471 /**
11472 * Global to the view hierarchy used as a temporary for dealing with
11473 * x/y location when view is transformed.
11474 */
11475 final float[] mTmpTransformLocation = new float[2];
11476
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011477 /**
11478 * The view tree observer used to dispatch global events like
11479 * layout, pre-draw, touch mode change, etc.
11480 */
11481 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
11482
11483 /**
11484 * A Canvas used by the view hierarchy to perform bitmap caching.
11485 */
11486 Canvas mCanvas;
11487
11488 /**
11489 * A Handler supplied by a view's {@link android.view.ViewRoot}. This
11490 * handler can be used to pump events in the UI events queue.
11491 */
11492 final Handler mHandler;
11493
11494 /**
11495 * Identifier for messages requesting the view to be invalidated.
11496 * Such messages should be sent to {@link #mHandler}.
11497 */
11498 static final int INVALIDATE_MSG = 0x1;
11499
11500 /**
11501 * Identifier for messages requesting the view to invalidate a region.
11502 * Such messages should be sent to {@link #mHandler}.
11503 */
11504 static final int INVALIDATE_RECT_MSG = 0x2;
11505
11506 /**
11507 * Temporary for use in computing invalidate rectangles while
11508 * calling up the hierarchy.
11509 */
11510 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070011511
11512 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070011513 * Temporary for use in computing hit areas with transformed views
11514 */
11515 final RectF mTmpTransformRect = new RectF();
11516
11517 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070011518 * Temporary list for use in collecting focusable descendents of a view.
11519 */
11520 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24);
11521
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011522 /**
11523 * Creates a new set of attachment information with the specified
11524 * events handler and thread.
11525 *
11526 * @param handler the events handler the view must use
11527 */
11528 AttachInfo(IWindowSession session, IWindow window,
11529 Handler handler, Callbacks effectPlayer) {
11530 mSession = session;
11531 mWindow = window;
11532 mWindowToken = window.asBinder();
11533 mHandler = handler;
11534 mRootCallbacks = effectPlayer;
11535 }
11536 }
11537
11538 /**
11539 * <p>ScrollabilityCache holds various fields used by a View when scrolling
11540 * is supported. This avoids keeping too many unused fields in most
11541 * instances of View.</p>
11542 */
Mike Cleronf116bf82009-09-27 19:14:12 -070011543 private static class ScrollabilityCache implements Runnable {
11544
11545 /**
11546 * Scrollbars are not visible
11547 */
11548 public static final int OFF = 0;
11549
11550 /**
11551 * Scrollbars are visible
11552 */
11553 public static final int ON = 1;
11554
11555 /**
11556 * Scrollbars are fading away
11557 */
11558 public static final int FADING = 2;
11559
11560 public boolean fadeScrollBars;
11561
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011562 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070011563 public int scrollBarDefaultDelayBeforeFade;
11564 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011565
11566 public int scrollBarSize;
11567 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070011568 public float[] interpolatorValues;
11569 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011570
11571 public final Paint paint;
11572 public final Matrix matrix;
11573 public Shader shader;
11574
Mike Cleronf116bf82009-09-27 19:14:12 -070011575 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
11576
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080011577 private static final float[] OPAQUE = { 255 };
11578 private static final float[] TRANSPARENT = { 0.0f };
Mike Cleronf116bf82009-09-27 19:14:12 -070011579
11580 /**
11581 * When fading should start. This time moves into the future every time
11582 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
11583 */
11584 public long fadeStartTime;
11585
11586
11587 /**
11588 * The current state of the scrollbars: ON, OFF, or FADING
11589 */
11590 public int state = OFF;
11591
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011592 private int mLastColor;
11593
Mike Cleronf116bf82009-09-27 19:14:12 -070011594 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011595 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
11596 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070011597 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
11598 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011599
11600 paint = new Paint();
11601 matrix = new Matrix();
11602 // use use a height of 1, and then wack the matrix each time we
11603 // actually use it.
11604 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070011605
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011606 paint.setShader(shader);
11607 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070011608 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011609 }
Romain Guy8506ab42009-06-11 17:35:47 -070011610
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011611 public void setFadeColor(int color) {
11612 if (color != 0 && color != mLastColor) {
11613 mLastColor = color;
11614 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070011615
Romain Guye55e1a72009-08-27 10:42:26 -070011616 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
11617 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070011618
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011619 paint.setShader(shader);
11620 // Restore the default transfer mode (src_over)
11621 paint.setXfermode(null);
11622 }
11623 }
Mike Cleronf116bf82009-09-27 19:14:12 -070011624
11625 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070011626 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070011627 if (now >= fadeStartTime) {
11628
11629 // the animation fades the scrollbars out by changing
11630 // the opacity (alpha) from fully opaque to fully
11631 // transparent
11632 int nextFrame = (int) now;
11633 int framesCount = 0;
11634
11635 Interpolator interpolator = scrollBarInterpolator;
11636
11637 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080011638 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070011639
11640 // End transparent
11641 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080011642 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070011643
11644 state = FADING;
11645
11646 // Kick off the fade animation
11647 host.invalidate();
11648 }
11649 }
11650
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011651 }
11652}