blob: b41687e4dabeb2a8d67fb1a23bab476fdafa29da [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) {
Svetoslav Ganov9cd1eca2011-01-13 14:24:02 -08003263 if (!isShown()) {
3264 return;
3265 }
svetoslavganov75986cf2009-05-14 22:28:01 -07003266 event.setClassName(getClass().getName());
3267 event.setPackageName(getContext().getPackageName());
3268 event.setEnabled(isEnabled());
3269 event.setContentDescription(mContentDescription);
3270
3271 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) {
3272 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList;
3273 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, FOCUSABLES_ALL);
3274 event.setItemCount(focusablesTempList.size());
3275 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
3276 focusablesTempList.clear();
3277 }
3278
3279 dispatchPopulateAccessibilityEvent(event);
3280
3281 AccessibilityManager.getInstance(mContext).sendAccessibilityEvent(event);
3282 }
3283
3284 /**
3285 * Dispatches an {@link AccessibilityEvent} to the {@link View} children
3286 * to be populated.
3287 *
3288 * @param event The event.
3289 *
3290 * @return True if the event population was completed.
3291 */
3292 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
3293 return false;
3294 }
3295
3296 /**
3297 * Gets the {@link View} description. It briefly describes the view and is
3298 * primarily used for accessibility support. Set this property to enable
3299 * better accessibility support for your application. This is especially
3300 * true for views that do not have textual representation (For example,
3301 * ImageButton).
3302 *
3303 * @return The content descriptiopn.
3304 *
3305 * @attr ref android.R.styleable#View_contentDescription
3306 */
3307 public CharSequence getContentDescription() {
3308 return mContentDescription;
3309 }
3310
3311 /**
3312 * Sets the {@link View} description. It briefly describes the view and is
3313 * primarily used for accessibility support. Set this property to enable
3314 * better accessibility support for your application. This is especially
3315 * true for views that do not have textual representation (For example,
3316 * ImageButton).
3317 *
3318 * @param contentDescription The content description.
3319 *
3320 * @attr ref android.R.styleable#View_contentDescription
3321 */
3322 public void setContentDescription(CharSequence contentDescription) {
3323 mContentDescription = contentDescription;
3324 }
3325
3326 /**
Romain Guya2431d02009-04-30 16:30:00 -07003327 * Invoked whenever this view loses focus, either by losing window focus or by losing
3328 * focus within its window. This method can be used to clear any state tied to the
3329 * focus. For instance, if a button is held pressed with the trackball and the window
3330 * loses focus, this method can be used to cancel the press.
3331 *
3332 * Subclasses of View overriding this method should always call super.onFocusLost().
3333 *
3334 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07003335 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07003336 *
3337 * @hide pending API council approval
3338 */
3339 protected void onFocusLost() {
3340 resetPressedState();
3341 }
3342
3343 private void resetPressedState() {
3344 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
3345 return;
3346 }
3347
3348 if (isPressed()) {
3349 setPressed(false);
3350
3351 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05003352 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07003353 }
3354 }
3355 }
3356
3357 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003358 * Returns true if this view has focus
3359 *
3360 * @return True if this view has focus, false otherwise.
3361 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003362 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003363 public boolean isFocused() {
3364 return (mPrivateFlags & FOCUSED) != 0;
3365 }
3366
3367 /**
3368 * Find the view in the hierarchy rooted at this view that currently has
3369 * focus.
3370 *
3371 * @return The view that currently has focus, or null if no focused view can
3372 * be found.
3373 */
3374 public View findFocus() {
3375 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
3376 }
3377
3378 /**
3379 * Change whether this view is one of the set of scrollable containers in
3380 * its window. This will be used to determine whether the window can
3381 * resize or must pan when a soft input area is open -- scrollable
3382 * containers allow the window to use resize mode since the container
3383 * will appropriately shrink.
3384 */
3385 public void setScrollContainer(boolean isScrollContainer) {
3386 if (isScrollContainer) {
3387 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
3388 mAttachInfo.mScrollContainers.add(this);
3389 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
3390 }
3391 mPrivateFlags |= SCROLL_CONTAINER;
3392 } else {
3393 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
3394 mAttachInfo.mScrollContainers.remove(this);
3395 }
3396 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
3397 }
3398 }
3399
3400 /**
3401 * Returns the quality of the drawing cache.
3402 *
3403 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3404 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3405 *
3406 * @see #setDrawingCacheQuality(int)
3407 * @see #setDrawingCacheEnabled(boolean)
3408 * @see #isDrawingCacheEnabled()
3409 *
3410 * @attr ref android.R.styleable#View_drawingCacheQuality
3411 */
3412 public int getDrawingCacheQuality() {
3413 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
3414 }
3415
3416 /**
3417 * Set the drawing cache quality of this view. This value is used only when the
3418 * drawing cache is enabled
3419 *
3420 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3421 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3422 *
3423 * @see #getDrawingCacheQuality()
3424 * @see #setDrawingCacheEnabled(boolean)
3425 * @see #isDrawingCacheEnabled()
3426 *
3427 * @attr ref android.R.styleable#View_drawingCacheQuality
3428 */
3429 public void setDrawingCacheQuality(int quality) {
3430 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
3431 }
3432
3433 /**
3434 * Returns whether the screen should remain on, corresponding to the current
3435 * value of {@link #KEEP_SCREEN_ON}.
3436 *
3437 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
3438 *
3439 * @see #setKeepScreenOn(boolean)
3440 *
3441 * @attr ref android.R.styleable#View_keepScreenOn
3442 */
3443 public boolean getKeepScreenOn() {
3444 return (mViewFlags & KEEP_SCREEN_ON) != 0;
3445 }
3446
3447 /**
3448 * Controls whether the screen should remain on, modifying the
3449 * value of {@link #KEEP_SCREEN_ON}.
3450 *
3451 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
3452 *
3453 * @see #getKeepScreenOn()
3454 *
3455 * @attr ref android.R.styleable#View_keepScreenOn
3456 */
3457 public void setKeepScreenOn(boolean keepScreenOn) {
3458 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
3459 }
3460
3461 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003462 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
3463 * @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 -08003464 *
3465 * @attr ref android.R.styleable#View_nextFocusLeft
3466 */
3467 public int getNextFocusLeftId() {
3468 return mNextFocusLeftId;
3469 }
3470
3471 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003472 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
3473 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
3474 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003475 *
3476 * @attr ref android.R.styleable#View_nextFocusLeft
3477 */
3478 public void setNextFocusLeftId(int nextFocusLeftId) {
3479 mNextFocusLeftId = nextFocusLeftId;
3480 }
3481
3482 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003483 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
3484 * @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 -08003485 *
3486 * @attr ref android.R.styleable#View_nextFocusRight
3487 */
3488 public int getNextFocusRightId() {
3489 return mNextFocusRightId;
3490 }
3491
3492 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003493 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
3494 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
3495 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003496 *
3497 * @attr ref android.R.styleable#View_nextFocusRight
3498 */
3499 public void setNextFocusRightId(int nextFocusRightId) {
3500 mNextFocusRightId = nextFocusRightId;
3501 }
3502
3503 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003504 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
3505 * @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 -08003506 *
3507 * @attr ref android.R.styleable#View_nextFocusUp
3508 */
3509 public int getNextFocusUpId() {
3510 return mNextFocusUpId;
3511 }
3512
3513 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003514 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
3515 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
3516 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003517 *
3518 * @attr ref android.R.styleable#View_nextFocusUp
3519 */
3520 public void setNextFocusUpId(int nextFocusUpId) {
3521 mNextFocusUpId = nextFocusUpId;
3522 }
3523
3524 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003525 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
3526 * @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 -08003527 *
3528 * @attr ref android.R.styleable#View_nextFocusDown
3529 */
3530 public int getNextFocusDownId() {
3531 return mNextFocusDownId;
3532 }
3533
3534 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003535 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
3536 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
3537 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003538 *
3539 * @attr ref android.R.styleable#View_nextFocusDown
3540 */
3541 public void setNextFocusDownId(int nextFocusDownId) {
3542 mNextFocusDownId = nextFocusDownId;
3543 }
3544
3545 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003546 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
3547 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
3548 *
3549 * @attr ref android.R.styleable#View_nextFocusForward
3550 */
3551 public int getNextFocusForwardId() {
3552 return mNextFocusForwardId;
3553 }
3554
3555 /**
3556 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
3557 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
3558 * decide automatically.
3559 *
3560 * @attr ref android.R.styleable#View_nextFocusForward
3561 */
3562 public void setNextFocusForwardId(int nextFocusForwardId) {
3563 mNextFocusForwardId = nextFocusForwardId;
3564 }
3565
3566 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003567 * Returns the visibility of this view and all of its ancestors
3568 *
3569 * @return True if this view and all of its ancestors are {@link #VISIBLE}
3570 */
3571 public boolean isShown() {
3572 View current = this;
3573 //noinspection ConstantConditions
3574 do {
3575 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
3576 return false;
3577 }
3578 ViewParent parent = current.mParent;
3579 if (parent == null) {
3580 return false; // We are not attached to the view root
3581 }
3582 if (!(parent instanceof View)) {
3583 return true;
3584 }
3585 current = (View) parent;
3586 } while (current != null);
3587
3588 return false;
3589 }
3590
3591 /**
3592 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag
3593 * is set
3594 *
3595 * @param insets Insets for system windows
3596 *
3597 * @return True if this view applied the insets, false otherwise
3598 */
3599 protected boolean fitSystemWindows(Rect insets) {
3600 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
3601 mPaddingLeft = insets.left;
3602 mPaddingTop = insets.top;
3603 mPaddingRight = insets.right;
3604 mPaddingBottom = insets.bottom;
3605 requestLayout();
3606 return true;
3607 }
3608 return false;
3609 }
3610
3611 /**
Jim Miller0b2a6d02010-07-13 18:01:29 -07003612 * Determine if this view has the FITS_SYSTEM_WINDOWS flag set.
3613 * @return True if window has FITS_SYSTEM_WINDOWS set
3614 *
3615 * @hide
3616 */
3617 public boolean isFitsSystemWindowsFlagSet() {
3618 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
3619 }
3620
3621 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003622 * Returns the visibility status for this view.
3623 *
3624 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3625 * @attr ref android.R.styleable#View_visibility
3626 */
3627 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07003628 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
3629 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
3630 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003631 })
3632 public int getVisibility() {
3633 return mViewFlags & VISIBILITY_MASK;
3634 }
3635
3636 /**
3637 * Set the enabled state of this view.
3638 *
3639 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3640 * @attr ref android.R.styleable#View_visibility
3641 */
3642 @RemotableViewMethod
3643 public void setVisibility(int visibility) {
3644 setFlags(visibility, VISIBILITY_MASK);
3645 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false);
3646 }
3647
3648 /**
3649 * Returns the enabled status for this view. The interpretation of the
3650 * enabled state varies by subclass.
3651 *
3652 * @return True if this view is enabled, false otherwise.
3653 */
3654 @ViewDebug.ExportedProperty
3655 public boolean isEnabled() {
3656 return (mViewFlags & ENABLED_MASK) == ENABLED;
3657 }
3658
3659 /**
3660 * Set the enabled state of this view. The interpretation of the enabled
3661 * state varies by subclass.
3662 *
3663 * @param enabled True if this view is enabled, false otherwise.
3664 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08003665 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003666 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07003667 if (enabled == isEnabled()) return;
3668
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003669 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
3670
3671 /*
3672 * The View most likely has to change its appearance, so refresh
3673 * the drawable state.
3674 */
3675 refreshDrawableState();
3676
3677 // Invalidate too, since the default behavior for views is to be
3678 // be drawn at 50% alpha rather than to change the drawable.
3679 invalidate();
3680 }
3681
3682 /**
3683 * Set whether this view can receive the focus.
3684 *
3685 * Setting this to false will also ensure that this view is not focusable
3686 * in touch mode.
3687 *
3688 * @param focusable If true, this view can receive the focus.
3689 *
3690 * @see #setFocusableInTouchMode(boolean)
3691 * @attr ref android.R.styleable#View_focusable
3692 */
3693 public void setFocusable(boolean focusable) {
3694 if (!focusable) {
3695 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
3696 }
3697 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
3698 }
3699
3700 /**
3701 * Set whether this view can receive focus while in touch mode.
3702 *
3703 * Setting this to true will also ensure that this view is focusable.
3704 *
3705 * @param focusableInTouchMode If true, this view can receive the focus while
3706 * in touch mode.
3707 *
3708 * @see #setFocusable(boolean)
3709 * @attr ref android.R.styleable#View_focusableInTouchMode
3710 */
3711 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
3712 // Focusable in touch mode should always be set before the focusable flag
3713 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
3714 // which, in touch mode, will not successfully request focus on this view
3715 // because the focusable in touch mode flag is not set
3716 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
3717 if (focusableInTouchMode) {
3718 setFlags(FOCUSABLE, FOCUSABLE_MASK);
3719 }
3720 }
3721
3722 /**
3723 * Set whether this view should have sound effects enabled for events such as
3724 * clicking and touching.
3725 *
3726 * <p>You may wish to disable sound effects for a view if you already play sounds,
3727 * for instance, a dial key that plays dtmf tones.
3728 *
3729 * @param soundEffectsEnabled whether sound effects are enabled for this view.
3730 * @see #isSoundEffectsEnabled()
3731 * @see #playSoundEffect(int)
3732 * @attr ref android.R.styleable#View_soundEffectsEnabled
3733 */
3734 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
3735 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
3736 }
3737
3738 /**
3739 * @return whether this view should have sound effects enabled for events such as
3740 * clicking and touching.
3741 *
3742 * @see #setSoundEffectsEnabled(boolean)
3743 * @see #playSoundEffect(int)
3744 * @attr ref android.R.styleable#View_soundEffectsEnabled
3745 */
3746 @ViewDebug.ExportedProperty
3747 public boolean isSoundEffectsEnabled() {
3748 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
3749 }
3750
3751 /**
3752 * Set whether this view should have haptic feedback for events such as
3753 * long presses.
3754 *
3755 * <p>You may wish to disable haptic feedback if your view already controls
3756 * its own haptic feedback.
3757 *
3758 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
3759 * @see #isHapticFeedbackEnabled()
3760 * @see #performHapticFeedback(int)
3761 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3762 */
3763 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
3764 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
3765 }
3766
3767 /**
3768 * @return whether this view should have haptic feedback enabled for events
3769 * long presses.
3770 *
3771 * @see #setHapticFeedbackEnabled(boolean)
3772 * @see #performHapticFeedback(int)
3773 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3774 */
3775 @ViewDebug.ExportedProperty
3776 public boolean isHapticFeedbackEnabled() {
3777 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
3778 }
3779
3780 /**
3781 * If this view doesn't do any drawing on its own, set this flag to
3782 * allow further optimizations. By default, this flag is not set on
3783 * View, but could be set on some View subclasses such as ViewGroup.
3784 *
3785 * Typically, if you override {@link #onDraw} you should clear this flag.
3786 *
3787 * @param willNotDraw whether or not this View draw on its own
3788 */
3789 public void setWillNotDraw(boolean willNotDraw) {
3790 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
3791 }
3792
3793 /**
3794 * Returns whether or not this View draws on its own.
3795 *
3796 * @return true if this view has nothing to draw, false otherwise
3797 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003798 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003799 public boolean willNotDraw() {
3800 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
3801 }
3802
3803 /**
3804 * When a View's drawing cache is enabled, drawing is redirected to an
3805 * offscreen bitmap. Some views, like an ImageView, must be able to
3806 * bypass this mechanism if they already draw a single bitmap, to avoid
3807 * unnecessary usage of the memory.
3808 *
3809 * @param willNotCacheDrawing true if this view does not cache its
3810 * drawing, false otherwise
3811 */
3812 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
3813 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
3814 }
3815
3816 /**
3817 * Returns whether or not this View can cache its drawing or not.
3818 *
3819 * @return true if this view does not cache its drawing, false otherwise
3820 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003821 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003822 public boolean willNotCacheDrawing() {
3823 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
3824 }
3825
3826 /**
3827 * Indicates whether this view reacts to click events or not.
3828 *
3829 * @return true if the view is clickable, false otherwise
3830 *
3831 * @see #setClickable(boolean)
3832 * @attr ref android.R.styleable#View_clickable
3833 */
3834 @ViewDebug.ExportedProperty
3835 public boolean isClickable() {
3836 return (mViewFlags & CLICKABLE) == CLICKABLE;
3837 }
3838
3839 /**
3840 * Enables or disables click events for this view. When a view
3841 * is clickable it will change its state to "pressed" on every click.
3842 * Subclasses should set the view clickable to visually react to
3843 * user's clicks.
3844 *
3845 * @param clickable true to make the view clickable, false otherwise
3846 *
3847 * @see #isClickable()
3848 * @attr ref android.R.styleable#View_clickable
3849 */
3850 public void setClickable(boolean clickable) {
3851 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
3852 }
3853
3854 /**
3855 * Indicates whether this view reacts to long click events or not.
3856 *
3857 * @return true if the view is long clickable, false otherwise
3858 *
3859 * @see #setLongClickable(boolean)
3860 * @attr ref android.R.styleable#View_longClickable
3861 */
3862 public boolean isLongClickable() {
3863 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
3864 }
3865
3866 /**
3867 * Enables or disables long click events for this view. When a view is long
3868 * clickable it reacts to the user holding down the button for a longer
3869 * duration than a tap. This event can either launch the listener or a
3870 * context menu.
3871 *
3872 * @param longClickable true to make the view long clickable, false otherwise
3873 * @see #isLongClickable()
3874 * @attr ref android.R.styleable#View_longClickable
3875 */
3876 public void setLongClickable(boolean longClickable) {
3877 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
3878 }
3879
3880 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07003881 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003882 *
3883 * @see #isClickable()
3884 * @see #setClickable(boolean)
3885 *
3886 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
3887 * the View's internal state from a previously set "pressed" state.
3888 */
3889 public void setPressed(boolean pressed) {
3890 if (pressed) {
3891 mPrivateFlags |= PRESSED;
3892 } else {
3893 mPrivateFlags &= ~PRESSED;
3894 }
3895 refreshDrawableState();
3896 dispatchSetPressed(pressed);
3897 }
3898
3899 /**
3900 * Dispatch setPressed to all of this View's children.
3901 *
3902 * @see #setPressed(boolean)
3903 *
3904 * @param pressed The new pressed state
3905 */
3906 protected void dispatchSetPressed(boolean pressed) {
3907 }
3908
3909 /**
3910 * Indicates whether the view is currently in pressed state. Unless
3911 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
3912 * the pressed state.
3913 *
3914 * @see #setPressed
3915 * @see #isClickable()
3916 * @see #setClickable(boolean)
3917 *
3918 * @return true if the view is currently pressed, false otherwise
3919 */
3920 public boolean isPressed() {
3921 return (mPrivateFlags & PRESSED) == PRESSED;
3922 }
3923
3924 /**
3925 * Indicates whether this view will save its state (that is,
3926 * whether its {@link #onSaveInstanceState} method will be called).
3927 *
3928 * @return Returns true if the view state saving is enabled, else false.
3929 *
3930 * @see #setSaveEnabled(boolean)
3931 * @attr ref android.R.styleable#View_saveEnabled
3932 */
3933 public boolean isSaveEnabled() {
3934 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
3935 }
3936
3937 /**
3938 * Controls whether the saving of this view's state is
3939 * enabled (that is, whether its {@link #onSaveInstanceState} method
3940 * will be called). Note that even if freezing is enabled, the
3941 * view still must have an id assigned to it (via {@link #setId setId()})
3942 * for its state to be saved. This flag can only disable the
3943 * saving of this view; any child views may still have their state saved.
3944 *
3945 * @param enabled Set to false to <em>disable</em> state saving, or true
3946 * (the default) to allow it.
3947 *
3948 * @see #isSaveEnabled()
3949 * @see #setId(int)
3950 * @see #onSaveInstanceState()
3951 * @attr ref android.R.styleable#View_saveEnabled
3952 */
3953 public void setSaveEnabled(boolean enabled) {
3954 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
3955 }
3956
Jeff Brown85a31762010-09-01 17:01:00 -07003957 /**
3958 * Gets whether the framework should discard touches when the view's
3959 * window is obscured by another visible window.
3960 * Refer to the {@link View} security documentation for more details.
3961 *
3962 * @return True if touch filtering is enabled.
3963 *
3964 * @see #setFilterTouchesWhenObscured(boolean)
3965 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
3966 */
3967 @ViewDebug.ExportedProperty
3968 public boolean getFilterTouchesWhenObscured() {
3969 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
3970 }
3971
3972 /**
3973 * Sets whether the framework should discard touches when the view's
3974 * window is obscured by another visible window.
3975 * Refer to the {@link View} security documentation for more details.
3976 *
3977 * @param enabled True if touch filtering should be enabled.
3978 *
3979 * @see #getFilterTouchesWhenObscured
3980 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
3981 */
3982 public void setFilterTouchesWhenObscured(boolean enabled) {
3983 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
3984 FILTER_TOUCHES_WHEN_OBSCURED);
3985 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003986
3987 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07003988 * Indicates whether the entire hierarchy under this view will save its
3989 * state when a state saving traversal occurs from its parent. The default
3990 * is true; if false, these views will not be saved unless
3991 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
3992 *
3993 * @return Returns true if the view state saving from parent is enabled, else false.
3994 *
3995 * @see #setSaveFromParentEnabled(boolean)
3996 */
3997 public boolean isSaveFromParentEnabled() {
3998 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
3999 }
4000
4001 /**
4002 * Controls whether the entire hierarchy under this view will save its
4003 * state when a state saving traversal occurs from its parent. The default
4004 * is true; if false, these views will not be saved unless
4005 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4006 *
4007 * @param enabled Set to false to <em>disable</em> state saving, or true
4008 * (the default) to allow it.
4009 *
4010 * @see #isSaveFromParentEnabled()
4011 * @see #setId(int)
4012 * @see #onSaveInstanceState()
4013 */
4014 public void setSaveFromParentEnabled(boolean enabled) {
4015 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
4016 }
4017
4018
4019 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004020 * Returns whether this View is able to take focus.
4021 *
4022 * @return True if this view can take focus, or false otherwise.
4023 * @attr ref android.R.styleable#View_focusable
4024 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004025 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004026 public final boolean isFocusable() {
4027 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
4028 }
4029
4030 /**
4031 * When a view is focusable, it may not want to take focus when in touch mode.
4032 * For example, a button would like focus when the user is navigating via a D-pad
4033 * so that the user can click on it, but once the user starts touching the screen,
4034 * the button shouldn't take focus
4035 * @return Whether the view is focusable in touch mode.
4036 * @attr ref android.R.styleable#View_focusableInTouchMode
4037 */
4038 @ViewDebug.ExportedProperty
4039 public final boolean isFocusableInTouchMode() {
4040 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
4041 }
4042
4043 /**
4044 * Find the nearest view in the specified direction that can take focus.
4045 * This does not actually give focus to that view.
4046 *
4047 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4048 *
4049 * @return The nearest focusable in the specified direction, or null if none
4050 * can be found.
4051 */
4052 public View focusSearch(int direction) {
4053 if (mParent != null) {
4054 return mParent.focusSearch(this, direction);
4055 } else {
4056 return null;
4057 }
4058 }
4059
4060 /**
4061 * This method is the last chance for the focused view and its ancestors to
4062 * respond to an arrow key. This is called when the focused view did not
4063 * consume the key internally, nor could the view system find a new view in
4064 * the requested direction to give focus to.
4065 *
4066 * @param focused The currently focused view.
4067 * @param direction The direction focus wants to move. One of FOCUS_UP,
4068 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
4069 * @return True if the this view consumed this unhandled move.
4070 */
4071 public boolean dispatchUnhandledMove(View focused, int direction) {
4072 return false;
4073 }
4074
4075 /**
4076 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08004077 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004078 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08004079 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
4080 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004081 * @return The user specified next view, or null if there is none.
4082 */
4083 View findUserSetNextFocus(View root, int direction) {
4084 switch (direction) {
4085 case FOCUS_LEFT:
4086 if (mNextFocusLeftId == View.NO_ID) return null;
4087 return findViewShouldExist(root, mNextFocusLeftId);
4088 case FOCUS_RIGHT:
4089 if (mNextFocusRightId == View.NO_ID) return null;
4090 return findViewShouldExist(root, mNextFocusRightId);
4091 case FOCUS_UP:
4092 if (mNextFocusUpId == View.NO_ID) return null;
4093 return findViewShouldExist(root, mNextFocusUpId);
4094 case FOCUS_DOWN:
4095 if (mNextFocusDownId == View.NO_ID) return null;
4096 return findViewShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08004097 case FOCUS_FORWARD:
4098 if (mNextFocusForwardId == View.NO_ID) return null;
4099 return findViewShouldExist(root, mNextFocusForwardId);
4100 case FOCUS_BACKWARD: {
4101 final int id = mID;
4102 return root.findViewByPredicate(new Predicate<View>() {
4103 @Override
4104 public boolean apply(View t) {
4105 return t.mNextFocusForwardId == id;
4106 }
4107 });
4108 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004109 }
4110 return null;
4111 }
4112
4113 private static View findViewShouldExist(View root, int childViewId) {
4114 View result = root.findViewById(childViewId);
4115 if (result == null) {
4116 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
4117 + "by user for id " + childViewId);
4118 }
4119 return result;
4120 }
4121
4122 /**
4123 * Find and return all focusable views that are descendants of this view,
4124 * possibly including this view if it is focusable itself.
4125 *
4126 * @param direction The direction of the focus
4127 * @return A list of focusable views
4128 */
4129 public ArrayList<View> getFocusables(int direction) {
4130 ArrayList<View> result = new ArrayList<View>(24);
4131 addFocusables(result, direction);
4132 return result;
4133 }
4134
4135 /**
4136 * Add any focusable views that are descendants of this view (possibly
4137 * including this view if it is focusable itself) to views. If we are in touch mode,
4138 * only add views that are also focusable in touch mode.
4139 *
4140 * @param views Focusable views found so far
4141 * @param direction The direction of the focus
4142 */
4143 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004144 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
4145 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004146
svetoslavganov75986cf2009-05-14 22:28:01 -07004147 /**
4148 * Adds any focusable views that are descendants of this view (possibly
4149 * including this view if it is focusable itself) to views. This method
4150 * adds all focusable views regardless if we are in touch mode or
4151 * only views focusable in touch mode if we are in touch mode depending on
4152 * the focusable mode paramater.
4153 *
4154 * @param views Focusable views found so far or null if all we are interested is
4155 * the number of focusables.
4156 * @param direction The direction of the focus.
4157 * @param focusableMode The type of focusables to be added.
4158 *
4159 * @see #FOCUSABLES_ALL
4160 * @see #FOCUSABLES_TOUCH_MODE
4161 */
4162 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
4163 if (!isFocusable()) {
4164 return;
4165 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004166
svetoslavganov75986cf2009-05-14 22:28:01 -07004167 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE &&
4168 isInTouchMode() && !isFocusableInTouchMode()) {
4169 return;
4170 }
4171
4172 if (views != null) {
4173 views.add(this);
4174 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004175 }
4176
4177 /**
4178 * Find and return all touchable views that are descendants of this view,
4179 * possibly including this view if it is touchable itself.
4180 *
4181 * @return A list of touchable views
4182 */
4183 public ArrayList<View> getTouchables() {
4184 ArrayList<View> result = new ArrayList<View>();
4185 addTouchables(result);
4186 return result;
4187 }
4188
4189 /**
4190 * Add any touchable views that are descendants of this view (possibly
4191 * including this view if it is touchable itself) to views.
4192 *
4193 * @param views Touchable views found so far
4194 */
4195 public void addTouchables(ArrayList<View> views) {
4196 final int viewFlags = mViewFlags;
4197
4198 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
4199 && (viewFlags & ENABLED_MASK) == ENABLED) {
4200 views.add(this);
4201 }
4202 }
4203
4204 /**
4205 * Call this to try to give focus to a specific view or to one of its
4206 * descendants.
4207 *
4208 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4209 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4210 * while the device is in touch mode.
4211 *
4212 * See also {@link #focusSearch}, which is what you call to say that you
4213 * have focus, and you want your parent to look for the next one.
4214 *
4215 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
4216 * {@link #FOCUS_DOWN} and <code>null</code>.
4217 *
4218 * @return Whether this view or one of its descendants actually took focus.
4219 */
4220 public final boolean requestFocus() {
4221 return requestFocus(View.FOCUS_DOWN);
4222 }
4223
4224
4225 /**
4226 * Call this to try to give focus to a specific view or to one of its
4227 * descendants and give it a hint about what direction focus is heading.
4228 *
4229 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4230 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4231 * while the device is in touch mode.
4232 *
4233 * See also {@link #focusSearch}, which is what you call to say that you
4234 * have focus, and you want your parent to look for the next one.
4235 *
4236 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
4237 * <code>null</code> set for the previously focused rectangle.
4238 *
4239 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4240 * @return Whether this view or one of its descendants actually took focus.
4241 */
4242 public final boolean requestFocus(int direction) {
4243 return requestFocus(direction, null);
4244 }
4245
4246 /**
4247 * Call this to try to give focus to a specific view or to one of its descendants
4248 * and give it hints about the direction and a specific rectangle that the focus
4249 * is coming from. The rectangle can help give larger views a finer grained hint
4250 * about where focus is coming from, and therefore, where to show selection, or
4251 * forward focus change internally.
4252 *
4253 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4254 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4255 * while the device is in touch mode.
4256 *
4257 * A View will not take focus if it is not visible.
4258 *
4259 * A View will not take focus if one of its parents has {@link android.view.ViewGroup#getDescendantFocusability()}
4260 * equal to {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
4261 *
4262 * See also {@link #focusSearch}, which is what you call to say that you
4263 * have focus, and you want your parent to look for the next one.
4264 *
4265 * You may wish to override this method if your custom {@link View} has an internal
4266 * {@link View} that it wishes to forward the request to.
4267 *
4268 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4269 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
4270 * to give a finer grained hint about where focus is coming from. May be null
4271 * if there is no hint.
4272 * @return Whether this view or one of its descendants actually took focus.
4273 */
4274 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
4275 // need to be focusable
4276 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
4277 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
4278 return false;
4279 }
4280
4281 // need to be focusable in touch mode if in touch mode
4282 if (isInTouchMode() &&
4283 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
4284 return false;
4285 }
4286
4287 // need to not have any parents blocking us
4288 if (hasAncestorThatBlocksDescendantFocus()) {
4289 return false;
4290 }
4291
4292 handleFocusGainInternal(direction, previouslyFocusedRect);
4293 return true;
4294 }
4295
Christopher Tate2c095f32010-10-04 14:13:40 -07004296 /** Gets the ViewRoot, or null if not attached. */
4297 /*package*/ ViewRoot getViewRoot() {
4298 View root = getRootView();
4299 return root != null ? (ViewRoot)root.getParent() : null;
4300 }
4301
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004302 /**
4303 * Call this to try to give focus to a specific view or to one of its descendants. This is a
4304 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
4305 * touch mode to request focus when they are touched.
4306 *
4307 * @return Whether this view or one of its descendants actually took focus.
4308 *
4309 * @see #isInTouchMode()
4310 *
4311 */
4312 public final boolean requestFocusFromTouch() {
4313 // Leave touch mode if we need to
4314 if (isInTouchMode()) {
Christopher Tate2c095f32010-10-04 14:13:40 -07004315 ViewRoot viewRoot = getViewRoot();
4316 if (viewRoot != null) {
4317 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004318 }
4319 }
4320 return requestFocus(View.FOCUS_DOWN);
4321 }
4322
4323 /**
4324 * @return Whether any ancestor of this view blocks descendant focus.
4325 */
4326 private boolean hasAncestorThatBlocksDescendantFocus() {
4327 ViewParent ancestor = mParent;
4328 while (ancestor instanceof ViewGroup) {
4329 final ViewGroup vgAncestor = (ViewGroup) ancestor;
4330 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
4331 return true;
4332 } else {
4333 ancestor = vgAncestor.getParent();
4334 }
4335 }
4336 return false;
4337 }
4338
4339 /**
Romain Guya440b002010-02-24 15:57:54 -08004340 * @hide
4341 */
4342 public void dispatchStartTemporaryDetach() {
4343 onStartTemporaryDetach();
4344 }
4345
4346 /**
4347 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004348 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
4349 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08004350 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004351 */
4352 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08004353 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08004354 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08004355 }
4356
4357 /**
4358 * @hide
4359 */
4360 public void dispatchFinishTemporaryDetach() {
4361 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004362 }
Romain Guy8506ab42009-06-11 17:35:47 -07004363
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004364 /**
4365 * Called after {@link #onStartTemporaryDetach} when the container is done
4366 * changing the view.
4367 */
4368 public void onFinishTemporaryDetach() {
4369 }
Romain Guy8506ab42009-06-11 17:35:47 -07004370
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004371 /**
4372 * capture information of this view for later analysis: developement only
4373 * check dynamic switch to make sure we only dump view
4374 * when ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW) is set
4375 */
4376 private static void captureViewInfo(String subTag, View v) {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07004377 if (v == null || SystemProperties.getInt(ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW, 0) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004378 return;
4379 }
4380 ViewDebug.dumpCapturedView(subTag, v);
4381 }
4382
4383 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004384 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
4385 * for this view's window. Returns null if the view is not currently attached
4386 * to the window. Normally you will not need to use this directly, but
4387 * just use the standard high-level event callbacks like {@link #onKeyDown}.
4388 */
4389 public KeyEvent.DispatcherState getKeyDispatcherState() {
4390 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
4391 }
4392
4393 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004394 * Dispatch a key event before it is processed by any input method
4395 * associated with the view hierarchy. This can be used to intercept
4396 * key events in special situations before the IME consumes them; a
4397 * typical example would be handling the BACK key to update the application's
4398 * UI instead of allowing the IME to see it and close itself.
4399 *
4400 * @param event The key event to be dispatched.
4401 * @return True if the event was handled, false otherwise.
4402 */
4403 public boolean dispatchKeyEventPreIme(KeyEvent event) {
4404 return onKeyPreIme(event.getKeyCode(), event);
4405 }
4406
4407 /**
4408 * Dispatch a key event to the next view on the focus path. This path runs
4409 * from the top of the view tree down to the currently focused view. If this
4410 * view has focus, it will dispatch to itself. Otherwise it will dispatch
4411 * the next node down the focus path. This method also fires any key
4412 * listeners.
4413 *
4414 * @param event The key event to be dispatched.
4415 * @return True if the event was handled, false otherwise.
4416 */
4417 public boolean dispatchKeyEvent(KeyEvent event) {
4418 // If any attached key listener a first crack at the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004419
Romain Guyf607bdc2010-09-10 19:20:06 -07004420 //noinspection SimplifiableIfStatement,deprecation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004421 if (android.util.Config.LOGV) {
4422 captureViewInfo("captureViewKeyEvent", this);
4423 }
4424
Romain Guyf607bdc2010-09-10 19:20:06 -07004425 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004426 if (mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
4427 && mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
4428 return true;
4429 }
4430
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004431 return event.dispatch(this, mAttachInfo != null
4432 ? mAttachInfo.mKeyDispatchState : null, this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004433 }
4434
4435 /**
4436 * Dispatches a key shortcut event.
4437 *
4438 * @param event The key event to be dispatched.
4439 * @return True if the event was handled by the view, false otherwise.
4440 */
4441 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
4442 return onKeyShortcut(event.getKeyCode(), event);
4443 }
4444
4445 /**
4446 * Pass the touch screen motion event down to the target view, or this
4447 * view if it is the target.
4448 *
4449 * @param event The motion event to be dispatched.
4450 * @return True if the event was handled by the view, false otherwise.
4451 */
4452 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown85a31762010-09-01 17:01:00 -07004453 if (!onFilterTouchEventForSecurity(event)) {
4454 return false;
4455 }
4456
Romain Guyf607bdc2010-09-10 19:20:06 -07004457 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004458 if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED &&
4459 mOnTouchListener.onTouch(this, event)) {
4460 return true;
4461 }
4462 return onTouchEvent(event);
4463 }
4464
4465 /**
Jeff Brown85a31762010-09-01 17:01:00 -07004466 * Filter the touch event to apply security policies.
4467 *
4468 * @param event The motion event to be filtered.
4469 * @return True if the event should be dispatched, false if the event should be dropped.
4470 *
4471 * @see #getFilterTouchesWhenObscured
4472 */
4473 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07004474 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07004475 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
4476 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
4477 // Window is obscured, drop this touch.
4478 return false;
4479 }
4480 return true;
4481 }
4482
4483 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004484 * Pass a trackball motion event down to the focused view.
4485 *
4486 * @param event The motion event to be dispatched.
4487 * @return True if the event was handled by the view, false otherwise.
4488 */
4489 public boolean dispatchTrackballEvent(MotionEvent event) {
4490 //Log.i("view", "view=" + this + ", " + event.toString());
4491 return onTrackballEvent(event);
4492 }
4493
4494 /**
4495 * Called when the window containing this view gains or loses window focus.
4496 * ViewGroups should override to route to their children.
4497 *
4498 * @param hasFocus True if the window containing this view now has focus,
4499 * false otherwise.
4500 */
4501 public void dispatchWindowFocusChanged(boolean hasFocus) {
4502 onWindowFocusChanged(hasFocus);
4503 }
4504
4505 /**
4506 * Called when the window containing this view gains or loses focus. Note
4507 * that this is separate from view focus: to receive key events, both
4508 * your view and its window must have focus. If a window is displayed
4509 * on top of yours that takes input focus, then your own window will lose
4510 * focus but the view focus will remain unchanged.
4511 *
4512 * @param hasWindowFocus True if the window containing this view now has
4513 * focus, false otherwise.
4514 */
4515 public void onWindowFocusChanged(boolean hasWindowFocus) {
4516 InputMethodManager imm = InputMethodManager.peekInstance();
4517 if (!hasWindowFocus) {
4518 if (isPressed()) {
4519 setPressed(false);
4520 }
4521 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4522 imm.focusOut(this);
4523 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05004524 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08004525 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004526 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004527 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4528 imm.focusIn(this);
4529 }
4530 refreshDrawableState();
4531 }
4532
4533 /**
4534 * Returns true if this view is in a window that currently has window focus.
4535 * Note that this is not the same as the view itself having focus.
4536 *
4537 * @return True if this view is in a window that currently has window focus.
4538 */
4539 public boolean hasWindowFocus() {
4540 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
4541 }
4542
4543 /**
Adam Powell326d8082009-12-09 15:10:07 -08004544 * Dispatch a view visibility change down the view hierarchy.
4545 * ViewGroups should override to route to their children.
4546 * @param changedView The view whose visibility changed. Could be 'this' or
4547 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004548 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4549 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004550 */
4551 protected void dispatchVisibilityChanged(View changedView, int visibility) {
4552 onVisibilityChanged(changedView, visibility);
4553 }
4554
4555 /**
4556 * Called when the visibility of the view or an ancestor of the view is changed.
4557 * @param changedView The view whose visibility changed. Could be 'this' or
4558 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004559 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4560 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004561 */
4562 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004563 if (visibility == VISIBLE) {
4564 if (mAttachInfo != null) {
4565 initialAwakenScrollBars();
4566 } else {
4567 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
4568 }
4569 }
Adam Powell326d8082009-12-09 15:10:07 -08004570 }
4571
4572 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08004573 * Dispatch a hint about whether this view is displayed. For instance, when
4574 * a View moves out of the screen, it might receives a display hint indicating
4575 * the view is not displayed. Applications should not <em>rely</em> on this hint
4576 * as there is no guarantee that they will receive one.
4577 *
4578 * @param hint A hint about whether or not this view is displayed:
4579 * {@link #VISIBLE} or {@link #INVISIBLE}.
4580 */
4581 public void dispatchDisplayHint(int hint) {
4582 onDisplayHint(hint);
4583 }
4584
4585 /**
4586 * Gives this view a hint about whether is displayed or not. For instance, when
4587 * a View moves out of the screen, it might receives a display hint indicating
4588 * the view is not displayed. Applications should not <em>rely</em> on this hint
4589 * as there is no guarantee that they will receive one.
4590 *
4591 * @param hint A hint about whether or not this view is displayed:
4592 * {@link #VISIBLE} or {@link #INVISIBLE}.
4593 */
4594 protected void onDisplayHint(int hint) {
4595 }
4596
4597 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004598 * Dispatch a window visibility change down the view hierarchy.
4599 * ViewGroups should override to route to their children.
4600 *
4601 * @param visibility The new visibility of the window.
4602 *
4603 * @see #onWindowVisibilityChanged
4604 */
4605 public void dispatchWindowVisibilityChanged(int visibility) {
4606 onWindowVisibilityChanged(visibility);
4607 }
4608
4609 /**
4610 * Called when the window containing has change its visibility
4611 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
4612 * that this tells you whether or not your window is being made visible
4613 * to the window manager; this does <em>not</em> tell you whether or not
4614 * your window is obscured by other windows on the screen, even if it
4615 * is itself visible.
4616 *
4617 * @param visibility The new visibility of the window.
4618 */
4619 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004620 if (visibility == VISIBLE) {
4621 initialAwakenScrollBars();
4622 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004623 }
4624
4625 /**
4626 * Returns the current visibility of the window this view is attached to
4627 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
4628 *
4629 * @return Returns the current visibility of the view's window.
4630 */
4631 public int getWindowVisibility() {
4632 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
4633 }
4634
4635 /**
4636 * Retrieve the overall visible display size in which the window this view is
4637 * attached to has been positioned in. This takes into account screen
4638 * decorations above the window, for both cases where the window itself
4639 * is being position inside of them or the window is being placed under
4640 * then and covered insets are used for the window to position its content
4641 * inside. In effect, this tells you the available area where content can
4642 * be placed and remain visible to users.
4643 *
4644 * <p>This function requires an IPC back to the window manager to retrieve
4645 * the requested information, so should not be used in performance critical
4646 * code like drawing.
4647 *
4648 * @param outRect Filled in with the visible display frame. If the view
4649 * is not attached to a window, this is simply the raw display size.
4650 */
4651 public void getWindowVisibleDisplayFrame(Rect outRect) {
4652 if (mAttachInfo != null) {
4653 try {
4654 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
4655 } catch (RemoteException e) {
4656 return;
4657 }
4658 // XXX This is really broken, and probably all needs to be done
4659 // in the window manager, and we need to know more about whether
4660 // we want the area behind or in front of the IME.
4661 final Rect insets = mAttachInfo.mVisibleInsets;
4662 outRect.left += insets.left;
4663 outRect.top += insets.top;
4664 outRect.right -= insets.right;
4665 outRect.bottom -= insets.bottom;
4666 return;
4667 }
4668 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
4669 outRect.set(0, 0, d.getWidth(), d.getHeight());
4670 }
4671
4672 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08004673 * Dispatch a notification about a resource configuration change down
4674 * the view hierarchy.
4675 * ViewGroups should override to route to their children.
4676 *
4677 * @param newConfig The new resource configuration.
4678 *
4679 * @see #onConfigurationChanged
4680 */
4681 public void dispatchConfigurationChanged(Configuration newConfig) {
4682 onConfigurationChanged(newConfig);
4683 }
4684
4685 /**
4686 * Called when the current configuration of the resources being used
4687 * by the application have changed. You can use this to decide when
4688 * to reload resources that can changed based on orientation and other
4689 * configuration characterstics. You only need to use this if you are
4690 * not relying on the normal {@link android.app.Activity} mechanism of
4691 * recreating the activity instance upon a configuration change.
4692 *
4693 * @param newConfig The new resource configuration.
4694 */
4695 protected void onConfigurationChanged(Configuration newConfig) {
4696 }
4697
4698 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004699 * Private function to aggregate all per-view attributes in to the view
4700 * root.
4701 */
4702 void dispatchCollectViewAttributes(int visibility) {
4703 performCollectViewAttributes(visibility);
4704 }
4705
4706 void performCollectViewAttributes(int visibility) {
4707 //noinspection PointlessBitwiseExpression
4708 if (((visibility | mViewFlags) & (VISIBILITY_MASK | KEEP_SCREEN_ON))
4709 == (VISIBLE | KEEP_SCREEN_ON)) {
4710 mAttachInfo.mKeepScreenOn = true;
4711 }
4712 }
4713
4714 void needGlobalAttributesUpdate(boolean force) {
4715 AttachInfo ai = mAttachInfo;
4716 if (ai != null) {
4717 if (ai.mKeepScreenOn || force) {
4718 ai.mRecomputeGlobalAttributes = true;
4719 }
4720 }
4721 }
4722
4723 /**
4724 * Returns whether the device is currently in touch mode. Touch mode is entered
4725 * once the user begins interacting with the device by touch, and affects various
4726 * things like whether focus is always visible to the user.
4727 *
4728 * @return Whether the device is in touch mode.
4729 */
4730 @ViewDebug.ExportedProperty
4731 public boolean isInTouchMode() {
4732 if (mAttachInfo != null) {
4733 return mAttachInfo.mInTouchMode;
4734 } else {
4735 return ViewRoot.isInTouchMode();
4736 }
4737 }
4738
4739 /**
4740 * Returns the context the view is running in, through which it can
4741 * access the current theme, resources, etc.
4742 *
4743 * @return The view's Context.
4744 */
4745 @ViewDebug.CapturedViewProperty
4746 public final Context getContext() {
4747 return mContext;
4748 }
4749
4750 /**
4751 * Handle a key event before it is processed by any input method
4752 * associated with the view hierarchy. This can be used to intercept
4753 * key events in special situations before the IME consumes them; a
4754 * typical example would be handling the BACK key to update the application's
4755 * UI instead of allowing the IME to see it and close itself.
4756 *
4757 * @param keyCode The value in event.getKeyCode().
4758 * @param event Description of the key event.
4759 * @return If you handled the event, return true. If you want to allow the
4760 * event to be handled by the next receiver, return false.
4761 */
4762 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
4763 return false;
4764 }
4765
4766 /**
Jeff Brown995e7742010-12-22 16:59:36 -08004767 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
4768 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004769 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
4770 * is released, if the view is enabled and clickable.
4771 *
4772 * @param keyCode A key code that represents the button pressed, from
4773 * {@link android.view.KeyEvent}.
4774 * @param event The KeyEvent object that defines the button action.
4775 */
4776 public boolean onKeyDown(int keyCode, KeyEvent event) {
4777 boolean result = false;
4778
4779 switch (keyCode) {
4780 case KeyEvent.KEYCODE_DPAD_CENTER:
4781 case KeyEvent.KEYCODE_ENTER: {
4782 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4783 return true;
4784 }
4785 // Long clickable items don't necessarily have to be clickable
4786 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
4787 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
4788 (event.getRepeatCount() == 0)) {
4789 setPressed(true);
4790 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
Adam Powelle14579b2009-12-16 18:39:52 -08004791 postCheckForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004792 }
4793 return true;
4794 }
4795 break;
4796 }
4797 }
4798 return result;
4799 }
4800
4801 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004802 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
4803 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
4804 * the event).
4805 */
4806 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
4807 return false;
4808 }
4809
4810 /**
Jeff Brown995e7742010-12-22 16:59:36 -08004811 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
4812 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004813 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
4814 * {@link KeyEvent#KEYCODE_ENTER} is released.
4815 *
4816 * @param keyCode A key code that represents the button pressed, from
4817 * {@link android.view.KeyEvent}.
4818 * @param event The KeyEvent object that defines the button action.
4819 */
4820 public boolean onKeyUp(int keyCode, KeyEvent event) {
4821 boolean result = false;
4822
4823 switch (keyCode) {
4824 case KeyEvent.KEYCODE_DPAD_CENTER:
4825 case KeyEvent.KEYCODE_ENTER: {
4826 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4827 return true;
4828 }
4829 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
4830 setPressed(false);
4831
4832 if (!mHasPerformedLongPress) {
4833 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05004834 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004835
4836 result = performClick();
4837 }
4838 }
4839 break;
4840 }
4841 }
4842 return result;
4843 }
4844
4845 /**
4846 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
4847 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
4848 * the event).
4849 *
4850 * @param keyCode A key code that represents the button pressed, from
4851 * {@link android.view.KeyEvent}.
4852 * @param repeatCount The number of times the action was made.
4853 * @param event The KeyEvent object that defines the button action.
4854 */
4855 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
4856 return false;
4857 }
4858
4859 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08004860 * Called on the focused view when a key shortcut event is not handled.
4861 * Override this method to implement local key shortcuts for the View.
4862 * Key shortcuts can also be implemented by setting the
4863 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004864 *
4865 * @param keyCode The value in event.getKeyCode().
4866 * @param event Description of the key event.
4867 * @return If you handled the event, return true. If you want to allow the
4868 * event to be handled by the next receiver, return false.
4869 */
4870 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
4871 return false;
4872 }
4873
4874 /**
4875 * Check whether the called view is a text editor, in which case it
4876 * would make sense to automatically display a soft input window for
4877 * it. Subclasses should override this if they implement
4878 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004879 * a call on that method would return a non-null InputConnection, and
4880 * they are really a first-class editor that the user would normally
4881 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07004882 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004883 * <p>The default implementation always returns false. This does
4884 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
4885 * will not be called or the user can not otherwise perform edits on your
4886 * view; it is just a hint to the system that this is not the primary
4887 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07004888 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004889 * @return Returns true if this view is a text editor, else false.
4890 */
4891 public boolean onCheckIsTextEditor() {
4892 return false;
4893 }
Romain Guy8506ab42009-06-11 17:35:47 -07004894
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004895 /**
4896 * Create a new InputConnection for an InputMethod to interact
4897 * with the view. The default implementation returns null, since it doesn't
4898 * support input methods. You can override this to implement such support.
4899 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07004900 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004901 * <p>When implementing this, you probably also want to implement
4902 * {@link #onCheckIsTextEditor()} to indicate you will return a
4903 * non-null InputConnection.
4904 *
4905 * @param outAttrs Fill in with attribute information about the connection.
4906 */
4907 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
4908 return null;
4909 }
4910
4911 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004912 * Called by the {@link android.view.inputmethod.InputMethodManager}
4913 * when a view who is not the current
4914 * input connection target is trying to make a call on the manager. The
4915 * default implementation returns false; you can override this to return
4916 * true for certain views if you are performing InputConnection proxying
4917 * to them.
4918 * @param view The View that is making the InputMethodManager call.
4919 * @return Return true to allow the call, false to reject.
4920 */
4921 public boolean checkInputConnectionProxy(View view) {
4922 return false;
4923 }
Romain Guy8506ab42009-06-11 17:35:47 -07004924
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004925 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004926 * Show the context menu for this view. It is not safe to hold on to the
4927 * menu after returning from this method.
4928 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07004929 * You should normally not overload this method. Overload
4930 * {@link #onCreateContextMenu(ContextMenu)} or define an
4931 * {@link OnCreateContextMenuListener} to add items to the context menu.
4932 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004933 * @param menu The context menu to populate
4934 */
4935 public void createContextMenu(ContextMenu menu) {
4936 ContextMenuInfo menuInfo = getContextMenuInfo();
4937
4938 // Sets the current menu info so all items added to menu will have
4939 // my extra info set.
4940 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
4941
4942 onCreateContextMenu(menu);
4943 if (mOnCreateContextMenuListener != null) {
4944 mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
4945 }
4946
4947 // Clear the extra information so subsequent items that aren't mine don't
4948 // have my extra info.
4949 ((MenuBuilder)menu).setCurrentMenuInfo(null);
4950
4951 if (mParent != null) {
4952 mParent.createContextMenu(menu);
4953 }
4954 }
4955
4956 /**
4957 * Views should implement this if they have extra information to associate
4958 * with the context menu. The return result is supplied as a parameter to
4959 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
4960 * callback.
4961 *
4962 * @return Extra information about the item for which the context menu
4963 * should be shown. This information will vary across different
4964 * subclasses of View.
4965 */
4966 protected ContextMenuInfo getContextMenuInfo() {
4967 return null;
4968 }
4969
4970 /**
4971 * Views should implement this if the view itself is going to add items to
4972 * the context menu.
4973 *
4974 * @param menu the context menu to populate
4975 */
4976 protected void onCreateContextMenu(ContextMenu menu) {
4977 }
4978
4979 /**
4980 * Implement this method to handle trackball motion events. The
4981 * <em>relative</em> movement of the trackball since the last event
4982 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
4983 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
4984 * that a movement of 1 corresponds to the user pressing one DPAD key (so
4985 * they will often be fractional values, representing the more fine-grained
4986 * movement information available from a trackball).
4987 *
4988 * @param event The motion event.
4989 * @return True if the event was handled, false otherwise.
4990 */
4991 public boolean onTrackballEvent(MotionEvent event) {
4992 return false;
4993 }
4994
4995 /**
4996 * Implement this method to handle touch screen motion events.
4997 *
4998 * @param event The motion event.
4999 * @return True if the event was handled, false otherwise.
5000 */
5001 public boolean onTouchEvent(MotionEvent event) {
5002 final int viewFlags = mViewFlags;
5003
5004 if ((viewFlags & ENABLED_MASK) == DISABLED) {
5005 // A disabled view that is clickable still consumes the touch
5006 // events, it just doesn't respond to them.
5007 return (((viewFlags & CLICKABLE) == CLICKABLE ||
5008 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
5009 }
5010
5011 if (mTouchDelegate != null) {
5012 if (mTouchDelegate.onTouchEvent(event)) {
5013 return true;
5014 }
5015 }
5016
5017 if (((viewFlags & CLICKABLE) == CLICKABLE ||
5018 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
5019 switch (event.getAction()) {
5020 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08005021 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
5022 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005023 // take focus if we don't have it already and we should in
5024 // touch mode.
5025 boolean focusTaken = false;
5026 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
5027 focusTaken = requestFocus();
5028 }
5029
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08005030 if (prepressed) {
5031 // The button is being released before we actually
5032 // showed it as pressed. Make it show the pressed
5033 // state now (before scheduling the click) to ensure
5034 // the user sees it.
5035 mPrivateFlags |= PRESSED;
5036 refreshDrawableState();
5037 }
5038
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005039 if (!mHasPerformedLongPress) {
5040 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05005041 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005042
5043 // Only perform take click actions if we were in the pressed state
5044 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08005045 // Use a Runnable and post this rather than calling
5046 // performClick directly. This lets other visual state
5047 // of the view update before click actions start.
5048 if (mPerformClick == null) {
5049 mPerformClick = new PerformClick();
5050 }
5051 if (!post(mPerformClick)) {
5052 performClick();
5053 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005054 }
5055 }
5056
5057 if (mUnsetPressedState == null) {
5058 mUnsetPressedState = new UnsetPressedState();
5059 }
5060
Adam Powelle14579b2009-12-16 18:39:52 -08005061 if (prepressed) {
Adam Powelle14579b2009-12-16 18:39:52 -08005062 postDelayed(mUnsetPressedState,
5063 ViewConfiguration.getPressedStateDuration());
5064 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005065 // If the post failed, unpress right now
5066 mUnsetPressedState.run();
5067 }
Adam Powelle14579b2009-12-16 18:39:52 -08005068 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005069 }
5070 break;
5071
5072 case MotionEvent.ACTION_DOWN:
Adam Powelle14579b2009-12-16 18:39:52 -08005073 if (mPendingCheckForTap == null) {
5074 mPendingCheckForTap = new CheckForTap();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005075 }
Adam Powelle14579b2009-12-16 18:39:52 -08005076 mPrivateFlags |= PREPRESSED;
Adam Powell3b023392010-03-11 16:30:28 -08005077 mHasPerformedLongPress = false;
Adam Powelle14579b2009-12-16 18:39:52 -08005078 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005079 break;
5080
5081 case MotionEvent.ACTION_CANCEL:
5082 mPrivateFlags &= ~PRESSED;
5083 refreshDrawableState();
Adam Powelle14579b2009-12-16 18:39:52 -08005084 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005085 break;
5086
5087 case MotionEvent.ACTION_MOVE:
5088 final int x = (int) event.getX();
5089 final int y = (int) event.getY();
5090
5091 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07005092 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005093 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08005094 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005095 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08005096 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05005097 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005098
5099 // Need to switch from pressed to not pressed
5100 mPrivateFlags &= ~PRESSED;
5101 refreshDrawableState();
5102 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005103 }
5104 break;
5105 }
5106 return true;
5107 }
5108
5109 return false;
5110 }
5111
5112 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05005113 * Remove the longpress detection timer.
5114 */
5115 private void removeLongPressCallback() {
5116 if (mPendingCheckForLongPress != null) {
5117 removeCallbacks(mPendingCheckForLongPress);
5118 }
5119 }
Adam Powell3cb8b632011-01-21 15:34:14 -08005120
5121 /**
5122 * Remove the pending click action
5123 */
5124 private void removePerformClickCallback() {
5125 if (mPerformClick != null) {
5126 removeCallbacks(mPerformClick);
5127 }
5128 }
5129
Adam Powelle14579b2009-12-16 18:39:52 -08005130 /**
Romain Guya440b002010-02-24 15:57:54 -08005131 * Remove the prepress detection timer.
5132 */
5133 private void removeUnsetPressCallback() {
5134 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
5135 setPressed(false);
5136 removeCallbacks(mUnsetPressedState);
5137 }
5138 }
5139
5140 /**
Adam Powelle14579b2009-12-16 18:39:52 -08005141 * Remove the tap detection timer.
5142 */
5143 private void removeTapCallback() {
5144 if (mPendingCheckForTap != null) {
5145 mPrivateFlags &= ~PREPRESSED;
5146 removeCallbacks(mPendingCheckForTap);
5147 }
5148 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05005149
5150 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005151 * Cancels a pending long press. Your subclass can use this if you
5152 * want the context menu to come up if the user presses and holds
5153 * at the same place, but you don't want it to come up if they press
5154 * and then move around enough to cause scrolling.
5155 */
5156 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05005157 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08005158
5159 /*
5160 * The prepressed state handled by the tap callback is a display
5161 * construct, but the tap callback will post a long press callback
5162 * less its own timeout. Remove it here.
5163 */
5164 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005165 }
5166
5167 /**
5168 * Sets the TouchDelegate for this View.
5169 */
5170 public void setTouchDelegate(TouchDelegate delegate) {
5171 mTouchDelegate = delegate;
5172 }
5173
5174 /**
5175 * Gets the TouchDelegate for this View.
5176 */
5177 public TouchDelegate getTouchDelegate() {
5178 return mTouchDelegate;
5179 }
5180
5181 /**
5182 * Set flags controlling behavior of this view.
5183 *
5184 * @param flags Constant indicating the value which should be set
5185 * @param mask Constant indicating the bit range that should be changed
5186 */
5187 void setFlags(int flags, int mask) {
5188 int old = mViewFlags;
5189 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
5190
5191 int changed = mViewFlags ^ old;
5192 if (changed == 0) {
5193 return;
5194 }
5195 int privateFlags = mPrivateFlags;
5196
5197 /* Check if the FOCUSABLE bit has changed */
5198 if (((changed & FOCUSABLE_MASK) != 0) &&
5199 ((privateFlags & HAS_BOUNDS) !=0)) {
5200 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
5201 && ((privateFlags & FOCUSED) != 0)) {
5202 /* Give up focus if we are no longer focusable */
5203 clearFocus();
5204 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
5205 && ((privateFlags & FOCUSED) == 0)) {
5206 /*
5207 * Tell the view system that we are now available to take focus
5208 * if no one else already has it.
5209 */
5210 if (mParent != null) mParent.focusableViewAvailable(this);
5211 }
5212 }
5213
5214 if ((flags & VISIBILITY_MASK) == VISIBLE) {
5215 if ((changed & VISIBILITY_MASK) != 0) {
5216 /*
5217 * If this view is becoming visible, set the DRAWN flag so that
5218 * the next invalidate() will not be skipped.
5219 */
5220 mPrivateFlags |= DRAWN;
5221
5222 needGlobalAttributesUpdate(true);
5223
5224 // a view becoming visible is worth notifying the parent
5225 // about in case nothing has focus. even if this specific view
5226 // isn't focusable, it may contain something that is, so let
5227 // the root view try to give this focus if nothing else does.
5228 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
5229 mParent.focusableViewAvailable(this);
5230 }
5231 }
5232 }
5233
5234 /* Check if the GONE bit has changed */
5235 if ((changed & GONE) != 0) {
5236 needGlobalAttributesUpdate(false);
5237 requestLayout();
5238 invalidate();
5239
Romain Guyecd80ee2009-12-03 17:13:02 -08005240 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
5241 if (hasFocus()) clearFocus();
5242 destroyDrawingCache();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005243 }
5244 if (mAttachInfo != null) {
5245 mAttachInfo.mViewVisibilityChanged = true;
5246 }
5247 }
5248
5249 /* Check if the VISIBLE bit has changed */
5250 if ((changed & INVISIBLE) != 0) {
5251 needGlobalAttributesUpdate(false);
5252 invalidate();
5253
5254 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
5255 // root view becoming invisible shouldn't clear focus
5256 if (getRootView() != this) {
5257 clearFocus();
5258 }
5259 }
5260 if (mAttachInfo != null) {
5261 mAttachInfo.mViewVisibilityChanged = true;
5262 }
5263 }
5264
Adam Powell326d8082009-12-09 15:10:07 -08005265 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07005266 if (mParent instanceof ViewGroup) {
5267 ((ViewGroup)mParent).onChildVisibilityChanged(this, (flags & VISIBILITY_MASK));
5268 }
Adam Powell326d8082009-12-09 15:10:07 -08005269 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
5270 }
5271
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005272 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
5273 destroyDrawingCache();
5274 }
5275
5276 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
5277 destroyDrawingCache();
5278 mPrivateFlags &= ~DRAWING_CACHE_VALID;
5279 }
5280
5281 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
5282 destroyDrawingCache();
5283 mPrivateFlags &= ~DRAWING_CACHE_VALID;
5284 }
5285
5286 if ((changed & DRAW_MASK) != 0) {
5287 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
5288 if (mBGDrawable != null) {
5289 mPrivateFlags &= ~SKIP_DRAW;
5290 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
5291 } else {
5292 mPrivateFlags |= SKIP_DRAW;
5293 }
5294 } else {
5295 mPrivateFlags &= ~SKIP_DRAW;
5296 }
5297 requestLayout();
5298 invalidate();
5299 }
5300
5301 if ((changed & KEEP_SCREEN_ON) != 0) {
5302 if (mParent != null) {
5303 mParent.recomputeViewAttributes(this);
5304 }
5305 }
5306 }
5307
5308 /**
5309 * Change the view's z order in the tree, so it's on top of other sibling
5310 * views
5311 */
5312 public void bringToFront() {
5313 if (mParent != null) {
5314 mParent.bringChildToFront(this);
5315 }
5316 }
5317
5318 /**
5319 * This is called in response to an internal scroll in this view (i.e., the
5320 * view scrolled its own contents). This is typically as a result of
5321 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
5322 * called.
5323 *
5324 * @param l Current horizontal scroll origin.
5325 * @param t Current vertical scroll origin.
5326 * @param oldl Previous horizontal scroll origin.
5327 * @param oldt Previous vertical scroll origin.
5328 */
5329 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
5330 mBackgroundSizeChanged = true;
5331
5332 final AttachInfo ai = mAttachInfo;
5333 if (ai != null) {
5334 ai.mViewScrollChanged = true;
5335 }
5336 }
5337
5338 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005339 * Interface definition for a callback to be invoked when the layout bounds of a view
5340 * changes due to layout processing.
5341 */
5342 public interface OnLayoutChangeListener {
5343 /**
5344 * Called when the focus state of a view has changed.
5345 *
5346 * @param v The view whose state has changed.
5347 * @param left The new value of the view's left property.
5348 * @param top The new value of the view's top property.
5349 * @param right The new value of the view's right property.
5350 * @param bottom The new value of the view's bottom property.
5351 * @param oldLeft The previous value of the view's left property.
5352 * @param oldTop The previous value of the view's top property.
5353 * @param oldRight The previous value of the view's right property.
5354 * @param oldBottom The previous value of the view's bottom property.
5355 */
5356 void onLayoutChange(View v, int left, int top, int right, int bottom,
5357 int oldLeft, int oldTop, int oldRight, int oldBottom);
5358 }
5359
5360 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005361 * This is called during layout when the size of this view has changed. If
5362 * you were just added to the view hierarchy, you're called with the old
5363 * values of 0.
5364 *
5365 * @param w Current width of this view.
5366 * @param h Current height of this view.
5367 * @param oldw Old width of this view.
5368 * @param oldh Old height of this view.
5369 */
5370 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
5371 }
5372
5373 /**
5374 * Called by draw to draw the child views. This may be overridden
5375 * by derived classes to gain control just before its children are drawn
5376 * (but after its own view has been drawn).
5377 * @param canvas the canvas on which to draw the view
5378 */
5379 protected void dispatchDraw(Canvas canvas) {
5380 }
5381
5382 /**
5383 * Gets the parent of this view. Note that the parent is a
5384 * ViewParent and not necessarily a View.
5385 *
5386 * @return Parent of this view.
5387 */
5388 public final ViewParent getParent() {
5389 return mParent;
5390 }
5391
5392 /**
5393 * Return the scrolled left position of this view. This is the left edge of
5394 * the displayed part of your view. You do not need to draw any pixels
5395 * farther left, since those are outside of the frame of your view on
5396 * screen.
5397 *
5398 * @return The left edge of the displayed part of your view, in pixels.
5399 */
5400 public final int getScrollX() {
5401 return mScrollX;
5402 }
5403
5404 /**
5405 * Return the scrolled top position of this view. This is the top edge of
5406 * the displayed part of your view. You do not need to draw any pixels above
5407 * it, since those are outside of the frame of your view on screen.
5408 *
5409 * @return The top edge of the displayed part of your view, in pixels.
5410 */
5411 public final int getScrollY() {
5412 return mScrollY;
5413 }
5414
5415 /**
5416 * Return the width of the your view.
5417 *
5418 * @return The width of your view, in pixels.
5419 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005420 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005421 public final int getWidth() {
5422 return mRight - mLeft;
5423 }
5424
5425 /**
5426 * Return the height of your view.
5427 *
5428 * @return The height of your view, in pixels.
5429 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005430 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005431 public final int getHeight() {
5432 return mBottom - mTop;
5433 }
5434
5435 /**
5436 * Return the visible drawing bounds of your view. Fills in the output
5437 * rectangle with the values from getScrollX(), getScrollY(),
5438 * getWidth(), and getHeight().
5439 *
5440 * @param outRect The (scrolled) drawing bounds of the view.
5441 */
5442 public void getDrawingRect(Rect outRect) {
5443 outRect.left = mScrollX;
5444 outRect.top = mScrollY;
5445 outRect.right = mScrollX + (mRight - mLeft);
5446 outRect.bottom = mScrollY + (mBottom - mTop);
5447 }
5448
5449 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005450 * Like {@link #getMeasuredWidthAndState()}, but only returns the
5451 * raw width component (that is the result is masked by
5452 * {@link #MEASURED_SIZE_MASK}).
5453 *
5454 * @return The raw measured width of this view.
5455 */
5456 public final int getMeasuredWidth() {
5457 return mMeasuredWidth & MEASURED_SIZE_MASK;
5458 }
5459
5460 /**
5461 * Return the full width measurement information for this view as computed
5462 * by the most recent call to {@link #measure}. This result is a bit mask
5463 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005464 * This should be used during measurement and layout calculations only. Use
5465 * {@link #getWidth()} to see how wide a view is after layout.
5466 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08005467 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005468 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08005469 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005470 return mMeasuredWidth;
5471 }
5472
5473 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005474 * Like {@link #getMeasuredHeightAndState()}, but only returns the
5475 * raw width component (that is the result is masked by
5476 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005477 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08005478 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005479 */
5480 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08005481 return mMeasuredHeight & MEASURED_SIZE_MASK;
5482 }
5483
5484 /**
5485 * Return the full height measurement information for this view as computed
5486 * by the most recent call to {@link #measure}. This result is a bit mask
5487 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
5488 * This should be used during measurement and layout calculations only. Use
5489 * {@link #getHeight()} to see how wide a view is after layout.
5490 *
5491 * @return The measured width of this view as a bit mask.
5492 */
5493 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005494 return mMeasuredHeight;
5495 }
5496
5497 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005498 * Return only the state bits of {@link #getMeasuredWidthAndState()}
5499 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
5500 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
5501 * and the height component is at the shifted bits
5502 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
5503 */
5504 public final int getMeasuredState() {
5505 return (mMeasuredWidth&MEASURED_STATE_MASK)
5506 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
5507 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
5508 }
5509
5510 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005511 * The transform matrix of this view, which is calculated based on the current
5512 * roation, scale, and pivot properties.
5513 *
5514 * @see #getRotation()
5515 * @see #getScaleX()
5516 * @see #getScaleY()
5517 * @see #getPivotX()
5518 * @see #getPivotY()
5519 * @return The current transform matrix for the view
5520 */
5521 public Matrix getMatrix() {
Jeff Brown86671742010-09-30 20:00:15 -07005522 updateMatrix();
Romain Guy33e72ae2010-07-17 12:40:29 -07005523 return mMatrix;
5524 }
5525
5526 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005527 * Utility function to determine if the value is far enough away from zero to be
5528 * considered non-zero.
5529 * @param value A floating point value to check for zero-ness
5530 * @return whether the passed-in value is far enough away from zero to be considered non-zero
5531 */
5532 private static boolean nonzero(float value) {
5533 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
5534 }
5535
5536 /**
Jeff Brown86671742010-09-30 20:00:15 -07005537 * Returns true if the transform matrix is the identity matrix.
5538 * Recomputes the matrix if necessary.
Romain Guy33e72ae2010-07-17 12:40:29 -07005539 *
5540 * @return True if the transform matrix is the identity matrix, false otherwise.
5541 */
Jeff Brown86671742010-09-30 20:00:15 -07005542 final boolean hasIdentityMatrix() {
5543 updateMatrix();
5544 return mMatrixIsIdentity;
5545 }
5546
5547 /**
5548 * Recomputes the transform matrix if necessary.
5549 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07005550 private void updateMatrix() {
Chet Haasec3aa3612010-06-17 08:50:37 -07005551 if (mMatrixDirty) {
5552 // transform-related properties have changed since the last time someone
5553 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07005554
5555 // Figure out if we need to update the pivot point
5556 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08005557 if ((mRight - mLeft) != mPrevWidth || (mBottom - mTop) != mPrevHeight) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005558 mPrevWidth = mRight - mLeft;
5559 mPrevHeight = mBottom - mTop;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -08005560 mPivotX = mPrevWidth / 2f;
5561 mPivotY = mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07005562 }
5563 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005564 mMatrix.reset();
Chet Haase897247b2010-09-09 14:54:47 -07005565 if (!nonzero(mRotationX) && !nonzero(mRotationY)) {
5566 mMatrix.setTranslate(mTranslationX, mTranslationY);
5567 mMatrix.preRotate(mRotation, mPivotX, mPivotY);
5568 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
5569 } else {
Chet Haasefd2b0022010-08-06 13:08:56 -07005570 if (mCamera == null) {
5571 mCamera = new Camera();
5572 matrix3D = new Matrix();
5573 }
5574 mCamera.save();
Chet Haase897247b2010-09-09 14:54:47 -07005575 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
Chet Haasefd2b0022010-08-06 13:08:56 -07005576 mCamera.rotateX(mRotationX);
5577 mCamera.rotateY(mRotationY);
Chet Haase897247b2010-09-09 14:54:47 -07005578 mCamera.rotateZ(-mRotation);
Chet Haasefd2b0022010-08-06 13:08:56 -07005579 mCamera.getMatrix(matrix3D);
5580 matrix3D.preTranslate(-mPivotX, -mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07005581 matrix3D.postTranslate(mPivotX + mTranslationX, mPivotY + mTranslationY);
Chet Haasefd2b0022010-08-06 13:08:56 -07005582 mMatrix.postConcat(matrix3D);
5583 mCamera.restore();
5584 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005585 mMatrixDirty = false;
5586 mMatrixIsIdentity = mMatrix.isIdentity();
5587 mInverseMatrixDirty = true;
5588 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005589 }
5590
5591 /**
5592 * Utility method to retrieve the inverse of the current mMatrix property.
5593 * We cache the matrix to avoid recalculating it when transform properties
5594 * have not changed.
5595 *
5596 * @return The inverse of the current matrix of this view.
5597 */
Jeff Brown86671742010-09-30 20:00:15 -07005598 final Matrix getInverseMatrix() {
5599 updateMatrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07005600 if (mInverseMatrixDirty) {
5601 if (mInverseMatrix == null) {
5602 mInverseMatrix = new Matrix();
5603 }
5604 mMatrix.invert(mInverseMatrix);
5605 mInverseMatrixDirty = false;
5606 }
5607 return mInverseMatrix;
5608 }
5609
5610 /**
5611 * The degrees that the view is rotated around the pivot point.
5612 *
5613 * @see #getPivotX()
5614 * @see #getPivotY()
5615 * @return The degrees of rotation.
5616 */
5617 public float getRotation() {
5618 return mRotation;
5619 }
5620
5621 /**
Chet Haase897247b2010-09-09 14:54:47 -07005622 * Sets the degrees that the view is rotated around the pivot point. Increasing values
5623 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07005624 *
5625 * @param rotation The degrees of rotation.
5626 * @see #getPivotX()
5627 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005628 *
5629 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07005630 */
5631 public void setRotation(float rotation) {
5632 if (mRotation != rotation) {
5633 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005634 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005635 mRotation = rotation;
5636 mMatrixDirty = true;
5637 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005638 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005639 }
5640 }
5641
5642 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005643 * The degrees that the view is rotated around the vertical axis through the pivot point.
5644 *
5645 * @see #getPivotX()
5646 * @see #getPivotY()
5647 * @return The degrees of Y rotation.
5648 */
5649 public float getRotationY() {
5650 return mRotationY;
5651 }
5652
5653 /**
Chet Haase897247b2010-09-09 14:54:47 -07005654 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
5655 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
5656 * down the y axis.
Chet Haasefd2b0022010-08-06 13:08:56 -07005657 *
5658 * @param rotationY The degrees of Y rotation.
5659 * @see #getPivotX()
5660 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005661 *
5662 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07005663 */
5664 public void setRotationY(float rotationY) {
5665 if (mRotationY != rotationY) {
5666 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005667 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005668 mRotationY = rotationY;
5669 mMatrixDirty = true;
5670 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005671 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005672 }
5673 }
5674
5675 /**
5676 * The degrees that the view is rotated around the horizontal axis through the pivot point.
5677 *
5678 * @see #getPivotX()
5679 * @see #getPivotY()
5680 * @return The degrees of X rotation.
5681 */
5682 public float getRotationX() {
5683 return mRotationX;
5684 }
5685
5686 /**
Chet Haase897247b2010-09-09 14:54:47 -07005687 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
5688 * Increasing values result in clockwise rotation from the viewpoint of looking down the
5689 * x axis.
Chet Haasefd2b0022010-08-06 13:08:56 -07005690 *
5691 * @param rotationX The degrees of X rotation.
5692 * @see #getPivotX()
5693 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005694 *
5695 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07005696 */
5697 public void setRotationX(float rotationX) {
5698 if (mRotationX != rotationX) {
5699 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005700 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005701 mRotationX = rotationX;
5702 mMatrixDirty = true;
5703 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005704 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005705 }
5706 }
5707
5708 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005709 * The amount that the view is scaled in x around the pivot point, as a proportion of
5710 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
5711 *
Joe Onorato93162322010-09-16 15:42:01 -04005712 * <p>By default, this is 1.0f.
5713 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005714 * @see #getPivotX()
5715 * @see #getPivotY()
5716 * @return The scaling factor.
5717 */
5718 public float getScaleX() {
5719 return mScaleX;
5720 }
5721
5722 /**
5723 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
5724 * the view's unscaled width. A value of 1 means that no scaling is applied.
5725 *
5726 * @param scaleX The scaling factor.
5727 * @see #getPivotX()
5728 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005729 *
5730 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07005731 */
5732 public void setScaleX(float scaleX) {
5733 if (mScaleX != scaleX) {
5734 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005735 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005736 mScaleX = scaleX;
5737 mMatrixDirty = true;
5738 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005739 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005740 }
5741 }
5742
5743 /**
5744 * The amount that the view is scaled in y around the pivot point, as a proportion of
5745 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
5746 *
Joe Onorato93162322010-09-16 15:42:01 -04005747 * <p>By default, this is 1.0f.
5748 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005749 * @see #getPivotX()
5750 * @see #getPivotY()
5751 * @return The scaling factor.
5752 */
5753 public float getScaleY() {
5754 return mScaleY;
5755 }
5756
5757 /**
5758 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
5759 * the view's unscaled width. A value of 1 means that no scaling is applied.
5760 *
5761 * @param scaleY The scaling factor.
5762 * @see #getPivotX()
5763 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005764 *
5765 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07005766 */
5767 public void setScaleY(float scaleY) {
5768 if (mScaleY != scaleY) {
5769 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005770 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005771 mScaleY = scaleY;
5772 mMatrixDirty = true;
5773 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005774 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005775 }
5776 }
5777
5778 /**
5779 * The x location of the point around which the view is {@link #setRotation(float) rotated}
5780 * and {@link #setScaleX(float) scaled}.
5781 *
5782 * @see #getRotation()
5783 * @see #getScaleX()
5784 * @see #getScaleY()
5785 * @see #getPivotY()
5786 * @return The x location of the pivot point.
5787 */
5788 public float getPivotX() {
5789 return mPivotX;
5790 }
5791
5792 /**
5793 * Sets the x location of the point around which the view is
5794 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07005795 * By default, the pivot point is centered on the object.
5796 * Setting this property disables this behavior and causes the view to use only the
5797 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07005798 *
5799 * @param pivotX The x location of the pivot point.
5800 * @see #getRotation()
5801 * @see #getScaleX()
5802 * @see #getScaleY()
5803 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005804 *
5805 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07005806 */
5807 public void setPivotX(float pivotX) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005808 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07005809 if (mPivotX != pivotX) {
5810 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005811 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005812 mPivotX = pivotX;
5813 mMatrixDirty = true;
5814 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005815 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005816 }
5817 }
5818
5819 /**
5820 * The y location of the point around which the view is {@link #setRotation(float) rotated}
5821 * and {@link #setScaleY(float) scaled}.
5822 *
5823 * @see #getRotation()
5824 * @see #getScaleX()
5825 * @see #getScaleY()
5826 * @see #getPivotY()
5827 * @return The y location of the pivot point.
5828 */
5829 public float getPivotY() {
5830 return mPivotY;
5831 }
5832
5833 /**
5834 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07005835 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
5836 * Setting this property disables this behavior and causes the view to use only the
5837 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07005838 *
5839 * @param pivotY The y location of the pivot point.
5840 * @see #getRotation()
5841 * @see #getScaleX()
5842 * @see #getScaleY()
5843 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005844 *
5845 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07005846 */
5847 public void setPivotY(float pivotY) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005848 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07005849 if (mPivotY != pivotY) {
5850 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005851 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005852 mPivotY = pivotY;
5853 mMatrixDirty = true;
5854 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005855 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005856 }
5857 }
5858
5859 /**
5860 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
5861 * completely transparent and 1 means the view is completely opaque.
5862 *
Joe Onorato93162322010-09-16 15:42:01 -04005863 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07005864 * @return The opacity of the view.
5865 */
5866 public float getAlpha() {
5867 return mAlpha;
5868 }
5869
5870 /**
Romain Guy171c5922011-01-06 10:04:23 -08005871 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
5872 * completely transparent and 1 means the view is completely opaque.</p>
5873 *
5874 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
5875 * responsible for applying the opacity itself. Otherwise, calling this method is
5876 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
5877 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07005878 *
5879 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08005880 *
Romain Guy171c5922011-01-06 10:04:23 -08005881 * @see #setLayerType(int, android.graphics.Paint)
5882 *
Chet Haase73066682010-11-29 15:55:32 -08005883 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07005884 */
5885 public void setAlpha(float alpha) {
5886 mAlpha = alpha;
Chet Haaseed032702010-10-01 14:05:54 -07005887 if (onSetAlpha((int) (alpha * 255))) {
Romain Guya3496a92010-10-12 11:53:24 -07005888 mPrivateFlags |= ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07005889 // subclass is handling alpha - don't optimize rendering cache invalidation
5890 invalidate();
5891 } else {
Romain Guya3496a92010-10-12 11:53:24 -07005892 mPrivateFlags &= ~ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07005893 invalidate(false);
5894 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005895 }
5896
5897 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005898 * Top position of this view relative to its parent.
5899 *
5900 * @return The top of this view, in pixels.
5901 */
5902 @ViewDebug.CapturedViewProperty
5903 public final int getTop() {
5904 return mTop;
5905 }
5906
5907 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005908 * Sets the top position of this view relative to its parent. This method is meant to be called
5909 * by the layout system and should not generally be called otherwise, because the property
5910 * may be changed at any time by the layout.
5911 *
5912 * @param top The top of this view, in pixels.
5913 */
5914 public final void setTop(int top) {
5915 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07005916 updateMatrix();
5917 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07005918 final ViewParent p = mParent;
5919 if (p != null && mAttachInfo != null) {
5920 final Rect r = mAttachInfo.mTmpInvalRect;
5921 int minTop;
5922 int yLoc;
5923 if (top < mTop) {
5924 minTop = top;
5925 yLoc = top - mTop;
5926 } else {
5927 minTop = mTop;
5928 yLoc = 0;
5929 }
5930 r.set(0, yLoc, mRight - mLeft, mBottom - minTop);
5931 p.invalidateChild(this, r);
5932 }
5933 } else {
5934 // Double-invalidation is necessary to capture view's old and new areas
5935 invalidate();
5936 }
5937
Chet Haaseed032702010-10-01 14:05:54 -07005938 int width = mRight - mLeft;
5939 int oldHeight = mBottom - mTop;
5940
Chet Haase21cd1382010-09-01 17:42:29 -07005941 mTop = top;
5942
Chet Haaseed032702010-10-01 14:05:54 -07005943 onSizeChanged(width, mBottom - mTop, width, oldHeight);
5944
Chet Haase21cd1382010-09-01 17:42:29 -07005945 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08005946 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
5947 // A change in dimension means an auto-centered pivot point changes, too
5948 mMatrixDirty = true;
5949 }
Chet Haase21cd1382010-09-01 17:42:29 -07005950 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
5951 invalidate();
5952 }
Chet Haase55dbb652010-12-21 20:15:08 -08005953 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07005954 }
5955 }
5956
5957 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005958 * Bottom position of this view relative to its parent.
5959 *
5960 * @return The bottom of this view, in pixels.
5961 */
5962 @ViewDebug.CapturedViewProperty
5963 public final int getBottom() {
5964 return mBottom;
5965 }
5966
5967 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08005968 * True if this view has changed since the last time being drawn.
5969 *
5970 * @return The dirty state of this view.
5971 */
5972 public boolean isDirty() {
5973 return (mPrivateFlags & DIRTY_MASK) != 0;
5974 }
5975
5976 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005977 * Sets the bottom position of this view relative to its parent. This method is meant to be
5978 * called by the layout system and should not generally be called otherwise, because the
5979 * property may be changed at any time by the layout.
5980 *
5981 * @param bottom The bottom of this view, in pixels.
5982 */
5983 public final void setBottom(int bottom) {
5984 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07005985 updateMatrix();
5986 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07005987 final ViewParent p = mParent;
5988 if (p != null && mAttachInfo != null) {
5989 final Rect r = mAttachInfo.mTmpInvalRect;
5990 int maxBottom;
5991 if (bottom < mBottom) {
5992 maxBottom = mBottom;
5993 } else {
5994 maxBottom = bottom;
5995 }
5996 r.set(0, 0, mRight - mLeft, maxBottom - mTop);
5997 p.invalidateChild(this, r);
5998 }
5999 } else {
6000 // Double-invalidation is necessary to capture view's old and new areas
6001 invalidate();
6002 }
6003
Chet Haaseed032702010-10-01 14:05:54 -07006004 int width = mRight - mLeft;
6005 int oldHeight = mBottom - mTop;
6006
Chet Haase21cd1382010-09-01 17:42:29 -07006007 mBottom = bottom;
6008
Chet Haaseed032702010-10-01 14:05:54 -07006009 onSizeChanged(width, mBottom - mTop, width, oldHeight);
6010
Chet Haase21cd1382010-09-01 17:42:29 -07006011 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006012 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6013 // A change in dimension means an auto-centered pivot point changes, too
6014 mMatrixDirty = true;
6015 }
Chet Haase21cd1382010-09-01 17:42:29 -07006016 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
6017 invalidate();
6018 }
Chet Haase55dbb652010-12-21 20:15:08 -08006019 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07006020 }
6021 }
6022
6023 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006024 * Left position of this view relative to its parent.
6025 *
6026 * @return The left edge of this view, in pixels.
6027 */
6028 @ViewDebug.CapturedViewProperty
6029 public final int getLeft() {
6030 return mLeft;
6031 }
6032
6033 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006034 * Sets the left position of this view relative to its parent. This method is meant to be called
6035 * by the layout system and should not generally be called otherwise, because the property
6036 * may be changed at any time by the layout.
6037 *
6038 * @param left The bottom of this view, in pixels.
6039 */
6040 public final void setLeft(int left) {
6041 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07006042 updateMatrix();
6043 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07006044 final ViewParent p = mParent;
6045 if (p != null && mAttachInfo != null) {
6046 final Rect r = mAttachInfo.mTmpInvalRect;
6047 int minLeft;
6048 int xLoc;
6049 if (left < mLeft) {
6050 minLeft = left;
6051 xLoc = left - mLeft;
6052 } else {
6053 minLeft = mLeft;
6054 xLoc = 0;
6055 }
6056 r.set(xLoc, 0, mRight - minLeft, mBottom - mTop);
6057 p.invalidateChild(this, r);
6058 }
6059 } else {
6060 // Double-invalidation is necessary to capture view's old and new areas
6061 invalidate();
6062 }
6063
Chet Haaseed032702010-10-01 14:05:54 -07006064 int oldWidth = mRight - mLeft;
6065 int height = mBottom - mTop;
6066
Chet Haase21cd1382010-09-01 17:42:29 -07006067 mLeft = left;
6068
Chet Haaseed032702010-10-01 14:05:54 -07006069 onSizeChanged(mRight - mLeft, height, oldWidth, height);
6070
Chet Haase21cd1382010-09-01 17:42:29 -07006071 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006072 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6073 // A change in dimension means an auto-centered pivot point changes, too
6074 mMatrixDirty = true;
6075 }
Chet Haase21cd1382010-09-01 17:42:29 -07006076 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
6077 invalidate();
6078 }
Chet Haase55dbb652010-12-21 20:15:08 -08006079 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07006080 }
6081 }
6082
6083 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006084 * Right position of this view relative to its parent.
6085 *
6086 * @return The right edge of this view, in pixels.
6087 */
6088 @ViewDebug.CapturedViewProperty
6089 public final int getRight() {
6090 return mRight;
6091 }
6092
6093 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006094 * Sets the right position of this view relative to its parent. This method is meant to be called
6095 * by the layout system and should not generally be called otherwise, because the property
6096 * may be changed at any time by the layout.
6097 *
6098 * @param right The bottom of this view, in pixels.
6099 */
6100 public final void setRight(int right) {
6101 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07006102 updateMatrix();
6103 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07006104 final ViewParent p = mParent;
6105 if (p != null && mAttachInfo != null) {
6106 final Rect r = mAttachInfo.mTmpInvalRect;
6107 int maxRight;
6108 if (right < mRight) {
6109 maxRight = mRight;
6110 } else {
6111 maxRight = right;
6112 }
6113 r.set(0, 0, maxRight - mLeft, mBottom - mTop);
6114 p.invalidateChild(this, r);
6115 }
6116 } else {
6117 // Double-invalidation is necessary to capture view's old and new areas
6118 invalidate();
6119 }
6120
Chet Haaseed032702010-10-01 14:05:54 -07006121 int oldWidth = mRight - mLeft;
6122 int height = mBottom - mTop;
6123
Chet Haase21cd1382010-09-01 17:42:29 -07006124 mRight = right;
6125
Chet Haaseed032702010-10-01 14:05:54 -07006126 onSizeChanged(mRight - mLeft, height, oldWidth, height);
6127
Chet Haase21cd1382010-09-01 17:42:29 -07006128 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006129 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6130 // A change in dimension means an auto-centered pivot point changes, too
6131 mMatrixDirty = true;
6132 }
Chet Haase21cd1382010-09-01 17:42:29 -07006133 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
6134 invalidate();
6135 }
Chet Haase55dbb652010-12-21 20:15:08 -08006136 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07006137 }
6138 }
6139
6140 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006141 * The visual x position of this view, in pixels. This is equivalent to the
6142 * {@link #setTranslationX(float) translationX} property plus the current
6143 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07006144 *
Chet Haasedf030d22010-07-30 17:22:38 -07006145 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07006146 */
Chet Haasedf030d22010-07-30 17:22:38 -07006147 public float getX() {
6148 return mLeft + mTranslationX;
6149 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006150
Chet Haasedf030d22010-07-30 17:22:38 -07006151 /**
6152 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
6153 * {@link #setTranslationX(float) translationX} property to be the difference between
6154 * the x value passed in and the current {@link #getLeft() left} property.
6155 *
6156 * @param x The visual x position of this view, in pixels.
6157 */
6158 public void setX(float x) {
6159 setTranslationX(x - mLeft);
6160 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006161
Chet Haasedf030d22010-07-30 17:22:38 -07006162 /**
6163 * The visual y position of this view, in pixels. This is equivalent to the
6164 * {@link #setTranslationY(float) translationY} property plus the current
6165 * {@link #getTop() top} property.
6166 *
6167 * @return The visual y position of this view, in pixels.
6168 */
6169 public float getY() {
6170 return mTop + mTranslationY;
6171 }
6172
6173 /**
6174 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
6175 * {@link #setTranslationY(float) translationY} property to be the difference between
6176 * the y value passed in and the current {@link #getTop() top} property.
6177 *
6178 * @param y The visual y position of this view, in pixels.
6179 */
6180 public void setY(float y) {
6181 setTranslationY(y - mTop);
6182 }
6183
6184
6185 /**
6186 * The horizontal location of this view relative to its {@link #getLeft() left} position.
6187 * This position is post-layout, in addition to wherever the object's
6188 * layout placed it.
6189 *
6190 * @return The horizontal position of this view relative to its left position, in pixels.
6191 */
6192 public float getTranslationX() {
6193 return mTranslationX;
6194 }
6195
6196 /**
6197 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
6198 * This effectively positions the object post-layout, in addition to wherever the object's
6199 * layout placed it.
6200 *
6201 * @param translationX The horizontal position of this view relative to its left position,
6202 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08006203 *
6204 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07006205 */
6206 public void setTranslationX(float translationX) {
6207 if (mTranslationX != translationX) {
6208 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006209 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006210 mTranslationX = translationX;
6211 mMatrixDirty = true;
6212 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006213 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006214 }
6215 }
6216
6217 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006218 * The horizontal location of this view relative to its {@link #getTop() top} position.
6219 * This position is post-layout, in addition to wherever the object's
6220 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07006221 *
Chet Haasedf030d22010-07-30 17:22:38 -07006222 * @return The vertical position of this view relative to its top position,
6223 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07006224 */
Chet Haasedf030d22010-07-30 17:22:38 -07006225 public float getTranslationY() {
6226 return mTranslationY;
Chet Haasec3aa3612010-06-17 08:50:37 -07006227 }
6228
6229 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006230 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
6231 * This effectively positions the object post-layout, in addition to wherever the object's
6232 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07006233 *
Chet Haasedf030d22010-07-30 17:22:38 -07006234 * @param translationY The vertical position of this view relative to its top position,
6235 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08006236 *
6237 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07006238 */
Chet Haasedf030d22010-07-30 17:22:38 -07006239 public void setTranslationY(float translationY) {
6240 if (mTranslationY != translationY) {
6241 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006242 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006243 mTranslationY = translationY;
6244 mMatrixDirty = true;
6245 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006246 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006247 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006248 }
6249
6250 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006251 * Hit rectangle in parent's coordinates
6252 *
6253 * @param outRect The hit rectangle of the view.
6254 */
6255 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07006256 updateMatrix();
6257 if (mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006258 outRect.set(mLeft, mTop, mRight, mBottom);
6259 } else {
6260 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Romain Guy33e72ae2010-07-17 12:40:29 -07006261 tmpRect.set(-mPivotX, -mPivotY, getWidth() - mPivotX, getHeight() - mPivotY);
Jeff Brown86671742010-09-30 20:00:15 -07006262 mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07006263 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
6264 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07006265 }
6266 }
6267
6268 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07006269 * Determines whether the given point, in local coordinates is inside the view.
6270 */
6271 /*package*/ final boolean pointInView(float localX, float localY) {
6272 return localX >= 0 && localX < (mRight - mLeft)
6273 && localY >= 0 && localY < (mBottom - mTop);
6274 }
6275
6276 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07006277 * Utility method to determine whether the given point, in local coordinates,
6278 * is inside the view, where the area of the view is expanded by the slop factor.
6279 * This method is called while processing touch-move events to determine if the event
6280 * is still within the view.
6281 */
6282 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07006283 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07006284 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006285 }
6286
6287 /**
6288 * When a view has focus and the user navigates away from it, the next view is searched for
6289 * starting from the rectangle filled in by this method.
6290 *
6291 * By default, the rectange is the {@link #getDrawingRect})of the view. However, if your
6292 * view maintains some idea of internal selection, such as a cursor, or a selected row
6293 * or column, you should override this method and fill in a more specific rectangle.
6294 *
6295 * @param r The rectangle to fill in, in this view's coordinates.
6296 */
6297 public void getFocusedRect(Rect r) {
6298 getDrawingRect(r);
6299 }
6300
6301 /**
6302 * If some part of this view is not clipped by any of its parents, then
6303 * return that area in r in global (root) coordinates. To convert r to local
6304 * coordinates, offset it by -globalOffset (e.g. r.offset(-globalOffset.x,
6305 * -globalOffset.y)) If the view is completely clipped or translated out,
6306 * return false.
6307 *
6308 * @param r If true is returned, r holds the global coordinates of the
6309 * visible portion of this view.
6310 * @param globalOffset If true is returned, globalOffset holds the dx,dy
6311 * between this view and its root. globalOffet may be null.
6312 * @return true if r is non-empty (i.e. part of the view is visible at the
6313 * root level.
6314 */
6315 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
6316 int width = mRight - mLeft;
6317 int height = mBottom - mTop;
6318 if (width > 0 && height > 0) {
6319 r.set(0, 0, width, height);
6320 if (globalOffset != null) {
6321 globalOffset.set(-mScrollX, -mScrollY);
6322 }
6323 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
6324 }
6325 return false;
6326 }
6327
6328 public final boolean getGlobalVisibleRect(Rect r) {
6329 return getGlobalVisibleRect(r, null);
6330 }
6331
6332 public final boolean getLocalVisibleRect(Rect r) {
6333 Point offset = new Point();
6334 if (getGlobalVisibleRect(r, offset)) {
6335 r.offset(-offset.x, -offset.y); // make r local
6336 return true;
6337 }
6338 return false;
6339 }
6340
6341 /**
6342 * Offset this view's vertical location by the specified number of pixels.
6343 *
6344 * @param offset the number of pixels to offset the view by
6345 */
6346 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006347 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07006348 updateMatrix();
6349 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006350 final ViewParent p = mParent;
6351 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006352 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006353 int minTop;
6354 int maxBottom;
6355 int yLoc;
6356 if (offset < 0) {
6357 minTop = mTop + offset;
6358 maxBottom = mBottom;
6359 yLoc = offset;
6360 } else {
6361 minTop = mTop;
6362 maxBottom = mBottom + offset;
6363 yLoc = 0;
6364 }
6365 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
6366 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07006367 }
6368 } else {
Chet Haaseed032702010-10-01 14:05:54 -07006369 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006370 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006371
Chet Haasec3aa3612010-06-17 08:50:37 -07006372 mTop += offset;
6373 mBottom += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07006374
Chet Haasec3aa3612010-06-17 08:50:37 -07006375 if (!mMatrixIsIdentity) {
6376 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006377 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006378 }
6379 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006380 }
6381
6382 /**
6383 * Offset this view's horizontal location by the specified amount of pixels.
6384 *
6385 * @param offset the numer of pixels to offset the view by
6386 */
6387 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006388 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07006389 updateMatrix();
6390 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006391 final ViewParent p = mParent;
6392 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006393 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006394 int minLeft;
6395 int maxRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006396 if (offset < 0) {
6397 minLeft = mLeft + offset;
6398 maxRight = mRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006399 } else {
6400 minLeft = mLeft;
6401 maxRight = mRight + offset;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006402 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006403 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
Chet Haase8fbf8d22010-07-30 15:01:32 -07006404 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07006405 }
6406 } else {
Chet Haaseed032702010-10-01 14:05:54 -07006407 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006408 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006409
Chet Haasec3aa3612010-06-17 08:50:37 -07006410 mLeft += offset;
6411 mRight += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07006412
Chet Haasec3aa3612010-06-17 08:50:37 -07006413 if (!mMatrixIsIdentity) {
6414 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006415 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006416 }
6417 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006418 }
6419
6420 /**
6421 * Get the LayoutParams associated with this view. All views should have
6422 * layout parameters. These supply parameters to the <i>parent</i> of this
6423 * view specifying how it should be arranged. There are many subclasses of
6424 * ViewGroup.LayoutParams, and these correspond to the different subclasses
6425 * of ViewGroup that are responsible for arranging their children.
6426 * @return The LayoutParams associated with this view
6427 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07006428 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006429 public ViewGroup.LayoutParams getLayoutParams() {
6430 return mLayoutParams;
6431 }
6432
6433 /**
6434 * Set the layout parameters associated with this view. These supply
6435 * parameters to the <i>parent</i> of this view specifying how it should be
6436 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
6437 * correspond to the different subclasses of ViewGroup that are responsible
6438 * for arranging their children.
6439 *
6440 * @param params the layout parameters for this view
6441 */
6442 public void setLayoutParams(ViewGroup.LayoutParams params) {
6443 if (params == null) {
6444 throw new NullPointerException("params == null");
6445 }
6446 mLayoutParams = params;
6447 requestLayout();
6448 }
6449
6450 /**
6451 * Set the scrolled position of your view. This will cause a call to
6452 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6453 * invalidated.
6454 * @param x the x position to scroll to
6455 * @param y the y position to scroll to
6456 */
6457 public void scrollTo(int x, int y) {
6458 if (mScrollX != x || mScrollY != y) {
6459 int oldX = mScrollX;
6460 int oldY = mScrollY;
6461 mScrollX = x;
6462 mScrollY = y;
6463 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07006464 if (!awakenScrollBars()) {
6465 invalidate();
6466 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006467 }
6468 }
6469
6470 /**
6471 * Move the scrolled position of your view. This will cause a call to
6472 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6473 * invalidated.
6474 * @param x the amount of pixels to scroll by horizontally
6475 * @param y the amount of pixels to scroll by vertically
6476 */
6477 public void scrollBy(int x, int y) {
6478 scrollTo(mScrollX + x, mScrollY + y);
6479 }
6480
6481 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006482 * <p>Trigger the scrollbars to draw. When invoked this method starts an
6483 * animation to fade the scrollbars out after a default delay. If a subclass
6484 * provides animated scrolling, the start delay should equal the duration
6485 * of the scrolling animation.</p>
6486 *
6487 * <p>The animation starts only if at least one of the scrollbars is
6488 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
6489 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6490 * this method returns true, and false otherwise. If the animation is
6491 * started, this method calls {@link #invalidate()}; in that case the
6492 * caller should not call {@link #invalidate()}.</p>
6493 *
6494 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07006495 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07006496 *
6497 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
6498 * and {@link #scrollTo(int, int)}.</p>
6499 *
6500 * @return true if the animation is played, false otherwise
6501 *
6502 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07006503 * @see #scrollBy(int, int)
6504 * @see #scrollTo(int, int)
6505 * @see #isHorizontalScrollBarEnabled()
6506 * @see #isVerticalScrollBarEnabled()
6507 * @see #setHorizontalScrollBarEnabled(boolean)
6508 * @see #setVerticalScrollBarEnabled(boolean)
6509 */
6510 protected boolean awakenScrollBars() {
6511 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07006512 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07006513 }
6514
6515 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07006516 * Trigger the scrollbars to draw.
6517 * This method differs from awakenScrollBars() only in its default duration.
6518 * initialAwakenScrollBars() will show the scroll bars for longer than
6519 * usual to give the user more of a chance to notice them.
6520 *
6521 * @return true if the animation is played, false otherwise.
6522 */
6523 private boolean initialAwakenScrollBars() {
6524 return mScrollCache != null &&
6525 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
6526 }
6527
6528 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006529 * <p>
6530 * Trigger the scrollbars to draw. When invoked this method starts an
6531 * animation to fade the scrollbars out after a fixed delay. If a subclass
6532 * provides animated scrolling, the start delay should equal the duration of
6533 * the scrolling animation.
6534 * </p>
6535 *
6536 * <p>
6537 * The animation starts only if at least one of the scrollbars is enabled,
6538 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6539 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6540 * this method returns true, and false otherwise. If the animation is
6541 * started, this method calls {@link #invalidate()}; in that case the caller
6542 * should not call {@link #invalidate()}.
6543 * </p>
6544 *
6545 * <p>
6546 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07006547 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07006548 * </p>
6549 *
6550 * @param startDelay the delay, in milliseconds, after which the animation
6551 * should start; when the delay is 0, the animation starts
6552 * immediately
6553 * @return true if the animation is played, false otherwise
6554 *
Mike Cleronf116bf82009-09-27 19:14:12 -07006555 * @see #scrollBy(int, int)
6556 * @see #scrollTo(int, int)
6557 * @see #isHorizontalScrollBarEnabled()
6558 * @see #isVerticalScrollBarEnabled()
6559 * @see #setHorizontalScrollBarEnabled(boolean)
6560 * @see #setVerticalScrollBarEnabled(boolean)
6561 */
6562 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07006563 return awakenScrollBars(startDelay, true);
6564 }
6565
6566 /**
6567 * <p>
6568 * Trigger the scrollbars to draw. When invoked this method starts an
6569 * animation to fade the scrollbars out after a fixed delay. If a subclass
6570 * provides animated scrolling, the start delay should equal the duration of
6571 * the scrolling animation.
6572 * </p>
6573 *
6574 * <p>
6575 * The animation starts only if at least one of the scrollbars is enabled,
6576 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6577 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6578 * this method returns true, and false otherwise. If the animation is
6579 * started, this method calls {@link #invalidate()} if the invalidate parameter
6580 * is set to true; in that case the caller
6581 * should not call {@link #invalidate()}.
6582 * </p>
6583 *
6584 * <p>
6585 * This method should be invoked everytime a subclass directly updates the
6586 * scroll parameters.
6587 * </p>
6588 *
6589 * @param startDelay the delay, in milliseconds, after which the animation
6590 * should start; when the delay is 0, the animation starts
6591 * immediately
6592 *
6593 * @param invalidate Wheter this method should call invalidate
6594 *
6595 * @return true if the animation is played, false otherwise
6596 *
6597 * @see #scrollBy(int, int)
6598 * @see #scrollTo(int, int)
6599 * @see #isHorizontalScrollBarEnabled()
6600 * @see #isVerticalScrollBarEnabled()
6601 * @see #setHorizontalScrollBarEnabled(boolean)
6602 * @see #setVerticalScrollBarEnabled(boolean)
6603 */
6604 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07006605 final ScrollabilityCache scrollCache = mScrollCache;
6606
6607 if (scrollCache == null || !scrollCache.fadeScrollBars) {
6608 return false;
6609 }
6610
6611 if (scrollCache.scrollBar == null) {
6612 scrollCache.scrollBar = new ScrollBarDrawable();
6613 }
6614
6615 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
6616
Mike Cleron290947b2009-09-29 18:34:32 -07006617 if (invalidate) {
6618 // Invalidate to show the scrollbars
6619 invalidate();
6620 }
Mike Cleronf116bf82009-09-27 19:14:12 -07006621
6622 if (scrollCache.state == ScrollabilityCache.OFF) {
6623 // FIXME: this is copied from WindowManagerService.
6624 // We should get this value from the system when it
6625 // is possible to do so.
6626 final int KEY_REPEAT_FIRST_DELAY = 750;
6627 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
6628 }
6629
6630 // Tell mScrollCache when we should start fading. This may
6631 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07006632 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07006633 scrollCache.fadeStartTime = fadeStartTime;
6634 scrollCache.state = ScrollabilityCache.ON;
6635
6636 // Schedule our fader to run, unscheduling any old ones first
6637 if (mAttachInfo != null) {
6638 mAttachInfo.mHandler.removeCallbacks(scrollCache);
6639 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
6640 }
6641
6642 return true;
6643 }
6644
6645 return false;
6646 }
6647
6648 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006649 * Mark the the area defined by dirty as needing to be drawn. If the view is
6650 * visible, {@link #onDraw} will be called at some point in the future.
6651 * This must be called from a UI thread. To call from a non-UI thread, call
6652 * {@link #postInvalidate()}.
6653 *
6654 * WARNING: This method is destructive to dirty.
6655 * @param dirty the rectangle representing the bounds of the dirty region
6656 */
6657 public void invalidate(Rect dirty) {
6658 if (ViewDebug.TRACE_HIERARCHY) {
6659 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6660 }
6661
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006662 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
6663 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006664 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6665 final ViewParent p = mParent;
6666 final AttachInfo ai = mAttachInfo;
Romain Guyaf636eb2010-12-09 17:47:21 -08006667 if (p != null && ai != null && ai.mHardwareAccelerated) {
6668 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6669 // with a null dirty rect, which tells the ViewRoot to redraw everything
6670 p.invalidateChild(this, null);
6671 return;
6672 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006673 if (p != null && ai != null) {
6674 final int scrollX = mScrollX;
6675 final int scrollY = mScrollY;
6676 final Rect r = ai.mTmpInvalRect;
6677 r.set(dirty.left - scrollX, dirty.top - scrollY,
6678 dirty.right - scrollX, dirty.bottom - scrollY);
6679 mParent.invalidateChild(this, r);
6680 }
6681 }
6682 }
6683
6684 /**
6685 * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
6686 * The coordinates of the dirty rect are relative to the view.
6687 * If the view is visible, {@link #onDraw} will be called at some point
6688 * in the future. This must be called from a UI thread. To call
6689 * from a non-UI thread, call {@link #postInvalidate()}.
6690 * @param l the left position of the dirty region
6691 * @param t the top position of the dirty region
6692 * @param r the right position of the dirty region
6693 * @param b the bottom position of the dirty region
6694 */
6695 public void invalidate(int l, int t, int r, int b) {
6696 if (ViewDebug.TRACE_HIERARCHY) {
6697 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6698 }
6699
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006700 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
6701 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006702 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6703 final ViewParent p = mParent;
6704 final AttachInfo ai = mAttachInfo;
Chet Haasef2f7d8f2010-12-03 14:08:14 -08006705 if (p != null && ai != null && ai.mHardwareAccelerated) {
6706 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6707 // with a null dirty rect, which tells the ViewRoot to redraw everything
6708 p.invalidateChild(this, null);
6709 return;
6710 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006711 if (p != null && ai != null && l < r && t < b) {
6712 final int scrollX = mScrollX;
6713 final int scrollY = mScrollY;
6714 final Rect tmpr = ai.mTmpInvalRect;
6715 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
6716 p.invalidateChild(this, tmpr);
6717 }
6718 }
6719 }
6720
6721 /**
6722 * Invalidate the whole view. If the view is visible, {@link #onDraw} will
6723 * be called at some point in the future. This must be called from a
6724 * UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
6725 */
6726 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -07006727 invalidate(true);
6728 }
6729
6730 /**
6731 * This is where the invalidate() work actually happens. A full invalidate()
6732 * causes the drawing cache to be invalidated, but this function can be called with
6733 * invalidateCache set to false to skip that invalidation step for cases that do not
6734 * need it (for example, a component that remains at the same dimensions with the same
6735 * content).
6736 *
6737 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
6738 * well. This is usually true for a full invalidate, but may be set to false if the
6739 * View's contents or dimensions have not changed.
6740 */
6741 private void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006742 if (ViewDebug.TRACE_HIERARCHY) {
6743 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6744 }
6745
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006746 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
6747 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID)) {
Chet Haaseed032702010-10-01 14:05:54 -07006748 mPrivateFlags &= ~DRAWN;
6749 if (invalidateCache) {
6750 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6751 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006752 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -07006753 final ViewParent p = mParent;
Chet Haasef2f7d8f2010-12-03 14:08:14 -08006754 if (p != null && ai != null && ai.mHardwareAccelerated) {
6755 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6756 // with a null dirty rect, which tells the ViewRoot to redraw everything
6757 p.invalidateChild(this, null);
6758 return;
6759 }
Michael Jurkaebefea42010-11-15 16:04:01 -08006760
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006761 if (p != null && ai != null) {
6762 final Rect r = ai.mTmpInvalRect;
6763 r.set(0, 0, mRight - mLeft, mBottom - mTop);
6764 // Don't call invalidate -- we don't want to internally scroll
6765 // our own bounds
6766 p.invalidateChild(this, r);
6767 }
6768 }
6769 }
6770
6771 /**
Romain Guy24443ea2009-05-11 11:56:30 -07006772 * Indicates whether this View is opaque. An opaque View guarantees that it will
6773 * draw all the pixels overlapping its bounds using a fully opaque color.
6774 *
6775 * Subclasses of View should override this method whenever possible to indicate
6776 * whether an instance is opaque. Opaque Views are treated in a special way by
6777 * the View hierarchy, possibly allowing it to perform optimizations during
6778 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -07006779 *
Romain Guy24443ea2009-05-11 11:56:30 -07006780 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -07006781 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07006782 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -07006783 public boolean isOpaque() {
Chet Haase70d4ba12010-10-06 09:46:45 -07006784 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK &&
6785 (mAlpha >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD);
Romain Guy8f1344f52009-05-15 16:03:59 -07006786 }
6787
Adam Powell20232d02010-12-08 21:08:53 -08006788 /**
6789 * @hide
6790 */
6791 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -07006792 // Opaque if:
6793 // - Has a background
6794 // - Background is opaque
6795 // - Doesn't have scrollbars or scrollbars are inside overlay
6796
6797 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) {
6798 mPrivateFlags |= OPAQUE_BACKGROUND;
6799 } else {
6800 mPrivateFlags &= ~OPAQUE_BACKGROUND;
6801 }
6802
6803 final int flags = mViewFlags;
6804 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
6805 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
6806 mPrivateFlags |= OPAQUE_SCROLLBARS;
6807 } else {
6808 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
6809 }
6810 }
6811
6812 /**
6813 * @hide
6814 */
6815 protected boolean hasOpaqueScrollbars() {
6816 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -07006817 }
6818
6819 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006820 * @return A handler associated with the thread running the View. This
6821 * handler can be used to pump events in the UI events queue.
6822 */
6823 public Handler getHandler() {
6824 if (mAttachInfo != null) {
6825 return mAttachInfo.mHandler;
6826 }
6827 return null;
6828 }
6829
6830 /**
6831 * Causes the Runnable to be added to the message queue.
6832 * The runnable will be run on the user interface thread.
6833 *
6834 * @param action The Runnable that will be executed.
6835 *
6836 * @return Returns true if the Runnable was successfully placed in to the
6837 * message queue. Returns false on failure, usually because the
6838 * looper processing the message queue is exiting.
6839 */
6840 public boolean post(Runnable action) {
6841 Handler handler;
6842 if (mAttachInfo != null) {
6843 handler = mAttachInfo.mHandler;
6844 } else {
6845 // Assume that post will succeed later
6846 ViewRoot.getRunQueue().post(action);
6847 return true;
6848 }
6849
6850 return handler.post(action);
6851 }
6852
6853 /**
6854 * Causes the Runnable to be added to the message queue, to be run
6855 * after the specified amount of time elapses.
6856 * The runnable will be run on the user interface thread.
6857 *
6858 * @param action The Runnable that will be executed.
6859 * @param delayMillis The delay (in milliseconds) until the Runnable
6860 * will be executed.
6861 *
6862 * @return true if the Runnable was successfully placed in to the
6863 * message queue. Returns false on failure, usually because the
6864 * looper processing the message queue is exiting. Note that a
6865 * result of true does not mean the Runnable will be processed --
6866 * if the looper is quit before the delivery time of the message
6867 * occurs then the message will be dropped.
6868 */
6869 public boolean postDelayed(Runnable action, long delayMillis) {
6870 Handler handler;
6871 if (mAttachInfo != null) {
6872 handler = mAttachInfo.mHandler;
6873 } else {
6874 // Assume that post will succeed later
6875 ViewRoot.getRunQueue().postDelayed(action, delayMillis);
6876 return true;
6877 }
6878
6879 return handler.postDelayed(action, delayMillis);
6880 }
6881
6882 /**
6883 * Removes the specified Runnable from the message queue.
6884 *
6885 * @param action The Runnable to remove from the message handling queue
6886 *
6887 * @return true if this view could ask the Handler to remove the Runnable,
6888 * false otherwise. When the returned value is true, the Runnable
6889 * may or may not have been actually removed from the message queue
6890 * (for instance, if the Runnable was not in the queue already.)
6891 */
6892 public boolean removeCallbacks(Runnable action) {
6893 Handler handler;
6894 if (mAttachInfo != null) {
6895 handler = mAttachInfo.mHandler;
6896 } else {
6897 // Assume that post will succeed later
6898 ViewRoot.getRunQueue().removeCallbacks(action);
6899 return true;
6900 }
6901
6902 handler.removeCallbacks(action);
6903 return true;
6904 }
6905
6906 /**
6907 * Cause an invalidate to happen on a subsequent cycle through the event loop.
6908 * Use this to invalidate the View from a non-UI thread.
6909 *
6910 * @see #invalidate()
6911 */
6912 public void postInvalidate() {
6913 postInvalidateDelayed(0);
6914 }
6915
6916 /**
6917 * Cause an invalidate of the specified area to happen on a subsequent cycle
6918 * through the event loop. Use this to invalidate the View from a non-UI thread.
6919 *
6920 * @param left The left coordinate of the rectangle to invalidate.
6921 * @param top The top coordinate of the rectangle to invalidate.
6922 * @param right The right coordinate of the rectangle to invalidate.
6923 * @param bottom The bottom coordinate of the rectangle to invalidate.
6924 *
6925 * @see #invalidate(int, int, int, int)
6926 * @see #invalidate(Rect)
6927 */
6928 public void postInvalidate(int left, int top, int right, int bottom) {
6929 postInvalidateDelayed(0, left, top, right, bottom);
6930 }
6931
6932 /**
6933 * Cause an invalidate to happen on a subsequent cycle through the event
6934 * loop. Waits for the specified amount of time.
6935 *
6936 * @param delayMilliseconds the duration in milliseconds to delay the
6937 * invalidation by
6938 */
6939 public void postInvalidateDelayed(long delayMilliseconds) {
6940 // We try only with the AttachInfo because there's no point in invalidating
6941 // if we are not attached to our window
6942 if (mAttachInfo != null) {
6943 Message msg = Message.obtain();
6944 msg.what = AttachInfo.INVALIDATE_MSG;
6945 msg.obj = this;
6946 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
6947 }
6948 }
6949
6950 /**
6951 * Cause an invalidate of the specified area to happen on a subsequent cycle
6952 * through the event loop. Waits for the specified amount of time.
6953 *
6954 * @param delayMilliseconds the duration in milliseconds to delay the
6955 * invalidation by
6956 * @param left The left coordinate of the rectangle to invalidate.
6957 * @param top The top coordinate of the rectangle to invalidate.
6958 * @param right The right coordinate of the rectangle to invalidate.
6959 * @param bottom The bottom coordinate of the rectangle to invalidate.
6960 */
6961 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
6962 int right, int bottom) {
6963
6964 // We try only with the AttachInfo because there's no point in invalidating
6965 // if we are not attached to our window
6966 if (mAttachInfo != null) {
6967 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
6968 info.target = this;
6969 info.left = left;
6970 info.top = top;
6971 info.right = right;
6972 info.bottom = bottom;
6973
6974 final Message msg = Message.obtain();
6975 msg.what = AttachInfo.INVALIDATE_RECT_MSG;
6976 msg.obj = info;
6977 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
6978 }
6979 }
6980
6981 /**
6982 * Called by a parent to request that a child update its values for mScrollX
6983 * and mScrollY if necessary. This will typically be done if the child is
6984 * animating a scroll using a {@link android.widget.Scroller Scroller}
6985 * object.
6986 */
6987 public void computeScroll() {
6988 }
6989
6990 /**
6991 * <p>Indicate whether the horizontal edges are faded when the view is
6992 * scrolled horizontally.</p>
6993 *
6994 * @return true if the horizontal edges should are faded on scroll, false
6995 * otherwise
6996 *
6997 * @see #setHorizontalFadingEdgeEnabled(boolean)
6998 * @attr ref android.R.styleable#View_fadingEdge
6999 */
7000 public boolean isHorizontalFadingEdgeEnabled() {
7001 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
7002 }
7003
7004 /**
7005 * <p>Define whether the horizontal edges should be faded when this view
7006 * is scrolled horizontally.</p>
7007 *
7008 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
7009 * be faded when the view is scrolled
7010 * horizontally
7011 *
7012 * @see #isHorizontalFadingEdgeEnabled()
7013 * @attr ref android.R.styleable#View_fadingEdge
7014 */
7015 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
7016 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
7017 if (horizontalFadingEdgeEnabled) {
7018 initScrollCache();
7019 }
7020
7021 mViewFlags ^= FADING_EDGE_HORIZONTAL;
7022 }
7023 }
7024
7025 /**
7026 * <p>Indicate whether the vertical edges are faded when the view is
7027 * scrolled horizontally.</p>
7028 *
7029 * @return true if the vertical edges should are faded on scroll, false
7030 * otherwise
7031 *
7032 * @see #setVerticalFadingEdgeEnabled(boolean)
7033 * @attr ref android.R.styleable#View_fadingEdge
7034 */
7035 public boolean isVerticalFadingEdgeEnabled() {
7036 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
7037 }
7038
7039 /**
7040 * <p>Define whether the vertical edges should be faded when this view
7041 * is scrolled vertically.</p>
7042 *
7043 * @param verticalFadingEdgeEnabled true if the vertical edges should
7044 * be faded when the view is scrolled
7045 * vertically
7046 *
7047 * @see #isVerticalFadingEdgeEnabled()
7048 * @attr ref android.R.styleable#View_fadingEdge
7049 */
7050 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
7051 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
7052 if (verticalFadingEdgeEnabled) {
7053 initScrollCache();
7054 }
7055
7056 mViewFlags ^= FADING_EDGE_VERTICAL;
7057 }
7058 }
7059
7060 /**
7061 * Returns the strength, or intensity, of the top faded edge. The strength is
7062 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7063 * returns 0.0 or 1.0 but no value in between.
7064 *
7065 * Subclasses should override this method to provide a smoother fade transition
7066 * when scrolling occurs.
7067 *
7068 * @return the intensity of the top fade as a float between 0.0f and 1.0f
7069 */
7070 protected float getTopFadingEdgeStrength() {
7071 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
7072 }
7073
7074 /**
7075 * Returns the strength, or intensity, of the bottom faded edge. The strength is
7076 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7077 * returns 0.0 or 1.0 but no value in between.
7078 *
7079 * Subclasses should override this method to provide a smoother fade transition
7080 * when scrolling occurs.
7081 *
7082 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
7083 */
7084 protected float getBottomFadingEdgeStrength() {
7085 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
7086 computeVerticalScrollRange() ? 1.0f : 0.0f;
7087 }
7088
7089 /**
7090 * Returns the strength, or intensity, of the left faded edge. The strength is
7091 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7092 * returns 0.0 or 1.0 but no value in between.
7093 *
7094 * Subclasses should override this method to provide a smoother fade transition
7095 * when scrolling occurs.
7096 *
7097 * @return the intensity of the left fade as a float between 0.0f and 1.0f
7098 */
7099 protected float getLeftFadingEdgeStrength() {
7100 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
7101 }
7102
7103 /**
7104 * Returns the strength, or intensity, of the right faded edge. The strength is
7105 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7106 * returns 0.0 or 1.0 but no value in between.
7107 *
7108 * Subclasses should override this method to provide a smoother fade transition
7109 * when scrolling occurs.
7110 *
7111 * @return the intensity of the right fade as a float between 0.0f and 1.0f
7112 */
7113 protected float getRightFadingEdgeStrength() {
7114 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
7115 computeHorizontalScrollRange() ? 1.0f : 0.0f;
7116 }
7117
7118 /**
7119 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
7120 * scrollbar is not drawn by default.</p>
7121 *
7122 * @return true if the horizontal scrollbar should be painted, false
7123 * otherwise
7124 *
7125 * @see #setHorizontalScrollBarEnabled(boolean)
7126 */
7127 public boolean isHorizontalScrollBarEnabled() {
7128 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
7129 }
7130
7131 /**
7132 * <p>Define whether the horizontal scrollbar should be drawn or not. The
7133 * scrollbar is not drawn by default.</p>
7134 *
7135 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
7136 * be painted
7137 *
7138 * @see #isHorizontalScrollBarEnabled()
7139 */
7140 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
7141 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
7142 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07007143 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007144 recomputePadding();
7145 }
7146 }
7147
7148 /**
7149 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
7150 * scrollbar is not drawn by default.</p>
7151 *
7152 * @return true if the vertical scrollbar should be painted, false
7153 * otherwise
7154 *
7155 * @see #setVerticalScrollBarEnabled(boolean)
7156 */
7157 public boolean isVerticalScrollBarEnabled() {
7158 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
7159 }
7160
7161 /**
7162 * <p>Define whether the vertical scrollbar should be drawn or not. The
7163 * scrollbar is not drawn by default.</p>
7164 *
7165 * @param verticalScrollBarEnabled true if the vertical scrollbar should
7166 * be painted
7167 *
7168 * @see #isVerticalScrollBarEnabled()
7169 */
7170 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
7171 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
7172 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07007173 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007174 recomputePadding();
7175 }
7176 }
7177
Adam Powell20232d02010-12-08 21:08:53 -08007178 /**
7179 * @hide
7180 */
7181 protected void recomputePadding() {
7182 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007183 }
Mike Cleronfe81d382009-09-28 14:22:16 -07007184
7185 /**
7186 * Define whether scrollbars will fade when the view is not scrolling.
7187 *
7188 * @param fadeScrollbars wheter to enable fading
7189 *
7190 */
7191 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
7192 initScrollCache();
7193 final ScrollabilityCache scrollabilityCache = mScrollCache;
7194 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -07007195 if (fadeScrollbars) {
7196 scrollabilityCache.state = ScrollabilityCache.OFF;
7197 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -07007198 scrollabilityCache.state = ScrollabilityCache.ON;
7199 }
7200 }
7201
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007202 /**
Mike Cleron52f0a642009-09-28 18:21:37 -07007203 *
7204 * Returns true if scrollbars will fade when this view is not scrolling
7205 *
7206 * @return true if scrollbar fading is enabled
7207 */
7208 public boolean isScrollbarFadingEnabled() {
7209 return mScrollCache != null && mScrollCache.fadeScrollBars;
7210 }
7211
7212 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007213 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
7214 * inset. When inset, they add to the padding of the view. And the scrollbars
7215 * can be drawn inside the padding area or on the edge of the view. For example,
7216 * if a view has a background drawable and you want to draw the scrollbars
7217 * inside the padding specified by the drawable, you can use
7218 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
7219 * appear at the edge of the view, ignoring the padding, then you can use
7220 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
7221 * @param style the style of the scrollbars. Should be one of
7222 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
7223 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
7224 * @see #SCROLLBARS_INSIDE_OVERLAY
7225 * @see #SCROLLBARS_INSIDE_INSET
7226 * @see #SCROLLBARS_OUTSIDE_OVERLAY
7227 * @see #SCROLLBARS_OUTSIDE_INSET
7228 */
7229 public void setScrollBarStyle(int style) {
7230 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
7231 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -07007232 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007233 recomputePadding();
7234 }
7235 }
7236
7237 /**
7238 * <p>Returns the current scrollbar style.</p>
7239 * @return the current scrollbar style
7240 * @see #SCROLLBARS_INSIDE_OVERLAY
7241 * @see #SCROLLBARS_INSIDE_INSET
7242 * @see #SCROLLBARS_OUTSIDE_OVERLAY
7243 * @see #SCROLLBARS_OUTSIDE_INSET
7244 */
7245 public int getScrollBarStyle() {
7246 return mViewFlags & SCROLLBARS_STYLE_MASK;
7247 }
7248
7249 /**
7250 * <p>Compute the horizontal range that the horizontal scrollbar
7251 * represents.</p>
7252 *
7253 * <p>The range is expressed in arbitrary units that must be the same as the
7254 * units used by {@link #computeHorizontalScrollExtent()} and
7255 * {@link #computeHorizontalScrollOffset()}.</p>
7256 *
7257 * <p>The default range is the drawing width of this view.</p>
7258 *
7259 * @return the total horizontal range represented by the horizontal
7260 * scrollbar
7261 *
7262 * @see #computeHorizontalScrollExtent()
7263 * @see #computeHorizontalScrollOffset()
7264 * @see android.widget.ScrollBarDrawable
7265 */
7266 protected int computeHorizontalScrollRange() {
7267 return getWidth();
7268 }
7269
7270 /**
7271 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
7272 * within the horizontal range. This value is used to compute the position
7273 * of the thumb within the scrollbar's track.</p>
7274 *
7275 * <p>The range is expressed in arbitrary units that must be the same as the
7276 * units used by {@link #computeHorizontalScrollRange()} and
7277 * {@link #computeHorizontalScrollExtent()}.</p>
7278 *
7279 * <p>The default offset is the scroll offset of this view.</p>
7280 *
7281 * @return the horizontal offset of the scrollbar's thumb
7282 *
7283 * @see #computeHorizontalScrollRange()
7284 * @see #computeHorizontalScrollExtent()
7285 * @see android.widget.ScrollBarDrawable
7286 */
7287 protected int computeHorizontalScrollOffset() {
7288 return mScrollX;
7289 }
7290
7291 /**
7292 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
7293 * within the horizontal range. This value is used to compute the length
7294 * of the thumb within the scrollbar's track.</p>
7295 *
7296 * <p>The range is expressed in arbitrary units that must be the same as the
7297 * units used by {@link #computeHorizontalScrollRange()} and
7298 * {@link #computeHorizontalScrollOffset()}.</p>
7299 *
7300 * <p>The default extent is the drawing width of this view.</p>
7301 *
7302 * @return the horizontal extent of the scrollbar's thumb
7303 *
7304 * @see #computeHorizontalScrollRange()
7305 * @see #computeHorizontalScrollOffset()
7306 * @see android.widget.ScrollBarDrawable
7307 */
7308 protected int computeHorizontalScrollExtent() {
7309 return getWidth();
7310 }
7311
7312 /**
7313 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
7314 *
7315 * <p>The range is expressed in arbitrary units that must be the same as the
7316 * units used by {@link #computeVerticalScrollExtent()} and
7317 * {@link #computeVerticalScrollOffset()}.</p>
7318 *
7319 * @return the total vertical range represented by the vertical scrollbar
7320 *
7321 * <p>The default range is the drawing height of this view.</p>
7322 *
7323 * @see #computeVerticalScrollExtent()
7324 * @see #computeVerticalScrollOffset()
7325 * @see android.widget.ScrollBarDrawable
7326 */
7327 protected int computeVerticalScrollRange() {
7328 return getHeight();
7329 }
7330
7331 /**
7332 * <p>Compute the vertical offset of the vertical scrollbar's thumb
7333 * within the horizontal range. This value is used to compute the position
7334 * of the thumb within the scrollbar's track.</p>
7335 *
7336 * <p>The range is expressed in arbitrary units that must be the same as the
7337 * units used by {@link #computeVerticalScrollRange()} and
7338 * {@link #computeVerticalScrollExtent()}.</p>
7339 *
7340 * <p>The default offset is the scroll offset of this view.</p>
7341 *
7342 * @return the vertical offset of the scrollbar's thumb
7343 *
7344 * @see #computeVerticalScrollRange()
7345 * @see #computeVerticalScrollExtent()
7346 * @see android.widget.ScrollBarDrawable
7347 */
7348 protected int computeVerticalScrollOffset() {
7349 return mScrollY;
7350 }
7351
7352 /**
7353 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
7354 * within the vertical range. This value is used to compute the length
7355 * of the thumb within the scrollbar's track.</p>
7356 *
7357 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -08007358 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007359 * {@link #computeVerticalScrollOffset()}.</p>
7360 *
7361 * <p>The default extent is the drawing height of this view.</p>
7362 *
7363 * @return the vertical extent of the scrollbar's thumb
7364 *
7365 * @see #computeVerticalScrollRange()
7366 * @see #computeVerticalScrollOffset()
7367 * @see android.widget.ScrollBarDrawable
7368 */
7369 protected int computeVerticalScrollExtent() {
7370 return getHeight();
7371 }
7372
7373 /**
7374 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
7375 * scrollbars are painted only if they have been awakened first.</p>
7376 *
7377 * @param canvas the canvas on which to draw the scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -07007378 *
7379 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007380 */
Romain Guy1d5b3a62009-11-05 18:44:12 -08007381 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007382 // scrollbars are drawn only when the animation is running
7383 final ScrollabilityCache cache = mScrollCache;
7384 if (cache != null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07007385
7386 int state = cache.state;
7387
7388 if (state == ScrollabilityCache.OFF) {
7389 return;
7390 }
7391
7392 boolean invalidate = false;
7393
7394 if (state == ScrollabilityCache.FADING) {
7395 // We're fading -- get our fade interpolation
7396 if (cache.interpolatorValues == null) {
7397 cache.interpolatorValues = new float[1];
7398 }
7399
7400 float[] values = cache.interpolatorValues;
7401
7402 // Stops the animation if we're done
7403 if (cache.scrollBarInterpolator.timeToValues(values) ==
7404 Interpolator.Result.FREEZE_END) {
7405 cache.state = ScrollabilityCache.OFF;
7406 } else {
7407 cache.scrollBar.setAlpha(Math.round(values[0]));
7408 }
7409
7410 // This will make the scroll bars inval themselves after
7411 // drawing. We only want this when we're fading so that
7412 // we prevent excessive redraws
7413 invalidate = true;
7414 } else {
7415 // We're just on -- but we may have been fading before so
7416 // reset alpha
7417 cache.scrollBar.setAlpha(255);
7418 }
7419
7420
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007421 final int viewFlags = mViewFlags;
7422
7423 final boolean drawHorizontalScrollBar =
7424 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
7425 final boolean drawVerticalScrollBar =
7426 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
7427 && !isVerticalScrollBarHidden();
7428
7429 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
7430 final int width = mRight - mLeft;
7431 final int height = mBottom - mTop;
7432
7433 final ScrollBarDrawable scrollBar = cache.scrollBar;
7434 int size = scrollBar.getSize(false);
7435 if (size <= 0) {
7436 size = cache.scrollBarSize;
7437 }
7438
Mike Reede8853fc2009-09-04 14:01:48 -04007439 final int scrollX = mScrollX;
7440 final int scrollY = mScrollY;
7441 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
7442
Mike Cleronf116bf82009-09-27 19:14:12 -07007443 int left, top, right, bottom;
7444
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007445 if (drawHorizontalScrollBar) {
Mike Cleronf116bf82009-09-27 19:14:12 -07007446 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -04007447 computeHorizontalScrollOffset(),
7448 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -04007449 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -07007450 getVerticalScrollbarWidth() : 0;
7451 top = scrollY + height - size - (mUserPaddingBottom & inside);
7452 left = scrollX + (mPaddingLeft & inside);
7453 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
7454 bottom = top + size;
7455 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
7456 if (invalidate) {
7457 invalidate(left, top, right, bottom);
7458 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007459 }
7460
7461 if (drawVerticalScrollBar) {
Mike Reede8853fc2009-09-04 14:01:48 -04007462 scrollBar.setParameters(computeVerticalScrollRange(),
7463 computeVerticalScrollOffset(),
7464 computeVerticalScrollExtent(), true);
Adam Powell20232d02010-12-08 21:08:53 -08007465 switch (mVerticalScrollbarPosition) {
7466 default:
7467 case SCROLLBAR_POSITION_DEFAULT:
7468 case SCROLLBAR_POSITION_RIGHT:
7469 left = scrollX + width - size - (mUserPaddingRight & inside);
7470 break;
7471 case SCROLLBAR_POSITION_LEFT:
7472 left = scrollX + (mUserPaddingLeft & inside);
7473 break;
7474 }
Mike Cleronf116bf82009-09-27 19:14:12 -07007475 top = scrollY + (mPaddingTop & inside);
7476 right = left + size;
7477 bottom = scrollY + height - (mUserPaddingBottom & inside);
7478 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
7479 if (invalidate) {
7480 invalidate(left, top, right, bottom);
7481 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007482 }
7483 }
7484 }
7485 }
Romain Guy8506ab42009-06-11 17:35:47 -07007486
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007487 /**
Romain Guy8506ab42009-06-11 17:35:47 -07007488 * 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 -08007489 * FastScroller is visible.
7490 * @return whether to temporarily hide the vertical scrollbar
7491 * @hide
7492 */
7493 protected boolean isVerticalScrollBarHidden() {
7494 return false;
7495 }
7496
7497 /**
7498 * <p>Draw the horizontal scrollbar if
7499 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
7500 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007501 * @param canvas the canvas on which to draw the scrollbar
7502 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007503 *
7504 * @see #isHorizontalScrollBarEnabled()
7505 * @see #computeHorizontalScrollRange()
7506 * @see #computeHorizontalScrollExtent()
7507 * @see #computeHorizontalScrollOffset()
7508 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -07007509 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007510 */
Romain Guy8fb95422010-08-17 18:38:51 -07007511 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
7512 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007513 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007514 scrollBar.draw(canvas);
7515 }
Mike Reede8853fc2009-09-04 14:01:48 -04007516
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007517 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007518 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
7519 * returns true.</p>
7520 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007521 * @param canvas the canvas on which to draw the scrollbar
7522 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007523 *
7524 * @see #isVerticalScrollBarEnabled()
7525 * @see #computeVerticalScrollRange()
7526 * @see #computeVerticalScrollExtent()
7527 * @see #computeVerticalScrollOffset()
7528 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -04007529 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007530 */
Romain Guy8fb95422010-08-17 18:38:51 -07007531 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
7532 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -04007533 scrollBar.setBounds(l, t, r, b);
7534 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007535 }
7536
7537 /**
7538 * Implement this to do your drawing.
7539 *
7540 * @param canvas the canvas on which the background will be drawn
7541 */
7542 protected void onDraw(Canvas canvas) {
7543 }
7544
7545 /*
7546 * Caller is responsible for calling requestLayout if necessary.
7547 * (This allows addViewInLayout to not request a new layout.)
7548 */
7549 void assignParent(ViewParent parent) {
7550 if (mParent == null) {
7551 mParent = parent;
7552 } else if (parent == null) {
7553 mParent = null;
7554 } else {
7555 throw new RuntimeException("view " + this + " being added, but"
7556 + " it already has a parent");
7557 }
7558 }
7559
7560 /**
7561 * This is called when the view is attached to a window. At this point it
7562 * has a Surface and will start drawing. Note that this function is
7563 * guaranteed to be called before {@link #onDraw}, however it may be called
7564 * any time before the first onDraw -- including before or after
7565 * {@link #onMeasure}.
7566 *
7567 * @see #onDetachedFromWindow()
7568 */
7569 protected void onAttachedToWindow() {
7570 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
7571 mParent.requestTransparentRegion(this);
7572 }
Adam Powell8568c3a2010-04-19 14:26:11 -07007573 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
7574 initialAwakenScrollBars();
7575 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
7576 }
Chet Haasea9b61ac2010-12-20 07:40:25 -08007577 jumpDrawablesToCurrentState();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007578 }
7579
7580 /**
7581 * This is called when the view is detached from a window. At this point it
7582 * no longer has a surface for drawing.
7583 *
7584 * @see #onAttachedToWindow()
7585 */
7586 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -08007587 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -08007588
Romain Guya440b002010-02-24 15:57:54 -08007589 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -05007590 removeLongPressCallback();
Adam Powell3cb8b632011-01-21 15:34:14 -08007591 removePerformClickCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -08007592
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007593 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -08007594
7595 if (mHardwareLayer != null) {
7596 mHardwareLayer.destroy();
7597 mHardwareLayer = null;
7598 }
Romain Guy8dd5b1e2011-01-14 17:28:51 -08007599
7600 if (mAttachInfo != null) {
7601 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_MSG, this);
7602 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_RECT_MSG, this);
7603 }
7604
Patrick Dubroyec84c3a2011-01-13 17:55:37 -08007605 mCurrentAnimation = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007606 }
7607
7608 /**
7609 * @return The number of times this view has been attached to a window
7610 */
7611 protected int getWindowAttachCount() {
7612 return mWindowAttachCount;
7613 }
7614
7615 /**
7616 * Retrieve a unique token identifying the window this view is attached to.
7617 * @return Return the window's token for use in
7618 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
7619 */
7620 public IBinder getWindowToken() {
7621 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
7622 }
7623
7624 /**
7625 * Retrieve a unique token identifying the top-level "real" window of
7626 * the window that this view is attached to. That is, this is like
7627 * {@link #getWindowToken}, except if the window this view in is a panel
7628 * window (attached to another containing window), then the token of
7629 * the containing window is returned instead.
7630 *
7631 * @return Returns the associated window token, either
7632 * {@link #getWindowToken()} or the containing window's token.
7633 */
7634 public IBinder getApplicationWindowToken() {
7635 AttachInfo ai = mAttachInfo;
7636 if (ai != null) {
7637 IBinder appWindowToken = ai.mPanelParentWindowToken;
7638 if (appWindowToken == null) {
7639 appWindowToken = ai.mWindowToken;
7640 }
7641 return appWindowToken;
7642 }
7643 return null;
7644 }
7645
7646 /**
7647 * Retrieve private session object this view hierarchy is using to
7648 * communicate with the window manager.
7649 * @return the session object to communicate with the window manager
7650 */
7651 /*package*/ IWindowSession getWindowSession() {
7652 return mAttachInfo != null ? mAttachInfo.mSession : null;
7653 }
7654
7655 /**
7656 * @param info the {@link android.view.View.AttachInfo} to associated with
7657 * this view
7658 */
7659 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
7660 //System.out.println("Attached! " + this);
7661 mAttachInfo = info;
7662 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08007663 // We will need to evaluate the drawable state at least once.
7664 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007665 if (mFloatingTreeObserver != null) {
7666 info.mTreeObserver.merge(mFloatingTreeObserver);
7667 mFloatingTreeObserver = null;
7668 }
7669 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
7670 mAttachInfo.mScrollContainers.add(this);
7671 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
7672 }
7673 performCollectViewAttributes(visibility);
7674 onAttachedToWindow();
7675 int vis = info.mWindowVisibility;
7676 if (vis != GONE) {
7677 onWindowVisibilityChanged(vis);
7678 }
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08007679 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) {
7680 // If nobody has evaluated the drawable state yet, then do it now.
7681 refreshDrawableState();
7682 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007683 }
7684
7685 void dispatchDetachedFromWindow() {
7686 //System.out.println("Detached! " + this);
7687 AttachInfo info = mAttachInfo;
7688 if (info != null) {
7689 int vis = info.mWindowVisibility;
7690 if (vis != GONE) {
7691 onWindowVisibilityChanged(GONE);
7692 }
7693 }
7694
7695 onDetachedFromWindow();
7696 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
7697 mAttachInfo.mScrollContainers.remove(this);
7698 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
7699 }
7700 mAttachInfo = null;
7701 }
7702
7703 /**
7704 * Store this view hierarchy's frozen state into the given container.
7705 *
7706 * @param container The SparseArray in which to save the view's state.
7707 *
7708 * @see #restoreHierarchyState
7709 * @see #dispatchSaveInstanceState
7710 * @see #onSaveInstanceState
7711 */
7712 public void saveHierarchyState(SparseArray<Parcelable> container) {
7713 dispatchSaveInstanceState(container);
7714 }
7715
7716 /**
7717 * Called by {@link #saveHierarchyState} to store the state for this view and its children.
7718 * May be overridden to modify how freezing happens to a view's children; for example, some
7719 * views may want to not store state for their children.
7720 *
7721 * @param container The SparseArray in which to save the view's state.
7722 *
7723 * @see #dispatchRestoreInstanceState
7724 * @see #saveHierarchyState
7725 * @see #onSaveInstanceState
7726 */
7727 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
7728 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
7729 mPrivateFlags &= ~SAVE_STATE_CALLED;
7730 Parcelable state = onSaveInstanceState();
7731 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
7732 throw new IllegalStateException(
7733 "Derived class did not call super.onSaveInstanceState()");
7734 }
7735 if (state != null) {
7736 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
7737 // + ": " + state);
7738 container.put(mID, state);
7739 }
7740 }
7741 }
7742
7743 /**
7744 * Hook allowing a view to generate a representation of its internal state
7745 * that can later be used to create a new instance with that same state.
7746 * This state should only contain information that is not persistent or can
7747 * not be reconstructed later. For example, you will never store your
7748 * current position on screen because that will be computed again when a
7749 * new instance of the view is placed in its view hierarchy.
7750 * <p>
7751 * Some examples of things you may store here: the current cursor position
7752 * in a text view (but usually not the text itself since that is stored in a
7753 * content provider or other persistent storage), the currently selected
7754 * item in a list view.
7755 *
7756 * @return Returns a Parcelable object containing the view's current dynamic
7757 * state, or null if there is nothing interesting to save. The
7758 * default implementation returns null.
7759 * @see #onRestoreInstanceState
7760 * @see #saveHierarchyState
7761 * @see #dispatchSaveInstanceState
7762 * @see #setSaveEnabled(boolean)
7763 */
7764 protected Parcelable onSaveInstanceState() {
7765 mPrivateFlags |= SAVE_STATE_CALLED;
7766 return BaseSavedState.EMPTY_STATE;
7767 }
7768
7769 /**
7770 * Restore this view hierarchy's frozen state from the given container.
7771 *
7772 * @param container The SparseArray which holds previously frozen states.
7773 *
7774 * @see #saveHierarchyState
7775 * @see #dispatchRestoreInstanceState
7776 * @see #onRestoreInstanceState
7777 */
7778 public void restoreHierarchyState(SparseArray<Parcelable> container) {
7779 dispatchRestoreInstanceState(container);
7780 }
7781
7782 /**
7783 * Called by {@link #restoreHierarchyState} to retrieve the state for this view and its
7784 * children. May be overridden to modify how restoreing happens to a view's children; for
7785 * example, some views may want to not store state for their children.
7786 *
7787 * @param container The SparseArray which holds previously saved state.
7788 *
7789 * @see #dispatchSaveInstanceState
7790 * @see #restoreHierarchyState
7791 * @see #onRestoreInstanceState
7792 */
7793 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
7794 if (mID != NO_ID) {
7795 Parcelable state = container.get(mID);
7796 if (state != null) {
7797 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
7798 // + ": " + state);
7799 mPrivateFlags &= ~SAVE_STATE_CALLED;
7800 onRestoreInstanceState(state);
7801 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
7802 throw new IllegalStateException(
7803 "Derived class did not call super.onRestoreInstanceState()");
7804 }
7805 }
7806 }
7807 }
7808
7809 /**
7810 * Hook allowing a view to re-apply a representation of its internal state that had previously
7811 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
7812 * null state.
7813 *
7814 * @param state The frozen state that had previously been returned by
7815 * {@link #onSaveInstanceState}.
7816 *
7817 * @see #onSaveInstanceState
7818 * @see #restoreHierarchyState
7819 * @see #dispatchRestoreInstanceState
7820 */
7821 protected void onRestoreInstanceState(Parcelable state) {
7822 mPrivateFlags |= SAVE_STATE_CALLED;
7823 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -08007824 throw new IllegalArgumentException("Wrong state class, expecting View State but "
7825 + "received " + state.getClass().toString() + " instead. This usually happens "
7826 + "when two views of different type have the same id in the same hierarchy. "
7827 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
7828 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007829 }
7830 }
7831
7832 /**
7833 * <p>Return the time at which the drawing of the view hierarchy started.</p>
7834 *
7835 * @return the drawing start time in milliseconds
7836 */
7837 public long getDrawingTime() {
7838 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
7839 }
7840
7841 /**
7842 * <p>Enables or disables the duplication of the parent's state into this view. When
7843 * duplication is enabled, this view gets its drawable state from its parent rather
7844 * than from its own internal properties.</p>
7845 *
7846 * <p>Note: in the current implementation, setting this property to true after the
7847 * view was added to a ViewGroup might have no effect at all. This property should
7848 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
7849 *
7850 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
7851 * property is enabled, an exception will be thrown.</p>
Gilles Debunnefb817032011-01-13 13:52:49 -08007852 *
7853 * <p>Note: if the child view uses and updates additionnal states which are unknown to the
7854 * parent, these states should not be affected by this method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007855 *
7856 * @param enabled True to enable duplication of the parent's drawable state, false
7857 * to disable it.
7858 *
7859 * @see #getDrawableState()
7860 * @see #isDuplicateParentStateEnabled()
7861 */
7862 public void setDuplicateParentStateEnabled(boolean enabled) {
7863 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
7864 }
7865
7866 /**
7867 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
7868 *
7869 * @return True if this view's drawable state is duplicated from the parent,
7870 * false otherwise
7871 *
7872 * @see #getDrawableState()
7873 * @see #setDuplicateParentStateEnabled(boolean)
7874 */
7875 public boolean isDuplicateParentStateEnabled() {
7876 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
7877 }
7878
7879 /**
Romain Guy171c5922011-01-06 10:04:23 -08007880 * <p>Specifies the type of layer backing this view. The layer can be
7881 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
7882 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
7883 *
7884 * <p>A layer is associated with an optional {@link android.graphics.Paint}
7885 * instance that controls how the layer is composed on screen. The following
7886 * properties of the paint are taken into account when composing the layer:</p>
7887 * <ul>
7888 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
7889 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
7890 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
7891 * </ul>
7892 *
7893 * <p>If this view has an alpha value set to < 1.0 by calling
7894 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
7895 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
7896 * equivalent to setting a hardware layer on this view and providing a paint with
7897 * the desired alpha value.<p>
7898 *
7899 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
7900 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
7901 * for more information on when and how to use layers.</p>
7902 *
7903 * @param layerType The ype of layer to use with this view, must be one of
7904 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
7905 * {@link #LAYER_TYPE_HARDWARE}
7906 * @param paint The paint used to compose the layer. This argument is optional
7907 * and can be null. It is ignored when the layer type is
7908 * {@link #LAYER_TYPE_NONE}
7909 *
7910 * @see #getLayerType()
7911 * @see #LAYER_TYPE_NONE
7912 * @see #LAYER_TYPE_SOFTWARE
7913 * @see #LAYER_TYPE_HARDWARE
7914 * @see #setAlpha(float)
7915 *
7916 * @attr ref android.R.styleable#View_layerType
7917 */
7918 public void setLayerType(int layerType, Paint paint) {
7919 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
7920 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
7921 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
7922 }
Romain Guy6c319ca2011-01-11 14:29:25 -08007923
Romain Guyd6cd5722011-01-17 14:42:41 -08007924 if (layerType == mLayerType) {
7925 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) {
7926 mLayerPaint = paint == null ? new Paint() : paint;
7927 if (mParent instanceof ViewGroup) {
7928 ((ViewGroup) mParent).invalidate();
7929 }
7930 invalidate();
7931 }
7932 return;
7933 }
Romain Guy171c5922011-01-06 10:04:23 -08007934
7935 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -08007936 switch (mLayerType) {
7937 case LAYER_TYPE_SOFTWARE:
7938 if (mDrawingCache != null) {
7939 mDrawingCache.recycle();
7940 mDrawingCache = null;
7941 }
7942
7943 if (mUnscaledDrawingCache != null) {
7944 mUnscaledDrawingCache.recycle();
7945 mUnscaledDrawingCache = null;
7946 }
7947 break;
7948 case LAYER_TYPE_HARDWARE:
7949 if (mHardwareLayer != null) {
7950 mHardwareLayer.destroy();
7951 mHardwareLayer = null;
7952 }
7953 break;
7954 default:
7955 break;
Romain Guy171c5922011-01-06 10:04:23 -08007956 }
7957
7958 mLayerType = layerType;
Romain Guyd6cd5722011-01-17 14:42:41 -08007959 mLayerPaint = mLayerType == LAYER_TYPE_NONE ? null : (paint == null ? new Paint() : paint);
Romain Guy171c5922011-01-06 10:04:23 -08007960
Romain Guyd6cd5722011-01-17 14:42:41 -08007961 if (mParent instanceof ViewGroup) {
7962 ((ViewGroup) mParent).invalidate();
7963 }
Romain Guy171c5922011-01-06 10:04:23 -08007964 invalidate();
7965 }
7966
7967 /**
7968 * Indicates what type of layer is currently associated with this view. By default
7969 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
7970 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
7971 * for more information on the different types of layers.
7972 *
7973 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
7974 * {@link #LAYER_TYPE_HARDWARE}
7975 *
7976 * @see #setLayerType(int, android.graphics.Paint)
7977 * @see #LAYER_TYPE_NONE
7978 * @see #LAYER_TYPE_SOFTWARE
7979 * @see #LAYER_TYPE_HARDWARE
7980 */
7981 public int getLayerType() {
7982 return mLayerType;
7983 }
Romain Guy6c319ca2011-01-11 14:29:25 -08007984
7985 /**
7986 * <p>Returns a hardware layer that can be used to draw this view again
7987 * without executing its draw method.</p>
7988 *
7989 * @return A HardwareLayer ready to render, or null if an error occurred.
7990 */
7991 HardwareLayer getHardwareLayer(Canvas currentCanvas) {
7992 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) {
7993 return null;
7994 }
7995
7996 final int width = mRight - mLeft;
7997 final int height = mBottom - mTop;
7998
7999 if (width == 0 || height == 0) {
8000 return null;
8001 }
8002
8003 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
8004 if (mHardwareLayer == null) {
8005 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
8006 width, height, isOpaque());
8007 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
8008 mHardwareLayer.resize(width, height);
8009 }
8010
8011 final HardwareCanvas canvas = mHardwareLayer.start(currentCanvas);
8012 try {
8013 canvas.setViewport(width, height);
8014 canvas.onPreDraw();
8015
8016 computeScroll();
8017 canvas.translate(-mScrollX, -mScrollY);
8018
8019 final int restoreCount = canvas.save();
8020
8021 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
8022
8023 // Fast path for layouts with no backgrounds
8024 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8025 mPrivateFlags &= ~DIRTY_MASK;
8026 dispatchDraw(canvas);
8027 } else {
8028 draw(canvas);
8029 }
8030
8031 canvas.restoreToCount(restoreCount);
8032 } finally {
8033 canvas.onPostDraw();
8034 mHardwareLayer.end(currentCanvas);
8035 }
8036 }
8037
8038 return mHardwareLayer;
8039 }
Romain Guy171c5922011-01-06 10:04:23 -08008040
8041 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008042 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
8043 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
8044 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
8045 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
8046 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
8047 * null.</p>
Romain Guy171c5922011-01-06 10:04:23 -08008048 *
8049 * <p>Enabling the drawing cache is similar to
8050 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
8051 * acceleration is turned off. When hardware acceleration is turned on enabling the
8052 * drawing cache has either no effect or the cache used at drawing time is not a bitmap.
8053 * 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 -08008054 *
8055 * @param enabled true to enable the drawing cache, false otherwise
8056 *
8057 * @see #isDrawingCacheEnabled()
8058 * @see #getDrawingCache()
8059 * @see #buildDrawingCache()
Romain Guy171c5922011-01-06 10:04:23 -08008060 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008061 */
8062 public void setDrawingCacheEnabled(boolean enabled) {
8063 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
8064 }
8065
8066 /**
8067 * <p>Indicates whether the drawing cache is enabled for this view.</p>
8068 *
8069 * @return true if the drawing cache is enabled
8070 *
8071 * @see #setDrawingCacheEnabled(boolean)
8072 * @see #getDrawingCache()
8073 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008074 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008075 public boolean isDrawingCacheEnabled() {
8076 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
8077 }
8078
8079 /**
Romain Guyb051e892010-09-28 19:09:36 -07008080 * <p>Returns a display list that can be used to draw this view again
8081 * without executing its draw method.</p>
8082 *
8083 * @return A DisplayList ready to replay, or null if caching is not enabled.
8084 */
8085 DisplayList getDisplayList() {
8086 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
8087 return null;
8088 }
Romain Guyb051e892010-09-28 19:09:36 -07008089 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) {
8090 return null;
8091 }
8092
8093 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED &&
Chet Haase9e90a992011-01-04 16:23:21 -08008094 ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 ||
8095 mDisplayList == null || !mDisplayList.isValid())) {
Romain Guyb051e892010-09-28 19:09:36 -07008096
Chet Haase9e90a992011-01-04 16:23:21 -08008097 if (mDisplayList == null) {
8098 mDisplayList = mAttachInfo.mHardwareRenderer.createDisplayList();
8099 }
Romain Guyb051e892010-09-28 19:09:36 -07008100
8101 final HardwareCanvas canvas = mDisplayList.start();
8102 try {
8103 int width = mRight - mLeft;
8104 int height = mBottom - mTop;
8105
8106 canvas.setViewport(width, height);
8107 canvas.onPreDraw();
8108
8109 final int restoreCount = canvas.save();
8110
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008111 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
Romain Guyb051e892010-09-28 19:09:36 -07008112
8113 // Fast path for layouts with no backgrounds
8114 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8115 mPrivateFlags &= ~DIRTY_MASK;
8116 dispatchDraw(canvas);
8117 } else {
8118 draw(canvas);
8119 }
8120
8121 canvas.restoreToCount(restoreCount);
8122 } finally {
8123 canvas.onPostDraw();
8124
8125 mDisplayList.end();
Romain Guyb051e892010-09-28 19:09:36 -07008126 }
8127 }
8128
8129 return mDisplayList;
8130 }
8131
8132 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07008133 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
8134 *
8135 * @return A non-scaled bitmap representing this view or null if cache is disabled.
8136 *
8137 * @see #getDrawingCache(boolean)
8138 */
8139 public Bitmap getDrawingCache() {
8140 return getDrawingCache(false);
8141 }
8142
8143 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008144 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
8145 * is null when caching is disabled. If caching is enabled and the cache is not ready,
8146 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
8147 * draw from the cache when the cache is enabled. To benefit from the cache, you must
8148 * request the drawing cache by calling this method and draw it on screen if the
8149 * returned bitmap is not null.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07008150 *
8151 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
8152 * this method will create a bitmap of the same size as this view. Because this bitmap
8153 * will be drawn scaled by the parent ViewGroup, the result on screen might show
8154 * scaling artifacts. To avoid such artifacts, you should call this method by setting
8155 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
8156 * size than the view. This implies that your application must be able to handle this
8157 * size.</p>
8158 *
8159 * @param autoScale Indicates whether the generated bitmap should be scaled based on
8160 * the current density of the screen when the application is in compatibility
8161 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008162 *
Romain Guyfbd8f692009-06-26 14:51:58 -07008163 * @return A bitmap representing this view or null if cache is disabled.
8164 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008165 * @see #setDrawingCacheEnabled(boolean)
8166 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -07008167 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008168 * @see #destroyDrawingCache()
8169 */
Romain Guyfbd8f692009-06-26 14:51:58 -07008170 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008171 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
8172 return null;
8173 }
8174 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008175 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008176 }
Romain Guy02890fd2010-08-06 17:58:44 -07008177 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008178 }
8179
8180 /**
8181 * <p>Frees the resources used by the drawing cache. If you call
8182 * {@link #buildDrawingCache()} manually without calling
8183 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
8184 * should cleanup the cache with this method afterwards.</p>
8185 *
8186 * @see #setDrawingCacheEnabled(boolean)
8187 * @see #buildDrawingCache()
8188 * @see #getDrawingCache()
8189 */
8190 public void destroyDrawingCache() {
8191 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07008192 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008193 mDrawingCache = null;
8194 }
Romain Guyfbd8f692009-06-26 14:51:58 -07008195 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07008196 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -07008197 mUnscaledDrawingCache = null;
8198 }
Romain Guyb051e892010-09-28 19:09:36 -07008199 if (mDisplayList != null) {
Chet Haase9e90a992011-01-04 16:23:21 -08008200 mDisplayList.invalidate();
Romain Guyb051e892010-09-28 19:09:36 -07008201 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008202 }
8203
8204 /**
8205 * Setting a solid background color for the drawing cache's bitmaps will improve
8206 * perfromance and memory usage. Note, though that this should only be used if this
8207 * view will always be drawn on top of a solid color.
8208 *
8209 * @param color The background color to use for the drawing cache's bitmap
8210 *
8211 * @see #setDrawingCacheEnabled(boolean)
8212 * @see #buildDrawingCache()
8213 * @see #getDrawingCache()
8214 */
8215 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -08008216 if (color != mDrawingCacheBackgroundColor) {
8217 mDrawingCacheBackgroundColor = color;
8218 mPrivateFlags &= ~DRAWING_CACHE_VALID;
8219 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008220 }
8221
8222 /**
8223 * @see #setDrawingCacheBackgroundColor(int)
8224 *
8225 * @return The background color to used for the drawing cache's bitmap
8226 */
8227 public int getDrawingCacheBackgroundColor() {
8228 return mDrawingCacheBackgroundColor;
8229 }
8230
8231 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07008232 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
8233 *
8234 * @see #buildDrawingCache(boolean)
8235 */
8236 public void buildDrawingCache() {
8237 buildDrawingCache(false);
8238 }
8239
8240 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008241 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
8242 *
8243 * <p>If you call {@link #buildDrawingCache()} manually without calling
8244 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
8245 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07008246 *
8247 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
8248 * this method will create a bitmap of the same size as this view. Because this bitmap
8249 * will be drawn scaled by the parent ViewGroup, the result on screen might show
8250 * scaling artifacts. To avoid such artifacts, you should call this method by setting
8251 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
8252 * size than the view. This implies that your application must be able to handle this
8253 * size.</p>
Romain Guy0d9275e2010-10-26 14:22:30 -07008254 *
8255 * <p>You should avoid calling this method when hardware acceleration is enabled. If
8256 * you do not need the drawing cache bitmap, calling this method will increase memory
8257 * usage and cause the view to be rendered in software once, thus negatively impacting
8258 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008259 *
8260 * @see #getDrawingCache()
8261 * @see #destroyDrawingCache()
8262 */
Romain Guyfbd8f692009-06-26 14:51:58 -07008263 public void buildDrawingCache(boolean autoScale) {
8264 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -07008265 mDrawingCache == null : mUnscaledDrawingCache == null)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008266
8267 if (ViewDebug.TRACE_HIERARCHY) {
8268 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
8269 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008270
Romain Guy8506ab42009-06-11 17:35:47 -07008271 int width = mRight - mLeft;
8272 int height = mBottom - mTop;
8273
8274 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -07008275 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -07008276
Romain Guye1123222009-06-29 14:24:56 -07008277 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008278 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
8279 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -07008280 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008281
8282 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -07008283 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -08008284 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008285
8286 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -07008287 // Projected bitmap size in bytes
Adam Powell26153a32010-11-08 15:22:27 -08008288 (width * height * (opaque && !use32BitCache ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008289 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
8290 destroyDrawingCache();
8291 return;
8292 }
8293
8294 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -07008295 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008296
8297 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008298 Bitmap.Config quality;
8299 if (!opaque) {
8300 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
8301 case DRAWING_CACHE_QUALITY_AUTO:
8302 quality = Bitmap.Config.ARGB_8888;
8303 break;
8304 case DRAWING_CACHE_QUALITY_LOW:
8305 quality = Bitmap.Config.ARGB_4444;
8306 break;
8307 case DRAWING_CACHE_QUALITY_HIGH:
8308 quality = Bitmap.Config.ARGB_8888;
8309 break;
8310 default:
8311 quality = Bitmap.Config.ARGB_8888;
8312 break;
8313 }
8314 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -07008315 // Optimization for translucent windows
8316 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -08008317 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008318 }
8319
8320 // Try to cleanup memory
8321 if (bitmap != null) bitmap.recycle();
8322
8323 try {
8324 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -07008325 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -07008326 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -07008327 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07008328 } else {
Romain Guy02890fd2010-08-06 17:58:44 -07008329 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07008330 }
Adam Powell26153a32010-11-08 15:22:27 -08008331 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008332 } catch (OutOfMemoryError e) {
8333 // If there is not enough memory to create the bitmap cache, just
8334 // ignore the issue as bitmap caches are not required to draw the
8335 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -07008336 if (autoScale) {
8337 mDrawingCache = null;
8338 } else {
8339 mUnscaledDrawingCache = null;
8340 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008341 return;
8342 }
8343
8344 clear = drawingCacheBackgroundColor != 0;
8345 }
8346
8347 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008348 if (attachInfo != null) {
8349 canvas = attachInfo.mCanvas;
8350 if (canvas == null) {
8351 canvas = new Canvas();
8352 }
8353 canvas.setBitmap(bitmap);
8354 // Temporarily clobber the cached Canvas in case one of our children
8355 // is also using a drawing cache. Without this, the children would
8356 // steal the canvas by attaching their own bitmap to it and bad, bad
8357 // thing would happen (invisible views, corrupted drawings, etc.)
8358 attachInfo.mCanvas = null;
8359 } else {
8360 // This case should hopefully never or seldom happen
8361 canvas = new Canvas(bitmap);
8362 }
8363
8364 if (clear) {
8365 bitmap.eraseColor(drawingCacheBackgroundColor);
8366 }
8367
8368 computeScroll();
8369 final int restoreCount = canvas.save();
Romain Guyfbd8f692009-06-26 14:51:58 -07008370
Romain Guye1123222009-06-29 14:24:56 -07008371 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008372 final float scale = attachInfo.mApplicationScale;
8373 canvas.scale(scale, scale);
8374 }
8375
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008376 canvas.translate(-mScrollX, -mScrollY);
8377
Romain Guy5bcdff42009-05-14 21:27:18 -07008378 mPrivateFlags |= DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -08008379 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
8380 mLayerType != LAYER_TYPE_NONE) {
Romain Guy0d9275e2010-10-26 14:22:30 -07008381 mPrivateFlags |= DRAWING_CACHE_VALID;
8382 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008383
8384 // Fast path for layouts with no backgrounds
8385 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8386 if (ViewDebug.TRACE_HIERARCHY) {
8387 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
8388 }
Romain Guy5bcdff42009-05-14 21:27:18 -07008389 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008390 dispatchDraw(canvas);
8391 } else {
8392 draw(canvas);
8393 }
8394
8395 canvas.restoreToCount(restoreCount);
8396
8397 if (attachInfo != null) {
8398 // Restore the cached Canvas for our siblings
8399 attachInfo.mCanvas = canvas;
8400 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008401 }
8402 }
8403
8404 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008405 * Create a snapshot of the view into a bitmap. We should probably make
8406 * some form of this public, but should think about the API.
8407 */
Romain Guy223ff5c2010-03-02 17:07:47 -08008408 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008409 int width = mRight - mLeft;
8410 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008411
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008412 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -07008413 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008414 width = (int) ((width * scale) + 0.5f);
8415 height = (int) ((height * scale) + 0.5f);
8416
Romain Guy8c11e312009-09-14 15:15:30 -07008417 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008418 if (bitmap == null) {
8419 throw new OutOfMemoryError();
8420 }
8421
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008422 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
8423
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008424 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008425 if (attachInfo != null) {
8426 canvas = attachInfo.mCanvas;
8427 if (canvas == null) {
8428 canvas = new Canvas();
8429 }
8430 canvas.setBitmap(bitmap);
8431 // Temporarily clobber the cached Canvas in case one of our children
8432 // is also using a drawing cache. Without this, the children would
8433 // steal the canvas by attaching their own bitmap to it and bad, bad
8434 // things would happen (invisible views, corrupted drawings, etc.)
8435 attachInfo.mCanvas = null;
8436 } else {
8437 // This case should hopefully never or seldom happen
8438 canvas = new Canvas(bitmap);
8439 }
8440
Romain Guy5bcdff42009-05-14 21:27:18 -07008441 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008442 bitmap.eraseColor(backgroundColor);
8443 }
8444
8445 computeScroll();
8446 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008447 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008448 canvas.translate(-mScrollX, -mScrollY);
8449
Romain Guy5bcdff42009-05-14 21:27:18 -07008450 // Temporarily remove the dirty mask
8451 int flags = mPrivateFlags;
8452 mPrivateFlags &= ~DIRTY_MASK;
8453
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008454 // Fast path for layouts with no backgrounds
8455 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8456 dispatchDraw(canvas);
8457 } else {
8458 draw(canvas);
8459 }
8460
Romain Guy5bcdff42009-05-14 21:27:18 -07008461 mPrivateFlags = flags;
8462
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008463 canvas.restoreToCount(restoreCount);
8464
8465 if (attachInfo != null) {
8466 // Restore the cached Canvas for our siblings
8467 attachInfo.mCanvas = canvas;
8468 }
Romain Guy8506ab42009-06-11 17:35:47 -07008469
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008470 return bitmap;
8471 }
8472
8473 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008474 * Indicates whether this View is currently in edit mode. A View is usually
8475 * in edit mode when displayed within a developer tool. For instance, if
8476 * this View is being drawn by a visual user interface builder, this method
8477 * should return true.
8478 *
8479 * Subclasses should check the return value of this method to provide
8480 * different behaviors if their normal behavior might interfere with the
8481 * host environment. For instance: the class spawns a thread in its
8482 * constructor, the drawing code relies on device-specific features, etc.
8483 *
8484 * This method is usually checked in the drawing code of custom widgets.
8485 *
8486 * @return True if this View is in edit mode, false otherwise.
8487 */
8488 public boolean isInEditMode() {
8489 return false;
8490 }
8491
8492 /**
8493 * If the View draws content inside its padding and enables fading edges,
8494 * it needs to support padding offsets. Padding offsets are added to the
8495 * fading edges to extend the length of the fade so that it covers pixels
8496 * drawn inside the padding.
8497 *
8498 * Subclasses of this class should override this method if they need
8499 * to draw content inside the padding.
8500 *
8501 * @return True if padding offset must be applied, false otherwise.
8502 *
8503 * @see #getLeftPaddingOffset()
8504 * @see #getRightPaddingOffset()
8505 * @see #getTopPaddingOffset()
8506 * @see #getBottomPaddingOffset()
8507 *
8508 * @since CURRENT
8509 */
8510 protected boolean isPaddingOffsetRequired() {
8511 return false;
8512 }
8513
8514 /**
8515 * Amount by which to extend the left fading region. Called only when
8516 * {@link #isPaddingOffsetRequired()} returns true.
8517 *
8518 * @return The left padding offset in pixels.
8519 *
8520 * @see #isPaddingOffsetRequired()
8521 *
8522 * @since CURRENT
8523 */
8524 protected int getLeftPaddingOffset() {
8525 return 0;
8526 }
8527
8528 /**
8529 * Amount by which to extend the right fading region. Called only when
8530 * {@link #isPaddingOffsetRequired()} returns true.
8531 *
8532 * @return The right padding offset in pixels.
8533 *
8534 * @see #isPaddingOffsetRequired()
8535 *
8536 * @since CURRENT
8537 */
8538 protected int getRightPaddingOffset() {
8539 return 0;
8540 }
8541
8542 /**
8543 * Amount by which to extend the top fading region. Called only when
8544 * {@link #isPaddingOffsetRequired()} returns true.
8545 *
8546 * @return The top padding offset in pixels.
8547 *
8548 * @see #isPaddingOffsetRequired()
8549 *
8550 * @since CURRENT
8551 */
8552 protected int getTopPaddingOffset() {
8553 return 0;
8554 }
8555
8556 /**
8557 * Amount by which to extend the bottom fading region. Called only when
8558 * {@link #isPaddingOffsetRequired()} returns true.
8559 *
8560 * @return The bottom padding offset in pixels.
8561 *
8562 * @see #isPaddingOffsetRequired()
8563 *
8564 * @since CURRENT
8565 */
8566 protected int getBottomPaddingOffset() {
8567 return 0;
8568 }
8569
8570 /**
Romain Guy2bffd262010-09-12 17:40:02 -07008571 * <p>Indicates whether this view is attached to an hardware accelerated
8572 * window or not.</p>
8573 *
8574 * <p>Even if this method returns true, it does not mean that every call
8575 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
8576 * accelerated {@link android.graphics.Canvas}. For instance, if this view
8577 * is drawn onto an offscren {@link android.graphics.Bitmap} and its
8578 * window is hardware accelerated,
8579 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
8580 * return false, and this method will return true.</p>
8581 *
8582 * @return True if the view is attached to a window and the window is
8583 * hardware accelerated; false in any other case.
8584 */
8585 public boolean isHardwareAccelerated() {
8586 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
8587 }
8588
8589 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008590 * Manually render this view (and all of its children) to the given Canvas.
8591 * The view must have already done a full layout before this function is
Chet Haasec75ec332010-12-17 07:44:30 -08008592 * called. When implementing a view, implement {@link #onDraw} instead of
8593 * overriding this method. If you do need to override this method, call
8594 * the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008595 *
8596 * @param canvas The Canvas to which the View is rendered.
8597 */
8598 public void draw(Canvas canvas) {
8599 if (ViewDebug.TRACE_HIERARCHY) {
8600 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
8601 }
8602
Romain Guy5bcdff42009-05-14 21:27:18 -07008603 final int privateFlags = mPrivateFlags;
8604 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
8605 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
8606 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -07008607
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008608 /*
8609 * Draw traversal performs several drawing steps which must be executed
8610 * in the appropriate order:
8611 *
8612 * 1. Draw the background
8613 * 2. If necessary, save the canvas' layers to prepare for fading
8614 * 3. Draw view's content
8615 * 4. Draw children
8616 * 5. If necessary, draw the fading edges and restore layers
8617 * 6. Draw decorations (scrollbars for instance)
8618 */
8619
8620 // Step 1, draw the background, if needed
8621 int saveCount;
8622
Romain Guy24443ea2009-05-11 11:56:30 -07008623 if (!dirtyOpaque) {
8624 final Drawable background = mBGDrawable;
8625 if (background != null) {
8626 final int scrollX = mScrollX;
8627 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008628
Romain Guy24443ea2009-05-11 11:56:30 -07008629 if (mBackgroundSizeChanged) {
8630 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
8631 mBackgroundSizeChanged = false;
8632 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008633
Romain Guy24443ea2009-05-11 11:56:30 -07008634 if ((scrollX | scrollY) == 0) {
8635 background.draw(canvas);
8636 } else {
8637 canvas.translate(scrollX, scrollY);
8638 background.draw(canvas);
8639 canvas.translate(-scrollX, -scrollY);
8640 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008641 }
8642 }
8643
8644 // skip step 2 & 5 if possible (common case)
8645 final int viewFlags = mViewFlags;
8646 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
8647 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
8648 if (!verticalEdges && !horizontalEdges) {
8649 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07008650 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008651
8652 // Step 4, draw the children
8653 dispatchDraw(canvas);
8654
8655 // Step 6, draw decorations (scrollbars)
8656 onDrawScrollBars(canvas);
8657
8658 // we're done...
8659 return;
8660 }
8661
8662 /*
8663 * Here we do the full fledged routine...
8664 * (this is an uncommon case where speed matters less,
8665 * this is why we repeat some of the tests that have been
8666 * done above)
8667 */
8668
8669 boolean drawTop = false;
8670 boolean drawBottom = false;
8671 boolean drawLeft = false;
8672 boolean drawRight = false;
8673
8674 float topFadeStrength = 0.0f;
8675 float bottomFadeStrength = 0.0f;
8676 float leftFadeStrength = 0.0f;
8677 float rightFadeStrength = 0.0f;
8678
8679 // Step 2, save the canvas' layers
8680 int paddingLeft = mPaddingLeft;
8681 int paddingTop = mPaddingTop;
8682
8683 final boolean offsetRequired = isPaddingOffsetRequired();
8684 if (offsetRequired) {
8685 paddingLeft += getLeftPaddingOffset();
8686 paddingTop += getTopPaddingOffset();
8687 }
8688
8689 int left = mScrollX + paddingLeft;
8690 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
8691 int top = mScrollY + paddingTop;
8692 int bottom = top + mBottom - mTop - mPaddingBottom - paddingTop;
8693
8694 if (offsetRequired) {
8695 right += getRightPaddingOffset();
8696 bottom += getBottomPaddingOffset();
8697 }
8698
8699 final ScrollabilityCache scrollabilityCache = mScrollCache;
8700 int length = scrollabilityCache.fadingEdgeLength;
8701
8702 // clip the fade length if top and bottom fades overlap
8703 // overlapping fades produce odd-looking artifacts
8704 if (verticalEdges && (top + length > bottom - length)) {
8705 length = (bottom - top) / 2;
8706 }
8707
8708 // also clip horizontal fades if necessary
8709 if (horizontalEdges && (left + length > right - length)) {
8710 length = (right - left) / 2;
8711 }
8712
8713 if (verticalEdges) {
8714 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008715 drawTop = topFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008716 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008717 drawBottom = bottomFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008718 }
8719
8720 if (horizontalEdges) {
8721 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008722 drawLeft = leftFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008723 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008724 drawRight = rightFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008725 }
8726
8727 saveCount = canvas.getSaveCount();
8728
8729 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -07008730 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008731 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
8732
8733 if (drawTop) {
8734 canvas.saveLayer(left, top, right, top + length, null, flags);
8735 }
8736
8737 if (drawBottom) {
8738 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
8739 }
8740
8741 if (drawLeft) {
8742 canvas.saveLayer(left, top, left + length, bottom, null, flags);
8743 }
8744
8745 if (drawRight) {
8746 canvas.saveLayer(right - length, top, right, bottom, null, flags);
8747 }
8748 } else {
8749 scrollabilityCache.setFadeColor(solidColor);
8750 }
8751
8752 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07008753 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008754
8755 // Step 4, draw the children
8756 dispatchDraw(canvas);
8757
8758 // Step 5, draw the fade effect and restore layers
8759 final Paint p = scrollabilityCache.paint;
8760 final Matrix matrix = scrollabilityCache.matrix;
8761 final Shader fade = scrollabilityCache.shader;
8762 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
8763
8764 if (drawTop) {
8765 matrix.setScale(1, fadeHeight * topFadeStrength);
8766 matrix.postTranslate(left, top);
8767 fade.setLocalMatrix(matrix);
8768 canvas.drawRect(left, top, right, top + length, p);
8769 }
8770
8771 if (drawBottom) {
8772 matrix.setScale(1, fadeHeight * bottomFadeStrength);
8773 matrix.postRotate(180);
8774 matrix.postTranslate(left, bottom);
8775 fade.setLocalMatrix(matrix);
8776 canvas.drawRect(left, bottom - length, right, bottom, p);
8777 }
8778
8779 if (drawLeft) {
8780 matrix.setScale(1, fadeHeight * leftFadeStrength);
8781 matrix.postRotate(-90);
8782 matrix.postTranslate(left, top);
8783 fade.setLocalMatrix(matrix);
8784 canvas.drawRect(left, top, left + length, bottom, p);
8785 }
8786
8787 if (drawRight) {
8788 matrix.setScale(1, fadeHeight * rightFadeStrength);
8789 matrix.postRotate(90);
8790 matrix.postTranslate(right, top);
8791 fade.setLocalMatrix(matrix);
8792 canvas.drawRect(right - length, top, right, bottom, p);
8793 }
8794
8795 canvas.restoreToCount(saveCount);
8796
8797 // Step 6, draw decorations (scrollbars)
8798 onDrawScrollBars(canvas);
8799 }
8800
8801 /**
8802 * Override this if your view is known to always be drawn on top of a solid color background,
8803 * and needs to draw fading edges. Returning a non-zero color enables the view system to
8804 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
8805 * should be set to 0xFF.
8806 *
8807 * @see #setVerticalFadingEdgeEnabled
8808 * @see #setHorizontalFadingEdgeEnabled
8809 *
8810 * @return The known solid color background for this view, or 0 if the color may vary
8811 */
8812 public int getSolidColor() {
8813 return 0;
8814 }
8815
8816 /**
8817 * Build a human readable string representation of the specified view flags.
8818 *
8819 * @param flags the view flags to convert to a string
8820 * @return a String representing the supplied flags
8821 */
8822 private static String printFlags(int flags) {
8823 String output = "";
8824 int numFlags = 0;
8825 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
8826 output += "TAKES_FOCUS";
8827 numFlags++;
8828 }
8829
8830 switch (flags & VISIBILITY_MASK) {
8831 case INVISIBLE:
8832 if (numFlags > 0) {
8833 output += " ";
8834 }
8835 output += "INVISIBLE";
8836 // USELESS HERE numFlags++;
8837 break;
8838 case GONE:
8839 if (numFlags > 0) {
8840 output += " ";
8841 }
8842 output += "GONE";
8843 // USELESS HERE numFlags++;
8844 break;
8845 default:
8846 break;
8847 }
8848 return output;
8849 }
8850
8851 /**
8852 * Build a human readable string representation of the specified private
8853 * view flags.
8854 *
8855 * @param privateFlags the private view flags to convert to a string
8856 * @return a String representing the supplied flags
8857 */
8858 private static String printPrivateFlags(int privateFlags) {
8859 String output = "";
8860 int numFlags = 0;
8861
8862 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
8863 output += "WANTS_FOCUS";
8864 numFlags++;
8865 }
8866
8867 if ((privateFlags & FOCUSED) == FOCUSED) {
8868 if (numFlags > 0) {
8869 output += " ";
8870 }
8871 output += "FOCUSED";
8872 numFlags++;
8873 }
8874
8875 if ((privateFlags & SELECTED) == SELECTED) {
8876 if (numFlags > 0) {
8877 output += " ";
8878 }
8879 output += "SELECTED";
8880 numFlags++;
8881 }
8882
8883 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
8884 if (numFlags > 0) {
8885 output += " ";
8886 }
8887 output += "IS_ROOT_NAMESPACE";
8888 numFlags++;
8889 }
8890
8891 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
8892 if (numFlags > 0) {
8893 output += " ";
8894 }
8895 output += "HAS_BOUNDS";
8896 numFlags++;
8897 }
8898
8899 if ((privateFlags & DRAWN) == DRAWN) {
8900 if (numFlags > 0) {
8901 output += " ";
8902 }
8903 output += "DRAWN";
8904 // USELESS HERE numFlags++;
8905 }
8906 return output;
8907 }
8908
8909 /**
8910 * <p>Indicates whether or not this view's layout will be requested during
8911 * the next hierarchy layout pass.</p>
8912 *
8913 * @return true if the layout will be forced during next layout pass
8914 */
8915 public boolean isLayoutRequested() {
8916 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
8917 }
8918
8919 /**
8920 * Assign a size and position to a view and all of its
8921 * descendants
8922 *
8923 * <p>This is the second phase of the layout mechanism.
8924 * (The first is measuring). In this phase, each parent calls
8925 * layout on all of its children to position them.
8926 * This is typically done using the child measurements
Chet Haase9c087442011-01-12 16:20:16 -08008927 * that were stored in the measure pass().</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008928 *
Chet Haase9c087442011-01-12 16:20:16 -08008929 * <p>Derived classes should not override this method.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008930 * Derived classes with children should override
8931 * onLayout. In that method, they should
Chet Haase9c087442011-01-12 16:20:16 -08008932 * call layout on each of their children.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008933 *
8934 * @param l Left position, relative to parent
8935 * @param t Top position, relative to parent
8936 * @param r Right position, relative to parent
8937 * @param b Bottom position, relative to parent
8938 */
Romain Guy5429e1d2010-09-07 12:38:00 -07008939 @SuppressWarnings({"unchecked"})
Chet Haase9c087442011-01-12 16:20:16 -08008940 public void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -07008941 int oldL = mLeft;
8942 int oldT = mTop;
8943 int oldB = mBottom;
8944 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008945 boolean changed = setFrame(l, t, r, b);
8946 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
8947 if (ViewDebug.TRACE_HIERARCHY) {
8948 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
8949 }
8950
8951 onLayout(changed, l, t, r, b);
8952 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -07008953
8954 if (mOnLayoutChangeListeners != null) {
8955 ArrayList<OnLayoutChangeListener> listenersCopy =
8956 (ArrayList<OnLayoutChangeListener>) mOnLayoutChangeListeners.clone();
8957 int numListeners = listenersCopy.size();
8958 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -07008959 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -07008960 }
8961 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008962 }
8963 mPrivateFlags &= ~FORCE_LAYOUT;
8964 }
8965
8966 /**
8967 * Called from layout when this view should
8968 * assign a size and position to each of its children.
8969 *
8970 * Derived classes with children should override
8971 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -07008972 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008973 * @param changed This is a new size or position for this view
8974 * @param left Left position, relative to parent
8975 * @param top Top position, relative to parent
8976 * @param right Right position, relative to parent
8977 * @param bottom Bottom position, relative to parent
8978 */
8979 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
8980 }
8981
8982 /**
8983 * Assign a size and position to this view.
8984 *
8985 * This is called from layout.
8986 *
8987 * @param left Left position, relative to parent
8988 * @param top Top position, relative to parent
8989 * @param right Right position, relative to parent
8990 * @param bottom Bottom position, relative to parent
8991 * @return true if the new size and position are different than the
8992 * previous ones
8993 * {@hide}
8994 */
8995 protected boolean setFrame(int left, int top, int right, int bottom) {
8996 boolean changed = false;
8997
8998 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -07008999 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009000 + right + "," + bottom + ")");
9001 }
9002
9003 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
9004 changed = true;
9005
9006 // Remember our drawn bit
9007 int drawn = mPrivateFlags & DRAWN;
9008
9009 // Invalidate our old position
9010 invalidate();
9011
9012
9013 int oldWidth = mRight - mLeft;
9014 int oldHeight = mBottom - mTop;
9015
9016 mLeft = left;
9017 mTop = top;
9018 mRight = right;
9019 mBottom = bottom;
9020
9021 mPrivateFlags |= HAS_BOUNDS;
9022
9023 int newWidth = right - left;
9024 int newHeight = bottom - top;
9025
9026 if (newWidth != oldWidth || newHeight != oldHeight) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009027 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9028 // A change in dimension means an auto-centered pivot point changes, too
9029 mMatrixDirty = true;
9030 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009031 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
9032 }
9033
9034 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
9035 // If we are visible, force the DRAWN bit to on so that
9036 // this invalidate will go through (at least to our parent).
9037 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009038 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009039 // the DRAWN bit.
9040 mPrivateFlags |= DRAWN;
9041 invalidate();
9042 }
9043
9044 // Reset drawn bit to original value (invalidate turns it off)
9045 mPrivateFlags |= drawn;
9046
9047 mBackgroundSizeChanged = true;
9048 }
9049 return changed;
9050 }
9051
9052 /**
9053 * Finalize inflating a view from XML. This is called as the last phase
9054 * of inflation, after all child views have been added.
9055 *
9056 * <p>Even if the subclass overrides onFinishInflate, they should always be
9057 * sure to call the super method, so that we get called.
9058 */
9059 protected void onFinishInflate() {
9060 }
9061
9062 /**
9063 * Returns the resources associated with this view.
9064 *
9065 * @return Resources object.
9066 */
9067 public Resources getResources() {
9068 return mResources;
9069 }
9070
9071 /**
9072 * Invalidates the specified Drawable.
9073 *
9074 * @param drawable the drawable to invalidate
9075 */
9076 public void invalidateDrawable(Drawable drawable) {
9077 if (verifyDrawable(drawable)) {
9078 final Rect dirty = drawable.getBounds();
9079 final int scrollX = mScrollX;
9080 final int scrollY = mScrollY;
9081
9082 invalidate(dirty.left + scrollX, dirty.top + scrollY,
9083 dirty.right + scrollX, dirty.bottom + scrollY);
9084 }
9085 }
9086
9087 /**
9088 * Schedules an action on a drawable to occur at a specified time.
9089 *
9090 * @param who the recipient of the action
9091 * @param what the action to run on the drawable
9092 * @param when the time at which the action must occur. Uses the
9093 * {@link SystemClock#uptimeMillis} timebase.
9094 */
9095 public void scheduleDrawable(Drawable who, Runnable what, long when) {
9096 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
9097 mAttachInfo.mHandler.postAtTime(what, who, when);
9098 }
9099 }
9100
9101 /**
9102 * Cancels a scheduled action on a drawable.
9103 *
9104 * @param who the recipient of the action
9105 * @param what the action to cancel
9106 */
9107 public void unscheduleDrawable(Drawable who, Runnable what) {
9108 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
9109 mAttachInfo.mHandler.removeCallbacks(what, who);
9110 }
9111 }
9112
9113 /**
9114 * Unschedule any events associated with the given Drawable. This can be
9115 * used when selecting a new Drawable into a view, so that the previous
9116 * one is completely unscheduled.
9117 *
9118 * @param who The Drawable to unschedule.
9119 *
9120 * @see #drawableStateChanged
9121 */
9122 public void unscheduleDrawable(Drawable who) {
9123 if (mAttachInfo != null) {
9124 mAttachInfo.mHandler.removeCallbacksAndMessages(who);
9125 }
9126 }
9127
9128 /**
9129 * If your view subclass is displaying its own Drawable objects, it should
9130 * override this function and return true for any Drawable it is
9131 * displaying. This allows animations for those drawables to be
9132 * scheduled.
9133 *
9134 * <p>Be sure to call through to the super class when overriding this
9135 * function.
9136 *
9137 * @param who The Drawable to verify. Return true if it is one you are
9138 * displaying, else return the result of calling through to the
9139 * super class.
9140 *
9141 * @return boolean If true than the Drawable is being displayed in the
9142 * view; else false and it is not allowed to animate.
9143 *
9144 * @see #unscheduleDrawable
9145 * @see #drawableStateChanged
9146 */
9147 protected boolean verifyDrawable(Drawable who) {
9148 return who == mBGDrawable;
9149 }
9150
9151 /**
9152 * This function is called whenever the state of the view changes in such
9153 * a way that it impacts the state of drawables being shown.
9154 *
9155 * <p>Be sure to call through to the superclass when overriding this
9156 * function.
9157 *
9158 * @see Drawable#setState
9159 */
9160 protected void drawableStateChanged() {
9161 Drawable d = mBGDrawable;
9162 if (d != null && d.isStateful()) {
9163 d.setState(getDrawableState());
9164 }
9165 }
9166
9167 /**
9168 * Call this to force a view to update its drawable state. This will cause
9169 * drawableStateChanged to be called on this view. Views that are interested
9170 * in the new state should call getDrawableState.
9171 *
9172 * @see #drawableStateChanged
9173 * @see #getDrawableState
9174 */
9175 public void refreshDrawableState() {
9176 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
9177 drawableStateChanged();
9178
9179 ViewParent parent = mParent;
9180 if (parent != null) {
9181 parent.childDrawableStateChanged(this);
9182 }
9183 }
9184
9185 /**
9186 * Return an array of resource IDs of the drawable states representing the
9187 * current state of the view.
9188 *
9189 * @return The current drawable state
9190 *
9191 * @see Drawable#setState
9192 * @see #drawableStateChanged
9193 * @see #onCreateDrawableState
9194 */
9195 public final int[] getDrawableState() {
9196 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
9197 return mDrawableState;
9198 } else {
9199 mDrawableState = onCreateDrawableState(0);
9200 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
9201 return mDrawableState;
9202 }
9203 }
9204
9205 /**
9206 * Generate the new {@link android.graphics.drawable.Drawable} state for
9207 * this view. This is called by the view
9208 * system when the cached Drawable state is determined to be invalid. To
9209 * retrieve the current state, you should use {@link #getDrawableState}.
9210 *
9211 * @param extraSpace if non-zero, this is the number of extra entries you
9212 * would like in the returned array in which you can place your own
9213 * states.
9214 *
9215 * @return Returns an array holding the current {@link Drawable} state of
9216 * the view.
9217 *
9218 * @see #mergeDrawableStates
9219 */
9220 protected int[] onCreateDrawableState(int extraSpace) {
9221 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
9222 mParent instanceof View) {
9223 return ((View) mParent).onCreateDrawableState(extraSpace);
9224 }
9225
9226 int[] drawableState;
9227
9228 int privateFlags = mPrivateFlags;
9229
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009230 int viewStateIndex = 0;
9231 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
9232 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
9233 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -07009234 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009235 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
9236 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08009237 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested) {
9238 // This is set if HW acceleration is requested, even if the current
9239 // process doesn't allow it. This is just to allow app preview
9240 // windows to better match their app.
9241 viewStateIndex |= VIEW_STATE_ACCELERATED;
9242 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009243
9244 drawableState = VIEW_STATE_SETS[viewStateIndex];
9245
9246 //noinspection ConstantIfStatement
9247 if (false) {
9248 Log.i("View", "drawableStateIndex=" + viewStateIndex);
9249 Log.i("View", toString()
9250 + " pressed=" + ((privateFlags & PRESSED) != 0)
9251 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
9252 + " fo=" + hasFocus()
9253 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009254 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009255 + ": " + Arrays.toString(drawableState));
9256 }
9257
9258 if (extraSpace == 0) {
9259 return drawableState;
9260 }
9261
9262 final int[] fullState;
9263 if (drawableState != null) {
9264 fullState = new int[drawableState.length + extraSpace];
9265 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
9266 } else {
9267 fullState = new int[extraSpace];
9268 }
9269
9270 return fullState;
9271 }
9272
9273 /**
9274 * Merge your own state values in <var>additionalState</var> into the base
9275 * state values <var>baseState</var> that were returned by
9276 * {@link #onCreateDrawableState}.
9277 *
9278 * @param baseState The base state values returned by
9279 * {@link #onCreateDrawableState}, which will be modified to also hold your
9280 * own additional state values.
9281 *
9282 * @param additionalState The additional state values you would like
9283 * added to <var>baseState</var>; this array is not modified.
9284 *
9285 * @return As a convenience, the <var>baseState</var> array you originally
9286 * passed into the function is returned.
9287 *
9288 * @see #onCreateDrawableState
9289 */
9290 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
9291 final int N = baseState.length;
9292 int i = N - 1;
9293 while (i >= 0 && baseState[i] == 0) {
9294 i--;
9295 }
9296 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
9297 return baseState;
9298 }
9299
9300 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -07009301 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
9302 * on all Drawable objects associated with this view.
9303 */
9304 public void jumpDrawablesToCurrentState() {
9305 if (mBGDrawable != null) {
9306 mBGDrawable.jumpToCurrentState();
9307 }
9308 }
9309
9310 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009311 * Sets the background color for this view.
9312 * @param color the color of the background
9313 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00009314 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009315 public void setBackgroundColor(int color) {
Chet Haase70d4ba12010-10-06 09:46:45 -07009316 if (mBGDrawable instanceof ColorDrawable) {
9317 ((ColorDrawable) mBGDrawable).setColor(color);
9318 } else {
9319 setBackgroundDrawable(new ColorDrawable(color));
9320 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009321 }
9322
9323 /**
9324 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -07009325 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009326 * @param resid The identifier of the resource.
9327 * @attr ref android.R.styleable#View_background
9328 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00009329 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009330 public void setBackgroundResource(int resid) {
9331 if (resid != 0 && resid == mBackgroundResource) {
9332 return;
9333 }
9334
9335 Drawable d= null;
9336 if (resid != 0) {
9337 d = mResources.getDrawable(resid);
9338 }
9339 setBackgroundDrawable(d);
9340
9341 mBackgroundResource = resid;
9342 }
9343
9344 /**
9345 * Set the background to a given Drawable, or remove the background. If the
9346 * background has padding, this View's padding is set to the background's
9347 * padding. However, when a background is removed, this View's padding isn't
9348 * touched. If setting the padding is desired, please use
9349 * {@link #setPadding(int, int, int, int)}.
9350 *
9351 * @param d The Drawable to use as the background, or null to remove the
9352 * background
9353 */
9354 public void setBackgroundDrawable(Drawable d) {
9355 boolean requestLayout = false;
9356
9357 mBackgroundResource = 0;
9358
9359 /*
9360 * Regardless of whether we're setting a new background or not, we want
9361 * to clear the previous drawable.
9362 */
9363 if (mBGDrawable != null) {
9364 mBGDrawable.setCallback(null);
9365 unscheduleDrawable(mBGDrawable);
9366 }
9367
9368 if (d != null) {
9369 Rect padding = sThreadLocal.get();
9370 if (padding == null) {
9371 padding = new Rect();
9372 sThreadLocal.set(padding);
9373 }
9374 if (d.getPadding(padding)) {
9375 setPadding(padding.left, padding.top, padding.right, padding.bottom);
9376 }
9377
9378 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
9379 // if it has a different minimum size, we should layout again
9380 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() ||
9381 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) {
9382 requestLayout = true;
9383 }
9384
9385 d.setCallback(this);
9386 if (d.isStateful()) {
9387 d.setState(getDrawableState());
9388 }
9389 d.setVisible(getVisibility() == VISIBLE, false);
9390 mBGDrawable = d;
9391
9392 if ((mPrivateFlags & SKIP_DRAW) != 0) {
9393 mPrivateFlags &= ~SKIP_DRAW;
9394 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
9395 requestLayout = true;
9396 }
9397 } else {
9398 /* Remove the background */
9399 mBGDrawable = null;
9400
9401 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
9402 /*
9403 * This view ONLY drew the background before and we're removing
9404 * the background, so now it won't draw anything
9405 * (hence we SKIP_DRAW)
9406 */
9407 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
9408 mPrivateFlags |= SKIP_DRAW;
9409 }
9410
9411 /*
9412 * When the background is set, we try to apply its padding to this
9413 * View. When the background is removed, we don't touch this View's
9414 * padding. This is noted in the Javadocs. Hence, we don't need to
9415 * requestLayout(), the invalidate() below is sufficient.
9416 */
9417
9418 // The old background's minimum size could have affected this
9419 // View's layout, so let's requestLayout
9420 requestLayout = true;
9421 }
9422
Romain Guy8f1344f52009-05-15 16:03:59 -07009423 computeOpaqueFlags();
9424
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009425 if (requestLayout) {
9426 requestLayout();
9427 }
9428
9429 mBackgroundSizeChanged = true;
9430 invalidate();
9431 }
9432
9433 /**
9434 * Gets the background drawable
9435 * @return The drawable used as the background for this view, if any.
9436 */
9437 public Drawable getBackground() {
9438 return mBGDrawable;
9439 }
9440
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009441 /**
9442 * Sets the padding. The view may add on the space required to display
9443 * the scrollbars, depending on the style and visibility of the scrollbars.
9444 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
9445 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
9446 * from the values set in this call.
9447 *
9448 * @attr ref android.R.styleable#View_padding
9449 * @attr ref android.R.styleable#View_paddingBottom
9450 * @attr ref android.R.styleable#View_paddingLeft
9451 * @attr ref android.R.styleable#View_paddingRight
9452 * @attr ref android.R.styleable#View_paddingTop
9453 * @param left the left padding in pixels
9454 * @param top the top padding in pixels
9455 * @param right the right padding in pixels
9456 * @param bottom the bottom padding in pixels
9457 */
9458 public void setPadding(int left, int top, int right, int bottom) {
9459 boolean changed = false;
9460
Adam Powell20232d02010-12-08 21:08:53 -08009461 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009462 mUserPaddingRight = right;
9463 mUserPaddingBottom = bottom;
9464
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009465 final int viewFlags = mViewFlags;
Romain Guy8506ab42009-06-11 17:35:47 -07009466
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009467 // Common case is there are no scroll bars.
9468 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009469 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -08009470 // TODO Determine what to do with SCROLLBAR_POSITION_DEFAULT based on RTL settings.
9471 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009472 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -08009473 switch (mVerticalScrollbarPosition) {
9474 case SCROLLBAR_POSITION_DEFAULT:
9475 case SCROLLBAR_POSITION_RIGHT:
9476 right += offset;
9477 break;
9478 case SCROLLBAR_POSITION_LEFT:
9479 left += offset;
9480 break;
9481 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009482 }
Adam Powell20232d02010-12-08 21:08:53 -08009483 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009484 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
9485 ? 0 : getHorizontalScrollbarHeight();
9486 }
9487 }
Romain Guy8506ab42009-06-11 17:35:47 -07009488
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009489 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009490 changed = true;
9491 mPaddingLeft = left;
9492 }
9493 if (mPaddingTop != top) {
9494 changed = true;
9495 mPaddingTop = top;
9496 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009497 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009498 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009499 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009500 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009501 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009502 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009503 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009504 }
9505
9506 if (changed) {
9507 requestLayout();
9508 }
9509 }
9510
9511 /**
9512 * Returns the top padding of this view.
9513 *
9514 * @return the top padding in pixels
9515 */
9516 public int getPaddingTop() {
9517 return mPaddingTop;
9518 }
9519
9520 /**
9521 * Returns the bottom padding of this view. If there are inset and enabled
9522 * scrollbars, this value may include the space required to display the
9523 * scrollbars as well.
9524 *
9525 * @return the bottom padding in pixels
9526 */
9527 public int getPaddingBottom() {
9528 return mPaddingBottom;
9529 }
9530
9531 /**
9532 * Returns the left padding of this view. If there are inset and enabled
9533 * scrollbars, this value may include the space required to display the
9534 * scrollbars as well.
9535 *
9536 * @return the left padding in pixels
9537 */
9538 public int getPaddingLeft() {
9539 return mPaddingLeft;
9540 }
9541
9542 /**
9543 * Returns the right padding of this view. If there are inset and enabled
9544 * scrollbars, this value may include the space required to display the
9545 * scrollbars as well.
9546 *
9547 * @return the right padding in pixels
9548 */
9549 public int getPaddingRight() {
9550 return mPaddingRight;
9551 }
9552
9553 /**
9554 * Changes the selection state of this view. A view can be selected or not.
9555 * Note that selection is not the same as focus. Views are typically
9556 * selected in the context of an AdapterView like ListView or GridView;
9557 * the selected view is the view that is highlighted.
9558 *
9559 * @param selected true if the view must be selected, false otherwise
9560 */
9561 public void setSelected(boolean selected) {
9562 if (((mPrivateFlags & SELECTED) != 0) != selected) {
9563 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -07009564 if (!selected) resetPressedState();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009565 invalidate();
9566 refreshDrawableState();
9567 dispatchSetSelected(selected);
9568 }
9569 }
9570
9571 /**
9572 * Dispatch setSelected to all of this View's children.
9573 *
9574 * @see #setSelected(boolean)
9575 *
9576 * @param selected The new selected state
9577 */
9578 protected void dispatchSetSelected(boolean selected) {
9579 }
9580
9581 /**
9582 * Indicates the selection state of this view.
9583 *
9584 * @return true if the view is selected, false otherwise
9585 */
9586 @ViewDebug.ExportedProperty
9587 public boolean isSelected() {
9588 return (mPrivateFlags & SELECTED) != 0;
9589 }
9590
9591 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009592 * Changes the activated state of this view. A view can be activated or not.
9593 * Note that activation is not the same as selection. Selection is
9594 * a transient property, representing the view (hierarchy) the user is
9595 * currently interacting with. Activation is a longer-term state that the
9596 * user can move views in and out of. For example, in a list view with
9597 * single or multiple selection enabled, the views in the current selection
9598 * set are activated. (Um, yeah, we are deeply sorry about the terminology
9599 * here.) The activated state is propagated down to children of the view it
9600 * is set on.
9601 *
9602 * @param activated true if the view must be activated, false otherwise
9603 */
9604 public void setActivated(boolean activated) {
9605 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
9606 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
9607 invalidate();
9608 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -07009609 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009610 }
9611 }
9612
9613 /**
9614 * Dispatch setActivated to all of this View's children.
9615 *
9616 * @see #setActivated(boolean)
9617 *
9618 * @param activated The new activated state
9619 */
9620 protected void dispatchSetActivated(boolean activated) {
9621 }
9622
9623 /**
9624 * Indicates the activation state of this view.
9625 *
9626 * @return true if the view is activated, false otherwise
9627 */
9628 @ViewDebug.ExportedProperty
9629 public boolean isActivated() {
9630 return (mPrivateFlags & ACTIVATED) != 0;
9631 }
9632
9633 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009634 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
9635 * observer can be used to get notifications when global events, like
9636 * layout, happen.
9637 *
9638 * The returned ViewTreeObserver observer is not guaranteed to remain
9639 * valid for the lifetime of this View. If the caller of this method keeps
9640 * a long-lived reference to ViewTreeObserver, it should always check for
9641 * the return value of {@link ViewTreeObserver#isAlive()}.
9642 *
9643 * @return The ViewTreeObserver for this view's hierarchy.
9644 */
9645 public ViewTreeObserver getViewTreeObserver() {
9646 if (mAttachInfo != null) {
9647 return mAttachInfo.mTreeObserver;
9648 }
9649 if (mFloatingTreeObserver == null) {
9650 mFloatingTreeObserver = new ViewTreeObserver();
9651 }
9652 return mFloatingTreeObserver;
9653 }
9654
9655 /**
9656 * <p>Finds the topmost view in the current view hierarchy.</p>
9657 *
9658 * @return the topmost view containing this view
9659 */
9660 public View getRootView() {
9661 if (mAttachInfo != null) {
9662 final View v = mAttachInfo.mRootView;
9663 if (v != null) {
9664 return v;
9665 }
9666 }
Romain Guy8506ab42009-06-11 17:35:47 -07009667
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009668 View parent = this;
9669
9670 while (parent.mParent != null && parent.mParent instanceof View) {
9671 parent = (View) parent.mParent;
9672 }
9673
9674 return parent;
9675 }
9676
9677 /**
9678 * <p>Computes the coordinates of this view on the screen. The argument
9679 * must be an array of two integers. After the method returns, the array
9680 * contains the x and y location in that order.</p>
9681 *
9682 * @param location an array of two integers in which to hold the coordinates
9683 */
9684 public void getLocationOnScreen(int[] location) {
9685 getLocationInWindow(location);
9686
9687 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -07009688 if (info != null) {
9689 location[0] += info.mWindowLeft;
9690 location[1] += info.mWindowTop;
9691 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009692 }
9693
9694 /**
9695 * <p>Computes the coordinates of this view in its window. The argument
9696 * must be an array of two integers. After the method returns, the array
9697 * contains the x and y location in that order.</p>
9698 *
9699 * @param location an array of two integers in which to hold the coordinates
9700 */
9701 public void getLocationInWindow(int[] location) {
9702 if (location == null || location.length < 2) {
9703 throw new IllegalArgumentException("location must be an array of "
9704 + "two integers");
9705 }
9706
Michael Jurka4d2bd4c2010-11-30 18:15:11 -08009707 location[0] = mLeft + (int) (mTranslationX + 0.5f);
9708 location[1] = mTop + (int) (mTranslationY + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009709
9710 ViewParent viewParent = mParent;
9711 while (viewParent instanceof View) {
9712 final View view = (View)viewParent;
Michael Jurka4d2bd4c2010-11-30 18:15:11 -08009713 location[0] += view.mLeft + (int) (view.mTranslationX + 0.5f) - view.mScrollX;
9714 location[1] += view.mTop + (int) (view.mTranslationY + 0.5f) - view.mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009715 viewParent = view.mParent;
9716 }
Romain Guy8506ab42009-06-11 17:35:47 -07009717
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009718 if (viewParent instanceof ViewRoot) {
9719 // *cough*
9720 final ViewRoot vr = (ViewRoot)viewParent;
9721 location[1] -= vr.mCurScrollY;
9722 }
9723 }
9724
9725 /**
9726 * {@hide}
9727 * @param id the id of the view to be found
9728 * @return the view of the specified id, null if cannot be found
9729 */
9730 protected View findViewTraversal(int id) {
9731 if (id == mID) {
9732 return this;
9733 }
9734 return null;
9735 }
9736
9737 /**
9738 * {@hide}
9739 * @param tag the tag of the view to be found
9740 * @return the view of specified tag, null if cannot be found
9741 */
9742 protected View findViewWithTagTraversal(Object tag) {
9743 if (tag != null && tag.equals(mTag)) {
9744 return this;
9745 }
9746 return null;
9747 }
9748
9749 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08009750 * {@hide}
9751 * @param predicate The predicate to evaluate.
9752 * @return The first view that matches the predicate or null.
9753 */
9754 protected View findViewByPredicateTraversal(Predicate<View> predicate) {
9755 if (predicate.apply(this)) {
9756 return this;
9757 }
9758 return null;
9759 }
9760
9761 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009762 * Look for a child view with the given id. If this view has the given
9763 * id, return this view.
9764 *
9765 * @param id The id to search for.
9766 * @return The view that has the given id in the hierarchy or null
9767 */
9768 public final View findViewById(int id) {
9769 if (id < 0) {
9770 return null;
9771 }
9772 return findViewTraversal(id);
9773 }
9774
9775 /**
9776 * Look for a child view with the given tag. If this view has the given
9777 * tag, return this view.
9778 *
9779 * @param tag The tag to search for, using "tag.equals(getTag())".
9780 * @return The View that has the given tag in the hierarchy or null
9781 */
9782 public final View findViewWithTag(Object tag) {
9783 if (tag == null) {
9784 return null;
9785 }
9786 return findViewWithTagTraversal(tag);
9787 }
9788
9789 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08009790 * {@hide}
9791 * Look for a child view that matches the specified predicate.
9792 * If this view matches the predicate, return this view.
9793 *
9794 * @param predicate The predicate to evaluate.
9795 * @return The first view that matches the predicate or null.
9796 */
9797 public final View findViewByPredicate(Predicate<View> predicate) {
9798 return findViewByPredicateTraversal(predicate);
9799 }
9800
9801 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009802 * Sets the identifier for this view. The identifier does not have to be
9803 * unique in this view's hierarchy. The identifier should be a positive
9804 * number.
9805 *
9806 * @see #NO_ID
9807 * @see #getId
9808 * @see #findViewById
9809 *
9810 * @param id a number used to identify the view
9811 *
9812 * @attr ref android.R.styleable#View_id
9813 */
9814 public void setId(int id) {
9815 mID = id;
9816 }
9817
9818 /**
9819 * {@hide}
9820 *
9821 * @param isRoot true if the view belongs to the root namespace, false
9822 * otherwise
9823 */
9824 public void setIsRootNamespace(boolean isRoot) {
9825 if (isRoot) {
9826 mPrivateFlags |= IS_ROOT_NAMESPACE;
9827 } else {
9828 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
9829 }
9830 }
9831
9832 /**
9833 * {@hide}
9834 *
9835 * @return true if the view belongs to the root namespace, false otherwise
9836 */
9837 public boolean isRootNamespace() {
9838 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
9839 }
9840
9841 /**
9842 * Returns this view's identifier.
9843 *
9844 * @return a positive integer used to identify the view or {@link #NO_ID}
9845 * if the view has no ID
9846 *
9847 * @see #setId
9848 * @see #findViewById
9849 * @attr ref android.R.styleable#View_id
9850 */
9851 @ViewDebug.CapturedViewProperty
9852 public int getId() {
9853 return mID;
9854 }
9855
9856 /**
9857 * Returns this view's tag.
9858 *
9859 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -07009860 *
9861 * @see #setTag(Object)
9862 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009863 */
9864 @ViewDebug.ExportedProperty
9865 public Object getTag() {
9866 return mTag;
9867 }
9868
9869 /**
9870 * Sets the tag associated with this view. A tag can be used to mark
9871 * a view in its hierarchy and does not have to be unique within the
9872 * hierarchy. Tags can also be used to store data within a view without
9873 * resorting to another data structure.
9874 *
9875 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -07009876 *
9877 * @see #getTag()
9878 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009879 */
9880 public void setTag(final Object tag) {
9881 mTag = tag;
9882 }
9883
9884 /**
Romain Guyd90a3312009-05-06 14:54:28 -07009885 * Returns the tag associated with this view and the specified key.
9886 *
9887 * @param key The key identifying the tag
9888 *
9889 * @return the Object stored in this view as a tag
9890 *
9891 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -07009892 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -07009893 */
9894 public Object getTag(int key) {
9895 SparseArray<Object> tags = null;
9896 synchronized (sTagsLock) {
9897 if (sTags != null) {
9898 tags = sTags.get(this);
9899 }
9900 }
9901
9902 if (tags != null) return tags.get(key);
9903 return null;
9904 }
9905
9906 /**
9907 * Sets a tag associated with this view and a key. A tag can be used
9908 * to mark a view in its hierarchy and does not have to be unique within
9909 * the hierarchy. Tags can also be used to store data within a view
9910 * without resorting to another data structure.
9911 *
9912 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -07009913 * application to ensure it is unique (see the <a
9914 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
9915 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -07009916 * the Android framework or not associated with any package will cause
9917 * an {@link IllegalArgumentException} to be thrown.
9918 *
9919 * @param key The key identifying the tag
9920 * @param tag An Object to tag the view with
9921 *
9922 * @throws IllegalArgumentException If they specified key is not valid
9923 *
9924 * @see #setTag(Object)
9925 * @see #getTag(int)
9926 */
9927 public void setTag(int key, final Object tag) {
9928 // If the package id is 0x00 or 0x01, it's either an undefined package
9929 // or a framework id
9930 if ((key >>> 24) < 2) {
9931 throw new IllegalArgumentException("The key must be an application-specific "
9932 + "resource id.");
9933 }
9934
9935 setTagInternal(this, key, tag);
9936 }
9937
9938 /**
9939 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
9940 * framework id.
9941 *
9942 * @hide
9943 */
9944 public void setTagInternal(int key, Object tag) {
9945 if ((key >>> 24) != 0x1) {
9946 throw new IllegalArgumentException("The key must be a framework-specific "
9947 + "resource id.");
9948 }
9949
Romain Guy8506ab42009-06-11 17:35:47 -07009950 setTagInternal(this, key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -07009951 }
9952
9953 private static void setTagInternal(View view, int key, Object tag) {
9954 SparseArray<Object> tags = null;
9955 synchronized (sTagsLock) {
9956 if (sTags == null) {
9957 sTags = new WeakHashMap<View, SparseArray<Object>>();
9958 } else {
9959 tags = sTags.get(view);
9960 }
9961 }
9962
9963 if (tags == null) {
9964 tags = new SparseArray<Object>(2);
9965 synchronized (sTagsLock) {
9966 sTags.put(view, tags);
9967 }
9968 }
9969
9970 tags.put(key, tag);
9971 }
9972
9973 /**
Romain Guy13922e02009-05-12 17:56:14 -07009974 * @param consistency The type of consistency. See ViewDebug for more information.
9975 *
9976 * @hide
9977 */
9978 protected boolean dispatchConsistencyCheck(int consistency) {
9979 return onConsistencyCheck(consistency);
9980 }
9981
9982 /**
9983 * Method that subclasses should implement to check their consistency. The type of
9984 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -07009985 *
Romain Guy13922e02009-05-12 17:56:14 -07009986 * @param consistency The type of consistency. See ViewDebug for more information.
9987 *
9988 * @throws IllegalStateException if the view is in an inconsistent state.
9989 *
9990 * @hide
9991 */
9992 protected boolean onConsistencyCheck(int consistency) {
9993 boolean result = true;
9994
9995 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
9996 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
9997
9998 if (checkLayout) {
9999 if (getParent() == null) {
10000 result = false;
10001 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10002 "View " + this + " does not have a parent.");
10003 }
10004
10005 if (mAttachInfo == null) {
10006 result = false;
10007 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10008 "View " + this + " is not attached to a window.");
10009 }
10010 }
10011
10012 if (checkDrawing) {
10013 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
10014 // from their draw() method
10015
10016 if ((mPrivateFlags & DRAWN) != DRAWN &&
10017 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
10018 result = false;
10019 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10020 "View " + this + " was invalidated but its drawing cache is valid.");
10021 }
10022 }
10023
10024 return result;
10025 }
10026
10027 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010028 * Prints information about this view in the log output, with the tag
10029 * {@link #VIEW_LOG_TAG}.
10030 *
10031 * @hide
10032 */
10033 public void debug() {
10034 debug(0);
10035 }
10036
10037 /**
10038 * Prints information about this view in the log output, with the tag
10039 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
10040 * indentation defined by the <code>depth</code>.
10041 *
10042 * @param depth the indentation level
10043 *
10044 * @hide
10045 */
10046 protected void debug(int depth) {
10047 String output = debugIndent(depth - 1);
10048
10049 output += "+ " + this;
10050 int id = getId();
10051 if (id != -1) {
10052 output += " (id=" + id + ")";
10053 }
10054 Object tag = getTag();
10055 if (tag != null) {
10056 output += " (tag=" + tag + ")";
10057 }
10058 Log.d(VIEW_LOG_TAG, output);
10059
10060 if ((mPrivateFlags & FOCUSED) != 0) {
10061 output = debugIndent(depth) + " FOCUSED";
10062 Log.d(VIEW_LOG_TAG, output);
10063 }
10064
10065 output = debugIndent(depth);
10066 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
10067 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
10068 + "} ";
10069 Log.d(VIEW_LOG_TAG, output);
10070
10071 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
10072 || mPaddingBottom != 0) {
10073 output = debugIndent(depth);
10074 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
10075 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
10076 Log.d(VIEW_LOG_TAG, output);
10077 }
10078
10079 output = debugIndent(depth);
10080 output += "mMeasureWidth=" + mMeasuredWidth +
10081 " mMeasureHeight=" + mMeasuredHeight;
10082 Log.d(VIEW_LOG_TAG, output);
10083
10084 output = debugIndent(depth);
10085 if (mLayoutParams == null) {
10086 output += "BAD! no layout params";
10087 } else {
10088 output = mLayoutParams.debug(output);
10089 }
10090 Log.d(VIEW_LOG_TAG, output);
10091
10092 output = debugIndent(depth);
10093 output += "flags={";
10094 output += View.printFlags(mViewFlags);
10095 output += "}";
10096 Log.d(VIEW_LOG_TAG, output);
10097
10098 output = debugIndent(depth);
10099 output += "privateFlags={";
10100 output += View.printPrivateFlags(mPrivateFlags);
10101 output += "}";
10102 Log.d(VIEW_LOG_TAG, output);
10103 }
10104
10105 /**
10106 * Creates an string of whitespaces used for indentation.
10107 *
10108 * @param depth the indentation level
10109 * @return a String containing (depth * 2 + 3) * 2 white spaces
10110 *
10111 * @hide
10112 */
10113 protected static String debugIndent(int depth) {
10114 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
10115 for (int i = 0; i < (depth * 2) + 3; i++) {
10116 spaces.append(' ').append(' ');
10117 }
10118 return spaces.toString();
10119 }
10120
10121 /**
10122 * <p>Return the offset of the widget's text baseline from the widget's top
10123 * boundary. If this widget does not support baseline alignment, this
10124 * method returns -1. </p>
10125 *
10126 * @return the offset of the baseline within the widget's bounds or -1
10127 * if baseline alignment is not supported
10128 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070010129 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010130 public int getBaseline() {
10131 return -1;
10132 }
10133
10134 /**
10135 * Call this when something has changed which has invalidated the
10136 * layout of this view. This will schedule a layout pass of the view
10137 * tree.
10138 */
10139 public void requestLayout() {
10140 if (ViewDebug.TRACE_HIERARCHY) {
10141 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
10142 }
10143
10144 mPrivateFlags |= FORCE_LAYOUT;
10145
10146 if (mParent != null && !mParent.isLayoutRequested()) {
10147 mParent.requestLayout();
10148 }
10149 }
10150
10151 /**
10152 * Forces this view to be laid out during the next layout pass.
10153 * This method does not call requestLayout() or forceLayout()
10154 * on the parent.
10155 */
10156 public void forceLayout() {
10157 mPrivateFlags |= FORCE_LAYOUT;
10158 }
10159
10160 /**
10161 * <p>
10162 * This is called to find out how big a view should be. The parent
10163 * supplies constraint information in the width and height parameters.
10164 * </p>
10165 *
10166 * <p>
10167 * The actual mesurement work of a view is performed in
10168 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
10169 * {@link #onMeasure(int, int)} can and must be overriden by subclasses.
10170 * </p>
10171 *
10172 *
10173 * @param widthMeasureSpec Horizontal space requirements as imposed by the
10174 * parent
10175 * @param heightMeasureSpec Vertical space requirements as imposed by the
10176 * parent
10177 *
10178 * @see #onMeasure(int, int)
10179 */
10180 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
10181 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
10182 widthMeasureSpec != mOldWidthMeasureSpec ||
10183 heightMeasureSpec != mOldHeightMeasureSpec) {
10184
10185 // first clears the measured dimension flag
10186 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
10187
10188 if (ViewDebug.TRACE_HIERARCHY) {
10189 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
10190 }
10191
10192 // measure ourselves, this should set the measured dimension flag back
10193 onMeasure(widthMeasureSpec, heightMeasureSpec);
10194
10195 // flag not set, setMeasuredDimension() was not invoked, we raise
10196 // an exception to warn the developer
10197 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
10198 throw new IllegalStateException("onMeasure() did not set the"
10199 + " measured dimension by calling"
10200 + " setMeasuredDimension()");
10201 }
10202
10203 mPrivateFlags |= LAYOUT_REQUIRED;
10204 }
10205
10206 mOldWidthMeasureSpec = widthMeasureSpec;
10207 mOldHeightMeasureSpec = heightMeasureSpec;
10208 }
10209
10210 /**
10211 * <p>
10212 * Measure the view and its content to determine the measured width and the
10213 * measured height. This method is invoked by {@link #measure(int, int)} and
10214 * should be overriden by subclasses to provide accurate and efficient
10215 * measurement of their contents.
10216 * </p>
10217 *
10218 * <p>
10219 * <strong>CONTRACT:</strong> When overriding this method, you
10220 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
10221 * measured width and height of this view. Failure to do so will trigger an
10222 * <code>IllegalStateException</code>, thrown by
10223 * {@link #measure(int, int)}. Calling the superclass'
10224 * {@link #onMeasure(int, int)} is a valid use.
10225 * </p>
10226 *
10227 * <p>
10228 * The base class implementation of measure defaults to the background size,
10229 * unless a larger size is allowed by the MeasureSpec. Subclasses should
10230 * override {@link #onMeasure(int, int)} to provide better measurements of
10231 * their content.
10232 * </p>
10233 *
10234 * <p>
10235 * If this method is overridden, it is the subclass's responsibility to make
10236 * sure the measured height and width are at least the view's minimum height
10237 * and width ({@link #getSuggestedMinimumHeight()} and
10238 * {@link #getSuggestedMinimumWidth()}).
10239 * </p>
10240 *
10241 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
10242 * The requirements are encoded with
10243 * {@link android.view.View.MeasureSpec}.
10244 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
10245 * The requirements are encoded with
10246 * {@link android.view.View.MeasureSpec}.
10247 *
10248 * @see #getMeasuredWidth()
10249 * @see #getMeasuredHeight()
10250 * @see #setMeasuredDimension(int, int)
10251 * @see #getSuggestedMinimumHeight()
10252 * @see #getSuggestedMinimumWidth()
10253 * @see android.view.View.MeasureSpec#getMode(int)
10254 * @see android.view.View.MeasureSpec#getSize(int)
10255 */
10256 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
10257 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
10258 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
10259 }
10260
10261 /**
10262 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
10263 * measured width and measured height. Failing to do so will trigger an
10264 * exception at measurement time.</p>
10265 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080010266 * @param measuredWidth The measured width of this view. May be a complex
10267 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
10268 * {@link #MEASURED_STATE_TOO_SMALL}.
10269 * @param measuredHeight The measured height of this view. May be a complex
10270 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
10271 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010272 */
10273 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
10274 mMeasuredWidth = measuredWidth;
10275 mMeasuredHeight = measuredHeight;
10276
10277 mPrivateFlags |= MEASURED_DIMENSION_SET;
10278 }
10279
10280 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080010281 * Merge two states as returned by {@link #getMeasuredState()}.
10282 * @param curState The current state as returned from a view or the result
10283 * of combining multiple views.
10284 * @param newState The new view state to combine.
10285 * @return Returns a new integer reflecting the combination of the two
10286 * states.
10287 */
10288 public static int combineMeasuredStates(int curState, int newState) {
10289 return curState | newState;
10290 }
10291
10292 /**
10293 * Version of {@link #resolveSizeAndState(int, int, int)}
10294 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
10295 */
10296 public static int resolveSize(int size, int measureSpec) {
10297 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
10298 }
10299
10300 /**
10301 * Utility to reconcile a desired size and state, with constraints imposed
10302 * by a MeasureSpec. Will take the desired size, unless a different size
10303 * is imposed by the constraints. The returned value is a compound integer,
10304 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
10305 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
10306 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010307 *
10308 * @param size How big the view wants to be
10309 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080010310 * @return Size information bit mask as defined by
10311 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010312 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080010313 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010314 int result = size;
10315 int specMode = MeasureSpec.getMode(measureSpec);
10316 int specSize = MeasureSpec.getSize(measureSpec);
10317 switch (specMode) {
10318 case MeasureSpec.UNSPECIFIED:
10319 result = size;
10320 break;
10321 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080010322 if (specSize < size) {
10323 result = specSize | MEASURED_STATE_TOO_SMALL;
10324 } else {
10325 result = size;
10326 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010327 break;
10328 case MeasureSpec.EXACTLY:
10329 result = specSize;
10330 break;
10331 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080010332 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010333 }
10334
10335 /**
10336 * Utility to return a default size. Uses the supplied size if the
10337 * MeasureSpec imposed no contraints. Will get larger if allowed
10338 * by the MeasureSpec.
10339 *
10340 * @param size Default size for this view
10341 * @param measureSpec Constraints imposed by the parent
10342 * @return The size this view should be.
10343 */
10344 public static int getDefaultSize(int size, int measureSpec) {
10345 int result = size;
10346 int specMode = MeasureSpec.getMode(measureSpec);
10347 int specSize = MeasureSpec.getSize(measureSpec);
10348
10349 switch (specMode) {
10350 case MeasureSpec.UNSPECIFIED:
10351 result = size;
10352 break;
10353 case MeasureSpec.AT_MOST:
10354 case MeasureSpec.EXACTLY:
10355 result = specSize;
10356 break;
10357 }
10358 return result;
10359 }
10360
10361 /**
10362 * Returns the suggested minimum height that the view should use. This
10363 * returns the maximum of the view's minimum height
10364 * and the background's minimum height
10365 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
10366 * <p>
10367 * When being used in {@link #onMeasure(int, int)}, the caller should still
10368 * ensure the returned height is within the requirements of the parent.
10369 *
10370 * @return The suggested minimum height of the view.
10371 */
10372 protected int getSuggestedMinimumHeight() {
10373 int suggestedMinHeight = mMinHeight;
10374
10375 if (mBGDrawable != null) {
10376 final int bgMinHeight = mBGDrawable.getMinimumHeight();
10377 if (suggestedMinHeight < bgMinHeight) {
10378 suggestedMinHeight = bgMinHeight;
10379 }
10380 }
10381
10382 return suggestedMinHeight;
10383 }
10384
10385 /**
10386 * Returns the suggested minimum width that the view should use. This
10387 * returns the maximum of the view's minimum width)
10388 * and the background's minimum width
10389 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
10390 * <p>
10391 * When being used in {@link #onMeasure(int, int)}, the caller should still
10392 * ensure the returned width is within the requirements of the parent.
10393 *
10394 * @return The suggested minimum width of the view.
10395 */
10396 protected int getSuggestedMinimumWidth() {
10397 int suggestedMinWidth = mMinWidth;
10398
10399 if (mBGDrawable != null) {
10400 final int bgMinWidth = mBGDrawable.getMinimumWidth();
10401 if (suggestedMinWidth < bgMinWidth) {
10402 suggestedMinWidth = bgMinWidth;
10403 }
10404 }
10405
10406 return suggestedMinWidth;
10407 }
10408
10409 /**
10410 * Sets the minimum height of the view. It is not guaranteed the view will
10411 * be able to achieve this minimum height (for example, if its parent layout
10412 * constrains it with less available height).
10413 *
10414 * @param minHeight The minimum height the view will try to be.
10415 */
10416 public void setMinimumHeight(int minHeight) {
10417 mMinHeight = minHeight;
10418 }
10419
10420 /**
10421 * Sets the minimum width of the view. It is not guaranteed the view will
10422 * be able to achieve this minimum width (for example, if its parent layout
10423 * constrains it with less available width).
10424 *
10425 * @param minWidth The minimum width the view will try to be.
10426 */
10427 public void setMinimumWidth(int minWidth) {
10428 mMinWidth = minWidth;
10429 }
10430
10431 /**
10432 * Get the animation currently associated with this view.
10433 *
10434 * @return The animation that is currently playing or
10435 * scheduled to play for this view.
10436 */
10437 public Animation getAnimation() {
10438 return mCurrentAnimation;
10439 }
10440
10441 /**
10442 * Start the specified animation now.
10443 *
10444 * @param animation the animation to start now
10445 */
10446 public void startAnimation(Animation animation) {
10447 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
10448 setAnimation(animation);
10449 invalidate();
10450 }
10451
10452 /**
10453 * Cancels any animations for this view.
10454 */
10455 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080010456 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080010457 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080010458 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010459 mCurrentAnimation = null;
10460 }
10461
10462 /**
10463 * Sets the next animation to play for this view.
10464 * If you want the animation to play immediately, use
10465 * startAnimation. This method provides allows fine-grained
10466 * control over the start time and invalidation, but you
10467 * must make sure that 1) the animation has a start time set, and
10468 * 2) the view will be invalidated when the animation is supposed to
10469 * start.
10470 *
10471 * @param animation The next animation, or null.
10472 */
10473 public void setAnimation(Animation animation) {
10474 mCurrentAnimation = animation;
10475 if (animation != null) {
10476 animation.reset();
10477 }
10478 }
10479
10480 /**
10481 * Invoked by a parent ViewGroup to notify the start of the animation
10482 * currently associated with this view. If you override this method,
10483 * always call super.onAnimationStart();
10484 *
10485 * @see #setAnimation(android.view.animation.Animation)
10486 * @see #getAnimation()
10487 */
10488 protected void onAnimationStart() {
10489 mPrivateFlags |= ANIMATION_STARTED;
10490 }
10491
10492 /**
10493 * Invoked by a parent ViewGroup to notify the end of the animation
10494 * currently associated with this view. If you override this method,
10495 * always call super.onAnimationEnd();
10496 *
10497 * @see #setAnimation(android.view.animation.Animation)
10498 * @see #getAnimation()
10499 */
10500 protected void onAnimationEnd() {
10501 mPrivateFlags &= ~ANIMATION_STARTED;
10502 }
10503
10504 /**
10505 * Invoked if there is a Transform that involves alpha. Subclass that can
10506 * draw themselves with the specified alpha should return true, and then
10507 * respect that alpha when their onDraw() is called. If this returns false
10508 * then the view may be redirected to draw into an offscreen buffer to
10509 * fulfill the request, which will look fine, but may be slower than if the
10510 * subclass handles it internally. The default implementation returns false.
10511 *
10512 * @param alpha The alpha (0..255) to apply to the view's drawing
10513 * @return true if the view can draw with the specified alpha.
10514 */
10515 protected boolean onSetAlpha(int alpha) {
10516 return false;
10517 }
10518
10519 /**
10520 * This is used by the RootView to perform an optimization when
10521 * the view hierarchy contains one or several SurfaceView.
10522 * SurfaceView is always considered transparent, but its children are not,
10523 * therefore all View objects remove themselves from the global transparent
10524 * region (passed as a parameter to this function).
10525 *
10526 * @param region The transparent region for this ViewRoot (window).
10527 *
10528 * @return Returns true if the effective visibility of the view at this
10529 * point is opaque, regardless of the transparent region; returns false
10530 * if it is possible for underlying windows to be seen behind the view.
10531 *
10532 * {@hide}
10533 */
10534 public boolean gatherTransparentRegion(Region region) {
10535 final AttachInfo attachInfo = mAttachInfo;
10536 if (region != null && attachInfo != null) {
10537 final int pflags = mPrivateFlags;
10538 if ((pflags & SKIP_DRAW) == 0) {
10539 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
10540 // remove it from the transparent region.
10541 final int[] location = attachInfo.mTransparentLocation;
10542 getLocationInWindow(location);
10543 region.op(location[0], location[1], location[0] + mRight - mLeft,
10544 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
10545 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) {
10546 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
10547 // exists, so we remove the background drawable's non-transparent
10548 // parts from this transparent region.
10549 applyDrawableToTransparentRegion(mBGDrawable, region);
10550 }
10551 }
10552 return true;
10553 }
10554
10555 /**
10556 * Play a sound effect for this view.
10557 *
10558 * <p>The framework will play sound effects for some built in actions, such as
10559 * clicking, but you may wish to play these effects in your widget,
10560 * for instance, for internal navigation.
10561 *
10562 * <p>The sound effect will only be played if sound effects are enabled by the user, and
10563 * {@link #isSoundEffectsEnabled()} is true.
10564 *
10565 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
10566 */
10567 public void playSoundEffect(int soundConstant) {
10568 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
10569 return;
10570 }
10571 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
10572 }
10573
10574 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010575 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070010576 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010577 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010578 *
10579 * <p>The framework will provide haptic feedback for some built in actions,
10580 * such as long presses, but you may wish to provide feedback for your
10581 * own widget.
10582 *
10583 * <p>The feedback will only be performed if
10584 * {@link #isHapticFeedbackEnabled()} is true.
10585 *
10586 * @param feedbackConstant One of the constants defined in
10587 * {@link HapticFeedbackConstants}
10588 */
10589 public boolean performHapticFeedback(int feedbackConstant) {
10590 return performHapticFeedback(feedbackConstant, 0);
10591 }
10592
10593 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010594 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070010595 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010596 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010597 *
10598 * @param feedbackConstant One of the constants defined in
10599 * {@link HapticFeedbackConstants}
10600 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
10601 */
10602 public boolean performHapticFeedback(int feedbackConstant, int flags) {
10603 if (mAttachInfo == null) {
10604 return false;
10605 }
Romain Guyf607bdc2010-09-10 19:20:06 -070010606 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070010607 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010608 && !isHapticFeedbackEnabled()) {
10609 return false;
10610 }
Romain Guy812ccbe2010-06-01 14:07:24 -070010611 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
10612 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010613 }
10614
10615 /**
Christopher Tate2c095f32010-10-04 14:13:40 -070010616 * !!! TODO: real docs
10617 *
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010618 * The base class implementation makes the shadow the same size and appearance
Christopher Tate2c095f32010-10-04 14:13:40 -070010619 * as the view itself, and positions it with its center at the touch point.
10620 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010621 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070010622 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070010623
10624 /**
Christopher Tate17ed60c2011-01-18 12:50:26 -080010625 * Construct a shadow builder object for use with the given View object. The
10626 * default implementation will construct a drag shadow the same size and
10627 * appearance as the supplied View.
10628 *
10629 * @param view A view within the application's layout whose appearance
10630 * should be replicated as the drag shadow.
Christopher Tate2c095f32010-10-04 14:13:40 -070010631 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010632 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070010633 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070010634 }
10635
Christopher Tate17ed60c2011-01-18 12:50:26 -080010636 /**
10637 * Construct a shadow builder object with no associated View. This
10638 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)}
10639 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order
10640 * to supply the drag shadow's dimensions and appearance without
10641 * reference to any View object.
10642 */
10643 public DragShadowBuilder() {
10644 mView = new WeakReference<View>(null);
10645 }
10646
10647 /**
10648 * Returns the View object that had been passed to the
10649 * {@link #View.DragShadowBuilder(View)}
10650 * constructor. If that View parameter was {@code null} or if the
10651 * {@link #View.DragShadowBuilder()}
10652 * constructor was used to instantiate the builder object, this method will return
10653 * null.
10654 *
10655 * @return The View object associate with this builder object.
10656 */
Chris Tate6b391282010-10-14 15:48:59 -070010657 final public View getView() {
10658 return mView.get();
10659 }
10660
Christopher Tate2c095f32010-10-04 14:13:40 -070010661 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010662 * Provide the draggable-shadow metrics for the operation: the dimensions of
10663 * the shadow image itself, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070010664 * be centered under the touch location while dragging.
10665 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010666 * The default implementation sets the dimensions of the shadow to be the
Christopher Tate17ed60c2011-01-18 12:50:26 -080010667 * same as the dimensions of the View object that had been supplied to the
10668 * {@link #View.DragShadowBuilder(View)} constructor
10669 * when the builder object was instantiated, and centers the shadow under the touch
10670 * point.
Christopher Tate2c095f32010-10-04 14:13:40 -070010671 *
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010672 * @param shadowSize The application should set the {@code x} member of this
10673 * parameter to the desired shadow width, and the {@code y} member to
Christopher Tate2c095f32010-10-04 14:13:40 -070010674 * the desired height.
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010675 * @param shadowTouchPoint The application should set this point to be the
10676 * location within the shadow that should track directly underneath
Christopher Tate2c095f32010-10-04 14:13:40 -070010677 * the touch point on the screen during a drag.
10678 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010679 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070010680 final View view = mView.get();
10681 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010682 shadowSize.set(view.getWidth(), view.getHeight());
10683 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070010684 } else {
10685 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
10686 }
Christopher Tate2c095f32010-10-04 14:13:40 -070010687 }
10688
10689 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010690 * Draw the shadow image for the upcoming drag. The shadow canvas was
10691 * created with the dimensions supplied by the
10692 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate17ed60c2011-01-18 12:50:26 -080010693 * <p>
10694 * The default implementation replicates the appearance of the View object
10695 * that had been supplied to the
10696 * {@link #View.DragShadowBuilder(View)}
10697 * constructor when the builder object was instantiated.
Christopher Tate2c095f32010-10-04 14:13:40 -070010698 *
10699 * @param canvas
10700 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010701 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070010702 final View view = mView.get();
10703 if (view != null) {
10704 view.draw(canvas);
10705 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010706 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070010707 }
Christopher Tate2c095f32010-10-04 14:13:40 -070010708 }
10709 }
10710
10711 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010712 * Drag and drop. App calls startDrag(), then callbacks to the shadow builder's
10713 * {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} and
10714 * {@link DragShadowBuilder#onDrawShadow(Canvas)} methods happen, then the drag
Christopher Tate5ada6cb2010-10-05 14:15:29 -070010715 * operation is handed over to the OS.
Christopher Tatea53146c2010-09-07 11:57:52 -070010716 * !!! TODO: real docs
Christopher Tate407b4e92010-11-30 17:14:08 -080010717 *
10718 * @param data !!! TODO
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010719 * @param shadowBuilder !!! TODO
Christopher Tate407b4e92010-11-30 17:14:08 -080010720 * @param myLocalState An arbitrary object that will be passed as part of every DragEvent
10721 * delivered to the calling application during the course of the current drag operation.
10722 * This object is private to the application that called startDrag(), and is not
10723 * visible to other applications. It provides a lightweight way for the application to
10724 * propagate information from the initiator to the recipient of a drag within its own
10725 * application; for example, to help disambiguate between 'copy' and 'move' semantics.
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010726 * @param flags Flags affecting the drag operation. At present no flags are defined;
10727 * pass 0 for this parameter.
Christopher Tate407b4e92010-11-30 17:14:08 -080010728 * @return {@code true} if the drag operation was initiated successfully; {@code false} if
10729 * an error prevented the drag from taking place.
Christopher Tatea53146c2010-09-07 11:57:52 -070010730 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010731 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010732 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070010733 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010734 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070010735 }
10736 boolean okay = false;
10737
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010738 Point shadowSize = new Point();
10739 Point shadowTouchPoint = new Point();
10740 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070010741
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010742 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
10743 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
10744 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070010745 }
Christopher Tatea53146c2010-09-07 11:57:52 -070010746
Chris Tatea32dcf72010-10-14 12:13:50 -070010747 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010748 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
10749 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070010750 }
Christopher Tatea53146c2010-09-07 11:57:52 -070010751 Surface surface = new Surface();
10752 try {
10753 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010754 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070010755 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070010756 + " surface=" + surface);
10757 if (token != null) {
10758 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070010759 try {
Chris Tate6b391282010-10-14 15:48:59 -070010760 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010761 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070010762 } finally {
10763 surface.unlockCanvasAndPost(canvas);
10764 }
Christopher Tatea53146c2010-09-07 11:57:52 -070010765
Christopher Tate407b4e92010-11-30 17:14:08 -080010766 final ViewRoot root = getViewRoot();
10767
10768 // Cache the local state object for delivery with DragEvents
10769 root.setLocalDragState(myLocalState);
10770
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010771 // repurpose 'shadowSize' for the last touch point
10772 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070010773
Christopher Tatea53146c2010-09-07 11:57:52 -070010774 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010775 shadowSize.x, shadowSize.y,
10776 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070010777 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tatea53146c2010-09-07 11:57:52 -070010778 }
10779 } catch (Exception e) {
10780 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
10781 surface.destroy();
10782 }
10783
10784 return okay;
10785 }
10786
Christopher Tatea53146c2010-09-07 11:57:52 -070010787 /**
10788 * Drag-and-drop event dispatch. The event.getAction() verb is one of the DragEvent
10789 * constants DRAG_STARTED_EVENT, DRAG_EVENT, DROP_EVENT, and DRAG_ENDED_EVENT.
10790 *
10791 * For DRAG_STARTED_EVENT, event.getClipDescription() describes the content
10792 * being dragged. onDragEvent() should return 'true' if the view can handle
10793 * a drop of that content. A view that returns 'false' here will receive no
10794 * further calls to onDragEvent() about the drag/drop operation.
10795 *
10796 * For DRAG_ENTERED, event.getClipDescription() describes the content being
10797 * dragged. This will be the same content description passed in the
10798 * DRAG_STARTED_EVENT invocation.
10799 *
10800 * For DRAG_EXITED, event.getClipDescription() describes the content being
10801 * dragged. This will be the same content description passed in the
10802 * DRAG_STARTED_EVENT invocation. The view should return to its approriate
10803 * drag-acceptance visual state.
10804 *
10805 * For DRAG_LOCATION_EVENT, event.getX() and event.getY() give the location in View
10806 * coordinates of the current drag point. The view must return 'true' if it
10807 * can accept a drop of the current drag content, false otherwise.
10808 *
10809 * For DROP_EVENT, event.getX() and event.getY() give the location of the drop
10810 * within the view; also, event.getClipData() returns the full data payload
10811 * being dropped. The view should return 'true' if it consumed the dropped
10812 * content, 'false' if it did not.
10813 *
10814 * For DRAG_ENDED_EVENT, the 'event' argument may be null. The view should return
10815 * to its normal visual state.
10816 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070010817 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070010818 return false;
10819 }
10820
10821 /**
10822 * Views typically don't need to override dispatchDragEvent(); it just calls
Chris Tate32affef2010-10-18 15:29:21 -070010823 * onDragEvent(event) and passes the result up appropriately.
Christopher Tatea53146c2010-09-07 11:57:52 -070010824 */
10825 public boolean dispatchDragEvent(DragEvent event) {
Chris Tate32affef2010-10-18 15:29:21 -070010826 if (mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
10827 && mOnDragListener.onDrag(this, event)) {
10828 return true;
10829 }
Christopher Tatea53146c2010-09-07 11:57:52 -070010830 return onDragEvent(event);
10831 }
10832
10833 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070010834 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
10835 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070010836 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070010837 */
10838 public void onCloseSystemDialogs(String reason) {
10839 }
10840
10841 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010842 * Given a Drawable whose bounds have been set to draw into this view,
10843 * update a Region being computed for {@link #gatherTransparentRegion} so
10844 * that any non-transparent parts of the Drawable are removed from the
10845 * given transparent region.
10846 *
10847 * @param dr The Drawable whose transparency is to be applied to the region.
10848 * @param region A Region holding the current transparency information,
10849 * where any parts of the region that are set are considered to be
10850 * transparent. On return, this region will be modified to have the
10851 * transparency information reduced by the corresponding parts of the
10852 * Drawable that are not transparent.
10853 * {@hide}
10854 */
10855 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
10856 if (DBG) {
10857 Log.i("View", "Getting transparent region for: " + this);
10858 }
10859 final Region r = dr.getTransparentRegion();
10860 final Rect db = dr.getBounds();
10861 final AttachInfo attachInfo = mAttachInfo;
10862 if (r != null && attachInfo != null) {
10863 final int w = getRight()-getLeft();
10864 final int h = getBottom()-getTop();
10865 if (db.left > 0) {
10866 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
10867 r.op(0, 0, db.left, h, Region.Op.UNION);
10868 }
10869 if (db.right < w) {
10870 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
10871 r.op(db.right, 0, w, h, Region.Op.UNION);
10872 }
10873 if (db.top > 0) {
10874 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
10875 r.op(0, 0, w, db.top, Region.Op.UNION);
10876 }
10877 if (db.bottom < h) {
10878 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
10879 r.op(0, db.bottom, w, h, Region.Op.UNION);
10880 }
10881 final int[] location = attachInfo.mTransparentLocation;
10882 getLocationInWindow(location);
10883 r.translate(location[0], location[1]);
10884 region.op(r, Region.Op.INTERSECT);
10885 } else {
10886 region.op(db, Region.Op.DIFFERENCE);
10887 }
10888 }
10889
Adam Powelle14579b2009-12-16 18:39:52 -080010890 private void postCheckForLongClick(int delayOffset) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010891 mHasPerformedLongPress = false;
10892
10893 if (mPendingCheckForLongPress == null) {
10894 mPendingCheckForLongPress = new CheckForLongPress();
10895 }
10896 mPendingCheckForLongPress.rememberWindowAttachCount();
Adam Powelle14579b2009-12-16 18:39:52 -080010897 postDelayed(mPendingCheckForLongPress,
10898 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010899 }
10900
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010901 /**
10902 * Inflate a view from an XML resource. This convenience method wraps the {@link
10903 * LayoutInflater} class, which provides a full range of options for view inflation.
10904 *
10905 * @param context The Context object for your activity or application.
10906 * @param resource The resource ID to inflate
10907 * @param root A view group that will be the parent. Used to properly inflate the
10908 * layout_* parameters.
10909 * @see LayoutInflater
10910 */
10911 public static View inflate(Context context, int resource, ViewGroup root) {
10912 LayoutInflater factory = LayoutInflater.from(context);
10913 return factory.inflate(resource, root);
10914 }
Romain Guy33e72ae2010-07-17 12:40:29 -070010915
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010916 /**
Adam Powell637d3372010-08-25 14:37:03 -070010917 * Scroll the view with standard behavior for scrolling beyond the normal
10918 * content boundaries. Views that call this method should override
10919 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
10920 * results of an over-scroll operation.
10921 *
10922 * Views can use this method to handle any touch or fling-based scrolling.
10923 *
10924 * @param deltaX Change in X in pixels
10925 * @param deltaY Change in Y in pixels
10926 * @param scrollX Current X scroll value in pixels before applying deltaX
10927 * @param scrollY Current Y scroll value in pixels before applying deltaY
10928 * @param scrollRangeX Maximum content scroll range along the X axis
10929 * @param scrollRangeY Maximum content scroll range along the Y axis
10930 * @param maxOverScrollX Number of pixels to overscroll by in either direction
10931 * along the X axis.
10932 * @param maxOverScrollY Number of pixels to overscroll by in either direction
10933 * along the Y axis.
10934 * @param isTouchEvent true if this scroll operation is the result of a touch event.
10935 * @return true if scrolling was clamped to an over-scroll boundary along either
10936 * axis, false otherwise.
10937 */
10938 protected boolean overScrollBy(int deltaX, int deltaY,
10939 int scrollX, int scrollY,
10940 int scrollRangeX, int scrollRangeY,
10941 int maxOverScrollX, int maxOverScrollY,
10942 boolean isTouchEvent) {
10943 final int overScrollMode = mOverScrollMode;
10944 final boolean canScrollHorizontal =
10945 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
10946 final boolean canScrollVertical =
10947 computeVerticalScrollRange() > computeVerticalScrollExtent();
10948 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
10949 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
10950 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
10951 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
10952
10953 int newScrollX = scrollX + deltaX;
10954 if (!overScrollHorizontal) {
10955 maxOverScrollX = 0;
10956 }
10957
10958 int newScrollY = scrollY + deltaY;
10959 if (!overScrollVertical) {
10960 maxOverScrollY = 0;
10961 }
10962
10963 // Clamp values if at the limits and record
10964 final int left = -maxOverScrollX;
10965 final int right = maxOverScrollX + scrollRangeX;
10966 final int top = -maxOverScrollY;
10967 final int bottom = maxOverScrollY + scrollRangeY;
10968
10969 boolean clampedX = false;
10970 if (newScrollX > right) {
10971 newScrollX = right;
10972 clampedX = true;
10973 } else if (newScrollX < left) {
10974 newScrollX = left;
10975 clampedX = true;
10976 }
10977
10978 boolean clampedY = false;
10979 if (newScrollY > bottom) {
10980 newScrollY = bottom;
10981 clampedY = true;
10982 } else if (newScrollY < top) {
10983 newScrollY = top;
10984 clampedY = true;
10985 }
10986
10987 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
10988
10989 return clampedX || clampedY;
10990 }
10991
10992 /**
10993 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
10994 * respond to the results of an over-scroll operation.
10995 *
10996 * @param scrollX New X scroll value in pixels
10997 * @param scrollY New Y scroll value in pixels
10998 * @param clampedX True if scrollX was clamped to an over-scroll boundary
10999 * @param clampedY True if scrollY was clamped to an over-scroll boundary
11000 */
11001 protected void onOverScrolled(int scrollX, int scrollY,
11002 boolean clampedX, boolean clampedY) {
11003 // Intentionally empty.
11004 }
11005
11006 /**
11007 * Returns the over-scroll mode for this view. The result will be
11008 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
11009 * (allow over-scrolling only if the view content is larger than the container),
11010 * or {@link #OVER_SCROLL_NEVER}.
11011 *
11012 * @return This view's over-scroll mode.
11013 */
11014 public int getOverScrollMode() {
11015 return mOverScrollMode;
11016 }
11017
11018 /**
11019 * Set the over-scroll mode for this view. Valid over-scroll modes are
11020 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
11021 * (allow over-scrolling only if the view content is larger than the container),
11022 * or {@link #OVER_SCROLL_NEVER}.
11023 *
11024 * Setting the over-scroll mode of a view will have an effect only if the
11025 * view is capable of scrolling.
11026 *
11027 * @param overScrollMode The new over-scroll mode for this view.
11028 */
11029 public void setOverScrollMode(int overScrollMode) {
11030 if (overScrollMode != OVER_SCROLL_ALWAYS &&
11031 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
11032 overScrollMode != OVER_SCROLL_NEVER) {
11033 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
11034 }
11035 mOverScrollMode = overScrollMode;
11036 }
11037
11038 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011039 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
11040 * Each MeasureSpec represents a requirement for either the width or the height.
11041 * A MeasureSpec is comprised of a size and a mode. There are three possible
11042 * modes:
11043 * <dl>
11044 * <dt>UNSPECIFIED</dt>
11045 * <dd>
11046 * The parent has not imposed any constraint on the child. It can be whatever size
11047 * it wants.
11048 * </dd>
11049 *
11050 * <dt>EXACTLY</dt>
11051 * <dd>
11052 * The parent has determined an exact size for the child. The child is going to be
11053 * given those bounds regardless of how big it wants to be.
11054 * </dd>
11055 *
11056 * <dt>AT_MOST</dt>
11057 * <dd>
11058 * The child can be as large as it wants up to the specified size.
11059 * </dd>
11060 * </dl>
11061 *
11062 * MeasureSpecs are implemented as ints to reduce object allocation. This class
11063 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
11064 */
11065 public static class MeasureSpec {
11066 private static final int MODE_SHIFT = 30;
11067 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
11068
11069 /**
11070 * Measure specification mode: The parent has not imposed any constraint
11071 * on the child. It can be whatever size it wants.
11072 */
11073 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
11074
11075 /**
11076 * Measure specification mode: The parent has determined an exact size
11077 * for the child. The child is going to be given those bounds regardless
11078 * of how big it wants to be.
11079 */
11080 public static final int EXACTLY = 1 << MODE_SHIFT;
11081
11082 /**
11083 * Measure specification mode: The child can be as large as it wants up
11084 * to the specified size.
11085 */
11086 public static final int AT_MOST = 2 << MODE_SHIFT;
11087
11088 /**
11089 * Creates a measure specification based on the supplied size and mode.
11090 *
11091 * The mode must always be one of the following:
11092 * <ul>
11093 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
11094 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
11095 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
11096 * </ul>
11097 *
11098 * @param size the size of the measure specification
11099 * @param mode the mode of the measure specification
11100 * @return the measure specification based on size and mode
11101 */
11102 public static int makeMeasureSpec(int size, int mode) {
11103 return size + mode;
11104 }
11105
11106 /**
11107 * Extracts the mode from the supplied measure specification.
11108 *
11109 * @param measureSpec the measure specification to extract the mode from
11110 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
11111 * {@link android.view.View.MeasureSpec#AT_MOST} or
11112 * {@link android.view.View.MeasureSpec#EXACTLY}
11113 */
11114 public static int getMode(int measureSpec) {
11115 return (measureSpec & MODE_MASK);
11116 }
11117
11118 /**
11119 * Extracts the size from the supplied measure specification.
11120 *
11121 * @param measureSpec the measure specification to extract the size from
11122 * @return the size in pixels defined in the supplied measure specification
11123 */
11124 public static int getSize(int measureSpec) {
11125 return (measureSpec & ~MODE_MASK);
11126 }
11127
11128 /**
11129 * Returns a String representation of the specified measure
11130 * specification.
11131 *
11132 * @param measureSpec the measure specification to convert to a String
11133 * @return a String with the following format: "MeasureSpec: MODE SIZE"
11134 */
11135 public static String toString(int measureSpec) {
11136 int mode = getMode(measureSpec);
11137 int size = getSize(measureSpec);
11138
11139 StringBuilder sb = new StringBuilder("MeasureSpec: ");
11140
11141 if (mode == UNSPECIFIED)
11142 sb.append("UNSPECIFIED ");
11143 else if (mode == EXACTLY)
11144 sb.append("EXACTLY ");
11145 else if (mode == AT_MOST)
11146 sb.append("AT_MOST ");
11147 else
11148 sb.append(mode).append(" ");
11149
11150 sb.append(size);
11151 return sb.toString();
11152 }
11153 }
11154
11155 class CheckForLongPress implements Runnable {
11156
11157 private int mOriginalWindowAttachCount;
11158
11159 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070011160 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011161 && mOriginalWindowAttachCount == mWindowAttachCount) {
11162 if (performLongClick()) {
11163 mHasPerformedLongPress = true;
11164 }
11165 }
11166 }
11167
11168 public void rememberWindowAttachCount() {
11169 mOriginalWindowAttachCount = mWindowAttachCount;
11170 }
11171 }
Adam Powelle14579b2009-12-16 18:39:52 -080011172
11173 private final class CheckForTap implements Runnable {
11174 public void run() {
11175 mPrivateFlags &= ~PREPRESSED;
11176 mPrivateFlags |= PRESSED;
11177 refreshDrawableState();
11178 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
11179 postCheckForLongClick(ViewConfiguration.getTapTimeout());
11180 }
11181 }
11182 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011183
Adam Powella35d7682010-03-12 14:48:13 -080011184 private final class PerformClick implements Runnable {
11185 public void run() {
11186 performClick();
11187 }
11188 }
11189
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011190 /**
11191 * Interface definition for a callback to be invoked when a key event is
11192 * dispatched to this view. The callback will be invoked before the key
11193 * event is given to the view.
11194 */
11195 public interface OnKeyListener {
11196 /**
11197 * Called when a key is dispatched to a view. This allows listeners to
11198 * get a chance to respond before the target view.
11199 *
11200 * @param v The view the key has been dispatched to.
11201 * @param keyCode The code for the physical key that was pressed
11202 * @param event The KeyEvent object containing full information about
11203 * the event.
11204 * @return True if the listener has consumed the event, false otherwise.
11205 */
11206 boolean onKey(View v, int keyCode, KeyEvent event);
11207 }
11208
11209 /**
11210 * Interface definition for a callback to be invoked when a touch event is
11211 * dispatched to this view. The callback will be invoked before the touch
11212 * event is given to the view.
11213 */
11214 public interface OnTouchListener {
11215 /**
11216 * Called when a touch event is dispatched to a view. This allows listeners to
11217 * get a chance to respond before the target view.
11218 *
11219 * @param v The view the touch event has been dispatched to.
11220 * @param event The MotionEvent object containing full information about
11221 * the event.
11222 * @return True if the listener has consumed the event, false otherwise.
11223 */
11224 boolean onTouch(View v, MotionEvent event);
11225 }
11226
11227 /**
11228 * Interface definition for a callback to be invoked when a view has been clicked and held.
11229 */
11230 public interface OnLongClickListener {
11231 /**
11232 * Called when a view has been clicked and held.
11233 *
11234 * @param v The view that was clicked and held.
11235 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080011236 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011237 */
11238 boolean onLongClick(View v);
11239 }
11240
11241 /**
Chris Tate32affef2010-10-18 15:29:21 -070011242 * Interface definition for a callback to be invoked when a drag is being dispatched
11243 * to this view. The callback will be invoked before the hosting view's own
11244 * onDrag(event) method. If the listener wants to fall back to the hosting view's
11245 * onDrag(event) behavior, it should return 'false' from this callback.
11246 */
11247 public interface OnDragListener {
11248 /**
11249 * Called when a drag event is dispatched to a view. This allows listeners
11250 * to get a chance to override base View behavior.
11251 *
11252 * @param v The view the drag has been dispatched to.
11253 * @param event The DragEvent object containing full information
11254 * about the event.
11255 * @return true if the listener consumed the DragEvent, false in order to fall
11256 * back to the view's default handling.
11257 */
11258 boolean onDrag(View v, DragEvent event);
11259 }
11260
11261 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011262 * Interface definition for a callback to be invoked when the focus state of
11263 * a view changed.
11264 */
11265 public interface OnFocusChangeListener {
11266 /**
11267 * Called when the focus state of a view has changed.
11268 *
11269 * @param v The view whose state has changed.
11270 * @param hasFocus The new focus state of v.
11271 */
11272 void onFocusChange(View v, boolean hasFocus);
11273 }
11274
11275 /**
11276 * Interface definition for a callback to be invoked when a view is clicked.
11277 */
11278 public interface OnClickListener {
11279 /**
11280 * Called when a view has been clicked.
11281 *
11282 * @param v The view that was clicked.
11283 */
11284 void onClick(View v);
11285 }
11286
11287 /**
11288 * Interface definition for a callback to be invoked when the context menu
11289 * for this view is being built.
11290 */
11291 public interface OnCreateContextMenuListener {
11292 /**
11293 * Called when the context menu for this view is being built. It is not
11294 * safe to hold onto the menu after this method returns.
11295 *
11296 * @param menu The context menu that is being built
11297 * @param v The view for which the context menu is being built
11298 * @param menuInfo Extra information about the item for which the
11299 * context menu should be shown. This information will vary
11300 * depending on the class of v.
11301 */
11302 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
11303 }
11304
11305 private final class UnsetPressedState implements Runnable {
11306 public void run() {
11307 setPressed(false);
11308 }
11309 }
11310
11311 /**
11312 * Base class for derived classes that want to save and restore their own
11313 * state in {@link android.view.View#onSaveInstanceState()}.
11314 */
11315 public static class BaseSavedState extends AbsSavedState {
11316 /**
11317 * Constructor used when reading from a parcel. Reads the state of the superclass.
11318 *
11319 * @param source
11320 */
11321 public BaseSavedState(Parcel source) {
11322 super(source);
11323 }
11324
11325 /**
11326 * Constructor called by derived classes when creating their SavedState objects
11327 *
11328 * @param superState The state of the superclass of this view
11329 */
11330 public BaseSavedState(Parcelable superState) {
11331 super(superState);
11332 }
11333
11334 public static final Parcelable.Creator<BaseSavedState> CREATOR =
11335 new Parcelable.Creator<BaseSavedState>() {
11336 public BaseSavedState createFromParcel(Parcel in) {
11337 return new BaseSavedState(in);
11338 }
11339
11340 public BaseSavedState[] newArray(int size) {
11341 return new BaseSavedState[size];
11342 }
11343 };
11344 }
11345
11346 /**
11347 * A set of information given to a view when it is attached to its parent
11348 * window.
11349 */
11350 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011351 interface Callbacks {
11352 void playSoundEffect(int effectId);
11353 boolean performHapticFeedback(int effectId, boolean always);
11354 }
11355
11356 /**
11357 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
11358 * to a Handler. This class contains the target (View) to invalidate and
11359 * the coordinates of the dirty rectangle.
11360 *
11361 * For performance purposes, this class also implements a pool of up to
11362 * POOL_LIMIT objects that get reused. This reduces memory allocations
11363 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011364 */
Romain Guyd928d682009-03-31 17:52:16 -070011365 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011366 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070011367 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
11368 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070011369 public InvalidateInfo newInstance() {
11370 return new InvalidateInfo();
11371 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011372
Romain Guyd928d682009-03-31 17:52:16 -070011373 public void onAcquired(InvalidateInfo element) {
11374 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011375
Romain Guyd928d682009-03-31 17:52:16 -070011376 public void onReleased(InvalidateInfo element) {
11377 }
11378 }, POOL_LIMIT)
11379 );
11380
11381 private InvalidateInfo mNext;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011382
11383 View target;
11384
11385 int left;
11386 int top;
11387 int right;
11388 int bottom;
11389
Romain Guyd928d682009-03-31 17:52:16 -070011390 public void setNextPoolable(InvalidateInfo element) {
11391 mNext = element;
11392 }
11393
11394 public InvalidateInfo getNextPoolable() {
11395 return mNext;
11396 }
11397
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011398 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070011399 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011400 }
11401
11402 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070011403 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011404 }
11405 }
11406
11407 final IWindowSession mSession;
11408
11409 final IWindow mWindow;
11410
11411 final IBinder mWindowToken;
11412
11413 final Callbacks mRootCallbacks;
11414
11415 /**
11416 * The top view of the hierarchy.
11417 */
11418 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070011419
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011420 IBinder mPanelParentWindowToken;
11421 Surface mSurface;
11422
Romain Guyb051e892010-09-28 19:09:36 -070011423 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011424 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070011425 HardwareRenderer mHardwareRenderer;
Romain Guy2bffd262010-09-12 17:40:02 -070011426
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011427 /**
Romain Guy8506ab42009-06-11 17:35:47 -070011428 * Scale factor used by the compatibility mode
11429 */
11430 float mApplicationScale;
11431
11432 /**
11433 * Indicates whether the application is in compatibility mode
11434 */
11435 boolean mScalingRequired;
11436
11437 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011438 * Left position of this view's window
11439 */
11440 int mWindowLeft;
11441
11442 /**
11443 * Top position of this view's window
11444 */
11445 int mWindowTop;
11446
11447 /**
Adam Powell26153a32010-11-08 15:22:27 -080011448 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070011449 */
Adam Powell26153a32010-11-08 15:22:27 -080011450 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070011451
11452 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011453 * For windows that are full-screen but using insets to layout inside
11454 * of the screen decorations, these are the current insets for the
11455 * content of the window.
11456 */
11457 final Rect mContentInsets = new Rect();
11458
11459 /**
11460 * For windows that are full-screen but using insets to layout inside
11461 * of the screen decorations, these are the current insets for the
11462 * actual visible parts of the window.
11463 */
11464 final Rect mVisibleInsets = new Rect();
11465
11466 /**
11467 * The internal insets given by this window. This value is
11468 * supplied by the client (through
11469 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
11470 * be given to the window manager when changed to be used in laying
11471 * out windows behind it.
11472 */
11473 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
11474 = new ViewTreeObserver.InternalInsetsInfo();
11475
11476 /**
11477 * All views in the window's hierarchy that serve as scroll containers,
11478 * used to determine if the window can be resized or must be panned
11479 * to adjust for a soft input area.
11480 */
11481 final ArrayList<View> mScrollContainers = new ArrayList<View>();
11482
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070011483 final KeyEvent.DispatcherState mKeyDispatchState
11484 = new KeyEvent.DispatcherState();
11485
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011486 /**
11487 * Indicates whether the view's window currently has the focus.
11488 */
11489 boolean mHasWindowFocus;
11490
11491 /**
11492 * The current visibility of the window.
11493 */
11494 int mWindowVisibility;
11495
11496 /**
11497 * Indicates the time at which drawing started to occur.
11498 */
11499 long mDrawingTime;
11500
11501 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070011502 * Indicates whether or not ignoring the DIRTY_MASK flags.
11503 */
11504 boolean mIgnoreDirtyState;
11505
11506 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011507 * Indicates whether the view's window is currently in touch mode.
11508 */
11509 boolean mInTouchMode;
11510
11511 /**
11512 * Indicates that ViewRoot should trigger a global layout change
11513 * the next time it performs a traversal
11514 */
11515 boolean mRecomputeGlobalAttributes;
11516
11517 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011518 * Set during a traveral if any views want to keep the screen on.
11519 */
11520 boolean mKeepScreenOn;
11521
11522 /**
11523 * Set if the visibility of any views has changed.
11524 */
11525 boolean mViewVisibilityChanged;
11526
11527 /**
11528 * Set to true if a view has been scrolled.
11529 */
11530 boolean mViewScrollChanged;
11531
11532 /**
11533 * Global to the view hierarchy used as a temporary for dealing with
11534 * x/y points in the transparent region computations.
11535 */
11536 final int[] mTransparentLocation = new int[2];
11537
11538 /**
11539 * Global to the view hierarchy used as a temporary for dealing with
11540 * x/y points in the ViewGroup.invalidateChild implementation.
11541 */
11542 final int[] mInvalidateChildLocation = new int[2];
11543
Chet Haasec3aa3612010-06-17 08:50:37 -070011544
11545 /**
11546 * Global to the view hierarchy used as a temporary for dealing with
11547 * x/y location when view is transformed.
11548 */
11549 final float[] mTmpTransformLocation = new float[2];
11550
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011551 /**
11552 * The view tree observer used to dispatch global events like
11553 * layout, pre-draw, touch mode change, etc.
11554 */
11555 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
11556
11557 /**
11558 * A Canvas used by the view hierarchy to perform bitmap caching.
11559 */
11560 Canvas mCanvas;
11561
11562 /**
11563 * A Handler supplied by a view's {@link android.view.ViewRoot}. This
11564 * handler can be used to pump events in the UI events queue.
11565 */
11566 final Handler mHandler;
11567
11568 /**
11569 * Identifier for messages requesting the view to be invalidated.
11570 * Such messages should be sent to {@link #mHandler}.
11571 */
11572 static final int INVALIDATE_MSG = 0x1;
11573
11574 /**
11575 * Identifier for messages requesting the view to invalidate a region.
11576 * Such messages should be sent to {@link #mHandler}.
11577 */
11578 static final int INVALIDATE_RECT_MSG = 0x2;
11579
11580 /**
11581 * Temporary for use in computing invalidate rectangles while
11582 * calling up the hierarchy.
11583 */
11584 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070011585
11586 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070011587 * Temporary for use in computing hit areas with transformed views
11588 */
11589 final RectF mTmpTransformRect = new RectF();
11590
11591 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070011592 * Temporary list for use in collecting focusable descendents of a view.
11593 */
11594 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24);
11595
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011596 /**
11597 * Creates a new set of attachment information with the specified
11598 * events handler and thread.
11599 *
11600 * @param handler the events handler the view must use
11601 */
11602 AttachInfo(IWindowSession session, IWindow window,
11603 Handler handler, Callbacks effectPlayer) {
11604 mSession = session;
11605 mWindow = window;
11606 mWindowToken = window.asBinder();
11607 mHandler = handler;
11608 mRootCallbacks = effectPlayer;
11609 }
11610 }
11611
11612 /**
11613 * <p>ScrollabilityCache holds various fields used by a View when scrolling
11614 * is supported. This avoids keeping too many unused fields in most
11615 * instances of View.</p>
11616 */
Mike Cleronf116bf82009-09-27 19:14:12 -070011617 private static class ScrollabilityCache implements Runnable {
11618
11619 /**
11620 * Scrollbars are not visible
11621 */
11622 public static final int OFF = 0;
11623
11624 /**
11625 * Scrollbars are visible
11626 */
11627 public static final int ON = 1;
11628
11629 /**
11630 * Scrollbars are fading away
11631 */
11632 public static final int FADING = 2;
11633
11634 public boolean fadeScrollBars;
11635
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011636 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070011637 public int scrollBarDefaultDelayBeforeFade;
11638 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011639
11640 public int scrollBarSize;
11641 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070011642 public float[] interpolatorValues;
11643 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011644
11645 public final Paint paint;
11646 public final Matrix matrix;
11647 public Shader shader;
11648
Mike Cleronf116bf82009-09-27 19:14:12 -070011649 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
11650
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080011651 private static final float[] OPAQUE = { 255 };
11652 private static final float[] TRANSPARENT = { 0.0f };
Mike Cleronf116bf82009-09-27 19:14:12 -070011653
11654 /**
11655 * When fading should start. This time moves into the future every time
11656 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
11657 */
11658 public long fadeStartTime;
11659
11660
11661 /**
11662 * The current state of the scrollbars: ON, OFF, or FADING
11663 */
11664 public int state = OFF;
11665
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011666 private int mLastColor;
11667
Mike Cleronf116bf82009-09-27 19:14:12 -070011668 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011669 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
11670 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070011671 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
11672 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011673
11674 paint = new Paint();
11675 matrix = new Matrix();
11676 // use use a height of 1, and then wack the matrix each time we
11677 // actually use it.
11678 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070011679
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011680 paint.setShader(shader);
11681 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070011682 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011683 }
Romain Guy8506ab42009-06-11 17:35:47 -070011684
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011685 public void setFadeColor(int color) {
11686 if (color != 0 && color != mLastColor) {
11687 mLastColor = color;
11688 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070011689
Romain Guye55e1a72009-08-27 10:42:26 -070011690 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
11691 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070011692
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011693 paint.setShader(shader);
11694 // Restore the default transfer mode (src_over)
11695 paint.setXfermode(null);
11696 }
11697 }
Mike Cleronf116bf82009-09-27 19:14:12 -070011698
11699 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070011700 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070011701 if (now >= fadeStartTime) {
11702
11703 // the animation fades the scrollbars out by changing
11704 // the opacity (alpha) from fully opaque to fully
11705 // transparent
11706 int nextFrame = (int) now;
11707 int framesCount = 0;
11708
11709 Interpolator interpolator = scrollBarInterpolator;
11710
11711 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080011712 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070011713
11714 // End transparent
11715 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080011716 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070011717
11718 state = FADING;
11719
11720 // Kick off the fade animation
11721 host.invalidate();
11722 }
11723 }
11724
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011725 }
11726}