blob: fc0039ea731ac660073e5b7965daf9a0cf9f16f0 [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 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001511 * Flag to indicate that this view was marked INVALIDATED, or had its display list
1512 * invalidated, prior to the current drawing iteration. If true, the view must re-draw
1513 * its display list. This flag, used only when hw accelerated, allows us to clear the
1514 * flag while retaining this information until it's needed (at getDisplayList() time and
1515 * in drawChild(), when we decide to draw a view's children's display lists into our own).
1516 *
1517 * {@hide}
1518 */
1519 boolean mRecreateDisplayList = false;
1520
1521 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001522 * The view's identifier.
1523 * {@hide}
1524 *
1525 * @see #setId(int)
1526 * @see #getId()
1527 */
1528 @ViewDebug.ExportedProperty(resolveId = true)
1529 int mID = NO_ID;
1530
1531 /**
1532 * The view's tag.
1533 * {@hide}
1534 *
1535 * @see #setTag(Object)
1536 * @see #getTag()
1537 */
1538 protected Object mTag;
1539
1540 // for mPrivateFlags:
1541 /** {@hide} */
1542 static final int WANTS_FOCUS = 0x00000001;
1543 /** {@hide} */
1544 static final int FOCUSED = 0x00000002;
1545 /** {@hide} */
1546 static final int SELECTED = 0x00000004;
1547 /** {@hide} */
1548 static final int IS_ROOT_NAMESPACE = 0x00000008;
1549 /** {@hide} */
1550 static final int HAS_BOUNDS = 0x00000010;
1551 /** {@hide} */
1552 static final int DRAWN = 0x00000020;
1553 /**
1554 * When this flag is set, this view is running an animation on behalf of its
1555 * children and should therefore not cancel invalidate requests, even if they
1556 * lie outside of this view's bounds.
1557 *
1558 * {@hide}
1559 */
1560 static final int DRAW_ANIMATION = 0x00000040;
1561 /** {@hide} */
1562 static final int SKIP_DRAW = 0x00000080;
1563 /** {@hide} */
1564 static final int ONLY_DRAWS_BACKGROUND = 0x00000100;
1565 /** {@hide} */
1566 static final int REQUEST_TRANSPARENT_REGIONS = 0x00000200;
1567 /** {@hide} */
1568 static final int DRAWABLE_STATE_DIRTY = 0x00000400;
1569 /** {@hide} */
1570 static final int MEASURED_DIMENSION_SET = 0x00000800;
1571 /** {@hide} */
1572 static final int FORCE_LAYOUT = 0x00001000;
Konstantin Lopyrevc6dc4572010-08-06 15:01:52 -07001573 /** {@hide} */
1574 static final int LAYOUT_REQUIRED = 0x00002000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001575
1576 private static final int PRESSED = 0x00004000;
1577
1578 /** {@hide} */
1579 static final int DRAWING_CACHE_VALID = 0x00008000;
1580 /**
1581 * Flag used to indicate that this view should be drawn once more (and only once
1582 * more) after its animation has completed.
1583 * {@hide}
1584 */
1585 static final int ANIMATION_STARTED = 0x00010000;
1586
1587 private static final int SAVE_STATE_CALLED = 0x00020000;
1588
1589 /**
1590 * Indicates that the View returned true when onSetAlpha() was called and that
1591 * the alpha must be restored.
1592 * {@hide}
1593 */
1594 static final int ALPHA_SET = 0x00040000;
1595
1596 /**
1597 * Set by {@link #setScrollContainer(boolean)}.
1598 */
1599 static final int SCROLL_CONTAINER = 0x00080000;
1600
1601 /**
1602 * Set by {@link #setScrollContainer(boolean)}.
1603 */
1604 static final int SCROLL_CONTAINER_ADDED = 0x00100000;
1605
1606 /**
Romain Guy809a7f62009-05-14 15:44:42 -07001607 * View flag indicating whether this view was invalidated (fully or partially.)
1608 *
1609 * @hide
1610 */
1611 static final int DIRTY = 0x00200000;
1612
1613 /**
1614 * View flag indicating whether this view was invalidated by an opaque
1615 * invalidate request.
1616 *
1617 * @hide
1618 */
1619 static final int DIRTY_OPAQUE = 0x00400000;
1620
1621 /**
1622 * Mask for {@link #DIRTY} and {@link #DIRTY_OPAQUE}.
1623 *
1624 * @hide
1625 */
1626 static final int DIRTY_MASK = 0x00600000;
1627
1628 /**
Romain Guy8f1344f52009-05-15 16:03:59 -07001629 * Indicates whether the background is opaque.
1630 *
1631 * @hide
1632 */
1633 static final int OPAQUE_BACKGROUND = 0x00800000;
1634
1635 /**
1636 * Indicates whether the scrollbars are opaque.
1637 *
1638 * @hide
1639 */
1640 static final int OPAQUE_SCROLLBARS = 0x01000000;
1641
1642 /**
1643 * Indicates whether the view is opaque.
1644 *
1645 * @hide
1646 */
1647 static final int OPAQUE_MASK = 0x01800000;
Adam Powelle14579b2009-12-16 18:39:52 -08001648
1649 /**
1650 * Indicates a prepressed state;
1651 * the short time between ACTION_DOWN and recognizing
1652 * a 'real' press. Prepressed is used to recognize quick taps
1653 * even when they are shorter than ViewConfiguration.getTapTimeout().
1654 *
1655 * @hide
1656 */
1657 private static final int PREPRESSED = 0x02000000;
Adam Powellc9fbaab2010-02-16 17:16:19 -08001658
1659 /**
Romain Guy8afa5152010-02-26 11:56:30 -08001660 * Indicates whether the view is temporarily detached.
1661 *
1662 * @hide
1663 */
1664 static final int CANCEL_NEXT_UP_EVENT = 0x04000000;
Adam Powell8568c3a2010-04-19 14:26:11 -07001665
1666 /**
1667 * Indicates that we should awaken scroll bars once attached
1668 *
1669 * @hide
1670 */
1671 private static final int AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000;
Romain Guy8f1344f52009-05-15 16:03:59 -07001672
1673 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001674 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center
1675 * for transform operations
1676 *
1677 * @hide
1678 */
Adam Powellf37df072010-09-17 16:22:49 -07001679 private static final int PIVOT_EXPLICITLY_SET = 0x20000000;
Chet Haasefd2b0022010-08-06 13:08:56 -07001680
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001681 /** {@hide} */
Adam Powellf37df072010-09-17 16:22:49 -07001682 static final int ACTIVATED = 0x40000000;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001683
Chet Haasefd2b0022010-08-06 13:08:56 -07001684 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001685 * Indicates that this view was specifically invalidated, not just dirtied because some
1686 * child view was invalidated. The flag is used to determine when we need to recreate
1687 * a view's display list (as opposed to just returning a reference to its existing
1688 * display list).
1689 *
1690 * @hide
1691 */
1692 static final int INVALIDATED = 0x80000000;
1693
1694 /**
Adam Powell637d3372010-08-25 14:37:03 -07001695 * Always allow a user to over-scroll this view, provided it is a
1696 * view that can scroll.
1697 *
1698 * @see #getOverScrollMode()
1699 * @see #setOverScrollMode(int)
1700 */
1701 public static final int OVER_SCROLL_ALWAYS = 0;
1702
1703 /**
1704 * Allow a user to over-scroll this view only if the content is large
1705 * enough to meaningfully scroll, provided it is a view that can scroll.
1706 *
1707 * @see #getOverScrollMode()
1708 * @see #setOverScrollMode(int)
1709 */
1710 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1;
1711
1712 /**
1713 * Never allow a user to over-scroll this view.
1714 *
1715 * @see #getOverScrollMode()
1716 * @see #setOverScrollMode(int)
1717 */
1718 public static final int OVER_SCROLL_NEVER = 2;
1719
1720 /**
Joe Onorato664644d2011-01-23 17:53:23 -08001721 * View has requested the status bar to be visible (the default).
1722 *
Romain Guy0fd89bf2011-01-26 15:41:30 -08001723 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08001724 */
1725 public static final int STATUS_BAR_VISIBLE = 0;
1726
1727 /**
1728 * View has requested the status bar to be visible (the default).
1729 *
Romain Guy0fd89bf2011-01-26 15:41:30 -08001730 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08001731 */
1732 public static final int STATUS_BAR_HIDDEN = 0x00000001;
1733
1734 /**
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001735 * @hide
1736 *
1737 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1738 * out of the public fields to keep the undefined bits out of the developer's way.
1739 *
1740 * Flag to make the status bar not expandable. Unless you also
1741 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show.
1742 */
1743 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000;
1744
1745 /**
1746 * @hide
1747 *
1748 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1749 * out of the public fields to keep the undefined bits out of the developer's way.
1750 *
1751 * Flag to hide notification icons and scrolling ticker text.
1752 */
1753 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000;
1754
1755 /**
1756 * @hide
1757 *
1758 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1759 * out of the public fields to keep the undefined bits out of the developer's way.
1760 *
1761 * Flag to disable incoming notification alerts. This will not block
1762 * icons, but it will block sound, vibrating and other visual or aural notifications.
1763 */
1764 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000;
1765
1766 /**
1767 * @hide
1768 *
1769 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1770 * out of the public fields to keep the undefined bits out of the developer's way.
1771 *
1772 * Flag to hide only the scrolling ticker. Note that
1773 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies
1774 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}.
1775 */
1776 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000;
1777
1778 /**
1779 * @hide
1780 *
1781 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1782 * out of the public fields to keep the undefined bits out of the developer's way.
1783 *
1784 * Flag to hide the center system info area.
1785 */
1786 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000;
1787
1788 /**
1789 * @hide
1790 *
1791 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1792 * out of the public fields to keep the undefined bits out of the developer's way.
1793 *
1794 * Flag to hide only the navigation buttons. Don't use this
1795 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
Joe Onorato6478adc2011-01-27 21:15:01 -08001796 *
1797 * THIS DOES NOT DISABLE THE BACK BUTTON
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001798 */
1799 public static final int STATUS_BAR_DISABLE_NAVIGATION = 0x00200000;
1800
1801 /**
1802 * @hide
1803 *
1804 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1805 * out of the public fields to keep the undefined bits out of the developer's way.
1806 *
Joe Onorato6478adc2011-01-27 21:15:01 -08001807 * Flag to hide only the back button. Don't use this
1808 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
1809 */
1810 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000;
1811
1812 /**
1813 * @hide
1814 *
1815 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1816 * out of the public fields to keep the undefined bits out of the developer's way.
1817 *
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001818 * Flag to hide only the clock. You might use this if your activity has
1819 * its own clock making the status bar's clock redundant.
1820 */
Joe Onorato6478adc2011-01-27 21:15:01 -08001821 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000;
1822
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001823
1824 /**
1825 * @hide
1826 */
1827 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = STATUS_BAR_HIDDEN;
1828
1829
1830 /**
Adam Powell637d3372010-08-25 14:37:03 -07001831 * Controls the over-scroll mode for this view.
1832 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)},
1833 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS},
1834 * and {@link #OVER_SCROLL_NEVER}.
1835 */
1836 private int mOverScrollMode;
1837
1838 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001839 * The parent this view is attached to.
1840 * {@hide}
1841 *
1842 * @see #getParent()
1843 */
1844 protected ViewParent mParent;
1845
1846 /**
1847 * {@hide}
1848 */
1849 AttachInfo mAttachInfo;
1850
1851 /**
1852 * {@hide}
1853 */
Romain Guy809a7f62009-05-14 15:44:42 -07001854 @ViewDebug.ExportedProperty(flagMapping = {
1855 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT,
1856 name = "FORCE_LAYOUT"),
1857 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED,
1858 name = "LAYOUT_REQUIRED"),
1859 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07001860 name = "DRAWING_CACHE_INVALID", outputIf = false),
Romain Guy809a7f62009-05-14 15:44:42 -07001861 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true),
1862 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false),
1863 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
1864 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY")
1865 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001866 int mPrivateFlags;
1867
1868 /**
Joe Onorato664644d2011-01-23 17:53:23 -08001869 * This view's request for the visibility of the status bar.
1870 * @hide
1871 */
1872 int mSystemUiVisibility;
1873
1874 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001875 * Count of how many windows this view has been attached to.
1876 */
1877 int mWindowAttachCount;
1878
1879 /**
1880 * The layout parameters associated with this view and used by the parent
1881 * {@link android.view.ViewGroup} to determine how this view should be
1882 * laid out.
1883 * {@hide}
1884 */
1885 protected ViewGroup.LayoutParams mLayoutParams;
1886
1887 /**
1888 * The view flags hold various views states.
1889 * {@hide}
1890 */
1891 @ViewDebug.ExportedProperty
1892 int mViewFlags;
1893
1894 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001895 * The transform matrix for the View. This transform is calculated internally
1896 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1897 * is used by default. Do *not* use this variable directly; instead call
1898 * getMatrix(), which will automatically recalculate the matrix if necessary
1899 * to get the correct matrix based on the latest rotation and scale properties.
1900 */
1901 private final Matrix mMatrix = new Matrix();
1902
1903 /**
1904 * The transform matrix for the View. This transform is calculated internally
1905 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1906 * is used by default. Do *not* use this variable directly; instead call
Jeff Brown86671742010-09-30 20:00:15 -07001907 * getInverseMatrix(), which will automatically recalculate the matrix if necessary
Chet Haasec3aa3612010-06-17 08:50:37 -07001908 * to get the correct matrix based on the latest rotation and scale properties.
1909 */
1910 private Matrix mInverseMatrix;
1911
1912 /**
1913 * An internal variable that tracks whether we need to recalculate the
1914 * transform matrix, based on whether the rotation or scaleX/Y properties
1915 * have changed since the matrix was last calculated.
1916 */
1917 private boolean mMatrixDirty = false;
1918
1919 /**
1920 * An internal variable that tracks whether we need to recalculate the
1921 * transform matrix, based on whether the rotation or scaleX/Y properties
1922 * have changed since the matrix was last calculated.
1923 */
1924 private boolean mInverseMatrixDirty = true;
1925
1926 /**
1927 * A variable that tracks whether we need to recalculate the
1928 * transform matrix, based on whether the rotation or scaleX/Y properties
1929 * have changed since the matrix was last calculated. This variable
Jeff Brown86671742010-09-30 20:00:15 -07001930 * is only valid after a call to updateMatrix() or to a function that
1931 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix().
Chet Haasec3aa3612010-06-17 08:50:37 -07001932 */
Romain Guy33e72ae2010-07-17 12:40:29 -07001933 private boolean mMatrixIsIdentity = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07001934
1935 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001936 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set.
1937 */
1938 private Camera mCamera = null;
1939
1940 /**
1941 * This matrix is used when computing the matrix for 3D rotations.
1942 */
1943 private Matrix matrix3D = null;
1944
1945 /**
1946 * These prev values are used to recalculate a centered pivot point when necessary. The
1947 * pivot point is only used in matrix operations (when rotation, scale, or translation are
1948 * set), so thes values are only used then as well.
1949 */
1950 private int mPrevWidth = -1;
1951 private int mPrevHeight = -1;
1952
Romain Guyc5d55862011-01-21 19:01:46 -08001953 private boolean mLastIsOpaque;
1954
Chet Haasefd2b0022010-08-06 13:08:56 -07001955 /**
1956 * Convenience value to check for float values that are close enough to zero to be considered
1957 * zero.
1958 */
Romain Guy2542d192010-08-18 11:47:12 -07001959 private static final float NONZERO_EPSILON = .001f;
Chet Haasefd2b0022010-08-06 13:08:56 -07001960
1961 /**
1962 * The degrees rotation around the vertical axis through the pivot point.
1963 */
1964 @ViewDebug.ExportedProperty
1965 private float mRotationY = 0f;
1966
1967 /**
1968 * The degrees rotation around the horizontal axis through the pivot point.
1969 */
1970 @ViewDebug.ExportedProperty
1971 private float mRotationX = 0f;
1972
1973 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001974 * The degrees rotation around the pivot point.
1975 */
1976 @ViewDebug.ExportedProperty
1977 private float mRotation = 0f;
1978
1979 /**
Chet Haasedf030d22010-07-30 17:22:38 -07001980 * The amount of translation of the object away from its left property (post-layout).
1981 */
1982 @ViewDebug.ExportedProperty
1983 private float mTranslationX = 0f;
1984
1985 /**
1986 * The amount of translation of the object away from its top property (post-layout).
1987 */
1988 @ViewDebug.ExportedProperty
1989 private float mTranslationY = 0f;
1990
1991 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001992 * The amount of scale in the x direction around the pivot point. A
1993 * value of 1 means no scaling is applied.
1994 */
1995 @ViewDebug.ExportedProperty
1996 private float mScaleX = 1f;
1997
1998 /**
1999 * The amount of scale in the y direction around the pivot point. A
2000 * value of 1 means no scaling is applied.
2001 */
2002 @ViewDebug.ExportedProperty
2003 private float mScaleY = 1f;
2004
2005 /**
2006 * The amount of scale in the x direction around the pivot point. A
2007 * value of 1 means no scaling is applied.
2008 */
2009 @ViewDebug.ExportedProperty
2010 private float mPivotX = 0f;
2011
2012 /**
2013 * The amount of scale in the y direction around the pivot point. A
2014 * value of 1 means no scaling is applied.
2015 */
2016 @ViewDebug.ExportedProperty
2017 private float mPivotY = 0f;
2018
2019 /**
2020 * The opacity of the View. This is a value from 0 to 1, where 0 means
2021 * completely transparent and 1 means completely opaque.
2022 */
2023 @ViewDebug.ExportedProperty
2024 private float mAlpha = 1f;
2025
2026 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002027 * The distance in pixels from the left edge of this view's parent
2028 * to the left edge of this view.
2029 * {@hide}
2030 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002031 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002032 protected int mLeft;
2033 /**
2034 * The distance in pixels from the left edge of this view's parent
2035 * to the right edge of this view.
2036 * {@hide}
2037 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002038 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002039 protected int mRight;
2040 /**
2041 * The distance in pixels from the top edge of this view's parent
2042 * to the top edge of this view.
2043 * {@hide}
2044 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002045 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002046 protected int mTop;
2047 /**
2048 * The distance in pixels from the top edge of this view's parent
2049 * to the bottom edge of this view.
2050 * {@hide}
2051 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002052 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002053 protected int mBottom;
2054
2055 /**
2056 * The offset, in pixels, by which the content of this view is scrolled
2057 * horizontally.
2058 * {@hide}
2059 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002060 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002061 protected int mScrollX;
2062 /**
2063 * The offset, in pixels, by which the content of this view is scrolled
2064 * vertically.
2065 * {@hide}
2066 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002067 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002068 protected int mScrollY;
2069
2070 /**
2071 * The left padding in pixels, that is the distance in pixels between the
2072 * left edge of this view and the left edge of its content.
2073 * {@hide}
2074 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002075 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002076 protected int mPaddingLeft;
2077 /**
2078 * The right padding in pixels, that is the distance in pixels between the
2079 * right edge of this view and the right edge of its content.
2080 * {@hide}
2081 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002082 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002083 protected int mPaddingRight;
2084 /**
2085 * The top padding in pixels, that is the distance in pixels between the
2086 * top edge of this view and the top edge of its content.
2087 * {@hide}
2088 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002089 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002090 protected int mPaddingTop;
2091 /**
2092 * The bottom padding in pixels, that is the distance in pixels between the
2093 * bottom edge of this view and the bottom edge of its content.
2094 * {@hide}
2095 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002096 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002097 protected int mPaddingBottom;
2098
2099 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002100 * Briefly describes the view and is primarily used for accessibility support.
2101 */
2102 private CharSequence mContentDescription;
2103
2104 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002105 * Cache the paddingRight set by the user to append to the scrollbar's size.
2106 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002107 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002108 int mUserPaddingRight;
2109
2110 /**
2111 * Cache the paddingBottom set by the user to append to the scrollbar's size.
2112 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002113 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002114 int mUserPaddingBottom;
2115
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002116 /**
Adam Powell20232d02010-12-08 21:08:53 -08002117 * Cache the paddingLeft set by the user to append to the scrollbar's size.
2118 */
2119 @ViewDebug.ExportedProperty(category = "padding")
2120 int mUserPaddingLeft;
2121
2122 /**
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002123 * @hide
2124 */
2125 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
2126 /**
2127 * @hide
2128 */
2129 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002130
2131 private Resources mResources = null;
2132
2133 private Drawable mBGDrawable;
2134
2135 private int mBackgroundResource;
2136 private boolean mBackgroundSizeChanged;
2137
2138 /**
2139 * Listener used to dispatch focus change events.
2140 * This field should be made private, so it is hidden from the SDK.
2141 * {@hide}
2142 */
2143 protected OnFocusChangeListener mOnFocusChangeListener;
2144
2145 /**
Chet Haase21cd1382010-09-01 17:42:29 -07002146 * Listeners for layout change events.
2147 */
2148 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
2149
2150 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002151 * Listener used to dispatch click events.
2152 * This field should be made private, so it is hidden from the SDK.
2153 * {@hide}
2154 */
2155 protected OnClickListener mOnClickListener;
2156
2157 /**
2158 * Listener used to dispatch long click events.
2159 * This field should be made private, so it is hidden from the SDK.
2160 * {@hide}
2161 */
2162 protected OnLongClickListener mOnLongClickListener;
2163
2164 /**
2165 * Listener used to build the context menu.
2166 * This field should be made private, so it is hidden from the SDK.
2167 * {@hide}
2168 */
2169 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
2170
2171 private OnKeyListener mOnKeyListener;
2172
2173 private OnTouchListener mOnTouchListener;
2174
Chris Tate32affef2010-10-18 15:29:21 -07002175 private OnDragListener mOnDragListener;
2176
Joe Onorato664644d2011-01-23 17:53:23 -08002177 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener;
2178
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002179 /**
2180 * The application environment this view lives in.
2181 * This field should be made private, so it is hidden from the SDK.
2182 * {@hide}
2183 */
2184 protected Context mContext;
2185
2186 private ScrollabilityCache mScrollCache;
2187
2188 private int[] mDrawableState = null;
2189
Romain Guy02890fd2010-08-06 17:58:44 -07002190 private Bitmap mDrawingCache;
2191 private Bitmap mUnscaledDrawingCache;
Romain Guyb051e892010-09-28 19:09:36 -07002192 private DisplayList mDisplayList;
Romain Guy6c319ca2011-01-11 14:29:25 -08002193 private HardwareLayer mHardwareLayer;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002194
2195 /**
2196 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
2197 * the user may specify which view to go to next.
2198 */
2199 private int mNextFocusLeftId = View.NO_ID;
2200
2201 /**
2202 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
2203 * the user may specify which view to go to next.
2204 */
2205 private int mNextFocusRightId = View.NO_ID;
2206
2207 /**
2208 * When this view has focus and the next focus is {@link #FOCUS_UP},
2209 * the user may specify which view to go to next.
2210 */
2211 private int mNextFocusUpId = View.NO_ID;
2212
2213 /**
2214 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
2215 * the user may specify which view to go to next.
2216 */
2217 private int mNextFocusDownId = View.NO_ID;
2218
Jeff Brown4e6319b2010-12-13 10:36:51 -08002219 /**
2220 * When this view has focus and the next focus is {@link #FOCUS_FORWARD},
2221 * the user may specify which view to go to next.
2222 */
2223 int mNextFocusForwardId = View.NO_ID;
2224
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002225 private CheckForLongPress mPendingCheckForLongPress;
Adam Powelle14579b2009-12-16 18:39:52 -08002226 private CheckForTap mPendingCheckForTap = null;
Adam Powella35d7682010-03-12 14:48:13 -08002227 private PerformClick mPerformClick;
Adam Powelle14579b2009-12-16 18:39:52 -08002228
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002229 private UnsetPressedState mUnsetPressedState;
2230
2231 /**
2232 * Whether the long press's action has been invoked. The tap's action is invoked on the
2233 * up event while a long press is invoked as soon as the long press duration is reached, so
2234 * a long press could be performed before the tap is checked, in which case the tap's action
2235 * should not be invoked.
2236 */
2237 private boolean mHasPerformedLongPress;
2238
2239 /**
2240 * The minimum height of the view. We'll try our best to have the height
2241 * of this view to at least this amount.
2242 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002243 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002244 private int mMinHeight;
2245
2246 /**
2247 * The minimum width of the view. We'll try our best to have the width
2248 * of this view to at least this amount.
2249 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002250 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002251 private int mMinWidth;
2252
2253 /**
2254 * The delegate to handle touch events that are physically in this view
2255 * but should be handled by another view.
2256 */
2257 private TouchDelegate mTouchDelegate = null;
2258
2259 /**
2260 * Solid color to use as a background when creating the drawing cache. Enables
2261 * the cache to use 16 bit bitmaps instead of 32 bit.
2262 */
2263 private int mDrawingCacheBackgroundColor = 0;
2264
2265 /**
2266 * Special tree observer used when mAttachInfo is null.
2267 */
2268 private ViewTreeObserver mFloatingTreeObserver;
Adam Powelle14579b2009-12-16 18:39:52 -08002269
2270 /**
2271 * Cache the touch slop from the context that created the view.
2272 */
2273 private int mTouchSlop;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002274
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002275 /**
Christopher Tatea53146c2010-09-07 11:57:52 -07002276 * Cache drag/drop state
2277 *
2278 */
2279 boolean mCanAcceptDrop;
Christopher Tatea53146c2010-09-07 11:57:52 -07002280
2281 /**
Christopher Tate02d2b3b2011-01-10 20:43:53 -08002282 * Flag indicating that a drag can cross window boundaries
2283 * @hide
2284 */
2285 public static final int DRAG_FLAG_GLOBAL = 1;
2286
2287 /**
Adam Powell20232d02010-12-08 21:08:53 -08002288 * Position of the vertical scroll bar.
2289 */
2290 private int mVerticalScrollbarPosition;
2291
2292 /**
2293 * Position the scroll bar at the default position as determined by the system.
2294 */
2295 public static final int SCROLLBAR_POSITION_DEFAULT = 0;
2296
2297 /**
2298 * Position the scroll bar along the left edge.
2299 */
2300 public static final int SCROLLBAR_POSITION_LEFT = 1;
2301
2302 /**
2303 * Position the scroll bar along the right edge.
2304 */
2305 public static final int SCROLLBAR_POSITION_RIGHT = 2;
2306
2307 /**
Romain Guy171c5922011-01-06 10:04:23 -08002308 * Indicates that the view does not have a layer.
2309 *
2310 * @see #getLayerType()
2311 * @see #setLayerType(int, android.graphics.Paint)
2312 * @see #LAYER_TYPE_SOFTWARE
2313 * @see #LAYER_TYPE_HARDWARE
2314 */
2315 public static final int LAYER_TYPE_NONE = 0;
2316
2317 /**
2318 * <p>Indicates that the view has a software layer. A software layer is backed
2319 * by a bitmap and causes the view to be rendered using Android's software
2320 * rendering pipeline, even if hardware acceleration is enabled.</p>
2321 *
2322 * <p>Software layers have various usages:</p>
2323 * <p>When the application is not using hardware acceleration, a software layer
2324 * is useful to apply a specific color filter and/or blending mode and/or
2325 * translucency to a view and all its children.</p>
2326 * <p>When the application is using hardware acceleration, a software layer
2327 * is useful to render drawing primitives not supported by the hardware
2328 * accelerated pipeline. It can also be used to cache a complex view tree
2329 * into a texture and reduce the complexity of drawing operations. For instance,
2330 * when animating a complex view tree with a translation, a software layer can
2331 * be used to render the view tree only once.</p>
2332 * <p>Software layers should be avoided when the affected view tree updates
2333 * often. Every update will require to re-render the software layer, which can
2334 * potentially be slow (particularly when hardware acceleration is turned on
2335 * since the layer will have to be uploaded into a hardware texture after every
2336 * update.)</p>
2337 *
2338 * @see #getLayerType()
2339 * @see #setLayerType(int, android.graphics.Paint)
2340 * @see #LAYER_TYPE_NONE
2341 * @see #LAYER_TYPE_HARDWARE
2342 */
2343 public static final int LAYER_TYPE_SOFTWARE = 1;
2344
2345 /**
2346 * <p>Indicates that the view has a hardware layer. A hardware layer is backed
2347 * by a hardware specific texture (generally Frame Buffer Objects or FBO on
2348 * OpenGL hardware) and causes the view to be rendered using Android's hardware
2349 * rendering pipeline, but only if hardware acceleration is turned on for the
2350 * view hierarchy. When hardware acceleration is turned off, hardware layers
2351 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p>
2352 *
2353 * <p>A hardware layer is useful to apply a specific color filter and/or
2354 * blending mode and/or translucency to a view and all its children.</p>
Romain Guy6c319ca2011-01-11 14:29:25 -08002355 * <p>A hardware layer can be used to cache a complex view tree into a
2356 * texture and reduce the complexity of drawing operations. For instance,
2357 * when animating a complex view tree with a translation, a hardware layer can
2358 * be used to render the view tree only once.</p>
Romain Guy171c5922011-01-06 10:04:23 -08002359 * <p>A hardware layer can also be used to increase the rendering quality when
2360 * rotation transformations are applied on a view. It can also be used to
2361 * prevent potential clipping issues when applying 3D transforms on a view.</p>
2362 *
2363 * @see #getLayerType()
2364 * @see #setLayerType(int, android.graphics.Paint)
2365 * @see #LAYER_TYPE_NONE
2366 * @see #LAYER_TYPE_SOFTWARE
2367 */
2368 public static final int LAYER_TYPE_HARDWARE = 2;
2369
Romain Guy3aaff3a2011-01-12 14:18:47 -08002370 @ViewDebug.ExportedProperty(category = "drawing", mapping = {
2371 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"),
2372 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"),
2373 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE")
2374 })
Romain Guy171c5922011-01-06 10:04:23 -08002375 int mLayerType = LAYER_TYPE_NONE;
2376 Paint mLayerPaint;
2377
2378 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002379 * Simple constructor to use when creating a view from code.
2380 *
2381 * @param context The Context the view is running in, through which it can
2382 * access the current theme, resources, etc.
2383 */
2384 public View(Context context) {
2385 mContext = context;
2386 mResources = context != null ? context.getResources() : null;
Romain Guy8f1344f52009-05-15 16:03:59 -07002387 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED;
Adam Powelle14579b2009-12-16 18:39:52 -08002388 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop();
Adam Powell637d3372010-08-25 14:37:03 -07002389 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002390 }
2391
2392 /**
2393 * Constructor that is called when inflating a view from XML. This is called
2394 * when a view is being constructed from an XML file, supplying attributes
2395 * that were specified in the XML file. This version uses a default style of
2396 * 0, so the only attribute values applied are those in the Context's Theme
2397 * and the given AttributeSet.
2398 *
2399 * <p>
2400 * The method onFinishInflate() will be called after all children have been
2401 * added.
2402 *
2403 * @param context The Context the view is running in, through which it can
2404 * access the current theme, resources, etc.
2405 * @param attrs The attributes of the XML tag that is inflating the view.
2406 * @see #View(Context, AttributeSet, int)
2407 */
2408 public View(Context context, AttributeSet attrs) {
2409 this(context, attrs, 0);
2410 }
2411
2412 /**
2413 * Perform inflation from XML and apply a class-specific base style. This
2414 * constructor of View allows subclasses to use their own base style when
2415 * they are inflating. For example, a Button class's constructor would call
2416 * this version of the super class constructor and supply
2417 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
2418 * the theme's button style to modify all of the base view attributes (in
2419 * particular its background) as well as the Button class's attributes.
2420 *
2421 * @param context The Context the view is running in, through which it can
2422 * access the current theme, resources, etc.
2423 * @param attrs The attributes of the XML tag that is inflating the view.
2424 * @param defStyle The default style to apply to this view. If 0, no style
2425 * will be applied (beyond what is included in the theme). This may
2426 * either be an attribute resource, whose value will be retrieved
2427 * from the current theme, or an explicit style resource.
2428 * @see #View(Context, AttributeSet)
2429 */
2430 public View(Context context, AttributeSet attrs, int defStyle) {
2431 this(context);
2432
2433 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
2434 defStyle, 0);
2435
2436 Drawable background = null;
2437
2438 int leftPadding = -1;
2439 int topPadding = -1;
2440 int rightPadding = -1;
2441 int bottomPadding = -1;
2442
2443 int padding = -1;
2444
2445 int viewFlagValues = 0;
2446 int viewFlagMasks = 0;
2447
2448 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07002449
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002450 int x = 0;
2451 int y = 0;
2452
Chet Haase73066682010-11-29 15:55:32 -08002453 float tx = 0;
2454 float ty = 0;
2455 float rotation = 0;
2456 float rotationX = 0;
2457 float rotationY = 0;
2458 float sx = 1f;
2459 float sy = 1f;
2460 boolean transformSet = false;
2461
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002462 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
2463
Adam Powell637d3372010-08-25 14:37:03 -07002464 int overScrollMode = mOverScrollMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002465 final int N = a.getIndexCount();
2466 for (int i = 0; i < N; i++) {
2467 int attr = a.getIndex(i);
2468 switch (attr) {
2469 case com.android.internal.R.styleable.View_background:
2470 background = a.getDrawable(attr);
2471 break;
2472 case com.android.internal.R.styleable.View_padding:
2473 padding = a.getDimensionPixelSize(attr, -1);
2474 break;
2475 case com.android.internal.R.styleable.View_paddingLeft:
2476 leftPadding = a.getDimensionPixelSize(attr, -1);
2477 break;
2478 case com.android.internal.R.styleable.View_paddingTop:
2479 topPadding = a.getDimensionPixelSize(attr, -1);
2480 break;
2481 case com.android.internal.R.styleable.View_paddingRight:
2482 rightPadding = a.getDimensionPixelSize(attr, -1);
2483 break;
2484 case com.android.internal.R.styleable.View_paddingBottom:
2485 bottomPadding = a.getDimensionPixelSize(attr, -1);
2486 break;
2487 case com.android.internal.R.styleable.View_scrollX:
2488 x = a.getDimensionPixelOffset(attr, 0);
2489 break;
2490 case com.android.internal.R.styleable.View_scrollY:
2491 y = a.getDimensionPixelOffset(attr, 0);
2492 break;
Chet Haase73066682010-11-29 15:55:32 -08002493 case com.android.internal.R.styleable.View_alpha:
2494 setAlpha(a.getFloat(attr, 1f));
2495 break;
2496 case com.android.internal.R.styleable.View_transformPivotX:
2497 setPivotX(a.getDimensionPixelOffset(attr, 0));
2498 break;
2499 case com.android.internal.R.styleable.View_transformPivotY:
2500 setPivotY(a.getDimensionPixelOffset(attr, 0));
2501 break;
2502 case com.android.internal.R.styleable.View_translationX:
2503 tx = a.getDimensionPixelOffset(attr, 0);
2504 transformSet = true;
2505 break;
2506 case com.android.internal.R.styleable.View_translationY:
2507 ty = a.getDimensionPixelOffset(attr, 0);
2508 transformSet = true;
2509 break;
2510 case com.android.internal.R.styleable.View_rotation:
2511 rotation = a.getFloat(attr, 0);
2512 transformSet = true;
2513 break;
2514 case com.android.internal.R.styleable.View_rotationX:
2515 rotationX = a.getFloat(attr, 0);
2516 transformSet = true;
2517 break;
2518 case com.android.internal.R.styleable.View_rotationY:
2519 rotationY = a.getFloat(attr, 0);
2520 transformSet = true;
2521 break;
2522 case com.android.internal.R.styleable.View_scaleX:
2523 sx = a.getFloat(attr, 1f);
2524 transformSet = true;
2525 break;
2526 case com.android.internal.R.styleable.View_scaleY:
2527 sy = a.getFloat(attr, 1f);
2528 transformSet = true;
2529 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002530 case com.android.internal.R.styleable.View_id:
2531 mID = a.getResourceId(attr, NO_ID);
2532 break;
2533 case com.android.internal.R.styleable.View_tag:
2534 mTag = a.getText(attr);
2535 break;
2536 case com.android.internal.R.styleable.View_fitsSystemWindows:
2537 if (a.getBoolean(attr, false)) {
2538 viewFlagValues |= FITS_SYSTEM_WINDOWS;
2539 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
2540 }
2541 break;
2542 case com.android.internal.R.styleable.View_focusable:
2543 if (a.getBoolean(attr, false)) {
2544 viewFlagValues |= FOCUSABLE;
2545 viewFlagMasks |= FOCUSABLE_MASK;
2546 }
2547 break;
2548 case com.android.internal.R.styleable.View_focusableInTouchMode:
2549 if (a.getBoolean(attr, false)) {
2550 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
2551 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
2552 }
2553 break;
2554 case com.android.internal.R.styleable.View_clickable:
2555 if (a.getBoolean(attr, false)) {
2556 viewFlagValues |= CLICKABLE;
2557 viewFlagMasks |= CLICKABLE;
2558 }
2559 break;
2560 case com.android.internal.R.styleable.View_longClickable:
2561 if (a.getBoolean(attr, false)) {
2562 viewFlagValues |= LONG_CLICKABLE;
2563 viewFlagMasks |= LONG_CLICKABLE;
2564 }
2565 break;
2566 case com.android.internal.R.styleable.View_saveEnabled:
2567 if (!a.getBoolean(attr, true)) {
2568 viewFlagValues |= SAVE_DISABLED;
2569 viewFlagMasks |= SAVE_DISABLED_MASK;
2570 }
2571 break;
2572 case com.android.internal.R.styleable.View_duplicateParentState:
2573 if (a.getBoolean(attr, false)) {
2574 viewFlagValues |= DUPLICATE_PARENT_STATE;
2575 viewFlagMasks |= DUPLICATE_PARENT_STATE;
2576 }
2577 break;
2578 case com.android.internal.R.styleable.View_visibility:
2579 final int visibility = a.getInt(attr, 0);
2580 if (visibility != 0) {
2581 viewFlagValues |= VISIBILITY_FLAGS[visibility];
2582 viewFlagMasks |= VISIBILITY_MASK;
2583 }
2584 break;
2585 case com.android.internal.R.styleable.View_drawingCacheQuality:
2586 final int cacheQuality = a.getInt(attr, 0);
2587 if (cacheQuality != 0) {
2588 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
2589 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
2590 }
2591 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07002592 case com.android.internal.R.styleable.View_contentDescription:
2593 mContentDescription = a.getString(attr);
2594 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002595 case com.android.internal.R.styleable.View_soundEffectsEnabled:
2596 if (!a.getBoolean(attr, true)) {
2597 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
2598 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
2599 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002600 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002601 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
2602 if (!a.getBoolean(attr, true)) {
2603 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
2604 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
2605 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002606 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002607 case R.styleable.View_scrollbars:
2608 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
2609 if (scrollbars != SCROLLBARS_NONE) {
2610 viewFlagValues |= scrollbars;
2611 viewFlagMasks |= SCROLLBARS_MASK;
2612 initializeScrollbars(a);
2613 }
2614 break;
2615 case R.styleable.View_fadingEdge:
2616 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
2617 if (fadingEdge != FADING_EDGE_NONE) {
2618 viewFlagValues |= fadingEdge;
2619 viewFlagMasks |= FADING_EDGE_MASK;
2620 initializeFadingEdge(a);
2621 }
2622 break;
2623 case R.styleable.View_scrollbarStyle:
2624 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
2625 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2626 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
2627 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
2628 }
2629 break;
2630 case R.styleable.View_isScrollContainer:
2631 setScrollContainer = true;
2632 if (a.getBoolean(attr, false)) {
2633 setScrollContainer(true);
2634 }
2635 break;
2636 case com.android.internal.R.styleable.View_keepScreenOn:
2637 if (a.getBoolean(attr, false)) {
2638 viewFlagValues |= KEEP_SCREEN_ON;
2639 viewFlagMasks |= KEEP_SCREEN_ON;
2640 }
2641 break;
Jeff Brown85a31762010-09-01 17:01:00 -07002642 case R.styleable.View_filterTouchesWhenObscured:
2643 if (a.getBoolean(attr, false)) {
2644 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED;
2645 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED;
2646 }
2647 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002648 case R.styleable.View_nextFocusLeft:
2649 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
2650 break;
2651 case R.styleable.View_nextFocusRight:
2652 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
2653 break;
2654 case R.styleable.View_nextFocusUp:
2655 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
2656 break;
2657 case R.styleable.View_nextFocusDown:
2658 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
2659 break;
Jeff Brown4e6319b2010-12-13 10:36:51 -08002660 case R.styleable.View_nextFocusForward:
2661 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID);
2662 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002663 case R.styleable.View_minWidth:
2664 mMinWidth = a.getDimensionPixelSize(attr, 0);
2665 break;
2666 case R.styleable.View_minHeight:
2667 mMinHeight = a.getDimensionPixelSize(attr, 0);
2668 break;
Romain Guy9a817362009-05-01 10:57:14 -07002669 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07002670 if (context.isRestricted()) {
2671 throw new IllegalStateException("The android:onClick attribute cannot "
2672 + "be used within a restricted context");
2673 }
2674
Romain Guy9a817362009-05-01 10:57:14 -07002675 final String handlerName = a.getString(attr);
2676 if (handlerName != null) {
2677 setOnClickListener(new OnClickListener() {
2678 private Method mHandler;
2679
2680 public void onClick(View v) {
2681 if (mHandler == null) {
2682 try {
2683 mHandler = getContext().getClass().getMethod(handlerName,
2684 View.class);
2685 } catch (NoSuchMethodException e) {
Joe Onorato42e14d72010-03-11 14:51:17 -08002686 int id = getId();
2687 String idText = id == NO_ID ? "" : " with id '"
2688 + getContext().getResources().getResourceEntryName(
2689 id) + "'";
Romain Guy9a817362009-05-01 10:57:14 -07002690 throw new IllegalStateException("Could not find a method " +
Joe Onorato42e14d72010-03-11 14:51:17 -08002691 handlerName + "(View) in the activity "
2692 + getContext().getClass() + " for onClick handler"
2693 + " on view " + View.this.getClass() + idText, e);
Romain Guy9a817362009-05-01 10:57:14 -07002694 }
2695 }
2696
2697 try {
2698 mHandler.invoke(getContext(), View.this);
2699 } catch (IllegalAccessException e) {
2700 throw new IllegalStateException("Could not execute non "
2701 + "public method of the activity", e);
2702 } catch (InvocationTargetException e) {
2703 throw new IllegalStateException("Could not execute "
2704 + "method of the activity", e);
2705 }
2706 }
2707 });
2708 }
2709 break;
Adam Powell637d3372010-08-25 14:37:03 -07002710 case R.styleable.View_overScrollMode:
2711 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS);
2712 break;
Adam Powell20232d02010-12-08 21:08:53 -08002713 case R.styleable.View_verticalScrollbarPosition:
2714 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT);
2715 break;
Romain Guy171c5922011-01-06 10:04:23 -08002716 case R.styleable.View_layerType:
2717 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null);
2718 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002719 }
2720 }
2721
Adam Powell637d3372010-08-25 14:37:03 -07002722 setOverScrollMode(overScrollMode);
2723
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002724 if (background != null) {
2725 setBackgroundDrawable(background);
2726 }
2727
2728 if (padding >= 0) {
2729 leftPadding = padding;
2730 topPadding = padding;
2731 rightPadding = padding;
2732 bottomPadding = padding;
2733 }
2734
2735 // If the user specified the padding (either with android:padding or
2736 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
2737 // use the default padding or the padding from the background drawable
2738 // (stored at this point in mPadding*)
2739 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
2740 topPadding >= 0 ? topPadding : mPaddingTop,
2741 rightPadding >= 0 ? rightPadding : mPaddingRight,
2742 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
2743
2744 if (viewFlagMasks != 0) {
2745 setFlags(viewFlagValues, viewFlagMasks);
2746 }
2747
2748 // Needs to be called after mViewFlags is set
2749 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2750 recomputePadding();
2751 }
2752
2753 if (x != 0 || y != 0) {
2754 scrollTo(x, y);
2755 }
2756
Chet Haase73066682010-11-29 15:55:32 -08002757 if (transformSet) {
2758 setTranslationX(tx);
2759 setTranslationY(ty);
2760 setRotation(rotation);
2761 setRotationX(rotationX);
2762 setRotationY(rotationY);
2763 setScaleX(sx);
2764 setScaleY(sy);
2765 }
2766
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002767 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
2768 setScrollContainer(true);
2769 }
Romain Guy8f1344f52009-05-15 16:03:59 -07002770
2771 computeOpaqueFlags();
2772
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002773 a.recycle();
2774 }
2775
2776 /**
2777 * Non-public constructor for use in testing
2778 */
2779 View() {
2780 }
2781
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002782 /**
2783 * <p>
2784 * Initializes the fading edges from a given set of styled attributes. This
2785 * method should be called by subclasses that need fading edges and when an
2786 * instance of these subclasses is created programmatically rather than
2787 * being inflated from XML. This method is automatically called when the XML
2788 * is inflated.
2789 * </p>
2790 *
2791 * @param a the styled attributes set to initialize the fading edges from
2792 */
2793 protected void initializeFadingEdge(TypedArray a) {
2794 initScrollCache();
2795
2796 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
2797 R.styleable.View_fadingEdgeLength,
2798 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
2799 }
2800
2801 /**
2802 * Returns the size of the vertical faded edges used to indicate that more
2803 * content in this view is visible.
2804 *
2805 * @return The size in pixels of the vertical faded edge or 0 if vertical
2806 * faded edges are not enabled for this view.
2807 * @attr ref android.R.styleable#View_fadingEdgeLength
2808 */
2809 public int getVerticalFadingEdgeLength() {
2810 if (isVerticalFadingEdgeEnabled()) {
2811 ScrollabilityCache cache = mScrollCache;
2812 if (cache != null) {
2813 return cache.fadingEdgeLength;
2814 }
2815 }
2816 return 0;
2817 }
2818
2819 /**
2820 * Set the size of the faded edge used to indicate that more content in this
2821 * view is available. Will not change whether the fading edge is enabled; use
2822 * {@link #setVerticalFadingEdgeEnabled} or {@link #setHorizontalFadingEdgeEnabled}
2823 * to enable the fading edge for the vertical or horizontal fading edges.
2824 *
2825 * @param length The size in pixels of the faded edge used to indicate that more
2826 * content in this view is visible.
2827 */
2828 public void setFadingEdgeLength(int length) {
2829 initScrollCache();
2830 mScrollCache.fadingEdgeLength = length;
2831 }
2832
2833 /**
2834 * Returns the size of the horizontal faded edges used to indicate that more
2835 * content in this view is visible.
2836 *
2837 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
2838 * faded edges are not enabled for this view.
2839 * @attr ref android.R.styleable#View_fadingEdgeLength
2840 */
2841 public int getHorizontalFadingEdgeLength() {
2842 if (isHorizontalFadingEdgeEnabled()) {
2843 ScrollabilityCache cache = mScrollCache;
2844 if (cache != null) {
2845 return cache.fadingEdgeLength;
2846 }
2847 }
2848 return 0;
2849 }
2850
2851 /**
2852 * Returns the width of the vertical scrollbar.
2853 *
2854 * @return The width in pixels of the vertical scrollbar or 0 if there
2855 * is no vertical scrollbar.
2856 */
2857 public int getVerticalScrollbarWidth() {
2858 ScrollabilityCache cache = mScrollCache;
2859 if (cache != null) {
2860 ScrollBarDrawable scrollBar = cache.scrollBar;
2861 if (scrollBar != null) {
2862 int size = scrollBar.getSize(true);
2863 if (size <= 0) {
2864 size = cache.scrollBarSize;
2865 }
2866 return size;
2867 }
2868 return 0;
2869 }
2870 return 0;
2871 }
2872
2873 /**
2874 * Returns the height of the horizontal scrollbar.
2875 *
2876 * @return The height in pixels of the horizontal scrollbar or 0 if
2877 * there is no horizontal scrollbar.
2878 */
2879 protected int getHorizontalScrollbarHeight() {
2880 ScrollabilityCache cache = mScrollCache;
2881 if (cache != null) {
2882 ScrollBarDrawable scrollBar = cache.scrollBar;
2883 if (scrollBar != null) {
2884 int size = scrollBar.getSize(false);
2885 if (size <= 0) {
2886 size = cache.scrollBarSize;
2887 }
2888 return size;
2889 }
2890 return 0;
2891 }
2892 return 0;
2893 }
2894
2895 /**
2896 * <p>
2897 * Initializes the scrollbars from a given set of styled attributes. This
2898 * method should be called by subclasses that need scrollbars and when an
2899 * instance of these subclasses is created programmatically rather than
2900 * being inflated from XML. This method is automatically called when the XML
2901 * is inflated.
2902 * </p>
2903 *
2904 * @param a the styled attributes set to initialize the scrollbars from
2905 */
2906 protected void initializeScrollbars(TypedArray a) {
2907 initScrollCache();
2908
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002909 final ScrollabilityCache scrollabilityCache = mScrollCache;
Mike Cleronf116bf82009-09-27 19:14:12 -07002910
2911 if (scrollabilityCache.scrollBar == null) {
2912 scrollabilityCache.scrollBar = new ScrollBarDrawable();
2913 }
2914
Romain Guy8bda2482010-03-02 11:42:11 -08002915 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002916
Mike Cleronf116bf82009-09-27 19:14:12 -07002917 if (!fadeScrollbars) {
2918 scrollabilityCache.state = ScrollabilityCache.ON;
2919 }
2920 scrollabilityCache.fadeScrollBars = fadeScrollbars;
2921
2922
2923 scrollabilityCache.scrollBarFadeDuration = a.getInt(
2924 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
2925 .getScrollBarFadeDuration());
2926 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
2927 R.styleable.View_scrollbarDefaultDelayBeforeFade,
2928 ViewConfiguration.getScrollDefaultDelay());
2929
2930
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002931 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
2932 com.android.internal.R.styleable.View_scrollbarSize,
2933 ViewConfiguration.get(mContext).getScaledScrollBarSize());
2934
2935 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
2936 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
2937
2938 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
2939 if (thumb != null) {
2940 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
2941 }
2942
2943 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
2944 false);
2945 if (alwaysDraw) {
2946 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
2947 }
2948
2949 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
2950 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
2951
2952 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
2953 if (thumb != null) {
2954 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
2955 }
2956
2957 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
2958 false);
2959 if (alwaysDraw) {
2960 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
2961 }
2962
2963 // Re-apply user/background padding so that scrollbar(s) get added
2964 recomputePadding();
2965 }
2966
2967 /**
2968 * <p>
2969 * Initalizes the scrollability cache if necessary.
2970 * </p>
2971 */
2972 private void initScrollCache() {
2973 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07002974 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002975 }
2976 }
2977
2978 /**
Adam Powell20232d02010-12-08 21:08:53 -08002979 * Set the position of the vertical scroll bar. Should be one of
2980 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or
2981 * {@link #SCROLLBAR_POSITION_RIGHT}.
2982 *
2983 * @param position Where the vertical scroll bar should be positioned.
2984 */
2985 public void setVerticalScrollbarPosition(int position) {
2986 if (mVerticalScrollbarPosition != position) {
2987 mVerticalScrollbarPosition = position;
2988 computeOpaqueFlags();
2989 recomputePadding();
2990 }
2991 }
2992
2993 /**
2994 * @return The position where the vertical scroll bar will show, if applicable.
2995 * @see #setVerticalScrollbarPosition(int)
2996 */
2997 public int getVerticalScrollbarPosition() {
2998 return mVerticalScrollbarPosition;
2999 }
3000
3001 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003002 * Register a callback to be invoked when focus of this view changed.
3003 *
3004 * @param l The callback that will run.
3005 */
3006 public void setOnFocusChangeListener(OnFocusChangeListener l) {
3007 mOnFocusChangeListener = l;
3008 }
3009
3010 /**
Chet Haase21cd1382010-09-01 17:42:29 -07003011 * Add a listener that will be called when the bounds of the view change due to
3012 * layout processing.
3013 *
3014 * @param listener The listener that will be called when layout bounds change.
3015 */
3016 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) {
3017 if (mOnLayoutChangeListeners == null) {
3018 mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>();
3019 }
3020 mOnLayoutChangeListeners.add(listener);
3021 }
3022
3023 /**
3024 * Remove a listener for layout changes.
3025 *
3026 * @param listener The listener for layout bounds change.
3027 */
3028 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) {
3029 if (mOnLayoutChangeListeners == null) {
3030 return;
3031 }
3032 mOnLayoutChangeListeners.remove(listener);
3033 }
3034
3035 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003036 * Returns the focus-change callback registered for this view.
3037 *
3038 * @return The callback, or null if one is not registered.
3039 */
3040 public OnFocusChangeListener getOnFocusChangeListener() {
3041 return mOnFocusChangeListener;
3042 }
3043
3044 /**
3045 * Register a callback to be invoked when this view is clicked. If this view is not
3046 * clickable, it becomes clickable.
3047 *
3048 * @param l The callback that will run
3049 *
3050 * @see #setClickable(boolean)
3051 */
3052 public void setOnClickListener(OnClickListener l) {
3053 if (!isClickable()) {
3054 setClickable(true);
3055 }
3056 mOnClickListener = l;
3057 }
3058
3059 /**
3060 * Register a callback to be invoked when this view is clicked and held. If this view is not
3061 * long clickable, it becomes long clickable.
3062 *
3063 * @param l The callback that will run
3064 *
3065 * @see #setLongClickable(boolean)
3066 */
3067 public void setOnLongClickListener(OnLongClickListener l) {
3068 if (!isLongClickable()) {
3069 setLongClickable(true);
3070 }
3071 mOnLongClickListener = l;
3072 }
3073
3074 /**
3075 * Register a callback to be invoked when the context menu for this view is
3076 * being built. If this view is not long clickable, it becomes long clickable.
3077 *
3078 * @param l The callback that will run
3079 *
3080 */
3081 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
3082 if (!isLongClickable()) {
3083 setLongClickable(true);
3084 }
3085 mOnCreateContextMenuListener = l;
3086 }
3087
3088 /**
3089 * Call this view's OnClickListener, if it is defined.
3090 *
3091 * @return True there was an assigned OnClickListener that was called, false
3092 * otherwise is returned.
3093 */
3094 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003095 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
3096
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003097 if (mOnClickListener != null) {
3098 playSoundEffect(SoundEffectConstants.CLICK);
3099 mOnClickListener.onClick(this);
3100 return true;
3101 }
3102
3103 return false;
3104 }
3105
3106 /**
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003107 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the
3108 * OnLongClickListener did not consume the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003109 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003110 * @return True if one of the above receivers consumed the event, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003111 */
3112 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003113 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
3114
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003115 boolean handled = false;
3116 if (mOnLongClickListener != null) {
3117 handled = mOnLongClickListener.onLongClick(View.this);
3118 }
3119 if (!handled) {
3120 handled = showContextMenu();
3121 }
3122 if (handled) {
3123 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
3124 }
3125 return handled;
3126 }
3127
3128 /**
3129 * Bring up the context menu for this view.
3130 *
3131 * @return Whether a context menu was displayed.
3132 */
3133 public boolean showContextMenu() {
3134 return getParent().showContextMenuForChild(this);
3135 }
3136
3137 /**
Adam Powell6e346362010-07-23 10:18:23 -07003138 * Start an action mode.
3139 *
3140 * @param callback Callback that will control the lifecycle of the action mode
3141 * @return The new action mode if it is started, null otherwise
3142 *
3143 * @see ActionMode
3144 */
3145 public ActionMode startActionMode(ActionMode.Callback callback) {
3146 return getParent().startActionModeForChild(this, callback);
3147 }
3148
3149 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003150 * Register a callback to be invoked when a key is pressed in this view.
3151 * @param l the key listener to attach to this view
3152 */
3153 public void setOnKeyListener(OnKeyListener l) {
3154 mOnKeyListener = l;
3155 }
3156
3157 /**
3158 * Register a callback to be invoked when a touch event is sent to this view.
3159 * @param l the touch listener to attach to this view
3160 */
3161 public void setOnTouchListener(OnTouchListener l) {
3162 mOnTouchListener = l;
3163 }
3164
3165 /**
Chris Tate32affef2010-10-18 15:29:21 -07003166 * Register a callback to be invoked when a drag event is sent to this view.
3167 * @param l The drag listener to attach to this view
3168 */
3169 public void setOnDragListener(OnDragListener l) {
3170 mOnDragListener = l;
3171 }
3172
3173 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003174 * Give this view focus. This will cause {@link #onFocusChanged} to be called.
3175 *
3176 * Note: this does not check whether this {@link View} should get focus, it just
3177 * gives it focus no matter what. It should only be called internally by framework
3178 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
3179 *
3180 * @param direction values are View.FOCUS_UP, View.FOCUS_DOWN,
3181 * View.FOCUS_LEFT or View.FOCUS_RIGHT. This is the direction which
3182 * focus moved when requestFocus() is called. It may not always
3183 * apply, in which case use the default View.FOCUS_DOWN.
3184 * @param previouslyFocusedRect The rectangle of the view that had focus
3185 * prior in this View's coordinate system.
3186 */
3187 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
3188 if (DBG) {
3189 System.out.println(this + " requestFocus()");
3190 }
3191
3192 if ((mPrivateFlags & FOCUSED) == 0) {
3193 mPrivateFlags |= FOCUSED;
3194
3195 if (mParent != null) {
3196 mParent.requestChildFocus(this, this);
3197 }
3198
3199 onFocusChanged(true, direction, previouslyFocusedRect);
3200 refreshDrawableState();
3201 }
3202 }
3203
3204 /**
3205 * Request that a rectangle of this view be visible on the screen,
3206 * scrolling if necessary just enough.
3207 *
3208 * <p>A View should call this if it maintains some notion of which part
3209 * of its content is interesting. For example, a text editing view
3210 * should call this when its cursor moves.
3211 *
3212 * @param rectangle The rectangle.
3213 * @return Whether any parent scrolled.
3214 */
3215 public boolean requestRectangleOnScreen(Rect rectangle) {
3216 return requestRectangleOnScreen(rectangle, false);
3217 }
3218
3219 /**
3220 * Request that a rectangle of this view be visible on the screen,
3221 * scrolling if necessary just enough.
3222 *
3223 * <p>A View should call this if it maintains some notion of which part
3224 * of its content is interesting. For example, a text editing view
3225 * should call this when its cursor moves.
3226 *
3227 * <p>When <code>immediate</code> is set to true, scrolling will not be
3228 * animated.
3229 *
3230 * @param rectangle The rectangle.
3231 * @param immediate True to forbid animated scrolling, false otherwise
3232 * @return Whether any parent scrolled.
3233 */
3234 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
3235 View child = this;
3236 ViewParent parent = mParent;
3237 boolean scrolled = false;
3238 while (parent != null) {
3239 scrolled |= parent.requestChildRectangleOnScreen(child,
3240 rectangle, immediate);
3241
3242 // offset rect so next call has the rectangle in the
3243 // coordinate system of its direct child.
3244 rectangle.offset(child.getLeft(), child.getTop());
3245 rectangle.offset(-child.getScrollX(), -child.getScrollY());
3246
3247 if (!(parent instanceof View)) {
3248 break;
3249 }
Romain Guy8506ab42009-06-11 17:35:47 -07003250
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003251 child = (View) parent;
3252 parent = child.getParent();
3253 }
3254 return scrolled;
3255 }
3256
3257 /**
3258 * Called when this view wants to give up focus. This will cause
3259 * {@link #onFocusChanged} to be called.
3260 */
3261 public void clearFocus() {
3262 if (DBG) {
3263 System.out.println(this + " clearFocus()");
3264 }
3265
3266 if ((mPrivateFlags & FOCUSED) != 0) {
3267 mPrivateFlags &= ~FOCUSED;
3268
3269 if (mParent != null) {
3270 mParent.clearChildFocus(this);
3271 }
3272
3273 onFocusChanged(false, 0, null);
3274 refreshDrawableState();
3275 }
3276 }
3277
3278 /**
3279 * Called to clear the focus of a view that is about to be removed.
3280 * Doesn't call clearChildFocus, which prevents this view from taking
3281 * focus again before it has been removed from the parent
3282 */
3283 void clearFocusForRemoval() {
3284 if ((mPrivateFlags & FOCUSED) != 0) {
3285 mPrivateFlags &= ~FOCUSED;
3286
3287 onFocusChanged(false, 0, null);
3288 refreshDrawableState();
3289 }
3290 }
3291
3292 /**
3293 * Called internally by the view system when a new view is getting focus.
3294 * This is what clears the old focus.
3295 */
3296 void unFocus() {
3297 if (DBG) {
3298 System.out.println(this + " unFocus()");
3299 }
3300
3301 if ((mPrivateFlags & FOCUSED) != 0) {
3302 mPrivateFlags &= ~FOCUSED;
3303
3304 onFocusChanged(false, 0, null);
3305 refreshDrawableState();
3306 }
3307 }
3308
3309 /**
3310 * Returns true if this view has focus iteself, or is the ancestor of the
3311 * view that has focus.
3312 *
3313 * @return True if this view has or contains focus, false otherwise.
3314 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003315 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003316 public boolean hasFocus() {
3317 return (mPrivateFlags & FOCUSED) != 0;
3318 }
3319
3320 /**
3321 * Returns true if this view is focusable or if it contains a reachable View
3322 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
3323 * is a View whose parents do not block descendants focus.
3324 *
3325 * Only {@link #VISIBLE} views are considered focusable.
3326 *
3327 * @return True if the view is focusable or if the view contains a focusable
3328 * View, false otherwise.
3329 *
3330 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
3331 */
3332 public boolean hasFocusable() {
3333 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
3334 }
3335
3336 /**
3337 * Called by the view system when the focus state of this view changes.
3338 * When the focus change event is caused by directional navigation, direction
3339 * and previouslyFocusedRect provide insight into where the focus is coming from.
3340 * When overriding, be sure to call up through to the super class so that
3341 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07003342 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003343 * @param gainFocus True if the View has focus; false otherwise.
3344 * @param direction The direction focus has moved when requestFocus()
3345 * is called to give this view focus. Values are
Jeff Brown4e6319b2010-12-13 10:36:51 -08003346 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT},
3347 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}.
3348 * It may not always apply, in which case use the default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003349 * @param previouslyFocusedRect The rectangle, in this view's coordinate
3350 * system, of the previously focused view. If applicable, this will be
3351 * passed in as finer grained information about where the focus is coming
3352 * from (in addition to direction). Will be <code>null</code> otherwise.
3353 */
3354 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07003355 if (gainFocus) {
3356 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
3357 }
3358
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003359 InputMethodManager imm = InputMethodManager.peekInstance();
3360 if (!gainFocus) {
3361 if (isPressed()) {
3362 setPressed(false);
3363 }
3364 if (imm != null && mAttachInfo != null
3365 && mAttachInfo.mHasWindowFocus) {
3366 imm.focusOut(this);
3367 }
Romain Guya2431d02009-04-30 16:30:00 -07003368 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003369 } else if (imm != null && mAttachInfo != null
3370 && mAttachInfo.mHasWindowFocus) {
3371 imm.focusIn(this);
3372 }
Romain Guy8506ab42009-06-11 17:35:47 -07003373
Romain Guy0fd89bf2011-01-26 15:41:30 -08003374 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003375 if (mOnFocusChangeListener != null) {
3376 mOnFocusChangeListener.onFocusChange(this, gainFocus);
3377 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07003378
3379 if (mAttachInfo != null) {
3380 mAttachInfo.mKeyDispatchState.reset(this);
3381 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003382 }
3383
3384 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07003385 * {@inheritDoc}
3386 */
3387 public void sendAccessibilityEvent(int eventType) {
3388 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
3389 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
3390 }
3391 }
3392
3393 /**
3394 * {@inheritDoc}
3395 */
3396 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
Svetoslav Ganov9cd1eca2011-01-13 14:24:02 -08003397 if (!isShown()) {
3398 return;
3399 }
svetoslavganov75986cf2009-05-14 22:28:01 -07003400 event.setClassName(getClass().getName());
3401 event.setPackageName(getContext().getPackageName());
3402 event.setEnabled(isEnabled());
3403 event.setContentDescription(mContentDescription);
3404
3405 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) {
3406 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList;
3407 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, FOCUSABLES_ALL);
3408 event.setItemCount(focusablesTempList.size());
3409 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
3410 focusablesTempList.clear();
3411 }
3412
3413 dispatchPopulateAccessibilityEvent(event);
3414
3415 AccessibilityManager.getInstance(mContext).sendAccessibilityEvent(event);
3416 }
3417
3418 /**
3419 * Dispatches an {@link AccessibilityEvent} to the {@link View} children
3420 * to be populated.
3421 *
3422 * @param event The event.
3423 *
3424 * @return True if the event population was completed.
3425 */
3426 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
3427 return false;
3428 }
3429
3430 /**
3431 * Gets the {@link View} description. It briefly describes the view and is
3432 * primarily used for accessibility support. Set this property to enable
3433 * better accessibility support for your application. This is especially
3434 * true for views that do not have textual representation (For example,
3435 * ImageButton).
3436 *
3437 * @return The content descriptiopn.
3438 *
3439 * @attr ref android.R.styleable#View_contentDescription
3440 */
3441 public CharSequence getContentDescription() {
3442 return mContentDescription;
3443 }
3444
3445 /**
3446 * Sets the {@link View} description. It briefly describes the view and is
3447 * primarily used for accessibility support. Set this property to enable
3448 * better accessibility support for your application. This is especially
3449 * true for views that do not have textual representation (For example,
3450 * ImageButton).
3451 *
3452 * @param contentDescription The content description.
3453 *
3454 * @attr ref android.R.styleable#View_contentDescription
3455 */
3456 public void setContentDescription(CharSequence contentDescription) {
3457 mContentDescription = contentDescription;
3458 }
3459
3460 /**
Romain Guya2431d02009-04-30 16:30:00 -07003461 * Invoked whenever this view loses focus, either by losing window focus or by losing
3462 * focus within its window. This method can be used to clear any state tied to the
3463 * focus. For instance, if a button is held pressed with the trackball and the window
3464 * loses focus, this method can be used to cancel the press.
3465 *
3466 * Subclasses of View overriding this method should always call super.onFocusLost().
3467 *
3468 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07003469 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07003470 *
3471 * @hide pending API council approval
3472 */
3473 protected void onFocusLost() {
3474 resetPressedState();
3475 }
3476
3477 private void resetPressedState() {
3478 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
3479 return;
3480 }
3481
3482 if (isPressed()) {
3483 setPressed(false);
3484
3485 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05003486 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07003487 }
3488 }
3489 }
3490
3491 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003492 * Returns true if this view has focus
3493 *
3494 * @return True if this view has focus, false otherwise.
3495 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003496 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003497 public boolean isFocused() {
3498 return (mPrivateFlags & FOCUSED) != 0;
3499 }
3500
3501 /**
3502 * Find the view in the hierarchy rooted at this view that currently has
3503 * focus.
3504 *
3505 * @return The view that currently has focus, or null if no focused view can
3506 * be found.
3507 */
3508 public View findFocus() {
3509 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
3510 }
3511
3512 /**
3513 * Change whether this view is one of the set of scrollable containers in
3514 * its window. This will be used to determine whether the window can
3515 * resize or must pan when a soft input area is open -- scrollable
3516 * containers allow the window to use resize mode since the container
3517 * will appropriately shrink.
3518 */
3519 public void setScrollContainer(boolean isScrollContainer) {
3520 if (isScrollContainer) {
3521 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
3522 mAttachInfo.mScrollContainers.add(this);
3523 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
3524 }
3525 mPrivateFlags |= SCROLL_CONTAINER;
3526 } else {
3527 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
3528 mAttachInfo.mScrollContainers.remove(this);
3529 }
3530 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
3531 }
3532 }
3533
3534 /**
3535 * Returns the quality of the drawing cache.
3536 *
3537 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3538 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3539 *
3540 * @see #setDrawingCacheQuality(int)
3541 * @see #setDrawingCacheEnabled(boolean)
3542 * @see #isDrawingCacheEnabled()
3543 *
3544 * @attr ref android.R.styleable#View_drawingCacheQuality
3545 */
3546 public int getDrawingCacheQuality() {
3547 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
3548 }
3549
3550 /**
3551 * Set the drawing cache quality of this view. This value is used only when the
3552 * drawing cache is enabled
3553 *
3554 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3555 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3556 *
3557 * @see #getDrawingCacheQuality()
3558 * @see #setDrawingCacheEnabled(boolean)
3559 * @see #isDrawingCacheEnabled()
3560 *
3561 * @attr ref android.R.styleable#View_drawingCacheQuality
3562 */
3563 public void setDrawingCacheQuality(int quality) {
3564 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
3565 }
3566
3567 /**
3568 * Returns whether the screen should remain on, corresponding to the current
3569 * value of {@link #KEEP_SCREEN_ON}.
3570 *
3571 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
3572 *
3573 * @see #setKeepScreenOn(boolean)
3574 *
3575 * @attr ref android.R.styleable#View_keepScreenOn
3576 */
3577 public boolean getKeepScreenOn() {
3578 return (mViewFlags & KEEP_SCREEN_ON) != 0;
3579 }
3580
3581 /**
3582 * Controls whether the screen should remain on, modifying the
3583 * value of {@link #KEEP_SCREEN_ON}.
3584 *
3585 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
3586 *
3587 * @see #getKeepScreenOn()
3588 *
3589 * @attr ref android.R.styleable#View_keepScreenOn
3590 */
3591 public void setKeepScreenOn(boolean keepScreenOn) {
3592 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
3593 }
3594
3595 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003596 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
3597 * @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 -08003598 *
3599 * @attr ref android.R.styleable#View_nextFocusLeft
3600 */
3601 public int getNextFocusLeftId() {
3602 return mNextFocusLeftId;
3603 }
3604
3605 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003606 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
3607 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
3608 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003609 *
3610 * @attr ref android.R.styleable#View_nextFocusLeft
3611 */
3612 public void setNextFocusLeftId(int nextFocusLeftId) {
3613 mNextFocusLeftId = nextFocusLeftId;
3614 }
3615
3616 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003617 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
3618 * @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 -08003619 *
3620 * @attr ref android.R.styleable#View_nextFocusRight
3621 */
3622 public int getNextFocusRightId() {
3623 return mNextFocusRightId;
3624 }
3625
3626 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003627 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
3628 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
3629 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003630 *
3631 * @attr ref android.R.styleable#View_nextFocusRight
3632 */
3633 public void setNextFocusRightId(int nextFocusRightId) {
3634 mNextFocusRightId = nextFocusRightId;
3635 }
3636
3637 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003638 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
3639 * @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 -08003640 *
3641 * @attr ref android.R.styleable#View_nextFocusUp
3642 */
3643 public int getNextFocusUpId() {
3644 return mNextFocusUpId;
3645 }
3646
3647 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003648 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
3649 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
3650 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003651 *
3652 * @attr ref android.R.styleable#View_nextFocusUp
3653 */
3654 public void setNextFocusUpId(int nextFocusUpId) {
3655 mNextFocusUpId = nextFocusUpId;
3656 }
3657
3658 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003659 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
3660 * @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 -08003661 *
3662 * @attr ref android.R.styleable#View_nextFocusDown
3663 */
3664 public int getNextFocusDownId() {
3665 return mNextFocusDownId;
3666 }
3667
3668 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003669 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
3670 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
3671 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003672 *
3673 * @attr ref android.R.styleable#View_nextFocusDown
3674 */
3675 public void setNextFocusDownId(int nextFocusDownId) {
3676 mNextFocusDownId = nextFocusDownId;
3677 }
3678
3679 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003680 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
3681 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
3682 *
3683 * @attr ref android.R.styleable#View_nextFocusForward
3684 */
3685 public int getNextFocusForwardId() {
3686 return mNextFocusForwardId;
3687 }
3688
3689 /**
3690 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
3691 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
3692 * decide automatically.
3693 *
3694 * @attr ref android.R.styleable#View_nextFocusForward
3695 */
3696 public void setNextFocusForwardId(int nextFocusForwardId) {
3697 mNextFocusForwardId = nextFocusForwardId;
3698 }
3699
3700 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003701 * Returns the visibility of this view and all of its ancestors
3702 *
3703 * @return True if this view and all of its ancestors are {@link #VISIBLE}
3704 */
3705 public boolean isShown() {
3706 View current = this;
3707 //noinspection ConstantConditions
3708 do {
3709 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
3710 return false;
3711 }
3712 ViewParent parent = current.mParent;
3713 if (parent == null) {
3714 return false; // We are not attached to the view root
3715 }
3716 if (!(parent instanceof View)) {
3717 return true;
3718 }
3719 current = (View) parent;
3720 } while (current != null);
3721
3722 return false;
3723 }
3724
3725 /**
3726 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag
3727 * is set
3728 *
3729 * @param insets Insets for system windows
3730 *
3731 * @return True if this view applied the insets, false otherwise
3732 */
3733 protected boolean fitSystemWindows(Rect insets) {
3734 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
3735 mPaddingLeft = insets.left;
3736 mPaddingTop = insets.top;
3737 mPaddingRight = insets.right;
3738 mPaddingBottom = insets.bottom;
3739 requestLayout();
3740 return true;
3741 }
3742 return false;
3743 }
3744
3745 /**
Jim Miller0b2a6d02010-07-13 18:01:29 -07003746 * Determine if this view has the FITS_SYSTEM_WINDOWS flag set.
3747 * @return True if window has FITS_SYSTEM_WINDOWS set
3748 *
3749 * @hide
3750 */
3751 public boolean isFitsSystemWindowsFlagSet() {
3752 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
3753 }
3754
3755 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003756 * Returns the visibility status for this view.
3757 *
3758 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3759 * @attr ref android.R.styleable#View_visibility
3760 */
3761 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07003762 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
3763 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
3764 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003765 })
3766 public int getVisibility() {
3767 return mViewFlags & VISIBILITY_MASK;
3768 }
3769
3770 /**
3771 * Set the enabled state of this view.
3772 *
3773 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3774 * @attr ref android.R.styleable#View_visibility
3775 */
3776 @RemotableViewMethod
3777 public void setVisibility(int visibility) {
3778 setFlags(visibility, VISIBILITY_MASK);
3779 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false);
3780 }
3781
3782 /**
3783 * Returns the enabled status for this view. The interpretation of the
3784 * enabled state varies by subclass.
3785 *
3786 * @return True if this view is enabled, false otherwise.
3787 */
3788 @ViewDebug.ExportedProperty
3789 public boolean isEnabled() {
3790 return (mViewFlags & ENABLED_MASK) == ENABLED;
3791 }
3792
3793 /**
3794 * Set the enabled state of this view. The interpretation of the enabled
3795 * state varies by subclass.
3796 *
3797 * @param enabled True if this view is enabled, false otherwise.
3798 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08003799 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003800 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07003801 if (enabled == isEnabled()) return;
3802
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003803 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
3804
3805 /*
3806 * The View most likely has to change its appearance, so refresh
3807 * the drawable state.
3808 */
3809 refreshDrawableState();
3810
3811 // Invalidate too, since the default behavior for views is to be
3812 // be drawn at 50% alpha rather than to change the drawable.
Romain Guy0fd89bf2011-01-26 15:41:30 -08003813 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003814 }
3815
3816 /**
3817 * Set whether this view can receive the focus.
3818 *
3819 * Setting this to false will also ensure that this view is not focusable
3820 * in touch mode.
3821 *
3822 * @param focusable If true, this view can receive the focus.
3823 *
3824 * @see #setFocusableInTouchMode(boolean)
3825 * @attr ref android.R.styleable#View_focusable
3826 */
3827 public void setFocusable(boolean focusable) {
3828 if (!focusable) {
3829 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
3830 }
3831 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
3832 }
3833
3834 /**
3835 * Set whether this view can receive focus while in touch mode.
3836 *
3837 * Setting this to true will also ensure that this view is focusable.
3838 *
3839 * @param focusableInTouchMode If true, this view can receive the focus while
3840 * in touch mode.
3841 *
3842 * @see #setFocusable(boolean)
3843 * @attr ref android.R.styleable#View_focusableInTouchMode
3844 */
3845 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
3846 // Focusable in touch mode should always be set before the focusable flag
3847 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
3848 // which, in touch mode, will not successfully request focus on this view
3849 // because the focusable in touch mode flag is not set
3850 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
3851 if (focusableInTouchMode) {
3852 setFlags(FOCUSABLE, FOCUSABLE_MASK);
3853 }
3854 }
3855
3856 /**
3857 * Set whether this view should have sound effects enabled for events such as
3858 * clicking and touching.
3859 *
3860 * <p>You may wish to disable sound effects for a view if you already play sounds,
3861 * for instance, a dial key that plays dtmf tones.
3862 *
3863 * @param soundEffectsEnabled whether sound effects are enabled for this view.
3864 * @see #isSoundEffectsEnabled()
3865 * @see #playSoundEffect(int)
3866 * @attr ref android.R.styleable#View_soundEffectsEnabled
3867 */
3868 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
3869 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
3870 }
3871
3872 /**
3873 * @return whether this view should have sound effects enabled for events such as
3874 * clicking and touching.
3875 *
3876 * @see #setSoundEffectsEnabled(boolean)
3877 * @see #playSoundEffect(int)
3878 * @attr ref android.R.styleable#View_soundEffectsEnabled
3879 */
3880 @ViewDebug.ExportedProperty
3881 public boolean isSoundEffectsEnabled() {
3882 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
3883 }
3884
3885 /**
3886 * Set whether this view should have haptic feedback for events such as
3887 * long presses.
3888 *
3889 * <p>You may wish to disable haptic feedback if your view already controls
3890 * its own haptic feedback.
3891 *
3892 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
3893 * @see #isHapticFeedbackEnabled()
3894 * @see #performHapticFeedback(int)
3895 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3896 */
3897 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
3898 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
3899 }
3900
3901 /**
3902 * @return whether this view should have haptic feedback enabled for events
3903 * long presses.
3904 *
3905 * @see #setHapticFeedbackEnabled(boolean)
3906 * @see #performHapticFeedback(int)
3907 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3908 */
3909 @ViewDebug.ExportedProperty
3910 public boolean isHapticFeedbackEnabled() {
3911 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
3912 }
3913
3914 /**
3915 * If this view doesn't do any drawing on its own, set this flag to
3916 * allow further optimizations. By default, this flag is not set on
3917 * View, but could be set on some View subclasses such as ViewGroup.
3918 *
3919 * Typically, if you override {@link #onDraw} you should clear this flag.
3920 *
3921 * @param willNotDraw whether or not this View draw on its own
3922 */
3923 public void setWillNotDraw(boolean willNotDraw) {
3924 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
3925 }
3926
3927 /**
3928 * Returns whether or not this View draws on its own.
3929 *
3930 * @return true if this view has nothing to draw, false otherwise
3931 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003932 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003933 public boolean willNotDraw() {
3934 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
3935 }
3936
3937 /**
3938 * When a View's drawing cache is enabled, drawing is redirected to an
3939 * offscreen bitmap. Some views, like an ImageView, must be able to
3940 * bypass this mechanism if they already draw a single bitmap, to avoid
3941 * unnecessary usage of the memory.
3942 *
3943 * @param willNotCacheDrawing true if this view does not cache its
3944 * drawing, false otherwise
3945 */
3946 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
3947 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
3948 }
3949
3950 /**
3951 * Returns whether or not this View can cache its drawing or not.
3952 *
3953 * @return true if this view does not cache its drawing, false otherwise
3954 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003955 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003956 public boolean willNotCacheDrawing() {
3957 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
3958 }
3959
3960 /**
3961 * Indicates whether this view reacts to click events or not.
3962 *
3963 * @return true if the view is clickable, false otherwise
3964 *
3965 * @see #setClickable(boolean)
3966 * @attr ref android.R.styleable#View_clickable
3967 */
3968 @ViewDebug.ExportedProperty
3969 public boolean isClickable() {
3970 return (mViewFlags & CLICKABLE) == CLICKABLE;
3971 }
3972
3973 /**
3974 * Enables or disables click events for this view. When a view
3975 * is clickable it will change its state to "pressed" on every click.
3976 * Subclasses should set the view clickable to visually react to
3977 * user's clicks.
3978 *
3979 * @param clickable true to make the view clickable, false otherwise
3980 *
3981 * @see #isClickable()
3982 * @attr ref android.R.styleable#View_clickable
3983 */
3984 public void setClickable(boolean clickable) {
3985 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
3986 }
3987
3988 /**
3989 * Indicates whether this view reacts to long click events or not.
3990 *
3991 * @return true if the view is long clickable, false otherwise
3992 *
3993 * @see #setLongClickable(boolean)
3994 * @attr ref android.R.styleable#View_longClickable
3995 */
3996 public boolean isLongClickable() {
3997 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
3998 }
3999
4000 /**
4001 * Enables or disables long click events for this view. When a view is long
4002 * clickable it reacts to the user holding down the button for a longer
4003 * duration than a tap. This event can either launch the listener or a
4004 * context menu.
4005 *
4006 * @param longClickable true to make the view long clickable, false otherwise
4007 * @see #isLongClickable()
4008 * @attr ref android.R.styleable#View_longClickable
4009 */
4010 public void setLongClickable(boolean longClickable) {
4011 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
4012 }
4013
4014 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07004015 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004016 *
4017 * @see #isClickable()
4018 * @see #setClickable(boolean)
4019 *
4020 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
4021 * the View's internal state from a previously set "pressed" state.
4022 */
4023 public void setPressed(boolean pressed) {
4024 if (pressed) {
4025 mPrivateFlags |= PRESSED;
4026 } else {
4027 mPrivateFlags &= ~PRESSED;
4028 }
4029 refreshDrawableState();
4030 dispatchSetPressed(pressed);
4031 }
4032
4033 /**
4034 * Dispatch setPressed to all of this View's children.
4035 *
4036 * @see #setPressed(boolean)
4037 *
4038 * @param pressed The new pressed state
4039 */
4040 protected void dispatchSetPressed(boolean pressed) {
4041 }
4042
4043 /**
4044 * Indicates whether the view is currently in pressed state. Unless
4045 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
4046 * the pressed state.
4047 *
4048 * @see #setPressed
4049 * @see #isClickable()
4050 * @see #setClickable(boolean)
4051 *
4052 * @return true if the view is currently pressed, false otherwise
4053 */
4054 public boolean isPressed() {
4055 return (mPrivateFlags & PRESSED) == PRESSED;
4056 }
4057
4058 /**
4059 * Indicates whether this view will save its state (that is,
4060 * whether its {@link #onSaveInstanceState} method will be called).
4061 *
4062 * @return Returns true if the view state saving is enabled, else false.
4063 *
4064 * @see #setSaveEnabled(boolean)
4065 * @attr ref android.R.styleable#View_saveEnabled
4066 */
4067 public boolean isSaveEnabled() {
4068 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
4069 }
4070
4071 /**
4072 * Controls whether the saving of this view's state is
4073 * enabled (that is, whether its {@link #onSaveInstanceState} method
4074 * will be called). Note that even if freezing is enabled, the
4075 * view still must have an id assigned to it (via {@link #setId setId()})
4076 * for its state to be saved. This flag can only disable the
4077 * saving of this view; any child views may still have their state saved.
4078 *
4079 * @param enabled Set to false to <em>disable</em> state saving, or true
4080 * (the default) to allow it.
4081 *
4082 * @see #isSaveEnabled()
4083 * @see #setId(int)
4084 * @see #onSaveInstanceState()
4085 * @attr ref android.R.styleable#View_saveEnabled
4086 */
4087 public void setSaveEnabled(boolean enabled) {
4088 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
4089 }
4090
Jeff Brown85a31762010-09-01 17:01:00 -07004091 /**
4092 * Gets whether the framework should discard touches when the view's
4093 * window is obscured by another visible window.
4094 * Refer to the {@link View} security documentation for more details.
4095 *
4096 * @return True if touch filtering is enabled.
4097 *
4098 * @see #setFilterTouchesWhenObscured(boolean)
4099 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
4100 */
4101 @ViewDebug.ExportedProperty
4102 public boolean getFilterTouchesWhenObscured() {
4103 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
4104 }
4105
4106 /**
4107 * Sets whether the framework should discard touches when the view's
4108 * window is obscured by another visible window.
4109 * Refer to the {@link View} security documentation for more details.
4110 *
4111 * @param enabled True if touch filtering should be enabled.
4112 *
4113 * @see #getFilterTouchesWhenObscured
4114 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
4115 */
4116 public void setFilterTouchesWhenObscured(boolean enabled) {
4117 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
4118 FILTER_TOUCHES_WHEN_OBSCURED);
4119 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004120
4121 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004122 * Indicates whether the entire hierarchy under this view will save its
4123 * state when a state saving traversal occurs from its parent. The default
4124 * is true; if false, these views will not be saved unless
4125 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4126 *
4127 * @return Returns true if the view state saving from parent is enabled, else false.
4128 *
4129 * @see #setSaveFromParentEnabled(boolean)
4130 */
4131 public boolean isSaveFromParentEnabled() {
4132 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
4133 }
4134
4135 /**
4136 * Controls whether the entire hierarchy under this view will save its
4137 * state when a state saving traversal occurs from its parent. The default
4138 * is true; if false, these views will not be saved unless
4139 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4140 *
4141 * @param enabled Set to false to <em>disable</em> state saving, or true
4142 * (the default) to allow it.
4143 *
4144 * @see #isSaveFromParentEnabled()
4145 * @see #setId(int)
4146 * @see #onSaveInstanceState()
4147 */
4148 public void setSaveFromParentEnabled(boolean enabled) {
4149 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
4150 }
4151
4152
4153 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004154 * Returns whether this View is able to take focus.
4155 *
4156 * @return True if this view can take focus, or false otherwise.
4157 * @attr ref android.R.styleable#View_focusable
4158 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004159 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004160 public final boolean isFocusable() {
4161 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
4162 }
4163
4164 /**
4165 * When a view is focusable, it may not want to take focus when in touch mode.
4166 * For example, a button would like focus when the user is navigating via a D-pad
4167 * so that the user can click on it, but once the user starts touching the screen,
4168 * the button shouldn't take focus
4169 * @return Whether the view is focusable in touch mode.
4170 * @attr ref android.R.styleable#View_focusableInTouchMode
4171 */
4172 @ViewDebug.ExportedProperty
4173 public final boolean isFocusableInTouchMode() {
4174 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
4175 }
4176
4177 /**
4178 * Find the nearest view in the specified direction that can take focus.
4179 * This does not actually give focus to that view.
4180 *
4181 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4182 *
4183 * @return The nearest focusable in the specified direction, or null if none
4184 * can be found.
4185 */
4186 public View focusSearch(int direction) {
4187 if (mParent != null) {
4188 return mParent.focusSearch(this, direction);
4189 } else {
4190 return null;
4191 }
4192 }
4193
4194 /**
4195 * This method is the last chance for the focused view and its ancestors to
4196 * respond to an arrow key. This is called when the focused view did not
4197 * consume the key internally, nor could the view system find a new view in
4198 * the requested direction to give focus to.
4199 *
4200 * @param focused The currently focused view.
4201 * @param direction The direction focus wants to move. One of FOCUS_UP,
4202 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
4203 * @return True if the this view consumed this unhandled move.
4204 */
4205 public boolean dispatchUnhandledMove(View focused, int direction) {
4206 return false;
4207 }
4208
4209 /**
4210 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08004211 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004212 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08004213 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
4214 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004215 * @return The user specified next view, or null if there is none.
4216 */
4217 View findUserSetNextFocus(View root, int direction) {
4218 switch (direction) {
4219 case FOCUS_LEFT:
4220 if (mNextFocusLeftId == View.NO_ID) return null;
4221 return findViewShouldExist(root, mNextFocusLeftId);
4222 case FOCUS_RIGHT:
4223 if (mNextFocusRightId == View.NO_ID) return null;
4224 return findViewShouldExist(root, mNextFocusRightId);
4225 case FOCUS_UP:
4226 if (mNextFocusUpId == View.NO_ID) return null;
4227 return findViewShouldExist(root, mNextFocusUpId);
4228 case FOCUS_DOWN:
4229 if (mNextFocusDownId == View.NO_ID) return null;
4230 return findViewShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08004231 case FOCUS_FORWARD:
4232 if (mNextFocusForwardId == View.NO_ID) return null;
4233 return findViewShouldExist(root, mNextFocusForwardId);
4234 case FOCUS_BACKWARD: {
4235 final int id = mID;
4236 return root.findViewByPredicate(new Predicate<View>() {
4237 @Override
4238 public boolean apply(View t) {
4239 return t.mNextFocusForwardId == id;
4240 }
4241 });
4242 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004243 }
4244 return null;
4245 }
4246
4247 private static View findViewShouldExist(View root, int childViewId) {
4248 View result = root.findViewById(childViewId);
4249 if (result == null) {
4250 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
4251 + "by user for id " + childViewId);
4252 }
4253 return result;
4254 }
4255
4256 /**
4257 * Find and return all focusable views that are descendants of this view,
4258 * possibly including this view if it is focusable itself.
4259 *
4260 * @param direction The direction of the focus
4261 * @return A list of focusable views
4262 */
4263 public ArrayList<View> getFocusables(int direction) {
4264 ArrayList<View> result = new ArrayList<View>(24);
4265 addFocusables(result, direction);
4266 return result;
4267 }
4268
4269 /**
4270 * Add any focusable views that are descendants of this view (possibly
4271 * including this view if it is focusable itself) to views. If we are in touch mode,
4272 * only add views that are also focusable in touch mode.
4273 *
4274 * @param views Focusable views found so far
4275 * @param direction The direction of the focus
4276 */
4277 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004278 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
4279 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004280
svetoslavganov75986cf2009-05-14 22:28:01 -07004281 /**
4282 * Adds any focusable views that are descendants of this view (possibly
4283 * including this view if it is focusable itself) to views. This method
4284 * adds all focusable views regardless if we are in touch mode or
4285 * only views focusable in touch mode if we are in touch mode depending on
4286 * the focusable mode paramater.
4287 *
4288 * @param views Focusable views found so far or null if all we are interested is
4289 * the number of focusables.
4290 * @param direction The direction of the focus.
4291 * @param focusableMode The type of focusables to be added.
4292 *
4293 * @see #FOCUSABLES_ALL
4294 * @see #FOCUSABLES_TOUCH_MODE
4295 */
4296 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
4297 if (!isFocusable()) {
4298 return;
4299 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004300
svetoslavganov75986cf2009-05-14 22:28:01 -07004301 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE &&
4302 isInTouchMode() && !isFocusableInTouchMode()) {
4303 return;
4304 }
4305
4306 if (views != null) {
4307 views.add(this);
4308 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004309 }
4310
4311 /**
4312 * Find and return all touchable views that are descendants of this view,
4313 * possibly including this view if it is touchable itself.
4314 *
4315 * @return A list of touchable views
4316 */
4317 public ArrayList<View> getTouchables() {
4318 ArrayList<View> result = new ArrayList<View>();
4319 addTouchables(result);
4320 return result;
4321 }
4322
4323 /**
4324 * Add any touchable views that are descendants of this view (possibly
4325 * including this view if it is touchable itself) to views.
4326 *
4327 * @param views Touchable views found so far
4328 */
4329 public void addTouchables(ArrayList<View> views) {
4330 final int viewFlags = mViewFlags;
4331
4332 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
4333 && (viewFlags & ENABLED_MASK) == ENABLED) {
4334 views.add(this);
4335 }
4336 }
4337
4338 /**
4339 * Call this to try to give focus to a specific view or to one of its
4340 * descendants.
4341 *
4342 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4343 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4344 * while the device is in touch mode.
4345 *
4346 * See also {@link #focusSearch}, which is what you call to say that you
4347 * have focus, and you want your parent to look for the next one.
4348 *
4349 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
4350 * {@link #FOCUS_DOWN} and <code>null</code>.
4351 *
4352 * @return Whether this view or one of its descendants actually took focus.
4353 */
4354 public final boolean requestFocus() {
4355 return requestFocus(View.FOCUS_DOWN);
4356 }
4357
4358
4359 /**
4360 * Call this to try to give focus to a specific view or to one of its
4361 * descendants and give it a hint about what direction focus is heading.
4362 *
4363 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4364 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4365 * while the device is in touch mode.
4366 *
4367 * See also {@link #focusSearch}, which is what you call to say that you
4368 * have focus, and you want your parent to look for the next one.
4369 *
4370 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
4371 * <code>null</code> set for the previously focused rectangle.
4372 *
4373 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4374 * @return Whether this view or one of its descendants actually took focus.
4375 */
4376 public final boolean requestFocus(int direction) {
4377 return requestFocus(direction, null);
4378 }
4379
4380 /**
4381 * Call this to try to give focus to a specific view or to one of its descendants
4382 * and give it hints about the direction and a specific rectangle that the focus
4383 * is coming from. The rectangle can help give larger views a finer grained hint
4384 * about where focus is coming from, and therefore, where to show selection, or
4385 * forward focus change internally.
4386 *
4387 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4388 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4389 * while the device is in touch mode.
4390 *
4391 * A View will not take focus if it is not visible.
4392 *
4393 * A View will not take focus if one of its parents has {@link android.view.ViewGroup#getDescendantFocusability()}
4394 * equal to {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
4395 *
4396 * See also {@link #focusSearch}, which is what you call to say that you
4397 * have focus, and you want your parent to look for the next one.
4398 *
4399 * You may wish to override this method if your custom {@link View} has an internal
4400 * {@link View} that it wishes to forward the request to.
4401 *
4402 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4403 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
4404 * to give a finer grained hint about where focus is coming from. May be null
4405 * if there is no hint.
4406 * @return Whether this view or one of its descendants actually took focus.
4407 */
4408 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
4409 // need to be focusable
4410 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
4411 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
4412 return false;
4413 }
4414
4415 // need to be focusable in touch mode if in touch mode
4416 if (isInTouchMode() &&
4417 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
4418 return false;
4419 }
4420
4421 // need to not have any parents blocking us
4422 if (hasAncestorThatBlocksDescendantFocus()) {
4423 return false;
4424 }
4425
4426 handleFocusGainInternal(direction, previouslyFocusedRect);
4427 return true;
4428 }
4429
Christopher Tate2c095f32010-10-04 14:13:40 -07004430 /** Gets the ViewRoot, or null if not attached. */
4431 /*package*/ ViewRoot getViewRoot() {
4432 View root = getRootView();
4433 return root != null ? (ViewRoot)root.getParent() : null;
4434 }
4435
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004436 /**
4437 * Call this to try to give focus to a specific view or to one of its descendants. This is a
4438 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
4439 * touch mode to request focus when they are touched.
4440 *
4441 * @return Whether this view or one of its descendants actually took focus.
4442 *
4443 * @see #isInTouchMode()
4444 *
4445 */
4446 public final boolean requestFocusFromTouch() {
4447 // Leave touch mode if we need to
4448 if (isInTouchMode()) {
Christopher Tate2c095f32010-10-04 14:13:40 -07004449 ViewRoot viewRoot = getViewRoot();
4450 if (viewRoot != null) {
4451 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004452 }
4453 }
4454 return requestFocus(View.FOCUS_DOWN);
4455 }
4456
4457 /**
4458 * @return Whether any ancestor of this view blocks descendant focus.
4459 */
4460 private boolean hasAncestorThatBlocksDescendantFocus() {
4461 ViewParent ancestor = mParent;
4462 while (ancestor instanceof ViewGroup) {
4463 final ViewGroup vgAncestor = (ViewGroup) ancestor;
4464 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
4465 return true;
4466 } else {
4467 ancestor = vgAncestor.getParent();
4468 }
4469 }
4470 return false;
4471 }
4472
4473 /**
Romain Guya440b002010-02-24 15:57:54 -08004474 * @hide
4475 */
4476 public void dispatchStartTemporaryDetach() {
4477 onStartTemporaryDetach();
4478 }
4479
4480 /**
4481 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004482 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
4483 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08004484 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004485 */
4486 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08004487 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08004488 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08004489 }
4490
4491 /**
4492 * @hide
4493 */
4494 public void dispatchFinishTemporaryDetach() {
4495 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004496 }
Romain Guy8506ab42009-06-11 17:35:47 -07004497
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004498 /**
4499 * Called after {@link #onStartTemporaryDetach} when the container is done
4500 * changing the view.
4501 */
4502 public void onFinishTemporaryDetach() {
4503 }
Romain Guy8506ab42009-06-11 17:35:47 -07004504
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004505 /**
4506 * capture information of this view for later analysis: developement only
4507 * check dynamic switch to make sure we only dump view
4508 * when ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW) is set
4509 */
4510 private static void captureViewInfo(String subTag, View v) {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07004511 if (v == null || SystemProperties.getInt(ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW, 0) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004512 return;
4513 }
4514 ViewDebug.dumpCapturedView(subTag, v);
4515 }
4516
4517 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004518 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
4519 * for this view's window. Returns null if the view is not currently attached
4520 * to the window. Normally you will not need to use this directly, but
4521 * just use the standard high-level event callbacks like {@link #onKeyDown}.
4522 */
4523 public KeyEvent.DispatcherState getKeyDispatcherState() {
4524 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
4525 }
4526
4527 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004528 * Dispatch a key event before it is processed by any input method
4529 * associated with the view hierarchy. This can be used to intercept
4530 * key events in special situations before the IME consumes them; a
4531 * typical example would be handling the BACK key to update the application's
4532 * UI instead of allowing the IME to see it and close itself.
4533 *
4534 * @param event The key event to be dispatched.
4535 * @return True if the event was handled, false otherwise.
4536 */
4537 public boolean dispatchKeyEventPreIme(KeyEvent event) {
4538 return onKeyPreIme(event.getKeyCode(), event);
4539 }
4540
4541 /**
4542 * Dispatch a key event to the next view on the focus path. This path runs
4543 * from the top of the view tree down to the currently focused view. If this
4544 * view has focus, it will dispatch to itself. Otherwise it will dispatch
4545 * the next node down the focus path. This method also fires any key
4546 * listeners.
4547 *
4548 * @param event The key event to be dispatched.
4549 * @return True if the event was handled, false otherwise.
4550 */
4551 public boolean dispatchKeyEvent(KeyEvent event) {
4552 // If any attached key listener a first crack at the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004553
Romain Guyf607bdc2010-09-10 19:20:06 -07004554 //noinspection SimplifiableIfStatement,deprecation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004555 if (android.util.Config.LOGV) {
4556 captureViewInfo("captureViewKeyEvent", this);
4557 }
4558
Romain Guyf607bdc2010-09-10 19:20:06 -07004559 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004560 if (mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
4561 && mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
4562 return true;
4563 }
4564
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004565 return event.dispatch(this, mAttachInfo != null
4566 ? mAttachInfo.mKeyDispatchState : null, this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004567 }
4568
4569 /**
4570 * Dispatches a key shortcut event.
4571 *
4572 * @param event The key event to be dispatched.
4573 * @return True if the event was handled by the view, false otherwise.
4574 */
4575 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
4576 return onKeyShortcut(event.getKeyCode(), event);
4577 }
4578
4579 /**
4580 * Pass the touch screen motion event down to the target view, or this
4581 * view if it is the target.
4582 *
4583 * @param event The motion event to be dispatched.
4584 * @return True if the event was handled by the view, false otherwise.
4585 */
4586 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown85a31762010-09-01 17:01:00 -07004587 if (!onFilterTouchEventForSecurity(event)) {
4588 return false;
4589 }
4590
Romain Guyf607bdc2010-09-10 19:20:06 -07004591 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004592 if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED &&
4593 mOnTouchListener.onTouch(this, event)) {
4594 return true;
4595 }
4596 return onTouchEvent(event);
4597 }
4598
4599 /**
Jeff Brown85a31762010-09-01 17:01:00 -07004600 * Filter the touch event to apply security policies.
4601 *
4602 * @param event The motion event to be filtered.
4603 * @return True if the event should be dispatched, false if the event should be dropped.
4604 *
4605 * @see #getFilterTouchesWhenObscured
4606 */
4607 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07004608 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07004609 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
4610 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
4611 // Window is obscured, drop this touch.
4612 return false;
4613 }
4614 return true;
4615 }
4616
4617 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004618 * Pass a trackball motion event down to the focused view.
4619 *
4620 * @param event The motion event to be dispatched.
4621 * @return True if the event was handled by the view, false otherwise.
4622 */
4623 public boolean dispatchTrackballEvent(MotionEvent event) {
4624 //Log.i("view", "view=" + this + ", " + event.toString());
4625 return onTrackballEvent(event);
4626 }
4627
4628 /**
4629 * Called when the window containing this view gains or loses window focus.
4630 * ViewGroups should override to route to their children.
4631 *
4632 * @param hasFocus True if the window containing this view now has focus,
4633 * false otherwise.
4634 */
4635 public void dispatchWindowFocusChanged(boolean hasFocus) {
4636 onWindowFocusChanged(hasFocus);
4637 }
4638
4639 /**
4640 * Called when the window containing this view gains or loses focus. Note
4641 * that this is separate from view focus: to receive key events, both
4642 * your view and its window must have focus. If a window is displayed
4643 * on top of yours that takes input focus, then your own window will lose
4644 * focus but the view focus will remain unchanged.
4645 *
4646 * @param hasWindowFocus True if the window containing this view now has
4647 * focus, false otherwise.
4648 */
4649 public void onWindowFocusChanged(boolean hasWindowFocus) {
4650 InputMethodManager imm = InputMethodManager.peekInstance();
4651 if (!hasWindowFocus) {
4652 if (isPressed()) {
4653 setPressed(false);
4654 }
4655 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4656 imm.focusOut(this);
4657 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05004658 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08004659 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004660 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004661 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4662 imm.focusIn(this);
4663 }
4664 refreshDrawableState();
4665 }
4666
4667 /**
4668 * Returns true if this view is in a window that currently has window focus.
4669 * Note that this is not the same as the view itself having focus.
4670 *
4671 * @return True if this view is in a window that currently has window focus.
4672 */
4673 public boolean hasWindowFocus() {
4674 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
4675 }
4676
4677 /**
Adam Powell326d8082009-12-09 15:10:07 -08004678 * Dispatch a view visibility change down the view hierarchy.
4679 * ViewGroups should override to route to their children.
4680 * @param changedView The view whose visibility changed. Could be 'this' or
4681 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004682 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4683 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004684 */
4685 protected void dispatchVisibilityChanged(View changedView, int visibility) {
4686 onVisibilityChanged(changedView, visibility);
4687 }
4688
4689 /**
4690 * Called when the visibility of the view or an ancestor of the view is changed.
4691 * @param changedView The view whose visibility changed. Could be 'this' or
4692 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004693 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4694 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004695 */
4696 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004697 if (visibility == VISIBLE) {
4698 if (mAttachInfo != null) {
4699 initialAwakenScrollBars();
4700 } else {
4701 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
4702 }
4703 }
Adam Powell326d8082009-12-09 15:10:07 -08004704 }
4705
4706 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08004707 * Dispatch a hint about whether this view is displayed. For instance, when
4708 * a View moves out of the screen, it might receives a display hint indicating
4709 * the view is not displayed. Applications should not <em>rely</em> on this hint
4710 * as there is no guarantee that they will receive one.
4711 *
4712 * @param hint A hint about whether or not this view is displayed:
4713 * {@link #VISIBLE} or {@link #INVISIBLE}.
4714 */
4715 public void dispatchDisplayHint(int hint) {
4716 onDisplayHint(hint);
4717 }
4718
4719 /**
4720 * Gives this view a hint about whether is displayed or not. For instance, when
4721 * a View moves out of the screen, it might receives a display hint indicating
4722 * the view is not displayed. Applications should not <em>rely</em> on this hint
4723 * as there is no guarantee that they will receive one.
4724 *
4725 * @param hint A hint about whether or not this view is displayed:
4726 * {@link #VISIBLE} or {@link #INVISIBLE}.
4727 */
4728 protected void onDisplayHint(int hint) {
4729 }
4730
4731 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004732 * Dispatch a window visibility change down the view hierarchy.
4733 * ViewGroups should override to route to their children.
4734 *
4735 * @param visibility The new visibility of the window.
4736 *
4737 * @see #onWindowVisibilityChanged
4738 */
4739 public void dispatchWindowVisibilityChanged(int visibility) {
4740 onWindowVisibilityChanged(visibility);
4741 }
4742
4743 /**
4744 * Called when the window containing has change its visibility
4745 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
4746 * that this tells you whether or not your window is being made visible
4747 * to the window manager; this does <em>not</em> tell you whether or not
4748 * your window is obscured by other windows on the screen, even if it
4749 * is itself visible.
4750 *
4751 * @param visibility The new visibility of the window.
4752 */
4753 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004754 if (visibility == VISIBLE) {
4755 initialAwakenScrollBars();
4756 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004757 }
4758
4759 /**
4760 * Returns the current visibility of the window this view is attached to
4761 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
4762 *
4763 * @return Returns the current visibility of the view's window.
4764 */
4765 public int getWindowVisibility() {
4766 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
4767 }
4768
4769 /**
4770 * Retrieve the overall visible display size in which the window this view is
4771 * attached to has been positioned in. This takes into account screen
4772 * decorations above the window, for both cases where the window itself
4773 * is being position inside of them or the window is being placed under
4774 * then and covered insets are used for the window to position its content
4775 * inside. In effect, this tells you the available area where content can
4776 * be placed and remain visible to users.
4777 *
4778 * <p>This function requires an IPC back to the window manager to retrieve
4779 * the requested information, so should not be used in performance critical
4780 * code like drawing.
4781 *
4782 * @param outRect Filled in with the visible display frame. If the view
4783 * is not attached to a window, this is simply the raw display size.
4784 */
4785 public void getWindowVisibleDisplayFrame(Rect outRect) {
4786 if (mAttachInfo != null) {
4787 try {
4788 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
4789 } catch (RemoteException e) {
4790 return;
4791 }
4792 // XXX This is really broken, and probably all needs to be done
4793 // in the window manager, and we need to know more about whether
4794 // we want the area behind or in front of the IME.
4795 final Rect insets = mAttachInfo.mVisibleInsets;
4796 outRect.left += insets.left;
4797 outRect.top += insets.top;
4798 outRect.right -= insets.right;
4799 outRect.bottom -= insets.bottom;
4800 return;
4801 }
4802 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
4803 outRect.set(0, 0, d.getWidth(), d.getHeight());
4804 }
4805
4806 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08004807 * Dispatch a notification about a resource configuration change down
4808 * the view hierarchy.
4809 * ViewGroups should override to route to their children.
4810 *
4811 * @param newConfig The new resource configuration.
4812 *
4813 * @see #onConfigurationChanged
4814 */
4815 public void dispatchConfigurationChanged(Configuration newConfig) {
4816 onConfigurationChanged(newConfig);
4817 }
4818
4819 /**
4820 * Called when the current configuration of the resources being used
4821 * by the application have changed. You can use this to decide when
4822 * to reload resources that can changed based on orientation and other
4823 * configuration characterstics. You only need to use this if you are
4824 * not relying on the normal {@link android.app.Activity} mechanism of
4825 * recreating the activity instance upon a configuration change.
4826 *
4827 * @param newConfig The new resource configuration.
4828 */
4829 protected void onConfigurationChanged(Configuration newConfig) {
4830 }
4831
4832 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004833 * Private function to aggregate all per-view attributes in to the view
4834 * root.
4835 */
4836 void dispatchCollectViewAttributes(int visibility) {
4837 performCollectViewAttributes(visibility);
4838 }
4839
4840 void performCollectViewAttributes(int visibility) {
Romain Guyd30b36d2011-01-26 10:54:43 -08004841 if ((visibility & VISIBILITY_MASK) == VISIBLE && mAttachInfo != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08004842 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) {
4843 mAttachInfo.mKeepScreenOn = true;
4844 }
4845 mAttachInfo.mSystemUiVisibility |= mSystemUiVisibility;
4846 if (mOnSystemUiVisibilityChangeListener != null) {
4847 mAttachInfo.mHasSystemUiListeners = true;
4848 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004849 }
4850 }
4851
4852 void needGlobalAttributesUpdate(boolean force) {
Joe Onorato664644d2011-01-23 17:53:23 -08004853 final AttachInfo ai = mAttachInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004854 if (ai != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08004855 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0)
4856 || ai.mHasSystemUiListeners) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004857 ai.mRecomputeGlobalAttributes = true;
4858 }
4859 }
4860 }
4861
4862 /**
4863 * Returns whether the device is currently in touch mode. Touch mode is entered
4864 * once the user begins interacting with the device by touch, and affects various
4865 * things like whether focus is always visible to the user.
4866 *
4867 * @return Whether the device is in touch mode.
4868 */
4869 @ViewDebug.ExportedProperty
4870 public boolean isInTouchMode() {
4871 if (mAttachInfo != null) {
4872 return mAttachInfo.mInTouchMode;
4873 } else {
4874 return ViewRoot.isInTouchMode();
4875 }
4876 }
4877
4878 /**
4879 * Returns the context the view is running in, through which it can
4880 * access the current theme, resources, etc.
4881 *
4882 * @return The view's Context.
4883 */
4884 @ViewDebug.CapturedViewProperty
4885 public final Context getContext() {
4886 return mContext;
4887 }
4888
4889 /**
4890 * Handle a key event before it is processed by any input method
4891 * associated with the view hierarchy. This can be used to intercept
4892 * key events in special situations before the IME consumes them; a
4893 * typical example would be handling the BACK key to update the application's
4894 * UI instead of allowing the IME to see it and close itself.
4895 *
4896 * @param keyCode The value in event.getKeyCode().
4897 * @param event Description of the key event.
4898 * @return If you handled the event, return true. If you want to allow the
4899 * event to be handled by the next receiver, return false.
4900 */
4901 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
4902 return false;
4903 }
4904
4905 /**
Jeff Brown995e7742010-12-22 16:59:36 -08004906 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
4907 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004908 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
4909 * is released, if the view is enabled and clickable.
4910 *
4911 * @param keyCode A key code that represents the button pressed, from
4912 * {@link android.view.KeyEvent}.
4913 * @param event The KeyEvent object that defines the button action.
4914 */
4915 public boolean onKeyDown(int keyCode, KeyEvent event) {
4916 boolean result = false;
4917
4918 switch (keyCode) {
4919 case KeyEvent.KEYCODE_DPAD_CENTER:
4920 case KeyEvent.KEYCODE_ENTER: {
4921 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4922 return true;
4923 }
4924 // Long clickable items don't necessarily have to be clickable
4925 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
4926 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
4927 (event.getRepeatCount() == 0)) {
4928 setPressed(true);
4929 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
Adam Powelle14579b2009-12-16 18:39:52 -08004930 postCheckForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004931 }
4932 return true;
4933 }
4934 break;
4935 }
4936 }
4937 return result;
4938 }
4939
4940 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004941 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
4942 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
4943 * the event).
4944 */
4945 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
4946 return false;
4947 }
4948
4949 /**
Jeff Brown995e7742010-12-22 16:59:36 -08004950 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
4951 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004952 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
4953 * {@link KeyEvent#KEYCODE_ENTER} is released.
4954 *
4955 * @param keyCode A key code that represents the button pressed, from
4956 * {@link android.view.KeyEvent}.
4957 * @param event The KeyEvent object that defines the button action.
4958 */
4959 public boolean onKeyUp(int keyCode, KeyEvent event) {
4960 boolean result = false;
4961
4962 switch (keyCode) {
4963 case KeyEvent.KEYCODE_DPAD_CENTER:
4964 case KeyEvent.KEYCODE_ENTER: {
4965 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4966 return true;
4967 }
4968 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
4969 setPressed(false);
4970
4971 if (!mHasPerformedLongPress) {
4972 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05004973 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004974
4975 result = performClick();
4976 }
4977 }
4978 break;
4979 }
4980 }
4981 return result;
4982 }
4983
4984 /**
4985 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
4986 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
4987 * the event).
4988 *
4989 * @param keyCode A key code that represents the button pressed, from
4990 * {@link android.view.KeyEvent}.
4991 * @param repeatCount The number of times the action was made.
4992 * @param event The KeyEvent object that defines the button action.
4993 */
4994 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
4995 return false;
4996 }
4997
4998 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08004999 * Called on the focused view when a key shortcut event is not handled.
5000 * Override this method to implement local key shortcuts for the View.
5001 * Key shortcuts can also be implemented by setting the
5002 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005003 *
5004 * @param keyCode The value in event.getKeyCode().
5005 * @param event Description of the key event.
5006 * @return If you handled the event, return true. If you want to allow the
5007 * event to be handled by the next receiver, return false.
5008 */
5009 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
5010 return false;
5011 }
5012
5013 /**
5014 * Check whether the called view is a text editor, in which case it
5015 * would make sense to automatically display a soft input window for
5016 * it. Subclasses should override this if they implement
5017 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005018 * a call on that method would return a non-null InputConnection, and
5019 * they are really a first-class editor that the user would normally
5020 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07005021 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005022 * <p>The default implementation always returns false. This does
5023 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
5024 * will not be called or the user can not otherwise perform edits on your
5025 * view; it is just a hint to the system that this is not the primary
5026 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07005027 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005028 * @return Returns true if this view is a text editor, else false.
5029 */
5030 public boolean onCheckIsTextEditor() {
5031 return false;
5032 }
Romain Guy8506ab42009-06-11 17:35:47 -07005033
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005034 /**
5035 * Create a new InputConnection for an InputMethod to interact
5036 * with the view. The default implementation returns null, since it doesn't
5037 * support input methods. You can override this to implement such support.
5038 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07005039 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005040 * <p>When implementing this, you probably also want to implement
5041 * {@link #onCheckIsTextEditor()} to indicate you will return a
5042 * non-null InputConnection.
5043 *
5044 * @param outAttrs Fill in with attribute information about the connection.
5045 */
5046 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
5047 return null;
5048 }
5049
5050 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005051 * Called by the {@link android.view.inputmethod.InputMethodManager}
5052 * when a view who is not the current
5053 * input connection target is trying to make a call on the manager. The
5054 * default implementation returns false; you can override this to return
5055 * true for certain views if you are performing InputConnection proxying
5056 * to them.
5057 * @param view The View that is making the InputMethodManager call.
5058 * @return Return true to allow the call, false to reject.
5059 */
5060 public boolean checkInputConnectionProxy(View view) {
5061 return false;
5062 }
Romain Guy8506ab42009-06-11 17:35:47 -07005063
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005064 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005065 * Show the context menu for this view. It is not safe to hold on to the
5066 * menu after returning from this method.
5067 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07005068 * You should normally not overload this method. Overload
5069 * {@link #onCreateContextMenu(ContextMenu)} or define an
5070 * {@link OnCreateContextMenuListener} to add items to the context menu.
5071 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005072 * @param menu The context menu to populate
5073 */
5074 public void createContextMenu(ContextMenu menu) {
5075 ContextMenuInfo menuInfo = getContextMenuInfo();
5076
5077 // Sets the current menu info so all items added to menu will have
5078 // my extra info set.
5079 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
5080
5081 onCreateContextMenu(menu);
5082 if (mOnCreateContextMenuListener != null) {
5083 mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
5084 }
5085
5086 // Clear the extra information so subsequent items that aren't mine don't
5087 // have my extra info.
5088 ((MenuBuilder)menu).setCurrentMenuInfo(null);
5089
5090 if (mParent != null) {
5091 mParent.createContextMenu(menu);
5092 }
5093 }
5094
5095 /**
5096 * Views should implement this if they have extra information to associate
5097 * with the context menu. The return result is supplied as a parameter to
5098 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
5099 * callback.
5100 *
5101 * @return Extra information about the item for which the context menu
5102 * should be shown. This information will vary across different
5103 * subclasses of View.
5104 */
5105 protected ContextMenuInfo getContextMenuInfo() {
5106 return null;
5107 }
5108
5109 /**
5110 * Views should implement this if the view itself is going to add items to
5111 * the context menu.
5112 *
5113 * @param menu the context menu to populate
5114 */
5115 protected void onCreateContextMenu(ContextMenu menu) {
5116 }
5117
5118 /**
5119 * Implement this method to handle trackball motion events. The
5120 * <em>relative</em> movement of the trackball since the last event
5121 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
5122 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
5123 * that a movement of 1 corresponds to the user pressing one DPAD key (so
5124 * they will often be fractional values, representing the more fine-grained
5125 * movement information available from a trackball).
5126 *
5127 * @param event The motion event.
5128 * @return True if the event was handled, false otherwise.
5129 */
5130 public boolean onTrackballEvent(MotionEvent event) {
5131 return false;
5132 }
5133
5134 /**
5135 * Implement this method to handle touch screen motion events.
5136 *
5137 * @param event The motion event.
5138 * @return True if the event was handled, false otherwise.
5139 */
5140 public boolean onTouchEvent(MotionEvent event) {
5141 final int viewFlags = mViewFlags;
5142
5143 if ((viewFlags & ENABLED_MASK) == DISABLED) {
5144 // A disabled view that is clickable still consumes the touch
5145 // events, it just doesn't respond to them.
5146 return (((viewFlags & CLICKABLE) == CLICKABLE ||
5147 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
5148 }
5149
5150 if (mTouchDelegate != null) {
5151 if (mTouchDelegate.onTouchEvent(event)) {
5152 return true;
5153 }
5154 }
5155
5156 if (((viewFlags & CLICKABLE) == CLICKABLE ||
5157 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
5158 switch (event.getAction()) {
5159 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08005160 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
5161 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005162 // take focus if we don't have it already and we should in
5163 // touch mode.
5164 boolean focusTaken = false;
5165 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
5166 focusTaken = requestFocus();
5167 }
5168
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08005169 if (prepressed) {
5170 // The button is being released before we actually
5171 // showed it as pressed. Make it show the pressed
5172 // state now (before scheduling the click) to ensure
5173 // the user sees it.
5174 mPrivateFlags |= PRESSED;
5175 refreshDrawableState();
5176 }
5177
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005178 if (!mHasPerformedLongPress) {
5179 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05005180 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005181
5182 // Only perform take click actions if we were in the pressed state
5183 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08005184 // Use a Runnable and post this rather than calling
5185 // performClick directly. This lets other visual state
5186 // of the view update before click actions start.
5187 if (mPerformClick == null) {
5188 mPerformClick = new PerformClick();
5189 }
5190 if (!post(mPerformClick)) {
5191 performClick();
5192 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005193 }
5194 }
5195
5196 if (mUnsetPressedState == null) {
5197 mUnsetPressedState = new UnsetPressedState();
5198 }
5199
Adam Powelle14579b2009-12-16 18:39:52 -08005200 if (prepressed) {
Adam Powelle14579b2009-12-16 18:39:52 -08005201 postDelayed(mUnsetPressedState,
5202 ViewConfiguration.getPressedStateDuration());
5203 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005204 // If the post failed, unpress right now
5205 mUnsetPressedState.run();
5206 }
Adam Powelle14579b2009-12-16 18:39:52 -08005207 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005208 }
5209 break;
5210
5211 case MotionEvent.ACTION_DOWN:
Adam Powelle14579b2009-12-16 18:39:52 -08005212 if (mPendingCheckForTap == null) {
5213 mPendingCheckForTap = new CheckForTap();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005214 }
Adam Powelle14579b2009-12-16 18:39:52 -08005215 mPrivateFlags |= PREPRESSED;
Adam Powell3b023392010-03-11 16:30:28 -08005216 mHasPerformedLongPress = false;
Adam Powelle14579b2009-12-16 18:39:52 -08005217 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005218 break;
5219
5220 case MotionEvent.ACTION_CANCEL:
5221 mPrivateFlags &= ~PRESSED;
5222 refreshDrawableState();
Adam Powelle14579b2009-12-16 18:39:52 -08005223 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005224 break;
5225
5226 case MotionEvent.ACTION_MOVE:
5227 final int x = (int) event.getX();
5228 final int y = (int) event.getY();
5229
5230 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07005231 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005232 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08005233 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005234 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08005235 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05005236 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005237
5238 // Need to switch from pressed to not pressed
5239 mPrivateFlags &= ~PRESSED;
5240 refreshDrawableState();
5241 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005242 }
5243 break;
5244 }
5245 return true;
5246 }
5247
5248 return false;
5249 }
5250
5251 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05005252 * Remove the longpress detection timer.
5253 */
5254 private void removeLongPressCallback() {
5255 if (mPendingCheckForLongPress != null) {
5256 removeCallbacks(mPendingCheckForLongPress);
5257 }
5258 }
Adam Powell3cb8b632011-01-21 15:34:14 -08005259
5260 /**
5261 * Remove the pending click action
5262 */
5263 private void removePerformClickCallback() {
5264 if (mPerformClick != null) {
5265 removeCallbacks(mPerformClick);
5266 }
5267 }
5268
Adam Powelle14579b2009-12-16 18:39:52 -08005269 /**
Romain Guya440b002010-02-24 15:57:54 -08005270 * Remove the prepress detection timer.
5271 */
5272 private void removeUnsetPressCallback() {
5273 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
5274 setPressed(false);
5275 removeCallbacks(mUnsetPressedState);
5276 }
5277 }
5278
5279 /**
Adam Powelle14579b2009-12-16 18:39:52 -08005280 * Remove the tap detection timer.
5281 */
5282 private void removeTapCallback() {
5283 if (mPendingCheckForTap != null) {
5284 mPrivateFlags &= ~PREPRESSED;
5285 removeCallbacks(mPendingCheckForTap);
5286 }
5287 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05005288
5289 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005290 * Cancels a pending long press. Your subclass can use this if you
5291 * want the context menu to come up if the user presses and holds
5292 * at the same place, but you don't want it to come up if they press
5293 * and then move around enough to cause scrolling.
5294 */
5295 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05005296 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08005297
5298 /*
5299 * The prepressed state handled by the tap callback is a display
5300 * construct, but the tap callback will post a long press callback
5301 * less its own timeout. Remove it here.
5302 */
5303 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005304 }
5305
5306 /**
5307 * Sets the TouchDelegate for this View.
5308 */
5309 public void setTouchDelegate(TouchDelegate delegate) {
5310 mTouchDelegate = delegate;
5311 }
5312
5313 /**
5314 * Gets the TouchDelegate for this View.
5315 */
5316 public TouchDelegate getTouchDelegate() {
5317 return mTouchDelegate;
5318 }
5319
5320 /**
5321 * Set flags controlling behavior of this view.
5322 *
5323 * @param flags Constant indicating the value which should be set
5324 * @param mask Constant indicating the bit range that should be changed
5325 */
5326 void setFlags(int flags, int mask) {
5327 int old = mViewFlags;
5328 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
5329
5330 int changed = mViewFlags ^ old;
5331 if (changed == 0) {
5332 return;
5333 }
5334 int privateFlags = mPrivateFlags;
5335
5336 /* Check if the FOCUSABLE bit has changed */
5337 if (((changed & FOCUSABLE_MASK) != 0) &&
5338 ((privateFlags & HAS_BOUNDS) !=0)) {
5339 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
5340 && ((privateFlags & FOCUSED) != 0)) {
5341 /* Give up focus if we are no longer focusable */
5342 clearFocus();
5343 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
5344 && ((privateFlags & FOCUSED) == 0)) {
5345 /*
5346 * Tell the view system that we are now available to take focus
5347 * if no one else already has it.
5348 */
5349 if (mParent != null) mParent.focusableViewAvailable(this);
5350 }
5351 }
5352
5353 if ((flags & VISIBILITY_MASK) == VISIBLE) {
5354 if ((changed & VISIBILITY_MASK) != 0) {
5355 /*
5356 * If this view is becoming visible, set the DRAWN flag so that
5357 * the next invalidate() will not be skipped.
5358 */
5359 mPrivateFlags |= DRAWN;
5360
5361 needGlobalAttributesUpdate(true);
5362
5363 // a view becoming visible is worth notifying the parent
5364 // about in case nothing has focus. even if this specific view
5365 // isn't focusable, it may contain something that is, so let
5366 // the root view try to give this focus if nothing else does.
5367 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
5368 mParent.focusableViewAvailable(this);
5369 }
5370 }
5371 }
5372
5373 /* Check if the GONE bit has changed */
5374 if ((changed & GONE) != 0) {
5375 needGlobalAttributesUpdate(false);
5376 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08005377 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005378
Romain Guyecd80ee2009-12-03 17:13:02 -08005379 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
5380 if (hasFocus()) clearFocus();
5381 destroyDrawingCache();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005382 }
5383 if (mAttachInfo != null) {
5384 mAttachInfo.mViewVisibilityChanged = true;
5385 }
5386 }
5387
5388 /* Check if the VISIBLE bit has changed */
5389 if ((changed & INVISIBLE) != 0) {
5390 needGlobalAttributesUpdate(false);
Romain Guy0fd89bf2011-01-26 15:41:30 -08005391 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005392
5393 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
5394 // root view becoming invisible shouldn't clear focus
5395 if (getRootView() != this) {
5396 clearFocus();
5397 }
5398 }
5399 if (mAttachInfo != null) {
5400 mAttachInfo.mViewVisibilityChanged = true;
5401 }
5402 }
5403
Adam Powell326d8082009-12-09 15:10:07 -08005404 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07005405 if (mParent instanceof ViewGroup) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005406 ((ViewGroup) mParent).onChildVisibilityChanged(this, (flags & VISIBILITY_MASK));
5407 ((View) mParent).invalidate(true);
Chet Haase5e25c2c2010-09-16 11:15:56 -07005408 }
Adam Powell326d8082009-12-09 15:10:07 -08005409 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
5410 }
5411
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005412 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
5413 destroyDrawingCache();
5414 }
5415
5416 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
5417 destroyDrawingCache();
5418 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Romain Guy0fd89bf2011-01-26 15:41:30 -08005419 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005420 }
5421
5422 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
5423 destroyDrawingCache();
5424 mPrivateFlags &= ~DRAWING_CACHE_VALID;
5425 }
5426
5427 if ((changed & DRAW_MASK) != 0) {
5428 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
5429 if (mBGDrawable != null) {
5430 mPrivateFlags &= ~SKIP_DRAW;
5431 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
5432 } else {
5433 mPrivateFlags |= SKIP_DRAW;
5434 }
5435 } else {
5436 mPrivateFlags &= ~SKIP_DRAW;
5437 }
5438 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08005439 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005440 }
5441
5442 if ((changed & KEEP_SCREEN_ON) != 0) {
Joe Onorato664644d2011-01-23 17:53:23 -08005443 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005444 mParent.recomputeViewAttributes(this);
5445 }
5446 }
5447 }
5448
5449 /**
5450 * Change the view's z order in the tree, so it's on top of other sibling
5451 * views
5452 */
5453 public void bringToFront() {
5454 if (mParent != null) {
5455 mParent.bringChildToFront(this);
5456 }
5457 }
5458
5459 /**
5460 * This is called in response to an internal scroll in this view (i.e., the
5461 * view scrolled its own contents). This is typically as a result of
5462 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
5463 * called.
5464 *
5465 * @param l Current horizontal scroll origin.
5466 * @param t Current vertical scroll origin.
5467 * @param oldl Previous horizontal scroll origin.
5468 * @param oldt Previous vertical scroll origin.
5469 */
5470 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
5471 mBackgroundSizeChanged = true;
5472
5473 final AttachInfo ai = mAttachInfo;
5474 if (ai != null) {
5475 ai.mViewScrollChanged = true;
5476 }
5477 }
5478
5479 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005480 * Interface definition for a callback to be invoked when the layout bounds of a view
5481 * changes due to layout processing.
5482 */
5483 public interface OnLayoutChangeListener {
5484 /**
5485 * Called when the focus state of a view has changed.
5486 *
5487 * @param v The view whose state has changed.
5488 * @param left The new value of the view's left property.
5489 * @param top The new value of the view's top property.
5490 * @param right The new value of the view's right property.
5491 * @param bottom The new value of the view's bottom property.
5492 * @param oldLeft The previous value of the view's left property.
5493 * @param oldTop The previous value of the view's top property.
5494 * @param oldRight The previous value of the view's right property.
5495 * @param oldBottom The previous value of the view's bottom property.
5496 */
5497 void onLayoutChange(View v, int left, int top, int right, int bottom,
5498 int oldLeft, int oldTop, int oldRight, int oldBottom);
5499 }
5500
5501 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005502 * This is called during layout when the size of this view has changed. If
5503 * you were just added to the view hierarchy, you're called with the old
5504 * values of 0.
5505 *
5506 * @param w Current width of this view.
5507 * @param h Current height of this view.
5508 * @param oldw Old width of this view.
5509 * @param oldh Old height of this view.
5510 */
5511 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
5512 }
5513
5514 /**
5515 * Called by draw to draw the child views. This may be overridden
5516 * by derived classes to gain control just before its children are drawn
5517 * (but after its own view has been drawn).
5518 * @param canvas the canvas on which to draw the view
5519 */
5520 protected void dispatchDraw(Canvas canvas) {
5521 }
5522
5523 /**
5524 * Gets the parent of this view. Note that the parent is a
5525 * ViewParent and not necessarily a View.
5526 *
5527 * @return Parent of this view.
5528 */
5529 public final ViewParent getParent() {
5530 return mParent;
5531 }
5532
5533 /**
5534 * Return the scrolled left position of this view. This is the left edge of
5535 * the displayed part of your view. You do not need to draw any pixels
5536 * farther left, since those are outside of the frame of your view on
5537 * screen.
5538 *
5539 * @return The left edge of the displayed part of your view, in pixels.
5540 */
5541 public final int getScrollX() {
5542 return mScrollX;
5543 }
5544
5545 /**
5546 * Return the scrolled top position of this view. This is the top edge of
5547 * the displayed part of your view. You do not need to draw any pixels above
5548 * it, since those are outside of the frame of your view on screen.
5549 *
5550 * @return The top edge of the displayed part of your view, in pixels.
5551 */
5552 public final int getScrollY() {
5553 return mScrollY;
5554 }
5555
5556 /**
5557 * Return the width of the your view.
5558 *
5559 * @return The width of your view, in pixels.
5560 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005561 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005562 public final int getWidth() {
5563 return mRight - mLeft;
5564 }
5565
5566 /**
5567 * Return the height of your view.
5568 *
5569 * @return The height of your view, in pixels.
5570 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005571 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005572 public final int getHeight() {
5573 return mBottom - mTop;
5574 }
5575
5576 /**
5577 * Return the visible drawing bounds of your view. Fills in the output
5578 * rectangle with the values from getScrollX(), getScrollY(),
5579 * getWidth(), and getHeight().
5580 *
5581 * @param outRect The (scrolled) drawing bounds of the view.
5582 */
5583 public void getDrawingRect(Rect outRect) {
5584 outRect.left = mScrollX;
5585 outRect.top = mScrollY;
5586 outRect.right = mScrollX + (mRight - mLeft);
5587 outRect.bottom = mScrollY + (mBottom - mTop);
5588 }
5589
5590 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005591 * Like {@link #getMeasuredWidthAndState()}, but only returns the
5592 * raw width component (that is the result is masked by
5593 * {@link #MEASURED_SIZE_MASK}).
5594 *
5595 * @return The raw measured width of this view.
5596 */
5597 public final int getMeasuredWidth() {
5598 return mMeasuredWidth & MEASURED_SIZE_MASK;
5599 }
5600
5601 /**
5602 * Return the full width measurement information for this view as computed
5603 * by the most recent call to {@link #measure}. This result is a bit mask
5604 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005605 * This should be used during measurement and layout calculations only. Use
5606 * {@link #getWidth()} to see how wide a view is after layout.
5607 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08005608 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005609 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08005610 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005611 return mMeasuredWidth;
5612 }
5613
5614 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005615 * Like {@link #getMeasuredHeightAndState()}, but only returns the
5616 * raw width component (that is the result is masked by
5617 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005618 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08005619 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005620 */
5621 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08005622 return mMeasuredHeight & MEASURED_SIZE_MASK;
5623 }
5624
5625 /**
5626 * Return the full height measurement information for this view as computed
5627 * by the most recent call to {@link #measure}. This result is a bit mask
5628 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
5629 * This should be used during measurement and layout calculations only. Use
5630 * {@link #getHeight()} to see how wide a view is after layout.
5631 *
5632 * @return The measured width of this view as a bit mask.
5633 */
5634 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005635 return mMeasuredHeight;
5636 }
5637
5638 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005639 * Return only the state bits of {@link #getMeasuredWidthAndState()}
5640 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
5641 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
5642 * and the height component is at the shifted bits
5643 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
5644 */
5645 public final int getMeasuredState() {
5646 return (mMeasuredWidth&MEASURED_STATE_MASK)
5647 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
5648 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
5649 }
5650
5651 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005652 * The transform matrix of this view, which is calculated based on the current
5653 * roation, scale, and pivot properties.
5654 *
5655 * @see #getRotation()
5656 * @see #getScaleX()
5657 * @see #getScaleY()
5658 * @see #getPivotX()
5659 * @see #getPivotY()
5660 * @return The current transform matrix for the view
5661 */
5662 public Matrix getMatrix() {
Jeff Brown86671742010-09-30 20:00:15 -07005663 updateMatrix();
Romain Guy33e72ae2010-07-17 12:40:29 -07005664 return mMatrix;
5665 }
5666
5667 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005668 * Utility function to determine if the value is far enough away from zero to be
5669 * considered non-zero.
5670 * @param value A floating point value to check for zero-ness
5671 * @return whether the passed-in value is far enough away from zero to be considered non-zero
5672 */
5673 private static boolean nonzero(float value) {
5674 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
5675 }
5676
5677 /**
Jeff Brown86671742010-09-30 20:00:15 -07005678 * Returns true if the transform matrix is the identity matrix.
5679 * Recomputes the matrix if necessary.
Romain Guy33e72ae2010-07-17 12:40:29 -07005680 *
5681 * @return True if the transform matrix is the identity matrix, false otherwise.
5682 */
Jeff Brown86671742010-09-30 20:00:15 -07005683 final boolean hasIdentityMatrix() {
5684 updateMatrix();
5685 return mMatrixIsIdentity;
5686 }
5687
5688 /**
5689 * Recomputes the transform matrix if necessary.
5690 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07005691 private void updateMatrix() {
Chet Haasec3aa3612010-06-17 08:50:37 -07005692 if (mMatrixDirty) {
5693 // transform-related properties have changed since the last time someone
5694 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07005695
5696 // Figure out if we need to update the pivot point
5697 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08005698 if ((mRight - mLeft) != mPrevWidth || (mBottom - mTop) != mPrevHeight) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005699 mPrevWidth = mRight - mLeft;
5700 mPrevHeight = mBottom - mTop;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -08005701 mPivotX = mPrevWidth / 2f;
5702 mPivotY = mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07005703 }
5704 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005705 mMatrix.reset();
Chet Haase897247b2010-09-09 14:54:47 -07005706 if (!nonzero(mRotationX) && !nonzero(mRotationY)) {
5707 mMatrix.setTranslate(mTranslationX, mTranslationY);
5708 mMatrix.preRotate(mRotation, mPivotX, mPivotY);
5709 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
5710 } else {
Chet Haasefd2b0022010-08-06 13:08:56 -07005711 if (mCamera == null) {
5712 mCamera = new Camera();
5713 matrix3D = new Matrix();
5714 }
5715 mCamera.save();
Chet Haase897247b2010-09-09 14:54:47 -07005716 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
Chet Haasefd2b0022010-08-06 13:08:56 -07005717 mCamera.rotateX(mRotationX);
5718 mCamera.rotateY(mRotationY);
Chet Haase897247b2010-09-09 14:54:47 -07005719 mCamera.rotateZ(-mRotation);
Chet Haasefd2b0022010-08-06 13:08:56 -07005720 mCamera.getMatrix(matrix3D);
5721 matrix3D.preTranslate(-mPivotX, -mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07005722 matrix3D.postTranslate(mPivotX + mTranslationX, mPivotY + mTranslationY);
Chet Haasefd2b0022010-08-06 13:08:56 -07005723 mMatrix.postConcat(matrix3D);
5724 mCamera.restore();
5725 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005726 mMatrixDirty = false;
5727 mMatrixIsIdentity = mMatrix.isIdentity();
5728 mInverseMatrixDirty = true;
5729 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005730 }
5731
5732 /**
5733 * Utility method to retrieve the inverse of the current mMatrix property.
5734 * We cache the matrix to avoid recalculating it when transform properties
5735 * have not changed.
5736 *
5737 * @return The inverse of the current matrix of this view.
5738 */
Jeff Brown86671742010-09-30 20:00:15 -07005739 final Matrix getInverseMatrix() {
5740 updateMatrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07005741 if (mInverseMatrixDirty) {
5742 if (mInverseMatrix == null) {
5743 mInverseMatrix = new Matrix();
5744 }
5745 mMatrix.invert(mInverseMatrix);
5746 mInverseMatrixDirty = false;
5747 }
5748 return mInverseMatrix;
5749 }
5750
5751 /**
5752 * The degrees that the view is rotated around the pivot point.
5753 *
5754 * @see #getPivotX()
5755 * @see #getPivotY()
5756 * @return The degrees of rotation.
5757 */
5758 public float getRotation() {
5759 return mRotation;
5760 }
5761
5762 /**
Chet Haase897247b2010-09-09 14:54:47 -07005763 * Sets the degrees that the view is rotated around the pivot point. Increasing values
5764 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07005765 *
5766 * @param rotation The degrees of rotation.
5767 * @see #getPivotX()
5768 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005769 *
5770 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07005771 */
5772 public void setRotation(float rotation) {
5773 if (mRotation != rotation) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005774 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005775 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005776 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005777 mRotation = rotation;
5778 mMatrixDirty = true;
5779 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005780 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005781 }
5782 }
5783
5784 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005785 * The degrees that the view is rotated around the vertical axis through the pivot point.
5786 *
5787 * @see #getPivotX()
5788 * @see #getPivotY()
5789 * @return The degrees of Y rotation.
5790 */
5791 public float getRotationY() {
5792 return mRotationY;
5793 }
5794
5795 /**
Chet Haase897247b2010-09-09 14:54:47 -07005796 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
5797 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
5798 * down the y axis.
Chet Haasefd2b0022010-08-06 13:08:56 -07005799 *
5800 * @param rotationY The degrees of Y rotation.
5801 * @see #getPivotX()
5802 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005803 *
5804 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07005805 */
5806 public void setRotationY(float rotationY) {
5807 if (mRotationY != rotationY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005808 invalidateParentCaches();
Chet Haasefd2b0022010-08-06 13:08:56 -07005809 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005810 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005811 mRotationY = rotationY;
5812 mMatrixDirty = true;
5813 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005814 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005815 }
5816 }
5817
5818 /**
5819 * The degrees that the view is rotated around the horizontal axis through the pivot point.
5820 *
5821 * @see #getPivotX()
5822 * @see #getPivotY()
5823 * @return The degrees of X rotation.
5824 */
5825 public float getRotationX() {
5826 return mRotationX;
5827 }
5828
5829 /**
Chet Haase897247b2010-09-09 14:54:47 -07005830 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
5831 * Increasing values result in clockwise rotation from the viewpoint of looking down the
5832 * x axis.
Chet Haasefd2b0022010-08-06 13:08:56 -07005833 *
5834 * @param rotationX The degrees of X rotation.
5835 * @see #getPivotX()
5836 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005837 *
5838 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07005839 */
5840 public void setRotationX(float rotationX) {
5841 if (mRotationX != rotationX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005842 invalidateParentCaches();
Chet Haasefd2b0022010-08-06 13:08:56 -07005843 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005844 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005845 mRotationX = rotationX;
5846 mMatrixDirty = true;
5847 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005848 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005849 }
5850 }
5851
5852 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005853 * The amount that the view is scaled in x around the pivot point, as a proportion of
5854 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
5855 *
Joe Onorato93162322010-09-16 15:42:01 -04005856 * <p>By default, this is 1.0f.
5857 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005858 * @see #getPivotX()
5859 * @see #getPivotY()
5860 * @return The scaling factor.
5861 */
5862 public float getScaleX() {
5863 return mScaleX;
5864 }
5865
5866 /**
5867 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
5868 * the view's unscaled width. A value of 1 means that no scaling is applied.
5869 *
5870 * @param scaleX The scaling factor.
5871 * @see #getPivotX()
5872 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005873 *
5874 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07005875 */
5876 public void setScaleX(float scaleX) {
5877 if (mScaleX != scaleX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005878 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005879 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005880 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005881 mScaleX = scaleX;
5882 mMatrixDirty = true;
5883 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005884 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005885 }
5886 }
5887
5888 /**
5889 * The amount that the view is scaled in y around the pivot point, as a proportion of
5890 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
5891 *
Joe Onorato93162322010-09-16 15:42:01 -04005892 * <p>By default, this is 1.0f.
5893 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005894 * @see #getPivotX()
5895 * @see #getPivotY()
5896 * @return The scaling factor.
5897 */
5898 public float getScaleY() {
5899 return mScaleY;
5900 }
5901
5902 /**
5903 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
5904 * the view's unscaled width. A value of 1 means that no scaling is applied.
5905 *
5906 * @param scaleY The scaling factor.
5907 * @see #getPivotX()
5908 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005909 *
5910 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07005911 */
5912 public void setScaleY(float scaleY) {
5913 if (mScaleY != scaleY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005914 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005915 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005916 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005917 mScaleY = scaleY;
5918 mMatrixDirty = true;
5919 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005920 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005921 }
5922 }
5923
5924 /**
5925 * The x location of the point around which the view is {@link #setRotation(float) rotated}
5926 * and {@link #setScaleX(float) scaled}.
5927 *
5928 * @see #getRotation()
5929 * @see #getScaleX()
5930 * @see #getScaleY()
5931 * @see #getPivotY()
5932 * @return The x location of the pivot point.
5933 */
5934 public float getPivotX() {
5935 return mPivotX;
5936 }
5937
5938 /**
5939 * Sets the x location of the point around which the view is
5940 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07005941 * By default, the pivot point is centered on the object.
5942 * Setting this property disables this behavior and causes the view to use only the
5943 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07005944 *
5945 * @param pivotX The x location of the pivot point.
5946 * @see #getRotation()
5947 * @see #getScaleX()
5948 * @see #getScaleY()
5949 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005950 *
5951 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07005952 */
5953 public void setPivotX(float pivotX) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005954 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07005955 if (mPivotX != pivotX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005956 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005957 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005958 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005959 mPivotX = pivotX;
5960 mMatrixDirty = true;
5961 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005962 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005963 }
5964 }
5965
5966 /**
5967 * The y location of the point around which the view is {@link #setRotation(float) rotated}
5968 * and {@link #setScaleY(float) scaled}.
5969 *
5970 * @see #getRotation()
5971 * @see #getScaleX()
5972 * @see #getScaleY()
5973 * @see #getPivotY()
5974 * @return The y location of the pivot point.
5975 */
5976 public float getPivotY() {
5977 return mPivotY;
5978 }
5979
5980 /**
5981 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07005982 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
5983 * Setting this property disables this behavior and causes the view to use only the
5984 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07005985 *
5986 * @param pivotY The y location of the pivot point.
5987 * @see #getRotation()
5988 * @see #getScaleX()
5989 * @see #getScaleY()
5990 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005991 *
5992 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07005993 */
5994 public void setPivotY(float pivotY) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005995 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07005996 if (mPivotY != pivotY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005997 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005998 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005999 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006000 mPivotY = pivotY;
6001 mMatrixDirty = true;
6002 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006003 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006004 }
6005 }
6006
6007 /**
6008 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
6009 * completely transparent and 1 means the view is completely opaque.
6010 *
Joe Onorato93162322010-09-16 15:42:01 -04006011 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07006012 * @return The opacity of the view.
6013 */
6014 public float getAlpha() {
6015 return mAlpha;
6016 }
6017
6018 /**
Romain Guy171c5922011-01-06 10:04:23 -08006019 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
6020 * completely transparent and 1 means the view is completely opaque.</p>
6021 *
6022 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
6023 * responsible for applying the opacity itself. Otherwise, calling this method is
6024 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
6025 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07006026 *
6027 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08006028 *
Romain Guy171c5922011-01-06 10:04:23 -08006029 * @see #setLayerType(int, android.graphics.Paint)
6030 *
Chet Haase73066682010-11-29 15:55:32 -08006031 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07006032 */
6033 public void setAlpha(float alpha) {
6034 mAlpha = alpha;
Romain Guy0fd89bf2011-01-26 15:41:30 -08006035 invalidateParentCaches();
Chet Haaseed032702010-10-01 14:05:54 -07006036 if (onSetAlpha((int) (alpha * 255))) {
Romain Guya3496a92010-10-12 11:53:24 -07006037 mPrivateFlags |= ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07006038 // subclass is handling alpha - don't optimize rendering cache invalidation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006039 invalidate(true);
Chet Haaseed032702010-10-01 14:05:54 -07006040 } else {
Romain Guya3496a92010-10-12 11:53:24 -07006041 mPrivateFlags &= ~ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07006042 invalidate(false);
6043 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006044 }
6045
6046 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006047 * Top position of this view relative to its parent.
6048 *
6049 * @return The top of this view, in pixels.
6050 */
6051 @ViewDebug.CapturedViewProperty
6052 public final int getTop() {
6053 return mTop;
6054 }
6055
6056 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006057 * Sets the top position of this view relative to its parent. This method is meant to be called
6058 * by the layout system and should not generally be called otherwise, because the property
6059 * may be changed at any time by the layout.
6060 *
6061 * @param top The top of this view, in pixels.
6062 */
6063 public final void setTop(int top) {
6064 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07006065 updateMatrix();
6066 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07006067 final ViewParent p = mParent;
6068 if (p != null && mAttachInfo != null) {
6069 final Rect r = mAttachInfo.mTmpInvalRect;
6070 int minTop;
6071 int yLoc;
6072 if (top < mTop) {
6073 minTop = top;
6074 yLoc = top - mTop;
6075 } else {
6076 minTop = mTop;
6077 yLoc = 0;
6078 }
6079 r.set(0, yLoc, mRight - mLeft, mBottom - minTop);
6080 p.invalidateChild(this, r);
6081 }
6082 } else {
6083 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08006084 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006085 }
6086
Chet Haaseed032702010-10-01 14:05:54 -07006087 int width = mRight - mLeft;
6088 int oldHeight = mBottom - mTop;
6089
Chet Haase21cd1382010-09-01 17:42:29 -07006090 mTop = top;
6091
Chet Haaseed032702010-10-01 14:05:54 -07006092 onSizeChanged(width, mBottom - mTop, width, oldHeight);
6093
Chet Haase21cd1382010-09-01 17:42:29 -07006094 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006095 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6096 // A change in dimension means an auto-centered pivot point changes, too
6097 mMatrixDirty = true;
6098 }
Chet Haase21cd1382010-09-01 17:42:29 -07006099 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006100 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006101 }
Chet Haase55dbb652010-12-21 20:15:08 -08006102 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08006103 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07006104 }
6105 }
6106
6107 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006108 * Bottom position of this view relative to its parent.
6109 *
6110 * @return The bottom of this view, in pixels.
6111 */
6112 @ViewDebug.CapturedViewProperty
6113 public final int getBottom() {
6114 return mBottom;
6115 }
6116
6117 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08006118 * True if this view has changed since the last time being drawn.
6119 *
6120 * @return The dirty state of this view.
6121 */
6122 public boolean isDirty() {
6123 return (mPrivateFlags & DIRTY_MASK) != 0;
6124 }
6125
6126 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006127 * Sets the bottom position of this view relative to its parent. This method is meant to be
6128 * called by the layout system and should not generally be called otherwise, because the
6129 * property may be changed at any time by the layout.
6130 *
6131 * @param bottom The bottom of this view, in pixels.
6132 */
6133 public final void setBottom(int bottom) {
6134 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07006135 updateMatrix();
6136 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07006137 final ViewParent p = mParent;
6138 if (p != null && mAttachInfo != null) {
6139 final Rect r = mAttachInfo.mTmpInvalRect;
6140 int maxBottom;
6141 if (bottom < mBottom) {
6142 maxBottom = mBottom;
6143 } else {
6144 maxBottom = bottom;
6145 }
6146 r.set(0, 0, mRight - mLeft, maxBottom - mTop);
6147 p.invalidateChild(this, r);
6148 }
6149 } else {
6150 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08006151 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006152 }
6153
Chet Haaseed032702010-10-01 14:05:54 -07006154 int width = mRight - mLeft;
6155 int oldHeight = mBottom - mTop;
6156
Chet Haase21cd1382010-09-01 17:42:29 -07006157 mBottom = bottom;
6158
Chet Haaseed032702010-10-01 14:05:54 -07006159 onSizeChanged(width, mBottom - mTop, width, oldHeight);
6160
Chet Haase21cd1382010-09-01 17:42:29 -07006161 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006162 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6163 // A change in dimension means an auto-centered pivot point changes, too
6164 mMatrixDirty = true;
6165 }
Chet Haase21cd1382010-09-01 17:42:29 -07006166 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006167 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006168 }
Chet Haase55dbb652010-12-21 20:15:08 -08006169 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08006170 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07006171 }
6172 }
6173
6174 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006175 * Left position of this view relative to its parent.
6176 *
6177 * @return The left edge of this view, in pixels.
6178 */
6179 @ViewDebug.CapturedViewProperty
6180 public final int getLeft() {
6181 return mLeft;
6182 }
6183
6184 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006185 * Sets the left position of this view relative to its parent. This method is meant to be called
6186 * by the layout system and should not generally be called otherwise, because the property
6187 * may be changed at any time by the layout.
6188 *
6189 * @param left The bottom of this view, in pixels.
6190 */
6191 public final void setLeft(int left) {
6192 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07006193 updateMatrix();
6194 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07006195 final ViewParent p = mParent;
6196 if (p != null && mAttachInfo != null) {
6197 final Rect r = mAttachInfo.mTmpInvalRect;
6198 int minLeft;
6199 int xLoc;
6200 if (left < mLeft) {
6201 minLeft = left;
6202 xLoc = left - mLeft;
6203 } else {
6204 minLeft = mLeft;
6205 xLoc = 0;
6206 }
6207 r.set(xLoc, 0, mRight - minLeft, mBottom - mTop);
6208 p.invalidateChild(this, r);
6209 }
6210 } else {
6211 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08006212 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006213 }
6214
Chet Haaseed032702010-10-01 14:05:54 -07006215 int oldWidth = mRight - mLeft;
6216 int height = mBottom - mTop;
6217
Chet Haase21cd1382010-09-01 17:42:29 -07006218 mLeft = left;
6219
Chet Haaseed032702010-10-01 14:05:54 -07006220 onSizeChanged(mRight - mLeft, height, oldWidth, height);
6221
Chet Haase21cd1382010-09-01 17:42:29 -07006222 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006223 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6224 // A change in dimension means an auto-centered pivot point changes, too
6225 mMatrixDirty = true;
6226 }
Chet Haase21cd1382010-09-01 17:42:29 -07006227 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006228 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006229 }
Chet Haase55dbb652010-12-21 20:15:08 -08006230 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08006231 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07006232 }
6233 }
6234
6235 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006236 * Right position of this view relative to its parent.
6237 *
6238 * @return The right edge of this view, in pixels.
6239 */
6240 @ViewDebug.CapturedViewProperty
6241 public final int getRight() {
6242 return mRight;
6243 }
6244
6245 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006246 * Sets the right position of this view relative to its parent. This method is meant to be called
6247 * by the layout system and should not generally be called otherwise, because the property
6248 * may be changed at any time by the layout.
6249 *
6250 * @param right The bottom of this view, in pixels.
6251 */
6252 public final void setRight(int right) {
6253 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07006254 updateMatrix();
6255 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07006256 final ViewParent p = mParent;
6257 if (p != null && mAttachInfo != null) {
6258 final Rect r = mAttachInfo.mTmpInvalRect;
6259 int maxRight;
6260 if (right < mRight) {
6261 maxRight = mRight;
6262 } else {
6263 maxRight = right;
6264 }
6265 r.set(0, 0, maxRight - mLeft, mBottom - mTop);
6266 p.invalidateChild(this, r);
6267 }
6268 } else {
6269 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08006270 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006271 }
6272
Chet Haaseed032702010-10-01 14:05:54 -07006273 int oldWidth = mRight - mLeft;
6274 int height = mBottom - mTop;
6275
Chet Haase21cd1382010-09-01 17:42:29 -07006276 mRight = right;
6277
Chet Haaseed032702010-10-01 14:05:54 -07006278 onSizeChanged(mRight - mLeft, height, oldWidth, height);
6279
Chet Haase21cd1382010-09-01 17:42:29 -07006280 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006281 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6282 // A change in dimension means an auto-centered pivot point changes, too
6283 mMatrixDirty = true;
6284 }
Chet Haase21cd1382010-09-01 17:42:29 -07006285 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006286 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006287 }
Chet Haase55dbb652010-12-21 20:15:08 -08006288 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08006289 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07006290 }
6291 }
6292
6293 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006294 * The visual x position of this view, in pixels. This is equivalent to the
6295 * {@link #setTranslationX(float) translationX} property plus the current
6296 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07006297 *
Chet Haasedf030d22010-07-30 17:22:38 -07006298 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07006299 */
Chet Haasedf030d22010-07-30 17:22:38 -07006300 public float getX() {
6301 return mLeft + mTranslationX;
6302 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006303
Chet Haasedf030d22010-07-30 17:22:38 -07006304 /**
6305 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
6306 * {@link #setTranslationX(float) translationX} property to be the difference between
6307 * the x value passed in and the current {@link #getLeft() left} property.
6308 *
6309 * @param x The visual x position of this view, in pixels.
6310 */
6311 public void setX(float x) {
6312 setTranslationX(x - mLeft);
6313 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006314
Chet Haasedf030d22010-07-30 17:22:38 -07006315 /**
6316 * The visual y position of this view, in pixels. This is equivalent to the
6317 * {@link #setTranslationY(float) translationY} property plus the current
6318 * {@link #getTop() top} property.
6319 *
6320 * @return The visual y position of this view, in pixels.
6321 */
6322 public float getY() {
6323 return mTop + mTranslationY;
6324 }
6325
6326 /**
6327 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
6328 * {@link #setTranslationY(float) translationY} property to be the difference between
6329 * the y value passed in and the current {@link #getTop() top} property.
6330 *
6331 * @param y The visual y position of this view, in pixels.
6332 */
6333 public void setY(float y) {
6334 setTranslationY(y - mTop);
6335 }
6336
6337
6338 /**
6339 * The horizontal location of this view relative to its {@link #getLeft() left} position.
6340 * This position is post-layout, in addition to wherever the object's
6341 * layout placed it.
6342 *
6343 * @return The horizontal position of this view relative to its left position, in pixels.
6344 */
6345 public float getTranslationX() {
6346 return mTranslationX;
6347 }
6348
6349 /**
6350 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
6351 * This effectively positions the object post-layout, in addition to wherever the object's
6352 * layout placed it.
6353 *
6354 * @param translationX The horizontal position of this view relative to its left position,
6355 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08006356 *
6357 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07006358 */
6359 public void setTranslationX(float translationX) {
6360 if (mTranslationX != translationX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006361 invalidateParentCaches();
Chet Haasedf030d22010-07-30 17:22:38 -07006362 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006363 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006364 mTranslationX = translationX;
6365 mMatrixDirty = true;
6366 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006367 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006368 }
6369 }
6370
6371 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006372 * The horizontal location of this view relative to its {@link #getTop() top} position.
6373 * This position is post-layout, in addition to wherever the object's
6374 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07006375 *
Chet Haasedf030d22010-07-30 17:22:38 -07006376 * @return The vertical position of this view relative to its top position,
6377 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07006378 */
Chet Haasedf030d22010-07-30 17:22:38 -07006379 public float getTranslationY() {
6380 return mTranslationY;
Chet Haasec3aa3612010-06-17 08:50:37 -07006381 }
6382
6383 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006384 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
6385 * This effectively positions the object post-layout, in addition to wherever the object's
6386 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07006387 *
Chet Haasedf030d22010-07-30 17:22:38 -07006388 * @param translationY The vertical position of this view relative to its top position,
6389 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08006390 *
6391 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07006392 */
Chet Haasedf030d22010-07-30 17:22:38 -07006393 public void setTranslationY(float translationY) {
6394 if (mTranslationY != translationY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006395 invalidateParentCaches();
Chet Haasedf030d22010-07-30 17:22:38 -07006396 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006397 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006398 mTranslationY = translationY;
6399 mMatrixDirty = true;
6400 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006401 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006402 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006403 }
6404
6405 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006406 * Hit rectangle in parent's coordinates
6407 *
6408 * @param outRect The hit rectangle of the view.
6409 */
6410 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07006411 updateMatrix();
6412 if (mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006413 outRect.set(mLeft, mTop, mRight, mBottom);
6414 } else {
6415 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Romain Guy33e72ae2010-07-17 12:40:29 -07006416 tmpRect.set(-mPivotX, -mPivotY, getWidth() - mPivotX, getHeight() - mPivotY);
Jeff Brown86671742010-09-30 20:00:15 -07006417 mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07006418 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
6419 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07006420 }
6421 }
6422
6423 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07006424 * Determines whether the given point, in local coordinates is inside the view.
6425 */
6426 /*package*/ final boolean pointInView(float localX, float localY) {
6427 return localX >= 0 && localX < (mRight - mLeft)
6428 && localY >= 0 && localY < (mBottom - mTop);
6429 }
6430
6431 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07006432 * Utility method to determine whether the given point, in local coordinates,
6433 * is inside the view, where the area of the view is expanded by the slop factor.
6434 * This method is called while processing touch-move events to determine if the event
6435 * is still within the view.
6436 */
6437 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07006438 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07006439 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006440 }
6441
6442 /**
6443 * When a view has focus and the user navigates away from it, the next view is searched for
6444 * starting from the rectangle filled in by this method.
6445 *
6446 * By default, the rectange is the {@link #getDrawingRect})of the view. However, if your
6447 * view maintains some idea of internal selection, such as a cursor, or a selected row
6448 * or column, you should override this method and fill in a more specific rectangle.
6449 *
6450 * @param r The rectangle to fill in, in this view's coordinates.
6451 */
6452 public void getFocusedRect(Rect r) {
6453 getDrawingRect(r);
6454 }
6455
6456 /**
6457 * If some part of this view is not clipped by any of its parents, then
6458 * return that area in r in global (root) coordinates. To convert r to local
6459 * coordinates, offset it by -globalOffset (e.g. r.offset(-globalOffset.x,
6460 * -globalOffset.y)) If the view is completely clipped or translated out,
6461 * return false.
6462 *
6463 * @param r If true is returned, r holds the global coordinates of the
6464 * visible portion of this view.
6465 * @param globalOffset If true is returned, globalOffset holds the dx,dy
6466 * between this view and its root. globalOffet may be null.
6467 * @return true if r is non-empty (i.e. part of the view is visible at the
6468 * root level.
6469 */
6470 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
6471 int width = mRight - mLeft;
6472 int height = mBottom - mTop;
6473 if (width > 0 && height > 0) {
6474 r.set(0, 0, width, height);
6475 if (globalOffset != null) {
6476 globalOffset.set(-mScrollX, -mScrollY);
6477 }
6478 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
6479 }
6480 return false;
6481 }
6482
6483 public final boolean getGlobalVisibleRect(Rect r) {
6484 return getGlobalVisibleRect(r, null);
6485 }
6486
6487 public final boolean getLocalVisibleRect(Rect r) {
6488 Point offset = new Point();
6489 if (getGlobalVisibleRect(r, offset)) {
6490 r.offset(-offset.x, -offset.y); // make r local
6491 return true;
6492 }
6493 return false;
6494 }
6495
6496 /**
6497 * Offset this view's vertical location by the specified number of pixels.
6498 *
6499 * @param offset the number of pixels to offset the view by
6500 */
6501 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006502 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07006503 updateMatrix();
6504 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006505 final ViewParent p = mParent;
6506 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006507 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006508 int minTop;
6509 int maxBottom;
6510 int yLoc;
6511 if (offset < 0) {
6512 minTop = mTop + offset;
6513 maxBottom = mBottom;
6514 yLoc = offset;
6515 } else {
6516 minTop = mTop;
6517 maxBottom = mBottom + offset;
6518 yLoc = 0;
6519 }
6520 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
6521 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07006522 }
6523 } else {
Chet Haaseed032702010-10-01 14:05:54 -07006524 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006525 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006526
Chet Haasec3aa3612010-06-17 08:50:37 -07006527 mTop += offset;
6528 mBottom += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07006529
Chet Haasec3aa3612010-06-17 08:50:37 -07006530 if (!mMatrixIsIdentity) {
6531 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006532 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006533 }
Chet Haase678e0ad2011-01-25 09:37:18 -08006534 invalidateParentIfNeeded();
Chet Haasec3aa3612010-06-17 08:50:37 -07006535 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006536 }
6537
6538 /**
6539 * Offset this view's horizontal location by the specified amount of pixels.
6540 *
6541 * @param offset the numer of pixels to offset the view by
6542 */
6543 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006544 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07006545 updateMatrix();
6546 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006547 final ViewParent p = mParent;
6548 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006549 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006550 int minLeft;
6551 int maxRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006552 if (offset < 0) {
6553 minLeft = mLeft + offset;
6554 maxRight = mRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006555 } else {
6556 minLeft = mLeft;
6557 maxRight = mRight + offset;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006558 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006559 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
Chet Haase8fbf8d22010-07-30 15:01:32 -07006560 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07006561 }
6562 } else {
Chet Haaseed032702010-10-01 14:05:54 -07006563 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006564 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006565
Chet Haasec3aa3612010-06-17 08:50:37 -07006566 mLeft += offset;
6567 mRight += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07006568
Chet Haasec3aa3612010-06-17 08:50:37 -07006569 if (!mMatrixIsIdentity) {
6570 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006571 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006572 }
Chet Haase678e0ad2011-01-25 09:37:18 -08006573 invalidateParentIfNeeded();
Chet Haasec3aa3612010-06-17 08:50:37 -07006574 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006575 }
6576
6577 /**
6578 * Get the LayoutParams associated with this view. All views should have
6579 * layout parameters. These supply parameters to the <i>parent</i> of this
6580 * view specifying how it should be arranged. There are many subclasses of
6581 * ViewGroup.LayoutParams, and these correspond to the different subclasses
6582 * of ViewGroup that are responsible for arranging their children.
6583 * @return The LayoutParams associated with this view
6584 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07006585 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006586 public ViewGroup.LayoutParams getLayoutParams() {
6587 return mLayoutParams;
6588 }
6589
6590 /**
6591 * Set the layout parameters associated with this view. These supply
6592 * parameters to the <i>parent</i> of this view specifying how it should be
6593 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
6594 * correspond to the different subclasses of ViewGroup that are responsible
6595 * for arranging their children.
6596 *
6597 * @param params the layout parameters for this view
6598 */
6599 public void setLayoutParams(ViewGroup.LayoutParams params) {
6600 if (params == null) {
6601 throw new NullPointerException("params == null");
6602 }
6603 mLayoutParams = params;
6604 requestLayout();
6605 }
6606
6607 /**
6608 * Set the scrolled position of your view. This will cause a call to
6609 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6610 * invalidated.
6611 * @param x the x position to scroll to
6612 * @param y the y position to scroll to
6613 */
6614 public void scrollTo(int x, int y) {
6615 if (mScrollX != x || mScrollY != y) {
6616 int oldX = mScrollX;
6617 int oldY = mScrollY;
6618 mScrollX = x;
6619 mScrollY = y;
Romain Guy0fd89bf2011-01-26 15:41:30 -08006620 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006621 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07006622 if (!awakenScrollBars()) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006623 invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -07006624 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006625 }
6626 }
6627
6628 /**
6629 * Move the scrolled position of your view. This will cause a call to
6630 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6631 * invalidated.
6632 * @param x the amount of pixels to scroll by horizontally
6633 * @param y the amount of pixels to scroll by vertically
6634 */
6635 public void scrollBy(int x, int y) {
6636 scrollTo(mScrollX + x, mScrollY + y);
6637 }
6638
6639 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006640 * <p>Trigger the scrollbars to draw. When invoked this method starts an
6641 * animation to fade the scrollbars out after a default delay. If a subclass
6642 * provides animated scrolling, the start delay should equal the duration
6643 * of the scrolling animation.</p>
6644 *
6645 * <p>The animation starts only if at least one of the scrollbars is
6646 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
6647 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6648 * this method returns true, and false otherwise. If the animation is
6649 * started, this method calls {@link #invalidate()}; in that case the
6650 * caller should not call {@link #invalidate()}.</p>
6651 *
6652 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07006653 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07006654 *
6655 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
6656 * and {@link #scrollTo(int, int)}.</p>
6657 *
6658 * @return true if the animation is played, false otherwise
6659 *
6660 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07006661 * @see #scrollBy(int, int)
6662 * @see #scrollTo(int, int)
6663 * @see #isHorizontalScrollBarEnabled()
6664 * @see #isVerticalScrollBarEnabled()
6665 * @see #setHorizontalScrollBarEnabled(boolean)
6666 * @see #setVerticalScrollBarEnabled(boolean)
6667 */
6668 protected boolean awakenScrollBars() {
6669 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07006670 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07006671 }
6672
6673 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07006674 * Trigger the scrollbars to draw.
6675 * This method differs from awakenScrollBars() only in its default duration.
6676 * initialAwakenScrollBars() will show the scroll bars for longer than
6677 * usual to give the user more of a chance to notice them.
6678 *
6679 * @return true if the animation is played, false otherwise.
6680 */
6681 private boolean initialAwakenScrollBars() {
6682 return mScrollCache != null &&
6683 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
6684 }
6685
6686 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006687 * <p>
6688 * Trigger the scrollbars to draw. When invoked this method starts an
6689 * animation to fade the scrollbars out after a fixed delay. If a subclass
6690 * provides animated scrolling, the start delay should equal the duration of
6691 * the scrolling animation.
6692 * </p>
6693 *
6694 * <p>
6695 * The animation starts only if at least one of the scrollbars is enabled,
6696 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6697 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6698 * this method returns true, and false otherwise. If the animation is
6699 * started, this method calls {@link #invalidate()}; in that case the caller
6700 * should not call {@link #invalidate()}.
6701 * </p>
6702 *
6703 * <p>
6704 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07006705 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07006706 * </p>
6707 *
6708 * @param startDelay the delay, in milliseconds, after which the animation
6709 * should start; when the delay is 0, the animation starts
6710 * immediately
6711 * @return true if the animation is played, false otherwise
6712 *
Mike Cleronf116bf82009-09-27 19:14:12 -07006713 * @see #scrollBy(int, int)
6714 * @see #scrollTo(int, int)
6715 * @see #isHorizontalScrollBarEnabled()
6716 * @see #isVerticalScrollBarEnabled()
6717 * @see #setHorizontalScrollBarEnabled(boolean)
6718 * @see #setVerticalScrollBarEnabled(boolean)
6719 */
6720 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07006721 return awakenScrollBars(startDelay, true);
6722 }
6723
6724 /**
6725 * <p>
6726 * Trigger the scrollbars to draw. When invoked this method starts an
6727 * animation to fade the scrollbars out after a fixed delay. If a subclass
6728 * provides animated scrolling, the start delay should equal the duration of
6729 * the scrolling animation.
6730 * </p>
6731 *
6732 * <p>
6733 * The animation starts only if at least one of the scrollbars is enabled,
6734 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6735 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6736 * this method returns true, and false otherwise. If the animation is
6737 * started, this method calls {@link #invalidate()} if the invalidate parameter
6738 * is set to true; in that case the caller
6739 * should not call {@link #invalidate()}.
6740 * </p>
6741 *
6742 * <p>
6743 * This method should be invoked everytime a subclass directly updates the
6744 * scroll parameters.
6745 * </p>
6746 *
6747 * @param startDelay the delay, in milliseconds, after which the animation
6748 * should start; when the delay is 0, the animation starts
6749 * immediately
6750 *
6751 * @param invalidate Wheter this method should call invalidate
6752 *
6753 * @return true if the animation is played, false otherwise
6754 *
6755 * @see #scrollBy(int, int)
6756 * @see #scrollTo(int, int)
6757 * @see #isHorizontalScrollBarEnabled()
6758 * @see #isVerticalScrollBarEnabled()
6759 * @see #setHorizontalScrollBarEnabled(boolean)
6760 * @see #setVerticalScrollBarEnabled(boolean)
6761 */
6762 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07006763 final ScrollabilityCache scrollCache = mScrollCache;
6764
6765 if (scrollCache == null || !scrollCache.fadeScrollBars) {
6766 return false;
6767 }
6768
6769 if (scrollCache.scrollBar == null) {
6770 scrollCache.scrollBar = new ScrollBarDrawable();
6771 }
6772
6773 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
6774
Mike Cleron290947b2009-09-29 18:34:32 -07006775 if (invalidate) {
6776 // Invalidate to show the scrollbars
Romain Guy0fd89bf2011-01-26 15:41:30 -08006777 invalidate(true);
Mike Cleron290947b2009-09-29 18:34:32 -07006778 }
Mike Cleronf116bf82009-09-27 19:14:12 -07006779
6780 if (scrollCache.state == ScrollabilityCache.OFF) {
6781 // FIXME: this is copied from WindowManagerService.
6782 // We should get this value from the system when it
6783 // is possible to do so.
6784 final int KEY_REPEAT_FIRST_DELAY = 750;
6785 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
6786 }
6787
6788 // Tell mScrollCache when we should start fading. This may
6789 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07006790 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07006791 scrollCache.fadeStartTime = fadeStartTime;
6792 scrollCache.state = ScrollabilityCache.ON;
6793
6794 // Schedule our fader to run, unscheduling any old ones first
6795 if (mAttachInfo != null) {
6796 mAttachInfo.mHandler.removeCallbacks(scrollCache);
6797 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
6798 }
6799
6800 return true;
6801 }
6802
6803 return false;
6804 }
6805
6806 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006807 * Mark the the area defined by dirty as needing to be drawn. If the view is
6808 * visible, {@link #onDraw} will be called at some point in the future.
6809 * This must be called from a UI thread. To call from a non-UI thread, call
6810 * {@link #postInvalidate()}.
6811 *
6812 * WARNING: This method is destructive to dirty.
6813 * @param dirty the rectangle representing the bounds of the dirty region
6814 */
6815 public void invalidate(Rect dirty) {
6816 if (ViewDebug.TRACE_HIERARCHY) {
6817 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6818 }
6819
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006820 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08006821 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
6822 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006823 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08006824 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006825 final ViewParent p = mParent;
6826 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08006827 //noinspection PointlessBooleanExpression,ConstantConditions
6828 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
6829 if (p != null && ai != null && ai.mHardwareAccelerated) {
6830 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6831 // with a null dirty rect, which tells the ViewRoot to redraw everything
6832 p.invalidateChild(this, null);
6833 return;
6834 }
Romain Guyaf636eb2010-12-09 17:47:21 -08006835 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006836 if (p != null && ai != null) {
6837 final int scrollX = mScrollX;
6838 final int scrollY = mScrollY;
6839 final Rect r = ai.mTmpInvalRect;
6840 r.set(dirty.left - scrollX, dirty.top - scrollY,
6841 dirty.right - scrollX, dirty.bottom - scrollY);
6842 mParent.invalidateChild(this, r);
6843 }
6844 }
6845 }
6846
6847 /**
6848 * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
6849 * The coordinates of the dirty rect are relative to the view.
6850 * If the view is visible, {@link #onDraw} will be called at some point
6851 * in the future. This must be called from a UI thread. To call
6852 * from a non-UI thread, call {@link #postInvalidate()}.
6853 * @param l the left position of the dirty region
6854 * @param t the top position of the dirty region
6855 * @param r the right position of the dirty region
6856 * @param b the bottom position of the dirty region
6857 */
6858 public void invalidate(int l, int t, int r, int b) {
6859 if (ViewDebug.TRACE_HIERARCHY) {
6860 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6861 }
6862
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006863 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08006864 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
6865 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006866 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08006867 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006868 final ViewParent p = mParent;
6869 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08006870 //noinspection PointlessBooleanExpression,ConstantConditions
6871 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
6872 if (p != null && ai != null && ai.mHardwareAccelerated) {
6873 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6874 // with a null dirty rect, which tells the ViewRoot to redraw everything
6875 p.invalidateChild(this, null);
6876 return;
6877 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08006878 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006879 if (p != null && ai != null && l < r && t < b) {
6880 final int scrollX = mScrollX;
6881 final int scrollY = mScrollY;
6882 final Rect tmpr = ai.mTmpInvalRect;
6883 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
6884 p.invalidateChild(this, tmpr);
6885 }
6886 }
6887 }
6888
6889 /**
6890 * Invalidate the whole view. If the view is visible, {@link #onDraw} will
6891 * be called at some point in the future. This must be called from a
6892 * UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
6893 */
6894 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -07006895 invalidate(true);
6896 }
Romain Guyc5d55862011-01-21 19:01:46 -08006897
Chet Haaseed032702010-10-01 14:05:54 -07006898 /**
6899 * This is where the invalidate() work actually happens. A full invalidate()
6900 * causes the drawing cache to be invalidated, but this function can be called with
6901 * invalidateCache set to false to skip that invalidation step for cases that do not
6902 * need it (for example, a component that remains at the same dimensions with the same
6903 * content).
6904 *
6905 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
6906 * well. This is usually true for a full invalidate, but may be set to false if the
6907 * View's contents or dimensions have not changed.
6908 */
6909 private void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006910 if (ViewDebug.TRACE_HIERARCHY) {
6911 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6912 }
6913
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006914 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Romain Guyc5d55862011-01-21 19:01:46 -08006915 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) ||
Romain Guy0fd89bf2011-01-26 15:41:30 -08006916 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) {
6917 mLastIsOpaque = isOpaque();
Chet Haaseed032702010-10-01 14:05:54 -07006918 mPrivateFlags &= ~DRAWN;
6919 if (invalidateCache) {
Chet Haasedaf98e92011-01-10 14:10:36 -08006920 mPrivateFlags |= INVALIDATED;
Chet Haaseed032702010-10-01 14:05:54 -07006921 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6922 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006923 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -07006924 final ViewParent p = mParent;
Romain Guy7d7b5492011-01-24 16:33:45 -08006925 //noinspection PointlessBooleanExpression,ConstantConditions
6926 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
6927 if (p != null && ai != null && ai.mHardwareAccelerated) {
6928 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6929 // with a null dirty rect, which tells the ViewRoot to redraw everything
6930 p.invalidateChild(this, null);
6931 return;
6932 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08006933 }
Michael Jurkaebefea42010-11-15 16:04:01 -08006934
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006935 if (p != null && ai != null) {
6936 final Rect r = ai.mTmpInvalRect;
6937 r.set(0, 0, mRight - mLeft, mBottom - mTop);
6938 // Don't call invalidate -- we don't want to internally scroll
6939 // our own bounds
6940 p.invalidateChild(this, r);
6941 }
6942 }
6943 }
6944
6945 /**
Romain Guy0fd89bf2011-01-26 15:41:30 -08006946 * Used to indicate that the parent of this view should clear its caches. This functionality
Chet Haasedaf98e92011-01-10 14:10:36 -08006947 * is used to force the parent to rebuild its display list (when hardware-accelerated),
6948 * which is necessary when various parent-managed properties of the view change, such as
Romain Guy0fd89bf2011-01-26 15:41:30 -08006949 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only
6950 * clears the parent caches and does not causes an invalidate event.
Chet Haasedaf98e92011-01-10 14:10:36 -08006951 *
6952 * @hide
6953 */
Romain Guy0fd89bf2011-01-26 15:41:30 -08006954 protected void invalidateParentCaches() {
6955 if (mParent instanceof View) {
6956 ((View) mParent).mPrivateFlags |= INVALIDATED;
6957 }
6958 }
6959
6960 /**
6961 * Used to indicate that the parent of this view should be invalidated. This functionality
6962 * is used to force the parent to rebuild its display list (when hardware-accelerated),
6963 * which is necessary when various parent-managed properties of the view change, such as
6964 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate
6965 * an invalidation event to the parent.
6966 *
6967 * @hide
6968 */
6969 protected void invalidateParentIfNeeded() {
Chet Haasedaf98e92011-01-10 14:10:36 -08006970 if (isHardwareAccelerated() && mParent instanceof View) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006971 ((View) mParent).invalidate(true);
Chet Haasedaf98e92011-01-10 14:10:36 -08006972 }
6973 }
6974
6975 /**
Romain Guy24443ea2009-05-11 11:56:30 -07006976 * Indicates whether this View is opaque. An opaque View guarantees that it will
6977 * draw all the pixels overlapping its bounds using a fully opaque color.
6978 *
6979 * Subclasses of View should override this method whenever possible to indicate
6980 * whether an instance is opaque. Opaque Views are treated in a special way by
6981 * the View hierarchy, possibly allowing it to perform optimizations during
6982 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -07006983 *
Romain Guy24443ea2009-05-11 11:56:30 -07006984 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -07006985 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07006986 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -07006987 public boolean isOpaque() {
Chet Haase70d4ba12010-10-06 09:46:45 -07006988 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK &&
6989 (mAlpha >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD);
Romain Guy8f1344f52009-05-15 16:03:59 -07006990 }
6991
Adam Powell20232d02010-12-08 21:08:53 -08006992 /**
6993 * @hide
6994 */
6995 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -07006996 // Opaque if:
6997 // - Has a background
6998 // - Background is opaque
6999 // - Doesn't have scrollbars or scrollbars are inside overlay
7000
7001 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) {
7002 mPrivateFlags |= OPAQUE_BACKGROUND;
7003 } else {
7004 mPrivateFlags &= ~OPAQUE_BACKGROUND;
7005 }
7006
7007 final int flags = mViewFlags;
7008 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
7009 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
7010 mPrivateFlags |= OPAQUE_SCROLLBARS;
7011 } else {
7012 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
7013 }
7014 }
7015
7016 /**
7017 * @hide
7018 */
7019 protected boolean hasOpaqueScrollbars() {
7020 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -07007021 }
7022
7023 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007024 * @return A handler associated with the thread running the View. This
7025 * handler can be used to pump events in the UI events queue.
7026 */
7027 public Handler getHandler() {
7028 if (mAttachInfo != null) {
7029 return mAttachInfo.mHandler;
7030 }
7031 return null;
7032 }
7033
7034 /**
7035 * Causes the Runnable to be added to the message queue.
7036 * The runnable will be run on the user interface thread.
7037 *
7038 * @param action The Runnable that will be executed.
7039 *
7040 * @return Returns true if the Runnable was successfully placed in to the
7041 * message queue. Returns false on failure, usually because the
7042 * looper processing the message queue is exiting.
7043 */
7044 public boolean post(Runnable action) {
7045 Handler handler;
7046 if (mAttachInfo != null) {
7047 handler = mAttachInfo.mHandler;
7048 } else {
7049 // Assume that post will succeed later
7050 ViewRoot.getRunQueue().post(action);
7051 return true;
7052 }
7053
7054 return handler.post(action);
7055 }
7056
7057 /**
7058 * Causes the Runnable to be added to the message queue, to be run
7059 * after the specified amount of time elapses.
7060 * The runnable will be run on the user interface thread.
7061 *
7062 * @param action The Runnable that will be executed.
7063 * @param delayMillis The delay (in milliseconds) until the Runnable
7064 * will be executed.
7065 *
7066 * @return true if the Runnable was successfully placed in to the
7067 * message queue. Returns false on failure, usually because the
7068 * looper processing the message queue is exiting. Note that a
7069 * result of true does not mean the Runnable will be processed --
7070 * if the looper is quit before the delivery time of the message
7071 * occurs then the message will be dropped.
7072 */
7073 public boolean postDelayed(Runnable action, long delayMillis) {
7074 Handler handler;
7075 if (mAttachInfo != null) {
7076 handler = mAttachInfo.mHandler;
7077 } else {
7078 // Assume that post will succeed later
7079 ViewRoot.getRunQueue().postDelayed(action, delayMillis);
7080 return true;
7081 }
7082
7083 return handler.postDelayed(action, delayMillis);
7084 }
7085
7086 /**
7087 * Removes the specified Runnable from the message queue.
7088 *
7089 * @param action The Runnable to remove from the message handling queue
7090 *
7091 * @return true if this view could ask the Handler to remove the Runnable,
7092 * false otherwise. When the returned value is true, the Runnable
7093 * may or may not have been actually removed from the message queue
7094 * (for instance, if the Runnable was not in the queue already.)
7095 */
7096 public boolean removeCallbacks(Runnable action) {
7097 Handler handler;
7098 if (mAttachInfo != null) {
7099 handler = mAttachInfo.mHandler;
7100 } else {
7101 // Assume that post will succeed later
7102 ViewRoot.getRunQueue().removeCallbacks(action);
7103 return true;
7104 }
7105
7106 handler.removeCallbacks(action);
7107 return true;
7108 }
7109
7110 /**
7111 * Cause an invalidate to happen on a subsequent cycle through the event loop.
7112 * Use this to invalidate the View from a non-UI thread.
7113 *
7114 * @see #invalidate()
7115 */
7116 public void postInvalidate() {
7117 postInvalidateDelayed(0);
7118 }
7119
7120 /**
7121 * Cause an invalidate of the specified area to happen on a subsequent cycle
7122 * through the event loop. Use this to invalidate the View from a non-UI thread.
7123 *
7124 * @param left The left coordinate of the rectangle to invalidate.
7125 * @param top The top coordinate of the rectangle to invalidate.
7126 * @param right The right coordinate of the rectangle to invalidate.
7127 * @param bottom The bottom coordinate of the rectangle to invalidate.
7128 *
7129 * @see #invalidate(int, int, int, int)
7130 * @see #invalidate(Rect)
7131 */
7132 public void postInvalidate(int left, int top, int right, int bottom) {
7133 postInvalidateDelayed(0, left, top, right, bottom);
7134 }
7135
7136 /**
7137 * Cause an invalidate to happen on a subsequent cycle through the event
7138 * loop. Waits for the specified amount of time.
7139 *
7140 * @param delayMilliseconds the duration in milliseconds to delay the
7141 * invalidation by
7142 */
7143 public void postInvalidateDelayed(long delayMilliseconds) {
7144 // We try only with the AttachInfo because there's no point in invalidating
7145 // if we are not attached to our window
7146 if (mAttachInfo != null) {
7147 Message msg = Message.obtain();
7148 msg.what = AttachInfo.INVALIDATE_MSG;
7149 msg.obj = this;
7150 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
7151 }
7152 }
7153
7154 /**
7155 * Cause an invalidate of the specified area to happen on a subsequent cycle
7156 * through the event loop. Waits for the specified amount of time.
7157 *
7158 * @param delayMilliseconds the duration in milliseconds to delay the
7159 * invalidation by
7160 * @param left The left coordinate of the rectangle to invalidate.
7161 * @param top The top coordinate of the rectangle to invalidate.
7162 * @param right The right coordinate of the rectangle to invalidate.
7163 * @param bottom The bottom coordinate of the rectangle to invalidate.
7164 */
7165 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
7166 int right, int bottom) {
7167
7168 // We try only with the AttachInfo because there's no point in invalidating
7169 // if we are not attached to our window
7170 if (mAttachInfo != null) {
7171 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
7172 info.target = this;
7173 info.left = left;
7174 info.top = top;
7175 info.right = right;
7176 info.bottom = bottom;
7177
7178 final Message msg = Message.obtain();
7179 msg.what = AttachInfo.INVALIDATE_RECT_MSG;
7180 msg.obj = info;
7181 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
7182 }
7183 }
7184
7185 /**
7186 * Called by a parent to request that a child update its values for mScrollX
7187 * and mScrollY if necessary. This will typically be done if the child is
7188 * animating a scroll using a {@link android.widget.Scroller Scroller}
7189 * object.
7190 */
7191 public void computeScroll() {
7192 }
7193
7194 /**
7195 * <p>Indicate whether the horizontal edges are faded when the view is
7196 * scrolled horizontally.</p>
7197 *
7198 * @return true if the horizontal edges should are faded on scroll, false
7199 * otherwise
7200 *
7201 * @see #setHorizontalFadingEdgeEnabled(boolean)
7202 * @attr ref android.R.styleable#View_fadingEdge
7203 */
7204 public boolean isHorizontalFadingEdgeEnabled() {
7205 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
7206 }
7207
7208 /**
7209 * <p>Define whether the horizontal edges should be faded when this view
7210 * is scrolled horizontally.</p>
7211 *
7212 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
7213 * be faded when the view is scrolled
7214 * horizontally
7215 *
7216 * @see #isHorizontalFadingEdgeEnabled()
7217 * @attr ref android.R.styleable#View_fadingEdge
7218 */
7219 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
7220 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
7221 if (horizontalFadingEdgeEnabled) {
7222 initScrollCache();
7223 }
7224
7225 mViewFlags ^= FADING_EDGE_HORIZONTAL;
7226 }
7227 }
7228
7229 /**
7230 * <p>Indicate whether the vertical edges are faded when the view is
7231 * scrolled horizontally.</p>
7232 *
7233 * @return true if the vertical edges should are faded on scroll, false
7234 * otherwise
7235 *
7236 * @see #setVerticalFadingEdgeEnabled(boolean)
7237 * @attr ref android.R.styleable#View_fadingEdge
7238 */
7239 public boolean isVerticalFadingEdgeEnabled() {
7240 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
7241 }
7242
7243 /**
7244 * <p>Define whether the vertical edges should be faded when this view
7245 * is scrolled vertically.</p>
7246 *
7247 * @param verticalFadingEdgeEnabled true if the vertical edges should
7248 * be faded when the view is scrolled
7249 * vertically
7250 *
7251 * @see #isVerticalFadingEdgeEnabled()
7252 * @attr ref android.R.styleable#View_fadingEdge
7253 */
7254 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
7255 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
7256 if (verticalFadingEdgeEnabled) {
7257 initScrollCache();
7258 }
7259
7260 mViewFlags ^= FADING_EDGE_VERTICAL;
7261 }
7262 }
7263
7264 /**
7265 * Returns the strength, or intensity, of the top faded edge. The strength is
7266 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7267 * returns 0.0 or 1.0 but no value in between.
7268 *
7269 * Subclasses should override this method to provide a smoother fade transition
7270 * when scrolling occurs.
7271 *
7272 * @return the intensity of the top fade as a float between 0.0f and 1.0f
7273 */
7274 protected float getTopFadingEdgeStrength() {
7275 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
7276 }
7277
7278 /**
7279 * Returns the strength, or intensity, of the bottom faded edge. The strength is
7280 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7281 * returns 0.0 or 1.0 but no value in between.
7282 *
7283 * Subclasses should override this method to provide a smoother fade transition
7284 * when scrolling occurs.
7285 *
7286 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
7287 */
7288 protected float getBottomFadingEdgeStrength() {
7289 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
7290 computeVerticalScrollRange() ? 1.0f : 0.0f;
7291 }
7292
7293 /**
7294 * Returns the strength, or intensity, of the left faded edge. The strength is
7295 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7296 * returns 0.0 or 1.0 but no value in between.
7297 *
7298 * Subclasses should override this method to provide a smoother fade transition
7299 * when scrolling occurs.
7300 *
7301 * @return the intensity of the left fade as a float between 0.0f and 1.0f
7302 */
7303 protected float getLeftFadingEdgeStrength() {
7304 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
7305 }
7306
7307 /**
7308 * Returns the strength, or intensity, of the right faded edge. The strength is
7309 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7310 * returns 0.0 or 1.0 but no value in between.
7311 *
7312 * Subclasses should override this method to provide a smoother fade transition
7313 * when scrolling occurs.
7314 *
7315 * @return the intensity of the right fade as a float between 0.0f and 1.0f
7316 */
7317 protected float getRightFadingEdgeStrength() {
7318 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
7319 computeHorizontalScrollRange() ? 1.0f : 0.0f;
7320 }
7321
7322 /**
7323 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
7324 * scrollbar is not drawn by default.</p>
7325 *
7326 * @return true if the horizontal scrollbar should be painted, false
7327 * otherwise
7328 *
7329 * @see #setHorizontalScrollBarEnabled(boolean)
7330 */
7331 public boolean isHorizontalScrollBarEnabled() {
7332 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
7333 }
7334
7335 /**
7336 * <p>Define whether the horizontal scrollbar should be drawn or not. The
7337 * scrollbar is not drawn by default.</p>
7338 *
7339 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
7340 * be painted
7341 *
7342 * @see #isHorizontalScrollBarEnabled()
7343 */
7344 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
7345 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
7346 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07007347 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007348 recomputePadding();
7349 }
7350 }
7351
7352 /**
7353 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
7354 * scrollbar is not drawn by default.</p>
7355 *
7356 * @return true if the vertical scrollbar should be painted, false
7357 * otherwise
7358 *
7359 * @see #setVerticalScrollBarEnabled(boolean)
7360 */
7361 public boolean isVerticalScrollBarEnabled() {
7362 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
7363 }
7364
7365 /**
7366 * <p>Define whether the vertical scrollbar should be drawn or not. The
7367 * scrollbar is not drawn by default.</p>
7368 *
7369 * @param verticalScrollBarEnabled true if the vertical scrollbar should
7370 * be painted
7371 *
7372 * @see #isVerticalScrollBarEnabled()
7373 */
7374 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
7375 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
7376 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07007377 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007378 recomputePadding();
7379 }
7380 }
7381
Adam Powell20232d02010-12-08 21:08:53 -08007382 /**
7383 * @hide
7384 */
7385 protected void recomputePadding() {
7386 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007387 }
Mike Cleronfe81d382009-09-28 14:22:16 -07007388
7389 /**
7390 * Define whether scrollbars will fade when the view is not scrolling.
7391 *
7392 * @param fadeScrollbars wheter to enable fading
7393 *
7394 */
7395 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
7396 initScrollCache();
7397 final ScrollabilityCache scrollabilityCache = mScrollCache;
7398 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -07007399 if (fadeScrollbars) {
7400 scrollabilityCache.state = ScrollabilityCache.OFF;
7401 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -07007402 scrollabilityCache.state = ScrollabilityCache.ON;
7403 }
7404 }
7405
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007406 /**
Mike Cleron52f0a642009-09-28 18:21:37 -07007407 *
7408 * Returns true if scrollbars will fade when this view is not scrolling
7409 *
7410 * @return true if scrollbar fading is enabled
7411 */
7412 public boolean isScrollbarFadingEnabled() {
7413 return mScrollCache != null && mScrollCache.fadeScrollBars;
7414 }
7415
7416 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007417 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
7418 * inset. When inset, they add to the padding of the view. And the scrollbars
7419 * can be drawn inside the padding area or on the edge of the view. For example,
7420 * if a view has a background drawable and you want to draw the scrollbars
7421 * inside the padding specified by the drawable, you can use
7422 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
7423 * appear at the edge of the view, ignoring the padding, then you can use
7424 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
7425 * @param style the style of the scrollbars. Should be one of
7426 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
7427 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
7428 * @see #SCROLLBARS_INSIDE_OVERLAY
7429 * @see #SCROLLBARS_INSIDE_INSET
7430 * @see #SCROLLBARS_OUTSIDE_OVERLAY
7431 * @see #SCROLLBARS_OUTSIDE_INSET
7432 */
7433 public void setScrollBarStyle(int style) {
7434 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
7435 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -07007436 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007437 recomputePadding();
7438 }
7439 }
7440
7441 /**
7442 * <p>Returns the current scrollbar style.</p>
7443 * @return the current scrollbar style
7444 * @see #SCROLLBARS_INSIDE_OVERLAY
7445 * @see #SCROLLBARS_INSIDE_INSET
7446 * @see #SCROLLBARS_OUTSIDE_OVERLAY
7447 * @see #SCROLLBARS_OUTSIDE_INSET
7448 */
7449 public int getScrollBarStyle() {
7450 return mViewFlags & SCROLLBARS_STYLE_MASK;
7451 }
7452
7453 /**
7454 * <p>Compute the horizontal range that the horizontal scrollbar
7455 * represents.</p>
7456 *
7457 * <p>The range is expressed in arbitrary units that must be the same as the
7458 * units used by {@link #computeHorizontalScrollExtent()} and
7459 * {@link #computeHorizontalScrollOffset()}.</p>
7460 *
7461 * <p>The default range is the drawing width of this view.</p>
7462 *
7463 * @return the total horizontal range represented by the horizontal
7464 * scrollbar
7465 *
7466 * @see #computeHorizontalScrollExtent()
7467 * @see #computeHorizontalScrollOffset()
7468 * @see android.widget.ScrollBarDrawable
7469 */
7470 protected int computeHorizontalScrollRange() {
7471 return getWidth();
7472 }
7473
7474 /**
7475 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
7476 * within the horizontal range. This value is used to compute the position
7477 * of the thumb within the scrollbar's track.</p>
7478 *
7479 * <p>The range is expressed in arbitrary units that must be the same as the
7480 * units used by {@link #computeHorizontalScrollRange()} and
7481 * {@link #computeHorizontalScrollExtent()}.</p>
7482 *
7483 * <p>The default offset is the scroll offset of this view.</p>
7484 *
7485 * @return the horizontal offset of the scrollbar's thumb
7486 *
7487 * @see #computeHorizontalScrollRange()
7488 * @see #computeHorizontalScrollExtent()
7489 * @see android.widget.ScrollBarDrawable
7490 */
7491 protected int computeHorizontalScrollOffset() {
7492 return mScrollX;
7493 }
7494
7495 /**
7496 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
7497 * within the horizontal range. This value is used to compute the length
7498 * of the thumb within the scrollbar's track.</p>
7499 *
7500 * <p>The range is expressed in arbitrary units that must be the same as the
7501 * units used by {@link #computeHorizontalScrollRange()} and
7502 * {@link #computeHorizontalScrollOffset()}.</p>
7503 *
7504 * <p>The default extent is the drawing width of this view.</p>
7505 *
7506 * @return the horizontal extent of the scrollbar's thumb
7507 *
7508 * @see #computeHorizontalScrollRange()
7509 * @see #computeHorizontalScrollOffset()
7510 * @see android.widget.ScrollBarDrawable
7511 */
7512 protected int computeHorizontalScrollExtent() {
7513 return getWidth();
7514 }
7515
7516 /**
7517 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
7518 *
7519 * <p>The range is expressed in arbitrary units that must be the same as the
7520 * units used by {@link #computeVerticalScrollExtent()} and
7521 * {@link #computeVerticalScrollOffset()}.</p>
7522 *
7523 * @return the total vertical range represented by the vertical scrollbar
7524 *
7525 * <p>The default range is the drawing height of this view.</p>
7526 *
7527 * @see #computeVerticalScrollExtent()
7528 * @see #computeVerticalScrollOffset()
7529 * @see android.widget.ScrollBarDrawable
7530 */
7531 protected int computeVerticalScrollRange() {
7532 return getHeight();
7533 }
7534
7535 /**
7536 * <p>Compute the vertical offset of the vertical scrollbar's thumb
7537 * within the horizontal range. This value is used to compute the position
7538 * of the thumb within the scrollbar's track.</p>
7539 *
7540 * <p>The range is expressed in arbitrary units that must be the same as the
7541 * units used by {@link #computeVerticalScrollRange()} and
7542 * {@link #computeVerticalScrollExtent()}.</p>
7543 *
7544 * <p>The default offset is the scroll offset of this view.</p>
7545 *
7546 * @return the vertical offset of the scrollbar's thumb
7547 *
7548 * @see #computeVerticalScrollRange()
7549 * @see #computeVerticalScrollExtent()
7550 * @see android.widget.ScrollBarDrawable
7551 */
7552 protected int computeVerticalScrollOffset() {
7553 return mScrollY;
7554 }
7555
7556 /**
7557 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
7558 * within the vertical range. This value is used to compute the length
7559 * of the thumb within the scrollbar's track.</p>
7560 *
7561 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -08007562 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007563 * {@link #computeVerticalScrollOffset()}.</p>
7564 *
7565 * <p>The default extent is the drawing height of this view.</p>
7566 *
7567 * @return the vertical extent of the scrollbar's thumb
7568 *
7569 * @see #computeVerticalScrollRange()
7570 * @see #computeVerticalScrollOffset()
7571 * @see android.widget.ScrollBarDrawable
7572 */
7573 protected int computeVerticalScrollExtent() {
7574 return getHeight();
7575 }
7576
7577 /**
7578 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
7579 * scrollbars are painted only if they have been awakened first.</p>
7580 *
7581 * @param canvas the canvas on which to draw the scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -07007582 *
7583 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007584 */
Romain Guy1d5b3a62009-11-05 18:44:12 -08007585 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007586 // scrollbars are drawn only when the animation is running
7587 final ScrollabilityCache cache = mScrollCache;
7588 if (cache != null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07007589
7590 int state = cache.state;
7591
7592 if (state == ScrollabilityCache.OFF) {
7593 return;
7594 }
7595
7596 boolean invalidate = false;
7597
7598 if (state == ScrollabilityCache.FADING) {
7599 // We're fading -- get our fade interpolation
7600 if (cache.interpolatorValues == null) {
7601 cache.interpolatorValues = new float[1];
7602 }
7603
7604 float[] values = cache.interpolatorValues;
7605
7606 // Stops the animation if we're done
7607 if (cache.scrollBarInterpolator.timeToValues(values) ==
7608 Interpolator.Result.FREEZE_END) {
7609 cache.state = ScrollabilityCache.OFF;
7610 } else {
7611 cache.scrollBar.setAlpha(Math.round(values[0]));
7612 }
7613
7614 // This will make the scroll bars inval themselves after
7615 // drawing. We only want this when we're fading so that
7616 // we prevent excessive redraws
7617 invalidate = true;
7618 } else {
7619 // We're just on -- but we may have been fading before so
7620 // reset alpha
7621 cache.scrollBar.setAlpha(255);
7622 }
7623
7624
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007625 final int viewFlags = mViewFlags;
7626
7627 final boolean drawHorizontalScrollBar =
7628 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
7629 final boolean drawVerticalScrollBar =
7630 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
7631 && !isVerticalScrollBarHidden();
7632
7633 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
7634 final int width = mRight - mLeft;
7635 final int height = mBottom - mTop;
7636
7637 final ScrollBarDrawable scrollBar = cache.scrollBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007638
Mike Reede8853fc2009-09-04 14:01:48 -04007639 final int scrollX = mScrollX;
7640 final int scrollY = mScrollY;
7641 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
7642
Mike Cleronf116bf82009-09-27 19:14:12 -07007643 int left, top, right, bottom;
7644
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007645 if (drawHorizontalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -08007646 int size = scrollBar.getSize(false);
7647 if (size <= 0) {
7648 size = cache.scrollBarSize;
7649 }
7650
Mike Cleronf116bf82009-09-27 19:14:12 -07007651 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -04007652 computeHorizontalScrollOffset(),
7653 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -04007654 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -07007655 getVerticalScrollbarWidth() : 0;
7656 top = scrollY + height - size - (mUserPaddingBottom & inside);
7657 left = scrollX + (mPaddingLeft & inside);
7658 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
7659 bottom = top + size;
7660 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
7661 if (invalidate) {
7662 invalidate(left, top, right, bottom);
7663 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007664 }
7665
7666 if (drawVerticalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -08007667 int size = scrollBar.getSize(true);
7668 if (size <= 0) {
7669 size = cache.scrollBarSize;
7670 }
7671
Mike Reede8853fc2009-09-04 14:01:48 -04007672 scrollBar.setParameters(computeVerticalScrollRange(),
7673 computeVerticalScrollOffset(),
7674 computeVerticalScrollExtent(), true);
Adam Powell20232d02010-12-08 21:08:53 -08007675 switch (mVerticalScrollbarPosition) {
7676 default:
7677 case SCROLLBAR_POSITION_DEFAULT:
7678 case SCROLLBAR_POSITION_RIGHT:
7679 left = scrollX + width - size - (mUserPaddingRight & inside);
7680 break;
7681 case SCROLLBAR_POSITION_LEFT:
7682 left = scrollX + (mUserPaddingLeft & inside);
7683 break;
7684 }
Mike Cleronf116bf82009-09-27 19:14:12 -07007685 top = scrollY + (mPaddingTop & inside);
7686 right = left + size;
7687 bottom = scrollY + height - (mUserPaddingBottom & inside);
7688 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
7689 if (invalidate) {
7690 invalidate(left, top, right, bottom);
7691 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007692 }
7693 }
7694 }
7695 }
Romain Guy8506ab42009-06-11 17:35:47 -07007696
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007697 /**
Romain Guy8506ab42009-06-11 17:35:47 -07007698 * 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 -08007699 * FastScroller is visible.
7700 * @return whether to temporarily hide the vertical scrollbar
7701 * @hide
7702 */
7703 protected boolean isVerticalScrollBarHidden() {
7704 return false;
7705 }
7706
7707 /**
7708 * <p>Draw the horizontal scrollbar if
7709 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
7710 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007711 * @param canvas the canvas on which to draw the scrollbar
7712 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007713 *
7714 * @see #isHorizontalScrollBarEnabled()
7715 * @see #computeHorizontalScrollRange()
7716 * @see #computeHorizontalScrollExtent()
7717 * @see #computeHorizontalScrollOffset()
7718 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -07007719 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007720 */
Romain Guy8fb95422010-08-17 18:38:51 -07007721 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
7722 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007723 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007724 scrollBar.draw(canvas);
7725 }
Mike Reede8853fc2009-09-04 14:01:48 -04007726
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007727 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007728 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
7729 * returns true.</p>
7730 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007731 * @param canvas the canvas on which to draw the scrollbar
7732 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007733 *
7734 * @see #isVerticalScrollBarEnabled()
7735 * @see #computeVerticalScrollRange()
7736 * @see #computeVerticalScrollExtent()
7737 * @see #computeVerticalScrollOffset()
7738 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -04007739 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007740 */
Romain Guy8fb95422010-08-17 18:38:51 -07007741 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
7742 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -04007743 scrollBar.setBounds(l, t, r, b);
7744 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007745 }
7746
7747 /**
7748 * Implement this to do your drawing.
7749 *
7750 * @param canvas the canvas on which the background will be drawn
7751 */
7752 protected void onDraw(Canvas canvas) {
7753 }
7754
7755 /*
7756 * Caller is responsible for calling requestLayout if necessary.
7757 * (This allows addViewInLayout to not request a new layout.)
7758 */
7759 void assignParent(ViewParent parent) {
7760 if (mParent == null) {
7761 mParent = parent;
7762 } else if (parent == null) {
7763 mParent = null;
7764 } else {
7765 throw new RuntimeException("view " + this + " being added, but"
7766 + " it already has a parent");
7767 }
7768 }
7769
7770 /**
7771 * This is called when the view is attached to a window. At this point it
7772 * has a Surface and will start drawing. Note that this function is
7773 * guaranteed to be called before {@link #onDraw}, however it may be called
7774 * any time before the first onDraw -- including before or after
7775 * {@link #onMeasure}.
7776 *
7777 * @see #onDetachedFromWindow()
7778 */
7779 protected void onAttachedToWindow() {
7780 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
7781 mParent.requestTransparentRegion(this);
7782 }
Adam Powell8568c3a2010-04-19 14:26:11 -07007783 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
7784 initialAwakenScrollBars();
7785 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
7786 }
Chet Haasea9b61ac2010-12-20 07:40:25 -08007787 jumpDrawablesToCurrentState();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007788 }
7789
7790 /**
7791 * This is called when the view is detached from a window. At this point it
7792 * no longer has a surface for drawing.
7793 *
7794 * @see #onAttachedToWindow()
7795 */
7796 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -08007797 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -08007798
Romain Guya440b002010-02-24 15:57:54 -08007799 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -05007800 removeLongPressCallback();
Adam Powell3cb8b632011-01-21 15:34:14 -08007801 removePerformClickCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -08007802
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007803 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -08007804
7805 if (mHardwareLayer != null) {
7806 mHardwareLayer.destroy();
7807 mHardwareLayer = null;
7808 }
Romain Guy8dd5b1e2011-01-14 17:28:51 -08007809
Chet Haasedaf98e92011-01-10 14:10:36 -08007810 if (mDisplayList != null) {
7811 mDisplayList.invalidate();
7812 }
7813
Romain Guy8dd5b1e2011-01-14 17:28:51 -08007814 if (mAttachInfo != null) {
7815 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_MSG, this);
7816 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_RECT_MSG, this);
7817 }
7818
Patrick Dubroyec84c3a2011-01-13 17:55:37 -08007819 mCurrentAnimation = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007820 }
7821
7822 /**
7823 * @return The number of times this view has been attached to a window
7824 */
7825 protected int getWindowAttachCount() {
7826 return mWindowAttachCount;
7827 }
7828
7829 /**
7830 * Retrieve a unique token identifying the window this view is attached to.
7831 * @return Return the window's token for use in
7832 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
7833 */
7834 public IBinder getWindowToken() {
7835 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
7836 }
7837
7838 /**
7839 * Retrieve a unique token identifying the top-level "real" window of
7840 * the window that this view is attached to. That is, this is like
7841 * {@link #getWindowToken}, except if the window this view in is a panel
7842 * window (attached to another containing window), then the token of
7843 * the containing window is returned instead.
7844 *
7845 * @return Returns the associated window token, either
7846 * {@link #getWindowToken()} or the containing window's token.
7847 */
7848 public IBinder getApplicationWindowToken() {
7849 AttachInfo ai = mAttachInfo;
7850 if (ai != null) {
7851 IBinder appWindowToken = ai.mPanelParentWindowToken;
7852 if (appWindowToken == null) {
7853 appWindowToken = ai.mWindowToken;
7854 }
7855 return appWindowToken;
7856 }
7857 return null;
7858 }
7859
7860 /**
7861 * Retrieve private session object this view hierarchy is using to
7862 * communicate with the window manager.
7863 * @return the session object to communicate with the window manager
7864 */
7865 /*package*/ IWindowSession getWindowSession() {
7866 return mAttachInfo != null ? mAttachInfo.mSession : null;
7867 }
7868
7869 /**
7870 * @param info the {@link android.view.View.AttachInfo} to associated with
7871 * this view
7872 */
7873 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
7874 //System.out.println("Attached! " + this);
7875 mAttachInfo = info;
7876 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08007877 // We will need to evaluate the drawable state at least once.
7878 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007879 if (mFloatingTreeObserver != null) {
7880 info.mTreeObserver.merge(mFloatingTreeObserver);
7881 mFloatingTreeObserver = null;
7882 }
7883 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
7884 mAttachInfo.mScrollContainers.add(this);
7885 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
7886 }
7887 performCollectViewAttributes(visibility);
7888 onAttachedToWindow();
7889 int vis = info.mWindowVisibility;
7890 if (vis != GONE) {
7891 onWindowVisibilityChanged(vis);
7892 }
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08007893 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) {
7894 // If nobody has evaluated the drawable state yet, then do it now.
7895 refreshDrawableState();
7896 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007897 }
7898
7899 void dispatchDetachedFromWindow() {
7900 //System.out.println("Detached! " + this);
7901 AttachInfo info = mAttachInfo;
7902 if (info != null) {
7903 int vis = info.mWindowVisibility;
7904 if (vis != GONE) {
7905 onWindowVisibilityChanged(GONE);
7906 }
7907 }
7908
7909 onDetachedFromWindow();
7910 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
7911 mAttachInfo.mScrollContainers.remove(this);
7912 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
7913 }
7914 mAttachInfo = null;
7915 }
7916
7917 /**
7918 * Store this view hierarchy's frozen state into the given container.
7919 *
7920 * @param container The SparseArray in which to save the view's state.
7921 *
7922 * @see #restoreHierarchyState
7923 * @see #dispatchSaveInstanceState
7924 * @see #onSaveInstanceState
7925 */
7926 public void saveHierarchyState(SparseArray<Parcelable> container) {
7927 dispatchSaveInstanceState(container);
7928 }
7929
7930 /**
7931 * Called by {@link #saveHierarchyState} to store the state for this view and its children.
7932 * May be overridden to modify how freezing happens to a view's children; for example, some
7933 * views may want to not store state for their children.
7934 *
7935 * @param container The SparseArray in which to save the view's state.
7936 *
7937 * @see #dispatchRestoreInstanceState
7938 * @see #saveHierarchyState
7939 * @see #onSaveInstanceState
7940 */
7941 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
7942 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
7943 mPrivateFlags &= ~SAVE_STATE_CALLED;
7944 Parcelable state = onSaveInstanceState();
7945 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
7946 throw new IllegalStateException(
7947 "Derived class did not call super.onSaveInstanceState()");
7948 }
7949 if (state != null) {
7950 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
7951 // + ": " + state);
7952 container.put(mID, state);
7953 }
7954 }
7955 }
7956
7957 /**
7958 * Hook allowing a view to generate a representation of its internal state
7959 * that can later be used to create a new instance with that same state.
7960 * This state should only contain information that is not persistent or can
7961 * not be reconstructed later. For example, you will never store your
7962 * current position on screen because that will be computed again when a
7963 * new instance of the view is placed in its view hierarchy.
7964 * <p>
7965 * Some examples of things you may store here: the current cursor position
7966 * in a text view (but usually not the text itself since that is stored in a
7967 * content provider or other persistent storage), the currently selected
7968 * item in a list view.
7969 *
7970 * @return Returns a Parcelable object containing the view's current dynamic
7971 * state, or null if there is nothing interesting to save. The
7972 * default implementation returns null.
7973 * @see #onRestoreInstanceState
7974 * @see #saveHierarchyState
7975 * @see #dispatchSaveInstanceState
7976 * @see #setSaveEnabled(boolean)
7977 */
7978 protected Parcelable onSaveInstanceState() {
7979 mPrivateFlags |= SAVE_STATE_CALLED;
7980 return BaseSavedState.EMPTY_STATE;
7981 }
7982
7983 /**
7984 * Restore this view hierarchy's frozen state from the given container.
7985 *
7986 * @param container The SparseArray which holds previously frozen states.
7987 *
7988 * @see #saveHierarchyState
7989 * @see #dispatchRestoreInstanceState
7990 * @see #onRestoreInstanceState
7991 */
7992 public void restoreHierarchyState(SparseArray<Parcelable> container) {
7993 dispatchRestoreInstanceState(container);
7994 }
7995
7996 /**
7997 * Called by {@link #restoreHierarchyState} to retrieve the state for this view and its
7998 * children. May be overridden to modify how restoreing happens to a view's children; for
7999 * example, some views may want to not store state for their children.
8000 *
8001 * @param container The SparseArray which holds previously saved state.
8002 *
8003 * @see #dispatchSaveInstanceState
8004 * @see #restoreHierarchyState
8005 * @see #onRestoreInstanceState
8006 */
8007 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
8008 if (mID != NO_ID) {
8009 Parcelable state = container.get(mID);
8010 if (state != null) {
8011 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
8012 // + ": " + state);
8013 mPrivateFlags &= ~SAVE_STATE_CALLED;
8014 onRestoreInstanceState(state);
8015 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
8016 throw new IllegalStateException(
8017 "Derived class did not call super.onRestoreInstanceState()");
8018 }
8019 }
8020 }
8021 }
8022
8023 /**
8024 * Hook allowing a view to re-apply a representation of its internal state that had previously
8025 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
8026 * null state.
8027 *
8028 * @param state The frozen state that had previously been returned by
8029 * {@link #onSaveInstanceState}.
8030 *
8031 * @see #onSaveInstanceState
8032 * @see #restoreHierarchyState
8033 * @see #dispatchRestoreInstanceState
8034 */
8035 protected void onRestoreInstanceState(Parcelable state) {
8036 mPrivateFlags |= SAVE_STATE_CALLED;
8037 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -08008038 throw new IllegalArgumentException("Wrong state class, expecting View State but "
8039 + "received " + state.getClass().toString() + " instead. This usually happens "
8040 + "when two views of different type have the same id in the same hierarchy. "
8041 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
8042 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008043 }
8044 }
8045
8046 /**
8047 * <p>Return the time at which the drawing of the view hierarchy started.</p>
8048 *
8049 * @return the drawing start time in milliseconds
8050 */
8051 public long getDrawingTime() {
8052 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
8053 }
8054
8055 /**
8056 * <p>Enables or disables the duplication of the parent's state into this view. When
8057 * duplication is enabled, this view gets its drawable state from its parent rather
8058 * than from its own internal properties.</p>
8059 *
8060 * <p>Note: in the current implementation, setting this property to true after the
8061 * view was added to a ViewGroup might have no effect at all. This property should
8062 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
8063 *
8064 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
8065 * property is enabled, an exception will be thrown.</p>
Gilles Debunnefb817032011-01-13 13:52:49 -08008066 *
8067 * <p>Note: if the child view uses and updates additionnal states which are unknown to the
8068 * parent, these states should not be affected by this method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008069 *
8070 * @param enabled True to enable duplication of the parent's drawable state, false
8071 * to disable it.
8072 *
8073 * @see #getDrawableState()
8074 * @see #isDuplicateParentStateEnabled()
8075 */
8076 public void setDuplicateParentStateEnabled(boolean enabled) {
8077 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
8078 }
8079
8080 /**
8081 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
8082 *
8083 * @return True if this view's drawable state is duplicated from the parent,
8084 * false otherwise
8085 *
8086 * @see #getDrawableState()
8087 * @see #setDuplicateParentStateEnabled(boolean)
8088 */
8089 public boolean isDuplicateParentStateEnabled() {
8090 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
8091 }
8092
8093 /**
Romain Guy171c5922011-01-06 10:04:23 -08008094 * <p>Specifies the type of layer backing this view. The layer can be
8095 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
8096 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
8097 *
8098 * <p>A layer is associated with an optional {@link android.graphics.Paint}
8099 * instance that controls how the layer is composed on screen. The following
8100 * properties of the paint are taken into account when composing the layer:</p>
8101 * <ul>
8102 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
8103 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
8104 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
8105 * </ul>
8106 *
8107 * <p>If this view has an alpha value set to < 1.0 by calling
8108 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
8109 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
8110 * equivalent to setting a hardware layer on this view and providing a paint with
8111 * the desired alpha value.<p>
8112 *
8113 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
8114 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
8115 * for more information on when and how to use layers.</p>
8116 *
8117 * @param layerType The ype of layer to use with this view, must be one of
8118 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
8119 * {@link #LAYER_TYPE_HARDWARE}
8120 * @param paint The paint used to compose the layer. This argument is optional
8121 * and can be null. It is ignored when the layer type is
8122 * {@link #LAYER_TYPE_NONE}
8123 *
8124 * @see #getLayerType()
8125 * @see #LAYER_TYPE_NONE
8126 * @see #LAYER_TYPE_SOFTWARE
8127 * @see #LAYER_TYPE_HARDWARE
8128 * @see #setAlpha(float)
8129 *
8130 * @attr ref android.R.styleable#View_layerType
8131 */
8132 public void setLayerType(int layerType, Paint paint) {
8133 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
8134 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
8135 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
8136 }
Chet Haasedaf98e92011-01-10 14:10:36 -08008137
Romain Guyd6cd5722011-01-17 14:42:41 -08008138 if (layerType == mLayerType) {
8139 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) {
8140 mLayerPaint = paint == null ? new Paint() : paint;
Romain Guy0fd89bf2011-01-26 15:41:30 -08008141 invalidateParentCaches();
8142 invalidate(true);
Romain Guyd6cd5722011-01-17 14:42:41 -08008143 }
8144 return;
8145 }
Romain Guy171c5922011-01-06 10:04:23 -08008146
8147 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -08008148 switch (mLayerType) {
8149 case LAYER_TYPE_SOFTWARE:
8150 if (mDrawingCache != null) {
8151 mDrawingCache.recycle();
8152 mDrawingCache = null;
8153 }
8154
8155 if (mUnscaledDrawingCache != null) {
8156 mUnscaledDrawingCache.recycle();
8157 mUnscaledDrawingCache = null;
8158 }
8159 break;
8160 case LAYER_TYPE_HARDWARE:
8161 if (mHardwareLayer != null) {
8162 mHardwareLayer.destroy();
8163 mHardwareLayer = null;
8164 }
8165 break;
8166 default:
8167 break;
Romain Guy171c5922011-01-06 10:04:23 -08008168 }
8169
8170 mLayerType = layerType;
Romain Guyd6cd5722011-01-17 14:42:41 -08008171 mLayerPaint = mLayerType == LAYER_TYPE_NONE ? null : (paint == null ? new Paint() : paint);
Romain Guy171c5922011-01-06 10:04:23 -08008172
Romain Guy0fd89bf2011-01-26 15:41:30 -08008173 invalidateParentCaches();
8174 invalidate(true);
Romain Guy171c5922011-01-06 10:04:23 -08008175 }
8176
8177 /**
8178 * Indicates what type of layer is currently associated with this view. By default
8179 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
8180 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
8181 * for more information on the different types of layers.
8182 *
8183 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
8184 * {@link #LAYER_TYPE_HARDWARE}
8185 *
8186 * @see #setLayerType(int, android.graphics.Paint)
8187 * @see #LAYER_TYPE_NONE
8188 * @see #LAYER_TYPE_SOFTWARE
8189 * @see #LAYER_TYPE_HARDWARE
8190 */
8191 public int getLayerType() {
8192 return mLayerType;
8193 }
Romain Guy6c319ca2011-01-11 14:29:25 -08008194
8195 /**
8196 * <p>Returns a hardware layer that can be used to draw this view again
8197 * without executing its draw method.</p>
8198 *
8199 * @return A HardwareLayer ready to render, or null if an error occurred.
8200 */
Romain Guy5e7f7662011-01-24 22:35:56 -08008201 HardwareLayer getHardwareLayer() {
Romain Guy6c319ca2011-01-11 14:29:25 -08008202 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) {
8203 return null;
8204 }
8205
8206 final int width = mRight - mLeft;
8207 final int height = mBottom - mTop;
8208
8209 if (width == 0 || height == 0) {
8210 return null;
8211 }
8212
8213 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
8214 if (mHardwareLayer == null) {
8215 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
8216 width, height, isOpaque());
8217 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
8218 mHardwareLayer.resize(width, height);
8219 }
8220
Romain Guy5e7f7662011-01-24 22:35:56 -08008221 Canvas currentCanvas = mAttachInfo.mHardwareCanvas;
8222 final HardwareCanvas canvas = mHardwareLayer.start(currentCanvas);
8223 mAttachInfo.mHardwareCanvas = canvas;
Romain Guy6c319ca2011-01-11 14:29:25 -08008224 try {
8225 canvas.setViewport(width, height);
Romain Guy7d7b5492011-01-24 16:33:45 -08008226 // TODO: We should pass the dirty rect
8227 canvas.onPreDraw(null);
Romain Guy6c319ca2011-01-11 14:29:25 -08008228
Romain Guy4f09f542011-01-26 22:41:43 -08008229 final int restoreCount = canvas.save();
8230
Romain Guy6c319ca2011-01-11 14:29:25 -08008231 computeScroll();
8232 canvas.translate(-mScrollX, -mScrollY);
8233
Romain Guy6c319ca2011-01-11 14:29:25 -08008234 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
8235
8236 // Fast path for layouts with no backgrounds
8237 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8238 mPrivateFlags &= ~DIRTY_MASK;
8239 dispatchDraw(canvas);
8240 } else {
8241 draw(canvas);
8242 }
8243
8244 canvas.restoreToCount(restoreCount);
8245 } finally {
8246 canvas.onPostDraw();
Romain Guy5e7f7662011-01-24 22:35:56 -08008247 mHardwareLayer.end(currentCanvas);
8248 mAttachInfo.mHardwareCanvas = currentCanvas;
Romain Guy6c319ca2011-01-11 14:29:25 -08008249 }
8250 }
8251
8252 return mHardwareLayer;
8253 }
Romain Guy171c5922011-01-06 10:04:23 -08008254
8255 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008256 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
8257 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
8258 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
8259 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
8260 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
8261 * null.</p>
Romain Guy171c5922011-01-06 10:04:23 -08008262 *
8263 * <p>Enabling the drawing cache is similar to
8264 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
Chet Haasedaf98e92011-01-10 14:10:36 -08008265 * acceleration is turned off. When hardware acceleration is turned on, enabling the
8266 * drawing cache has no effect on rendering because the system uses a different mechanism
8267 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even
8268 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)}
8269 * for information on how to enable software and hardware layers.</p>
8270 *
8271 * <p>This API can be used to manually generate
8272 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling
8273 * {@link #getDrawingCache()}.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008274 *
8275 * @param enabled true to enable the drawing cache, false otherwise
8276 *
8277 * @see #isDrawingCacheEnabled()
8278 * @see #getDrawingCache()
8279 * @see #buildDrawingCache()
Romain Guy171c5922011-01-06 10:04:23 -08008280 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008281 */
8282 public void setDrawingCacheEnabled(boolean enabled) {
8283 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
8284 }
8285
8286 /**
8287 * <p>Indicates whether the drawing cache is enabled for this view.</p>
8288 *
8289 * @return true if the drawing cache is enabled
8290 *
8291 * @see #setDrawingCacheEnabled(boolean)
8292 * @see #getDrawingCache()
8293 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008294 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008295 public boolean isDrawingCacheEnabled() {
8296 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
8297 }
8298
8299 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08008300 * Debugging utility which recursively outputs the dirty state of a view and its
8301 * descendants.
8302 *
8303 * @hide
8304 */
8305 public void outputDirtyFlags(String indent, boolean clear, int clearMask) {
8306 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) +
8307 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" +
8308 (mPrivateFlags & View.DRAWING_CACHE_VALID) +
8309 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")");
8310 if (clear) {
8311 mPrivateFlags &= clearMask;
8312 }
8313 if (this instanceof ViewGroup) {
8314 ViewGroup parent = (ViewGroup) this;
8315 final int count = parent.getChildCount();
8316 for (int i = 0; i < count; i++) {
Romain Guy7d7b5492011-01-24 16:33:45 -08008317 final View child = parent.getChildAt(i);
Chet Haasedaf98e92011-01-10 14:10:36 -08008318 child.outputDirtyFlags(indent + " ", clear, clearMask);
8319 }
8320 }
8321 }
8322
8323 /**
8324 * This method is used by ViewGroup to cause its children to restore or recreate their
8325 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need
8326 * to recreate its own display list, which would happen if it went through the normal
8327 * draw/dispatchDraw mechanisms.
8328 *
8329 * @hide
8330 */
8331 protected void dispatchGetDisplayList() {}
Chet Haasef4ac5472011-01-27 10:30:25 -08008332
8333 /**
8334 * A view that is not attached or hardware accelerated cannot create a display list.
8335 * This method checks these conditions and returns the appropriate result.
8336 *
8337 * @return true if view has the ability to create a display list, false otherwise.
8338 *
8339 * @hide
8340 */
8341 public boolean canHaveDisplayList() {
8342 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) {
8343 return false;
8344 }
8345 return true;
8346 }
Chet Haasedaf98e92011-01-10 14:10:36 -08008347
8348 /**
Romain Guyb051e892010-09-28 19:09:36 -07008349 * <p>Returns a display list that can be used to draw this view again
8350 * without executing its draw method.</p>
8351 *
8352 * @return A DisplayList ready to replay, or null if caching is not enabled.
Chet Haasedaf98e92011-01-10 14:10:36 -08008353 *
8354 * @hide
Romain Guyb051e892010-09-28 19:09:36 -07008355 */
Chet Haasedaf98e92011-01-10 14:10:36 -08008356 public DisplayList getDisplayList() {
Chet Haasef4ac5472011-01-27 10:30:25 -08008357 if (!canHaveDisplayList()) {
Romain Guyb051e892010-09-28 19:09:36 -07008358 return null;
8359 }
8360
Chet Haasedaf98e92011-01-10 14:10:36 -08008361 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 ||
8362 mDisplayList == null || !mDisplayList.isValid() ||
8363 mRecreateDisplayList)) {
8364 // Don't need to recreate the display list, just need to tell our
8365 // children to restore/recreate theirs
8366 if (mDisplayList != null && mDisplayList.isValid() &&
8367 !mRecreateDisplayList) {
8368 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
8369 mPrivateFlags &= ~DIRTY_MASK;
8370 dispatchGetDisplayList();
8371
8372 return mDisplayList;
8373 }
8374
8375 // If we got here, we're recreating it. Mark it as such to ensure that
8376 // we copy in child display lists into ours in drawChild()
8377 mRecreateDisplayList = true;
Chet Haase9e90a992011-01-04 16:23:21 -08008378 if (mDisplayList == null) {
Chet Haasedaf98e92011-01-10 14:10:36 -08008379 mDisplayList = mAttachInfo.mHardwareRenderer.createDisplayList(this);
8380 // If we're creating a new display list, make sure our parent gets invalidated
8381 // since they will need to recreate their display list to account for this
8382 // new child display list.
Romain Guy0fd89bf2011-01-26 15:41:30 -08008383 invalidateParentCaches();
Chet Haase9e90a992011-01-04 16:23:21 -08008384 }
Romain Guyb051e892010-09-28 19:09:36 -07008385
8386 final HardwareCanvas canvas = mDisplayList.start();
8387 try {
8388 int width = mRight - mLeft;
8389 int height = mBottom - mTop;
8390
8391 canvas.setViewport(width, height);
Romain Guy7d7b5492011-01-24 16:33:45 -08008392 // The dirty rect should always be null for a display list
8393 canvas.onPreDraw(null);
Romain Guyb051e892010-09-28 19:09:36 -07008394
8395 final int restoreCount = canvas.save();
8396
Chet Haasedaf98e92011-01-10 14:10:36 -08008397 computeScroll();
8398 canvas.translate(-mScrollX, -mScrollY);
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008399 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
Romain Guyb051e892010-09-28 19:09:36 -07008400
8401 // Fast path for layouts with no backgrounds
8402 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8403 mPrivateFlags &= ~DIRTY_MASK;
8404 dispatchDraw(canvas);
8405 } else {
8406 draw(canvas);
8407 }
8408
8409 canvas.restoreToCount(restoreCount);
8410 } finally {
8411 canvas.onPostDraw();
8412
8413 mDisplayList.end();
Romain Guyb051e892010-09-28 19:09:36 -07008414 }
Chet Haase77785f92011-01-25 23:22:09 -08008415 } else {
8416 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
8417 mPrivateFlags &= ~DIRTY_MASK;
Romain Guyb051e892010-09-28 19:09:36 -07008418 }
8419
8420 return mDisplayList;
8421 }
8422
8423 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07008424 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
8425 *
8426 * @return A non-scaled bitmap representing this view or null if cache is disabled.
8427 *
8428 * @see #getDrawingCache(boolean)
8429 */
8430 public Bitmap getDrawingCache() {
8431 return getDrawingCache(false);
8432 }
8433
8434 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008435 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
8436 * is null when caching is disabled. If caching is enabled and the cache is not ready,
8437 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
8438 * draw from the cache when the cache is enabled. To benefit from the cache, you must
8439 * request the drawing cache by calling this method and draw it on screen if the
8440 * returned bitmap is not null.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07008441 *
8442 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
8443 * this method will create a bitmap of the same size as this view. Because this bitmap
8444 * will be drawn scaled by the parent ViewGroup, the result on screen might show
8445 * scaling artifacts. To avoid such artifacts, you should call this method by setting
8446 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
8447 * size than the view. This implies that your application must be able to handle this
8448 * size.</p>
8449 *
8450 * @param autoScale Indicates whether the generated bitmap should be scaled based on
8451 * the current density of the screen when the application is in compatibility
8452 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008453 *
Romain Guyfbd8f692009-06-26 14:51:58 -07008454 * @return A bitmap representing this view or null if cache is disabled.
8455 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008456 * @see #setDrawingCacheEnabled(boolean)
8457 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -07008458 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008459 * @see #destroyDrawingCache()
8460 */
Romain Guyfbd8f692009-06-26 14:51:58 -07008461 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008462 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
8463 return null;
8464 }
8465 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008466 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008467 }
Romain Guy02890fd2010-08-06 17:58:44 -07008468 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008469 }
8470
8471 /**
8472 * <p>Frees the resources used by the drawing cache. If you call
8473 * {@link #buildDrawingCache()} manually without calling
8474 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
8475 * should cleanup the cache with this method afterwards.</p>
8476 *
8477 * @see #setDrawingCacheEnabled(boolean)
8478 * @see #buildDrawingCache()
8479 * @see #getDrawingCache()
8480 */
8481 public void destroyDrawingCache() {
8482 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07008483 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008484 mDrawingCache = null;
8485 }
Romain Guyfbd8f692009-06-26 14:51:58 -07008486 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07008487 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -07008488 mUnscaledDrawingCache = null;
8489 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008490 }
8491
8492 /**
8493 * Setting a solid background color for the drawing cache's bitmaps will improve
8494 * perfromance and memory usage. Note, though that this should only be used if this
8495 * view will always be drawn on top of a solid color.
8496 *
8497 * @param color The background color to use for the drawing cache's bitmap
8498 *
8499 * @see #setDrawingCacheEnabled(boolean)
8500 * @see #buildDrawingCache()
8501 * @see #getDrawingCache()
8502 */
8503 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -08008504 if (color != mDrawingCacheBackgroundColor) {
8505 mDrawingCacheBackgroundColor = color;
8506 mPrivateFlags &= ~DRAWING_CACHE_VALID;
8507 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008508 }
8509
8510 /**
8511 * @see #setDrawingCacheBackgroundColor(int)
8512 *
8513 * @return The background color to used for the drawing cache's bitmap
8514 */
8515 public int getDrawingCacheBackgroundColor() {
8516 return mDrawingCacheBackgroundColor;
8517 }
8518
8519 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07008520 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
8521 *
8522 * @see #buildDrawingCache(boolean)
8523 */
8524 public void buildDrawingCache() {
8525 buildDrawingCache(false);
8526 }
8527
8528 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008529 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
8530 *
8531 * <p>If you call {@link #buildDrawingCache()} manually without calling
8532 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
8533 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07008534 *
8535 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
8536 * this method will create a bitmap of the same size as this view. Because this bitmap
8537 * will be drawn scaled by the parent ViewGroup, the result on screen might show
8538 * scaling artifacts. To avoid such artifacts, you should call this method by setting
8539 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
8540 * size than the view. This implies that your application must be able to handle this
8541 * size.</p>
Romain Guy0d9275e2010-10-26 14:22:30 -07008542 *
8543 * <p>You should avoid calling this method when hardware acceleration is enabled. If
8544 * you do not need the drawing cache bitmap, calling this method will increase memory
8545 * usage and cause the view to be rendered in software once, thus negatively impacting
8546 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008547 *
8548 * @see #getDrawingCache()
8549 * @see #destroyDrawingCache()
8550 */
Romain Guyfbd8f692009-06-26 14:51:58 -07008551 public void buildDrawingCache(boolean autoScale) {
8552 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -07008553 mDrawingCache == null : mUnscaledDrawingCache == null)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008554
8555 if (ViewDebug.TRACE_HIERARCHY) {
8556 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
8557 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008558
Romain Guy8506ab42009-06-11 17:35:47 -07008559 int width = mRight - mLeft;
8560 int height = mBottom - mTop;
8561
8562 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -07008563 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -07008564
Romain Guye1123222009-06-29 14:24:56 -07008565 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008566 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
8567 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -07008568 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008569
8570 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -07008571 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -08008572 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008573
8574 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -07008575 // Projected bitmap size in bytes
Adam Powell26153a32010-11-08 15:22:27 -08008576 (width * height * (opaque && !use32BitCache ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008577 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
8578 destroyDrawingCache();
8579 return;
8580 }
8581
8582 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -07008583 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008584
8585 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008586 Bitmap.Config quality;
8587 if (!opaque) {
8588 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
8589 case DRAWING_CACHE_QUALITY_AUTO:
8590 quality = Bitmap.Config.ARGB_8888;
8591 break;
8592 case DRAWING_CACHE_QUALITY_LOW:
8593 quality = Bitmap.Config.ARGB_4444;
8594 break;
8595 case DRAWING_CACHE_QUALITY_HIGH:
8596 quality = Bitmap.Config.ARGB_8888;
8597 break;
8598 default:
8599 quality = Bitmap.Config.ARGB_8888;
8600 break;
8601 }
8602 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -07008603 // Optimization for translucent windows
8604 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -08008605 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008606 }
8607
8608 // Try to cleanup memory
8609 if (bitmap != null) bitmap.recycle();
8610
8611 try {
8612 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -07008613 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -07008614 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -07008615 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07008616 } else {
Romain Guy02890fd2010-08-06 17:58:44 -07008617 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07008618 }
Adam Powell26153a32010-11-08 15:22:27 -08008619 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008620 } catch (OutOfMemoryError e) {
8621 // If there is not enough memory to create the bitmap cache, just
8622 // ignore the issue as bitmap caches are not required to draw the
8623 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -07008624 if (autoScale) {
8625 mDrawingCache = null;
8626 } else {
8627 mUnscaledDrawingCache = null;
8628 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008629 return;
8630 }
8631
8632 clear = drawingCacheBackgroundColor != 0;
8633 }
8634
8635 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008636 if (attachInfo != null) {
8637 canvas = attachInfo.mCanvas;
8638 if (canvas == null) {
8639 canvas = new Canvas();
8640 }
8641 canvas.setBitmap(bitmap);
8642 // Temporarily clobber the cached Canvas in case one of our children
8643 // is also using a drawing cache. Without this, the children would
8644 // steal the canvas by attaching their own bitmap to it and bad, bad
8645 // thing would happen (invisible views, corrupted drawings, etc.)
8646 attachInfo.mCanvas = null;
8647 } else {
8648 // This case should hopefully never or seldom happen
8649 canvas = new Canvas(bitmap);
8650 }
8651
8652 if (clear) {
8653 bitmap.eraseColor(drawingCacheBackgroundColor);
8654 }
8655
8656 computeScroll();
8657 final int restoreCount = canvas.save();
Romain Guyfbd8f692009-06-26 14:51:58 -07008658
Romain Guye1123222009-06-29 14:24:56 -07008659 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008660 final float scale = attachInfo.mApplicationScale;
8661 canvas.scale(scale, scale);
8662 }
8663
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008664 canvas.translate(-mScrollX, -mScrollY);
8665
Romain Guy5bcdff42009-05-14 21:27:18 -07008666 mPrivateFlags |= DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -08008667 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
8668 mLayerType != LAYER_TYPE_NONE) {
Romain Guy0d9275e2010-10-26 14:22:30 -07008669 mPrivateFlags |= DRAWING_CACHE_VALID;
8670 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008671
8672 // Fast path for layouts with no backgrounds
8673 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8674 if (ViewDebug.TRACE_HIERARCHY) {
8675 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
8676 }
Romain Guy5bcdff42009-05-14 21:27:18 -07008677 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008678 dispatchDraw(canvas);
8679 } else {
8680 draw(canvas);
8681 }
8682
8683 canvas.restoreToCount(restoreCount);
8684
8685 if (attachInfo != null) {
8686 // Restore the cached Canvas for our siblings
8687 attachInfo.mCanvas = canvas;
8688 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008689 }
8690 }
8691
8692 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008693 * Create a snapshot of the view into a bitmap. We should probably make
8694 * some form of this public, but should think about the API.
8695 */
Romain Guy223ff5c2010-03-02 17:07:47 -08008696 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008697 int width = mRight - mLeft;
8698 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008699
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008700 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -07008701 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008702 width = (int) ((width * scale) + 0.5f);
8703 height = (int) ((height * scale) + 0.5f);
8704
Romain Guy8c11e312009-09-14 15:15:30 -07008705 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008706 if (bitmap == null) {
8707 throw new OutOfMemoryError();
8708 }
8709
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008710 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
8711
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008712 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008713 if (attachInfo != null) {
8714 canvas = attachInfo.mCanvas;
8715 if (canvas == null) {
8716 canvas = new Canvas();
8717 }
8718 canvas.setBitmap(bitmap);
8719 // Temporarily clobber the cached Canvas in case one of our children
8720 // is also using a drawing cache. Without this, the children would
8721 // steal the canvas by attaching their own bitmap to it and bad, bad
8722 // things would happen (invisible views, corrupted drawings, etc.)
8723 attachInfo.mCanvas = null;
8724 } else {
8725 // This case should hopefully never or seldom happen
8726 canvas = new Canvas(bitmap);
8727 }
8728
Romain Guy5bcdff42009-05-14 21:27:18 -07008729 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008730 bitmap.eraseColor(backgroundColor);
8731 }
8732
8733 computeScroll();
8734 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008735 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008736 canvas.translate(-mScrollX, -mScrollY);
8737
Romain Guy5bcdff42009-05-14 21:27:18 -07008738 // Temporarily remove the dirty mask
8739 int flags = mPrivateFlags;
8740 mPrivateFlags &= ~DIRTY_MASK;
8741
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008742 // Fast path for layouts with no backgrounds
8743 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8744 dispatchDraw(canvas);
8745 } else {
8746 draw(canvas);
8747 }
8748
Romain Guy5bcdff42009-05-14 21:27:18 -07008749 mPrivateFlags = flags;
8750
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008751 canvas.restoreToCount(restoreCount);
8752
8753 if (attachInfo != null) {
8754 // Restore the cached Canvas for our siblings
8755 attachInfo.mCanvas = canvas;
8756 }
Romain Guy8506ab42009-06-11 17:35:47 -07008757
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008758 return bitmap;
8759 }
8760
8761 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008762 * Indicates whether this View is currently in edit mode. A View is usually
8763 * in edit mode when displayed within a developer tool. For instance, if
8764 * this View is being drawn by a visual user interface builder, this method
8765 * should return true.
8766 *
8767 * Subclasses should check the return value of this method to provide
8768 * different behaviors if their normal behavior might interfere with the
8769 * host environment. For instance: the class spawns a thread in its
8770 * constructor, the drawing code relies on device-specific features, etc.
8771 *
8772 * This method is usually checked in the drawing code of custom widgets.
8773 *
8774 * @return True if this View is in edit mode, false otherwise.
8775 */
8776 public boolean isInEditMode() {
8777 return false;
8778 }
8779
8780 /**
8781 * If the View draws content inside its padding and enables fading edges,
8782 * it needs to support padding offsets. Padding offsets are added to the
8783 * fading edges to extend the length of the fade so that it covers pixels
8784 * drawn inside the padding.
8785 *
8786 * Subclasses of this class should override this method if they need
8787 * to draw content inside the padding.
8788 *
8789 * @return True if padding offset must be applied, false otherwise.
8790 *
8791 * @see #getLeftPaddingOffset()
8792 * @see #getRightPaddingOffset()
8793 * @see #getTopPaddingOffset()
8794 * @see #getBottomPaddingOffset()
8795 *
8796 * @since CURRENT
8797 */
8798 protected boolean isPaddingOffsetRequired() {
8799 return false;
8800 }
8801
8802 /**
8803 * Amount by which to extend the left fading region. Called only when
8804 * {@link #isPaddingOffsetRequired()} returns true.
8805 *
8806 * @return The left padding offset in pixels.
8807 *
8808 * @see #isPaddingOffsetRequired()
8809 *
8810 * @since CURRENT
8811 */
8812 protected int getLeftPaddingOffset() {
8813 return 0;
8814 }
8815
8816 /**
8817 * Amount by which to extend the right fading region. Called only when
8818 * {@link #isPaddingOffsetRequired()} returns true.
8819 *
8820 * @return The right padding offset in pixels.
8821 *
8822 * @see #isPaddingOffsetRequired()
8823 *
8824 * @since CURRENT
8825 */
8826 protected int getRightPaddingOffset() {
8827 return 0;
8828 }
8829
8830 /**
8831 * Amount by which to extend the top fading region. Called only when
8832 * {@link #isPaddingOffsetRequired()} returns true.
8833 *
8834 * @return The top padding offset in pixels.
8835 *
8836 * @see #isPaddingOffsetRequired()
8837 *
8838 * @since CURRENT
8839 */
8840 protected int getTopPaddingOffset() {
8841 return 0;
8842 }
8843
8844 /**
8845 * Amount by which to extend the bottom fading region. Called only when
8846 * {@link #isPaddingOffsetRequired()} returns true.
8847 *
8848 * @return The bottom padding offset in pixels.
8849 *
8850 * @see #isPaddingOffsetRequired()
8851 *
8852 * @since CURRENT
8853 */
8854 protected int getBottomPaddingOffset() {
8855 return 0;
8856 }
8857
8858 /**
Romain Guy2bffd262010-09-12 17:40:02 -07008859 * <p>Indicates whether this view is attached to an hardware accelerated
8860 * window or not.</p>
8861 *
8862 * <p>Even if this method returns true, it does not mean that every call
8863 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
8864 * accelerated {@link android.graphics.Canvas}. For instance, if this view
8865 * is drawn onto an offscren {@link android.graphics.Bitmap} and its
8866 * window is hardware accelerated,
8867 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
8868 * return false, and this method will return true.</p>
8869 *
8870 * @return True if the view is attached to a window and the window is
8871 * hardware accelerated; false in any other case.
8872 */
8873 public boolean isHardwareAccelerated() {
8874 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
8875 }
8876
8877 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008878 * Manually render this view (and all of its children) to the given Canvas.
8879 * The view must have already done a full layout before this function is
Chet Haasec75ec332010-12-17 07:44:30 -08008880 * called. When implementing a view, implement {@link #onDraw} instead of
8881 * overriding this method. If you do need to override this method, call
8882 * the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008883 *
8884 * @param canvas The Canvas to which the View is rendered.
8885 */
8886 public void draw(Canvas canvas) {
8887 if (ViewDebug.TRACE_HIERARCHY) {
8888 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
8889 }
8890
Romain Guy5bcdff42009-05-14 21:27:18 -07008891 final int privateFlags = mPrivateFlags;
8892 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
8893 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
8894 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -07008895
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008896 /*
8897 * Draw traversal performs several drawing steps which must be executed
8898 * in the appropriate order:
8899 *
8900 * 1. Draw the background
8901 * 2. If necessary, save the canvas' layers to prepare for fading
8902 * 3. Draw view's content
8903 * 4. Draw children
8904 * 5. If necessary, draw the fading edges and restore layers
8905 * 6. Draw decorations (scrollbars for instance)
8906 */
8907
8908 // Step 1, draw the background, if needed
8909 int saveCount;
8910
Romain Guy24443ea2009-05-11 11:56:30 -07008911 if (!dirtyOpaque) {
8912 final Drawable background = mBGDrawable;
8913 if (background != null) {
8914 final int scrollX = mScrollX;
8915 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008916
Romain Guy24443ea2009-05-11 11:56:30 -07008917 if (mBackgroundSizeChanged) {
8918 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
8919 mBackgroundSizeChanged = false;
8920 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008921
Romain Guy24443ea2009-05-11 11:56:30 -07008922 if ((scrollX | scrollY) == 0) {
8923 background.draw(canvas);
8924 } else {
8925 canvas.translate(scrollX, scrollY);
8926 background.draw(canvas);
8927 canvas.translate(-scrollX, -scrollY);
8928 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008929 }
8930 }
8931
8932 // skip step 2 & 5 if possible (common case)
8933 final int viewFlags = mViewFlags;
8934 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
8935 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
8936 if (!verticalEdges && !horizontalEdges) {
8937 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07008938 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008939
8940 // Step 4, draw the children
8941 dispatchDraw(canvas);
8942
8943 // Step 6, draw decorations (scrollbars)
8944 onDrawScrollBars(canvas);
8945
8946 // we're done...
8947 return;
8948 }
8949
8950 /*
8951 * Here we do the full fledged routine...
8952 * (this is an uncommon case where speed matters less,
8953 * this is why we repeat some of the tests that have been
8954 * done above)
8955 */
8956
8957 boolean drawTop = false;
8958 boolean drawBottom = false;
8959 boolean drawLeft = false;
8960 boolean drawRight = false;
8961
8962 float topFadeStrength = 0.0f;
8963 float bottomFadeStrength = 0.0f;
8964 float leftFadeStrength = 0.0f;
8965 float rightFadeStrength = 0.0f;
8966
8967 // Step 2, save the canvas' layers
8968 int paddingLeft = mPaddingLeft;
8969 int paddingTop = mPaddingTop;
8970
8971 final boolean offsetRequired = isPaddingOffsetRequired();
8972 if (offsetRequired) {
8973 paddingLeft += getLeftPaddingOffset();
8974 paddingTop += getTopPaddingOffset();
8975 }
8976
8977 int left = mScrollX + paddingLeft;
8978 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
8979 int top = mScrollY + paddingTop;
8980 int bottom = top + mBottom - mTop - mPaddingBottom - paddingTop;
8981
8982 if (offsetRequired) {
8983 right += getRightPaddingOffset();
8984 bottom += getBottomPaddingOffset();
8985 }
8986
8987 final ScrollabilityCache scrollabilityCache = mScrollCache;
8988 int length = scrollabilityCache.fadingEdgeLength;
8989
8990 // clip the fade length if top and bottom fades overlap
8991 // overlapping fades produce odd-looking artifacts
8992 if (verticalEdges && (top + length > bottom - length)) {
8993 length = (bottom - top) / 2;
8994 }
8995
8996 // also clip horizontal fades if necessary
8997 if (horizontalEdges && (left + length > right - length)) {
8998 length = (right - left) / 2;
8999 }
9000
9001 if (verticalEdges) {
9002 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07009003 drawTop = topFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009004 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07009005 drawBottom = bottomFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009006 }
9007
9008 if (horizontalEdges) {
9009 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07009010 drawLeft = leftFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009011 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07009012 drawRight = rightFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009013 }
9014
9015 saveCount = canvas.getSaveCount();
9016
9017 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -07009018 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009019 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
9020
9021 if (drawTop) {
9022 canvas.saveLayer(left, top, right, top + length, null, flags);
9023 }
9024
9025 if (drawBottom) {
9026 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
9027 }
9028
9029 if (drawLeft) {
9030 canvas.saveLayer(left, top, left + length, bottom, null, flags);
9031 }
9032
9033 if (drawRight) {
9034 canvas.saveLayer(right - length, top, right, bottom, null, flags);
9035 }
9036 } else {
9037 scrollabilityCache.setFadeColor(solidColor);
9038 }
9039
9040 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07009041 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009042
9043 // Step 4, draw the children
9044 dispatchDraw(canvas);
9045
9046 // Step 5, draw the fade effect and restore layers
9047 final Paint p = scrollabilityCache.paint;
9048 final Matrix matrix = scrollabilityCache.matrix;
9049 final Shader fade = scrollabilityCache.shader;
9050 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
9051
9052 if (drawTop) {
9053 matrix.setScale(1, fadeHeight * topFadeStrength);
9054 matrix.postTranslate(left, top);
9055 fade.setLocalMatrix(matrix);
9056 canvas.drawRect(left, top, right, top + length, p);
9057 }
9058
9059 if (drawBottom) {
9060 matrix.setScale(1, fadeHeight * bottomFadeStrength);
9061 matrix.postRotate(180);
9062 matrix.postTranslate(left, bottom);
9063 fade.setLocalMatrix(matrix);
9064 canvas.drawRect(left, bottom - length, right, bottom, p);
9065 }
9066
9067 if (drawLeft) {
9068 matrix.setScale(1, fadeHeight * leftFadeStrength);
9069 matrix.postRotate(-90);
9070 matrix.postTranslate(left, top);
9071 fade.setLocalMatrix(matrix);
9072 canvas.drawRect(left, top, left + length, bottom, p);
9073 }
9074
9075 if (drawRight) {
9076 matrix.setScale(1, fadeHeight * rightFadeStrength);
9077 matrix.postRotate(90);
9078 matrix.postTranslate(right, top);
9079 fade.setLocalMatrix(matrix);
9080 canvas.drawRect(right - length, top, right, bottom, p);
9081 }
9082
9083 canvas.restoreToCount(saveCount);
9084
9085 // Step 6, draw decorations (scrollbars)
9086 onDrawScrollBars(canvas);
9087 }
9088
9089 /**
9090 * Override this if your view is known to always be drawn on top of a solid color background,
9091 * and needs to draw fading edges. Returning a non-zero color enables the view system to
9092 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
9093 * should be set to 0xFF.
9094 *
9095 * @see #setVerticalFadingEdgeEnabled
9096 * @see #setHorizontalFadingEdgeEnabled
9097 *
9098 * @return The known solid color background for this view, or 0 if the color may vary
9099 */
9100 public int getSolidColor() {
9101 return 0;
9102 }
9103
9104 /**
9105 * Build a human readable string representation of the specified view flags.
9106 *
9107 * @param flags the view flags to convert to a string
9108 * @return a String representing the supplied flags
9109 */
9110 private static String printFlags(int flags) {
9111 String output = "";
9112 int numFlags = 0;
9113 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
9114 output += "TAKES_FOCUS";
9115 numFlags++;
9116 }
9117
9118 switch (flags & VISIBILITY_MASK) {
9119 case INVISIBLE:
9120 if (numFlags > 0) {
9121 output += " ";
9122 }
9123 output += "INVISIBLE";
9124 // USELESS HERE numFlags++;
9125 break;
9126 case GONE:
9127 if (numFlags > 0) {
9128 output += " ";
9129 }
9130 output += "GONE";
9131 // USELESS HERE numFlags++;
9132 break;
9133 default:
9134 break;
9135 }
9136 return output;
9137 }
9138
9139 /**
9140 * Build a human readable string representation of the specified private
9141 * view flags.
9142 *
9143 * @param privateFlags the private view flags to convert to a string
9144 * @return a String representing the supplied flags
9145 */
9146 private static String printPrivateFlags(int privateFlags) {
9147 String output = "";
9148 int numFlags = 0;
9149
9150 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
9151 output += "WANTS_FOCUS";
9152 numFlags++;
9153 }
9154
9155 if ((privateFlags & FOCUSED) == FOCUSED) {
9156 if (numFlags > 0) {
9157 output += " ";
9158 }
9159 output += "FOCUSED";
9160 numFlags++;
9161 }
9162
9163 if ((privateFlags & SELECTED) == SELECTED) {
9164 if (numFlags > 0) {
9165 output += " ";
9166 }
9167 output += "SELECTED";
9168 numFlags++;
9169 }
9170
9171 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
9172 if (numFlags > 0) {
9173 output += " ";
9174 }
9175 output += "IS_ROOT_NAMESPACE";
9176 numFlags++;
9177 }
9178
9179 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
9180 if (numFlags > 0) {
9181 output += " ";
9182 }
9183 output += "HAS_BOUNDS";
9184 numFlags++;
9185 }
9186
9187 if ((privateFlags & DRAWN) == DRAWN) {
9188 if (numFlags > 0) {
9189 output += " ";
9190 }
9191 output += "DRAWN";
9192 // USELESS HERE numFlags++;
9193 }
9194 return output;
9195 }
9196
9197 /**
9198 * <p>Indicates whether or not this view's layout will be requested during
9199 * the next hierarchy layout pass.</p>
9200 *
9201 * @return true if the layout will be forced during next layout pass
9202 */
9203 public boolean isLayoutRequested() {
9204 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
9205 }
9206
9207 /**
9208 * Assign a size and position to a view and all of its
9209 * descendants
9210 *
9211 * <p>This is the second phase of the layout mechanism.
9212 * (The first is measuring). In this phase, each parent calls
9213 * layout on all of its children to position them.
9214 * This is typically done using the child measurements
Chet Haase9c087442011-01-12 16:20:16 -08009215 * that were stored in the measure pass().</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009216 *
Chet Haase9c087442011-01-12 16:20:16 -08009217 * <p>Derived classes should not override this method.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009218 * Derived classes with children should override
9219 * onLayout. In that method, they should
Chet Haase9c087442011-01-12 16:20:16 -08009220 * call layout on each of their children.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009221 *
9222 * @param l Left position, relative to parent
9223 * @param t Top position, relative to parent
9224 * @param r Right position, relative to parent
9225 * @param b Bottom position, relative to parent
9226 */
Romain Guy5429e1d2010-09-07 12:38:00 -07009227 @SuppressWarnings({"unchecked"})
Chet Haase9c087442011-01-12 16:20:16 -08009228 public void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -07009229 int oldL = mLeft;
9230 int oldT = mTop;
9231 int oldB = mBottom;
9232 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009233 boolean changed = setFrame(l, t, r, b);
9234 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
9235 if (ViewDebug.TRACE_HIERARCHY) {
9236 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
9237 }
9238
9239 onLayout(changed, l, t, r, b);
9240 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -07009241
9242 if (mOnLayoutChangeListeners != null) {
9243 ArrayList<OnLayoutChangeListener> listenersCopy =
9244 (ArrayList<OnLayoutChangeListener>) mOnLayoutChangeListeners.clone();
9245 int numListeners = listenersCopy.size();
9246 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -07009247 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -07009248 }
9249 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009250 }
9251 mPrivateFlags &= ~FORCE_LAYOUT;
9252 }
9253
9254 /**
9255 * Called from layout when this view should
9256 * assign a size and position to each of its children.
9257 *
9258 * Derived classes with children should override
9259 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -07009260 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009261 * @param changed This is a new size or position for this view
9262 * @param left Left position, relative to parent
9263 * @param top Top position, relative to parent
9264 * @param right Right position, relative to parent
9265 * @param bottom Bottom position, relative to parent
9266 */
9267 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
9268 }
9269
9270 /**
9271 * Assign a size and position to this view.
9272 *
9273 * This is called from layout.
9274 *
9275 * @param left Left position, relative to parent
9276 * @param top Top position, relative to parent
9277 * @param right Right position, relative to parent
9278 * @param bottom Bottom position, relative to parent
9279 * @return true if the new size and position are different than the
9280 * previous ones
9281 * {@hide}
9282 */
9283 protected boolean setFrame(int left, int top, int right, int bottom) {
9284 boolean changed = false;
9285
9286 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -07009287 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009288 + right + "," + bottom + ")");
9289 }
9290
9291 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
9292 changed = true;
9293
9294 // Remember our drawn bit
9295 int drawn = mPrivateFlags & DRAWN;
9296
9297 // Invalidate our old position
Romain Guy0fd89bf2011-01-26 15:41:30 -08009298 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009299
9300
9301 int oldWidth = mRight - mLeft;
9302 int oldHeight = mBottom - mTop;
9303
9304 mLeft = left;
9305 mTop = top;
9306 mRight = right;
9307 mBottom = bottom;
9308
9309 mPrivateFlags |= HAS_BOUNDS;
9310
9311 int newWidth = right - left;
9312 int newHeight = bottom - top;
9313
9314 if (newWidth != oldWidth || newHeight != oldHeight) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009315 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9316 // A change in dimension means an auto-centered pivot point changes, too
9317 mMatrixDirty = true;
9318 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009319 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
9320 }
9321
9322 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
9323 // If we are visible, force the DRAWN bit to on so that
9324 // this invalidate will go through (at least to our parent).
9325 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009326 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009327 // the DRAWN bit.
9328 mPrivateFlags |= DRAWN;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009329 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009330 }
9331
9332 // Reset drawn bit to original value (invalidate turns it off)
9333 mPrivateFlags |= drawn;
9334
9335 mBackgroundSizeChanged = true;
9336 }
9337 return changed;
9338 }
9339
9340 /**
9341 * Finalize inflating a view from XML. This is called as the last phase
9342 * of inflation, after all child views have been added.
9343 *
9344 * <p>Even if the subclass overrides onFinishInflate, they should always be
9345 * sure to call the super method, so that we get called.
9346 */
9347 protected void onFinishInflate() {
9348 }
9349
9350 /**
9351 * Returns the resources associated with this view.
9352 *
9353 * @return Resources object.
9354 */
9355 public Resources getResources() {
9356 return mResources;
9357 }
9358
9359 /**
9360 * Invalidates the specified Drawable.
9361 *
9362 * @param drawable the drawable to invalidate
9363 */
9364 public void invalidateDrawable(Drawable drawable) {
9365 if (verifyDrawable(drawable)) {
9366 final Rect dirty = drawable.getBounds();
9367 final int scrollX = mScrollX;
9368 final int scrollY = mScrollY;
9369
9370 invalidate(dirty.left + scrollX, dirty.top + scrollY,
9371 dirty.right + scrollX, dirty.bottom + scrollY);
9372 }
9373 }
9374
9375 /**
9376 * Schedules an action on a drawable to occur at a specified time.
9377 *
9378 * @param who the recipient of the action
9379 * @param what the action to run on the drawable
9380 * @param when the time at which the action must occur. Uses the
9381 * {@link SystemClock#uptimeMillis} timebase.
9382 */
9383 public void scheduleDrawable(Drawable who, Runnable what, long when) {
9384 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
9385 mAttachInfo.mHandler.postAtTime(what, who, when);
9386 }
9387 }
9388
9389 /**
9390 * Cancels a scheduled action on a drawable.
9391 *
9392 * @param who the recipient of the action
9393 * @param what the action to cancel
9394 */
9395 public void unscheduleDrawable(Drawable who, Runnable what) {
9396 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
9397 mAttachInfo.mHandler.removeCallbacks(what, who);
9398 }
9399 }
9400
9401 /**
9402 * Unschedule any events associated with the given Drawable. This can be
9403 * used when selecting a new Drawable into a view, so that the previous
9404 * one is completely unscheduled.
9405 *
9406 * @param who The Drawable to unschedule.
9407 *
9408 * @see #drawableStateChanged
9409 */
9410 public void unscheduleDrawable(Drawable who) {
9411 if (mAttachInfo != null) {
9412 mAttachInfo.mHandler.removeCallbacksAndMessages(who);
9413 }
9414 }
9415
9416 /**
9417 * If your view subclass is displaying its own Drawable objects, it should
9418 * override this function and return true for any Drawable it is
9419 * displaying. This allows animations for those drawables to be
9420 * scheduled.
9421 *
9422 * <p>Be sure to call through to the super class when overriding this
9423 * function.
9424 *
9425 * @param who The Drawable to verify. Return true if it is one you are
9426 * displaying, else return the result of calling through to the
9427 * super class.
9428 *
9429 * @return boolean If true than the Drawable is being displayed in the
9430 * view; else false and it is not allowed to animate.
9431 *
9432 * @see #unscheduleDrawable
9433 * @see #drawableStateChanged
9434 */
9435 protected boolean verifyDrawable(Drawable who) {
9436 return who == mBGDrawable;
9437 }
9438
9439 /**
9440 * This function is called whenever the state of the view changes in such
9441 * a way that it impacts the state of drawables being shown.
9442 *
9443 * <p>Be sure to call through to the superclass when overriding this
9444 * function.
9445 *
9446 * @see Drawable#setState
9447 */
9448 protected void drawableStateChanged() {
9449 Drawable d = mBGDrawable;
9450 if (d != null && d.isStateful()) {
9451 d.setState(getDrawableState());
9452 }
9453 }
9454
9455 /**
9456 * Call this to force a view to update its drawable state. This will cause
9457 * drawableStateChanged to be called on this view. Views that are interested
9458 * in the new state should call getDrawableState.
9459 *
9460 * @see #drawableStateChanged
9461 * @see #getDrawableState
9462 */
9463 public void refreshDrawableState() {
9464 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
9465 drawableStateChanged();
9466
9467 ViewParent parent = mParent;
9468 if (parent != null) {
9469 parent.childDrawableStateChanged(this);
9470 }
9471 }
9472
9473 /**
9474 * Return an array of resource IDs of the drawable states representing the
9475 * current state of the view.
9476 *
9477 * @return The current drawable state
9478 *
9479 * @see Drawable#setState
9480 * @see #drawableStateChanged
9481 * @see #onCreateDrawableState
9482 */
9483 public final int[] getDrawableState() {
9484 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
9485 return mDrawableState;
9486 } else {
9487 mDrawableState = onCreateDrawableState(0);
9488 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
9489 return mDrawableState;
9490 }
9491 }
9492
9493 /**
9494 * Generate the new {@link android.graphics.drawable.Drawable} state for
9495 * this view. This is called by the view
9496 * system when the cached Drawable state is determined to be invalid. To
9497 * retrieve the current state, you should use {@link #getDrawableState}.
9498 *
9499 * @param extraSpace if non-zero, this is the number of extra entries you
9500 * would like in the returned array in which you can place your own
9501 * states.
9502 *
9503 * @return Returns an array holding the current {@link Drawable} state of
9504 * the view.
9505 *
9506 * @see #mergeDrawableStates
9507 */
9508 protected int[] onCreateDrawableState(int extraSpace) {
9509 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
9510 mParent instanceof View) {
9511 return ((View) mParent).onCreateDrawableState(extraSpace);
9512 }
9513
9514 int[] drawableState;
9515
9516 int privateFlags = mPrivateFlags;
9517
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009518 int viewStateIndex = 0;
9519 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
9520 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
9521 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -07009522 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009523 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
9524 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08009525 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested) {
9526 // This is set if HW acceleration is requested, even if the current
9527 // process doesn't allow it. This is just to allow app preview
9528 // windows to better match their app.
9529 viewStateIndex |= VIEW_STATE_ACCELERATED;
9530 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009531
9532 drawableState = VIEW_STATE_SETS[viewStateIndex];
9533
9534 //noinspection ConstantIfStatement
9535 if (false) {
9536 Log.i("View", "drawableStateIndex=" + viewStateIndex);
9537 Log.i("View", toString()
9538 + " pressed=" + ((privateFlags & PRESSED) != 0)
9539 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
9540 + " fo=" + hasFocus()
9541 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009542 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009543 + ": " + Arrays.toString(drawableState));
9544 }
9545
9546 if (extraSpace == 0) {
9547 return drawableState;
9548 }
9549
9550 final int[] fullState;
9551 if (drawableState != null) {
9552 fullState = new int[drawableState.length + extraSpace];
9553 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
9554 } else {
9555 fullState = new int[extraSpace];
9556 }
9557
9558 return fullState;
9559 }
9560
9561 /**
9562 * Merge your own state values in <var>additionalState</var> into the base
9563 * state values <var>baseState</var> that were returned by
9564 * {@link #onCreateDrawableState}.
9565 *
9566 * @param baseState The base state values returned by
9567 * {@link #onCreateDrawableState}, which will be modified to also hold your
9568 * own additional state values.
9569 *
9570 * @param additionalState The additional state values you would like
9571 * added to <var>baseState</var>; this array is not modified.
9572 *
9573 * @return As a convenience, the <var>baseState</var> array you originally
9574 * passed into the function is returned.
9575 *
9576 * @see #onCreateDrawableState
9577 */
9578 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
9579 final int N = baseState.length;
9580 int i = N - 1;
9581 while (i >= 0 && baseState[i] == 0) {
9582 i--;
9583 }
9584 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
9585 return baseState;
9586 }
9587
9588 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -07009589 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
9590 * on all Drawable objects associated with this view.
9591 */
9592 public void jumpDrawablesToCurrentState() {
9593 if (mBGDrawable != null) {
9594 mBGDrawable.jumpToCurrentState();
9595 }
9596 }
9597
9598 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009599 * Sets the background color for this view.
9600 * @param color the color of the background
9601 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00009602 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009603 public void setBackgroundColor(int color) {
Chet Haase70d4ba12010-10-06 09:46:45 -07009604 if (mBGDrawable instanceof ColorDrawable) {
9605 ((ColorDrawable) mBGDrawable).setColor(color);
9606 } else {
9607 setBackgroundDrawable(new ColorDrawable(color));
9608 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009609 }
9610
9611 /**
9612 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -07009613 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009614 * @param resid The identifier of the resource.
9615 * @attr ref android.R.styleable#View_background
9616 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00009617 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009618 public void setBackgroundResource(int resid) {
9619 if (resid != 0 && resid == mBackgroundResource) {
9620 return;
9621 }
9622
9623 Drawable d= null;
9624 if (resid != 0) {
9625 d = mResources.getDrawable(resid);
9626 }
9627 setBackgroundDrawable(d);
9628
9629 mBackgroundResource = resid;
9630 }
9631
9632 /**
9633 * Set the background to a given Drawable, or remove the background. If the
9634 * background has padding, this View's padding is set to the background's
9635 * padding. However, when a background is removed, this View's padding isn't
9636 * touched. If setting the padding is desired, please use
9637 * {@link #setPadding(int, int, int, int)}.
9638 *
9639 * @param d The Drawable to use as the background, or null to remove the
9640 * background
9641 */
9642 public void setBackgroundDrawable(Drawable d) {
9643 boolean requestLayout = false;
9644
9645 mBackgroundResource = 0;
9646
9647 /*
9648 * Regardless of whether we're setting a new background or not, we want
9649 * to clear the previous drawable.
9650 */
9651 if (mBGDrawable != null) {
9652 mBGDrawable.setCallback(null);
9653 unscheduleDrawable(mBGDrawable);
9654 }
9655
9656 if (d != null) {
9657 Rect padding = sThreadLocal.get();
9658 if (padding == null) {
9659 padding = new Rect();
9660 sThreadLocal.set(padding);
9661 }
9662 if (d.getPadding(padding)) {
9663 setPadding(padding.left, padding.top, padding.right, padding.bottom);
9664 }
9665
9666 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
9667 // if it has a different minimum size, we should layout again
9668 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() ||
9669 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) {
9670 requestLayout = true;
9671 }
9672
9673 d.setCallback(this);
9674 if (d.isStateful()) {
9675 d.setState(getDrawableState());
9676 }
9677 d.setVisible(getVisibility() == VISIBLE, false);
9678 mBGDrawable = d;
9679
9680 if ((mPrivateFlags & SKIP_DRAW) != 0) {
9681 mPrivateFlags &= ~SKIP_DRAW;
9682 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
9683 requestLayout = true;
9684 }
9685 } else {
9686 /* Remove the background */
9687 mBGDrawable = null;
9688
9689 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
9690 /*
9691 * This view ONLY drew the background before and we're removing
9692 * the background, so now it won't draw anything
9693 * (hence we SKIP_DRAW)
9694 */
9695 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
9696 mPrivateFlags |= SKIP_DRAW;
9697 }
9698
9699 /*
9700 * When the background is set, we try to apply its padding to this
9701 * View. When the background is removed, we don't touch this View's
9702 * padding. This is noted in the Javadocs. Hence, we don't need to
9703 * requestLayout(), the invalidate() below is sufficient.
9704 */
9705
9706 // The old background's minimum size could have affected this
9707 // View's layout, so let's requestLayout
9708 requestLayout = true;
9709 }
9710
Romain Guy8f1344f52009-05-15 16:03:59 -07009711 computeOpaqueFlags();
9712
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009713 if (requestLayout) {
9714 requestLayout();
9715 }
9716
9717 mBackgroundSizeChanged = true;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009718 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009719 }
9720
9721 /**
9722 * Gets the background drawable
9723 * @return The drawable used as the background for this view, if any.
9724 */
9725 public Drawable getBackground() {
9726 return mBGDrawable;
9727 }
9728
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009729 /**
9730 * Sets the padding. The view may add on the space required to display
9731 * the scrollbars, depending on the style and visibility of the scrollbars.
9732 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
9733 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
9734 * from the values set in this call.
9735 *
9736 * @attr ref android.R.styleable#View_padding
9737 * @attr ref android.R.styleable#View_paddingBottom
9738 * @attr ref android.R.styleable#View_paddingLeft
9739 * @attr ref android.R.styleable#View_paddingRight
9740 * @attr ref android.R.styleable#View_paddingTop
9741 * @param left the left padding in pixels
9742 * @param top the top padding in pixels
9743 * @param right the right padding in pixels
9744 * @param bottom the bottom padding in pixels
9745 */
9746 public void setPadding(int left, int top, int right, int bottom) {
9747 boolean changed = false;
9748
Adam Powell20232d02010-12-08 21:08:53 -08009749 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009750 mUserPaddingRight = right;
9751 mUserPaddingBottom = bottom;
9752
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009753 final int viewFlags = mViewFlags;
Romain Guy8506ab42009-06-11 17:35:47 -07009754
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009755 // Common case is there are no scroll bars.
9756 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009757 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -08009758 // TODO Determine what to do with SCROLLBAR_POSITION_DEFAULT based on RTL settings.
9759 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009760 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -08009761 switch (mVerticalScrollbarPosition) {
9762 case SCROLLBAR_POSITION_DEFAULT:
9763 case SCROLLBAR_POSITION_RIGHT:
9764 right += offset;
9765 break;
9766 case SCROLLBAR_POSITION_LEFT:
9767 left += offset;
9768 break;
9769 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009770 }
Adam Powell20232d02010-12-08 21:08:53 -08009771 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009772 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
9773 ? 0 : getHorizontalScrollbarHeight();
9774 }
9775 }
Romain Guy8506ab42009-06-11 17:35:47 -07009776
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009777 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009778 changed = true;
9779 mPaddingLeft = left;
9780 }
9781 if (mPaddingTop != top) {
9782 changed = true;
9783 mPaddingTop = top;
9784 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009785 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009786 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009787 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009788 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009789 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009790 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009791 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009792 }
9793
9794 if (changed) {
9795 requestLayout();
9796 }
9797 }
9798
9799 /**
9800 * Returns the top padding of this view.
9801 *
9802 * @return the top padding in pixels
9803 */
9804 public int getPaddingTop() {
9805 return mPaddingTop;
9806 }
9807
9808 /**
9809 * Returns the bottom padding of this view. If there are inset and enabled
9810 * scrollbars, this value may include the space required to display the
9811 * scrollbars as well.
9812 *
9813 * @return the bottom padding in pixels
9814 */
9815 public int getPaddingBottom() {
9816 return mPaddingBottom;
9817 }
9818
9819 /**
9820 * Returns the left padding of this view. If there are inset and enabled
9821 * scrollbars, this value may include the space required to display the
9822 * scrollbars as well.
9823 *
9824 * @return the left padding in pixels
9825 */
9826 public int getPaddingLeft() {
9827 return mPaddingLeft;
9828 }
9829
9830 /**
9831 * Returns the right padding of this view. If there are inset and enabled
9832 * scrollbars, this value may include the space required to display the
9833 * scrollbars as well.
9834 *
9835 * @return the right padding in pixels
9836 */
9837 public int getPaddingRight() {
9838 return mPaddingRight;
9839 }
9840
9841 /**
9842 * Changes the selection state of this view. A view can be selected or not.
9843 * Note that selection is not the same as focus. Views are typically
9844 * selected in the context of an AdapterView like ListView or GridView;
9845 * the selected view is the view that is highlighted.
9846 *
9847 * @param selected true if the view must be selected, false otherwise
9848 */
9849 public void setSelected(boolean selected) {
9850 if (((mPrivateFlags & SELECTED) != 0) != selected) {
9851 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -07009852 if (!selected) resetPressedState();
Romain Guy0fd89bf2011-01-26 15:41:30 -08009853 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009854 refreshDrawableState();
9855 dispatchSetSelected(selected);
9856 }
9857 }
9858
9859 /**
9860 * Dispatch setSelected to all of this View's children.
9861 *
9862 * @see #setSelected(boolean)
9863 *
9864 * @param selected The new selected state
9865 */
9866 protected void dispatchSetSelected(boolean selected) {
9867 }
9868
9869 /**
9870 * Indicates the selection state of this view.
9871 *
9872 * @return true if the view is selected, false otherwise
9873 */
9874 @ViewDebug.ExportedProperty
9875 public boolean isSelected() {
9876 return (mPrivateFlags & SELECTED) != 0;
9877 }
9878
9879 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009880 * Changes the activated state of this view. A view can be activated or not.
9881 * Note that activation is not the same as selection. Selection is
9882 * a transient property, representing the view (hierarchy) the user is
9883 * currently interacting with. Activation is a longer-term state that the
9884 * user can move views in and out of. For example, in a list view with
9885 * single or multiple selection enabled, the views in the current selection
9886 * set are activated. (Um, yeah, we are deeply sorry about the terminology
9887 * here.) The activated state is propagated down to children of the view it
9888 * is set on.
9889 *
9890 * @param activated true if the view must be activated, false otherwise
9891 */
9892 public void setActivated(boolean activated) {
9893 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
9894 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
Romain Guy0fd89bf2011-01-26 15:41:30 -08009895 invalidate(true);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009896 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -07009897 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009898 }
9899 }
9900
9901 /**
9902 * Dispatch setActivated to all of this View's children.
9903 *
9904 * @see #setActivated(boolean)
9905 *
9906 * @param activated The new activated state
9907 */
9908 protected void dispatchSetActivated(boolean activated) {
9909 }
9910
9911 /**
9912 * Indicates the activation state of this view.
9913 *
9914 * @return true if the view is activated, false otherwise
9915 */
9916 @ViewDebug.ExportedProperty
9917 public boolean isActivated() {
9918 return (mPrivateFlags & ACTIVATED) != 0;
9919 }
9920
9921 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009922 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
9923 * observer can be used to get notifications when global events, like
9924 * layout, happen.
9925 *
9926 * The returned ViewTreeObserver observer is not guaranteed to remain
9927 * valid for the lifetime of this View. If the caller of this method keeps
9928 * a long-lived reference to ViewTreeObserver, it should always check for
9929 * the return value of {@link ViewTreeObserver#isAlive()}.
9930 *
9931 * @return The ViewTreeObserver for this view's hierarchy.
9932 */
9933 public ViewTreeObserver getViewTreeObserver() {
9934 if (mAttachInfo != null) {
9935 return mAttachInfo.mTreeObserver;
9936 }
9937 if (mFloatingTreeObserver == null) {
9938 mFloatingTreeObserver = new ViewTreeObserver();
9939 }
9940 return mFloatingTreeObserver;
9941 }
9942
9943 /**
9944 * <p>Finds the topmost view in the current view hierarchy.</p>
9945 *
9946 * @return the topmost view containing this view
9947 */
9948 public View getRootView() {
9949 if (mAttachInfo != null) {
9950 final View v = mAttachInfo.mRootView;
9951 if (v != null) {
9952 return v;
9953 }
9954 }
Romain Guy8506ab42009-06-11 17:35:47 -07009955
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009956 View parent = this;
9957
9958 while (parent.mParent != null && parent.mParent instanceof View) {
9959 parent = (View) parent.mParent;
9960 }
9961
9962 return parent;
9963 }
9964
9965 /**
9966 * <p>Computes the coordinates of this view on the screen. The argument
9967 * must be an array of two integers. After the method returns, the array
9968 * contains the x and y location in that order.</p>
9969 *
9970 * @param location an array of two integers in which to hold the coordinates
9971 */
9972 public void getLocationOnScreen(int[] location) {
9973 getLocationInWindow(location);
9974
9975 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -07009976 if (info != null) {
9977 location[0] += info.mWindowLeft;
9978 location[1] += info.mWindowTop;
9979 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009980 }
9981
9982 /**
9983 * <p>Computes the coordinates of this view in its window. The argument
9984 * must be an array of two integers. After the method returns, the array
9985 * contains the x and y location in that order.</p>
9986 *
9987 * @param location an array of two integers in which to hold the coordinates
9988 */
9989 public void getLocationInWindow(int[] location) {
9990 if (location == null || location.length < 2) {
9991 throw new IllegalArgumentException("location must be an array of "
9992 + "two integers");
9993 }
9994
Michael Jurka4d2bd4c2010-11-30 18:15:11 -08009995 location[0] = mLeft + (int) (mTranslationX + 0.5f);
9996 location[1] = mTop + (int) (mTranslationY + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009997
9998 ViewParent viewParent = mParent;
9999 while (viewParent instanceof View) {
10000 final View view = (View)viewParent;
Michael Jurka4d2bd4c2010-11-30 18:15:11 -080010001 location[0] += view.mLeft + (int) (view.mTranslationX + 0.5f) - view.mScrollX;
10002 location[1] += view.mTop + (int) (view.mTranslationY + 0.5f) - view.mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010003 viewParent = view.mParent;
10004 }
Romain Guy8506ab42009-06-11 17:35:47 -070010005
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010006 if (viewParent instanceof ViewRoot) {
10007 // *cough*
10008 final ViewRoot vr = (ViewRoot)viewParent;
10009 location[1] -= vr.mCurScrollY;
10010 }
10011 }
10012
10013 /**
10014 * {@hide}
10015 * @param id the id of the view to be found
10016 * @return the view of the specified id, null if cannot be found
10017 */
10018 protected View findViewTraversal(int id) {
10019 if (id == mID) {
10020 return this;
10021 }
10022 return null;
10023 }
10024
10025 /**
10026 * {@hide}
10027 * @param tag the tag of the view to be found
10028 * @return the view of specified tag, null if cannot be found
10029 */
10030 protected View findViewWithTagTraversal(Object tag) {
10031 if (tag != null && tag.equals(mTag)) {
10032 return this;
10033 }
10034 return null;
10035 }
10036
10037 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080010038 * {@hide}
10039 * @param predicate The predicate to evaluate.
10040 * @return The first view that matches the predicate or null.
10041 */
10042 protected View findViewByPredicateTraversal(Predicate<View> predicate) {
10043 if (predicate.apply(this)) {
10044 return this;
10045 }
10046 return null;
10047 }
10048
10049 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010050 * Look for a child view with the given id. If this view has the given
10051 * id, return this view.
10052 *
10053 * @param id The id to search for.
10054 * @return The view that has the given id in the hierarchy or null
10055 */
10056 public final View findViewById(int id) {
10057 if (id < 0) {
10058 return null;
10059 }
10060 return findViewTraversal(id);
10061 }
10062
10063 /**
10064 * Look for a child view with the given tag. If this view has the given
10065 * tag, return this view.
10066 *
10067 * @param tag The tag to search for, using "tag.equals(getTag())".
10068 * @return The View that has the given tag in the hierarchy or null
10069 */
10070 public final View findViewWithTag(Object tag) {
10071 if (tag == null) {
10072 return null;
10073 }
10074 return findViewWithTagTraversal(tag);
10075 }
10076
10077 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080010078 * {@hide}
10079 * Look for a child view that matches the specified predicate.
10080 * If this view matches the predicate, return this view.
10081 *
10082 * @param predicate The predicate to evaluate.
10083 * @return The first view that matches the predicate or null.
10084 */
10085 public final View findViewByPredicate(Predicate<View> predicate) {
10086 return findViewByPredicateTraversal(predicate);
10087 }
10088
10089 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010090 * Sets the identifier for this view. The identifier does not have to be
10091 * unique in this view's hierarchy. The identifier should be a positive
10092 * number.
10093 *
10094 * @see #NO_ID
10095 * @see #getId
10096 * @see #findViewById
10097 *
10098 * @param id a number used to identify the view
10099 *
10100 * @attr ref android.R.styleable#View_id
10101 */
10102 public void setId(int id) {
10103 mID = id;
10104 }
10105
10106 /**
10107 * {@hide}
10108 *
10109 * @param isRoot true if the view belongs to the root namespace, false
10110 * otherwise
10111 */
10112 public void setIsRootNamespace(boolean isRoot) {
10113 if (isRoot) {
10114 mPrivateFlags |= IS_ROOT_NAMESPACE;
10115 } else {
10116 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
10117 }
10118 }
10119
10120 /**
10121 * {@hide}
10122 *
10123 * @return true if the view belongs to the root namespace, false otherwise
10124 */
10125 public boolean isRootNamespace() {
10126 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
10127 }
10128
10129 /**
10130 * Returns this view's identifier.
10131 *
10132 * @return a positive integer used to identify the view or {@link #NO_ID}
10133 * if the view has no ID
10134 *
10135 * @see #setId
10136 * @see #findViewById
10137 * @attr ref android.R.styleable#View_id
10138 */
10139 @ViewDebug.CapturedViewProperty
10140 public int getId() {
10141 return mID;
10142 }
10143
10144 /**
10145 * Returns this view's tag.
10146 *
10147 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -070010148 *
10149 * @see #setTag(Object)
10150 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010151 */
10152 @ViewDebug.ExportedProperty
10153 public Object getTag() {
10154 return mTag;
10155 }
10156
10157 /**
10158 * Sets the tag associated with this view. A tag can be used to mark
10159 * a view in its hierarchy and does not have to be unique within the
10160 * hierarchy. Tags can also be used to store data within a view without
10161 * resorting to another data structure.
10162 *
10163 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -070010164 *
10165 * @see #getTag()
10166 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010167 */
10168 public void setTag(final Object tag) {
10169 mTag = tag;
10170 }
10171
10172 /**
Romain Guyd90a3312009-05-06 14:54:28 -070010173 * Returns the tag associated with this view and the specified key.
10174 *
10175 * @param key The key identifying the tag
10176 *
10177 * @return the Object stored in this view as a tag
10178 *
10179 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -070010180 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -070010181 */
10182 public Object getTag(int key) {
10183 SparseArray<Object> tags = null;
10184 synchronized (sTagsLock) {
10185 if (sTags != null) {
10186 tags = sTags.get(this);
10187 }
10188 }
10189
10190 if (tags != null) return tags.get(key);
10191 return null;
10192 }
10193
10194 /**
10195 * Sets a tag associated with this view and a key. A tag can be used
10196 * to mark a view in its hierarchy and does not have to be unique within
10197 * the hierarchy. Tags can also be used to store data within a view
10198 * without resorting to another data structure.
10199 *
10200 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -070010201 * application to ensure it is unique (see the <a
10202 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
10203 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -070010204 * the Android framework or not associated with any package will cause
10205 * an {@link IllegalArgumentException} to be thrown.
10206 *
10207 * @param key The key identifying the tag
10208 * @param tag An Object to tag the view with
10209 *
10210 * @throws IllegalArgumentException If they specified key is not valid
10211 *
10212 * @see #setTag(Object)
10213 * @see #getTag(int)
10214 */
10215 public void setTag(int key, final Object tag) {
10216 // If the package id is 0x00 or 0x01, it's either an undefined package
10217 // or a framework id
10218 if ((key >>> 24) < 2) {
10219 throw new IllegalArgumentException("The key must be an application-specific "
10220 + "resource id.");
10221 }
10222
10223 setTagInternal(this, key, tag);
10224 }
10225
10226 /**
10227 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
10228 * framework id.
10229 *
10230 * @hide
10231 */
10232 public void setTagInternal(int key, Object tag) {
10233 if ((key >>> 24) != 0x1) {
10234 throw new IllegalArgumentException("The key must be a framework-specific "
10235 + "resource id.");
10236 }
10237
Romain Guy8506ab42009-06-11 17:35:47 -070010238 setTagInternal(this, key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070010239 }
10240
10241 private static void setTagInternal(View view, int key, Object tag) {
10242 SparseArray<Object> tags = null;
10243 synchronized (sTagsLock) {
10244 if (sTags == null) {
10245 sTags = new WeakHashMap<View, SparseArray<Object>>();
10246 } else {
10247 tags = sTags.get(view);
10248 }
10249 }
10250
10251 if (tags == null) {
10252 tags = new SparseArray<Object>(2);
10253 synchronized (sTagsLock) {
10254 sTags.put(view, tags);
10255 }
10256 }
10257
10258 tags.put(key, tag);
10259 }
10260
10261 /**
Romain Guy13922e02009-05-12 17:56:14 -070010262 * @param consistency The type of consistency. See ViewDebug for more information.
10263 *
10264 * @hide
10265 */
10266 protected boolean dispatchConsistencyCheck(int consistency) {
10267 return onConsistencyCheck(consistency);
10268 }
10269
10270 /**
10271 * Method that subclasses should implement to check their consistency. The type of
10272 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -070010273 *
Romain Guy13922e02009-05-12 17:56:14 -070010274 * @param consistency The type of consistency. See ViewDebug for more information.
10275 *
10276 * @throws IllegalStateException if the view is in an inconsistent state.
10277 *
10278 * @hide
10279 */
10280 protected boolean onConsistencyCheck(int consistency) {
10281 boolean result = true;
10282
10283 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
10284 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
10285
10286 if (checkLayout) {
10287 if (getParent() == null) {
10288 result = false;
10289 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10290 "View " + this + " does not have a parent.");
10291 }
10292
10293 if (mAttachInfo == null) {
10294 result = false;
10295 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10296 "View " + this + " is not attached to a window.");
10297 }
10298 }
10299
10300 if (checkDrawing) {
10301 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
10302 // from their draw() method
10303
10304 if ((mPrivateFlags & DRAWN) != DRAWN &&
10305 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
10306 result = false;
10307 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10308 "View " + this + " was invalidated but its drawing cache is valid.");
10309 }
10310 }
10311
10312 return result;
10313 }
10314
10315 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010316 * Prints information about this view in the log output, with the tag
10317 * {@link #VIEW_LOG_TAG}.
10318 *
10319 * @hide
10320 */
10321 public void debug() {
10322 debug(0);
10323 }
10324
10325 /**
10326 * Prints information about this view in the log output, with the tag
10327 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
10328 * indentation defined by the <code>depth</code>.
10329 *
10330 * @param depth the indentation level
10331 *
10332 * @hide
10333 */
10334 protected void debug(int depth) {
10335 String output = debugIndent(depth - 1);
10336
10337 output += "+ " + this;
10338 int id = getId();
10339 if (id != -1) {
10340 output += " (id=" + id + ")";
10341 }
10342 Object tag = getTag();
10343 if (tag != null) {
10344 output += " (tag=" + tag + ")";
10345 }
10346 Log.d(VIEW_LOG_TAG, output);
10347
10348 if ((mPrivateFlags & FOCUSED) != 0) {
10349 output = debugIndent(depth) + " FOCUSED";
10350 Log.d(VIEW_LOG_TAG, output);
10351 }
10352
10353 output = debugIndent(depth);
10354 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
10355 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
10356 + "} ";
10357 Log.d(VIEW_LOG_TAG, output);
10358
10359 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
10360 || mPaddingBottom != 0) {
10361 output = debugIndent(depth);
10362 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
10363 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
10364 Log.d(VIEW_LOG_TAG, output);
10365 }
10366
10367 output = debugIndent(depth);
10368 output += "mMeasureWidth=" + mMeasuredWidth +
10369 " mMeasureHeight=" + mMeasuredHeight;
10370 Log.d(VIEW_LOG_TAG, output);
10371
10372 output = debugIndent(depth);
10373 if (mLayoutParams == null) {
10374 output += "BAD! no layout params";
10375 } else {
10376 output = mLayoutParams.debug(output);
10377 }
10378 Log.d(VIEW_LOG_TAG, output);
10379
10380 output = debugIndent(depth);
10381 output += "flags={";
10382 output += View.printFlags(mViewFlags);
10383 output += "}";
10384 Log.d(VIEW_LOG_TAG, output);
10385
10386 output = debugIndent(depth);
10387 output += "privateFlags={";
10388 output += View.printPrivateFlags(mPrivateFlags);
10389 output += "}";
10390 Log.d(VIEW_LOG_TAG, output);
10391 }
10392
10393 /**
10394 * Creates an string of whitespaces used for indentation.
10395 *
10396 * @param depth the indentation level
10397 * @return a String containing (depth * 2 + 3) * 2 white spaces
10398 *
10399 * @hide
10400 */
10401 protected static String debugIndent(int depth) {
10402 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
10403 for (int i = 0; i < (depth * 2) + 3; i++) {
10404 spaces.append(' ').append(' ');
10405 }
10406 return spaces.toString();
10407 }
10408
10409 /**
10410 * <p>Return the offset of the widget's text baseline from the widget's top
10411 * boundary. If this widget does not support baseline alignment, this
10412 * method returns -1. </p>
10413 *
10414 * @return the offset of the baseline within the widget's bounds or -1
10415 * if baseline alignment is not supported
10416 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070010417 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010418 public int getBaseline() {
10419 return -1;
10420 }
10421
10422 /**
10423 * Call this when something has changed which has invalidated the
10424 * layout of this view. This will schedule a layout pass of the view
10425 * tree.
10426 */
10427 public void requestLayout() {
10428 if (ViewDebug.TRACE_HIERARCHY) {
10429 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
10430 }
10431
10432 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080010433 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010434
10435 if (mParent != null && !mParent.isLayoutRequested()) {
10436 mParent.requestLayout();
10437 }
10438 }
10439
10440 /**
10441 * Forces this view to be laid out during the next layout pass.
10442 * This method does not call requestLayout() or forceLayout()
10443 * on the parent.
10444 */
10445 public void forceLayout() {
10446 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080010447 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010448 }
10449
10450 /**
10451 * <p>
10452 * This is called to find out how big a view should be. The parent
10453 * supplies constraint information in the width and height parameters.
10454 * </p>
10455 *
10456 * <p>
10457 * The actual mesurement work of a view is performed in
10458 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
10459 * {@link #onMeasure(int, int)} can and must be overriden by subclasses.
10460 * </p>
10461 *
10462 *
10463 * @param widthMeasureSpec Horizontal space requirements as imposed by the
10464 * parent
10465 * @param heightMeasureSpec Vertical space requirements as imposed by the
10466 * parent
10467 *
10468 * @see #onMeasure(int, int)
10469 */
10470 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
10471 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
10472 widthMeasureSpec != mOldWidthMeasureSpec ||
10473 heightMeasureSpec != mOldHeightMeasureSpec) {
10474
10475 // first clears the measured dimension flag
10476 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
10477
10478 if (ViewDebug.TRACE_HIERARCHY) {
10479 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
10480 }
10481
10482 // measure ourselves, this should set the measured dimension flag back
10483 onMeasure(widthMeasureSpec, heightMeasureSpec);
10484
10485 // flag not set, setMeasuredDimension() was not invoked, we raise
10486 // an exception to warn the developer
10487 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
10488 throw new IllegalStateException("onMeasure() did not set the"
10489 + " measured dimension by calling"
10490 + " setMeasuredDimension()");
10491 }
10492
10493 mPrivateFlags |= LAYOUT_REQUIRED;
10494 }
10495
10496 mOldWidthMeasureSpec = widthMeasureSpec;
10497 mOldHeightMeasureSpec = heightMeasureSpec;
10498 }
10499
10500 /**
10501 * <p>
10502 * Measure the view and its content to determine the measured width and the
10503 * measured height. This method is invoked by {@link #measure(int, int)} and
10504 * should be overriden by subclasses to provide accurate and efficient
10505 * measurement of their contents.
10506 * </p>
10507 *
10508 * <p>
10509 * <strong>CONTRACT:</strong> When overriding this method, you
10510 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
10511 * measured width and height of this view. Failure to do so will trigger an
10512 * <code>IllegalStateException</code>, thrown by
10513 * {@link #measure(int, int)}. Calling the superclass'
10514 * {@link #onMeasure(int, int)} is a valid use.
10515 * </p>
10516 *
10517 * <p>
10518 * The base class implementation of measure defaults to the background size,
10519 * unless a larger size is allowed by the MeasureSpec. Subclasses should
10520 * override {@link #onMeasure(int, int)} to provide better measurements of
10521 * their content.
10522 * </p>
10523 *
10524 * <p>
10525 * If this method is overridden, it is the subclass's responsibility to make
10526 * sure the measured height and width are at least the view's minimum height
10527 * and width ({@link #getSuggestedMinimumHeight()} and
10528 * {@link #getSuggestedMinimumWidth()}).
10529 * </p>
10530 *
10531 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
10532 * The requirements are encoded with
10533 * {@link android.view.View.MeasureSpec}.
10534 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
10535 * The requirements are encoded with
10536 * {@link android.view.View.MeasureSpec}.
10537 *
10538 * @see #getMeasuredWidth()
10539 * @see #getMeasuredHeight()
10540 * @see #setMeasuredDimension(int, int)
10541 * @see #getSuggestedMinimumHeight()
10542 * @see #getSuggestedMinimumWidth()
10543 * @see android.view.View.MeasureSpec#getMode(int)
10544 * @see android.view.View.MeasureSpec#getSize(int)
10545 */
10546 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
10547 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
10548 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
10549 }
10550
10551 /**
10552 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
10553 * measured width and measured height. Failing to do so will trigger an
10554 * exception at measurement time.</p>
10555 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080010556 * @param measuredWidth The measured width of this view. May be a complex
10557 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
10558 * {@link #MEASURED_STATE_TOO_SMALL}.
10559 * @param measuredHeight The measured height of this view. May be a complex
10560 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
10561 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010562 */
10563 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
10564 mMeasuredWidth = measuredWidth;
10565 mMeasuredHeight = measuredHeight;
10566
10567 mPrivateFlags |= MEASURED_DIMENSION_SET;
10568 }
10569
10570 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080010571 * Merge two states as returned by {@link #getMeasuredState()}.
10572 * @param curState The current state as returned from a view or the result
10573 * of combining multiple views.
10574 * @param newState The new view state to combine.
10575 * @return Returns a new integer reflecting the combination of the two
10576 * states.
10577 */
10578 public static int combineMeasuredStates(int curState, int newState) {
10579 return curState | newState;
10580 }
10581
10582 /**
10583 * Version of {@link #resolveSizeAndState(int, int, int)}
10584 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
10585 */
10586 public static int resolveSize(int size, int measureSpec) {
10587 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
10588 }
10589
10590 /**
10591 * Utility to reconcile a desired size and state, with constraints imposed
10592 * by a MeasureSpec. Will take the desired size, unless a different size
10593 * is imposed by the constraints. The returned value is a compound integer,
10594 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
10595 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
10596 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010597 *
10598 * @param size How big the view wants to be
10599 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080010600 * @return Size information bit mask as defined by
10601 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010602 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080010603 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010604 int result = size;
10605 int specMode = MeasureSpec.getMode(measureSpec);
10606 int specSize = MeasureSpec.getSize(measureSpec);
10607 switch (specMode) {
10608 case MeasureSpec.UNSPECIFIED:
10609 result = size;
10610 break;
10611 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080010612 if (specSize < size) {
10613 result = specSize | MEASURED_STATE_TOO_SMALL;
10614 } else {
10615 result = size;
10616 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010617 break;
10618 case MeasureSpec.EXACTLY:
10619 result = specSize;
10620 break;
10621 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080010622 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010623 }
10624
10625 /**
10626 * Utility to return a default size. Uses the supplied size if the
10627 * MeasureSpec imposed no contraints. Will get larger if allowed
10628 * by the MeasureSpec.
10629 *
10630 * @param size Default size for this view
10631 * @param measureSpec Constraints imposed by the parent
10632 * @return The size this view should be.
10633 */
10634 public static int getDefaultSize(int size, int measureSpec) {
10635 int result = size;
10636 int specMode = MeasureSpec.getMode(measureSpec);
10637 int specSize = MeasureSpec.getSize(measureSpec);
10638
10639 switch (specMode) {
10640 case MeasureSpec.UNSPECIFIED:
10641 result = size;
10642 break;
10643 case MeasureSpec.AT_MOST:
10644 case MeasureSpec.EXACTLY:
10645 result = specSize;
10646 break;
10647 }
10648 return result;
10649 }
10650
10651 /**
10652 * Returns the suggested minimum height that the view should use. This
10653 * returns the maximum of the view's minimum height
10654 * and the background's minimum height
10655 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
10656 * <p>
10657 * When being used in {@link #onMeasure(int, int)}, the caller should still
10658 * ensure the returned height is within the requirements of the parent.
10659 *
10660 * @return The suggested minimum height of the view.
10661 */
10662 protected int getSuggestedMinimumHeight() {
10663 int suggestedMinHeight = mMinHeight;
10664
10665 if (mBGDrawable != null) {
10666 final int bgMinHeight = mBGDrawable.getMinimumHeight();
10667 if (suggestedMinHeight < bgMinHeight) {
10668 suggestedMinHeight = bgMinHeight;
10669 }
10670 }
10671
10672 return suggestedMinHeight;
10673 }
10674
10675 /**
10676 * Returns the suggested minimum width that the view should use. This
10677 * returns the maximum of the view's minimum width)
10678 * and the background's minimum width
10679 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
10680 * <p>
10681 * When being used in {@link #onMeasure(int, int)}, the caller should still
10682 * ensure the returned width is within the requirements of the parent.
10683 *
10684 * @return The suggested minimum width of the view.
10685 */
10686 protected int getSuggestedMinimumWidth() {
10687 int suggestedMinWidth = mMinWidth;
10688
10689 if (mBGDrawable != null) {
10690 final int bgMinWidth = mBGDrawable.getMinimumWidth();
10691 if (suggestedMinWidth < bgMinWidth) {
10692 suggestedMinWidth = bgMinWidth;
10693 }
10694 }
10695
10696 return suggestedMinWidth;
10697 }
10698
10699 /**
10700 * Sets the minimum height of the view. It is not guaranteed the view will
10701 * be able to achieve this minimum height (for example, if its parent layout
10702 * constrains it with less available height).
10703 *
10704 * @param minHeight The minimum height the view will try to be.
10705 */
10706 public void setMinimumHeight(int minHeight) {
10707 mMinHeight = minHeight;
10708 }
10709
10710 /**
10711 * Sets the minimum width of the view. It is not guaranteed the view will
10712 * be able to achieve this minimum width (for example, if its parent layout
10713 * constrains it with less available width).
10714 *
10715 * @param minWidth The minimum width the view will try to be.
10716 */
10717 public void setMinimumWidth(int minWidth) {
10718 mMinWidth = minWidth;
10719 }
10720
10721 /**
10722 * Get the animation currently associated with this view.
10723 *
10724 * @return The animation that is currently playing or
10725 * scheduled to play for this view.
10726 */
10727 public Animation getAnimation() {
10728 return mCurrentAnimation;
10729 }
10730
10731 /**
10732 * Start the specified animation now.
10733 *
10734 * @param animation the animation to start now
10735 */
10736 public void startAnimation(Animation animation) {
10737 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
10738 setAnimation(animation);
Romain Guy0fd89bf2011-01-26 15:41:30 -080010739 invalidateParentCaches();
10740 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010741 }
10742
10743 /**
10744 * Cancels any animations for this view.
10745 */
10746 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080010747 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080010748 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080010749 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010750 mCurrentAnimation = null;
Romain Guy0fd89bf2011-01-26 15:41:30 -080010751 invalidateParentIfNeeded();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010752 }
10753
10754 /**
10755 * Sets the next animation to play for this view.
10756 * If you want the animation to play immediately, use
10757 * startAnimation. This method provides allows fine-grained
10758 * control over the start time and invalidation, but you
10759 * must make sure that 1) the animation has a start time set, and
10760 * 2) the view will be invalidated when the animation is supposed to
10761 * start.
10762 *
10763 * @param animation The next animation, or null.
10764 */
10765 public void setAnimation(Animation animation) {
10766 mCurrentAnimation = animation;
10767 if (animation != null) {
10768 animation.reset();
10769 }
10770 }
10771
10772 /**
10773 * Invoked by a parent ViewGroup to notify the start of the animation
10774 * currently associated with this view. If you override this method,
10775 * always call super.onAnimationStart();
10776 *
10777 * @see #setAnimation(android.view.animation.Animation)
10778 * @see #getAnimation()
10779 */
10780 protected void onAnimationStart() {
10781 mPrivateFlags |= ANIMATION_STARTED;
10782 }
10783
10784 /**
10785 * Invoked by a parent ViewGroup to notify the end of the animation
10786 * currently associated with this view. If you override this method,
10787 * always call super.onAnimationEnd();
10788 *
10789 * @see #setAnimation(android.view.animation.Animation)
10790 * @see #getAnimation()
10791 */
10792 protected void onAnimationEnd() {
10793 mPrivateFlags &= ~ANIMATION_STARTED;
10794 }
10795
10796 /**
10797 * Invoked if there is a Transform that involves alpha. Subclass that can
10798 * draw themselves with the specified alpha should return true, and then
10799 * respect that alpha when their onDraw() is called. If this returns false
10800 * then the view may be redirected to draw into an offscreen buffer to
10801 * fulfill the request, which will look fine, but may be slower than if the
10802 * subclass handles it internally. The default implementation returns false.
10803 *
10804 * @param alpha The alpha (0..255) to apply to the view's drawing
10805 * @return true if the view can draw with the specified alpha.
10806 */
10807 protected boolean onSetAlpha(int alpha) {
10808 return false;
10809 }
10810
10811 /**
10812 * This is used by the RootView to perform an optimization when
10813 * the view hierarchy contains one or several SurfaceView.
10814 * SurfaceView is always considered transparent, but its children are not,
10815 * therefore all View objects remove themselves from the global transparent
10816 * region (passed as a parameter to this function).
10817 *
10818 * @param region The transparent region for this ViewRoot (window).
10819 *
10820 * @return Returns true if the effective visibility of the view at this
10821 * point is opaque, regardless of the transparent region; returns false
10822 * if it is possible for underlying windows to be seen behind the view.
10823 *
10824 * {@hide}
10825 */
10826 public boolean gatherTransparentRegion(Region region) {
10827 final AttachInfo attachInfo = mAttachInfo;
10828 if (region != null && attachInfo != null) {
10829 final int pflags = mPrivateFlags;
10830 if ((pflags & SKIP_DRAW) == 0) {
10831 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
10832 // remove it from the transparent region.
10833 final int[] location = attachInfo.mTransparentLocation;
10834 getLocationInWindow(location);
10835 region.op(location[0], location[1], location[0] + mRight - mLeft,
10836 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
10837 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) {
10838 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
10839 // exists, so we remove the background drawable's non-transparent
10840 // parts from this transparent region.
10841 applyDrawableToTransparentRegion(mBGDrawable, region);
10842 }
10843 }
10844 return true;
10845 }
10846
10847 /**
10848 * Play a sound effect for this view.
10849 *
10850 * <p>The framework will play sound effects for some built in actions, such as
10851 * clicking, but you may wish to play these effects in your widget,
10852 * for instance, for internal navigation.
10853 *
10854 * <p>The sound effect will only be played if sound effects are enabled by the user, and
10855 * {@link #isSoundEffectsEnabled()} is true.
10856 *
10857 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
10858 */
10859 public void playSoundEffect(int soundConstant) {
10860 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
10861 return;
10862 }
10863 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
10864 }
10865
10866 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010867 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070010868 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010869 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010870 *
10871 * <p>The framework will provide haptic feedback for some built in actions,
10872 * such as long presses, but you may wish to provide feedback for your
10873 * own widget.
10874 *
10875 * <p>The feedback will only be performed if
10876 * {@link #isHapticFeedbackEnabled()} is true.
10877 *
10878 * @param feedbackConstant One of the constants defined in
10879 * {@link HapticFeedbackConstants}
10880 */
10881 public boolean performHapticFeedback(int feedbackConstant) {
10882 return performHapticFeedback(feedbackConstant, 0);
10883 }
10884
10885 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010886 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070010887 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010888 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010889 *
10890 * @param feedbackConstant One of the constants defined in
10891 * {@link HapticFeedbackConstants}
10892 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
10893 */
10894 public boolean performHapticFeedback(int feedbackConstant, int flags) {
10895 if (mAttachInfo == null) {
10896 return false;
10897 }
Romain Guyf607bdc2010-09-10 19:20:06 -070010898 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070010899 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010900 && !isHapticFeedbackEnabled()) {
10901 return false;
10902 }
Romain Guy812ccbe2010-06-01 14:07:24 -070010903 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
10904 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010905 }
10906
10907 /**
Joe Onorato664644d2011-01-23 17:53:23 -080010908 * Request that the visibility of the status bar be changed.
10909 */
10910 public void setSystemUiVisibility(int visibility) {
10911 if (visibility != mSystemUiVisibility) {
10912 mSystemUiVisibility = visibility;
10913 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
10914 mParent.recomputeViewAttributes(this);
10915 }
10916 }
10917 }
10918
10919 /**
10920 * Returns the status bar visibility that this view has requested.
10921 */
Joe Onoratoe595cad2011-01-24 09:22:12 -080010922 public int getSystemUiVisibility() {
Joe Onorato664644d2011-01-23 17:53:23 -080010923 return mSystemUiVisibility;
10924 }
10925
10926 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) {
10927 mOnSystemUiVisibilityChangeListener = l;
10928 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
10929 mParent.recomputeViewAttributes(this);
10930 }
10931 }
10932
10933 /**
10934 */
10935 public void dispatchSystemUiVisibilityChanged(int visibility) {
Joe Onorato14782f72011-01-25 19:53:17 -080010936 mSystemUiVisibility = visibility;
Joe Onorato664644d2011-01-23 17:53:23 -080010937 if (mOnSystemUiVisibilityChangeListener != null) {
Joe Onorato7bb8eeb2011-01-27 16:00:58 -080010938 mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange(
10939 visibility & ~PUBLIC_STATUS_BAR_VISIBILITY_MASK);
Joe Onorato664644d2011-01-23 17:53:23 -080010940 }
10941 }
10942
10943 /**
Christopher Tate2c095f32010-10-04 14:13:40 -070010944 * !!! TODO: real docs
10945 *
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010946 * The base class implementation makes the shadow the same size and appearance
Christopher Tate2c095f32010-10-04 14:13:40 -070010947 * as the view itself, and positions it with its center at the touch point.
10948 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010949 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070010950 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070010951
10952 /**
Christopher Tate17ed60c2011-01-18 12:50:26 -080010953 * Construct a shadow builder object for use with the given View object. The
10954 * default implementation will construct a drag shadow the same size and
10955 * appearance as the supplied View.
10956 *
10957 * @param view A view within the application's layout whose appearance
10958 * should be replicated as the drag shadow.
Christopher Tate2c095f32010-10-04 14:13:40 -070010959 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010960 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070010961 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070010962 }
10963
Christopher Tate17ed60c2011-01-18 12:50:26 -080010964 /**
10965 * Construct a shadow builder object with no associated View. This
10966 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)}
10967 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order
10968 * to supply the drag shadow's dimensions and appearance without
10969 * reference to any View object.
10970 */
10971 public DragShadowBuilder() {
10972 mView = new WeakReference<View>(null);
10973 }
10974
10975 /**
10976 * Returns the View object that had been passed to the
10977 * {@link #View.DragShadowBuilder(View)}
10978 * constructor. If that View parameter was {@code null} or if the
10979 * {@link #View.DragShadowBuilder()}
10980 * constructor was used to instantiate the builder object, this method will return
10981 * null.
10982 *
10983 * @return The View object associate with this builder object.
10984 */
Chris Tate6b391282010-10-14 15:48:59 -070010985 final public View getView() {
10986 return mView.get();
10987 }
10988
Christopher Tate2c095f32010-10-04 14:13:40 -070010989 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010990 * Provide the draggable-shadow metrics for the operation: the dimensions of
10991 * the shadow image itself, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070010992 * be centered under the touch location while dragging.
10993 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010994 * The default implementation sets the dimensions of the shadow to be the
Christopher Tate17ed60c2011-01-18 12:50:26 -080010995 * same as the dimensions of the View object that had been supplied to the
10996 * {@link #View.DragShadowBuilder(View)} constructor
10997 * when the builder object was instantiated, and centers the shadow under the touch
10998 * point.
Christopher Tate2c095f32010-10-04 14:13:40 -070010999 *
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011000 * @param shadowSize The application should set the {@code x} member of this
11001 * parameter to the desired shadow width, and the {@code y} member to
Christopher Tate2c095f32010-10-04 14:13:40 -070011002 * the desired height.
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011003 * @param shadowTouchPoint The application should set this point to be the
11004 * location within the shadow that should track directly underneath
Christopher Tate2c095f32010-10-04 14:13:40 -070011005 * the touch point on the screen during a drag.
11006 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011007 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070011008 final View view = mView.get();
11009 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011010 shadowSize.set(view.getWidth(), view.getHeight());
11011 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070011012 } else {
11013 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
11014 }
Christopher Tate2c095f32010-10-04 14:13:40 -070011015 }
11016
11017 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011018 * Draw the shadow image for the upcoming drag. The shadow canvas was
11019 * created with the dimensions supplied by the
11020 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate17ed60c2011-01-18 12:50:26 -080011021 * <p>
11022 * The default implementation replicates the appearance of the View object
11023 * that had been supplied to the
11024 * {@link #View.DragShadowBuilder(View)}
11025 * constructor when the builder object was instantiated.
Christopher Tate2c095f32010-10-04 14:13:40 -070011026 *
11027 * @param canvas
11028 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011029 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070011030 final View view = mView.get();
11031 if (view != null) {
11032 view.draw(canvas);
11033 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011034 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070011035 }
Christopher Tate2c095f32010-10-04 14:13:40 -070011036 }
11037 }
11038
11039 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011040 * Drag and drop. App calls startDrag(), then callbacks to the shadow builder's
11041 * {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} and
11042 * {@link DragShadowBuilder#onDrawShadow(Canvas)} methods happen, then the drag
Christopher Tate5ada6cb2010-10-05 14:15:29 -070011043 * operation is handed over to the OS.
Christopher Tatea53146c2010-09-07 11:57:52 -070011044 * !!! TODO: real docs
Christopher Tate407b4e92010-11-30 17:14:08 -080011045 *
11046 * @param data !!! TODO
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011047 * @param shadowBuilder !!! TODO
Christopher Tate407b4e92010-11-30 17:14:08 -080011048 * @param myLocalState An arbitrary object that will be passed as part of every DragEvent
11049 * delivered to the calling application during the course of the current drag operation.
11050 * This object is private to the application that called startDrag(), and is not
11051 * visible to other applications. It provides a lightweight way for the application to
11052 * propagate information from the initiator to the recipient of a drag within its own
11053 * application; for example, to help disambiguate between 'copy' and 'move' semantics.
Christopher Tate02d2b3b2011-01-10 20:43:53 -080011054 * @param flags Flags affecting the drag operation. At present no flags are defined;
11055 * pass 0 for this parameter.
Christopher Tate407b4e92010-11-30 17:14:08 -080011056 * @return {@code true} if the drag operation was initiated successfully; {@code false} if
11057 * an error prevented the drag from taking place.
Christopher Tatea53146c2010-09-07 11:57:52 -070011058 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011059 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080011060 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070011061 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080011062 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070011063 }
11064 boolean okay = false;
11065
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011066 Point shadowSize = new Point();
11067 Point shadowTouchPoint = new Point();
11068 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070011069
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011070 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
11071 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
11072 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070011073 }
Christopher Tatea53146c2010-09-07 11:57:52 -070011074
Chris Tatea32dcf72010-10-14 12:13:50 -070011075 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011076 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
11077 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070011078 }
Christopher Tatea53146c2010-09-07 11:57:52 -070011079 Surface surface = new Surface();
11080 try {
11081 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080011082 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070011083 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070011084 + " surface=" + surface);
11085 if (token != null) {
11086 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070011087 try {
Chris Tate6b391282010-10-14 15:48:59 -070011088 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011089 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070011090 } finally {
11091 surface.unlockCanvasAndPost(canvas);
11092 }
Christopher Tatea53146c2010-09-07 11:57:52 -070011093
Christopher Tate407b4e92010-11-30 17:14:08 -080011094 final ViewRoot root = getViewRoot();
11095
11096 // Cache the local state object for delivery with DragEvents
11097 root.setLocalDragState(myLocalState);
11098
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011099 // repurpose 'shadowSize' for the last touch point
11100 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070011101
Christopher Tatea53146c2010-09-07 11:57:52 -070011102 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011103 shadowSize.x, shadowSize.y,
11104 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070011105 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tatea53146c2010-09-07 11:57:52 -070011106 }
11107 } catch (Exception e) {
11108 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
11109 surface.destroy();
11110 }
11111
11112 return okay;
11113 }
11114
Christopher Tatea53146c2010-09-07 11:57:52 -070011115 /**
11116 * Drag-and-drop event dispatch. The event.getAction() verb is one of the DragEvent
11117 * constants DRAG_STARTED_EVENT, DRAG_EVENT, DROP_EVENT, and DRAG_ENDED_EVENT.
11118 *
11119 * For DRAG_STARTED_EVENT, event.getClipDescription() describes the content
11120 * being dragged. onDragEvent() should return 'true' if the view can handle
11121 * a drop of that content. A view that returns 'false' here will receive no
11122 * further calls to onDragEvent() about the drag/drop operation.
11123 *
11124 * For DRAG_ENTERED, event.getClipDescription() describes the content being
11125 * dragged. This will be the same content description passed in the
11126 * DRAG_STARTED_EVENT invocation.
11127 *
11128 * For DRAG_EXITED, event.getClipDescription() describes the content being
11129 * dragged. This will be the same content description passed in the
11130 * DRAG_STARTED_EVENT invocation. The view should return to its approriate
11131 * drag-acceptance visual state.
11132 *
11133 * For DRAG_LOCATION_EVENT, event.getX() and event.getY() give the location in View
11134 * coordinates of the current drag point. The view must return 'true' if it
11135 * can accept a drop of the current drag content, false otherwise.
11136 *
11137 * For DROP_EVENT, event.getX() and event.getY() give the location of the drop
11138 * within the view; also, event.getClipData() returns the full data payload
11139 * being dropped. The view should return 'true' if it consumed the dropped
11140 * content, 'false' if it did not.
11141 *
11142 * For DRAG_ENDED_EVENT, the 'event' argument may be null. The view should return
11143 * to its normal visual state.
11144 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070011145 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070011146 return false;
11147 }
11148
11149 /**
11150 * Views typically don't need to override dispatchDragEvent(); it just calls
Chris Tate32affef2010-10-18 15:29:21 -070011151 * onDragEvent(event) and passes the result up appropriately.
Christopher Tatea53146c2010-09-07 11:57:52 -070011152 */
11153 public boolean dispatchDragEvent(DragEvent event) {
Chris Tate32affef2010-10-18 15:29:21 -070011154 if (mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
11155 && mOnDragListener.onDrag(this, event)) {
11156 return true;
11157 }
Christopher Tatea53146c2010-09-07 11:57:52 -070011158 return onDragEvent(event);
11159 }
11160
11161 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070011162 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
11163 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070011164 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070011165 */
11166 public void onCloseSystemDialogs(String reason) {
11167 }
11168
11169 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011170 * Given a Drawable whose bounds have been set to draw into this view,
11171 * update a Region being computed for {@link #gatherTransparentRegion} so
11172 * that any non-transparent parts of the Drawable are removed from the
11173 * given transparent region.
11174 *
11175 * @param dr The Drawable whose transparency is to be applied to the region.
11176 * @param region A Region holding the current transparency information,
11177 * where any parts of the region that are set are considered to be
11178 * transparent. On return, this region will be modified to have the
11179 * transparency information reduced by the corresponding parts of the
11180 * Drawable that are not transparent.
11181 * {@hide}
11182 */
11183 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
11184 if (DBG) {
11185 Log.i("View", "Getting transparent region for: " + this);
11186 }
11187 final Region r = dr.getTransparentRegion();
11188 final Rect db = dr.getBounds();
11189 final AttachInfo attachInfo = mAttachInfo;
11190 if (r != null && attachInfo != null) {
11191 final int w = getRight()-getLeft();
11192 final int h = getBottom()-getTop();
11193 if (db.left > 0) {
11194 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
11195 r.op(0, 0, db.left, h, Region.Op.UNION);
11196 }
11197 if (db.right < w) {
11198 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
11199 r.op(db.right, 0, w, h, Region.Op.UNION);
11200 }
11201 if (db.top > 0) {
11202 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
11203 r.op(0, 0, w, db.top, Region.Op.UNION);
11204 }
11205 if (db.bottom < h) {
11206 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
11207 r.op(0, db.bottom, w, h, Region.Op.UNION);
11208 }
11209 final int[] location = attachInfo.mTransparentLocation;
11210 getLocationInWindow(location);
11211 r.translate(location[0], location[1]);
11212 region.op(r, Region.Op.INTERSECT);
11213 } else {
11214 region.op(db, Region.Op.DIFFERENCE);
11215 }
11216 }
11217
Adam Powelle14579b2009-12-16 18:39:52 -080011218 private void postCheckForLongClick(int delayOffset) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011219 mHasPerformedLongPress = false;
11220
11221 if (mPendingCheckForLongPress == null) {
11222 mPendingCheckForLongPress = new CheckForLongPress();
11223 }
11224 mPendingCheckForLongPress.rememberWindowAttachCount();
Adam Powelle14579b2009-12-16 18:39:52 -080011225 postDelayed(mPendingCheckForLongPress,
11226 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011227 }
11228
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011229 /**
11230 * Inflate a view from an XML resource. This convenience method wraps the {@link
11231 * LayoutInflater} class, which provides a full range of options for view inflation.
11232 *
11233 * @param context The Context object for your activity or application.
11234 * @param resource The resource ID to inflate
11235 * @param root A view group that will be the parent. Used to properly inflate the
11236 * layout_* parameters.
11237 * @see LayoutInflater
11238 */
11239 public static View inflate(Context context, int resource, ViewGroup root) {
11240 LayoutInflater factory = LayoutInflater.from(context);
11241 return factory.inflate(resource, root);
11242 }
Romain Guy33e72ae2010-07-17 12:40:29 -070011243
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011244 /**
Adam Powell637d3372010-08-25 14:37:03 -070011245 * Scroll the view with standard behavior for scrolling beyond the normal
11246 * content boundaries. Views that call this method should override
11247 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
11248 * results of an over-scroll operation.
11249 *
11250 * Views can use this method to handle any touch or fling-based scrolling.
11251 *
11252 * @param deltaX Change in X in pixels
11253 * @param deltaY Change in Y in pixels
11254 * @param scrollX Current X scroll value in pixels before applying deltaX
11255 * @param scrollY Current Y scroll value in pixels before applying deltaY
11256 * @param scrollRangeX Maximum content scroll range along the X axis
11257 * @param scrollRangeY Maximum content scroll range along the Y axis
11258 * @param maxOverScrollX Number of pixels to overscroll by in either direction
11259 * along the X axis.
11260 * @param maxOverScrollY Number of pixels to overscroll by in either direction
11261 * along the Y axis.
11262 * @param isTouchEvent true if this scroll operation is the result of a touch event.
11263 * @return true if scrolling was clamped to an over-scroll boundary along either
11264 * axis, false otherwise.
11265 */
11266 protected boolean overScrollBy(int deltaX, int deltaY,
11267 int scrollX, int scrollY,
11268 int scrollRangeX, int scrollRangeY,
11269 int maxOverScrollX, int maxOverScrollY,
11270 boolean isTouchEvent) {
11271 final int overScrollMode = mOverScrollMode;
11272 final boolean canScrollHorizontal =
11273 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
11274 final boolean canScrollVertical =
11275 computeVerticalScrollRange() > computeVerticalScrollExtent();
11276 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
11277 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
11278 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
11279 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
11280
11281 int newScrollX = scrollX + deltaX;
11282 if (!overScrollHorizontal) {
11283 maxOverScrollX = 0;
11284 }
11285
11286 int newScrollY = scrollY + deltaY;
11287 if (!overScrollVertical) {
11288 maxOverScrollY = 0;
11289 }
11290
11291 // Clamp values if at the limits and record
11292 final int left = -maxOverScrollX;
11293 final int right = maxOverScrollX + scrollRangeX;
11294 final int top = -maxOverScrollY;
11295 final int bottom = maxOverScrollY + scrollRangeY;
11296
11297 boolean clampedX = false;
11298 if (newScrollX > right) {
11299 newScrollX = right;
11300 clampedX = true;
11301 } else if (newScrollX < left) {
11302 newScrollX = left;
11303 clampedX = true;
11304 }
11305
11306 boolean clampedY = false;
11307 if (newScrollY > bottom) {
11308 newScrollY = bottom;
11309 clampedY = true;
11310 } else if (newScrollY < top) {
11311 newScrollY = top;
11312 clampedY = true;
11313 }
11314
11315 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
11316
11317 return clampedX || clampedY;
11318 }
11319
11320 /**
11321 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
11322 * respond to the results of an over-scroll operation.
11323 *
11324 * @param scrollX New X scroll value in pixels
11325 * @param scrollY New Y scroll value in pixels
11326 * @param clampedX True if scrollX was clamped to an over-scroll boundary
11327 * @param clampedY True if scrollY was clamped to an over-scroll boundary
11328 */
11329 protected void onOverScrolled(int scrollX, int scrollY,
11330 boolean clampedX, boolean clampedY) {
11331 // Intentionally empty.
11332 }
11333
11334 /**
11335 * Returns the over-scroll mode for this view. The result will be
11336 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
11337 * (allow over-scrolling only if the view content is larger than the container),
11338 * or {@link #OVER_SCROLL_NEVER}.
11339 *
11340 * @return This view's over-scroll mode.
11341 */
11342 public int getOverScrollMode() {
11343 return mOverScrollMode;
11344 }
11345
11346 /**
11347 * Set the over-scroll mode for this view. Valid over-scroll modes are
11348 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
11349 * (allow over-scrolling only if the view content is larger than the container),
11350 * or {@link #OVER_SCROLL_NEVER}.
11351 *
11352 * Setting the over-scroll mode of a view will have an effect only if the
11353 * view is capable of scrolling.
11354 *
11355 * @param overScrollMode The new over-scroll mode for this view.
11356 */
11357 public void setOverScrollMode(int overScrollMode) {
11358 if (overScrollMode != OVER_SCROLL_ALWAYS &&
11359 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
11360 overScrollMode != OVER_SCROLL_NEVER) {
11361 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
11362 }
11363 mOverScrollMode = overScrollMode;
11364 }
11365
11366 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011367 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
11368 * Each MeasureSpec represents a requirement for either the width or the height.
11369 * A MeasureSpec is comprised of a size and a mode. There are three possible
11370 * modes:
11371 * <dl>
11372 * <dt>UNSPECIFIED</dt>
11373 * <dd>
11374 * The parent has not imposed any constraint on the child. It can be whatever size
11375 * it wants.
11376 * </dd>
11377 *
11378 * <dt>EXACTLY</dt>
11379 * <dd>
11380 * The parent has determined an exact size for the child. The child is going to be
11381 * given those bounds regardless of how big it wants to be.
11382 * </dd>
11383 *
11384 * <dt>AT_MOST</dt>
11385 * <dd>
11386 * The child can be as large as it wants up to the specified size.
11387 * </dd>
11388 * </dl>
11389 *
11390 * MeasureSpecs are implemented as ints to reduce object allocation. This class
11391 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
11392 */
11393 public static class MeasureSpec {
11394 private static final int MODE_SHIFT = 30;
11395 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
11396
11397 /**
11398 * Measure specification mode: The parent has not imposed any constraint
11399 * on the child. It can be whatever size it wants.
11400 */
11401 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
11402
11403 /**
11404 * Measure specification mode: The parent has determined an exact size
11405 * for the child. The child is going to be given those bounds regardless
11406 * of how big it wants to be.
11407 */
11408 public static final int EXACTLY = 1 << MODE_SHIFT;
11409
11410 /**
11411 * Measure specification mode: The child can be as large as it wants up
11412 * to the specified size.
11413 */
11414 public static final int AT_MOST = 2 << MODE_SHIFT;
11415
11416 /**
11417 * Creates a measure specification based on the supplied size and mode.
11418 *
11419 * The mode must always be one of the following:
11420 * <ul>
11421 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
11422 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
11423 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
11424 * </ul>
11425 *
11426 * @param size the size of the measure specification
11427 * @param mode the mode of the measure specification
11428 * @return the measure specification based on size and mode
11429 */
11430 public static int makeMeasureSpec(int size, int mode) {
11431 return size + mode;
11432 }
11433
11434 /**
11435 * Extracts the mode from the supplied measure specification.
11436 *
11437 * @param measureSpec the measure specification to extract the mode from
11438 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
11439 * {@link android.view.View.MeasureSpec#AT_MOST} or
11440 * {@link android.view.View.MeasureSpec#EXACTLY}
11441 */
11442 public static int getMode(int measureSpec) {
11443 return (measureSpec & MODE_MASK);
11444 }
11445
11446 /**
11447 * Extracts the size from the supplied measure specification.
11448 *
11449 * @param measureSpec the measure specification to extract the size from
11450 * @return the size in pixels defined in the supplied measure specification
11451 */
11452 public static int getSize(int measureSpec) {
11453 return (measureSpec & ~MODE_MASK);
11454 }
11455
11456 /**
11457 * Returns a String representation of the specified measure
11458 * specification.
11459 *
11460 * @param measureSpec the measure specification to convert to a String
11461 * @return a String with the following format: "MeasureSpec: MODE SIZE"
11462 */
11463 public static String toString(int measureSpec) {
11464 int mode = getMode(measureSpec);
11465 int size = getSize(measureSpec);
11466
11467 StringBuilder sb = new StringBuilder("MeasureSpec: ");
11468
11469 if (mode == UNSPECIFIED)
11470 sb.append("UNSPECIFIED ");
11471 else if (mode == EXACTLY)
11472 sb.append("EXACTLY ");
11473 else if (mode == AT_MOST)
11474 sb.append("AT_MOST ");
11475 else
11476 sb.append(mode).append(" ");
11477
11478 sb.append(size);
11479 return sb.toString();
11480 }
11481 }
11482
11483 class CheckForLongPress implements Runnable {
11484
11485 private int mOriginalWindowAttachCount;
11486
11487 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070011488 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011489 && mOriginalWindowAttachCount == mWindowAttachCount) {
11490 if (performLongClick()) {
11491 mHasPerformedLongPress = true;
11492 }
11493 }
11494 }
11495
11496 public void rememberWindowAttachCount() {
11497 mOriginalWindowAttachCount = mWindowAttachCount;
11498 }
11499 }
Adam Powelle14579b2009-12-16 18:39:52 -080011500
11501 private final class CheckForTap implements Runnable {
11502 public void run() {
11503 mPrivateFlags &= ~PREPRESSED;
11504 mPrivateFlags |= PRESSED;
11505 refreshDrawableState();
11506 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
11507 postCheckForLongClick(ViewConfiguration.getTapTimeout());
11508 }
11509 }
11510 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011511
Adam Powella35d7682010-03-12 14:48:13 -080011512 private final class PerformClick implements Runnable {
11513 public void run() {
11514 performClick();
11515 }
11516 }
11517
Dianne Hackborn63042d62011-01-26 18:56:29 -080011518 /** @hide */
11519 public void hackTurnOffWindowResizeAnim(boolean off) {
11520 mAttachInfo.mTurnOffWindowResizeAnim = off;
11521 }
11522
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011523 /**
11524 * Interface definition for a callback to be invoked when a key event is
11525 * dispatched to this view. The callback will be invoked before the key
11526 * event is given to the view.
11527 */
11528 public interface OnKeyListener {
11529 /**
11530 * Called when a key is dispatched to a view. This allows listeners to
11531 * get a chance to respond before the target view.
11532 *
11533 * @param v The view the key has been dispatched to.
11534 * @param keyCode The code for the physical key that was pressed
11535 * @param event The KeyEvent object containing full information about
11536 * the event.
11537 * @return True if the listener has consumed the event, false otherwise.
11538 */
11539 boolean onKey(View v, int keyCode, KeyEvent event);
11540 }
11541
11542 /**
11543 * Interface definition for a callback to be invoked when a touch event is
11544 * dispatched to this view. The callback will be invoked before the touch
11545 * event is given to the view.
11546 */
11547 public interface OnTouchListener {
11548 /**
11549 * Called when a touch event is dispatched to a view. This allows listeners to
11550 * get a chance to respond before the target view.
11551 *
11552 * @param v The view the touch event has been dispatched to.
11553 * @param event The MotionEvent object containing full information about
11554 * the event.
11555 * @return True if the listener has consumed the event, false otherwise.
11556 */
11557 boolean onTouch(View v, MotionEvent event);
11558 }
11559
11560 /**
11561 * Interface definition for a callback to be invoked when a view has been clicked and held.
11562 */
11563 public interface OnLongClickListener {
11564 /**
11565 * Called when a view has been clicked and held.
11566 *
11567 * @param v The view that was clicked and held.
11568 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080011569 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011570 */
11571 boolean onLongClick(View v);
11572 }
11573
11574 /**
Chris Tate32affef2010-10-18 15:29:21 -070011575 * Interface definition for a callback to be invoked when a drag is being dispatched
11576 * to this view. The callback will be invoked before the hosting view's own
11577 * onDrag(event) method. If the listener wants to fall back to the hosting view's
11578 * onDrag(event) behavior, it should return 'false' from this callback.
11579 */
11580 public interface OnDragListener {
11581 /**
11582 * Called when a drag event is dispatched to a view. This allows listeners
11583 * to get a chance to override base View behavior.
11584 *
11585 * @param v The view the drag has been dispatched to.
11586 * @param event The DragEvent object containing full information
11587 * about the event.
11588 * @return true if the listener consumed the DragEvent, false in order to fall
11589 * back to the view's default handling.
11590 */
11591 boolean onDrag(View v, DragEvent event);
11592 }
11593
11594 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011595 * Interface definition for a callback to be invoked when the focus state of
11596 * a view changed.
11597 */
11598 public interface OnFocusChangeListener {
11599 /**
11600 * Called when the focus state of a view has changed.
11601 *
11602 * @param v The view whose state has changed.
11603 * @param hasFocus The new focus state of v.
11604 */
11605 void onFocusChange(View v, boolean hasFocus);
11606 }
11607
11608 /**
11609 * Interface definition for a callback to be invoked when a view is clicked.
11610 */
11611 public interface OnClickListener {
11612 /**
11613 * Called when a view has been clicked.
11614 *
11615 * @param v The view that was clicked.
11616 */
11617 void onClick(View v);
11618 }
11619
11620 /**
11621 * Interface definition for a callback to be invoked when the context menu
11622 * for this view is being built.
11623 */
11624 public interface OnCreateContextMenuListener {
11625 /**
11626 * Called when the context menu for this view is being built. It is not
11627 * safe to hold onto the menu after this method returns.
11628 *
11629 * @param menu The context menu that is being built
11630 * @param v The view for which the context menu is being built
11631 * @param menuInfo Extra information about the item for which the
11632 * context menu should be shown. This information will vary
11633 * depending on the class of v.
11634 */
11635 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
11636 }
11637
Joe Onorato664644d2011-01-23 17:53:23 -080011638 /**
11639 * Interface definition for a callback to be invoked when the status bar changes
11640 * visibility.
11641 *
11642 * @see #setOnSystemUiVisibilityChangeListener
11643 */
11644 public interface OnSystemUiVisibilityChangeListener {
11645 /**
11646 * Called when the status bar changes visibility because of a call to
11647 * {@link #setSystemUiVisibility}.
11648 *
11649 * @param visibility {@link #STATUS_BAR_VISIBLE} or {@link #STATUS_BAR_HIDDEN}.
11650 */
11651 public void onSystemUiVisibilityChange(int visibility);
11652 }
11653
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011654 private final class UnsetPressedState implements Runnable {
11655 public void run() {
11656 setPressed(false);
11657 }
11658 }
11659
11660 /**
11661 * Base class for derived classes that want to save and restore their own
11662 * state in {@link android.view.View#onSaveInstanceState()}.
11663 */
11664 public static class BaseSavedState extends AbsSavedState {
11665 /**
11666 * Constructor used when reading from a parcel. Reads the state of the superclass.
11667 *
11668 * @param source
11669 */
11670 public BaseSavedState(Parcel source) {
11671 super(source);
11672 }
11673
11674 /**
11675 * Constructor called by derived classes when creating their SavedState objects
11676 *
11677 * @param superState The state of the superclass of this view
11678 */
11679 public BaseSavedState(Parcelable superState) {
11680 super(superState);
11681 }
11682
11683 public static final Parcelable.Creator<BaseSavedState> CREATOR =
11684 new Parcelable.Creator<BaseSavedState>() {
11685 public BaseSavedState createFromParcel(Parcel in) {
11686 return new BaseSavedState(in);
11687 }
11688
11689 public BaseSavedState[] newArray(int size) {
11690 return new BaseSavedState[size];
11691 }
11692 };
11693 }
11694
11695 /**
11696 * A set of information given to a view when it is attached to its parent
11697 * window.
11698 */
11699 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011700 interface Callbacks {
11701 void playSoundEffect(int effectId);
11702 boolean performHapticFeedback(int effectId, boolean always);
11703 }
11704
11705 /**
11706 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
11707 * to a Handler. This class contains the target (View) to invalidate and
11708 * the coordinates of the dirty rectangle.
11709 *
11710 * For performance purposes, this class also implements a pool of up to
11711 * POOL_LIMIT objects that get reused. This reduces memory allocations
11712 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011713 */
Romain Guyd928d682009-03-31 17:52:16 -070011714 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011715 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070011716 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
11717 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070011718 public InvalidateInfo newInstance() {
11719 return new InvalidateInfo();
11720 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011721
Romain Guyd928d682009-03-31 17:52:16 -070011722 public void onAcquired(InvalidateInfo element) {
11723 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011724
Romain Guyd928d682009-03-31 17:52:16 -070011725 public void onReleased(InvalidateInfo element) {
11726 }
11727 }, POOL_LIMIT)
11728 );
11729
11730 private InvalidateInfo mNext;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011731
11732 View target;
11733
11734 int left;
11735 int top;
11736 int right;
11737 int bottom;
11738
Romain Guyd928d682009-03-31 17:52:16 -070011739 public void setNextPoolable(InvalidateInfo element) {
11740 mNext = element;
11741 }
11742
11743 public InvalidateInfo getNextPoolable() {
11744 return mNext;
11745 }
11746
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011747 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070011748 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011749 }
11750
11751 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070011752 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011753 }
11754 }
11755
11756 final IWindowSession mSession;
11757
11758 final IWindow mWindow;
11759
11760 final IBinder mWindowToken;
11761
11762 final Callbacks mRootCallbacks;
11763
Chet Haasedaf98e92011-01-10 14:10:36 -080011764 Canvas mHardwareCanvas;
11765
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011766 /**
11767 * The top view of the hierarchy.
11768 */
11769 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070011770
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011771 IBinder mPanelParentWindowToken;
11772 Surface mSurface;
11773
Romain Guyb051e892010-09-28 19:09:36 -070011774 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011775 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070011776 HardwareRenderer mHardwareRenderer;
Romain Guy2bffd262010-09-12 17:40:02 -070011777
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011778 /**
Romain Guy8506ab42009-06-11 17:35:47 -070011779 * Scale factor used by the compatibility mode
11780 */
11781 float mApplicationScale;
11782
11783 /**
11784 * Indicates whether the application is in compatibility mode
11785 */
11786 boolean mScalingRequired;
11787
11788 /**
Dianne Hackborn63042d62011-01-26 18:56:29 -080011789 * If set, ViewRoot doesn't use its lame animation for when the window resizes.
11790 */
11791 boolean mTurnOffWindowResizeAnim;
11792
11793 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011794 * Left position of this view's window
11795 */
11796 int mWindowLeft;
11797
11798 /**
11799 * Top position of this view's window
11800 */
11801 int mWindowTop;
11802
11803 /**
Adam Powell26153a32010-11-08 15:22:27 -080011804 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070011805 */
Adam Powell26153a32010-11-08 15:22:27 -080011806 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070011807
11808 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011809 * For windows that are full-screen but using insets to layout inside
11810 * of the screen decorations, these are the current insets for the
11811 * content of the window.
11812 */
11813 final Rect mContentInsets = new Rect();
11814
11815 /**
11816 * For windows that are full-screen but using insets to layout inside
11817 * of the screen decorations, these are the current insets for the
11818 * actual visible parts of the window.
11819 */
11820 final Rect mVisibleInsets = new Rect();
11821
11822 /**
11823 * The internal insets given by this window. This value is
11824 * supplied by the client (through
11825 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
11826 * be given to the window manager when changed to be used in laying
11827 * out windows behind it.
11828 */
11829 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
11830 = new ViewTreeObserver.InternalInsetsInfo();
11831
11832 /**
11833 * All views in the window's hierarchy that serve as scroll containers,
11834 * used to determine if the window can be resized or must be panned
11835 * to adjust for a soft input area.
11836 */
11837 final ArrayList<View> mScrollContainers = new ArrayList<View>();
11838
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070011839 final KeyEvent.DispatcherState mKeyDispatchState
11840 = new KeyEvent.DispatcherState();
11841
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011842 /**
11843 * Indicates whether the view's window currently has the focus.
11844 */
11845 boolean mHasWindowFocus;
11846
11847 /**
11848 * The current visibility of the window.
11849 */
11850 int mWindowVisibility;
11851
11852 /**
11853 * Indicates the time at which drawing started to occur.
11854 */
11855 long mDrawingTime;
11856
11857 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070011858 * Indicates whether or not ignoring the DIRTY_MASK flags.
11859 */
11860 boolean mIgnoreDirtyState;
11861
11862 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011863 * Indicates whether the view's window is currently in touch mode.
11864 */
11865 boolean mInTouchMode;
11866
11867 /**
11868 * Indicates that ViewRoot should trigger a global layout change
11869 * the next time it performs a traversal
11870 */
11871 boolean mRecomputeGlobalAttributes;
11872
11873 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011874 * Set during a traveral if any views want to keep the screen on.
11875 */
11876 boolean mKeepScreenOn;
11877
11878 /**
Joe Onorato664644d2011-01-23 17:53:23 -080011879 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility().
11880 */
11881 int mSystemUiVisibility;
11882
11883 /**
11884 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener
11885 * attached.
11886 */
11887 boolean mHasSystemUiListeners;
11888
11889 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011890 * Set if the visibility of any views has changed.
11891 */
11892 boolean mViewVisibilityChanged;
11893
11894 /**
11895 * Set to true if a view has been scrolled.
11896 */
11897 boolean mViewScrollChanged;
11898
11899 /**
11900 * Global to the view hierarchy used as a temporary for dealing with
11901 * x/y points in the transparent region computations.
11902 */
11903 final int[] mTransparentLocation = new int[2];
11904
11905 /**
11906 * Global to the view hierarchy used as a temporary for dealing with
11907 * x/y points in the ViewGroup.invalidateChild implementation.
11908 */
11909 final int[] mInvalidateChildLocation = new int[2];
11910
Chet Haasec3aa3612010-06-17 08:50:37 -070011911
11912 /**
11913 * Global to the view hierarchy used as a temporary for dealing with
11914 * x/y location when view is transformed.
11915 */
11916 final float[] mTmpTransformLocation = new float[2];
11917
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011918 /**
11919 * The view tree observer used to dispatch global events like
11920 * layout, pre-draw, touch mode change, etc.
11921 */
11922 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
11923
11924 /**
11925 * A Canvas used by the view hierarchy to perform bitmap caching.
11926 */
11927 Canvas mCanvas;
11928
11929 /**
11930 * A Handler supplied by a view's {@link android.view.ViewRoot}. This
11931 * handler can be used to pump events in the UI events queue.
11932 */
11933 final Handler mHandler;
11934
11935 /**
11936 * Identifier for messages requesting the view to be invalidated.
11937 * Such messages should be sent to {@link #mHandler}.
11938 */
11939 static final int INVALIDATE_MSG = 0x1;
11940
11941 /**
11942 * Identifier for messages requesting the view to invalidate a region.
11943 * Such messages should be sent to {@link #mHandler}.
11944 */
11945 static final int INVALIDATE_RECT_MSG = 0x2;
11946
11947 /**
11948 * Temporary for use in computing invalidate rectangles while
11949 * calling up the hierarchy.
11950 */
11951 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070011952
11953 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070011954 * Temporary for use in computing hit areas with transformed views
11955 */
11956 final RectF mTmpTransformRect = new RectF();
11957
11958 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070011959 * Temporary list for use in collecting focusable descendents of a view.
11960 */
11961 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24);
11962
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011963 /**
11964 * Creates a new set of attachment information with the specified
11965 * events handler and thread.
11966 *
11967 * @param handler the events handler the view must use
11968 */
11969 AttachInfo(IWindowSession session, IWindow window,
11970 Handler handler, Callbacks effectPlayer) {
11971 mSession = session;
11972 mWindow = window;
11973 mWindowToken = window.asBinder();
11974 mHandler = handler;
11975 mRootCallbacks = effectPlayer;
11976 }
11977 }
11978
11979 /**
11980 * <p>ScrollabilityCache holds various fields used by a View when scrolling
11981 * is supported. This avoids keeping too many unused fields in most
11982 * instances of View.</p>
11983 */
Mike Cleronf116bf82009-09-27 19:14:12 -070011984 private static class ScrollabilityCache implements Runnable {
11985
11986 /**
11987 * Scrollbars are not visible
11988 */
11989 public static final int OFF = 0;
11990
11991 /**
11992 * Scrollbars are visible
11993 */
11994 public static final int ON = 1;
11995
11996 /**
11997 * Scrollbars are fading away
11998 */
11999 public static final int FADING = 2;
12000
12001 public boolean fadeScrollBars;
12002
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012003 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070012004 public int scrollBarDefaultDelayBeforeFade;
12005 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012006
12007 public int scrollBarSize;
12008 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070012009 public float[] interpolatorValues;
12010 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012011
12012 public final Paint paint;
12013 public final Matrix matrix;
12014 public Shader shader;
12015
Mike Cleronf116bf82009-09-27 19:14:12 -070012016 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
12017
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080012018 private static final float[] OPAQUE = { 255 };
12019 private static final float[] TRANSPARENT = { 0.0f };
Mike Cleronf116bf82009-09-27 19:14:12 -070012020
12021 /**
12022 * When fading should start. This time moves into the future every time
12023 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
12024 */
12025 public long fadeStartTime;
12026
12027
12028 /**
12029 * The current state of the scrollbars: ON, OFF, or FADING
12030 */
12031 public int state = OFF;
12032
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012033 private int mLastColor;
12034
Mike Cleronf116bf82009-09-27 19:14:12 -070012035 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012036 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
12037 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070012038 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
12039 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012040
12041 paint = new Paint();
12042 matrix = new Matrix();
12043 // use use a height of 1, and then wack the matrix each time we
12044 // actually use it.
12045 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070012046
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012047 paint.setShader(shader);
12048 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070012049 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012050 }
Romain Guy8506ab42009-06-11 17:35:47 -070012051
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012052 public void setFadeColor(int color) {
12053 if (color != 0 && color != mLastColor) {
12054 mLastColor = color;
12055 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070012056
Romain Guye55e1a72009-08-27 10:42:26 -070012057 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
12058 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070012059
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012060 paint.setShader(shader);
12061 // Restore the default transfer mode (src_over)
12062 paint.setXfermode(null);
12063 }
12064 }
Mike Cleronf116bf82009-09-27 19:14:12 -070012065
12066 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070012067 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070012068 if (now >= fadeStartTime) {
12069
12070 // the animation fades the scrollbars out by changing
12071 // the opacity (alpha) from fully opaque to fully
12072 // transparent
12073 int nextFrame = (int) now;
12074 int framesCount = 0;
12075
12076 Interpolator interpolator = scrollBarInterpolator;
12077
12078 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080012079 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070012080
12081 // End transparent
12082 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080012083 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070012084
12085 state = FADING;
12086
12087 // Kick off the fade animation
Romain Guy0fd89bf2011-01-26 15:41:30 -080012088 host.invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -070012089 }
12090 }
12091
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012092 }
12093}