blob: 6ae73b4776bf338ae5fefebad1714436da62ea11 [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 /**
Adam Powell637d3372010-08-25 14:37:03 -07001735 * Controls the over-scroll mode for this view.
1736 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)},
1737 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS},
1738 * and {@link #OVER_SCROLL_NEVER}.
1739 */
1740 private int mOverScrollMode;
1741
1742 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001743 * The parent this view is attached to.
1744 * {@hide}
1745 *
1746 * @see #getParent()
1747 */
1748 protected ViewParent mParent;
1749
1750 /**
1751 * {@hide}
1752 */
1753 AttachInfo mAttachInfo;
1754
1755 /**
1756 * {@hide}
1757 */
Romain Guy809a7f62009-05-14 15:44:42 -07001758 @ViewDebug.ExportedProperty(flagMapping = {
1759 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT,
1760 name = "FORCE_LAYOUT"),
1761 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED,
1762 name = "LAYOUT_REQUIRED"),
1763 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07001764 name = "DRAWING_CACHE_INVALID", outputIf = false),
Romain Guy809a7f62009-05-14 15:44:42 -07001765 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true),
1766 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false),
1767 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
1768 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY")
1769 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001770 int mPrivateFlags;
1771
1772 /**
Joe Onorato664644d2011-01-23 17:53:23 -08001773 * This view's request for the visibility of the status bar.
1774 * @hide
1775 */
1776 int mSystemUiVisibility;
1777
1778 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001779 * Count of how many windows this view has been attached to.
1780 */
1781 int mWindowAttachCount;
1782
1783 /**
1784 * The layout parameters associated with this view and used by the parent
1785 * {@link android.view.ViewGroup} to determine how this view should be
1786 * laid out.
1787 * {@hide}
1788 */
1789 protected ViewGroup.LayoutParams mLayoutParams;
1790
1791 /**
1792 * The view flags hold various views states.
1793 * {@hide}
1794 */
1795 @ViewDebug.ExportedProperty
1796 int mViewFlags;
1797
1798 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001799 * The transform matrix for the View. This transform is calculated internally
1800 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1801 * is used by default. Do *not* use this variable directly; instead call
1802 * getMatrix(), which will automatically recalculate the matrix if necessary
1803 * to get the correct matrix based on the latest rotation and scale properties.
1804 */
1805 private final Matrix mMatrix = new Matrix();
1806
1807 /**
1808 * The transform matrix for the View. This transform is calculated internally
1809 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1810 * is used by default. Do *not* use this variable directly; instead call
Jeff Brown86671742010-09-30 20:00:15 -07001811 * getInverseMatrix(), which will automatically recalculate the matrix if necessary
Chet Haasec3aa3612010-06-17 08:50:37 -07001812 * to get the correct matrix based on the latest rotation and scale properties.
1813 */
1814 private Matrix mInverseMatrix;
1815
1816 /**
1817 * An internal variable that tracks whether we need to recalculate the
1818 * transform matrix, based on whether the rotation or scaleX/Y properties
1819 * have changed since the matrix was last calculated.
1820 */
1821 private boolean mMatrixDirty = false;
1822
1823 /**
1824 * An internal variable that tracks whether we need to recalculate the
1825 * transform matrix, based on whether the rotation or scaleX/Y properties
1826 * have changed since the matrix was last calculated.
1827 */
1828 private boolean mInverseMatrixDirty = true;
1829
1830 /**
1831 * A variable that tracks whether we need to recalculate the
1832 * transform matrix, based on whether the rotation or scaleX/Y properties
1833 * have changed since the matrix was last calculated. This variable
Jeff Brown86671742010-09-30 20:00:15 -07001834 * is only valid after a call to updateMatrix() or to a function that
1835 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix().
Chet Haasec3aa3612010-06-17 08:50:37 -07001836 */
Romain Guy33e72ae2010-07-17 12:40:29 -07001837 private boolean mMatrixIsIdentity = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07001838
1839 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001840 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set.
1841 */
1842 private Camera mCamera = null;
1843
1844 /**
1845 * This matrix is used when computing the matrix for 3D rotations.
1846 */
1847 private Matrix matrix3D = null;
1848
1849 /**
1850 * These prev values are used to recalculate a centered pivot point when necessary. The
1851 * pivot point is only used in matrix operations (when rotation, scale, or translation are
1852 * set), so thes values are only used then as well.
1853 */
1854 private int mPrevWidth = -1;
1855 private int mPrevHeight = -1;
1856
Romain Guyc5d55862011-01-21 19:01:46 -08001857 private boolean mLastIsOpaque;
1858
Chet Haasefd2b0022010-08-06 13:08:56 -07001859 /**
1860 * Convenience value to check for float values that are close enough to zero to be considered
1861 * zero.
1862 */
Romain Guy2542d192010-08-18 11:47:12 -07001863 private static final float NONZERO_EPSILON = .001f;
Chet Haasefd2b0022010-08-06 13:08:56 -07001864
1865 /**
1866 * The degrees rotation around the vertical axis through the pivot point.
1867 */
1868 @ViewDebug.ExportedProperty
1869 private float mRotationY = 0f;
1870
1871 /**
1872 * The degrees rotation around the horizontal axis through the pivot point.
1873 */
1874 @ViewDebug.ExportedProperty
1875 private float mRotationX = 0f;
1876
1877 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001878 * The degrees rotation around the pivot point.
1879 */
1880 @ViewDebug.ExportedProperty
1881 private float mRotation = 0f;
1882
1883 /**
Chet Haasedf030d22010-07-30 17:22:38 -07001884 * The amount of translation of the object away from its left property (post-layout).
1885 */
1886 @ViewDebug.ExportedProperty
1887 private float mTranslationX = 0f;
1888
1889 /**
1890 * The amount of translation of the object away from its top property (post-layout).
1891 */
1892 @ViewDebug.ExportedProperty
1893 private float mTranslationY = 0f;
1894
1895 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001896 * The amount of scale in the x direction around the pivot point. A
1897 * value of 1 means no scaling is applied.
1898 */
1899 @ViewDebug.ExportedProperty
1900 private float mScaleX = 1f;
1901
1902 /**
1903 * The amount of scale in the y direction around the pivot point. A
1904 * value of 1 means no scaling is applied.
1905 */
1906 @ViewDebug.ExportedProperty
1907 private float mScaleY = 1f;
1908
1909 /**
1910 * The amount of scale in the x direction around the pivot point. A
1911 * value of 1 means no scaling is applied.
1912 */
1913 @ViewDebug.ExportedProperty
1914 private float mPivotX = 0f;
1915
1916 /**
1917 * The amount of scale in the y direction around the pivot point. A
1918 * value of 1 means no scaling is applied.
1919 */
1920 @ViewDebug.ExportedProperty
1921 private float mPivotY = 0f;
1922
1923 /**
1924 * The opacity of the View. This is a value from 0 to 1, where 0 means
1925 * completely transparent and 1 means completely opaque.
1926 */
1927 @ViewDebug.ExportedProperty
1928 private float mAlpha = 1f;
1929
1930 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001931 * The distance in pixels from the left edge of this view's parent
1932 * to the left edge of this view.
1933 * {@hide}
1934 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001935 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001936 protected int mLeft;
1937 /**
1938 * The distance in pixels from the left edge of this view's parent
1939 * to the right edge of this view.
1940 * {@hide}
1941 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001942 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001943 protected int mRight;
1944 /**
1945 * The distance in pixels from the top edge of this view's parent
1946 * to the top edge of this view.
1947 * {@hide}
1948 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001949 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001950 protected int mTop;
1951 /**
1952 * The distance in pixels from the top edge of this view's parent
1953 * to the bottom edge of this view.
1954 * {@hide}
1955 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001956 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001957 protected int mBottom;
1958
1959 /**
1960 * The offset, in pixels, by which the content of this view is scrolled
1961 * horizontally.
1962 * {@hide}
1963 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001964 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001965 protected int mScrollX;
1966 /**
1967 * The offset, in pixels, by which the content of this view is scrolled
1968 * vertically.
1969 * {@hide}
1970 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001971 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001972 protected int mScrollY;
1973
1974 /**
1975 * The left padding in pixels, that is the distance in pixels between the
1976 * left edge of this view and the left edge of its content.
1977 * {@hide}
1978 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001979 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001980 protected int mPaddingLeft;
1981 /**
1982 * The right padding in pixels, that is the distance in pixels between the
1983 * right edge of this view and the right edge of its content.
1984 * {@hide}
1985 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001986 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001987 protected int mPaddingRight;
1988 /**
1989 * The top padding in pixels, that is the distance in pixels between the
1990 * top edge of this view and the top edge of its content.
1991 * {@hide}
1992 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001993 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001994 protected int mPaddingTop;
1995 /**
1996 * The bottom padding in pixels, that is the distance in pixels between the
1997 * bottom edge of this view and the bottom edge of its content.
1998 * {@hide}
1999 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002000 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002001 protected int mPaddingBottom;
2002
2003 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002004 * Briefly describes the view and is primarily used for accessibility support.
2005 */
2006 private CharSequence mContentDescription;
2007
2008 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002009 * Cache the paddingRight set by the user to append to the scrollbar's size.
2010 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002011 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002012 int mUserPaddingRight;
2013
2014 /**
2015 * Cache the paddingBottom set by the user to append to the scrollbar's size.
2016 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002017 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002018 int mUserPaddingBottom;
2019
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002020 /**
Adam Powell20232d02010-12-08 21:08:53 -08002021 * Cache the paddingLeft set by the user to append to the scrollbar's size.
2022 */
2023 @ViewDebug.ExportedProperty(category = "padding")
2024 int mUserPaddingLeft;
2025
2026 /**
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002027 * @hide
2028 */
2029 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
2030 /**
2031 * @hide
2032 */
2033 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002034
2035 private Resources mResources = null;
2036
2037 private Drawable mBGDrawable;
2038
2039 private int mBackgroundResource;
2040 private boolean mBackgroundSizeChanged;
2041
2042 /**
2043 * Listener used to dispatch focus change events.
2044 * This field should be made private, so it is hidden from the SDK.
2045 * {@hide}
2046 */
2047 protected OnFocusChangeListener mOnFocusChangeListener;
2048
2049 /**
Chet Haase21cd1382010-09-01 17:42:29 -07002050 * Listeners for layout change events.
2051 */
2052 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
2053
2054 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002055 * Listener used to dispatch click events.
2056 * This field should be made private, so it is hidden from the SDK.
2057 * {@hide}
2058 */
2059 protected OnClickListener mOnClickListener;
2060
2061 /**
2062 * Listener used to dispatch long click events.
2063 * This field should be made private, so it is hidden from the SDK.
2064 * {@hide}
2065 */
2066 protected OnLongClickListener mOnLongClickListener;
2067
2068 /**
2069 * Listener used to build the context menu.
2070 * This field should be made private, so it is hidden from the SDK.
2071 * {@hide}
2072 */
2073 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
2074
2075 private OnKeyListener mOnKeyListener;
2076
2077 private OnTouchListener mOnTouchListener;
2078
Chris Tate32affef2010-10-18 15:29:21 -07002079 private OnDragListener mOnDragListener;
2080
Joe Onorato664644d2011-01-23 17:53:23 -08002081 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener;
2082
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002083 /**
2084 * The application environment this view lives in.
2085 * This field should be made private, so it is hidden from the SDK.
2086 * {@hide}
2087 */
2088 protected Context mContext;
2089
2090 private ScrollabilityCache mScrollCache;
2091
2092 private int[] mDrawableState = null;
2093
Romain Guy02890fd2010-08-06 17:58:44 -07002094 private Bitmap mDrawingCache;
2095 private Bitmap mUnscaledDrawingCache;
Romain Guyb051e892010-09-28 19:09:36 -07002096 private DisplayList mDisplayList;
Romain Guy6c319ca2011-01-11 14:29:25 -08002097 private HardwareLayer mHardwareLayer;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002098
2099 /**
2100 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
2101 * the user may specify which view to go to next.
2102 */
2103 private int mNextFocusLeftId = View.NO_ID;
2104
2105 /**
2106 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
2107 * the user may specify which view to go to next.
2108 */
2109 private int mNextFocusRightId = View.NO_ID;
2110
2111 /**
2112 * When this view has focus and the next focus is {@link #FOCUS_UP},
2113 * the user may specify which view to go to next.
2114 */
2115 private int mNextFocusUpId = View.NO_ID;
2116
2117 /**
2118 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
2119 * the user may specify which view to go to next.
2120 */
2121 private int mNextFocusDownId = View.NO_ID;
2122
Jeff Brown4e6319b2010-12-13 10:36:51 -08002123 /**
2124 * When this view has focus and the next focus is {@link #FOCUS_FORWARD},
2125 * the user may specify which view to go to next.
2126 */
2127 int mNextFocusForwardId = View.NO_ID;
2128
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002129 private CheckForLongPress mPendingCheckForLongPress;
Adam Powelle14579b2009-12-16 18:39:52 -08002130 private CheckForTap mPendingCheckForTap = null;
Adam Powella35d7682010-03-12 14:48:13 -08002131 private PerformClick mPerformClick;
Adam Powelle14579b2009-12-16 18:39:52 -08002132
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002133 private UnsetPressedState mUnsetPressedState;
2134
2135 /**
2136 * Whether the long press's action has been invoked. The tap's action is invoked on the
2137 * up event while a long press is invoked as soon as the long press duration is reached, so
2138 * a long press could be performed before the tap is checked, in which case the tap's action
2139 * should not be invoked.
2140 */
2141 private boolean mHasPerformedLongPress;
2142
2143 /**
2144 * The minimum height of the view. We'll try our best to have the height
2145 * of this view to at least this amount.
2146 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002147 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002148 private int mMinHeight;
2149
2150 /**
2151 * The minimum width of the view. We'll try our best to have the width
2152 * of this view to at least this amount.
2153 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002154 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002155 private int mMinWidth;
2156
2157 /**
2158 * The delegate to handle touch events that are physically in this view
2159 * but should be handled by another view.
2160 */
2161 private TouchDelegate mTouchDelegate = null;
2162
2163 /**
2164 * Solid color to use as a background when creating the drawing cache. Enables
2165 * the cache to use 16 bit bitmaps instead of 32 bit.
2166 */
2167 private int mDrawingCacheBackgroundColor = 0;
2168
2169 /**
2170 * Special tree observer used when mAttachInfo is null.
2171 */
2172 private ViewTreeObserver mFloatingTreeObserver;
Adam Powelle14579b2009-12-16 18:39:52 -08002173
2174 /**
2175 * Cache the touch slop from the context that created the view.
2176 */
2177 private int mTouchSlop;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002178
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002179 /**
Christopher Tatea53146c2010-09-07 11:57:52 -07002180 * Cache drag/drop state
2181 *
2182 */
2183 boolean mCanAcceptDrop;
Christopher Tatea53146c2010-09-07 11:57:52 -07002184
2185 /**
Christopher Tate02d2b3b2011-01-10 20:43:53 -08002186 * Flag indicating that a drag can cross window boundaries
2187 * @hide
2188 */
2189 public static final int DRAG_FLAG_GLOBAL = 1;
2190
2191 /**
Adam Powell20232d02010-12-08 21:08:53 -08002192 * Position of the vertical scroll bar.
2193 */
2194 private int mVerticalScrollbarPosition;
2195
2196 /**
2197 * Position the scroll bar at the default position as determined by the system.
2198 */
2199 public static final int SCROLLBAR_POSITION_DEFAULT = 0;
2200
2201 /**
2202 * Position the scroll bar along the left edge.
2203 */
2204 public static final int SCROLLBAR_POSITION_LEFT = 1;
2205
2206 /**
2207 * Position the scroll bar along the right edge.
2208 */
2209 public static final int SCROLLBAR_POSITION_RIGHT = 2;
2210
2211 /**
Romain Guy171c5922011-01-06 10:04:23 -08002212 * Indicates that the view does not have a layer.
2213 *
2214 * @see #getLayerType()
2215 * @see #setLayerType(int, android.graphics.Paint)
2216 * @see #LAYER_TYPE_SOFTWARE
2217 * @see #LAYER_TYPE_HARDWARE
2218 */
2219 public static final int LAYER_TYPE_NONE = 0;
2220
2221 /**
2222 * <p>Indicates that the view has a software layer. A software layer is backed
2223 * by a bitmap and causes the view to be rendered using Android's software
2224 * rendering pipeline, even if hardware acceleration is enabled.</p>
2225 *
2226 * <p>Software layers have various usages:</p>
2227 * <p>When the application is not using hardware acceleration, a software layer
2228 * is useful to apply a specific color filter and/or blending mode and/or
2229 * translucency to a view and all its children.</p>
2230 * <p>When the application is using hardware acceleration, a software layer
2231 * is useful to render drawing primitives not supported by the hardware
2232 * accelerated pipeline. It can also be used to cache a complex view tree
2233 * into a texture and reduce the complexity of drawing operations. For instance,
2234 * when animating a complex view tree with a translation, a software layer can
2235 * be used to render the view tree only once.</p>
2236 * <p>Software layers should be avoided when the affected view tree updates
2237 * often. Every update will require to re-render the software layer, which can
2238 * potentially be slow (particularly when hardware acceleration is turned on
2239 * since the layer will have to be uploaded into a hardware texture after every
2240 * update.)</p>
2241 *
2242 * @see #getLayerType()
2243 * @see #setLayerType(int, android.graphics.Paint)
2244 * @see #LAYER_TYPE_NONE
2245 * @see #LAYER_TYPE_HARDWARE
2246 */
2247 public static final int LAYER_TYPE_SOFTWARE = 1;
2248
2249 /**
2250 * <p>Indicates that the view has a hardware layer. A hardware layer is backed
2251 * by a hardware specific texture (generally Frame Buffer Objects or FBO on
2252 * OpenGL hardware) and causes the view to be rendered using Android's hardware
2253 * rendering pipeline, but only if hardware acceleration is turned on for the
2254 * view hierarchy. When hardware acceleration is turned off, hardware layers
2255 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p>
2256 *
2257 * <p>A hardware layer is useful to apply a specific color filter and/or
2258 * blending mode and/or translucency to a view and all its children.</p>
Romain Guy6c319ca2011-01-11 14:29:25 -08002259 * <p>A hardware layer can be used to cache a complex view tree into a
2260 * texture and reduce the complexity of drawing operations. For instance,
2261 * when animating a complex view tree with a translation, a hardware layer can
2262 * be used to render the view tree only once.</p>
Romain Guy171c5922011-01-06 10:04:23 -08002263 * <p>A hardware layer can also be used to increase the rendering quality when
2264 * rotation transformations are applied on a view. It can also be used to
2265 * prevent potential clipping issues when applying 3D transforms on a view.</p>
2266 *
2267 * @see #getLayerType()
2268 * @see #setLayerType(int, android.graphics.Paint)
2269 * @see #LAYER_TYPE_NONE
2270 * @see #LAYER_TYPE_SOFTWARE
2271 */
2272 public static final int LAYER_TYPE_HARDWARE = 2;
2273
Romain Guy3aaff3a2011-01-12 14:18:47 -08002274 @ViewDebug.ExportedProperty(category = "drawing", mapping = {
2275 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"),
2276 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"),
2277 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE")
2278 })
Romain Guy171c5922011-01-06 10:04:23 -08002279 int mLayerType = LAYER_TYPE_NONE;
2280 Paint mLayerPaint;
2281
2282 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002283 * Simple constructor to use when creating a view from code.
2284 *
2285 * @param context The Context the view is running in, through which it can
2286 * access the current theme, resources, etc.
2287 */
2288 public View(Context context) {
2289 mContext = context;
2290 mResources = context != null ? context.getResources() : null;
Romain Guy8f1344f52009-05-15 16:03:59 -07002291 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED;
Adam Powelle14579b2009-12-16 18:39:52 -08002292 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop();
Adam Powell637d3372010-08-25 14:37:03 -07002293 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002294 }
2295
2296 /**
2297 * Constructor that is called when inflating a view from XML. This is called
2298 * when a view is being constructed from an XML file, supplying attributes
2299 * that were specified in the XML file. This version uses a default style of
2300 * 0, so the only attribute values applied are those in the Context's Theme
2301 * and the given AttributeSet.
2302 *
2303 * <p>
2304 * The method onFinishInflate() will be called after all children have been
2305 * added.
2306 *
2307 * @param context The Context the view is running in, through which it can
2308 * access the current theme, resources, etc.
2309 * @param attrs The attributes of the XML tag that is inflating the view.
2310 * @see #View(Context, AttributeSet, int)
2311 */
2312 public View(Context context, AttributeSet attrs) {
2313 this(context, attrs, 0);
2314 }
2315
2316 /**
2317 * Perform inflation from XML and apply a class-specific base style. This
2318 * constructor of View allows subclasses to use their own base style when
2319 * they are inflating. For example, a Button class's constructor would call
2320 * this version of the super class constructor and supply
2321 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
2322 * the theme's button style to modify all of the base view attributes (in
2323 * particular its background) as well as the Button class's attributes.
2324 *
2325 * @param context The Context the view is running in, through which it can
2326 * access the current theme, resources, etc.
2327 * @param attrs The attributes of the XML tag that is inflating the view.
2328 * @param defStyle The default style to apply to this view. If 0, no style
2329 * will be applied (beyond what is included in the theme). This may
2330 * either be an attribute resource, whose value will be retrieved
2331 * from the current theme, or an explicit style resource.
2332 * @see #View(Context, AttributeSet)
2333 */
2334 public View(Context context, AttributeSet attrs, int defStyle) {
2335 this(context);
2336
2337 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
2338 defStyle, 0);
2339
2340 Drawable background = null;
2341
2342 int leftPadding = -1;
2343 int topPadding = -1;
2344 int rightPadding = -1;
2345 int bottomPadding = -1;
2346
2347 int padding = -1;
2348
2349 int viewFlagValues = 0;
2350 int viewFlagMasks = 0;
2351
2352 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07002353
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002354 int x = 0;
2355 int y = 0;
2356
Chet Haase73066682010-11-29 15:55:32 -08002357 float tx = 0;
2358 float ty = 0;
2359 float rotation = 0;
2360 float rotationX = 0;
2361 float rotationY = 0;
2362 float sx = 1f;
2363 float sy = 1f;
2364 boolean transformSet = false;
2365
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002366 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
2367
Adam Powell637d3372010-08-25 14:37:03 -07002368 int overScrollMode = mOverScrollMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002369 final int N = a.getIndexCount();
2370 for (int i = 0; i < N; i++) {
2371 int attr = a.getIndex(i);
2372 switch (attr) {
2373 case com.android.internal.R.styleable.View_background:
2374 background = a.getDrawable(attr);
2375 break;
2376 case com.android.internal.R.styleable.View_padding:
2377 padding = a.getDimensionPixelSize(attr, -1);
2378 break;
2379 case com.android.internal.R.styleable.View_paddingLeft:
2380 leftPadding = a.getDimensionPixelSize(attr, -1);
2381 break;
2382 case com.android.internal.R.styleable.View_paddingTop:
2383 topPadding = a.getDimensionPixelSize(attr, -1);
2384 break;
2385 case com.android.internal.R.styleable.View_paddingRight:
2386 rightPadding = a.getDimensionPixelSize(attr, -1);
2387 break;
2388 case com.android.internal.R.styleable.View_paddingBottom:
2389 bottomPadding = a.getDimensionPixelSize(attr, -1);
2390 break;
2391 case com.android.internal.R.styleable.View_scrollX:
2392 x = a.getDimensionPixelOffset(attr, 0);
2393 break;
2394 case com.android.internal.R.styleable.View_scrollY:
2395 y = a.getDimensionPixelOffset(attr, 0);
2396 break;
Chet Haase73066682010-11-29 15:55:32 -08002397 case com.android.internal.R.styleable.View_alpha:
2398 setAlpha(a.getFloat(attr, 1f));
2399 break;
2400 case com.android.internal.R.styleable.View_transformPivotX:
2401 setPivotX(a.getDimensionPixelOffset(attr, 0));
2402 break;
2403 case com.android.internal.R.styleable.View_transformPivotY:
2404 setPivotY(a.getDimensionPixelOffset(attr, 0));
2405 break;
2406 case com.android.internal.R.styleable.View_translationX:
2407 tx = a.getDimensionPixelOffset(attr, 0);
2408 transformSet = true;
2409 break;
2410 case com.android.internal.R.styleable.View_translationY:
2411 ty = a.getDimensionPixelOffset(attr, 0);
2412 transformSet = true;
2413 break;
2414 case com.android.internal.R.styleable.View_rotation:
2415 rotation = a.getFloat(attr, 0);
2416 transformSet = true;
2417 break;
2418 case com.android.internal.R.styleable.View_rotationX:
2419 rotationX = a.getFloat(attr, 0);
2420 transformSet = true;
2421 break;
2422 case com.android.internal.R.styleable.View_rotationY:
2423 rotationY = a.getFloat(attr, 0);
2424 transformSet = true;
2425 break;
2426 case com.android.internal.R.styleable.View_scaleX:
2427 sx = a.getFloat(attr, 1f);
2428 transformSet = true;
2429 break;
2430 case com.android.internal.R.styleable.View_scaleY:
2431 sy = a.getFloat(attr, 1f);
2432 transformSet = true;
2433 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002434 case com.android.internal.R.styleable.View_id:
2435 mID = a.getResourceId(attr, NO_ID);
2436 break;
2437 case com.android.internal.R.styleable.View_tag:
2438 mTag = a.getText(attr);
2439 break;
2440 case com.android.internal.R.styleable.View_fitsSystemWindows:
2441 if (a.getBoolean(attr, false)) {
2442 viewFlagValues |= FITS_SYSTEM_WINDOWS;
2443 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
2444 }
2445 break;
2446 case com.android.internal.R.styleable.View_focusable:
2447 if (a.getBoolean(attr, false)) {
2448 viewFlagValues |= FOCUSABLE;
2449 viewFlagMasks |= FOCUSABLE_MASK;
2450 }
2451 break;
2452 case com.android.internal.R.styleable.View_focusableInTouchMode:
2453 if (a.getBoolean(attr, false)) {
2454 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
2455 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
2456 }
2457 break;
2458 case com.android.internal.R.styleable.View_clickable:
2459 if (a.getBoolean(attr, false)) {
2460 viewFlagValues |= CLICKABLE;
2461 viewFlagMasks |= CLICKABLE;
2462 }
2463 break;
2464 case com.android.internal.R.styleable.View_longClickable:
2465 if (a.getBoolean(attr, false)) {
2466 viewFlagValues |= LONG_CLICKABLE;
2467 viewFlagMasks |= LONG_CLICKABLE;
2468 }
2469 break;
2470 case com.android.internal.R.styleable.View_saveEnabled:
2471 if (!a.getBoolean(attr, true)) {
2472 viewFlagValues |= SAVE_DISABLED;
2473 viewFlagMasks |= SAVE_DISABLED_MASK;
2474 }
2475 break;
2476 case com.android.internal.R.styleable.View_duplicateParentState:
2477 if (a.getBoolean(attr, false)) {
2478 viewFlagValues |= DUPLICATE_PARENT_STATE;
2479 viewFlagMasks |= DUPLICATE_PARENT_STATE;
2480 }
2481 break;
2482 case com.android.internal.R.styleable.View_visibility:
2483 final int visibility = a.getInt(attr, 0);
2484 if (visibility != 0) {
2485 viewFlagValues |= VISIBILITY_FLAGS[visibility];
2486 viewFlagMasks |= VISIBILITY_MASK;
2487 }
2488 break;
2489 case com.android.internal.R.styleable.View_drawingCacheQuality:
2490 final int cacheQuality = a.getInt(attr, 0);
2491 if (cacheQuality != 0) {
2492 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
2493 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
2494 }
2495 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07002496 case com.android.internal.R.styleable.View_contentDescription:
2497 mContentDescription = a.getString(attr);
2498 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002499 case com.android.internal.R.styleable.View_soundEffectsEnabled:
2500 if (!a.getBoolean(attr, true)) {
2501 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
2502 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
2503 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002504 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002505 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
2506 if (!a.getBoolean(attr, true)) {
2507 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
2508 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
2509 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002510 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002511 case R.styleable.View_scrollbars:
2512 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
2513 if (scrollbars != SCROLLBARS_NONE) {
2514 viewFlagValues |= scrollbars;
2515 viewFlagMasks |= SCROLLBARS_MASK;
2516 initializeScrollbars(a);
2517 }
2518 break;
2519 case R.styleable.View_fadingEdge:
2520 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
2521 if (fadingEdge != FADING_EDGE_NONE) {
2522 viewFlagValues |= fadingEdge;
2523 viewFlagMasks |= FADING_EDGE_MASK;
2524 initializeFadingEdge(a);
2525 }
2526 break;
2527 case R.styleable.View_scrollbarStyle:
2528 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
2529 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2530 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
2531 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
2532 }
2533 break;
2534 case R.styleable.View_isScrollContainer:
2535 setScrollContainer = true;
2536 if (a.getBoolean(attr, false)) {
2537 setScrollContainer(true);
2538 }
2539 break;
2540 case com.android.internal.R.styleable.View_keepScreenOn:
2541 if (a.getBoolean(attr, false)) {
2542 viewFlagValues |= KEEP_SCREEN_ON;
2543 viewFlagMasks |= KEEP_SCREEN_ON;
2544 }
2545 break;
Jeff Brown85a31762010-09-01 17:01:00 -07002546 case R.styleable.View_filterTouchesWhenObscured:
2547 if (a.getBoolean(attr, false)) {
2548 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED;
2549 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED;
2550 }
2551 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002552 case R.styleable.View_nextFocusLeft:
2553 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
2554 break;
2555 case R.styleable.View_nextFocusRight:
2556 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
2557 break;
2558 case R.styleable.View_nextFocusUp:
2559 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
2560 break;
2561 case R.styleable.View_nextFocusDown:
2562 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
2563 break;
Jeff Brown4e6319b2010-12-13 10:36:51 -08002564 case R.styleable.View_nextFocusForward:
2565 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID);
2566 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002567 case R.styleable.View_minWidth:
2568 mMinWidth = a.getDimensionPixelSize(attr, 0);
2569 break;
2570 case R.styleable.View_minHeight:
2571 mMinHeight = a.getDimensionPixelSize(attr, 0);
2572 break;
Romain Guy9a817362009-05-01 10:57:14 -07002573 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07002574 if (context.isRestricted()) {
2575 throw new IllegalStateException("The android:onClick attribute cannot "
2576 + "be used within a restricted context");
2577 }
2578
Romain Guy9a817362009-05-01 10:57:14 -07002579 final String handlerName = a.getString(attr);
2580 if (handlerName != null) {
2581 setOnClickListener(new OnClickListener() {
2582 private Method mHandler;
2583
2584 public void onClick(View v) {
2585 if (mHandler == null) {
2586 try {
2587 mHandler = getContext().getClass().getMethod(handlerName,
2588 View.class);
2589 } catch (NoSuchMethodException e) {
Joe Onorato42e14d72010-03-11 14:51:17 -08002590 int id = getId();
2591 String idText = id == NO_ID ? "" : " with id '"
2592 + getContext().getResources().getResourceEntryName(
2593 id) + "'";
Romain Guy9a817362009-05-01 10:57:14 -07002594 throw new IllegalStateException("Could not find a method " +
Joe Onorato42e14d72010-03-11 14:51:17 -08002595 handlerName + "(View) in the activity "
2596 + getContext().getClass() + " for onClick handler"
2597 + " on view " + View.this.getClass() + idText, e);
Romain Guy9a817362009-05-01 10:57:14 -07002598 }
2599 }
2600
2601 try {
2602 mHandler.invoke(getContext(), View.this);
2603 } catch (IllegalAccessException e) {
2604 throw new IllegalStateException("Could not execute non "
2605 + "public method of the activity", e);
2606 } catch (InvocationTargetException e) {
2607 throw new IllegalStateException("Could not execute "
2608 + "method of the activity", e);
2609 }
2610 }
2611 });
2612 }
2613 break;
Adam Powell637d3372010-08-25 14:37:03 -07002614 case R.styleable.View_overScrollMode:
2615 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS);
2616 break;
Adam Powell20232d02010-12-08 21:08:53 -08002617 case R.styleable.View_verticalScrollbarPosition:
2618 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT);
2619 break;
Romain Guy171c5922011-01-06 10:04:23 -08002620 case R.styleable.View_layerType:
2621 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null);
2622 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002623 }
2624 }
2625
Adam Powell637d3372010-08-25 14:37:03 -07002626 setOverScrollMode(overScrollMode);
2627
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002628 if (background != null) {
2629 setBackgroundDrawable(background);
2630 }
2631
2632 if (padding >= 0) {
2633 leftPadding = padding;
2634 topPadding = padding;
2635 rightPadding = padding;
2636 bottomPadding = padding;
2637 }
2638
2639 // If the user specified the padding (either with android:padding or
2640 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
2641 // use the default padding or the padding from the background drawable
2642 // (stored at this point in mPadding*)
2643 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
2644 topPadding >= 0 ? topPadding : mPaddingTop,
2645 rightPadding >= 0 ? rightPadding : mPaddingRight,
2646 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
2647
2648 if (viewFlagMasks != 0) {
2649 setFlags(viewFlagValues, viewFlagMasks);
2650 }
2651
2652 // Needs to be called after mViewFlags is set
2653 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2654 recomputePadding();
2655 }
2656
2657 if (x != 0 || y != 0) {
2658 scrollTo(x, y);
2659 }
2660
Chet Haase73066682010-11-29 15:55:32 -08002661 if (transformSet) {
2662 setTranslationX(tx);
2663 setTranslationY(ty);
2664 setRotation(rotation);
2665 setRotationX(rotationX);
2666 setRotationY(rotationY);
2667 setScaleX(sx);
2668 setScaleY(sy);
2669 }
2670
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002671 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
2672 setScrollContainer(true);
2673 }
Romain Guy8f1344f52009-05-15 16:03:59 -07002674
2675 computeOpaqueFlags();
2676
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002677 a.recycle();
2678 }
2679
2680 /**
2681 * Non-public constructor for use in testing
2682 */
2683 View() {
2684 }
2685
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002686 /**
2687 * <p>
2688 * Initializes the fading edges from a given set of styled attributes. This
2689 * method should be called by subclasses that need fading edges and when an
2690 * instance of these subclasses is created programmatically rather than
2691 * being inflated from XML. This method is automatically called when the XML
2692 * is inflated.
2693 * </p>
2694 *
2695 * @param a the styled attributes set to initialize the fading edges from
2696 */
2697 protected void initializeFadingEdge(TypedArray a) {
2698 initScrollCache();
2699
2700 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
2701 R.styleable.View_fadingEdgeLength,
2702 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
2703 }
2704
2705 /**
2706 * Returns the size of the vertical faded edges used to indicate that more
2707 * content in this view is visible.
2708 *
2709 * @return The size in pixels of the vertical faded edge or 0 if vertical
2710 * faded edges are not enabled for this view.
2711 * @attr ref android.R.styleable#View_fadingEdgeLength
2712 */
2713 public int getVerticalFadingEdgeLength() {
2714 if (isVerticalFadingEdgeEnabled()) {
2715 ScrollabilityCache cache = mScrollCache;
2716 if (cache != null) {
2717 return cache.fadingEdgeLength;
2718 }
2719 }
2720 return 0;
2721 }
2722
2723 /**
2724 * Set the size of the faded edge used to indicate that more content in this
2725 * view is available. Will not change whether the fading edge is enabled; use
2726 * {@link #setVerticalFadingEdgeEnabled} or {@link #setHorizontalFadingEdgeEnabled}
2727 * to enable the fading edge for the vertical or horizontal fading edges.
2728 *
2729 * @param length The size in pixels of the faded edge used to indicate that more
2730 * content in this view is visible.
2731 */
2732 public void setFadingEdgeLength(int length) {
2733 initScrollCache();
2734 mScrollCache.fadingEdgeLength = length;
2735 }
2736
2737 /**
2738 * Returns the size of the horizontal faded edges used to indicate that more
2739 * content in this view is visible.
2740 *
2741 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
2742 * faded edges are not enabled for this view.
2743 * @attr ref android.R.styleable#View_fadingEdgeLength
2744 */
2745 public int getHorizontalFadingEdgeLength() {
2746 if (isHorizontalFadingEdgeEnabled()) {
2747 ScrollabilityCache cache = mScrollCache;
2748 if (cache != null) {
2749 return cache.fadingEdgeLength;
2750 }
2751 }
2752 return 0;
2753 }
2754
2755 /**
2756 * Returns the width of the vertical scrollbar.
2757 *
2758 * @return The width in pixels of the vertical scrollbar or 0 if there
2759 * is no vertical scrollbar.
2760 */
2761 public int getVerticalScrollbarWidth() {
2762 ScrollabilityCache cache = mScrollCache;
2763 if (cache != null) {
2764 ScrollBarDrawable scrollBar = cache.scrollBar;
2765 if (scrollBar != null) {
2766 int size = scrollBar.getSize(true);
2767 if (size <= 0) {
2768 size = cache.scrollBarSize;
2769 }
2770 return size;
2771 }
2772 return 0;
2773 }
2774 return 0;
2775 }
2776
2777 /**
2778 * Returns the height of the horizontal scrollbar.
2779 *
2780 * @return The height in pixels of the horizontal scrollbar or 0 if
2781 * there is no horizontal scrollbar.
2782 */
2783 protected int getHorizontalScrollbarHeight() {
2784 ScrollabilityCache cache = mScrollCache;
2785 if (cache != null) {
2786 ScrollBarDrawable scrollBar = cache.scrollBar;
2787 if (scrollBar != null) {
2788 int size = scrollBar.getSize(false);
2789 if (size <= 0) {
2790 size = cache.scrollBarSize;
2791 }
2792 return size;
2793 }
2794 return 0;
2795 }
2796 return 0;
2797 }
2798
2799 /**
2800 * <p>
2801 * Initializes the scrollbars from a given set of styled attributes. This
2802 * method should be called by subclasses that need scrollbars and when an
2803 * instance of these subclasses is created programmatically rather than
2804 * being inflated from XML. This method is automatically called when the XML
2805 * is inflated.
2806 * </p>
2807 *
2808 * @param a the styled attributes set to initialize the scrollbars from
2809 */
2810 protected void initializeScrollbars(TypedArray a) {
2811 initScrollCache();
2812
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002813 final ScrollabilityCache scrollabilityCache = mScrollCache;
Mike Cleronf116bf82009-09-27 19:14:12 -07002814
2815 if (scrollabilityCache.scrollBar == null) {
2816 scrollabilityCache.scrollBar = new ScrollBarDrawable();
2817 }
2818
Romain Guy8bda2482010-03-02 11:42:11 -08002819 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002820
Mike Cleronf116bf82009-09-27 19:14:12 -07002821 if (!fadeScrollbars) {
2822 scrollabilityCache.state = ScrollabilityCache.ON;
2823 }
2824 scrollabilityCache.fadeScrollBars = fadeScrollbars;
2825
2826
2827 scrollabilityCache.scrollBarFadeDuration = a.getInt(
2828 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
2829 .getScrollBarFadeDuration());
2830 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
2831 R.styleable.View_scrollbarDefaultDelayBeforeFade,
2832 ViewConfiguration.getScrollDefaultDelay());
2833
2834
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002835 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
2836 com.android.internal.R.styleable.View_scrollbarSize,
2837 ViewConfiguration.get(mContext).getScaledScrollBarSize());
2838
2839 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
2840 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
2841
2842 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
2843 if (thumb != null) {
2844 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
2845 }
2846
2847 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
2848 false);
2849 if (alwaysDraw) {
2850 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
2851 }
2852
2853 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
2854 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
2855
2856 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
2857 if (thumb != null) {
2858 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
2859 }
2860
2861 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
2862 false);
2863 if (alwaysDraw) {
2864 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
2865 }
2866
2867 // Re-apply user/background padding so that scrollbar(s) get added
2868 recomputePadding();
2869 }
2870
2871 /**
2872 * <p>
2873 * Initalizes the scrollability cache if necessary.
2874 * </p>
2875 */
2876 private void initScrollCache() {
2877 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07002878 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002879 }
2880 }
2881
2882 /**
Adam Powell20232d02010-12-08 21:08:53 -08002883 * Set the position of the vertical scroll bar. Should be one of
2884 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or
2885 * {@link #SCROLLBAR_POSITION_RIGHT}.
2886 *
2887 * @param position Where the vertical scroll bar should be positioned.
2888 */
2889 public void setVerticalScrollbarPosition(int position) {
2890 if (mVerticalScrollbarPosition != position) {
2891 mVerticalScrollbarPosition = position;
2892 computeOpaqueFlags();
2893 recomputePadding();
2894 }
2895 }
2896
2897 /**
2898 * @return The position where the vertical scroll bar will show, if applicable.
2899 * @see #setVerticalScrollbarPosition(int)
2900 */
2901 public int getVerticalScrollbarPosition() {
2902 return mVerticalScrollbarPosition;
2903 }
2904
2905 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002906 * Register a callback to be invoked when focus of this view changed.
2907 *
2908 * @param l The callback that will run.
2909 */
2910 public void setOnFocusChangeListener(OnFocusChangeListener l) {
2911 mOnFocusChangeListener = l;
2912 }
2913
2914 /**
Chet Haase21cd1382010-09-01 17:42:29 -07002915 * Add a listener that will be called when the bounds of the view change due to
2916 * layout processing.
2917 *
2918 * @param listener The listener that will be called when layout bounds change.
2919 */
2920 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) {
2921 if (mOnLayoutChangeListeners == null) {
2922 mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>();
2923 }
2924 mOnLayoutChangeListeners.add(listener);
2925 }
2926
2927 /**
2928 * Remove a listener for layout changes.
2929 *
2930 * @param listener The listener for layout bounds change.
2931 */
2932 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) {
2933 if (mOnLayoutChangeListeners == null) {
2934 return;
2935 }
2936 mOnLayoutChangeListeners.remove(listener);
2937 }
2938
2939 /**
2940 * Gets the current list of listeners for layout changes.
Chet Haase21cd1382010-09-01 17:42:29 -07002941 */
2942 public List<OnLayoutChangeListener> getOnLayoutChangeListeners() {
2943 return mOnLayoutChangeListeners;
2944 }
2945
2946 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002947 * Returns the focus-change callback registered for this view.
2948 *
2949 * @return The callback, or null if one is not registered.
2950 */
2951 public OnFocusChangeListener getOnFocusChangeListener() {
2952 return mOnFocusChangeListener;
2953 }
2954
2955 /**
2956 * Register a callback to be invoked when this view is clicked. If this view is not
2957 * clickable, it becomes clickable.
2958 *
2959 * @param l The callback that will run
2960 *
2961 * @see #setClickable(boolean)
2962 */
2963 public void setOnClickListener(OnClickListener l) {
2964 if (!isClickable()) {
2965 setClickable(true);
2966 }
2967 mOnClickListener = l;
2968 }
2969
2970 /**
2971 * Register a callback to be invoked when this view is clicked and held. If this view is not
2972 * long clickable, it becomes long clickable.
2973 *
2974 * @param l The callback that will run
2975 *
2976 * @see #setLongClickable(boolean)
2977 */
2978 public void setOnLongClickListener(OnLongClickListener l) {
2979 if (!isLongClickable()) {
2980 setLongClickable(true);
2981 }
2982 mOnLongClickListener = l;
2983 }
2984
2985 /**
2986 * Register a callback to be invoked when the context menu for this view is
2987 * being built. If this view is not long clickable, it becomes long clickable.
2988 *
2989 * @param l The callback that will run
2990 *
2991 */
2992 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
2993 if (!isLongClickable()) {
2994 setLongClickable(true);
2995 }
2996 mOnCreateContextMenuListener = l;
2997 }
2998
2999 /**
3000 * Call this view's OnClickListener, if it is defined.
3001 *
3002 * @return True there was an assigned OnClickListener that was called, false
3003 * otherwise is returned.
3004 */
3005 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003006 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
3007
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003008 if (mOnClickListener != null) {
3009 playSoundEffect(SoundEffectConstants.CLICK);
3010 mOnClickListener.onClick(this);
3011 return true;
3012 }
3013
3014 return false;
3015 }
3016
3017 /**
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003018 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the
3019 * OnLongClickListener did not consume the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003020 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003021 * @return True if one of the above receivers consumed the event, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003022 */
3023 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003024 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
3025
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003026 boolean handled = false;
3027 if (mOnLongClickListener != null) {
3028 handled = mOnLongClickListener.onLongClick(View.this);
3029 }
3030 if (!handled) {
3031 handled = showContextMenu();
3032 }
3033 if (handled) {
3034 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
3035 }
3036 return handled;
3037 }
3038
3039 /**
3040 * Bring up the context menu for this view.
3041 *
3042 * @return Whether a context menu was displayed.
3043 */
3044 public boolean showContextMenu() {
3045 return getParent().showContextMenuForChild(this);
3046 }
3047
3048 /**
Adam Powell6e346362010-07-23 10:18:23 -07003049 * Start an action mode.
3050 *
3051 * @param callback Callback that will control the lifecycle of the action mode
3052 * @return The new action mode if it is started, null otherwise
3053 *
3054 * @see ActionMode
3055 */
3056 public ActionMode startActionMode(ActionMode.Callback callback) {
3057 return getParent().startActionModeForChild(this, callback);
3058 }
3059
3060 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003061 * Register a callback to be invoked when a key is pressed in this view.
3062 * @param l the key listener to attach to this view
3063 */
3064 public void setOnKeyListener(OnKeyListener l) {
3065 mOnKeyListener = l;
3066 }
3067
3068 /**
3069 * Register a callback to be invoked when a touch event is sent to this view.
3070 * @param l the touch listener to attach to this view
3071 */
3072 public void setOnTouchListener(OnTouchListener l) {
3073 mOnTouchListener = l;
3074 }
3075
3076 /**
Chris Tate32affef2010-10-18 15:29:21 -07003077 * Register a callback to be invoked when a drag event is sent to this view.
3078 * @param l The drag listener to attach to this view
3079 */
3080 public void setOnDragListener(OnDragListener l) {
3081 mOnDragListener = l;
3082 }
3083
3084 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003085 * Give this view focus. This will cause {@link #onFocusChanged} to be called.
3086 *
3087 * Note: this does not check whether this {@link View} should get focus, it just
3088 * gives it focus no matter what. It should only be called internally by framework
3089 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
3090 *
3091 * @param direction values are View.FOCUS_UP, View.FOCUS_DOWN,
3092 * View.FOCUS_LEFT or View.FOCUS_RIGHT. This is the direction which
3093 * focus moved when requestFocus() is called. It may not always
3094 * apply, in which case use the default View.FOCUS_DOWN.
3095 * @param previouslyFocusedRect The rectangle of the view that had focus
3096 * prior in this View's coordinate system.
3097 */
3098 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
3099 if (DBG) {
3100 System.out.println(this + " requestFocus()");
3101 }
3102
3103 if ((mPrivateFlags & FOCUSED) == 0) {
3104 mPrivateFlags |= FOCUSED;
3105
3106 if (mParent != null) {
3107 mParent.requestChildFocus(this, this);
3108 }
3109
3110 onFocusChanged(true, direction, previouslyFocusedRect);
3111 refreshDrawableState();
3112 }
3113 }
3114
3115 /**
3116 * Request that a rectangle of this view be visible on the screen,
3117 * scrolling if necessary just enough.
3118 *
3119 * <p>A View should call this if it maintains some notion of which part
3120 * of its content is interesting. For example, a text editing view
3121 * should call this when its cursor moves.
3122 *
3123 * @param rectangle The rectangle.
3124 * @return Whether any parent scrolled.
3125 */
3126 public boolean requestRectangleOnScreen(Rect rectangle) {
3127 return requestRectangleOnScreen(rectangle, false);
3128 }
3129
3130 /**
3131 * Request that a rectangle of this view be visible on the screen,
3132 * scrolling if necessary just enough.
3133 *
3134 * <p>A View should call this if it maintains some notion of which part
3135 * of its content is interesting. For example, a text editing view
3136 * should call this when its cursor moves.
3137 *
3138 * <p>When <code>immediate</code> is set to true, scrolling will not be
3139 * animated.
3140 *
3141 * @param rectangle The rectangle.
3142 * @param immediate True to forbid animated scrolling, false otherwise
3143 * @return Whether any parent scrolled.
3144 */
3145 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
3146 View child = this;
3147 ViewParent parent = mParent;
3148 boolean scrolled = false;
3149 while (parent != null) {
3150 scrolled |= parent.requestChildRectangleOnScreen(child,
3151 rectangle, immediate);
3152
3153 // offset rect so next call has the rectangle in the
3154 // coordinate system of its direct child.
3155 rectangle.offset(child.getLeft(), child.getTop());
3156 rectangle.offset(-child.getScrollX(), -child.getScrollY());
3157
3158 if (!(parent instanceof View)) {
3159 break;
3160 }
Romain Guy8506ab42009-06-11 17:35:47 -07003161
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003162 child = (View) parent;
3163 parent = child.getParent();
3164 }
3165 return scrolled;
3166 }
3167
3168 /**
3169 * Called when this view wants to give up focus. This will cause
3170 * {@link #onFocusChanged} to be called.
3171 */
3172 public void clearFocus() {
3173 if (DBG) {
3174 System.out.println(this + " clearFocus()");
3175 }
3176
3177 if ((mPrivateFlags & FOCUSED) != 0) {
3178 mPrivateFlags &= ~FOCUSED;
3179
3180 if (mParent != null) {
3181 mParent.clearChildFocus(this);
3182 }
3183
3184 onFocusChanged(false, 0, null);
3185 refreshDrawableState();
3186 }
3187 }
3188
3189 /**
3190 * Called to clear the focus of a view that is about to be removed.
3191 * Doesn't call clearChildFocus, which prevents this view from taking
3192 * focus again before it has been removed from the parent
3193 */
3194 void clearFocusForRemoval() {
3195 if ((mPrivateFlags & FOCUSED) != 0) {
3196 mPrivateFlags &= ~FOCUSED;
3197
3198 onFocusChanged(false, 0, null);
3199 refreshDrawableState();
3200 }
3201 }
3202
3203 /**
3204 * Called internally by the view system when a new view is getting focus.
3205 * This is what clears the old focus.
3206 */
3207 void unFocus() {
3208 if (DBG) {
3209 System.out.println(this + " unFocus()");
3210 }
3211
3212 if ((mPrivateFlags & FOCUSED) != 0) {
3213 mPrivateFlags &= ~FOCUSED;
3214
3215 onFocusChanged(false, 0, null);
3216 refreshDrawableState();
3217 }
3218 }
3219
3220 /**
3221 * Returns true if this view has focus iteself, or is the ancestor of the
3222 * view that has focus.
3223 *
3224 * @return True if this view has or contains focus, false otherwise.
3225 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003226 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003227 public boolean hasFocus() {
3228 return (mPrivateFlags & FOCUSED) != 0;
3229 }
3230
3231 /**
3232 * Returns true if this view is focusable or if it contains a reachable View
3233 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
3234 * is a View whose parents do not block descendants focus.
3235 *
3236 * Only {@link #VISIBLE} views are considered focusable.
3237 *
3238 * @return True if the view is focusable or if the view contains a focusable
3239 * View, false otherwise.
3240 *
3241 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
3242 */
3243 public boolean hasFocusable() {
3244 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
3245 }
3246
3247 /**
3248 * Called by the view system when the focus state of this view changes.
3249 * When the focus change event is caused by directional navigation, direction
3250 * and previouslyFocusedRect provide insight into where the focus is coming from.
3251 * When overriding, be sure to call up through to the super class so that
3252 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07003253 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003254 * @param gainFocus True if the View has focus; false otherwise.
3255 * @param direction The direction focus has moved when requestFocus()
3256 * is called to give this view focus. Values are
Jeff Brown4e6319b2010-12-13 10:36:51 -08003257 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT},
3258 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}.
3259 * It may not always apply, in which case use the default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003260 * @param previouslyFocusedRect The rectangle, in this view's coordinate
3261 * system, of the previously focused view. If applicable, this will be
3262 * passed in as finer grained information about where the focus is coming
3263 * from (in addition to direction). Will be <code>null</code> otherwise.
3264 */
3265 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07003266 if (gainFocus) {
3267 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
3268 }
3269
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003270 InputMethodManager imm = InputMethodManager.peekInstance();
3271 if (!gainFocus) {
3272 if (isPressed()) {
3273 setPressed(false);
3274 }
3275 if (imm != null && mAttachInfo != null
3276 && mAttachInfo.mHasWindowFocus) {
3277 imm.focusOut(this);
3278 }
Romain Guya2431d02009-04-30 16:30:00 -07003279 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003280 } else if (imm != null && mAttachInfo != null
3281 && mAttachInfo.mHasWindowFocus) {
3282 imm.focusIn(this);
3283 }
Romain Guy8506ab42009-06-11 17:35:47 -07003284
Romain Guy0fd89bf2011-01-26 15:41:30 -08003285 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003286 if (mOnFocusChangeListener != null) {
3287 mOnFocusChangeListener.onFocusChange(this, gainFocus);
3288 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07003289
3290 if (mAttachInfo != null) {
3291 mAttachInfo.mKeyDispatchState.reset(this);
3292 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003293 }
3294
3295 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07003296 * {@inheritDoc}
3297 */
3298 public void sendAccessibilityEvent(int eventType) {
3299 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
3300 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
3301 }
3302 }
3303
3304 /**
3305 * {@inheritDoc}
3306 */
3307 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
Svetoslav Ganov9cd1eca2011-01-13 14:24:02 -08003308 if (!isShown()) {
3309 return;
3310 }
svetoslavganov75986cf2009-05-14 22:28:01 -07003311 event.setClassName(getClass().getName());
3312 event.setPackageName(getContext().getPackageName());
3313 event.setEnabled(isEnabled());
3314 event.setContentDescription(mContentDescription);
3315
3316 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) {
3317 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList;
3318 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, FOCUSABLES_ALL);
3319 event.setItemCount(focusablesTempList.size());
3320 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
3321 focusablesTempList.clear();
3322 }
3323
3324 dispatchPopulateAccessibilityEvent(event);
3325
3326 AccessibilityManager.getInstance(mContext).sendAccessibilityEvent(event);
3327 }
3328
3329 /**
3330 * Dispatches an {@link AccessibilityEvent} to the {@link View} children
3331 * to be populated.
3332 *
3333 * @param event The event.
3334 *
3335 * @return True if the event population was completed.
3336 */
3337 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
3338 return false;
3339 }
3340
3341 /**
3342 * Gets the {@link View} description. It briefly describes the view and is
3343 * primarily used for accessibility support. Set this property to enable
3344 * better accessibility support for your application. This is especially
3345 * true for views that do not have textual representation (For example,
3346 * ImageButton).
3347 *
3348 * @return The content descriptiopn.
3349 *
3350 * @attr ref android.R.styleable#View_contentDescription
3351 */
3352 public CharSequence getContentDescription() {
3353 return mContentDescription;
3354 }
3355
3356 /**
3357 * Sets the {@link View} description. It briefly describes the view and is
3358 * primarily used for accessibility support. Set this property to enable
3359 * better accessibility support for your application. This is especially
3360 * true for views that do not have textual representation (For example,
3361 * ImageButton).
3362 *
3363 * @param contentDescription The content description.
3364 *
3365 * @attr ref android.R.styleable#View_contentDescription
3366 */
3367 public void setContentDescription(CharSequence contentDescription) {
3368 mContentDescription = contentDescription;
3369 }
3370
3371 /**
Romain Guya2431d02009-04-30 16:30:00 -07003372 * Invoked whenever this view loses focus, either by losing window focus or by losing
3373 * focus within its window. This method can be used to clear any state tied to the
3374 * focus. For instance, if a button is held pressed with the trackball and the window
3375 * loses focus, this method can be used to cancel the press.
3376 *
3377 * Subclasses of View overriding this method should always call super.onFocusLost().
3378 *
3379 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07003380 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07003381 *
3382 * @hide pending API council approval
3383 */
3384 protected void onFocusLost() {
3385 resetPressedState();
3386 }
3387
3388 private void resetPressedState() {
3389 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
3390 return;
3391 }
3392
3393 if (isPressed()) {
3394 setPressed(false);
3395
3396 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05003397 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07003398 }
3399 }
3400 }
3401
3402 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003403 * Returns true if this view has focus
3404 *
3405 * @return True if this view has focus, false otherwise.
3406 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003407 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003408 public boolean isFocused() {
3409 return (mPrivateFlags & FOCUSED) != 0;
3410 }
3411
3412 /**
3413 * Find the view in the hierarchy rooted at this view that currently has
3414 * focus.
3415 *
3416 * @return The view that currently has focus, or null if no focused view can
3417 * be found.
3418 */
3419 public View findFocus() {
3420 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
3421 }
3422
3423 /**
3424 * Change whether this view is one of the set of scrollable containers in
3425 * its window. This will be used to determine whether the window can
3426 * resize or must pan when a soft input area is open -- scrollable
3427 * containers allow the window to use resize mode since the container
3428 * will appropriately shrink.
3429 */
3430 public void setScrollContainer(boolean isScrollContainer) {
3431 if (isScrollContainer) {
3432 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
3433 mAttachInfo.mScrollContainers.add(this);
3434 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
3435 }
3436 mPrivateFlags |= SCROLL_CONTAINER;
3437 } else {
3438 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
3439 mAttachInfo.mScrollContainers.remove(this);
3440 }
3441 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
3442 }
3443 }
3444
3445 /**
3446 * Returns the quality of the drawing cache.
3447 *
3448 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3449 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3450 *
3451 * @see #setDrawingCacheQuality(int)
3452 * @see #setDrawingCacheEnabled(boolean)
3453 * @see #isDrawingCacheEnabled()
3454 *
3455 * @attr ref android.R.styleable#View_drawingCacheQuality
3456 */
3457 public int getDrawingCacheQuality() {
3458 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
3459 }
3460
3461 /**
3462 * Set the drawing cache quality of this view. This value is used only when the
3463 * drawing cache is enabled
3464 *
3465 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3466 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3467 *
3468 * @see #getDrawingCacheQuality()
3469 * @see #setDrawingCacheEnabled(boolean)
3470 * @see #isDrawingCacheEnabled()
3471 *
3472 * @attr ref android.R.styleable#View_drawingCacheQuality
3473 */
3474 public void setDrawingCacheQuality(int quality) {
3475 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
3476 }
3477
3478 /**
3479 * Returns whether the screen should remain on, corresponding to the current
3480 * value of {@link #KEEP_SCREEN_ON}.
3481 *
3482 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
3483 *
3484 * @see #setKeepScreenOn(boolean)
3485 *
3486 * @attr ref android.R.styleable#View_keepScreenOn
3487 */
3488 public boolean getKeepScreenOn() {
3489 return (mViewFlags & KEEP_SCREEN_ON) != 0;
3490 }
3491
3492 /**
3493 * Controls whether the screen should remain on, modifying the
3494 * value of {@link #KEEP_SCREEN_ON}.
3495 *
3496 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
3497 *
3498 * @see #getKeepScreenOn()
3499 *
3500 * @attr ref android.R.styleable#View_keepScreenOn
3501 */
3502 public void setKeepScreenOn(boolean keepScreenOn) {
3503 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
3504 }
3505
3506 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003507 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
3508 * @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 -08003509 *
3510 * @attr ref android.R.styleable#View_nextFocusLeft
3511 */
3512 public int getNextFocusLeftId() {
3513 return mNextFocusLeftId;
3514 }
3515
3516 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003517 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
3518 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
3519 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003520 *
3521 * @attr ref android.R.styleable#View_nextFocusLeft
3522 */
3523 public void setNextFocusLeftId(int nextFocusLeftId) {
3524 mNextFocusLeftId = nextFocusLeftId;
3525 }
3526
3527 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003528 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
3529 * @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 -08003530 *
3531 * @attr ref android.R.styleable#View_nextFocusRight
3532 */
3533 public int getNextFocusRightId() {
3534 return mNextFocusRightId;
3535 }
3536
3537 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003538 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
3539 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
3540 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003541 *
3542 * @attr ref android.R.styleable#View_nextFocusRight
3543 */
3544 public void setNextFocusRightId(int nextFocusRightId) {
3545 mNextFocusRightId = nextFocusRightId;
3546 }
3547
3548 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003549 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
3550 * @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 -08003551 *
3552 * @attr ref android.R.styleable#View_nextFocusUp
3553 */
3554 public int getNextFocusUpId() {
3555 return mNextFocusUpId;
3556 }
3557
3558 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003559 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
3560 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
3561 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003562 *
3563 * @attr ref android.R.styleable#View_nextFocusUp
3564 */
3565 public void setNextFocusUpId(int nextFocusUpId) {
3566 mNextFocusUpId = nextFocusUpId;
3567 }
3568
3569 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003570 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
3571 * @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 -08003572 *
3573 * @attr ref android.R.styleable#View_nextFocusDown
3574 */
3575 public int getNextFocusDownId() {
3576 return mNextFocusDownId;
3577 }
3578
3579 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003580 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
3581 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
3582 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003583 *
3584 * @attr ref android.R.styleable#View_nextFocusDown
3585 */
3586 public void setNextFocusDownId(int nextFocusDownId) {
3587 mNextFocusDownId = nextFocusDownId;
3588 }
3589
3590 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003591 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
3592 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
3593 *
3594 * @attr ref android.R.styleable#View_nextFocusForward
3595 */
3596 public int getNextFocusForwardId() {
3597 return mNextFocusForwardId;
3598 }
3599
3600 /**
3601 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
3602 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
3603 * decide automatically.
3604 *
3605 * @attr ref android.R.styleable#View_nextFocusForward
3606 */
3607 public void setNextFocusForwardId(int nextFocusForwardId) {
3608 mNextFocusForwardId = nextFocusForwardId;
3609 }
3610
3611 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003612 * Returns the visibility of this view and all of its ancestors
3613 *
3614 * @return True if this view and all of its ancestors are {@link #VISIBLE}
3615 */
3616 public boolean isShown() {
3617 View current = this;
3618 //noinspection ConstantConditions
3619 do {
3620 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
3621 return false;
3622 }
3623 ViewParent parent = current.mParent;
3624 if (parent == null) {
3625 return false; // We are not attached to the view root
3626 }
3627 if (!(parent instanceof View)) {
3628 return true;
3629 }
3630 current = (View) parent;
3631 } while (current != null);
3632
3633 return false;
3634 }
3635
3636 /**
3637 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag
3638 * is set
3639 *
3640 * @param insets Insets for system windows
3641 *
3642 * @return True if this view applied the insets, false otherwise
3643 */
3644 protected boolean fitSystemWindows(Rect insets) {
3645 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
3646 mPaddingLeft = insets.left;
3647 mPaddingTop = insets.top;
3648 mPaddingRight = insets.right;
3649 mPaddingBottom = insets.bottom;
3650 requestLayout();
3651 return true;
3652 }
3653 return false;
3654 }
3655
3656 /**
Jim Miller0b2a6d02010-07-13 18:01:29 -07003657 * Determine if this view has the FITS_SYSTEM_WINDOWS flag set.
3658 * @return True if window has FITS_SYSTEM_WINDOWS set
3659 *
3660 * @hide
3661 */
3662 public boolean isFitsSystemWindowsFlagSet() {
3663 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
3664 }
3665
3666 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003667 * Returns the visibility status for this view.
3668 *
3669 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3670 * @attr ref android.R.styleable#View_visibility
3671 */
3672 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07003673 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
3674 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
3675 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003676 })
3677 public int getVisibility() {
3678 return mViewFlags & VISIBILITY_MASK;
3679 }
3680
3681 /**
3682 * Set the enabled state of this view.
3683 *
3684 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3685 * @attr ref android.R.styleable#View_visibility
3686 */
3687 @RemotableViewMethod
3688 public void setVisibility(int visibility) {
3689 setFlags(visibility, VISIBILITY_MASK);
3690 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false);
3691 }
3692
3693 /**
3694 * Returns the enabled status for this view. The interpretation of the
3695 * enabled state varies by subclass.
3696 *
3697 * @return True if this view is enabled, false otherwise.
3698 */
3699 @ViewDebug.ExportedProperty
3700 public boolean isEnabled() {
3701 return (mViewFlags & ENABLED_MASK) == ENABLED;
3702 }
3703
3704 /**
3705 * Set the enabled state of this view. The interpretation of the enabled
3706 * state varies by subclass.
3707 *
3708 * @param enabled True if this view is enabled, false otherwise.
3709 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08003710 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003711 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07003712 if (enabled == isEnabled()) return;
3713
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003714 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
3715
3716 /*
3717 * The View most likely has to change its appearance, so refresh
3718 * the drawable state.
3719 */
3720 refreshDrawableState();
3721
3722 // Invalidate too, since the default behavior for views is to be
3723 // be drawn at 50% alpha rather than to change the drawable.
Romain Guy0fd89bf2011-01-26 15:41:30 -08003724 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003725 }
3726
3727 /**
3728 * Set whether this view can receive the focus.
3729 *
3730 * Setting this to false will also ensure that this view is not focusable
3731 * in touch mode.
3732 *
3733 * @param focusable If true, this view can receive the focus.
3734 *
3735 * @see #setFocusableInTouchMode(boolean)
3736 * @attr ref android.R.styleable#View_focusable
3737 */
3738 public void setFocusable(boolean focusable) {
3739 if (!focusable) {
3740 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
3741 }
3742 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
3743 }
3744
3745 /**
3746 * Set whether this view can receive focus while in touch mode.
3747 *
3748 * Setting this to true will also ensure that this view is focusable.
3749 *
3750 * @param focusableInTouchMode If true, this view can receive the focus while
3751 * in touch mode.
3752 *
3753 * @see #setFocusable(boolean)
3754 * @attr ref android.R.styleable#View_focusableInTouchMode
3755 */
3756 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
3757 // Focusable in touch mode should always be set before the focusable flag
3758 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
3759 // which, in touch mode, will not successfully request focus on this view
3760 // because the focusable in touch mode flag is not set
3761 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
3762 if (focusableInTouchMode) {
3763 setFlags(FOCUSABLE, FOCUSABLE_MASK);
3764 }
3765 }
3766
3767 /**
3768 * Set whether this view should have sound effects enabled for events such as
3769 * clicking and touching.
3770 *
3771 * <p>You may wish to disable sound effects for a view if you already play sounds,
3772 * for instance, a dial key that plays dtmf tones.
3773 *
3774 * @param soundEffectsEnabled whether sound effects are enabled for this view.
3775 * @see #isSoundEffectsEnabled()
3776 * @see #playSoundEffect(int)
3777 * @attr ref android.R.styleable#View_soundEffectsEnabled
3778 */
3779 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
3780 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
3781 }
3782
3783 /**
3784 * @return whether this view should have sound effects enabled for events such as
3785 * clicking and touching.
3786 *
3787 * @see #setSoundEffectsEnabled(boolean)
3788 * @see #playSoundEffect(int)
3789 * @attr ref android.R.styleable#View_soundEffectsEnabled
3790 */
3791 @ViewDebug.ExportedProperty
3792 public boolean isSoundEffectsEnabled() {
3793 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
3794 }
3795
3796 /**
3797 * Set whether this view should have haptic feedback for events such as
3798 * long presses.
3799 *
3800 * <p>You may wish to disable haptic feedback if your view already controls
3801 * its own haptic feedback.
3802 *
3803 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
3804 * @see #isHapticFeedbackEnabled()
3805 * @see #performHapticFeedback(int)
3806 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3807 */
3808 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
3809 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
3810 }
3811
3812 /**
3813 * @return whether this view should have haptic feedback enabled for events
3814 * long presses.
3815 *
3816 * @see #setHapticFeedbackEnabled(boolean)
3817 * @see #performHapticFeedback(int)
3818 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3819 */
3820 @ViewDebug.ExportedProperty
3821 public boolean isHapticFeedbackEnabled() {
3822 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
3823 }
3824
3825 /**
3826 * If this view doesn't do any drawing on its own, set this flag to
3827 * allow further optimizations. By default, this flag is not set on
3828 * View, but could be set on some View subclasses such as ViewGroup.
3829 *
3830 * Typically, if you override {@link #onDraw} you should clear this flag.
3831 *
3832 * @param willNotDraw whether or not this View draw on its own
3833 */
3834 public void setWillNotDraw(boolean willNotDraw) {
3835 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
3836 }
3837
3838 /**
3839 * Returns whether or not this View draws on its own.
3840 *
3841 * @return true if this view has nothing to draw, false otherwise
3842 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003843 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003844 public boolean willNotDraw() {
3845 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
3846 }
3847
3848 /**
3849 * When a View's drawing cache is enabled, drawing is redirected to an
3850 * offscreen bitmap. Some views, like an ImageView, must be able to
3851 * bypass this mechanism if they already draw a single bitmap, to avoid
3852 * unnecessary usage of the memory.
3853 *
3854 * @param willNotCacheDrawing true if this view does not cache its
3855 * drawing, false otherwise
3856 */
3857 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
3858 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
3859 }
3860
3861 /**
3862 * Returns whether or not this View can cache its drawing or not.
3863 *
3864 * @return true if this view does not cache its drawing, false otherwise
3865 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003866 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003867 public boolean willNotCacheDrawing() {
3868 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
3869 }
3870
3871 /**
3872 * Indicates whether this view reacts to click events or not.
3873 *
3874 * @return true if the view is clickable, false otherwise
3875 *
3876 * @see #setClickable(boolean)
3877 * @attr ref android.R.styleable#View_clickable
3878 */
3879 @ViewDebug.ExportedProperty
3880 public boolean isClickable() {
3881 return (mViewFlags & CLICKABLE) == CLICKABLE;
3882 }
3883
3884 /**
3885 * Enables or disables click events for this view. When a view
3886 * is clickable it will change its state to "pressed" on every click.
3887 * Subclasses should set the view clickable to visually react to
3888 * user's clicks.
3889 *
3890 * @param clickable true to make the view clickable, false otherwise
3891 *
3892 * @see #isClickable()
3893 * @attr ref android.R.styleable#View_clickable
3894 */
3895 public void setClickable(boolean clickable) {
3896 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
3897 }
3898
3899 /**
3900 * Indicates whether this view reacts to long click events or not.
3901 *
3902 * @return true if the view is long clickable, false otherwise
3903 *
3904 * @see #setLongClickable(boolean)
3905 * @attr ref android.R.styleable#View_longClickable
3906 */
3907 public boolean isLongClickable() {
3908 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
3909 }
3910
3911 /**
3912 * Enables or disables long click events for this view. When a view is long
3913 * clickable it reacts to the user holding down the button for a longer
3914 * duration than a tap. This event can either launch the listener or a
3915 * context menu.
3916 *
3917 * @param longClickable true to make the view long clickable, false otherwise
3918 * @see #isLongClickable()
3919 * @attr ref android.R.styleable#View_longClickable
3920 */
3921 public void setLongClickable(boolean longClickable) {
3922 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
3923 }
3924
3925 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07003926 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003927 *
3928 * @see #isClickable()
3929 * @see #setClickable(boolean)
3930 *
3931 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
3932 * the View's internal state from a previously set "pressed" state.
3933 */
3934 public void setPressed(boolean pressed) {
3935 if (pressed) {
3936 mPrivateFlags |= PRESSED;
3937 } else {
3938 mPrivateFlags &= ~PRESSED;
3939 }
3940 refreshDrawableState();
3941 dispatchSetPressed(pressed);
3942 }
3943
3944 /**
3945 * Dispatch setPressed to all of this View's children.
3946 *
3947 * @see #setPressed(boolean)
3948 *
3949 * @param pressed The new pressed state
3950 */
3951 protected void dispatchSetPressed(boolean pressed) {
3952 }
3953
3954 /**
3955 * Indicates whether the view is currently in pressed state. Unless
3956 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
3957 * the pressed state.
3958 *
3959 * @see #setPressed
3960 * @see #isClickable()
3961 * @see #setClickable(boolean)
3962 *
3963 * @return true if the view is currently pressed, false otherwise
3964 */
3965 public boolean isPressed() {
3966 return (mPrivateFlags & PRESSED) == PRESSED;
3967 }
3968
3969 /**
3970 * Indicates whether this view will save its state (that is,
3971 * whether its {@link #onSaveInstanceState} method will be called).
3972 *
3973 * @return Returns true if the view state saving is enabled, else false.
3974 *
3975 * @see #setSaveEnabled(boolean)
3976 * @attr ref android.R.styleable#View_saveEnabled
3977 */
3978 public boolean isSaveEnabled() {
3979 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
3980 }
3981
3982 /**
3983 * Controls whether the saving of this view's state is
3984 * enabled (that is, whether its {@link #onSaveInstanceState} method
3985 * will be called). Note that even if freezing is enabled, the
3986 * view still must have an id assigned to it (via {@link #setId setId()})
3987 * for its state to be saved. This flag can only disable the
3988 * saving of this view; any child views may still have their state saved.
3989 *
3990 * @param enabled Set to false to <em>disable</em> state saving, or true
3991 * (the default) to allow it.
3992 *
3993 * @see #isSaveEnabled()
3994 * @see #setId(int)
3995 * @see #onSaveInstanceState()
3996 * @attr ref android.R.styleable#View_saveEnabled
3997 */
3998 public void setSaveEnabled(boolean enabled) {
3999 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
4000 }
4001
Jeff Brown85a31762010-09-01 17:01:00 -07004002 /**
4003 * Gets whether the framework should discard touches when the view's
4004 * window is obscured by another visible window.
4005 * Refer to the {@link View} security documentation for more details.
4006 *
4007 * @return True if touch filtering is enabled.
4008 *
4009 * @see #setFilterTouchesWhenObscured(boolean)
4010 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
4011 */
4012 @ViewDebug.ExportedProperty
4013 public boolean getFilterTouchesWhenObscured() {
4014 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
4015 }
4016
4017 /**
4018 * Sets whether the framework should discard touches when the view's
4019 * window is obscured by another visible window.
4020 * Refer to the {@link View} security documentation for more details.
4021 *
4022 * @param enabled True if touch filtering should be enabled.
4023 *
4024 * @see #getFilterTouchesWhenObscured
4025 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
4026 */
4027 public void setFilterTouchesWhenObscured(boolean enabled) {
4028 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
4029 FILTER_TOUCHES_WHEN_OBSCURED);
4030 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004031
4032 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004033 * Indicates whether the entire hierarchy under this view will save its
4034 * state when a state saving traversal occurs from its parent. The default
4035 * is true; if false, these views will not be saved unless
4036 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4037 *
4038 * @return Returns true if the view state saving from parent is enabled, else false.
4039 *
4040 * @see #setSaveFromParentEnabled(boolean)
4041 */
4042 public boolean isSaveFromParentEnabled() {
4043 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
4044 }
4045
4046 /**
4047 * Controls whether the entire hierarchy under this view will save its
4048 * state when a state saving traversal occurs from its parent. The default
4049 * is true; if false, these views will not be saved unless
4050 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4051 *
4052 * @param enabled Set to false to <em>disable</em> state saving, or true
4053 * (the default) to allow it.
4054 *
4055 * @see #isSaveFromParentEnabled()
4056 * @see #setId(int)
4057 * @see #onSaveInstanceState()
4058 */
4059 public void setSaveFromParentEnabled(boolean enabled) {
4060 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
4061 }
4062
4063
4064 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004065 * Returns whether this View is able to take focus.
4066 *
4067 * @return True if this view can take focus, or false otherwise.
4068 * @attr ref android.R.styleable#View_focusable
4069 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004070 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004071 public final boolean isFocusable() {
4072 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
4073 }
4074
4075 /**
4076 * When a view is focusable, it may not want to take focus when in touch mode.
4077 * For example, a button would like focus when the user is navigating via a D-pad
4078 * so that the user can click on it, but once the user starts touching the screen,
4079 * the button shouldn't take focus
4080 * @return Whether the view is focusable in touch mode.
4081 * @attr ref android.R.styleable#View_focusableInTouchMode
4082 */
4083 @ViewDebug.ExportedProperty
4084 public final boolean isFocusableInTouchMode() {
4085 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
4086 }
4087
4088 /**
4089 * Find the nearest view in the specified direction that can take focus.
4090 * This does not actually give focus to that view.
4091 *
4092 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4093 *
4094 * @return The nearest focusable in the specified direction, or null if none
4095 * can be found.
4096 */
4097 public View focusSearch(int direction) {
4098 if (mParent != null) {
4099 return mParent.focusSearch(this, direction);
4100 } else {
4101 return null;
4102 }
4103 }
4104
4105 /**
4106 * This method is the last chance for the focused view and its ancestors to
4107 * respond to an arrow key. This is called when the focused view did not
4108 * consume the key internally, nor could the view system find a new view in
4109 * the requested direction to give focus to.
4110 *
4111 * @param focused The currently focused view.
4112 * @param direction The direction focus wants to move. One of FOCUS_UP,
4113 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
4114 * @return True if the this view consumed this unhandled move.
4115 */
4116 public boolean dispatchUnhandledMove(View focused, int direction) {
4117 return false;
4118 }
4119
4120 /**
4121 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08004122 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004123 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08004124 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
4125 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004126 * @return The user specified next view, or null if there is none.
4127 */
4128 View findUserSetNextFocus(View root, int direction) {
4129 switch (direction) {
4130 case FOCUS_LEFT:
4131 if (mNextFocusLeftId == View.NO_ID) return null;
4132 return findViewShouldExist(root, mNextFocusLeftId);
4133 case FOCUS_RIGHT:
4134 if (mNextFocusRightId == View.NO_ID) return null;
4135 return findViewShouldExist(root, mNextFocusRightId);
4136 case FOCUS_UP:
4137 if (mNextFocusUpId == View.NO_ID) return null;
4138 return findViewShouldExist(root, mNextFocusUpId);
4139 case FOCUS_DOWN:
4140 if (mNextFocusDownId == View.NO_ID) return null;
4141 return findViewShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08004142 case FOCUS_FORWARD:
4143 if (mNextFocusForwardId == View.NO_ID) return null;
4144 return findViewShouldExist(root, mNextFocusForwardId);
4145 case FOCUS_BACKWARD: {
4146 final int id = mID;
4147 return root.findViewByPredicate(new Predicate<View>() {
4148 @Override
4149 public boolean apply(View t) {
4150 return t.mNextFocusForwardId == id;
4151 }
4152 });
4153 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004154 }
4155 return null;
4156 }
4157
4158 private static View findViewShouldExist(View root, int childViewId) {
4159 View result = root.findViewById(childViewId);
4160 if (result == null) {
4161 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
4162 + "by user for id " + childViewId);
4163 }
4164 return result;
4165 }
4166
4167 /**
4168 * Find and return all focusable views that are descendants of this view,
4169 * possibly including this view if it is focusable itself.
4170 *
4171 * @param direction The direction of the focus
4172 * @return A list of focusable views
4173 */
4174 public ArrayList<View> getFocusables(int direction) {
4175 ArrayList<View> result = new ArrayList<View>(24);
4176 addFocusables(result, direction);
4177 return result;
4178 }
4179
4180 /**
4181 * Add any focusable views that are descendants of this view (possibly
4182 * including this view if it is focusable itself) to views. If we are in touch mode,
4183 * only add views that are also focusable in touch mode.
4184 *
4185 * @param views Focusable views found so far
4186 * @param direction The direction of the focus
4187 */
4188 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004189 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
4190 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004191
svetoslavganov75986cf2009-05-14 22:28:01 -07004192 /**
4193 * Adds any focusable views that are descendants of this view (possibly
4194 * including this view if it is focusable itself) to views. This method
4195 * adds all focusable views regardless if we are in touch mode or
4196 * only views focusable in touch mode if we are in touch mode depending on
4197 * the focusable mode paramater.
4198 *
4199 * @param views Focusable views found so far or null if all we are interested is
4200 * the number of focusables.
4201 * @param direction The direction of the focus.
4202 * @param focusableMode The type of focusables to be added.
4203 *
4204 * @see #FOCUSABLES_ALL
4205 * @see #FOCUSABLES_TOUCH_MODE
4206 */
4207 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
4208 if (!isFocusable()) {
4209 return;
4210 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004211
svetoslavganov75986cf2009-05-14 22:28:01 -07004212 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE &&
4213 isInTouchMode() && !isFocusableInTouchMode()) {
4214 return;
4215 }
4216
4217 if (views != null) {
4218 views.add(this);
4219 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004220 }
4221
4222 /**
4223 * Find and return all touchable views that are descendants of this view,
4224 * possibly including this view if it is touchable itself.
4225 *
4226 * @return A list of touchable views
4227 */
4228 public ArrayList<View> getTouchables() {
4229 ArrayList<View> result = new ArrayList<View>();
4230 addTouchables(result);
4231 return result;
4232 }
4233
4234 /**
4235 * Add any touchable views that are descendants of this view (possibly
4236 * including this view if it is touchable itself) to views.
4237 *
4238 * @param views Touchable views found so far
4239 */
4240 public void addTouchables(ArrayList<View> views) {
4241 final int viewFlags = mViewFlags;
4242
4243 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
4244 && (viewFlags & ENABLED_MASK) == ENABLED) {
4245 views.add(this);
4246 }
4247 }
4248
4249 /**
4250 * Call this to try to give focus to a specific view or to one of its
4251 * descendants.
4252 *
4253 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4254 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4255 * while the device is in touch mode.
4256 *
4257 * See also {@link #focusSearch}, which is what you call to say that you
4258 * have focus, and you want your parent to look for the next one.
4259 *
4260 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
4261 * {@link #FOCUS_DOWN} and <code>null</code>.
4262 *
4263 * @return Whether this view or one of its descendants actually took focus.
4264 */
4265 public final boolean requestFocus() {
4266 return requestFocus(View.FOCUS_DOWN);
4267 }
4268
4269
4270 /**
4271 * Call this to try to give focus to a specific view or to one of its
4272 * descendants and give it a hint about what direction focus is heading.
4273 *
4274 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4275 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4276 * while the device is in touch mode.
4277 *
4278 * See also {@link #focusSearch}, which is what you call to say that you
4279 * have focus, and you want your parent to look for the next one.
4280 *
4281 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
4282 * <code>null</code> set for the previously focused rectangle.
4283 *
4284 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4285 * @return Whether this view or one of its descendants actually took focus.
4286 */
4287 public final boolean requestFocus(int direction) {
4288 return requestFocus(direction, null);
4289 }
4290
4291 /**
4292 * Call this to try to give focus to a specific view or to one of its descendants
4293 * and give it hints about the direction and a specific rectangle that the focus
4294 * is coming from. The rectangle can help give larger views a finer grained hint
4295 * about where focus is coming from, and therefore, where to show selection, or
4296 * forward focus change internally.
4297 *
4298 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4299 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4300 * while the device is in touch mode.
4301 *
4302 * A View will not take focus if it is not visible.
4303 *
4304 * A View will not take focus if one of its parents has {@link android.view.ViewGroup#getDescendantFocusability()}
4305 * equal to {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
4306 *
4307 * See also {@link #focusSearch}, which is what you call to say that you
4308 * have focus, and you want your parent to look for the next one.
4309 *
4310 * You may wish to override this method if your custom {@link View} has an internal
4311 * {@link View} that it wishes to forward the request to.
4312 *
4313 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4314 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
4315 * to give a finer grained hint about where focus is coming from. May be null
4316 * if there is no hint.
4317 * @return Whether this view or one of its descendants actually took focus.
4318 */
4319 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
4320 // need to be focusable
4321 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
4322 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
4323 return false;
4324 }
4325
4326 // need to be focusable in touch mode if in touch mode
4327 if (isInTouchMode() &&
4328 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
4329 return false;
4330 }
4331
4332 // need to not have any parents blocking us
4333 if (hasAncestorThatBlocksDescendantFocus()) {
4334 return false;
4335 }
4336
4337 handleFocusGainInternal(direction, previouslyFocusedRect);
4338 return true;
4339 }
4340
Christopher Tate2c095f32010-10-04 14:13:40 -07004341 /** Gets the ViewRoot, or null if not attached. */
4342 /*package*/ ViewRoot getViewRoot() {
4343 View root = getRootView();
4344 return root != null ? (ViewRoot)root.getParent() : null;
4345 }
4346
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004347 /**
4348 * Call this to try to give focus to a specific view or to one of its descendants. This is a
4349 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
4350 * touch mode to request focus when they are touched.
4351 *
4352 * @return Whether this view or one of its descendants actually took focus.
4353 *
4354 * @see #isInTouchMode()
4355 *
4356 */
4357 public final boolean requestFocusFromTouch() {
4358 // Leave touch mode if we need to
4359 if (isInTouchMode()) {
Christopher Tate2c095f32010-10-04 14:13:40 -07004360 ViewRoot viewRoot = getViewRoot();
4361 if (viewRoot != null) {
4362 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004363 }
4364 }
4365 return requestFocus(View.FOCUS_DOWN);
4366 }
4367
4368 /**
4369 * @return Whether any ancestor of this view blocks descendant focus.
4370 */
4371 private boolean hasAncestorThatBlocksDescendantFocus() {
4372 ViewParent ancestor = mParent;
4373 while (ancestor instanceof ViewGroup) {
4374 final ViewGroup vgAncestor = (ViewGroup) ancestor;
4375 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
4376 return true;
4377 } else {
4378 ancestor = vgAncestor.getParent();
4379 }
4380 }
4381 return false;
4382 }
4383
4384 /**
Romain Guya440b002010-02-24 15:57:54 -08004385 * @hide
4386 */
4387 public void dispatchStartTemporaryDetach() {
4388 onStartTemporaryDetach();
4389 }
4390
4391 /**
4392 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004393 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
4394 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08004395 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004396 */
4397 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08004398 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08004399 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08004400 }
4401
4402 /**
4403 * @hide
4404 */
4405 public void dispatchFinishTemporaryDetach() {
4406 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004407 }
Romain Guy8506ab42009-06-11 17:35:47 -07004408
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004409 /**
4410 * Called after {@link #onStartTemporaryDetach} when the container is done
4411 * changing the view.
4412 */
4413 public void onFinishTemporaryDetach() {
4414 }
Romain Guy8506ab42009-06-11 17:35:47 -07004415
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004416 /**
4417 * capture information of this view for later analysis: developement only
4418 * check dynamic switch to make sure we only dump view
4419 * when ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW) is set
4420 */
4421 private static void captureViewInfo(String subTag, View v) {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07004422 if (v == null || SystemProperties.getInt(ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW, 0) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004423 return;
4424 }
4425 ViewDebug.dumpCapturedView(subTag, v);
4426 }
4427
4428 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004429 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
4430 * for this view's window. Returns null if the view is not currently attached
4431 * to the window. Normally you will not need to use this directly, but
4432 * just use the standard high-level event callbacks like {@link #onKeyDown}.
4433 */
4434 public KeyEvent.DispatcherState getKeyDispatcherState() {
4435 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
4436 }
4437
4438 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004439 * Dispatch a key event before it is processed by any input method
4440 * associated with the view hierarchy. This can be used to intercept
4441 * key events in special situations before the IME consumes them; a
4442 * typical example would be handling the BACK key to update the application's
4443 * UI instead of allowing the IME to see it and close itself.
4444 *
4445 * @param event The key event to be dispatched.
4446 * @return True if the event was handled, false otherwise.
4447 */
4448 public boolean dispatchKeyEventPreIme(KeyEvent event) {
4449 return onKeyPreIme(event.getKeyCode(), event);
4450 }
4451
4452 /**
4453 * Dispatch a key event to the next view on the focus path. This path runs
4454 * from the top of the view tree down to the currently focused view. If this
4455 * view has focus, it will dispatch to itself. Otherwise it will dispatch
4456 * the next node down the focus path. This method also fires any key
4457 * listeners.
4458 *
4459 * @param event The key event to be dispatched.
4460 * @return True if the event was handled, false otherwise.
4461 */
4462 public boolean dispatchKeyEvent(KeyEvent event) {
4463 // If any attached key listener a first crack at the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004464
Romain Guyf607bdc2010-09-10 19:20:06 -07004465 //noinspection SimplifiableIfStatement,deprecation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004466 if (android.util.Config.LOGV) {
4467 captureViewInfo("captureViewKeyEvent", this);
4468 }
4469
Romain Guyf607bdc2010-09-10 19:20:06 -07004470 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004471 if (mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
4472 && mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
4473 return true;
4474 }
4475
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004476 return event.dispatch(this, mAttachInfo != null
4477 ? mAttachInfo.mKeyDispatchState : null, this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004478 }
4479
4480 /**
4481 * Dispatches a key shortcut event.
4482 *
4483 * @param event The key event to be dispatched.
4484 * @return True if the event was handled by the view, false otherwise.
4485 */
4486 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
4487 return onKeyShortcut(event.getKeyCode(), event);
4488 }
4489
4490 /**
4491 * Pass the touch screen motion event down to the target view, or this
4492 * view if it is the target.
4493 *
4494 * @param event The motion event to be dispatched.
4495 * @return True if the event was handled by the view, false otherwise.
4496 */
4497 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown85a31762010-09-01 17:01:00 -07004498 if (!onFilterTouchEventForSecurity(event)) {
4499 return false;
4500 }
4501
Romain Guyf607bdc2010-09-10 19:20:06 -07004502 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004503 if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED &&
4504 mOnTouchListener.onTouch(this, event)) {
4505 return true;
4506 }
4507 return onTouchEvent(event);
4508 }
4509
4510 /**
Jeff Brown85a31762010-09-01 17:01:00 -07004511 * Filter the touch event to apply security policies.
4512 *
4513 * @param event The motion event to be filtered.
4514 * @return True if the event should be dispatched, false if the event should be dropped.
4515 *
4516 * @see #getFilterTouchesWhenObscured
4517 */
4518 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07004519 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07004520 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
4521 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
4522 // Window is obscured, drop this touch.
4523 return false;
4524 }
4525 return true;
4526 }
4527
4528 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004529 * Pass a trackball motion event down to the focused view.
4530 *
4531 * @param event The motion event to be dispatched.
4532 * @return True if the event was handled by the view, false otherwise.
4533 */
4534 public boolean dispatchTrackballEvent(MotionEvent event) {
4535 //Log.i("view", "view=" + this + ", " + event.toString());
4536 return onTrackballEvent(event);
4537 }
4538
4539 /**
4540 * Called when the window containing this view gains or loses window focus.
4541 * ViewGroups should override to route to their children.
4542 *
4543 * @param hasFocus True if the window containing this view now has focus,
4544 * false otherwise.
4545 */
4546 public void dispatchWindowFocusChanged(boolean hasFocus) {
4547 onWindowFocusChanged(hasFocus);
4548 }
4549
4550 /**
4551 * Called when the window containing this view gains or loses focus. Note
4552 * that this is separate from view focus: to receive key events, both
4553 * your view and its window must have focus. If a window is displayed
4554 * on top of yours that takes input focus, then your own window will lose
4555 * focus but the view focus will remain unchanged.
4556 *
4557 * @param hasWindowFocus True if the window containing this view now has
4558 * focus, false otherwise.
4559 */
4560 public void onWindowFocusChanged(boolean hasWindowFocus) {
4561 InputMethodManager imm = InputMethodManager.peekInstance();
4562 if (!hasWindowFocus) {
4563 if (isPressed()) {
4564 setPressed(false);
4565 }
4566 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4567 imm.focusOut(this);
4568 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05004569 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08004570 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004571 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004572 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4573 imm.focusIn(this);
4574 }
4575 refreshDrawableState();
4576 }
4577
4578 /**
4579 * Returns true if this view is in a window that currently has window focus.
4580 * Note that this is not the same as the view itself having focus.
4581 *
4582 * @return True if this view is in a window that currently has window focus.
4583 */
4584 public boolean hasWindowFocus() {
4585 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
4586 }
4587
4588 /**
Adam Powell326d8082009-12-09 15:10:07 -08004589 * Dispatch a view visibility change down the view hierarchy.
4590 * ViewGroups should override to route to their children.
4591 * @param changedView The view whose visibility changed. Could be 'this' or
4592 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004593 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4594 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004595 */
4596 protected void dispatchVisibilityChanged(View changedView, int visibility) {
4597 onVisibilityChanged(changedView, visibility);
4598 }
4599
4600 /**
4601 * Called when the visibility of the view or an ancestor of the view is changed.
4602 * @param changedView The view whose visibility changed. Could be 'this' or
4603 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004604 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4605 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004606 */
4607 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004608 if (visibility == VISIBLE) {
4609 if (mAttachInfo != null) {
4610 initialAwakenScrollBars();
4611 } else {
4612 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
4613 }
4614 }
Adam Powell326d8082009-12-09 15:10:07 -08004615 }
4616
4617 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08004618 * Dispatch a hint about whether this view is displayed. For instance, when
4619 * a View moves out of the screen, it might receives a display hint indicating
4620 * the view is not displayed. Applications should not <em>rely</em> on this hint
4621 * as there is no guarantee that they will receive one.
4622 *
4623 * @param hint A hint about whether or not this view is displayed:
4624 * {@link #VISIBLE} or {@link #INVISIBLE}.
4625 */
4626 public void dispatchDisplayHint(int hint) {
4627 onDisplayHint(hint);
4628 }
4629
4630 /**
4631 * Gives this view a hint about whether is displayed or not. For instance, when
4632 * a View moves out of the screen, it might receives a display hint indicating
4633 * the view is not displayed. Applications should not <em>rely</em> on this hint
4634 * as there is no guarantee that they will receive one.
4635 *
4636 * @param hint A hint about whether or not this view is displayed:
4637 * {@link #VISIBLE} or {@link #INVISIBLE}.
4638 */
4639 protected void onDisplayHint(int hint) {
4640 }
4641
4642 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004643 * Dispatch a window visibility change down the view hierarchy.
4644 * ViewGroups should override to route to their children.
4645 *
4646 * @param visibility The new visibility of the window.
4647 *
4648 * @see #onWindowVisibilityChanged
4649 */
4650 public void dispatchWindowVisibilityChanged(int visibility) {
4651 onWindowVisibilityChanged(visibility);
4652 }
4653
4654 /**
4655 * Called when the window containing has change its visibility
4656 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
4657 * that this tells you whether or not your window is being made visible
4658 * to the window manager; this does <em>not</em> tell you whether or not
4659 * your window is obscured by other windows on the screen, even if it
4660 * is itself visible.
4661 *
4662 * @param visibility The new visibility of the window.
4663 */
4664 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004665 if (visibility == VISIBLE) {
4666 initialAwakenScrollBars();
4667 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004668 }
4669
4670 /**
4671 * Returns the current visibility of the window this view is attached to
4672 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
4673 *
4674 * @return Returns the current visibility of the view's window.
4675 */
4676 public int getWindowVisibility() {
4677 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
4678 }
4679
4680 /**
4681 * Retrieve the overall visible display size in which the window this view is
4682 * attached to has been positioned in. This takes into account screen
4683 * decorations above the window, for both cases where the window itself
4684 * is being position inside of them or the window is being placed under
4685 * then and covered insets are used for the window to position its content
4686 * inside. In effect, this tells you the available area where content can
4687 * be placed and remain visible to users.
4688 *
4689 * <p>This function requires an IPC back to the window manager to retrieve
4690 * the requested information, so should not be used in performance critical
4691 * code like drawing.
4692 *
4693 * @param outRect Filled in with the visible display frame. If the view
4694 * is not attached to a window, this is simply the raw display size.
4695 */
4696 public void getWindowVisibleDisplayFrame(Rect outRect) {
4697 if (mAttachInfo != null) {
4698 try {
4699 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
4700 } catch (RemoteException e) {
4701 return;
4702 }
4703 // XXX This is really broken, and probably all needs to be done
4704 // in the window manager, and we need to know more about whether
4705 // we want the area behind or in front of the IME.
4706 final Rect insets = mAttachInfo.mVisibleInsets;
4707 outRect.left += insets.left;
4708 outRect.top += insets.top;
4709 outRect.right -= insets.right;
4710 outRect.bottom -= insets.bottom;
4711 return;
4712 }
4713 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
4714 outRect.set(0, 0, d.getWidth(), d.getHeight());
4715 }
4716
4717 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08004718 * Dispatch a notification about a resource configuration change down
4719 * the view hierarchy.
4720 * ViewGroups should override to route to their children.
4721 *
4722 * @param newConfig The new resource configuration.
4723 *
4724 * @see #onConfigurationChanged
4725 */
4726 public void dispatchConfigurationChanged(Configuration newConfig) {
4727 onConfigurationChanged(newConfig);
4728 }
4729
4730 /**
4731 * Called when the current configuration of the resources being used
4732 * by the application have changed. You can use this to decide when
4733 * to reload resources that can changed based on orientation and other
4734 * configuration characterstics. You only need to use this if you are
4735 * not relying on the normal {@link android.app.Activity} mechanism of
4736 * recreating the activity instance upon a configuration change.
4737 *
4738 * @param newConfig The new resource configuration.
4739 */
4740 protected void onConfigurationChanged(Configuration newConfig) {
4741 }
4742
4743 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004744 * Private function to aggregate all per-view attributes in to the view
4745 * root.
4746 */
4747 void dispatchCollectViewAttributes(int visibility) {
4748 performCollectViewAttributes(visibility);
4749 }
4750
4751 void performCollectViewAttributes(int visibility) {
Romain Guyd30b36d2011-01-26 10:54:43 -08004752 if ((visibility & VISIBILITY_MASK) == VISIBLE && mAttachInfo != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08004753 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) {
4754 mAttachInfo.mKeepScreenOn = true;
4755 }
4756 mAttachInfo.mSystemUiVisibility |= mSystemUiVisibility;
4757 if (mOnSystemUiVisibilityChangeListener != null) {
4758 mAttachInfo.mHasSystemUiListeners = true;
4759 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004760 }
4761 }
4762
4763 void needGlobalAttributesUpdate(boolean force) {
Joe Onorato664644d2011-01-23 17:53:23 -08004764 final AttachInfo ai = mAttachInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004765 if (ai != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08004766 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0)
4767 || ai.mHasSystemUiListeners) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004768 ai.mRecomputeGlobalAttributes = true;
4769 }
4770 }
4771 }
4772
4773 /**
4774 * Returns whether the device is currently in touch mode. Touch mode is entered
4775 * once the user begins interacting with the device by touch, and affects various
4776 * things like whether focus is always visible to the user.
4777 *
4778 * @return Whether the device is in touch mode.
4779 */
4780 @ViewDebug.ExportedProperty
4781 public boolean isInTouchMode() {
4782 if (mAttachInfo != null) {
4783 return mAttachInfo.mInTouchMode;
4784 } else {
4785 return ViewRoot.isInTouchMode();
4786 }
4787 }
4788
4789 /**
4790 * Returns the context the view is running in, through which it can
4791 * access the current theme, resources, etc.
4792 *
4793 * @return The view's Context.
4794 */
4795 @ViewDebug.CapturedViewProperty
4796 public final Context getContext() {
4797 return mContext;
4798 }
4799
4800 /**
4801 * Handle a key event before it is processed by any input method
4802 * associated with the view hierarchy. This can be used to intercept
4803 * key events in special situations before the IME consumes them; a
4804 * typical example would be handling the BACK key to update the application's
4805 * UI instead of allowing the IME to see it and close itself.
4806 *
4807 * @param keyCode The value in event.getKeyCode().
4808 * @param event Description of the key event.
4809 * @return If you handled the event, return true. If you want to allow the
4810 * event to be handled by the next receiver, return false.
4811 */
4812 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
4813 return false;
4814 }
4815
4816 /**
Jeff Brown995e7742010-12-22 16:59:36 -08004817 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
4818 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004819 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
4820 * is released, if the view is enabled and clickable.
4821 *
4822 * @param keyCode A key code that represents the button pressed, from
4823 * {@link android.view.KeyEvent}.
4824 * @param event The KeyEvent object that defines the button action.
4825 */
4826 public boolean onKeyDown(int keyCode, KeyEvent event) {
4827 boolean result = false;
4828
4829 switch (keyCode) {
4830 case KeyEvent.KEYCODE_DPAD_CENTER:
4831 case KeyEvent.KEYCODE_ENTER: {
4832 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4833 return true;
4834 }
4835 // Long clickable items don't necessarily have to be clickable
4836 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
4837 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
4838 (event.getRepeatCount() == 0)) {
4839 setPressed(true);
4840 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
Adam Powelle14579b2009-12-16 18:39:52 -08004841 postCheckForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004842 }
4843 return true;
4844 }
4845 break;
4846 }
4847 }
4848 return result;
4849 }
4850
4851 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004852 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
4853 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
4854 * the event).
4855 */
4856 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
4857 return false;
4858 }
4859
4860 /**
Jeff Brown995e7742010-12-22 16:59:36 -08004861 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
4862 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004863 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
4864 * {@link KeyEvent#KEYCODE_ENTER} is released.
4865 *
4866 * @param keyCode A key code that represents the button pressed, from
4867 * {@link android.view.KeyEvent}.
4868 * @param event The KeyEvent object that defines the button action.
4869 */
4870 public boolean onKeyUp(int keyCode, KeyEvent event) {
4871 boolean result = false;
4872
4873 switch (keyCode) {
4874 case KeyEvent.KEYCODE_DPAD_CENTER:
4875 case KeyEvent.KEYCODE_ENTER: {
4876 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4877 return true;
4878 }
4879 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
4880 setPressed(false);
4881
4882 if (!mHasPerformedLongPress) {
4883 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05004884 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004885
4886 result = performClick();
4887 }
4888 }
4889 break;
4890 }
4891 }
4892 return result;
4893 }
4894
4895 /**
4896 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
4897 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
4898 * the event).
4899 *
4900 * @param keyCode A key code that represents the button pressed, from
4901 * {@link android.view.KeyEvent}.
4902 * @param repeatCount The number of times the action was made.
4903 * @param event The KeyEvent object that defines the button action.
4904 */
4905 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
4906 return false;
4907 }
4908
4909 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08004910 * Called on the focused view when a key shortcut event is not handled.
4911 * Override this method to implement local key shortcuts for the View.
4912 * Key shortcuts can also be implemented by setting the
4913 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004914 *
4915 * @param keyCode The value in event.getKeyCode().
4916 * @param event Description of the key event.
4917 * @return If you handled the event, return true. If you want to allow the
4918 * event to be handled by the next receiver, return false.
4919 */
4920 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
4921 return false;
4922 }
4923
4924 /**
4925 * Check whether the called view is a text editor, in which case it
4926 * would make sense to automatically display a soft input window for
4927 * it. Subclasses should override this if they implement
4928 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004929 * a call on that method would return a non-null InputConnection, and
4930 * they are really a first-class editor that the user would normally
4931 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07004932 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004933 * <p>The default implementation always returns false. This does
4934 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
4935 * will not be called or the user can not otherwise perform edits on your
4936 * view; it is just a hint to the system that this is not the primary
4937 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07004938 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004939 * @return Returns true if this view is a text editor, else false.
4940 */
4941 public boolean onCheckIsTextEditor() {
4942 return false;
4943 }
Romain Guy8506ab42009-06-11 17:35:47 -07004944
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004945 /**
4946 * Create a new InputConnection for an InputMethod to interact
4947 * with the view. The default implementation returns null, since it doesn't
4948 * support input methods. You can override this to implement such support.
4949 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07004950 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004951 * <p>When implementing this, you probably also want to implement
4952 * {@link #onCheckIsTextEditor()} to indicate you will return a
4953 * non-null InputConnection.
4954 *
4955 * @param outAttrs Fill in with attribute information about the connection.
4956 */
4957 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
4958 return null;
4959 }
4960
4961 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004962 * Called by the {@link android.view.inputmethod.InputMethodManager}
4963 * when a view who is not the current
4964 * input connection target is trying to make a call on the manager. The
4965 * default implementation returns false; you can override this to return
4966 * true for certain views if you are performing InputConnection proxying
4967 * to them.
4968 * @param view The View that is making the InputMethodManager call.
4969 * @return Return true to allow the call, false to reject.
4970 */
4971 public boolean checkInputConnectionProxy(View view) {
4972 return false;
4973 }
Romain Guy8506ab42009-06-11 17:35:47 -07004974
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004975 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004976 * Show the context menu for this view. It is not safe to hold on to the
4977 * menu after returning from this method.
4978 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07004979 * You should normally not overload this method. Overload
4980 * {@link #onCreateContextMenu(ContextMenu)} or define an
4981 * {@link OnCreateContextMenuListener} to add items to the context menu.
4982 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004983 * @param menu The context menu to populate
4984 */
4985 public void createContextMenu(ContextMenu menu) {
4986 ContextMenuInfo menuInfo = getContextMenuInfo();
4987
4988 // Sets the current menu info so all items added to menu will have
4989 // my extra info set.
4990 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
4991
4992 onCreateContextMenu(menu);
4993 if (mOnCreateContextMenuListener != null) {
4994 mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
4995 }
4996
4997 // Clear the extra information so subsequent items that aren't mine don't
4998 // have my extra info.
4999 ((MenuBuilder)menu).setCurrentMenuInfo(null);
5000
5001 if (mParent != null) {
5002 mParent.createContextMenu(menu);
5003 }
5004 }
5005
5006 /**
5007 * Views should implement this if they have extra information to associate
5008 * with the context menu. The return result is supplied as a parameter to
5009 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
5010 * callback.
5011 *
5012 * @return Extra information about the item for which the context menu
5013 * should be shown. This information will vary across different
5014 * subclasses of View.
5015 */
5016 protected ContextMenuInfo getContextMenuInfo() {
5017 return null;
5018 }
5019
5020 /**
5021 * Views should implement this if the view itself is going to add items to
5022 * the context menu.
5023 *
5024 * @param menu the context menu to populate
5025 */
5026 protected void onCreateContextMenu(ContextMenu menu) {
5027 }
5028
5029 /**
5030 * Implement this method to handle trackball motion events. The
5031 * <em>relative</em> movement of the trackball since the last event
5032 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
5033 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
5034 * that a movement of 1 corresponds to the user pressing one DPAD key (so
5035 * they will often be fractional values, representing the more fine-grained
5036 * movement information available from a trackball).
5037 *
5038 * @param event The motion event.
5039 * @return True if the event was handled, false otherwise.
5040 */
5041 public boolean onTrackballEvent(MotionEvent event) {
5042 return false;
5043 }
5044
5045 /**
5046 * Implement this method to handle touch screen motion events.
5047 *
5048 * @param event The motion event.
5049 * @return True if the event was handled, false otherwise.
5050 */
5051 public boolean onTouchEvent(MotionEvent event) {
5052 final int viewFlags = mViewFlags;
5053
5054 if ((viewFlags & ENABLED_MASK) == DISABLED) {
5055 // A disabled view that is clickable still consumes the touch
5056 // events, it just doesn't respond to them.
5057 return (((viewFlags & CLICKABLE) == CLICKABLE ||
5058 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
5059 }
5060
5061 if (mTouchDelegate != null) {
5062 if (mTouchDelegate.onTouchEvent(event)) {
5063 return true;
5064 }
5065 }
5066
5067 if (((viewFlags & CLICKABLE) == CLICKABLE ||
5068 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
5069 switch (event.getAction()) {
5070 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08005071 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
5072 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005073 // take focus if we don't have it already and we should in
5074 // touch mode.
5075 boolean focusTaken = false;
5076 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
5077 focusTaken = requestFocus();
5078 }
5079
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08005080 if (prepressed) {
5081 // The button is being released before we actually
5082 // showed it as pressed. Make it show the pressed
5083 // state now (before scheduling the click) to ensure
5084 // the user sees it.
5085 mPrivateFlags |= PRESSED;
5086 refreshDrawableState();
5087 }
5088
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005089 if (!mHasPerformedLongPress) {
5090 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05005091 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005092
5093 // Only perform take click actions if we were in the pressed state
5094 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08005095 // Use a Runnable and post this rather than calling
5096 // performClick directly. This lets other visual state
5097 // of the view update before click actions start.
5098 if (mPerformClick == null) {
5099 mPerformClick = new PerformClick();
5100 }
5101 if (!post(mPerformClick)) {
5102 performClick();
5103 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005104 }
5105 }
5106
5107 if (mUnsetPressedState == null) {
5108 mUnsetPressedState = new UnsetPressedState();
5109 }
5110
Adam Powelle14579b2009-12-16 18:39:52 -08005111 if (prepressed) {
Adam Powelle14579b2009-12-16 18:39:52 -08005112 postDelayed(mUnsetPressedState,
5113 ViewConfiguration.getPressedStateDuration());
5114 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005115 // If the post failed, unpress right now
5116 mUnsetPressedState.run();
5117 }
Adam Powelle14579b2009-12-16 18:39:52 -08005118 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005119 }
5120 break;
5121
5122 case MotionEvent.ACTION_DOWN:
Adam Powelle14579b2009-12-16 18:39:52 -08005123 if (mPendingCheckForTap == null) {
5124 mPendingCheckForTap = new CheckForTap();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005125 }
Adam Powelle14579b2009-12-16 18:39:52 -08005126 mPrivateFlags |= PREPRESSED;
Adam Powell3b023392010-03-11 16:30:28 -08005127 mHasPerformedLongPress = false;
Adam Powelle14579b2009-12-16 18:39:52 -08005128 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005129 break;
5130
5131 case MotionEvent.ACTION_CANCEL:
5132 mPrivateFlags &= ~PRESSED;
5133 refreshDrawableState();
Adam Powelle14579b2009-12-16 18:39:52 -08005134 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005135 break;
5136
5137 case MotionEvent.ACTION_MOVE:
5138 final int x = (int) event.getX();
5139 final int y = (int) event.getY();
5140
5141 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07005142 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005143 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08005144 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005145 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08005146 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05005147 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005148
5149 // Need to switch from pressed to not pressed
5150 mPrivateFlags &= ~PRESSED;
5151 refreshDrawableState();
5152 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005153 }
5154 break;
5155 }
5156 return true;
5157 }
5158
5159 return false;
5160 }
5161
5162 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05005163 * Remove the longpress detection timer.
5164 */
5165 private void removeLongPressCallback() {
5166 if (mPendingCheckForLongPress != null) {
5167 removeCallbacks(mPendingCheckForLongPress);
5168 }
5169 }
Adam Powell3cb8b632011-01-21 15:34:14 -08005170
5171 /**
5172 * Remove the pending click action
5173 */
5174 private void removePerformClickCallback() {
5175 if (mPerformClick != null) {
5176 removeCallbacks(mPerformClick);
5177 }
5178 }
5179
Adam Powelle14579b2009-12-16 18:39:52 -08005180 /**
Romain Guya440b002010-02-24 15:57:54 -08005181 * Remove the prepress detection timer.
5182 */
5183 private void removeUnsetPressCallback() {
5184 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
5185 setPressed(false);
5186 removeCallbacks(mUnsetPressedState);
5187 }
5188 }
5189
5190 /**
Adam Powelle14579b2009-12-16 18:39:52 -08005191 * Remove the tap detection timer.
5192 */
5193 private void removeTapCallback() {
5194 if (mPendingCheckForTap != null) {
5195 mPrivateFlags &= ~PREPRESSED;
5196 removeCallbacks(mPendingCheckForTap);
5197 }
5198 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05005199
5200 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005201 * Cancels a pending long press. Your subclass can use this if you
5202 * want the context menu to come up if the user presses and holds
5203 * at the same place, but you don't want it to come up if they press
5204 * and then move around enough to cause scrolling.
5205 */
5206 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05005207 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08005208
5209 /*
5210 * The prepressed state handled by the tap callback is a display
5211 * construct, but the tap callback will post a long press callback
5212 * less its own timeout. Remove it here.
5213 */
5214 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005215 }
5216
5217 /**
5218 * Sets the TouchDelegate for this View.
5219 */
5220 public void setTouchDelegate(TouchDelegate delegate) {
5221 mTouchDelegate = delegate;
5222 }
5223
5224 /**
5225 * Gets the TouchDelegate for this View.
5226 */
5227 public TouchDelegate getTouchDelegate() {
5228 return mTouchDelegate;
5229 }
5230
5231 /**
5232 * Set flags controlling behavior of this view.
5233 *
5234 * @param flags Constant indicating the value which should be set
5235 * @param mask Constant indicating the bit range that should be changed
5236 */
5237 void setFlags(int flags, int mask) {
5238 int old = mViewFlags;
5239 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
5240
5241 int changed = mViewFlags ^ old;
5242 if (changed == 0) {
5243 return;
5244 }
5245 int privateFlags = mPrivateFlags;
5246
5247 /* Check if the FOCUSABLE bit has changed */
5248 if (((changed & FOCUSABLE_MASK) != 0) &&
5249 ((privateFlags & HAS_BOUNDS) !=0)) {
5250 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
5251 && ((privateFlags & FOCUSED) != 0)) {
5252 /* Give up focus if we are no longer focusable */
5253 clearFocus();
5254 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
5255 && ((privateFlags & FOCUSED) == 0)) {
5256 /*
5257 * Tell the view system that we are now available to take focus
5258 * if no one else already has it.
5259 */
5260 if (mParent != null) mParent.focusableViewAvailable(this);
5261 }
5262 }
5263
5264 if ((flags & VISIBILITY_MASK) == VISIBLE) {
5265 if ((changed & VISIBILITY_MASK) != 0) {
5266 /*
5267 * If this view is becoming visible, set the DRAWN flag so that
5268 * the next invalidate() will not be skipped.
5269 */
5270 mPrivateFlags |= DRAWN;
5271
5272 needGlobalAttributesUpdate(true);
5273
5274 // a view becoming visible is worth notifying the parent
5275 // about in case nothing has focus. even if this specific view
5276 // isn't focusable, it may contain something that is, so let
5277 // the root view try to give this focus if nothing else does.
5278 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
5279 mParent.focusableViewAvailable(this);
5280 }
5281 }
5282 }
5283
5284 /* Check if the GONE bit has changed */
5285 if ((changed & GONE) != 0) {
5286 needGlobalAttributesUpdate(false);
5287 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08005288 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005289
Romain Guyecd80ee2009-12-03 17:13:02 -08005290 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
5291 if (hasFocus()) clearFocus();
5292 destroyDrawingCache();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005293 }
5294 if (mAttachInfo != null) {
5295 mAttachInfo.mViewVisibilityChanged = true;
5296 }
5297 }
5298
5299 /* Check if the VISIBLE bit has changed */
5300 if ((changed & INVISIBLE) != 0) {
5301 needGlobalAttributesUpdate(false);
Romain Guy0fd89bf2011-01-26 15:41:30 -08005302 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005303
5304 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
5305 // root view becoming invisible shouldn't clear focus
5306 if (getRootView() != this) {
5307 clearFocus();
5308 }
5309 }
5310 if (mAttachInfo != null) {
5311 mAttachInfo.mViewVisibilityChanged = true;
5312 }
5313 }
5314
Adam Powell326d8082009-12-09 15:10:07 -08005315 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07005316 if (mParent instanceof ViewGroup) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005317 ((ViewGroup) mParent).onChildVisibilityChanged(this, (flags & VISIBILITY_MASK));
5318 ((View) mParent).invalidate(true);
Chet Haase5e25c2c2010-09-16 11:15:56 -07005319 }
Adam Powell326d8082009-12-09 15:10:07 -08005320 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
5321 }
5322
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005323 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
5324 destroyDrawingCache();
5325 }
5326
5327 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
5328 destroyDrawingCache();
5329 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Romain Guy0fd89bf2011-01-26 15:41:30 -08005330 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005331 }
5332
5333 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
5334 destroyDrawingCache();
5335 mPrivateFlags &= ~DRAWING_CACHE_VALID;
5336 }
5337
5338 if ((changed & DRAW_MASK) != 0) {
5339 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
5340 if (mBGDrawable != null) {
5341 mPrivateFlags &= ~SKIP_DRAW;
5342 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
5343 } else {
5344 mPrivateFlags |= SKIP_DRAW;
5345 }
5346 } else {
5347 mPrivateFlags &= ~SKIP_DRAW;
5348 }
5349 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08005350 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005351 }
5352
5353 if ((changed & KEEP_SCREEN_ON) != 0) {
Joe Onorato664644d2011-01-23 17:53:23 -08005354 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005355 mParent.recomputeViewAttributes(this);
5356 }
5357 }
5358 }
5359
5360 /**
5361 * Change the view's z order in the tree, so it's on top of other sibling
5362 * views
5363 */
5364 public void bringToFront() {
5365 if (mParent != null) {
5366 mParent.bringChildToFront(this);
5367 }
5368 }
5369
5370 /**
5371 * This is called in response to an internal scroll in this view (i.e., the
5372 * view scrolled its own contents). This is typically as a result of
5373 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
5374 * called.
5375 *
5376 * @param l Current horizontal scroll origin.
5377 * @param t Current vertical scroll origin.
5378 * @param oldl Previous horizontal scroll origin.
5379 * @param oldt Previous vertical scroll origin.
5380 */
5381 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
5382 mBackgroundSizeChanged = true;
5383
5384 final AttachInfo ai = mAttachInfo;
5385 if (ai != null) {
5386 ai.mViewScrollChanged = true;
5387 }
5388 }
5389
5390 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005391 * Interface definition for a callback to be invoked when the layout bounds of a view
5392 * changes due to layout processing.
5393 */
5394 public interface OnLayoutChangeListener {
5395 /**
5396 * Called when the focus state of a view has changed.
5397 *
5398 * @param v The view whose state has changed.
5399 * @param left The new value of the view's left property.
5400 * @param top The new value of the view's top property.
5401 * @param right The new value of the view's right property.
5402 * @param bottom The new value of the view's bottom property.
5403 * @param oldLeft The previous value of the view's left property.
5404 * @param oldTop The previous value of the view's top property.
5405 * @param oldRight The previous value of the view's right property.
5406 * @param oldBottom The previous value of the view's bottom property.
5407 */
5408 void onLayoutChange(View v, int left, int top, int right, int bottom,
5409 int oldLeft, int oldTop, int oldRight, int oldBottom);
5410 }
5411
5412 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005413 * This is called during layout when the size of this view has changed. If
5414 * you were just added to the view hierarchy, you're called with the old
5415 * values of 0.
5416 *
5417 * @param w Current width of this view.
5418 * @param h Current height of this view.
5419 * @param oldw Old width of this view.
5420 * @param oldh Old height of this view.
5421 */
5422 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
5423 }
5424
5425 /**
5426 * Called by draw to draw the child views. This may be overridden
5427 * by derived classes to gain control just before its children are drawn
5428 * (but after its own view has been drawn).
5429 * @param canvas the canvas on which to draw the view
5430 */
5431 protected void dispatchDraw(Canvas canvas) {
5432 }
5433
5434 /**
5435 * Gets the parent of this view. Note that the parent is a
5436 * ViewParent and not necessarily a View.
5437 *
5438 * @return Parent of this view.
5439 */
5440 public final ViewParent getParent() {
5441 return mParent;
5442 }
5443
5444 /**
5445 * Return the scrolled left position of this view. This is the left edge of
5446 * the displayed part of your view. You do not need to draw any pixels
5447 * farther left, since those are outside of the frame of your view on
5448 * screen.
5449 *
5450 * @return The left edge of the displayed part of your view, in pixels.
5451 */
5452 public final int getScrollX() {
5453 return mScrollX;
5454 }
5455
5456 /**
5457 * Return the scrolled top position of this view. This is the top edge of
5458 * the displayed part of your view. You do not need to draw any pixels above
5459 * it, since those are outside of the frame of your view on screen.
5460 *
5461 * @return The top edge of the displayed part of your view, in pixels.
5462 */
5463 public final int getScrollY() {
5464 return mScrollY;
5465 }
5466
5467 /**
5468 * Return the width of the your view.
5469 *
5470 * @return The width of your view, in pixels.
5471 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005472 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005473 public final int getWidth() {
5474 return mRight - mLeft;
5475 }
5476
5477 /**
5478 * Return the height of your view.
5479 *
5480 * @return The height of your view, in pixels.
5481 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005482 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005483 public final int getHeight() {
5484 return mBottom - mTop;
5485 }
5486
5487 /**
5488 * Return the visible drawing bounds of your view. Fills in the output
5489 * rectangle with the values from getScrollX(), getScrollY(),
5490 * getWidth(), and getHeight().
5491 *
5492 * @param outRect The (scrolled) drawing bounds of the view.
5493 */
5494 public void getDrawingRect(Rect outRect) {
5495 outRect.left = mScrollX;
5496 outRect.top = mScrollY;
5497 outRect.right = mScrollX + (mRight - mLeft);
5498 outRect.bottom = mScrollY + (mBottom - mTop);
5499 }
5500
5501 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005502 * Like {@link #getMeasuredWidthAndState()}, but only returns the
5503 * raw width component (that is the result is masked by
5504 * {@link #MEASURED_SIZE_MASK}).
5505 *
5506 * @return The raw measured width of this view.
5507 */
5508 public final int getMeasuredWidth() {
5509 return mMeasuredWidth & MEASURED_SIZE_MASK;
5510 }
5511
5512 /**
5513 * Return the full width measurement information for this view as computed
5514 * by the most recent call to {@link #measure}. This result is a bit mask
5515 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005516 * This should be used during measurement and layout calculations only. Use
5517 * {@link #getWidth()} to see how wide a view is after layout.
5518 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08005519 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005520 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08005521 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005522 return mMeasuredWidth;
5523 }
5524
5525 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005526 * Like {@link #getMeasuredHeightAndState()}, but only returns the
5527 * raw width component (that is the result is masked by
5528 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005529 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08005530 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005531 */
5532 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08005533 return mMeasuredHeight & MEASURED_SIZE_MASK;
5534 }
5535
5536 /**
5537 * Return the full height measurement information for this view as computed
5538 * by the most recent call to {@link #measure}. This result is a bit mask
5539 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
5540 * This should be used during measurement and layout calculations only. Use
5541 * {@link #getHeight()} to see how wide a view is after layout.
5542 *
5543 * @return The measured width of this view as a bit mask.
5544 */
5545 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005546 return mMeasuredHeight;
5547 }
5548
5549 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005550 * Return only the state bits of {@link #getMeasuredWidthAndState()}
5551 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
5552 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
5553 * and the height component is at the shifted bits
5554 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
5555 */
5556 public final int getMeasuredState() {
5557 return (mMeasuredWidth&MEASURED_STATE_MASK)
5558 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
5559 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
5560 }
5561
5562 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005563 * The transform matrix of this view, which is calculated based on the current
5564 * roation, scale, and pivot properties.
5565 *
5566 * @see #getRotation()
5567 * @see #getScaleX()
5568 * @see #getScaleY()
5569 * @see #getPivotX()
5570 * @see #getPivotY()
5571 * @return The current transform matrix for the view
5572 */
5573 public Matrix getMatrix() {
Jeff Brown86671742010-09-30 20:00:15 -07005574 updateMatrix();
Romain Guy33e72ae2010-07-17 12:40:29 -07005575 return mMatrix;
5576 }
5577
5578 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005579 * Utility function to determine if the value is far enough away from zero to be
5580 * considered non-zero.
5581 * @param value A floating point value to check for zero-ness
5582 * @return whether the passed-in value is far enough away from zero to be considered non-zero
5583 */
5584 private static boolean nonzero(float value) {
5585 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
5586 }
5587
5588 /**
Jeff Brown86671742010-09-30 20:00:15 -07005589 * Returns true if the transform matrix is the identity matrix.
5590 * Recomputes the matrix if necessary.
Romain Guy33e72ae2010-07-17 12:40:29 -07005591 *
5592 * @return True if the transform matrix is the identity matrix, false otherwise.
5593 */
Jeff Brown86671742010-09-30 20:00:15 -07005594 final boolean hasIdentityMatrix() {
5595 updateMatrix();
5596 return mMatrixIsIdentity;
5597 }
5598
5599 /**
5600 * Recomputes the transform matrix if necessary.
5601 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07005602 private void updateMatrix() {
Chet Haasec3aa3612010-06-17 08:50:37 -07005603 if (mMatrixDirty) {
5604 // transform-related properties have changed since the last time someone
5605 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07005606
5607 // Figure out if we need to update the pivot point
5608 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08005609 if ((mRight - mLeft) != mPrevWidth || (mBottom - mTop) != mPrevHeight) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005610 mPrevWidth = mRight - mLeft;
5611 mPrevHeight = mBottom - mTop;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -08005612 mPivotX = mPrevWidth / 2f;
5613 mPivotY = mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07005614 }
5615 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005616 mMatrix.reset();
Chet Haase897247b2010-09-09 14:54:47 -07005617 if (!nonzero(mRotationX) && !nonzero(mRotationY)) {
5618 mMatrix.setTranslate(mTranslationX, mTranslationY);
5619 mMatrix.preRotate(mRotation, mPivotX, mPivotY);
5620 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
5621 } else {
Chet Haasefd2b0022010-08-06 13:08:56 -07005622 if (mCamera == null) {
5623 mCamera = new Camera();
5624 matrix3D = new Matrix();
5625 }
5626 mCamera.save();
Chet Haase897247b2010-09-09 14:54:47 -07005627 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
Chet Haasefd2b0022010-08-06 13:08:56 -07005628 mCamera.rotateX(mRotationX);
5629 mCamera.rotateY(mRotationY);
Chet Haase897247b2010-09-09 14:54:47 -07005630 mCamera.rotateZ(-mRotation);
Chet Haasefd2b0022010-08-06 13:08:56 -07005631 mCamera.getMatrix(matrix3D);
5632 matrix3D.preTranslate(-mPivotX, -mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07005633 matrix3D.postTranslate(mPivotX + mTranslationX, mPivotY + mTranslationY);
Chet Haasefd2b0022010-08-06 13:08:56 -07005634 mMatrix.postConcat(matrix3D);
5635 mCamera.restore();
5636 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005637 mMatrixDirty = false;
5638 mMatrixIsIdentity = mMatrix.isIdentity();
5639 mInverseMatrixDirty = true;
5640 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005641 }
5642
5643 /**
5644 * Utility method to retrieve the inverse of the current mMatrix property.
5645 * We cache the matrix to avoid recalculating it when transform properties
5646 * have not changed.
5647 *
5648 * @return The inverse of the current matrix of this view.
5649 */
Jeff Brown86671742010-09-30 20:00:15 -07005650 final Matrix getInverseMatrix() {
5651 updateMatrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07005652 if (mInverseMatrixDirty) {
5653 if (mInverseMatrix == null) {
5654 mInverseMatrix = new Matrix();
5655 }
5656 mMatrix.invert(mInverseMatrix);
5657 mInverseMatrixDirty = false;
5658 }
5659 return mInverseMatrix;
5660 }
5661
5662 /**
5663 * The degrees that the view is rotated around the pivot point.
5664 *
5665 * @see #getPivotX()
5666 * @see #getPivotY()
5667 * @return The degrees of rotation.
5668 */
5669 public float getRotation() {
5670 return mRotation;
5671 }
5672
5673 /**
Chet Haase897247b2010-09-09 14:54:47 -07005674 * Sets the degrees that the view is rotated around the pivot point. Increasing values
5675 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07005676 *
5677 * @param rotation The degrees of rotation.
5678 * @see #getPivotX()
5679 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005680 *
5681 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07005682 */
5683 public void setRotation(float rotation) {
5684 if (mRotation != rotation) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005685 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005686 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005687 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005688 mRotation = rotation;
5689 mMatrixDirty = true;
5690 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005691 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005692 }
5693 }
5694
5695 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005696 * The degrees that the view is rotated around the vertical axis through the pivot point.
5697 *
5698 * @see #getPivotX()
5699 * @see #getPivotY()
5700 * @return The degrees of Y rotation.
5701 */
5702 public float getRotationY() {
5703 return mRotationY;
5704 }
5705
5706 /**
Chet Haase897247b2010-09-09 14:54:47 -07005707 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
5708 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
5709 * down the y axis.
Chet Haasefd2b0022010-08-06 13:08:56 -07005710 *
5711 * @param rotationY The degrees of Y rotation.
5712 * @see #getPivotX()
5713 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005714 *
5715 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07005716 */
5717 public void setRotationY(float rotationY) {
5718 if (mRotationY != rotationY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005719 invalidateParentCaches();
Chet Haasefd2b0022010-08-06 13:08:56 -07005720 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005721 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005722 mRotationY = rotationY;
5723 mMatrixDirty = true;
5724 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005725 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005726 }
5727 }
5728
5729 /**
5730 * The degrees that the view is rotated around the horizontal axis through the pivot point.
5731 *
5732 * @see #getPivotX()
5733 * @see #getPivotY()
5734 * @return The degrees of X rotation.
5735 */
5736 public float getRotationX() {
5737 return mRotationX;
5738 }
5739
5740 /**
Chet Haase897247b2010-09-09 14:54:47 -07005741 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
5742 * Increasing values result in clockwise rotation from the viewpoint of looking down the
5743 * x axis.
Chet Haasefd2b0022010-08-06 13:08:56 -07005744 *
5745 * @param rotationX The degrees of X rotation.
5746 * @see #getPivotX()
5747 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005748 *
5749 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07005750 */
5751 public void setRotationX(float rotationX) {
5752 if (mRotationX != rotationX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005753 invalidateParentCaches();
Chet Haasefd2b0022010-08-06 13:08:56 -07005754 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005755 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005756 mRotationX = rotationX;
5757 mMatrixDirty = true;
5758 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005759 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005760 }
5761 }
5762
5763 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005764 * The amount that the view is scaled in x around the pivot point, as a proportion of
5765 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
5766 *
Joe Onorato93162322010-09-16 15:42:01 -04005767 * <p>By default, this is 1.0f.
5768 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005769 * @see #getPivotX()
5770 * @see #getPivotY()
5771 * @return The scaling factor.
5772 */
5773 public float getScaleX() {
5774 return mScaleX;
5775 }
5776
5777 /**
5778 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
5779 * the view's unscaled width. A value of 1 means that no scaling is applied.
5780 *
5781 * @param scaleX The scaling factor.
5782 * @see #getPivotX()
5783 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005784 *
5785 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07005786 */
5787 public void setScaleX(float scaleX) {
5788 if (mScaleX != scaleX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005789 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005790 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005791 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005792 mScaleX = scaleX;
5793 mMatrixDirty = true;
5794 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005795 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005796 }
5797 }
5798
5799 /**
5800 * The amount that the view is scaled in y around the pivot point, as a proportion of
5801 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
5802 *
Joe Onorato93162322010-09-16 15:42:01 -04005803 * <p>By default, this is 1.0f.
5804 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005805 * @see #getPivotX()
5806 * @see #getPivotY()
5807 * @return The scaling factor.
5808 */
5809 public float getScaleY() {
5810 return mScaleY;
5811 }
5812
5813 /**
5814 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
5815 * the view's unscaled width. A value of 1 means that no scaling is applied.
5816 *
5817 * @param scaleY The scaling factor.
5818 * @see #getPivotX()
5819 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005820 *
5821 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07005822 */
5823 public void setScaleY(float scaleY) {
5824 if (mScaleY != scaleY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005825 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005826 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005827 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005828 mScaleY = scaleY;
5829 mMatrixDirty = true;
5830 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005831 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005832 }
5833 }
5834
5835 /**
5836 * The x location of the point around which the view is {@link #setRotation(float) rotated}
5837 * and {@link #setScaleX(float) scaled}.
5838 *
5839 * @see #getRotation()
5840 * @see #getScaleX()
5841 * @see #getScaleY()
5842 * @see #getPivotY()
5843 * @return The x location of the pivot point.
5844 */
5845 public float getPivotX() {
5846 return mPivotX;
5847 }
5848
5849 /**
5850 * Sets the x location of the point around which the view is
5851 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07005852 * By default, the pivot point is centered on the object.
5853 * Setting this property disables this behavior and causes the view to use only the
5854 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07005855 *
5856 * @param pivotX The x location of the pivot point.
5857 * @see #getRotation()
5858 * @see #getScaleX()
5859 * @see #getScaleY()
5860 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005861 *
5862 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07005863 */
5864 public void setPivotX(float pivotX) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005865 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07005866 if (mPivotX != pivotX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005867 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005868 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005869 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005870 mPivotX = pivotX;
5871 mMatrixDirty = true;
5872 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005873 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005874 }
5875 }
5876
5877 /**
5878 * The y location of the point around which the view is {@link #setRotation(float) rotated}
5879 * and {@link #setScaleY(float) scaled}.
5880 *
5881 * @see #getRotation()
5882 * @see #getScaleX()
5883 * @see #getScaleY()
5884 * @see #getPivotY()
5885 * @return The y location of the pivot point.
5886 */
5887 public float getPivotY() {
5888 return mPivotY;
5889 }
5890
5891 /**
5892 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07005893 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
5894 * Setting this property disables this behavior and causes the view to use only the
5895 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07005896 *
5897 * @param pivotY The y location of the pivot point.
5898 * @see #getRotation()
5899 * @see #getScaleX()
5900 * @see #getScaleY()
5901 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005902 *
5903 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07005904 */
5905 public void setPivotY(float pivotY) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005906 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07005907 if (mPivotY != pivotY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005908 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005909 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005910 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005911 mPivotY = pivotY;
5912 mMatrixDirty = true;
5913 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005914 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005915 }
5916 }
5917
5918 /**
5919 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
5920 * completely transparent and 1 means the view is completely opaque.
5921 *
Joe Onorato93162322010-09-16 15:42:01 -04005922 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07005923 * @return The opacity of the view.
5924 */
5925 public float getAlpha() {
5926 return mAlpha;
5927 }
5928
5929 /**
Romain Guy171c5922011-01-06 10:04:23 -08005930 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
5931 * completely transparent and 1 means the view is completely opaque.</p>
5932 *
5933 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
5934 * responsible for applying the opacity itself. Otherwise, calling this method is
5935 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
5936 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07005937 *
5938 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08005939 *
Romain Guy171c5922011-01-06 10:04:23 -08005940 * @see #setLayerType(int, android.graphics.Paint)
5941 *
Chet Haase73066682010-11-29 15:55:32 -08005942 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07005943 */
5944 public void setAlpha(float alpha) {
5945 mAlpha = alpha;
Romain Guy0fd89bf2011-01-26 15:41:30 -08005946 invalidateParentCaches();
Chet Haaseed032702010-10-01 14:05:54 -07005947 if (onSetAlpha((int) (alpha * 255))) {
Romain Guya3496a92010-10-12 11:53:24 -07005948 mPrivateFlags |= ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07005949 // subclass is handling alpha - don't optimize rendering cache invalidation
Romain Guy0fd89bf2011-01-26 15:41:30 -08005950 invalidate(true);
Chet Haaseed032702010-10-01 14:05:54 -07005951 } else {
Romain Guya3496a92010-10-12 11:53:24 -07005952 mPrivateFlags &= ~ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07005953 invalidate(false);
5954 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005955 }
5956
5957 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005958 * Top position of this view relative to its parent.
5959 *
5960 * @return The top of this view, in pixels.
5961 */
5962 @ViewDebug.CapturedViewProperty
5963 public final int getTop() {
5964 return mTop;
5965 }
5966
5967 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005968 * Sets the top position of this view relative to its parent. This method is meant to be called
5969 * by the layout system and should not generally be called otherwise, because the property
5970 * may be changed at any time by the layout.
5971 *
5972 * @param top The top of this view, in pixels.
5973 */
5974 public final void setTop(int top) {
5975 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07005976 updateMatrix();
5977 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07005978 final ViewParent p = mParent;
5979 if (p != null && mAttachInfo != null) {
5980 final Rect r = mAttachInfo.mTmpInvalRect;
5981 int minTop;
5982 int yLoc;
5983 if (top < mTop) {
5984 minTop = top;
5985 yLoc = top - mTop;
5986 } else {
5987 minTop = mTop;
5988 yLoc = 0;
5989 }
5990 r.set(0, yLoc, mRight - mLeft, mBottom - minTop);
5991 p.invalidateChild(this, r);
5992 }
5993 } else {
5994 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08005995 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07005996 }
5997
Chet Haaseed032702010-10-01 14:05:54 -07005998 int width = mRight - mLeft;
5999 int oldHeight = mBottom - mTop;
6000
Chet Haase21cd1382010-09-01 17:42:29 -07006001 mTop = top;
6002
Chet Haaseed032702010-10-01 14:05:54 -07006003 onSizeChanged(width, mBottom - mTop, width, oldHeight);
6004
Chet Haase21cd1382010-09-01 17:42:29 -07006005 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006006 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6007 // A change in dimension means an auto-centered pivot point changes, too
6008 mMatrixDirty = true;
6009 }
Chet Haase21cd1382010-09-01 17:42:29 -07006010 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006011 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006012 }
Chet Haase55dbb652010-12-21 20:15:08 -08006013 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07006014 }
6015 }
6016
6017 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006018 * Bottom position of this view relative to its parent.
6019 *
6020 * @return The bottom of this view, in pixels.
6021 */
6022 @ViewDebug.CapturedViewProperty
6023 public final int getBottom() {
6024 return mBottom;
6025 }
6026
6027 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08006028 * True if this view has changed since the last time being drawn.
6029 *
6030 * @return The dirty state of this view.
6031 */
6032 public boolean isDirty() {
6033 return (mPrivateFlags & DIRTY_MASK) != 0;
6034 }
6035
6036 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006037 * Sets the bottom position of this view relative to its parent. This method is meant to be
6038 * called by the layout system and should not generally be called otherwise, because the
6039 * property may be changed at any time by the layout.
6040 *
6041 * @param bottom The bottom of this view, in pixels.
6042 */
6043 public final void setBottom(int bottom) {
6044 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07006045 updateMatrix();
6046 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07006047 final ViewParent p = mParent;
6048 if (p != null && mAttachInfo != null) {
6049 final Rect r = mAttachInfo.mTmpInvalRect;
6050 int maxBottom;
6051 if (bottom < mBottom) {
6052 maxBottom = mBottom;
6053 } else {
6054 maxBottom = bottom;
6055 }
6056 r.set(0, 0, mRight - mLeft, maxBottom - mTop);
6057 p.invalidateChild(this, r);
6058 }
6059 } else {
6060 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08006061 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006062 }
6063
Chet Haaseed032702010-10-01 14:05:54 -07006064 int width = mRight - mLeft;
6065 int oldHeight = mBottom - mTop;
6066
Chet Haase21cd1382010-09-01 17:42:29 -07006067 mBottom = bottom;
6068
Chet Haaseed032702010-10-01 14:05:54 -07006069 onSizeChanged(width, mBottom - mTop, width, oldHeight);
6070
Chet Haase21cd1382010-09-01 17:42:29 -07006071 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006072 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6073 // A change in dimension means an auto-centered pivot point changes, too
6074 mMatrixDirty = true;
6075 }
Chet Haase21cd1382010-09-01 17:42:29 -07006076 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006077 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006078 }
Chet Haase55dbb652010-12-21 20:15:08 -08006079 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07006080 }
6081 }
6082
6083 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006084 * Left position of this view relative to its parent.
6085 *
6086 * @return The left edge of this view, in pixels.
6087 */
6088 @ViewDebug.CapturedViewProperty
6089 public final int getLeft() {
6090 return mLeft;
6091 }
6092
6093 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006094 * Sets the left position of this view relative to its parent. This method is meant to be called
6095 * by the layout system and should not generally be called otherwise, because the property
6096 * may be changed at any time by the layout.
6097 *
6098 * @param left The bottom of this view, in pixels.
6099 */
6100 public final void setLeft(int left) {
6101 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07006102 updateMatrix();
6103 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07006104 final ViewParent p = mParent;
6105 if (p != null && mAttachInfo != null) {
6106 final Rect r = mAttachInfo.mTmpInvalRect;
6107 int minLeft;
6108 int xLoc;
6109 if (left < mLeft) {
6110 minLeft = left;
6111 xLoc = left - mLeft;
6112 } else {
6113 minLeft = mLeft;
6114 xLoc = 0;
6115 }
6116 r.set(xLoc, 0, mRight - minLeft, mBottom - mTop);
6117 p.invalidateChild(this, r);
6118 }
6119 } else {
6120 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08006121 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006122 }
6123
Chet Haaseed032702010-10-01 14:05:54 -07006124 int oldWidth = mRight - mLeft;
6125 int height = mBottom - mTop;
6126
Chet Haase21cd1382010-09-01 17:42:29 -07006127 mLeft = left;
6128
Chet Haaseed032702010-10-01 14:05:54 -07006129 onSizeChanged(mRight - mLeft, height, oldWidth, height);
6130
Chet Haase21cd1382010-09-01 17:42:29 -07006131 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006132 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6133 // A change in dimension means an auto-centered pivot point changes, too
6134 mMatrixDirty = true;
6135 }
Chet Haase21cd1382010-09-01 17:42:29 -07006136 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006137 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006138 }
Chet Haase55dbb652010-12-21 20:15:08 -08006139 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07006140 }
6141 }
6142
6143 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006144 * Right position of this view relative to its parent.
6145 *
6146 * @return The right edge of this view, in pixels.
6147 */
6148 @ViewDebug.CapturedViewProperty
6149 public final int getRight() {
6150 return mRight;
6151 }
6152
6153 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006154 * Sets the right position of this view relative to its parent. This method is meant to be called
6155 * by the layout system and should not generally be called otherwise, because the property
6156 * may be changed at any time by the layout.
6157 *
6158 * @param right The bottom of this view, in pixels.
6159 */
6160 public final void setRight(int right) {
6161 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07006162 updateMatrix();
6163 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07006164 final ViewParent p = mParent;
6165 if (p != null && mAttachInfo != null) {
6166 final Rect r = mAttachInfo.mTmpInvalRect;
6167 int maxRight;
6168 if (right < mRight) {
6169 maxRight = mRight;
6170 } else {
6171 maxRight = right;
6172 }
6173 r.set(0, 0, maxRight - mLeft, mBottom - mTop);
6174 p.invalidateChild(this, r);
6175 }
6176 } else {
6177 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08006178 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006179 }
6180
Chet Haaseed032702010-10-01 14:05:54 -07006181 int oldWidth = mRight - mLeft;
6182 int height = mBottom - mTop;
6183
Chet Haase21cd1382010-09-01 17:42:29 -07006184 mRight = right;
6185
Chet Haaseed032702010-10-01 14:05:54 -07006186 onSizeChanged(mRight - mLeft, height, oldWidth, height);
6187
Chet Haase21cd1382010-09-01 17:42:29 -07006188 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006189 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6190 // A change in dimension means an auto-centered pivot point changes, too
6191 mMatrixDirty = true;
6192 }
Chet Haase21cd1382010-09-01 17:42:29 -07006193 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006194 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006195 }
Chet Haase55dbb652010-12-21 20:15:08 -08006196 mBackgroundSizeChanged = true;
Chet Haase21cd1382010-09-01 17:42:29 -07006197 }
6198 }
6199
6200 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006201 * The visual x position of this view, in pixels. This is equivalent to the
6202 * {@link #setTranslationX(float) translationX} property plus the current
6203 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07006204 *
Chet Haasedf030d22010-07-30 17:22:38 -07006205 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07006206 */
Chet Haasedf030d22010-07-30 17:22:38 -07006207 public float getX() {
6208 return mLeft + mTranslationX;
6209 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006210
Chet Haasedf030d22010-07-30 17:22:38 -07006211 /**
6212 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
6213 * {@link #setTranslationX(float) translationX} property to be the difference between
6214 * the x value passed in and the current {@link #getLeft() left} property.
6215 *
6216 * @param x The visual x position of this view, in pixels.
6217 */
6218 public void setX(float x) {
6219 setTranslationX(x - mLeft);
6220 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006221
Chet Haasedf030d22010-07-30 17:22:38 -07006222 /**
6223 * The visual y position of this view, in pixels. This is equivalent to the
6224 * {@link #setTranslationY(float) translationY} property plus the current
6225 * {@link #getTop() top} property.
6226 *
6227 * @return The visual y position of this view, in pixels.
6228 */
6229 public float getY() {
6230 return mTop + mTranslationY;
6231 }
6232
6233 /**
6234 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
6235 * {@link #setTranslationY(float) translationY} property to be the difference between
6236 * the y value passed in and the current {@link #getTop() top} property.
6237 *
6238 * @param y The visual y position of this view, in pixels.
6239 */
6240 public void setY(float y) {
6241 setTranslationY(y - mTop);
6242 }
6243
6244
6245 /**
6246 * The horizontal location of this view relative to its {@link #getLeft() left} position.
6247 * This position is post-layout, in addition to wherever the object's
6248 * layout placed it.
6249 *
6250 * @return The horizontal position of this view relative to its left position, in pixels.
6251 */
6252 public float getTranslationX() {
6253 return mTranslationX;
6254 }
6255
6256 /**
6257 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
6258 * This effectively positions the object post-layout, in addition to wherever the object's
6259 * layout placed it.
6260 *
6261 * @param translationX The horizontal position of this view relative to its left position,
6262 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08006263 *
6264 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07006265 */
6266 public void setTranslationX(float translationX) {
6267 if (mTranslationX != translationX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006268 invalidateParentCaches();
Chet Haasedf030d22010-07-30 17:22:38 -07006269 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006270 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006271 mTranslationX = translationX;
6272 mMatrixDirty = true;
6273 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006274 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006275 }
6276 }
6277
6278 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006279 * The horizontal location of this view relative to its {@link #getTop() top} position.
6280 * This position is post-layout, in addition to wherever the object's
6281 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07006282 *
Chet Haasedf030d22010-07-30 17:22:38 -07006283 * @return The vertical position of this view relative to its top position,
6284 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07006285 */
Chet Haasedf030d22010-07-30 17:22:38 -07006286 public float getTranslationY() {
6287 return mTranslationY;
Chet Haasec3aa3612010-06-17 08:50:37 -07006288 }
6289
6290 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006291 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
6292 * This effectively positions the object post-layout, in addition to wherever the object's
6293 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07006294 *
Chet Haasedf030d22010-07-30 17:22:38 -07006295 * @param translationY The vertical position of this view relative to its top position,
6296 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08006297 *
6298 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07006299 */
Chet Haasedf030d22010-07-30 17:22:38 -07006300 public void setTranslationY(float translationY) {
6301 if (mTranslationY != translationY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006302 invalidateParentCaches();
Chet Haasedf030d22010-07-30 17:22:38 -07006303 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006304 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006305 mTranslationY = translationY;
6306 mMatrixDirty = true;
6307 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006308 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006309 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006310 }
6311
6312 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006313 * Hit rectangle in parent's coordinates
6314 *
6315 * @param outRect The hit rectangle of the view.
6316 */
6317 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07006318 updateMatrix();
6319 if (mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006320 outRect.set(mLeft, mTop, mRight, mBottom);
6321 } else {
6322 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Romain Guy33e72ae2010-07-17 12:40:29 -07006323 tmpRect.set(-mPivotX, -mPivotY, getWidth() - mPivotX, getHeight() - mPivotY);
Jeff Brown86671742010-09-30 20:00:15 -07006324 mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07006325 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
6326 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07006327 }
6328 }
6329
6330 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07006331 * Determines whether the given point, in local coordinates is inside the view.
6332 */
6333 /*package*/ final boolean pointInView(float localX, float localY) {
6334 return localX >= 0 && localX < (mRight - mLeft)
6335 && localY >= 0 && localY < (mBottom - mTop);
6336 }
6337
6338 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07006339 * Utility method to determine whether the given point, in local coordinates,
6340 * is inside the view, where the area of the view is expanded by the slop factor.
6341 * This method is called while processing touch-move events to determine if the event
6342 * is still within the view.
6343 */
6344 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07006345 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07006346 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006347 }
6348
6349 /**
6350 * When a view has focus and the user navigates away from it, the next view is searched for
6351 * starting from the rectangle filled in by this method.
6352 *
6353 * By default, the rectange is the {@link #getDrawingRect})of the view. However, if your
6354 * view maintains some idea of internal selection, such as a cursor, or a selected row
6355 * or column, you should override this method and fill in a more specific rectangle.
6356 *
6357 * @param r The rectangle to fill in, in this view's coordinates.
6358 */
6359 public void getFocusedRect(Rect r) {
6360 getDrawingRect(r);
6361 }
6362
6363 /**
6364 * If some part of this view is not clipped by any of its parents, then
6365 * return that area in r in global (root) coordinates. To convert r to local
6366 * coordinates, offset it by -globalOffset (e.g. r.offset(-globalOffset.x,
6367 * -globalOffset.y)) If the view is completely clipped or translated out,
6368 * return false.
6369 *
6370 * @param r If true is returned, r holds the global coordinates of the
6371 * visible portion of this view.
6372 * @param globalOffset If true is returned, globalOffset holds the dx,dy
6373 * between this view and its root. globalOffet may be null.
6374 * @return true if r is non-empty (i.e. part of the view is visible at the
6375 * root level.
6376 */
6377 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
6378 int width = mRight - mLeft;
6379 int height = mBottom - mTop;
6380 if (width > 0 && height > 0) {
6381 r.set(0, 0, width, height);
6382 if (globalOffset != null) {
6383 globalOffset.set(-mScrollX, -mScrollY);
6384 }
6385 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
6386 }
6387 return false;
6388 }
6389
6390 public final boolean getGlobalVisibleRect(Rect r) {
6391 return getGlobalVisibleRect(r, null);
6392 }
6393
6394 public final boolean getLocalVisibleRect(Rect r) {
6395 Point offset = new Point();
6396 if (getGlobalVisibleRect(r, offset)) {
6397 r.offset(-offset.x, -offset.y); // make r local
6398 return true;
6399 }
6400 return false;
6401 }
6402
6403 /**
6404 * Offset this view's vertical location by the specified number of pixels.
6405 *
6406 * @param offset the number of pixels to offset the view by
6407 */
6408 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006409 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07006410 updateMatrix();
6411 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006412 final ViewParent p = mParent;
6413 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006414 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006415 int minTop;
6416 int maxBottom;
6417 int yLoc;
6418 if (offset < 0) {
6419 minTop = mTop + offset;
6420 maxBottom = mBottom;
6421 yLoc = offset;
6422 } else {
6423 minTop = mTop;
6424 maxBottom = mBottom + offset;
6425 yLoc = 0;
6426 }
6427 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
6428 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07006429 }
6430 } else {
Chet Haaseed032702010-10-01 14:05:54 -07006431 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006432 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006433
Chet Haasec3aa3612010-06-17 08:50:37 -07006434 mTop += offset;
6435 mBottom += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07006436
Chet Haasec3aa3612010-06-17 08:50:37 -07006437 if (!mMatrixIsIdentity) {
6438 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006439 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006440 }
6441 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006442 }
6443
6444 /**
6445 * Offset this view's horizontal location by the specified amount of pixels.
6446 *
6447 * @param offset the numer of pixels to offset the view by
6448 */
6449 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006450 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07006451 updateMatrix();
6452 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006453 final ViewParent p = mParent;
6454 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006455 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006456 int minLeft;
6457 int maxRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006458 if (offset < 0) {
6459 minLeft = mLeft + offset;
6460 maxRight = mRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006461 } else {
6462 minLeft = mLeft;
6463 maxRight = mRight + offset;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006464 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006465 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
Chet Haase8fbf8d22010-07-30 15:01:32 -07006466 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07006467 }
6468 } else {
Chet Haaseed032702010-10-01 14:05:54 -07006469 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006470 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006471
Chet Haasec3aa3612010-06-17 08:50:37 -07006472 mLeft += offset;
6473 mRight += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07006474
Chet Haasec3aa3612010-06-17 08:50:37 -07006475 if (!mMatrixIsIdentity) {
6476 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006477 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006478 }
6479 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006480 }
6481
6482 /**
6483 * Get the LayoutParams associated with this view. All views should have
6484 * layout parameters. These supply parameters to the <i>parent</i> of this
6485 * view specifying how it should be arranged. There are many subclasses of
6486 * ViewGroup.LayoutParams, and these correspond to the different subclasses
6487 * of ViewGroup that are responsible for arranging their children.
6488 * @return The LayoutParams associated with this view
6489 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07006490 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006491 public ViewGroup.LayoutParams getLayoutParams() {
6492 return mLayoutParams;
6493 }
6494
6495 /**
6496 * Set the layout parameters associated with this view. These supply
6497 * parameters to the <i>parent</i> of this view specifying how it should be
6498 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
6499 * correspond to the different subclasses of ViewGroup that are responsible
6500 * for arranging their children.
6501 *
6502 * @param params the layout parameters for this view
6503 */
6504 public void setLayoutParams(ViewGroup.LayoutParams params) {
6505 if (params == null) {
6506 throw new NullPointerException("params == null");
6507 }
6508 mLayoutParams = params;
6509 requestLayout();
6510 }
6511
6512 /**
6513 * Set the scrolled position of your view. This will cause a call to
6514 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6515 * invalidated.
6516 * @param x the x position to scroll to
6517 * @param y the y position to scroll to
6518 */
6519 public void scrollTo(int x, int y) {
6520 if (mScrollX != x || mScrollY != y) {
6521 int oldX = mScrollX;
6522 int oldY = mScrollY;
6523 mScrollX = x;
6524 mScrollY = y;
Romain Guy0fd89bf2011-01-26 15:41:30 -08006525 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006526 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07006527 if (!awakenScrollBars()) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006528 invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -07006529 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006530 }
6531 }
6532
6533 /**
6534 * Move the scrolled position of your view. This will cause a call to
6535 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6536 * invalidated.
6537 * @param x the amount of pixels to scroll by horizontally
6538 * @param y the amount of pixels to scroll by vertically
6539 */
6540 public void scrollBy(int x, int y) {
6541 scrollTo(mScrollX + x, mScrollY + y);
6542 }
6543
6544 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006545 * <p>Trigger the scrollbars to draw. When invoked this method starts an
6546 * animation to fade the scrollbars out after a default delay. If a subclass
6547 * provides animated scrolling, the start delay should equal the duration
6548 * of the scrolling animation.</p>
6549 *
6550 * <p>The animation starts only if at least one of the scrollbars is
6551 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
6552 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6553 * this method returns true, and false otherwise. If the animation is
6554 * started, this method calls {@link #invalidate()}; in that case the
6555 * caller should not call {@link #invalidate()}.</p>
6556 *
6557 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07006558 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07006559 *
6560 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
6561 * and {@link #scrollTo(int, int)}.</p>
6562 *
6563 * @return true if the animation is played, false otherwise
6564 *
6565 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07006566 * @see #scrollBy(int, int)
6567 * @see #scrollTo(int, int)
6568 * @see #isHorizontalScrollBarEnabled()
6569 * @see #isVerticalScrollBarEnabled()
6570 * @see #setHorizontalScrollBarEnabled(boolean)
6571 * @see #setVerticalScrollBarEnabled(boolean)
6572 */
6573 protected boolean awakenScrollBars() {
6574 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07006575 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07006576 }
6577
6578 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07006579 * Trigger the scrollbars to draw.
6580 * This method differs from awakenScrollBars() only in its default duration.
6581 * initialAwakenScrollBars() will show the scroll bars for longer than
6582 * usual to give the user more of a chance to notice them.
6583 *
6584 * @return true if the animation is played, false otherwise.
6585 */
6586 private boolean initialAwakenScrollBars() {
6587 return mScrollCache != null &&
6588 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
6589 }
6590
6591 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006592 * <p>
6593 * Trigger the scrollbars to draw. When invoked this method starts an
6594 * animation to fade the scrollbars out after a fixed delay. If a subclass
6595 * provides animated scrolling, the start delay should equal the duration of
6596 * the scrolling animation.
6597 * </p>
6598 *
6599 * <p>
6600 * The animation starts only if at least one of the scrollbars is enabled,
6601 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6602 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6603 * this method returns true, and false otherwise. If the animation is
6604 * started, this method calls {@link #invalidate()}; in that case the caller
6605 * should not call {@link #invalidate()}.
6606 * </p>
6607 *
6608 * <p>
6609 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07006610 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07006611 * </p>
6612 *
6613 * @param startDelay the delay, in milliseconds, after which the animation
6614 * should start; when the delay is 0, the animation starts
6615 * immediately
6616 * @return true if the animation is played, false otherwise
6617 *
Mike Cleronf116bf82009-09-27 19:14:12 -07006618 * @see #scrollBy(int, int)
6619 * @see #scrollTo(int, int)
6620 * @see #isHorizontalScrollBarEnabled()
6621 * @see #isVerticalScrollBarEnabled()
6622 * @see #setHorizontalScrollBarEnabled(boolean)
6623 * @see #setVerticalScrollBarEnabled(boolean)
6624 */
6625 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07006626 return awakenScrollBars(startDelay, true);
6627 }
6628
6629 /**
6630 * <p>
6631 * Trigger the scrollbars to draw. When invoked this method starts an
6632 * animation to fade the scrollbars out after a fixed delay. If a subclass
6633 * provides animated scrolling, the start delay should equal the duration of
6634 * the scrolling animation.
6635 * </p>
6636 *
6637 * <p>
6638 * The animation starts only if at least one of the scrollbars is enabled,
6639 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6640 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6641 * this method returns true, and false otherwise. If the animation is
6642 * started, this method calls {@link #invalidate()} if the invalidate parameter
6643 * is set to true; in that case the caller
6644 * should not call {@link #invalidate()}.
6645 * </p>
6646 *
6647 * <p>
6648 * This method should be invoked everytime a subclass directly updates the
6649 * scroll parameters.
6650 * </p>
6651 *
6652 * @param startDelay the delay, in milliseconds, after which the animation
6653 * should start; when the delay is 0, the animation starts
6654 * immediately
6655 *
6656 * @param invalidate Wheter this method should call invalidate
6657 *
6658 * @return true if the animation is played, false otherwise
6659 *
6660 * @see #scrollBy(int, int)
6661 * @see #scrollTo(int, int)
6662 * @see #isHorizontalScrollBarEnabled()
6663 * @see #isVerticalScrollBarEnabled()
6664 * @see #setHorizontalScrollBarEnabled(boolean)
6665 * @see #setVerticalScrollBarEnabled(boolean)
6666 */
6667 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07006668 final ScrollabilityCache scrollCache = mScrollCache;
6669
6670 if (scrollCache == null || !scrollCache.fadeScrollBars) {
6671 return false;
6672 }
6673
6674 if (scrollCache.scrollBar == null) {
6675 scrollCache.scrollBar = new ScrollBarDrawable();
6676 }
6677
6678 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
6679
Mike Cleron290947b2009-09-29 18:34:32 -07006680 if (invalidate) {
6681 // Invalidate to show the scrollbars
Romain Guy0fd89bf2011-01-26 15:41:30 -08006682 invalidate(true);
Mike Cleron290947b2009-09-29 18:34:32 -07006683 }
Mike Cleronf116bf82009-09-27 19:14:12 -07006684
6685 if (scrollCache.state == ScrollabilityCache.OFF) {
6686 // FIXME: this is copied from WindowManagerService.
6687 // We should get this value from the system when it
6688 // is possible to do so.
6689 final int KEY_REPEAT_FIRST_DELAY = 750;
6690 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
6691 }
6692
6693 // Tell mScrollCache when we should start fading. This may
6694 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07006695 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07006696 scrollCache.fadeStartTime = fadeStartTime;
6697 scrollCache.state = ScrollabilityCache.ON;
6698
6699 // Schedule our fader to run, unscheduling any old ones first
6700 if (mAttachInfo != null) {
6701 mAttachInfo.mHandler.removeCallbacks(scrollCache);
6702 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
6703 }
6704
6705 return true;
6706 }
6707
6708 return false;
6709 }
6710
6711 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006712 * Mark the the area defined by dirty as needing to be drawn. If the view is
6713 * visible, {@link #onDraw} will be called at some point in the future.
6714 * This must be called from a UI thread. To call from a non-UI thread, call
6715 * {@link #postInvalidate()}.
6716 *
6717 * WARNING: This method is destructive to dirty.
6718 * @param dirty the rectangle representing the bounds of the dirty region
6719 */
6720 public void invalidate(Rect dirty) {
6721 if (ViewDebug.TRACE_HIERARCHY) {
6722 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6723 }
6724
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006725 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08006726 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
6727 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006728 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08006729 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006730 final ViewParent p = mParent;
6731 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08006732 //noinspection PointlessBooleanExpression,ConstantConditions
6733 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
6734 if (p != null && ai != null && ai.mHardwareAccelerated) {
6735 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6736 // with a null dirty rect, which tells the ViewRoot to redraw everything
6737 p.invalidateChild(this, null);
6738 return;
6739 }
Romain Guyaf636eb2010-12-09 17:47:21 -08006740 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006741 if (p != null && ai != null) {
6742 final int scrollX = mScrollX;
6743 final int scrollY = mScrollY;
6744 final Rect r = ai.mTmpInvalRect;
6745 r.set(dirty.left - scrollX, dirty.top - scrollY,
6746 dirty.right - scrollX, dirty.bottom - scrollY);
6747 mParent.invalidateChild(this, r);
6748 }
6749 }
6750 }
6751
6752 /**
6753 * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
6754 * The coordinates of the dirty rect are relative to the view.
6755 * If the view is visible, {@link #onDraw} will be called at some point
6756 * in the future. This must be called from a UI thread. To call
6757 * from a non-UI thread, call {@link #postInvalidate()}.
6758 * @param l the left position of the dirty region
6759 * @param t the top position of the dirty region
6760 * @param r the right position of the dirty region
6761 * @param b the bottom position of the dirty region
6762 */
6763 public void invalidate(int l, int t, int r, int b) {
6764 if (ViewDebug.TRACE_HIERARCHY) {
6765 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6766 }
6767
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006768 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08006769 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
6770 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006771 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08006772 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006773 final ViewParent p = mParent;
6774 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08006775 //noinspection PointlessBooleanExpression,ConstantConditions
6776 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
6777 if (p != null && ai != null && ai.mHardwareAccelerated) {
6778 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6779 // with a null dirty rect, which tells the ViewRoot to redraw everything
6780 p.invalidateChild(this, null);
6781 return;
6782 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08006783 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006784 if (p != null && ai != null && l < r && t < b) {
6785 final int scrollX = mScrollX;
6786 final int scrollY = mScrollY;
6787 final Rect tmpr = ai.mTmpInvalRect;
6788 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
6789 p.invalidateChild(this, tmpr);
6790 }
6791 }
6792 }
6793
6794 /**
6795 * Invalidate the whole view. If the view is visible, {@link #onDraw} will
6796 * be called at some point in the future. This must be called from a
6797 * UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
6798 */
6799 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -07006800 invalidate(true);
6801 }
Romain Guyc5d55862011-01-21 19:01:46 -08006802
Chet Haaseed032702010-10-01 14:05:54 -07006803 /**
6804 * This is where the invalidate() work actually happens. A full invalidate()
6805 * causes the drawing cache to be invalidated, but this function can be called with
6806 * invalidateCache set to false to skip that invalidation step for cases that do not
6807 * need it (for example, a component that remains at the same dimensions with the same
6808 * content).
6809 *
6810 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
6811 * well. This is usually true for a full invalidate, but may be set to false if the
6812 * View's contents or dimensions have not changed.
6813 */
6814 private void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006815 if (ViewDebug.TRACE_HIERARCHY) {
6816 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6817 }
6818
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006819 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Romain Guyc5d55862011-01-21 19:01:46 -08006820 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) ||
Romain Guy0fd89bf2011-01-26 15:41:30 -08006821 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) {
6822 mLastIsOpaque = isOpaque();
Chet Haaseed032702010-10-01 14:05:54 -07006823 mPrivateFlags &= ~DRAWN;
6824 if (invalidateCache) {
Chet Haasedaf98e92011-01-10 14:10:36 -08006825 mPrivateFlags |= INVALIDATED;
Chet Haaseed032702010-10-01 14:05:54 -07006826 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6827 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006828 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -07006829 final ViewParent p = mParent;
Romain Guy7d7b5492011-01-24 16:33:45 -08006830 //noinspection PointlessBooleanExpression,ConstantConditions
6831 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
6832 if (p != null && ai != null && ai.mHardwareAccelerated) {
6833 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
6834 // with a null dirty rect, which tells the ViewRoot to redraw everything
6835 p.invalidateChild(this, null);
6836 return;
6837 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08006838 }
Michael Jurkaebefea42010-11-15 16:04:01 -08006839
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006840 if (p != null && ai != null) {
6841 final Rect r = ai.mTmpInvalRect;
6842 r.set(0, 0, mRight - mLeft, mBottom - mTop);
6843 // Don't call invalidate -- we don't want to internally scroll
6844 // our own bounds
6845 p.invalidateChild(this, r);
6846 }
6847 }
6848 }
6849
6850 /**
Romain Guy0fd89bf2011-01-26 15:41:30 -08006851 * Used to indicate that the parent of this view should clear its caches. This functionality
Chet Haasedaf98e92011-01-10 14:10:36 -08006852 * is used to force the parent to rebuild its display list (when hardware-accelerated),
6853 * which is necessary when various parent-managed properties of the view change, such as
Romain Guy0fd89bf2011-01-26 15:41:30 -08006854 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only
6855 * clears the parent caches and does not causes an invalidate event.
Chet Haasedaf98e92011-01-10 14:10:36 -08006856 *
6857 * @hide
6858 */
Romain Guy0fd89bf2011-01-26 15:41:30 -08006859 protected void invalidateParentCaches() {
6860 if (mParent instanceof View) {
6861 ((View) mParent).mPrivateFlags |= INVALIDATED;
6862 }
6863 }
6864
6865 /**
6866 * Used to indicate that the parent of this view should be invalidated. This functionality
6867 * is used to force the parent to rebuild its display list (when hardware-accelerated),
6868 * which is necessary when various parent-managed properties of the view change, such as
6869 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate
6870 * an invalidation event to the parent.
6871 *
6872 * @hide
6873 */
6874 protected void invalidateParentIfNeeded() {
Chet Haasedaf98e92011-01-10 14:10:36 -08006875 if (isHardwareAccelerated() && mParent instanceof View) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006876 ((View) mParent).invalidate(true);
Chet Haasedaf98e92011-01-10 14:10:36 -08006877 }
6878 }
6879
6880 /**
Romain Guy24443ea2009-05-11 11:56:30 -07006881 * Indicates whether this View is opaque. An opaque View guarantees that it will
6882 * draw all the pixels overlapping its bounds using a fully opaque color.
6883 *
6884 * Subclasses of View should override this method whenever possible to indicate
6885 * whether an instance is opaque. Opaque Views are treated in a special way by
6886 * the View hierarchy, possibly allowing it to perform optimizations during
6887 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -07006888 *
Romain Guy24443ea2009-05-11 11:56:30 -07006889 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -07006890 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07006891 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -07006892 public boolean isOpaque() {
Chet Haase70d4ba12010-10-06 09:46:45 -07006893 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK &&
6894 (mAlpha >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD);
Romain Guy8f1344f52009-05-15 16:03:59 -07006895 }
6896
Adam Powell20232d02010-12-08 21:08:53 -08006897 /**
6898 * @hide
6899 */
6900 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -07006901 // Opaque if:
6902 // - Has a background
6903 // - Background is opaque
6904 // - Doesn't have scrollbars or scrollbars are inside overlay
6905
6906 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) {
6907 mPrivateFlags |= OPAQUE_BACKGROUND;
6908 } else {
6909 mPrivateFlags &= ~OPAQUE_BACKGROUND;
6910 }
6911
6912 final int flags = mViewFlags;
6913 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
6914 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
6915 mPrivateFlags |= OPAQUE_SCROLLBARS;
6916 } else {
6917 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
6918 }
6919 }
6920
6921 /**
6922 * @hide
6923 */
6924 protected boolean hasOpaqueScrollbars() {
6925 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -07006926 }
6927
6928 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006929 * @return A handler associated with the thread running the View. This
6930 * handler can be used to pump events in the UI events queue.
6931 */
6932 public Handler getHandler() {
6933 if (mAttachInfo != null) {
6934 return mAttachInfo.mHandler;
6935 }
6936 return null;
6937 }
6938
6939 /**
6940 * Causes the Runnable to be added to the message queue.
6941 * The runnable will be run on the user interface thread.
6942 *
6943 * @param action The Runnable that will be executed.
6944 *
6945 * @return Returns true if the Runnable was successfully placed in to the
6946 * message queue. Returns false on failure, usually because the
6947 * looper processing the message queue is exiting.
6948 */
6949 public boolean post(Runnable action) {
6950 Handler handler;
6951 if (mAttachInfo != null) {
6952 handler = mAttachInfo.mHandler;
6953 } else {
6954 // Assume that post will succeed later
6955 ViewRoot.getRunQueue().post(action);
6956 return true;
6957 }
6958
6959 return handler.post(action);
6960 }
6961
6962 /**
6963 * Causes the Runnable to be added to the message queue, to be run
6964 * after the specified amount of time elapses.
6965 * The runnable will be run on the user interface thread.
6966 *
6967 * @param action The Runnable that will be executed.
6968 * @param delayMillis The delay (in milliseconds) until the Runnable
6969 * will be executed.
6970 *
6971 * @return true if the Runnable was successfully placed in to the
6972 * message queue. Returns false on failure, usually because the
6973 * looper processing the message queue is exiting. Note that a
6974 * result of true does not mean the Runnable will be processed --
6975 * if the looper is quit before the delivery time of the message
6976 * occurs then the message will be dropped.
6977 */
6978 public boolean postDelayed(Runnable action, long delayMillis) {
6979 Handler handler;
6980 if (mAttachInfo != null) {
6981 handler = mAttachInfo.mHandler;
6982 } else {
6983 // Assume that post will succeed later
6984 ViewRoot.getRunQueue().postDelayed(action, delayMillis);
6985 return true;
6986 }
6987
6988 return handler.postDelayed(action, delayMillis);
6989 }
6990
6991 /**
6992 * Removes the specified Runnable from the message queue.
6993 *
6994 * @param action The Runnable to remove from the message handling queue
6995 *
6996 * @return true if this view could ask the Handler to remove the Runnable,
6997 * false otherwise. When the returned value is true, the Runnable
6998 * may or may not have been actually removed from the message queue
6999 * (for instance, if the Runnable was not in the queue already.)
7000 */
7001 public boolean removeCallbacks(Runnable action) {
7002 Handler handler;
7003 if (mAttachInfo != null) {
7004 handler = mAttachInfo.mHandler;
7005 } else {
7006 // Assume that post will succeed later
7007 ViewRoot.getRunQueue().removeCallbacks(action);
7008 return true;
7009 }
7010
7011 handler.removeCallbacks(action);
7012 return true;
7013 }
7014
7015 /**
7016 * Cause an invalidate to happen on a subsequent cycle through the event loop.
7017 * Use this to invalidate the View from a non-UI thread.
7018 *
7019 * @see #invalidate()
7020 */
7021 public void postInvalidate() {
7022 postInvalidateDelayed(0);
7023 }
7024
7025 /**
7026 * Cause an invalidate of the specified area to happen on a subsequent cycle
7027 * through the event loop. Use this to invalidate the View from a non-UI thread.
7028 *
7029 * @param left The left coordinate of the rectangle to invalidate.
7030 * @param top The top coordinate of the rectangle to invalidate.
7031 * @param right The right coordinate of the rectangle to invalidate.
7032 * @param bottom The bottom coordinate of the rectangle to invalidate.
7033 *
7034 * @see #invalidate(int, int, int, int)
7035 * @see #invalidate(Rect)
7036 */
7037 public void postInvalidate(int left, int top, int right, int bottom) {
7038 postInvalidateDelayed(0, left, top, right, bottom);
7039 }
7040
7041 /**
7042 * Cause an invalidate to happen on a subsequent cycle through the event
7043 * loop. Waits for the specified amount of time.
7044 *
7045 * @param delayMilliseconds the duration in milliseconds to delay the
7046 * invalidation by
7047 */
7048 public void postInvalidateDelayed(long delayMilliseconds) {
7049 // We try only with the AttachInfo because there's no point in invalidating
7050 // if we are not attached to our window
7051 if (mAttachInfo != null) {
7052 Message msg = Message.obtain();
7053 msg.what = AttachInfo.INVALIDATE_MSG;
7054 msg.obj = this;
7055 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
7056 }
7057 }
7058
7059 /**
7060 * Cause an invalidate of the specified area to happen on a subsequent cycle
7061 * through the event loop. Waits for the specified amount of time.
7062 *
7063 * @param delayMilliseconds the duration in milliseconds to delay the
7064 * invalidation by
7065 * @param left The left coordinate of the rectangle to invalidate.
7066 * @param top The top coordinate of the rectangle to invalidate.
7067 * @param right The right coordinate of the rectangle to invalidate.
7068 * @param bottom The bottom coordinate of the rectangle to invalidate.
7069 */
7070 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
7071 int right, int bottom) {
7072
7073 // We try only with the AttachInfo because there's no point in invalidating
7074 // if we are not attached to our window
7075 if (mAttachInfo != null) {
7076 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
7077 info.target = this;
7078 info.left = left;
7079 info.top = top;
7080 info.right = right;
7081 info.bottom = bottom;
7082
7083 final Message msg = Message.obtain();
7084 msg.what = AttachInfo.INVALIDATE_RECT_MSG;
7085 msg.obj = info;
7086 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
7087 }
7088 }
7089
7090 /**
7091 * Called by a parent to request that a child update its values for mScrollX
7092 * and mScrollY if necessary. This will typically be done if the child is
7093 * animating a scroll using a {@link android.widget.Scroller Scroller}
7094 * object.
7095 */
7096 public void computeScroll() {
7097 }
7098
7099 /**
7100 * <p>Indicate whether the horizontal edges are faded when the view is
7101 * scrolled horizontally.</p>
7102 *
7103 * @return true if the horizontal edges should are faded on scroll, false
7104 * otherwise
7105 *
7106 * @see #setHorizontalFadingEdgeEnabled(boolean)
7107 * @attr ref android.R.styleable#View_fadingEdge
7108 */
7109 public boolean isHorizontalFadingEdgeEnabled() {
7110 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
7111 }
7112
7113 /**
7114 * <p>Define whether the horizontal edges should be faded when this view
7115 * is scrolled horizontally.</p>
7116 *
7117 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
7118 * be faded when the view is scrolled
7119 * horizontally
7120 *
7121 * @see #isHorizontalFadingEdgeEnabled()
7122 * @attr ref android.R.styleable#View_fadingEdge
7123 */
7124 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
7125 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
7126 if (horizontalFadingEdgeEnabled) {
7127 initScrollCache();
7128 }
7129
7130 mViewFlags ^= FADING_EDGE_HORIZONTAL;
7131 }
7132 }
7133
7134 /**
7135 * <p>Indicate whether the vertical edges are faded when the view is
7136 * scrolled horizontally.</p>
7137 *
7138 * @return true if the vertical edges should are faded on scroll, false
7139 * otherwise
7140 *
7141 * @see #setVerticalFadingEdgeEnabled(boolean)
7142 * @attr ref android.R.styleable#View_fadingEdge
7143 */
7144 public boolean isVerticalFadingEdgeEnabled() {
7145 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
7146 }
7147
7148 /**
7149 * <p>Define whether the vertical edges should be faded when this view
7150 * is scrolled vertically.</p>
7151 *
7152 * @param verticalFadingEdgeEnabled true if the vertical edges should
7153 * be faded when the view is scrolled
7154 * vertically
7155 *
7156 * @see #isVerticalFadingEdgeEnabled()
7157 * @attr ref android.R.styleable#View_fadingEdge
7158 */
7159 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
7160 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
7161 if (verticalFadingEdgeEnabled) {
7162 initScrollCache();
7163 }
7164
7165 mViewFlags ^= FADING_EDGE_VERTICAL;
7166 }
7167 }
7168
7169 /**
7170 * Returns the strength, or intensity, of the top faded edge. The strength is
7171 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7172 * returns 0.0 or 1.0 but no value in between.
7173 *
7174 * Subclasses should override this method to provide a smoother fade transition
7175 * when scrolling occurs.
7176 *
7177 * @return the intensity of the top fade as a float between 0.0f and 1.0f
7178 */
7179 protected float getTopFadingEdgeStrength() {
7180 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
7181 }
7182
7183 /**
7184 * Returns the strength, or intensity, of the bottom faded edge. The strength is
7185 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7186 * returns 0.0 or 1.0 but no value in between.
7187 *
7188 * Subclasses should override this method to provide a smoother fade transition
7189 * when scrolling occurs.
7190 *
7191 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
7192 */
7193 protected float getBottomFadingEdgeStrength() {
7194 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
7195 computeVerticalScrollRange() ? 1.0f : 0.0f;
7196 }
7197
7198 /**
7199 * Returns the strength, or intensity, of the left faded edge. The strength is
7200 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7201 * returns 0.0 or 1.0 but no value in between.
7202 *
7203 * Subclasses should override this method to provide a smoother fade transition
7204 * when scrolling occurs.
7205 *
7206 * @return the intensity of the left fade as a float between 0.0f and 1.0f
7207 */
7208 protected float getLeftFadingEdgeStrength() {
7209 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
7210 }
7211
7212 /**
7213 * Returns the strength, or intensity, of the right faded edge. The strength is
7214 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7215 * returns 0.0 or 1.0 but no value in between.
7216 *
7217 * Subclasses should override this method to provide a smoother fade transition
7218 * when scrolling occurs.
7219 *
7220 * @return the intensity of the right fade as a float between 0.0f and 1.0f
7221 */
7222 protected float getRightFadingEdgeStrength() {
7223 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
7224 computeHorizontalScrollRange() ? 1.0f : 0.0f;
7225 }
7226
7227 /**
7228 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
7229 * scrollbar is not drawn by default.</p>
7230 *
7231 * @return true if the horizontal scrollbar should be painted, false
7232 * otherwise
7233 *
7234 * @see #setHorizontalScrollBarEnabled(boolean)
7235 */
7236 public boolean isHorizontalScrollBarEnabled() {
7237 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
7238 }
7239
7240 /**
7241 * <p>Define whether the horizontal scrollbar should be drawn or not. The
7242 * scrollbar is not drawn by default.</p>
7243 *
7244 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
7245 * be painted
7246 *
7247 * @see #isHorizontalScrollBarEnabled()
7248 */
7249 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
7250 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
7251 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07007252 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007253 recomputePadding();
7254 }
7255 }
7256
7257 /**
7258 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
7259 * scrollbar is not drawn by default.</p>
7260 *
7261 * @return true if the vertical scrollbar should be painted, false
7262 * otherwise
7263 *
7264 * @see #setVerticalScrollBarEnabled(boolean)
7265 */
7266 public boolean isVerticalScrollBarEnabled() {
7267 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
7268 }
7269
7270 /**
7271 * <p>Define whether the vertical scrollbar should be drawn or not. The
7272 * scrollbar is not drawn by default.</p>
7273 *
7274 * @param verticalScrollBarEnabled true if the vertical scrollbar should
7275 * be painted
7276 *
7277 * @see #isVerticalScrollBarEnabled()
7278 */
7279 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
7280 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
7281 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07007282 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007283 recomputePadding();
7284 }
7285 }
7286
Adam Powell20232d02010-12-08 21:08:53 -08007287 /**
7288 * @hide
7289 */
7290 protected void recomputePadding() {
7291 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007292 }
Mike Cleronfe81d382009-09-28 14:22:16 -07007293
7294 /**
7295 * Define whether scrollbars will fade when the view is not scrolling.
7296 *
7297 * @param fadeScrollbars wheter to enable fading
7298 *
7299 */
7300 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
7301 initScrollCache();
7302 final ScrollabilityCache scrollabilityCache = mScrollCache;
7303 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -07007304 if (fadeScrollbars) {
7305 scrollabilityCache.state = ScrollabilityCache.OFF;
7306 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -07007307 scrollabilityCache.state = ScrollabilityCache.ON;
7308 }
7309 }
7310
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007311 /**
Mike Cleron52f0a642009-09-28 18:21:37 -07007312 *
7313 * Returns true if scrollbars will fade when this view is not scrolling
7314 *
7315 * @return true if scrollbar fading is enabled
7316 */
7317 public boolean isScrollbarFadingEnabled() {
7318 return mScrollCache != null && mScrollCache.fadeScrollBars;
7319 }
7320
7321 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007322 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
7323 * inset. When inset, they add to the padding of the view. And the scrollbars
7324 * can be drawn inside the padding area or on the edge of the view. For example,
7325 * if a view has a background drawable and you want to draw the scrollbars
7326 * inside the padding specified by the drawable, you can use
7327 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
7328 * appear at the edge of the view, ignoring the padding, then you can use
7329 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
7330 * @param style the style of the scrollbars. Should be one of
7331 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
7332 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
7333 * @see #SCROLLBARS_INSIDE_OVERLAY
7334 * @see #SCROLLBARS_INSIDE_INSET
7335 * @see #SCROLLBARS_OUTSIDE_OVERLAY
7336 * @see #SCROLLBARS_OUTSIDE_INSET
7337 */
7338 public void setScrollBarStyle(int style) {
7339 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
7340 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -07007341 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007342 recomputePadding();
7343 }
7344 }
7345
7346 /**
7347 * <p>Returns the current scrollbar style.</p>
7348 * @return the current scrollbar style
7349 * @see #SCROLLBARS_INSIDE_OVERLAY
7350 * @see #SCROLLBARS_INSIDE_INSET
7351 * @see #SCROLLBARS_OUTSIDE_OVERLAY
7352 * @see #SCROLLBARS_OUTSIDE_INSET
7353 */
7354 public int getScrollBarStyle() {
7355 return mViewFlags & SCROLLBARS_STYLE_MASK;
7356 }
7357
7358 /**
7359 * <p>Compute the horizontal range that the horizontal scrollbar
7360 * represents.</p>
7361 *
7362 * <p>The range is expressed in arbitrary units that must be the same as the
7363 * units used by {@link #computeHorizontalScrollExtent()} and
7364 * {@link #computeHorizontalScrollOffset()}.</p>
7365 *
7366 * <p>The default range is the drawing width of this view.</p>
7367 *
7368 * @return the total horizontal range represented by the horizontal
7369 * scrollbar
7370 *
7371 * @see #computeHorizontalScrollExtent()
7372 * @see #computeHorizontalScrollOffset()
7373 * @see android.widget.ScrollBarDrawable
7374 */
7375 protected int computeHorizontalScrollRange() {
7376 return getWidth();
7377 }
7378
7379 /**
7380 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
7381 * within the horizontal range. This value is used to compute the position
7382 * of the thumb within the scrollbar's track.</p>
7383 *
7384 * <p>The range is expressed in arbitrary units that must be the same as the
7385 * units used by {@link #computeHorizontalScrollRange()} and
7386 * {@link #computeHorizontalScrollExtent()}.</p>
7387 *
7388 * <p>The default offset is the scroll offset of this view.</p>
7389 *
7390 * @return the horizontal offset of the scrollbar's thumb
7391 *
7392 * @see #computeHorizontalScrollRange()
7393 * @see #computeHorizontalScrollExtent()
7394 * @see android.widget.ScrollBarDrawable
7395 */
7396 protected int computeHorizontalScrollOffset() {
7397 return mScrollX;
7398 }
7399
7400 /**
7401 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
7402 * within the horizontal range. This value is used to compute the length
7403 * of the thumb within the scrollbar's track.</p>
7404 *
7405 * <p>The range is expressed in arbitrary units that must be the same as the
7406 * units used by {@link #computeHorizontalScrollRange()} and
7407 * {@link #computeHorizontalScrollOffset()}.</p>
7408 *
7409 * <p>The default extent is the drawing width of this view.</p>
7410 *
7411 * @return the horizontal extent of the scrollbar's thumb
7412 *
7413 * @see #computeHorizontalScrollRange()
7414 * @see #computeHorizontalScrollOffset()
7415 * @see android.widget.ScrollBarDrawable
7416 */
7417 protected int computeHorizontalScrollExtent() {
7418 return getWidth();
7419 }
7420
7421 /**
7422 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
7423 *
7424 * <p>The range is expressed in arbitrary units that must be the same as the
7425 * units used by {@link #computeVerticalScrollExtent()} and
7426 * {@link #computeVerticalScrollOffset()}.</p>
7427 *
7428 * @return the total vertical range represented by the vertical scrollbar
7429 *
7430 * <p>The default range is the drawing height of this view.</p>
7431 *
7432 * @see #computeVerticalScrollExtent()
7433 * @see #computeVerticalScrollOffset()
7434 * @see android.widget.ScrollBarDrawable
7435 */
7436 protected int computeVerticalScrollRange() {
7437 return getHeight();
7438 }
7439
7440 /**
7441 * <p>Compute the vertical offset of the vertical scrollbar's thumb
7442 * within the horizontal range. This value is used to compute the position
7443 * of the thumb within the scrollbar's track.</p>
7444 *
7445 * <p>The range is expressed in arbitrary units that must be the same as the
7446 * units used by {@link #computeVerticalScrollRange()} and
7447 * {@link #computeVerticalScrollExtent()}.</p>
7448 *
7449 * <p>The default offset is the scroll offset of this view.</p>
7450 *
7451 * @return the vertical offset of the scrollbar's thumb
7452 *
7453 * @see #computeVerticalScrollRange()
7454 * @see #computeVerticalScrollExtent()
7455 * @see android.widget.ScrollBarDrawable
7456 */
7457 protected int computeVerticalScrollOffset() {
7458 return mScrollY;
7459 }
7460
7461 /**
7462 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
7463 * within the vertical range. This value is used to compute the length
7464 * of the thumb within the scrollbar's track.</p>
7465 *
7466 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -08007467 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007468 * {@link #computeVerticalScrollOffset()}.</p>
7469 *
7470 * <p>The default extent is the drawing height of this view.</p>
7471 *
7472 * @return the vertical extent of the scrollbar's thumb
7473 *
7474 * @see #computeVerticalScrollRange()
7475 * @see #computeVerticalScrollOffset()
7476 * @see android.widget.ScrollBarDrawable
7477 */
7478 protected int computeVerticalScrollExtent() {
7479 return getHeight();
7480 }
7481
7482 /**
7483 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
7484 * scrollbars are painted only if they have been awakened first.</p>
7485 *
7486 * @param canvas the canvas on which to draw the scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -07007487 *
7488 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007489 */
Romain Guy1d5b3a62009-11-05 18:44:12 -08007490 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007491 // scrollbars are drawn only when the animation is running
7492 final ScrollabilityCache cache = mScrollCache;
7493 if (cache != null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07007494
7495 int state = cache.state;
7496
7497 if (state == ScrollabilityCache.OFF) {
7498 return;
7499 }
7500
7501 boolean invalidate = false;
7502
7503 if (state == ScrollabilityCache.FADING) {
7504 // We're fading -- get our fade interpolation
7505 if (cache.interpolatorValues == null) {
7506 cache.interpolatorValues = new float[1];
7507 }
7508
7509 float[] values = cache.interpolatorValues;
7510
7511 // Stops the animation if we're done
7512 if (cache.scrollBarInterpolator.timeToValues(values) ==
7513 Interpolator.Result.FREEZE_END) {
7514 cache.state = ScrollabilityCache.OFF;
7515 } else {
7516 cache.scrollBar.setAlpha(Math.round(values[0]));
7517 }
7518
7519 // This will make the scroll bars inval themselves after
7520 // drawing. We only want this when we're fading so that
7521 // we prevent excessive redraws
7522 invalidate = true;
7523 } else {
7524 // We're just on -- but we may have been fading before so
7525 // reset alpha
7526 cache.scrollBar.setAlpha(255);
7527 }
7528
7529
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007530 final int viewFlags = mViewFlags;
7531
7532 final boolean drawHorizontalScrollBar =
7533 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
7534 final boolean drawVerticalScrollBar =
7535 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
7536 && !isVerticalScrollBarHidden();
7537
7538 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
7539 final int width = mRight - mLeft;
7540 final int height = mBottom - mTop;
7541
7542 final ScrollBarDrawable scrollBar = cache.scrollBar;
7543 int size = scrollBar.getSize(false);
7544 if (size <= 0) {
7545 size = cache.scrollBarSize;
7546 }
7547
Mike Reede8853fc2009-09-04 14:01:48 -04007548 final int scrollX = mScrollX;
7549 final int scrollY = mScrollY;
7550 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
7551
Mike Cleronf116bf82009-09-27 19:14:12 -07007552 int left, top, right, bottom;
7553
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007554 if (drawHorizontalScrollBar) {
Mike Cleronf116bf82009-09-27 19:14:12 -07007555 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -04007556 computeHorizontalScrollOffset(),
7557 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -04007558 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -07007559 getVerticalScrollbarWidth() : 0;
7560 top = scrollY + height - size - (mUserPaddingBottom & inside);
7561 left = scrollX + (mPaddingLeft & inside);
7562 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
7563 bottom = top + size;
7564 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
7565 if (invalidate) {
7566 invalidate(left, top, right, bottom);
7567 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007568 }
7569
7570 if (drawVerticalScrollBar) {
Mike Reede8853fc2009-09-04 14:01:48 -04007571 scrollBar.setParameters(computeVerticalScrollRange(),
7572 computeVerticalScrollOffset(),
7573 computeVerticalScrollExtent(), true);
Adam Powell20232d02010-12-08 21:08:53 -08007574 switch (mVerticalScrollbarPosition) {
7575 default:
7576 case SCROLLBAR_POSITION_DEFAULT:
7577 case SCROLLBAR_POSITION_RIGHT:
7578 left = scrollX + width - size - (mUserPaddingRight & inside);
7579 break;
7580 case SCROLLBAR_POSITION_LEFT:
7581 left = scrollX + (mUserPaddingLeft & inside);
7582 break;
7583 }
Mike Cleronf116bf82009-09-27 19:14:12 -07007584 top = scrollY + (mPaddingTop & inside);
7585 right = left + size;
7586 bottom = scrollY + height - (mUserPaddingBottom & inside);
7587 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
7588 if (invalidate) {
7589 invalidate(left, top, right, bottom);
7590 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007591 }
7592 }
7593 }
7594 }
Romain Guy8506ab42009-06-11 17:35:47 -07007595
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007596 /**
Romain Guy8506ab42009-06-11 17:35:47 -07007597 * 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 -08007598 * FastScroller is visible.
7599 * @return whether to temporarily hide the vertical scrollbar
7600 * @hide
7601 */
7602 protected boolean isVerticalScrollBarHidden() {
7603 return false;
7604 }
7605
7606 /**
7607 * <p>Draw the horizontal scrollbar if
7608 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
7609 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007610 * @param canvas the canvas on which to draw the scrollbar
7611 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007612 *
7613 * @see #isHorizontalScrollBarEnabled()
7614 * @see #computeHorizontalScrollRange()
7615 * @see #computeHorizontalScrollExtent()
7616 * @see #computeHorizontalScrollOffset()
7617 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -07007618 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007619 */
Romain Guy8fb95422010-08-17 18:38:51 -07007620 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
7621 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007622 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007623 scrollBar.draw(canvas);
7624 }
Mike Reede8853fc2009-09-04 14:01:48 -04007625
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007626 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007627 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
7628 * returns true.</p>
7629 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007630 * @param canvas the canvas on which to draw the scrollbar
7631 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007632 *
7633 * @see #isVerticalScrollBarEnabled()
7634 * @see #computeVerticalScrollRange()
7635 * @see #computeVerticalScrollExtent()
7636 * @see #computeVerticalScrollOffset()
7637 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -04007638 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007639 */
Romain Guy8fb95422010-08-17 18:38:51 -07007640 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
7641 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -04007642 scrollBar.setBounds(l, t, r, b);
7643 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007644 }
7645
7646 /**
7647 * Implement this to do your drawing.
7648 *
7649 * @param canvas the canvas on which the background will be drawn
7650 */
7651 protected void onDraw(Canvas canvas) {
7652 }
7653
7654 /*
7655 * Caller is responsible for calling requestLayout if necessary.
7656 * (This allows addViewInLayout to not request a new layout.)
7657 */
7658 void assignParent(ViewParent parent) {
7659 if (mParent == null) {
7660 mParent = parent;
7661 } else if (parent == null) {
7662 mParent = null;
7663 } else {
7664 throw new RuntimeException("view " + this + " being added, but"
7665 + " it already has a parent");
7666 }
7667 }
7668
7669 /**
7670 * This is called when the view is attached to a window. At this point it
7671 * has a Surface and will start drawing. Note that this function is
7672 * guaranteed to be called before {@link #onDraw}, however it may be called
7673 * any time before the first onDraw -- including before or after
7674 * {@link #onMeasure}.
7675 *
7676 * @see #onDetachedFromWindow()
7677 */
7678 protected void onAttachedToWindow() {
7679 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
7680 mParent.requestTransparentRegion(this);
7681 }
Adam Powell8568c3a2010-04-19 14:26:11 -07007682 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
7683 initialAwakenScrollBars();
7684 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
7685 }
Chet Haasea9b61ac2010-12-20 07:40:25 -08007686 jumpDrawablesToCurrentState();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007687 }
7688
7689 /**
7690 * This is called when the view is detached from a window. At this point it
7691 * no longer has a surface for drawing.
7692 *
7693 * @see #onAttachedToWindow()
7694 */
7695 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -08007696 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -08007697
Romain Guya440b002010-02-24 15:57:54 -08007698 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -05007699 removeLongPressCallback();
Adam Powell3cb8b632011-01-21 15:34:14 -08007700 removePerformClickCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -08007701
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007702 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -08007703
7704 if (mHardwareLayer != null) {
7705 mHardwareLayer.destroy();
7706 mHardwareLayer = null;
7707 }
Romain Guy8dd5b1e2011-01-14 17:28:51 -08007708
Chet Haasedaf98e92011-01-10 14:10:36 -08007709 if (mDisplayList != null) {
7710 mDisplayList.invalidate();
7711 }
7712
Romain Guy8dd5b1e2011-01-14 17:28:51 -08007713 if (mAttachInfo != null) {
7714 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_MSG, this);
7715 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_RECT_MSG, this);
7716 }
7717
Patrick Dubroyec84c3a2011-01-13 17:55:37 -08007718 mCurrentAnimation = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007719 }
7720
7721 /**
7722 * @return The number of times this view has been attached to a window
7723 */
7724 protected int getWindowAttachCount() {
7725 return mWindowAttachCount;
7726 }
7727
7728 /**
7729 * Retrieve a unique token identifying the window this view is attached to.
7730 * @return Return the window's token for use in
7731 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
7732 */
7733 public IBinder getWindowToken() {
7734 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
7735 }
7736
7737 /**
7738 * Retrieve a unique token identifying the top-level "real" window of
7739 * the window that this view is attached to. That is, this is like
7740 * {@link #getWindowToken}, except if the window this view in is a panel
7741 * window (attached to another containing window), then the token of
7742 * the containing window is returned instead.
7743 *
7744 * @return Returns the associated window token, either
7745 * {@link #getWindowToken()} or the containing window's token.
7746 */
7747 public IBinder getApplicationWindowToken() {
7748 AttachInfo ai = mAttachInfo;
7749 if (ai != null) {
7750 IBinder appWindowToken = ai.mPanelParentWindowToken;
7751 if (appWindowToken == null) {
7752 appWindowToken = ai.mWindowToken;
7753 }
7754 return appWindowToken;
7755 }
7756 return null;
7757 }
7758
7759 /**
7760 * Retrieve private session object this view hierarchy is using to
7761 * communicate with the window manager.
7762 * @return the session object to communicate with the window manager
7763 */
7764 /*package*/ IWindowSession getWindowSession() {
7765 return mAttachInfo != null ? mAttachInfo.mSession : null;
7766 }
7767
7768 /**
7769 * @param info the {@link android.view.View.AttachInfo} to associated with
7770 * this view
7771 */
7772 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
7773 //System.out.println("Attached! " + this);
7774 mAttachInfo = info;
7775 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08007776 // We will need to evaluate the drawable state at least once.
7777 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007778 if (mFloatingTreeObserver != null) {
7779 info.mTreeObserver.merge(mFloatingTreeObserver);
7780 mFloatingTreeObserver = null;
7781 }
7782 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
7783 mAttachInfo.mScrollContainers.add(this);
7784 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
7785 }
7786 performCollectViewAttributes(visibility);
7787 onAttachedToWindow();
7788 int vis = info.mWindowVisibility;
7789 if (vis != GONE) {
7790 onWindowVisibilityChanged(vis);
7791 }
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08007792 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) {
7793 // If nobody has evaluated the drawable state yet, then do it now.
7794 refreshDrawableState();
7795 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007796 }
7797
7798 void dispatchDetachedFromWindow() {
7799 //System.out.println("Detached! " + this);
7800 AttachInfo info = mAttachInfo;
7801 if (info != null) {
7802 int vis = info.mWindowVisibility;
7803 if (vis != GONE) {
7804 onWindowVisibilityChanged(GONE);
7805 }
7806 }
7807
7808 onDetachedFromWindow();
7809 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
7810 mAttachInfo.mScrollContainers.remove(this);
7811 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
7812 }
7813 mAttachInfo = null;
7814 }
7815
7816 /**
7817 * Store this view hierarchy's frozen state into the given container.
7818 *
7819 * @param container The SparseArray in which to save the view's state.
7820 *
7821 * @see #restoreHierarchyState
7822 * @see #dispatchSaveInstanceState
7823 * @see #onSaveInstanceState
7824 */
7825 public void saveHierarchyState(SparseArray<Parcelable> container) {
7826 dispatchSaveInstanceState(container);
7827 }
7828
7829 /**
7830 * Called by {@link #saveHierarchyState} to store the state for this view and its children.
7831 * May be overridden to modify how freezing happens to a view's children; for example, some
7832 * views may want to not store state for their children.
7833 *
7834 * @param container The SparseArray in which to save the view's state.
7835 *
7836 * @see #dispatchRestoreInstanceState
7837 * @see #saveHierarchyState
7838 * @see #onSaveInstanceState
7839 */
7840 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
7841 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
7842 mPrivateFlags &= ~SAVE_STATE_CALLED;
7843 Parcelable state = onSaveInstanceState();
7844 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
7845 throw new IllegalStateException(
7846 "Derived class did not call super.onSaveInstanceState()");
7847 }
7848 if (state != null) {
7849 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
7850 // + ": " + state);
7851 container.put(mID, state);
7852 }
7853 }
7854 }
7855
7856 /**
7857 * Hook allowing a view to generate a representation of its internal state
7858 * that can later be used to create a new instance with that same state.
7859 * This state should only contain information that is not persistent or can
7860 * not be reconstructed later. For example, you will never store your
7861 * current position on screen because that will be computed again when a
7862 * new instance of the view is placed in its view hierarchy.
7863 * <p>
7864 * Some examples of things you may store here: the current cursor position
7865 * in a text view (but usually not the text itself since that is stored in a
7866 * content provider or other persistent storage), the currently selected
7867 * item in a list view.
7868 *
7869 * @return Returns a Parcelable object containing the view's current dynamic
7870 * state, or null if there is nothing interesting to save. The
7871 * default implementation returns null.
7872 * @see #onRestoreInstanceState
7873 * @see #saveHierarchyState
7874 * @see #dispatchSaveInstanceState
7875 * @see #setSaveEnabled(boolean)
7876 */
7877 protected Parcelable onSaveInstanceState() {
7878 mPrivateFlags |= SAVE_STATE_CALLED;
7879 return BaseSavedState.EMPTY_STATE;
7880 }
7881
7882 /**
7883 * Restore this view hierarchy's frozen state from the given container.
7884 *
7885 * @param container The SparseArray which holds previously frozen states.
7886 *
7887 * @see #saveHierarchyState
7888 * @see #dispatchRestoreInstanceState
7889 * @see #onRestoreInstanceState
7890 */
7891 public void restoreHierarchyState(SparseArray<Parcelable> container) {
7892 dispatchRestoreInstanceState(container);
7893 }
7894
7895 /**
7896 * Called by {@link #restoreHierarchyState} to retrieve the state for this view and its
7897 * children. May be overridden to modify how restoreing happens to a view's children; for
7898 * example, some views may want to not store state for their children.
7899 *
7900 * @param container The SparseArray which holds previously saved state.
7901 *
7902 * @see #dispatchSaveInstanceState
7903 * @see #restoreHierarchyState
7904 * @see #onRestoreInstanceState
7905 */
7906 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
7907 if (mID != NO_ID) {
7908 Parcelable state = container.get(mID);
7909 if (state != null) {
7910 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
7911 // + ": " + state);
7912 mPrivateFlags &= ~SAVE_STATE_CALLED;
7913 onRestoreInstanceState(state);
7914 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
7915 throw new IllegalStateException(
7916 "Derived class did not call super.onRestoreInstanceState()");
7917 }
7918 }
7919 }
7920 }
7921
7922 /**
7923 * Hook allowing a view to re-apply a representation of its internal state that had previously
7924 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
7925 * null state.
7926 *
7927 * @param state The frozen state that had previously been returned by
7928 * {@link #onSaveInstanceState}.
7929 *
7930 * @see #onSaveInstanceState
7931 * @see #restoreHierarchyState
7932 * @see #dispatchRestoreInstanceState
7933 */
7934 protected void onRestoreInstanceState(Parcelable state) {
7935 mPrivateFlags |= SAVE_STATE_CALLED;
7936 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -08007937 throw new IllegalArgumentException("Wrong state class, expecting View State but "
7938 + "received " + state.getClass().toString() + " instead. This usually happens "
7939 + "when two views of different type have the same id in the same hierarchy. "
7940 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
7941 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007942 }
7943 }
7944
7945 /**
7946 * <p>Return the time at which the drawing of the view hierarchy started.</p>
7947 *
7948 * @return the drawing start time in milliseconds
7949 */
7950 public long getDrawingTime() {
7951 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
7952 }
7953
7954 /**
7955 * <p>Enables or disables the duplication of the parent's state into this view. When
7956 * duplication is enabled, this view gets its drawable state from its parent rather
7957 * than from its own internal properties.</p>
7958 *
7959 * <p>Note: in the current implementation, setting this property to true after the
7960 * view was added to a ViewGroup might have no effect at all. This property should
7961 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
7962 *
7963 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
7964 * property is enabled, an exception will be thrown.</p>
Gilles Debunnefb817032011-01-13 13:52:49 -08007965 *
7966 * <p>Note: if the child view uses and updates additionnal states which are unknown to the
7967 * parent, these states should not be affected by this method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007968 *
7969 * @param enabled True to enable duplication of the parent's drawable state, false
7970 * to disable it.
7971 *
7972 * @see #getDrawableState()
7973 * @see #isDuplicateParentStateEnabled()
7974 */
7975 public void setDuplicateParentStateEnabled(boolean enabled) {
7976 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
7977 }
7978
7979 /**
7980 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
7981 *
7982 * @return True if this view's drawable state is duplicated from the parent,
7983 * false otherwise
7984 *
7985 * @see #getDrawableState()
7986 * @see #setDuplicateParentStateEnabled(boolean)
7987 */
7988 public boolean isDuplicateParentStateEnabled() {
7989 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
7990 }
7991
7992 /**
Romain Guy171c5922011-01-06 10:04:23 -08007993 * <p>Specifies the type of layer backing this view. The layer can be
7994 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
7995 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
7996 *
7997 * <p>A layer is associated with an optional {@link android.graphics.Paint}
7998 * instance that controls how the layer is composed on screen. The following
7999 * properties of the paint are taken into account when composing the layer:</p>
8000 * <ul>
8001 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
8002 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
8003 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
8004 * </ul>
8005 *
8006 * <p>If this view has an alpha value set to < 1.0 by calling
8007 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
8008 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
8009 * equivalent to setting a hardware layer on this view and providing a paint with
8010 * the desired alpha value.<p>
8011 *
8012 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
8013 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
8014 * for more information on when and how to use layers.</p>
8015 *
8016 * @param layerType The ype of layer to use with this view, must be one of
8017 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
8018 * {@link #LAYER_TYPE_HARDWARE}
8019 * @param paint The paint used to compose the layer. This argument is optional
8020 * and can be null. It is ignored when the layer type is
8021 * {@link #LAYER_TYPE_NONE}
8022 *
8023 * @see #getLayerType()
8024 * @see #LAYER_TYPE_NONE
8025 * @see #LAYER_TYPE_SOFTWARE
8026 * @see #LAYER_TYPE_HARDWARE
8027 * @see #setAlpha(float)
8028 *
8029 * @attr ref android.R.styleable#View_layerType
8030 */
8031 public void setLayerType(int layerType, Paint paint) {
8032 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
8033 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
8034 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
8035 }
Chet Haasedaf98e92011-01-10 14:10:36 -08008036
Romain Guyd6cd5722011-01-17 14:42:41 -08008037 if (layerType == mLayerType) {
8038 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) {
8039 mLayerPaint = paint == null ? new Paint() : paint;
Romain Guy0fd89bf2011-01-26 15:41:30 -08008040 invalidateParentCaches();
8041 invalidate(true);
Romain Guyd6cd5722011-01-17 14:42:41 -08008042 }
8043 return;
8044 }
Romain Guy171c5922011-01-06 10:04:23 -08008045
8046 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -08008047 switch (mLayerType) {
8048 case LAYER_TYPE_SOFTWARE:
8049 if (mDrawingCache != null) {
8050 mDrawingCache.recycle();
8051 mDrawingCache = null;
8052 }
8053
8054 if (mUnscaledDrawingCache != null) {
8055 mUnscaledDrawingCache.recycle();
8056 mUnscaledDrawingCache = null;
8057 }
8058 break;
8059 case LAYER_TYPE_HARDWARE:
8060 if (mHardwareLayer != null) {
8061 mHardwareLayer.destroy();
8062 mHardwareLayer = null;
8063 }
8064 break;
8065 default:
8066 break;
Romain Guy171c5922011-01-06 10:04:23 -08008067 }
8068
8069 mLayerType = layerType;
Romain Guyd6cd5722011-01-17 14:42:41 -08008070 mLayerPaint = mLayerType == LAYER_TYPE_NONE ? null : (paint == null ? new Paint() : paint);
Romain Guy171c5922011-01-06 10:04:23 -08008071
Romain Guy0fd89bf2011-01-26 15:41:30 -08008072 invalidateParentCaches();
8073 invalidate(true);
Romain Guy171c5922011-01-06 10:04:23 -08008074 }
8075
8076 /**
8077 * Indicates what type of layer is currently associated with this view. By default
8078 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
8079 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
8080 * for more information on the different types of layers.
8081 *
8082 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
8083 * {@link #LAYER_TYPE_HARDWARE}
8084 *
8085 * @see #setLayerType(int, android.graphics.Paint)
8086 * @see #LAYER_TYPE_NONE
8087 * @see #LAYER_TYPE_SOFTWARE
8088 * @see #LAYER_TYPE_HARDWARE
8089 */
8090 public int getLayerType() {
8091 return mLayerType;
8092 }
Romain Guy6c319ca2011-01-11 14:29:25 -08008093
8094 /**
8095 * <p>Returns a hardware layer that can be used to draw this view again
8096 * without executing its draw method.</p>
8097 *
8098 * @return A HardwareLayer ready to render, or null if an error occurred.
8099 */
Romain Guy5e7f7662011-01-24 22:35:56 -08008100 HardwareLayer getHardwareLayer() {
Romain Guy6c319ca2011-01-11 14:29:25 -08008101 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) {
8102 return null;
8103 }
8104
8105 final int width = mRight - mLeft;
8106 final int height = mBottom - mTop;
8107
8108 if (width == 0 || height == 0) {
8109 return null;
8110 }
8111
8112 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
8113 if (mHardwareLayer == null) {
8114 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
8115 width, height, isOpaque());
8116 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
8117 mHardwareLayer.resize(width, height);
8118 }
8119
Romain Guy5e7f7662011-01-24 22:35:56 -08008120 Canvas currentCanvas = mAttachInfo.mHardwareCanvas;
8121 final HardwareCanvas canvas = mHardwareLayer.start(currentCanvas);
8122 mAttachInfo.mHardwareCanvas = canvas;
Romain Guy6c319ca2011-01-11 14:29:25 -08008123 try {
8124 canvas.setViewport(width, height);
Romain Guy7d7b5492011-01-24 16:33:45 -08008125 // TODO: We should pass the dirty rect
8126 canvas.onPreDraw(null);
Romain Guy6c319ca2011-01-11 14:29:25 -08008127
8128 computeScroll();
8129 canvas.translate(-mScrollX, -mScrollY);
8130
8131 final int restoreCount = canvas.save();
8132
8133 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
8134
8135 // Fast path for layouts with no backgrounds
8136 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8137 mPrivateFlags &= ~DIRTY_MASK;
8138 dispatchDraw(canvas);
8139 } else {
8140 draw(canvas);
8141 }
8142
8143 canvas.restoreToCount(restoreCount);
8144 } finally {
8145 canvas.onPostDraw();
Romain Guy5e7f7662011-01-24 22:35:56 -08008146 mHardwareLayer.end(currentCanvas);
8147 mAttachInfo.mHardwareCanvas = currentCanvas;
Romain Guy6c319ca2011-01-11 14:29:25 -08008148 }
8149 }
8150
8151 return mHardwareLayer;
8152 }
Romain Guy171c5922011-01-06 10:04:23 -08008153
8154 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008155 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
8156 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
8157 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
8158 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
8159 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
8160 * null.</p>
Romain Guy171c5922011-01-06 10:04:23 -08008161 *
8162 * <p>Enabling the drawing cache is similar to
8163 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
Chet Haasedaf98e92011-01-10 14:10:36 -08008164 * acceleration is turned off. When hardware acceleration is turned on, enabling the
8165 * drawing cache has no effect on rendering because the system uses a different mechanism
8166 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even
8167 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)}
8168 * for information on how to enable software and hardware layers.</p>
8169 *
8170 * <p>This API can be used to manually generate
8171 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling
8172 * {@link #getDrawingCache()}.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008173 *
8174 * @param enabled true to enable the drawing cache, false otherwise
8175 *
8176 * @see #isDrawingCacheEnabled()
8177 * @see #getDrawingCache()
8178 * @see #buildDrawingCache()
Romain Guy171c5922011-01-06 10:04:23 -08008179 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008180 */
8181 public void setDrawingCacheEnabled(boolean enabled) {
8182 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
8183 }
8184
8185 /**
8186 * <p>Indicates whether the drawing cache is enabled for this view.</p>
8187 *
8188 * @return true if the drawing cache is enabled
8189 *
8190 * @see #setDrawingCacheEnabled(boolean)
8191 * @see #getDrawingCache()
8192 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008193 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008194 public boolean isDrawingCacheEnabled() {
8195 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
8196 }
8197
8198 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08008199 * Debugging utility which recursively outputs the dirty state of a view and its
8200 * descendants.
8201 *
8202 * @hide
8203 */
8204 public void outputDirtyFlags(String indent, boolean clear, int clearMask) {
8205 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) +
8206 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" +
8207 (mPrivateFlags & View.DRAWING_CACHE_VALID) +
8208 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")");
8209 if (clear) {
8210 mPrivateFlags &= clearMask;
8211 }
8212 if (this instanceof ViewGroup) {
8213 ViewGroup parent = (ViewGroup) this;
8214 final int count = parent.getChildCount();
8215 for (int i = 0; i < count; i++) {
Romain Guy7d7b5492011-01-24 16:33:45 -08008216 final View child = parent.getChildAt(i);
Chet Haasedaf98e92011-01-10 14:10:36 -08008217 child.outputDirtyFlags(indent + " ", clear, clearMask);
8218 }
8219 }
8220 }
8221
8222 /**
8223 * This method is used by ViewGroup to cause its children to restore or recreate their
8224 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need
8225 * to recreate its own display list, which would happen if it went through the normal
8226 * draw/dispatchDraw mechanisms.
8227 *
8228 * @hide
8229 */
8230 protected void dispatchGetDisplayList() {}
8231
8232 /**
Romain Guyb051e892010-09-28 19:09:36 -07008233 * <p>Returns a display list that can be used to draw this view again
8234 * without executing its draw method.</p>
8235 *
8236 * @return A DisplayList ready to replay, or null if caching is not enabled.
Chet Haasedaf98e92011-01-10 14:10:36 -08008237 *
8238 * @hide
Romain Guyb051e892010-09-28 19:09:36 -07008239 */
Chet Haasedaf98e92011-01-10 14:10:36 -08008240 public DisplayList getDisplayList() {
Romain Guyb051e892010-09-28 19:09:36 -07008241 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) {
8242 return null;
8243 }
8244
Chet Haasedaf98e92011-01-10 14:10:36 -08008245 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 ||
8246 mDisplayList == null || !mDisplayList.isValid() ||
8247 mRecreateDisplayList)) {
8248 // Don't need to recreate the display list, just need to tell our
8249 // children to restore/recreate theirs
8250 if (mDisplayList != null && mDisplayList.isValid() &&
8251 !mRecreateDisplayList) {
8252 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
8253 mPrivateFlags &= ~DIRTY_MASK;
8254 dispatchGetDisplayList();
8255
8256 return mDisplayList;
8257 }
8258
8259 // If we got here, we're recreating it. Mark it as such to ensure that
8260 // we copy in child display lists into ours in drawChild()
8261 mRecreateDisplayList = true;
Romain Guyb051e892010-09-28 19:09:36 -07008262
Chet Haase9e90a992011-01-04 16:23:21 -08008263 if (mDisplayList == null) {
Chet Haasedaf98e92011-01-10 14:10:36 -08008264 mDisplayList = mAttachInfo.mHardwareRenderer.createDisplayList(this);
8265 // If we're creating a new display list, make sure our parent gets invalidated
8266 // since they will need to recreate their display list to account for this
8267 // new child display list.
Romain Guy0fd89bf2011-01-26 15:41:30 -08008268 invalidateParentCaches();
Chet Haase9e90a992011-01-04 16:23:21 -08008269 }
Romain Guyb051e892010-09-28 19:09:36 -07008270
8271 final HardwareCanvas canvas = mDisplayList.start();
8272 try {
8273 int width = mRight - mLeft;
8274 int height = mBottom - mTop;
8275
8276 canvas.setViewport(width, height);
Romain Guy7d7b5492011-01-24 16:33:45 -08008277 // The dirty rect should always be null for a display list
8278 canvas.onPreDraw(null);
Romain Guyb051e892010-09-28 19:09:36 -07008279
8280 final int restoreCount = canvas.save();
8281
Chet Haasedaf98e92011-01-10 14:10:36 -08008282 computeScroll();
8283 canvas.translate(-mScrollX, -mScrollY);
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008284 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
Romain Guyb051e892010-09-28 19:09:36 -07008285
8286 // Fast path for layouts with no backgrounds
8287 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8288 mPrivateFlags &= ~DIRTY_MASK;
8289 dispatchDraw(canvas);
8290 } else {
8291 draw(canvas);
8292 }
8293
8294 canvas.restoreToCount(restoreCount);
8295 } finally {
8296 canvas.onPostDraw();
8297
8298 mDisplayList.end();
Romain Guyb051e892010-09-28 19:09:36 -07008299 }
8300 }
8301
8302 return mDisplayList;
8303 }
8304
8305 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07008306 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
8307 *
8308 * @return A non-scaled bitmap representing this view or null if cache is disabled.
8309 *
8310 * @see #getDrawingCache(boolean)
8311 */
8312 public Bitmap getDrawingCache() {
8313 return getDrawingCache(false);
8314 }
8315
8316 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008317 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
8318 * is null when caching is disabled. If caching is enabled and the cache is not ready,
8319 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
8320 * draw from the cache when the cache is enabled. To benefit from the cache, you must
8321 * request the drawing cache by calling this method and draw it on screen if the
8322 * returned bitmap is not null.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07008323 *
8324 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
8325 * this method will create a bitmap of the same size as this view. Because this bitmap
8326 * will be drawn scaled by the parent ViewGroup, the result on screen might show
8327 * scaling artifacts. To avoid such artifacts, you should call this method by setting
8328 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
8329 * size than the view. This implies that your application must be able to handle this
8330 * size.</p>
8331 *
8332 * @param autoScale Indicates whether the generated bitmap should be scaled based on
8333 * the current density of the screen when the application is in compatibility
8334 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008335 *
Romain Guyfbd8f692009-06-26 14:51:58 -07008336 * @return A bitmap representing this view or null if cache is disabled.
8337 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008338 * @see #setDrawingCacheEnabled(boolean)
8339 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -07008340 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008341 * @see #destroyDrawingCache()
8342 */
Romain Guyfbd8f692009-06-26 14:51:58 -07008343 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008344 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
8345 return null;
8346 }
8347 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008348 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008349 }
Romain Guy02890fd2010-08-06 17:58:44 -07008350 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008351 }
8352
8353 /**
8354 * <p>Frees the resources used by the drawing cache. If you call
8355 * {@link #buildDrawingCache()} manually without calling
8356 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
8357 * should cleanup the cache with this method afterwards.</p>
8358 *
8359 * @see #setDrawingCacheEnabled(boolean)
8360 * @see #buildDrawingCache()
8361 * @see #getDrawingCache()
8362 */
8363 public void destroyDrawingCache() {
8364 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07008365 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008366 mDrawingCache = null;
8367 }
Romain Guyfbd8f692009-06-26 14:51:58 -07008368 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07008369 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -07008370 mUnscaledDrawingCache = null;
8371 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008372 }
8373
8374 /**
8375 * Setting a solid background color for the drawing cache's bitmaps will improve
8376 * perfromance and memory usage. Note, though that this should only be used if this
8377 * view will always be drawn on top of a solid color.
8378 *
8379 * @param color The background color to use for the drawing cache's bitmap
8380 *
8381 * @see #setDrawingCacheEnabled(boolean)
8382 * @see #buildDrawingCache()
8383 * @see #getDrawingCache()
8384 */
8385 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -08008386 if (color != mDrawingCacheBackgroundColor) {
8387 mDrawingCacheBackgroundColor = color;
8388 mPrivateFlags &= ~DRAWING_CACHE_VALID;
8389 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008390 }
8391
8392 /**
8393 * @see #setDrawingCacheBackgroundColor(int)
8394 *
8395 * @return The background color to used for the drawing cache's bitmap
8396 */
8397 public int getDrawingCacheBackgroundColor() {
8398 return mDrawingCacheBackgroundColor;
8399 }
8400
8401 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07008402 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
8403 *
8404 * @see #buildDrawingCache(boolean)
8405 */
8406 public void buildDrawingCache() {
8407 buildDrawingCache(false);
8408 }
8409
8410 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008411 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
8412 *
8413 * <p>If you call {@link #buildDrawingCache()} manually without calling
8414 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
8415 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07008416 *
8417 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
8418 * this method will create a bitmap of the same size as this view. Because this bitmap
8419 * will be drawn scaled by the parent ViewGroup, the result on screen might show
8420 * scaling artifacts. To avoid such artifacts, you should call this method by setting
8421 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
8422 * size than the view. This implies that your application must be able to handle this
8423 * size.</p>
Romain Guy0d9275e2010-10-26 14:22:30 -07008424 *
8425 * <p>You should avoid calling this method when hardware acceleration is enabled. If
8426 * you do not need the drawing cache bitmap, calling this method will increase memory
8427 * usage and cause the view to be rendered in software once, thus negatively impacting
8428 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008429 *
8430 * @see #getDrawingCache()
8431 * @see #destroyDrawingCache()
8432 */
Romain Guyfbd8f692009-06-26 14:51:58 -07008433 public void buildDrawingCache(boolean autoScale) {
8434 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -07008435 mDrawingCache == null : mUnscaledDrawingCache == null)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008436
8437 if (ViewDebug.TRACE_HIERARCHY) {
8438 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
8439 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008440
Romain Guy8506ab42009-06-11 17:35:47 -07008441 int width = mRight - mLeft;
8442 int height = mBottom - mTop;
8443
8444 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -07008445 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -07008446
Romain Guye1123222009-06-29 14:24:56 -07008447 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008448 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
8449 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -07008450 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008451
8452 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -07008453 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -08008454 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008455
8456 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -07008457 // Projected bitmap size in bytes
Adam Powell26153a32010-11-08 15:22:27 -08008458 (width * height * (opaque && !use32BitCache ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008459 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
8460 destroyDrawingCache();
8461 return;
8462 }
8463
8464 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -07008465 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008466
8467 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008468 Bitmap.Config quality;
8469 if (!opaque) {
8470 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
8471 case DRAWING_CACHE_QUALITY_AUTO:
8472 quality = Bitmap.Config.ARGB_8888;
8473 break;
8474 case DRAWING_CACHE_QUALITY_LOW:
8475 quality = Bitmap.Config.ARGB_4444;
8476 break;
8477 case DRAWING_CACHE_QUALITY_HIGH:
8478 quality = Bitmap.Config.ARGB_8888;
8479 break;
8480 default:
8481 quality = Bitmap.Config.ARGB_8888;
8482 break;
8483 }
8484 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -07008485 // Optimization for translucent windows
8486 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -08008487 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008488 }
8489
8490 // Try to cleanup memory
8491 if (bitmap != null) bitmap.recycle();
8492
8493 try {
8494 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -07008495 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -07008496 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -07008497 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07008498 } else {
Romain Guy02890fd2010-08-06 17:58:44 -07008499 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07008500 }
Adam Powell26153a32010-11-08 15:22:27 -08008501 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008502 } catch (OutOfMemoryError e) {
8503 // If there is not enough memory to create the bitmap cache, just
8504 // ignore the issue as bitmap caches are not required to draw the
8505 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -07008506 if (autoScale) {
8507 mDrawingCache = null;
8508 } else {
8509 mUnscaledDrawingCache = null;
8510 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008511 return;
8512 }
8513
8514 clear = drawingCacheBackgroundColor != 0;
8515 }
8516
8517 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008518 if (attachInfo != null) {
8519 canvas = attachInfo.mCanvas;
8520 if (canvas == null) {
8521 canvas = new Canvas();
8522 }
8523 canvas.setBitmap(bitmap);
8524 // Temporarily clobber the cached Canvas in case one of our children
8525 // is also using a drawing cache. Without this, the children would
8526 // steal the canvas by attaching their own bitmap to it and bad, bad
8527 // thing would happen (invisible views, corrupted drawings, etc.)
8528 attachInfo.mCanvas = null;
8529 } else {
8530 // This case should hopefully never or seldom happen
8531 canvas = new Canvas(bitmap);
8532 }
8533
8534 if (clear) {
8535 bitmap.eraseColor(drawingCacheBackgroundColor);
8536 }
8537
8538 computeScroll();
8539 final int restoreCount = canvas.save();
Romain Guyfbd8f692009-06-26 14:51:58 -07008540
Romain Guye1123222009-06-29 14:24:56 -07008541 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008542 final float scale = attachInfo.mApplicationScale;
8543 canvas.scale(scale, scale);
8544 }
8545
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008546 canvas.translate(-mScrollX, -mScrollY);
8547
Romain Guy5bcdff42009-05-14 21:27:18 -07008548 mPrivateFlags |= DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -08008549 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
8550 mLayerType != LAYER_TYPE_NONE) {
Romain Guy0d9275e2010-10-26 14:22:30 -07008551 mPrivateFlags |= DRAWING_CACHE_VALID;
8552 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008553
8554 // Fast path for layouts with no backgrounds
8555 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8556 if (ViewDebug.TRACE_HIERARCHY) {
8557 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
8558 }
Romain Guy5bcdff42009-05-14 21:27:18 -07008559 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008560 dispatchDraw(canvas);
8561 } else {
8562 draw(canvas);
8563 }
8564
8565 canvas.restoreToCount(restoreCount);
8566
8567 if (attachInfo != null) {
8568 // Restore the cached Canvas for our siblings
8569 attachInfo.mCanvas = canvas;
8570 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008571 }
8572 }
8573
8574 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008575 * Create a snapshot of the view into a bitmap. We should probably make
8576 * some form of this public, but should think about the API.
8577 */
Romain Guy223ff5c2010-03-02 17:07:47 -08008578 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008579 int width = mRight - mLeft;
8580 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008581
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008582 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -07008583 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008584 width = (int) ((width * scale) + 0.5f);
8585 height = (int) ((height * scale) + 0.5f);
8586
Romain Guy8c11e312009-09-14 15:15:30 -07008587 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008588 if (bitmap == null) {
8589 throw new OutOfMemoryError();
8590 }
8591
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008592 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
8593
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008594 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008595 if (attachInfo != null) {
8596 canvas = attachInfo.mCanvas;
8597 if (canvas == null) {
8598 canvas = new Canvas();
8599 }
8600 canvas.setBitmap(bitmap);
8601 // Temporarily clobber the cached Canvas in case one of our children
8602 // is also using a drawing cache. Without this, the children would
8603 // steal the canvas by attaching their own bitmap to it and bad, bad
8604 // things would happen (invisible views, corrupted drawings, etc.)
8605 attachInfo.mCanvas = null;
8606 } else {
8607 // This case should hopefully never or seldom happen
8608 canvas = new Canvas(bitmap);
8609 }
8610
Romain Guy5bcdff42009-05-14 21:27:18 -07008611 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008612 bitmap.eraseColor(backgroundColor);
8613 }
8614
8615 computeScroll();
8616 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008617 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008618 canvas.translate(-mScrollX, -mScrollY);
8619
Romain Guy5bcdff42009-05-14 21:27:18 -07008620 // Temporarily remove the dirty mask
8621 int flags = mPrivateFlags;
8622 mPrivateFlags &= ~DIRTY_MASK;
8623
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008624 // Fast path for layouts with no backgrounds
8625 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8626 dispatchDraw(canvas);
8627 } else {
8628 draw(canvas);
8629 }
8630
Romain Guy5bcdff42009-05-14 21:27:18 -07008631 mPrivateFlags = flags;
8632
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008633 canvas.restoreToCount(restoreCount);
8634
8635 if (attachInfo != null) {
8636 // Restore the cached Canvas for our siblings
8637 attachInfo.mCanvas = canvas;
8638 }
Romain Guy8506ab42009-06-11 17:35:47 -07008639
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008640 return bitmap;
8641 }
8642
8643 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008644 * Indicates whether this View is currently in edit mode. A View is usually
8645 * in edit mode when displayed within a developer tool. For instance, if
8646 * this View is being drawn by a visual user interface builder, this method
8647 * should return true.
8648 *
8649 * Subclasses should check the return value of this method to provide
8650 * different behaviors if their normal behavior might interfere with the
8651 * host environment. For instance: the class spawns a thread in its
8652 * constructor, the drawing code relies on device-specific features, etc.
8653 *
8654 * This method is usually checked in the drawing code of custom widgets.
8655 *
8656 * @return True if this View is in edit mode, false otherwise.
8657 */
8658 public boolean isInEditMode() {
8659 return false;
8660 }
8661
8662 /**
8663 * If the View draws content inside its padding and enables fading edges,
8664 * it needs to support padding offsets. Padding offsets are added to the
8665 * fading edges to extend the length of the fade so that it covers pixels
8666 * drawn inside the padding.
8667 *
8668 * Subclasses of this class should override this method if they need
8669 * to draw content inside the padding.
8670 *
8671 * @return True if padding offset must be applied, false otherwise.
8672 *
8673 * @see #getLeftPaddingOffset()
8674 * @see #getRightPaddingOffset()
8675 * @see #getTopPaddingOffset()
8676 * @see #getBottomPaddingOffset()
8677 *
8678 * @since CURRENT
8679 */
8680 protected boolean isPaddingOffsetRequired() {
8681 return false;
8682 }
8683
8684 /**
8685 * Amount by which to extend the left fading region. Called only when
8686 * {@link #isPaddingOffsetRequired()} returns true.
8687 *
8688 * @return The left padding offset in pixels.
8689 *
8690 * @see #isPaddingOffsetRequired()
8691 *
8692 * @since CURRENT
8693 */
8694 protected int getLeftPaddingOffset() {
8695 return 0;
8696 }
8697
8698 /**
8699 * Amount by which to extend the right fading region. Called only when
8700 * {@link #isPaddingOffsetRequired()} returns true.
8701 *
8702 * @return The right padding offset in pixels.
8703 *
8704 * @see #isPaddingOffsetRequired()
8705 *
8706 * @since CURRENT
8707 */
8708 protected int getRightPaddingOffset() {
8709 return 0;
8710 }
8711
8712 /**
8713 * Amount by which to extend the top fading region. Called only when
8714 * {@link #isPaddingOffsetRequired()} returns true.
8715 *
8716 * @return The top padding offset in pixels.
8717 *
8718 * @see #isPaddingOffsetRequired()
8719 *
8720 * @since CURRENT
8721 */
8722 protected int getTopPaddingOffset() {
8723 return 0;
8724 }
8725
8726 /**
8727 * Amount by which to extend the bottom fading region. Called only when
8728 * {@link #isPaddingOffsetRequired()} returns true.
8729 *
8730 * @return The bottom padding offset in pixels.
8731 *
8732 * @see #isPaddingOffsetRequired()
8733 *
8734 * @since CURRENT
8735 */
8736 protected int getBottomPaddingOffset() {
8737 return 0;
8738 }
8739
8740 /**
Romain Guy2bffd262010-09-12 17:40:02 -07008741 * <p>Indicates whether this view is attached to an hardware accelerated
8742 * window or not.</p>
8743 *
8744 * <p>Even if this method returns true, it does not mean that every call
8745 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
8746 * accelerated {@link android.graphics.Canvas}. For instance, if this view
8747 * is drawn onto an offscren {@link android.graphics.Bitmap} and its
8748 * window is hardware accelerated,
8749 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
8750 * return false, and this method will return true.</p>
8751 *
8752 * @return True if the view is attached to a window and the window is
8753 * hardware accelerated; false in any other case.
8754 */
8755 public boolean isHardwareAccelerated() {
8756 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
8757 }
8758
8759 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008760 * Manually render this view (and all of its children) to the given Canvas.
8761 * The view must have already done a full layout before this function is
Chet Haasec75ec332010-12-17 07:44:30 -08008762 * called. When implementing a view, implement {@link #onDraw} instead of
8763 * overriding this method. If you do need to override this method, call
8764 * the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008765 *
8766 * @param canvas The Canvas to which the View is rendered.
8767 */
8768 public void draw(Canvas canvas) {
8769 if (ViewDebug.TRACE_HIERARCHY) {
8770 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
8771 }
8772
Romain Guy5bcdff42009-05-14 21:27:18 -07008773 final int privateFlags = mPrivateFlags;
8774 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
8775 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
8776 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -07008777
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008778 /*
8779 * Draw traversal performs several drawing steps which must be executed
8780 * in the appropriate order:
8781 *
8782 * 1. Draw the background
8783 * 2. If necessary, save the canvas' layers to prepare for fading
8784 * 3. Draw view's content
8785 * 4. Draw children
8786 * 5. If necessary, draw the fading edges and restore layers
8787 * 6. Draw decorations (scrollbars for instance)
8788 */
8789
8790 // Step 1, draw the background, if needed
8791 int saveCount;
8792
Romain Guy24443ea2009-05-11 11:56:30 -07008793 if (!dirtyOpaque) {
8794 final Drawable background = mBGDrawable;
8795 if (background != null) {
8796 final int scrollX = mScrollX;
8797 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008798
Romain Guy24443ea2009-05-11 11:56:30 -07008799 if (mBackgroundSizeChanged) {
8800 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
8801 mBackgroundSizeChanged = false;
8802 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008803
Romain Guy24443ea2009-05-11 11:56:30 -07008804 if ((scrollX | scrollY) == 0) {
8805 background.draw(canvas);
8806 } else {
8807 canvas.translate(scrollX, scrollY);
8808 background.draw(canvas);
8809 canvas.translate(-scrollX, -scrollY);
8810 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008811 }
8812 }
8813
8814 // skip step 2 & 5 if possible (common case)
8815 final int viewFlags = mViewFlags;
8816 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
8817 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
8818 if (!verticalEdges && !horizontalEdges) {
8819 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07008820 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008821
8822 // Step 4, draw the children
8823 dispatchDraw(canvas);
8824
8825 // Step 6, draw decorations (scrollbars)
8826 onDrawScrollBars(canvas);
8827
8828 // we're done...
8829 return;
8830 }
8831
8832 /*
8833 * Here we do the full fledged routine...
8834 * (this is an uncommon case where speed matters less,
8835 * this is why we repeat some of the tests that have been
8836 * done above)
8837 */
8838
8839 boolean drawTop = false;
8840 boolean drawBottom = false;
8841 boolean drawLeft = false;
8842 boolean drawRight = false;
8843
8844 float topFadeStrength = 0.0f;
8845 float bottomFadeStrength = 0.0f;
8846 float leftFadeStrength = 0.0f;
8847 float rightFadeStrength = 0.0f;
8848
8849 // Step 2, save the canvas' layers
8850 int paddingLeft = mPaddingLeft;
8851 int paddingTop = mPaddingTop;
8852
8853 final boolean offsetRequired = isPaddingOffsetRequired();
8854 if (offsetRequired) {
8855 paddingLeft += getLeftPaddingOffset();
8856 paddingTop += getTopPaddingOffset();
8857 }
8858
8859 int left = mScrollX + paddingLeft;
8860 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
8861 int top = mScrollY + paddingTop;
8862 int bottom = top + mBottom - mTop - mPaddingBottom - paddingTop;
8863
8864 if (offsetRequired) {
8865 right += getRightPaddingOffset();
8866 bottom += getBottomPaddingOffset();
8867 }
8868
8869 final ScrollabilityCache scrollabilityCache = mScrollCache;
8870 int length = scrollabilityCache.fadingEdgeLength;
8871
8872 // clip the fade length if top and bottom fades overlap
8873 // overlapping fades produce odd-looking artifacts
8874 if (verticalEdges && (top + length > bottom - length)) {
8875 length = (bottom - top) / 2;
8876 }
8877
8878 // also clip horizontal fades if necessary
8879 if (horizontalEdges && (left + length > right - length)) {
8880 length = (right - left) / 2;
8881 }
8882
8883 if (verticalEdges) {
8884 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008885 drawTop = topFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008886 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008887 drawBottom = bottomFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008888 }
8889
8890 if (horizontalEdges) {
8891 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008892 drawLeft = leftFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008893 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008894 drawRight = rightFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008895 }
8896
8897 saveCount = canvas.getSaveCount();
8898
8899 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -07008900 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008901 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
8902
8903 if (drawTop) {
8904 canvas.saveLayer(left, top, right, top + length, null, flags);
8905 }
8906
8907 if (drawBottom) {
8908 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
8909 }
8910
8911 if (drawLeft) {
8912 canvas.saveLayer(left, top, left + length, bottom, null, flags);
8913 }
8914
8915 if (drawRight) {
8916 canvas.saveLayer(right - length, top, right, bottom, null, flags);
8917 }
8918 } else {
8919 scrollabilityCache.setFadeColor(solidColor);
8920 }
8921
8922 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07008923 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008924
8925 // Step 4, draw the children
8926 dispatchDraw(canvas);
8927
8928 // Step 5, draw the fade effect and restore layers
8929 final Paint p = scrollabilityCache.paint;
8930 final Matrix matrix = scrollabilityCache.matrix;
8931 final Shader fade = scrollabilityCache.shader;
8932 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
8933
8934 if (drawTop) {
8935 matrix.setScale(1, fadeHeight * topFadeStrength);
8936 matrix.postTranslate(left, top);
8937 fade.setLocalMatrix(matrix);
8938 canvas.drawRect(left, top, right, top + length, p);
8939 }
8940
8941 if (drawBottom) {
8942 matrix.setScale(1, fadeHeight * bottomFadeStrength);
8943 matrix.postRotate(180);
8944 matrix.postTranslate(left, bottom);
8945 fade.setLocalMatrix(matrix);
8946 canvas.drawRect(left, bottom - length, right, bottom, p);
8947 }
8948
8949 if (drawLeft) {
8950 matrix.setScale(1, fadeHeight * leftFadeStrength);
8951 matrix.postRotate(-90);
8952 matrix.postTranslate(left, top);
8953 fade.setLocalMatrix(matrix);
8954 canvas.drawRect(left, top, left + length, bottom, p);
8955 }
8956
8957 if (drawRight) {
8958 matrix.setScale(1, fadeHeight * rightFadeStrength);
8959 matrix.postRotate(90);
8960 matrix.postTranslate(right, top);
8961 fade.setLocalMatrix(matrix);
8962 canvas.drawRect(right - length, top, right, bottom, p);
8963 }
8964
8965 canvas.restoreToCount(saveCount);
8966
8967 // Step 6, draw decorations (scrollbars)
8968 onDrawScrollBars(canvas);
8969 }
8970
8971 /**
8972 * Override this if your view is known to always be drawn on top of a solid color background,
8973 * and needs to draw fading edges. Returning a non-zero color enables the view system to
8974 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
8975 * should be set to 0xFF.
8976 *
8977 * @see #setVerticalFadingEdgeEnabled
8978 * @see #setHorizontalFadingEdgeEnabled
8979 *
8980 * @return The known solid color background for this view, or 0 if the color may vary
8981 */
8982 public int getSolidColor() {
8983 return 0;
8984 }
8985
8986 /**
8987 * Build a human readable string representation of the specified view flags.
8988 *
8989 * @param flags the view flags to convert to a string
8990 * @return a String representing the supplied flags
8991 */
8992 private static String printFlags(int flags) {
8993 String output = "";
8994 int numFlags = 0;
8995 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
8996 output += "TAKES_FOCUS";
8997 numFlags++;
8998 }
8999
9000 switch (flags & VISIBILITY_MASK) {
9001 case INVISIBLE:
9002 if (numFlags > 0) {
9003 output += " ";
9004 }
9005 output += "INVISIBLE";
9006 // USELESS HERE numFlags++;
9007 break;
9008 case GONE:
9009 if (numFlags > 0) {
9010 output += " ";
9011 }
9012 output += "GONE";
9013 // USELESS HERE numFlags++;
9014 break;
9015 default:
9016 break;
9017 }
9018 return output;
9019 }
9020
9021 /**
9022 * Build a human readable string representation of the specified private
9023 * view flags.
9024 *
9025 * @param privateFlags the private view flags to convert to a string
9026 * @return a String representing the supplied flags
9027 */
9028 private static String printPrivateFlags(int privateFlags) {
9029 String output = "";
9030 int numFlags = 0;
9031
9032 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
9033 output += "WANTS_FOCUS";
9034 numFlags++;
9035 }
9036
9037 if ((privateFlags & FOCUSED) == FOCUSED) {
9038 if (numFlags > 0) {
9039 output += " ";
9040 }
9041 output += "FOCUSED";
9042 numFlags++;
9043 }
9044
9045 if ((privateFlags & SELECTED) == SELECTED) {
9046 if (numFlags > 0) {
9047 output += " ";
9048 }
9049 output += "SELECTED";
9050 numFlags++;
9051 }
9052
9053 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
9054 if (numFlags > 0) {
9055 output += " ";
9056 }
9057 output += "IS_ROOT_NAMESPACE";
9058 numFlags++;
9059 }
9060
9061 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
9062 if (numFlags > 0) {
9063 output += " ";
9064 }
9065 output += "HAS_BOUNDS";
9066 numFlags++;
9067 }
9068
9069 if ((privateFlags & DRAWN) == DRAWN) {
9070 if (numFlags > 0) {
9071 output += " ";
9072 }
9073 output += "DRAWN";
9074 // USELESS HERE numFlags++;
9075 }
9076 return output;
9077 }
9078
9079 /**
9080 * <p>Indicates whether or not this view's layout will be requested during
9081 * the next hierarchy layout pass.</p>
9082 *
9083 * @return true if the layout will be forced during next layout pass
9084 */
9085 public boolean isLayoutRequested() {
9086 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
9087 }
9088
9089 /**
9090 * Assign a size and position to a view and all of its
9091 * descendants
9092 *
9093 * <p>This is the second phase of the layout mechanism.
9094 * (The first is measuring). In this phase, each parent calls
9095 * layout on all of its children to position them.
9096 * This is typically done using the child measurements
Chet Haase9c087442011-01-12 16:20:16 -08009097 * that were stored in the measure pass().</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009098 *
Chet Haase9c087442011-01-12 16:20:16 -08009099 * <p>Derived classes should not override this method.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009100 * Derived classes with children should override
9101 * onLayout. In that method, they should
Chet Haase9c087442011-01-12 16:20:16 -08009102 * call layout on each of their children.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009103 *
9104 * @param l Left position, relative to parent
9105 * @param t Top position, relative to parent
9106 * @param r Right position, relative to parent
9107 * @param b Bottom position, relative to parent
9108 */
Romain Guy5429e1d2010-09-07 12:38:00 -07009109 @SuppressWarnings({"unchecked"})
Chet Haase9c087442011-01-12 16:20:16 -08009110 public void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -07009111 int oldL = mLeft;
9112 int oldT = mTop;
9113 int oldB = mBottom;
9114 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009115 boolean changed = setFrame(l, t, r, b);
9116 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
9117 if (ViewDebug.TRACE_HIERARCHY) {
9118 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
9119 }
9120
9121 onLayout(changed, l, t, r, b);
9122 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -07009123
9124 if (mOnLayoutChangeListeners != null) {
9125 ArrayList<OnLayoutChangeListener> listenersCopy =
9126 (ArrayList<OnLayoutChangeListener>) mOnLayoutChangeListeners.clone();
9127 int numListeners = listenersCopy.size();
9128 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -07009129 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -07009130 }
9131 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009132 }
9133 mPrivateFlags &= ~FORCE_LAYOUT;
9134 }
9135
9136 /**
9137 * Called from layout when this view should
9138 * assign a size and position to each of its children.
9139 *
9140 * Derived classes with children should override
9141 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -07009142 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009143 * @param changed This is a new size or position for this view
9144 * @param left Left position, relative to parent
9145 * @param top Top position, relative to parent
9146 * @param right Right position, relative to parent
9147 * @param bottom Bottom position, relative to parent
9148 */
9149 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
9150 }
9151
9152 /**
9153 * Assign a size and position to this view.
9154 *
9155 * This is called from layout.
9156 *
9157 * @param left Left position, relative to parent
9158 * @param top Top position, relative to parent
9159 * @param right Right position, relative to parent
9160 * @param bottom Bottom position, relative to parent
9161 * @return true if the new size and position are different than the
9162 * previous ones
9163 * {@hide}
9164 */
9165 protected boolean setFrame(int left, int top, int right, int bottom) {
9166 boolean changed = false;
9167
9168 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -07009169 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009170 + right + "," + bottom + ")");
9171 }
9172
9173 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
9174 changed = true;
9175
9176 // Remember our drawn bit
9177 int drawn = mPrivateFlags & DRAWN;
9178
9179 // Invalidate our old position
Romain Guy0fd89bf2011-01-26 15:41:30 -08009180 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009181
9182
9183 int oldWidth = mRight - mLeft;
9184 int oldHeight = mBottom - mTop;
9185
9186 mLeft = left;
9187 mTop = top;
9188 mRight = right;
9189 mBottom = bottom;
9190
9191 mPrivateFlags |= HAS_BOUNDS;
9192
9193 int newWidth = right - left;
9194 int newHeight = bottom - top;
9195
9196 if (newWidth != oldWidth || newHeight != oldHeight) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009197 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9198 // A change in dimension means an auto-centered pivot point changes, too
9199 mMatrixDirty = true;
9200 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009201 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
9202 }
9203
9204 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
9205 // If we are visible, force the DRAWN bit to on so that
9206 // this invalidate will go through (at least to our parent).
9207 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009208 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009209 // the DRAWN bit.
9210 mPrivateFlags |= DRAWN;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009211 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009212 }
9213
9214 // Reset drawn bit to original value (invalidate turns it off)
9215 mPrivateFlags |= drawn;
9216
9217 mBackgroundSizeChanged = true;
9218 }
9219 return changed;
9220 }
9221
9222 /**
9223 * Finalize inflating a view from XML. This is called as the last phase
9224 * of inflation, after all child views have been added.
9225 *
9226 * <p>Even if the subclass overrides onFinishInflate, they should always be
9227 * sure to call the super method, so that we get called.
9228 */
9229 protected void onFinishInflate() {
9230 }
9231
9232 /**
9233 * Returns the resources associated with this view.
9234 *
9235 * @return Resources object.
9236 */
9237 public Resources getResources() {
9238 return mResources;
9239 }
9240
9241 /**
9242 * Invalidates the specified Drawable.
9243 *
9244 * @param drawable the drawable to invalidate
9245 */
9246 public void invalidateDrawable(Drawable drawable) {
9247 if (verifyDrawable(drawable)) {
9248 final Rect dirty = drawable.getBounds();
9249 final int scrollX = mScrollX;
9250 final int scrollY = mScrollY;
9251
9252 invalidate(dirty.left + scrollX, dirty.top + scrollY,
9253 dirty.right + scrollX, dirty.bottom + scrollY);
9254 }
9255 }
9256
9257 /**
9258 * Schedules an action on a drawable to occur at a specified time.
9259 *
9260 * @param who the recipient of the action
9261 * @param what the action to run on the drawable
9262 * @param when the time at which the action must occur. Uses the
9263 * {@link SystemClock#uptimeMillis} timebase.
9264 */
9265 public void scheduleDrawable(Drawable who, Runnable what, long when) {
9266 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
9267 mAttachInfo.mHandler.postAtTime(what, who, when);
9268 }
9269 }
9270
9271 /**
9272 * Cancels a scheduled action on a drawable.
9273 *
9274 * @param who the recipient of the action
9275 * @param what the action to cancel
9276 */
9277 public void unscheduleDrawable(Drawable who, Runnable what) {
9278 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
9279 mAttachInfo.mHandler.removeCallbacks(what, who);
9280 }
9281 }
9282
9283 /**
9284 * Unschedule any events associated with the given Drawable. This can be
9285 * used when selecting a new Drawable into a view, so that the previous
9286 * one is completely unscheduled.
9287 *
9288 * @param who The Drawable to unschedule.
9289 *
9290 * @see #drawableStateChanged
9291 */
9292 public void unscheduleDrawable(Drawable who) {
9293 if (mAttachInfo != null) {
9294 mAttachInfo.mHandler.removeCallbacksAndMessages(who);
9295 }
9296 }
9297
9298 /**
9299 * If your view subclass is displaying its own Drawable objects, it should
9300 * override this function and return true for any Drawable it is
9301 * displaying. This allows animations for those drawables to be
9302 * scheduled.
9303 *
9304 * <p>Be sure to call through to the super class when overriding this
9305 * function.
9306 *
9307 * @param who The Drawable to verify. Return true if it is one you are
9308 * displaying, else return the result of calling through to the
9309 * super class.
9310 *
9311 * @return boolean If true than the Drawable is being displayed in the
9312 * view; else false and it is not allowed to animate.
9313 *
9314 * @see #unscheduleDrawable
9315 * @see #drawableStateChanged
9316 */
9317 protected boolean verifyDrawable(Drawable who) {
9318 return who == mBGDrawable;
9319 }
9320
9321 /**
9322 * This function is called whenever the state of the view changes in such
9323 * a way that it impacts the state of drawables being shown.
9324 *
9325 * <p>Be sure to call through to the superclass when overriding this
9326 * function.
9327 *
9328 * @see Drawable#setState
9329 */
9330 protected void drawableStateChanged() {
9331 Drawable d = mBGDrawable;
9332 if (d != null && d.isStateful()) {
9333 d.setState(getDrawableState());
9334 }
9335 }
9336
9337 /**
9338 * Call this to force a view to update its drawable state. This will cause
9339 * drawableStateChanged to be called on this view. Views that are interested
9340 * in the new state should call getDrawableState.
9341 *
9342 * @see #drawableStateChanged
9343 * @see #getDrawableState
9344 */
9345 public void refreshDrawableState() {
9346 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
9347 drawableStateChanged();
9348
9349 ViewParent parent = mParent;
9350 if (parent != null) {
9351 parent.childDrawableStateChanged(this);
9352 }
9353 }
9354
9355 /**
9356 * Return an array of resource IDs of the drawable states representing the
9357 * current state of the view.
9358 *
9359 * @return The current drawable state
9360 *
9361 * @see Drawable#setState
9362 * @see #drawableStateChanged
9363 * @see #onCreateDrawableState
9364 */
9365 public final int[] getDrawableState() {
9366 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
9367 return mDrawableState;
9368 } else {
9369 mDrawableState = onCreateDrawableState(0);
9370 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
9371 return mDrawableState;
9372 }
9373 }
9374
9375 /**
9376 * Generate the new {@link android.graphics.drawable.Drawable} state for
9377 * this view. This is called by the view
9378 * system when the cached Drawable state is determined to be invalid. To
9379 * retrieve the current state, you should use {@link #getDrawableState}.
9380 *
9381 * @param extraSpace if non-zero, this is the number of extra entries you
9382 * would like in the returned array in which you can place your own
9383 * states.
9384 *
9385 * @return Returns an array holding the current {@link Drawable} state of
9386 * the view.
9387 *
9388 * @see #mergeDrawableStates
9389 */
9390 protected int[] onCreateDrawableState(int extraSpace) {
9391 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
9392 mParent instanceof View) {
9393 return ((View) mParent).onCreateDrawableState(extraSpace);
9394 }
9395
9396 int[] drawableState;
9397
9398 int privateFlags = mPrivateFlags;
9399
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009400 int viewStateIndex = 0;
9401 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
9402 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
9403 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -07009404 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009405 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
9406 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08009407 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested) {
9408 // This is set if HW acceleration is requested, even if the current
9409 // process doesn't allow it. This is just to allow app preview
9410 // windows to better match their app.
9411 viewStateIndex |= VIEW_STATE_ACCELERATED;
9412 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009413
9414 drawableState = VIEW_STATE_SETS[viewStateIndex];
9415
9416 //noinspection ConstantIfStatement
9417 if (false) {
9418 Log.i("View", "drawableStateIndex=" + viewStateIndex);
9419 Log.i("View", toString()
9420 + " pressed=" + ((privateFlags & PRESSED) != 0)
9421 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
9422 + " fo=" + hasFocus()
9423 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009424 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009425 + ": " + Arrays.toString(drawableState));
9426 }
9427
9428 if (extraSpace == 0) {
9429 return drawableState;
9430 }
9431
9432 final int[] fullState;
9433 if (drawableState != null) {
9434 fullState = new int[drawableState.length + extraSpace];
9435 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
9436 } else {
9437 fullState = new int[extraSpace];
9438 }
9439
9440 return fullState;
9441 }
9442
9443 /**
9444 * Merge your own state values in <var>additionalState</var> into the base
9445 * state values <var>baseState</var> that were returned by
9446 * {@link #onCreateDrawableState}.
9447 *
9448 * @param baseState The base state values returned by
9449 * {@link #onCreateDrawableState}, which will be modified to also hold your
9450 * own additional state values.
9451 *
9452 * @param additionalState The additional state values you would like
9453 * added to <var>baseState</var>; this array is not modified.
9454 *
9455 * @return As a convenience, the <var>baseState</var> array you originally
9456 * passed into the function is returned.
9457 *
9458 * @see #onCreateDrawableState
9459 */
9460 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
9461 final int N = baseState.length;
9462 int i = N - 1;
9463 while (i >= 0 && baseState[i] == 0) {
9464 i--;
9465 }
9466 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
9467 return baseState;
9468 }
9469
9470 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -07009471 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
9472 * on all Drawable objects associated with this view.
9473 */
9474 public void jumpDrawablesToCurrentState() {
9475 if (mBGDrawable != null) {
9476 mBGDrawable.jumpToCurrentState();
9477 }
9478 }
9479
9480 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009481 * Sets the background color for this view.
9482 * @param color the color of the background
9483 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00009484 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009485 public void setBackgroundColor(int color) {
Chet Haase70d4ba12010-10-06 09:46:45 -07009486 if (mBGDrawable instanceof ColorDrawable) {
9487 ((ColorDrawable) mBGDrawable).setColor(color);
9488 } else {
9489 setBackgroundDrawable(new ColorDrawable(color));
9490 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009491 }
9492
9493 /**
9494 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -07009495 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009496 * @param resid The identifier of the resource.
9497 * @attr ref android.R.styleable#View_background
9498 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00009499 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009500 public void setBackgroundResource(int resid) {
9501 if (resid != 0 && resid == mBackgroundResource) {
9502 return;
9503 }
9504
9505 Drawable d= null;
9506 if (resid != 0) {
9507 d = mResources.getDrawable(resid);
9508 }
9509 setBackgroundDrawable(d);
9510
9511 mBackgroundResource = resid;
9512 }
9513
9514 /**
9515 * Set the background to a given Drawable, or remove the background. If the
9516 * background has padding, this View's padding is set to the background's
9517 * padding. However, when a background is removed, this View's padding isn't
9518 * touched. If setting the padding is desired, please use
9519 * {@link #setPadding(int, int, int, int)}.
9520 *
9521 * @param d The Drawable to use as the background, or null to remove the
9522 * background
9523 */
9524 public void setBackgroundDrawable(Drawable d) {
9525 boolean requestLayout = false;
9526
9527 mBackgroundResource = 0;
9528
9529 /*
9530 * Regardless of whether we're setting a new background or not, we want
9531 * to clear the previous drawable.
9532 */
9533 if (mBGDrawable != null) {
9534 mBGDrawable.setCallback(null);
9535 unscheduleDrawable(mBGDrawable);
9536 }
9537
9538 if (d != null) {
9539 Rect padding = sThreadLocal.get();
9540 if (padding == null) {
9541 padding = new Rect();
9542 sThreadLocal.set(padding);
9543 }
9544 if (d.getPadding(padding)) {
9545 setPadding(padding.left, padding.top, padding.right, padding.bottom);
9546 }
9547
9548 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
9549 // if it has a different minimum size, we should layout again
9550 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() ||
9551 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) {
9552 requestLayout = true;
9553 }
9554
9555 d.setCallback(this);
9556 if (d.isStateful()) {
9557 d.setState(getDrawableState());
9558 }
9559 d.setVisible(getVisibility() == VISIBLE, false);
9560 mBGDrawable = d;
9561
9562 if ((mPrivateFlags & SKIP_DRAW) != 0) {
9563 mPrivateFlags &= ~SKIP_DRAW;
9564 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
9565 requestLayout = true;
9566 }
9567 } else {
9568 /* Remove the background */
9569 mBGDrawable = null;
9570
9571 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
9572 /*
9573 * This view ONLY drew the background before and we're removing
9574 * the background, so now it won't draw anything
9575 * (hence we SKIP_DRAW)
9576 */
9577 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
9578 mPrivateFlags |= SKIP_DRAW;
9579 }
9580
9581 /*
9582 * When the background is set, we try to apply its padding to this
9583 * View. When the background is removed, we don't touch this View's
9584 * padding. This is noted in the Javadocs. Hence, we don't need to
9585 * requestLayout(), the invalidate() below is sufficient.
9586 */
9587
9588 // The old background's minimum size could have affected this
9589 // View's layout, so let's requestLayout
9590 requestLayout = true;
9591 }
9592
Romain Guy8f1344f52009-05-15 16:03:59 -07009593 computeOpaqueFlags();
9594
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009595 if (requestLayout) {
9596 requestLayout();
9597 }
9598
9599 mBackgroundSizeChanged = true;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009600 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009601 }
9602
9603 /**
9604 * Gets the background drawable
9605 * @return The drawable used as the background for this view, if any.
9606 */
9607 public Drawable getBackground() {
9608 return mBGDrawable;
9609 }
9610
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009611 /**
9612 * Sets the padding. The view may add on the space required to display
9613 * the scrollbars, depending on the style and visibility of the scrollbars.
9614 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
9615 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
9616 * from the values set in this call.
9617 *
9618 * @attr ref android.R.styleable#View_padding
9619 * @attr ref android.R.styleable#View_paddingBottom
9620 * @attr ref android.R.styleable#View_paddingLeft
9621 * @attr ref android.R.styleable#View_paddingRight
9622 * @attr ref android.R.styleable#View_paddingTop
9623 * @param left the left padding in pixels
9624 * @param top the top padding in pixels
9625 * @param right the right padding in pixels
9626 * @param bottom the bottom padding in pixels
9627 */
9628 public void setPadding(int left, int top, int right, int bottom) {
9629 boolean changed = false;
9630
Adam Powell20232d02010-12-08 21:08:53 -08009631 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009632 mUserPaddingRight = right;
9633 mUserPaddingBottom = bottom;
9634
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009635 final int viewFlags = mViewFlags;
Romain Guy8506ab42009-06-11 17:35:47 -07009636
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009637 // Common case is there are no scroll bars.
9638 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009639 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -08009640 // TODO Determine what to do with SCROLLBAR_POSITION_DEFAULT based on RTL settings.
9641 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009642 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -08009643 switch (mVerticalScrollbarPosition) {
9644 case SCROLLBAR_POSITION_DEFAULT:
9645 case SCROLLBAR_POSITION_RIGHT:
9646 right += offset;
9647 break;
9648 case SCROLLBAR_POSITION_LEFT:
9649 left += offset;
9650 break;
9651 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009652 }
Adam Powell20232d02010-12-08 21:08:53 -08009653 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009654 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
9655 ? 0 : getHorizontalScrollbarHeight();
9656 }
9657 }
Romain Guy8506ab42009-06-11 17:35:47 -07009658
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009659 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009660 changed = true;
9661 mPaddingLeft = left;
9662 }
9663 if (mPaddingTop != top) {
9664 changed = true;
9665 mPaddingTop = top;
9666 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009667 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009668 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009669 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009670 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009671 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009672 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07009673 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009674 }
9675
9676 if (changed) {
9677 requestLayout();
9678 }
9679 }
9680
9681 /**
9682 * Returns the top padding of this view.
9683 *
9684 * @return the top padding in pixels
9685 */
9686 public int getPaddingTop() {
9687 return mPaddingTop;
9688 }
9689
9690 /**
9691 * Returns the bottom padding of this view. If there are inset and enabled
9692 * scrollbars, this value may include the space required to display the
9693 * scrollbars as well.
9694 *
9695 * @return the bottom padding in pixels
9696 */
9697 public int getPaddingBottom() {
9698 return mPaddingBottom;
9699 }
9700
9701 /**
9702 * Returns the left padding of this view. If there are inset and enabled
9703 * scrollbars, this value may include the space required to display the
9704 * scrollbars as well.
9705 *
9706 * @return the left padding in pixels
9707 */
9708 public int getPaddingLeft() {
9709 return mPaddingLeft;
9710 }
9711
9712 /**
9713 * Returns the right padding of this view. If there are inset and enabled
9714 * scrollbars, this value may include the space required to display the
9715 * scrollbars as well.
9716 *
9717 * @return the right padding in pixels
9718 */
9719 public int getPaddingRight() {
9720 return mPaddingRight;
9721 }
9722
9723 /**
9724 * Changes the selection state of this view. A view can be selected or not.
9725 * Note that selection is not the same as focus. Views are typically
9726 * selected in the context of an AdapterView like ListView or GridView;
9727 * the selected view is the view that is highlighted.
9728 *
9729 * @param selected true if the view must be selected, false otherwise
9730 */
9731 public void setSelected(boolean selected) {
9732 if (((mPrivateFlags & SELECTED) != 0) != selected) {
9733 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -07009734 if (!selected) resetPressedState();
Romain Guy0fd89bf2011-01-26 15:41:30 -08009735 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009736 refreshDrawableState();
9737 dispatchSetSelected(selected);
9738 }
9739 }
9740
9741 /**
9742 * Dispatch setSelected to all of this View's children.
9743 *
9744 * @see #setSelected(boolean)
9745 *
9746 * @param selected The new selected state
9747 */
9748 protected void dispatchSetSelected(boolean selected) {
9749 }
9750
9751 /**
9752 * Indicates the selection state of this view.
9753 *
9754 * @return true if the view is selected, false otherwise
9755 */
9756 @ViewDebug.ExportedProperty
9757 public boolean isSelected() {
9758 return (mPrivateFlags & SELECTED) != 0;
9759 }
9760
9761 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009762 * Changes the activated state of this view. A view can be activated or not.
9763 * Note that activation is not the same as selection. Selection is
9764 * a transient property, representing the view (hierarchy) the user is
9765 * currently interacting with. Activation is a longer-term state that the
9766 * user can move views in and out of. For example, in a list view with
9767 * single or multiple selection enabled, the views in the current selection
9768 * set are activated. (Um, yeah, we are deeply sorry about the terminology
9769 * here.) The activated state is propagated down to children of the view it
9770 * is set on.
9771 *
9772 * @param activated true if the view must be activated, false otherwise
9773 */
9774 public void setActivated(boolean activated) {
9775 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
9776 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
Romain Guy0fd89bf2011-01-26 15:41:30 -08009777 invalidate(true);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009778 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -07009779 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009780 }
9781 }
9782
9783 /**
9784 * Dispatch setActivated to all of this View's children.
9785 *
9786 * @see #setActivated(boolean)
9787 *
9788 * @param activated The new activated state
9789 */
9790 protected void dispatchSetActivated(boolean activated) {
9791 }
9792
9793 /**
9794 * Indicates the activation state of this view.
9795 *
9796 * @return true if the view is activated, false otherwise
9797 */
9798 @ViewDebug.ExportedProperty
9799 public boolean isActivated() {
9800 return (mPrivateFlags & ACTIVATED) != 0;
9801 }
9802
9803 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009804 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
9805 * observer can be used to get notifications when global events, like
9806 * layout, happen.
9807 *
9808 * The returned ViewTreeObserver observer is not guaranteed to remain
9809 * valid for the lifetime of this View. If the caller of this method keeps
9810 * a long-lived reference to ViewTreeObserver, it should always check for
9811 * the return value of {@link ViewTreeObserver#isAlive()}.
9812 *
9813 * @return The ViewTreeObserver for this view's hierarchy.
9814 */
9815 public ViewTreeObserver getViewTreeObserver() {
9816 if (mAttachInfo != null) {
9817 return mAttachInfo.mTreeObserver;
9818 }
9819 if (mFloatingTreeObserver == null) {
9820 mFloatingTreeObserver = new ViewTreeObserver();
9821 }
9822 return mFloatingTreeObserver;
9823 }
9824
9825 /**
9826 * <p>Finds the topmost view in the current view hierarchy.</p>
9827 *
9828 * @return the topmost view containing this view
9829 */
9830 public View getRootView() {
9831 if (mAttachInfo != null) {
9832 final View v = mAttachInfo.mRootView;
9833 if (v != null) {
9834 return v;
9835 }
9836 }
Romain Guy8506ab42009-06-11 17:35:47 -07009837
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009838 View parent = this;
9839
9840 while (parent.mParent != null && parent.mParent instanceof View) {
9841 parent = (View) parent.mParent;
9842 }
9843
9844 return parent;
9845 }
9846
9847 /**
9848 * <p>Computes the coordinates of this view on the screen. The argument
9849 * must be an array of two integers. After the method returns, the array
9850 * contains the x and y location in that order.</p>
9851 *
9852 * @param location an array of two integers in which to hold the coordinates
9853 */
9854 public void getLocationOnScreen(int[] location) {
9855 getLocationInWindow(location);
9856
9857 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -07009858 if (info != null) {
9859 location[0] += info.mWindowLeft;
9860 location[1] += info.mWindowTop;
9861 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009862 }
9863
9864 /**
9865 * <p>Computes the coordinates of this view in its window. The argument
9866 * must be an array of two integers. After the method returns, the array
9867 * contains the x and y location in that order.</p>
9868 *
9869 * @param location an array of two integers in which to hold the coordinates
9870 */
9871 public void getLocationInWindow(int[] location) {
9872 if (location == null || location.length < 2) {
9873 throw new IllegalArgumentException("location must be an array of "
9874 + "two integers");
9875 }
9876
Michael Jurka4d2bd4c2010-11-30 18:15:11 -08009877 location[0] = mLeft + (int) (mTranslationX + 0.5f);
9878 location[1] = mTop + (int) (mTranslationY + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009879
9880 ViewParent viewParent = mParent;
9881 while (viewParent instanceof View) {
9882 final View view = (View)viewParent;
Michael Jurka4d2bd4c2010-11-30 18:15:11 -08009883 location[0] += view.mLeft + (int) (view.mTranslationX + 0.5f) - view.mScrollX;
9884 location[1] += view.mTop + (int) (view.mTranslationY + 0.5f) - view.mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009885 viewParent = view.mParent;
9886 }
Romain Guy8506ab42009-06-11 17:35:47 -07009887
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009888 if (viewParent instanceof ViewRoot) {
9889 // *cough*
9890 final ViewRoot vr = (ViewRoot)viewParent;
9891 location[1] -= vr.mCurScrollY;
9892 }
9893 }
9894
9895 /**
9896 * {@hide}
9897 * @param id the id of the view to be found
9898 * @return the view of the specified id, null if cannot be found
9899 */
9900 protected View findViewTraversal(int id) {
9901 if (id == mID) {
9902 return this;
9903 }
9904 return null;
9905 }
9906
9907 /**
9908 * {@hide}
9909 * @param tag the tag of the view to be found
9910 * @return the view of specified tag, null if cannot be found
9911 */
9912 protected View findViewWithTagTraversal(Object tag) {
9913 if (tag != null && tag.equals(mTag)) {
9914 return this;
9915 }
9916 return null;
9917 }
9918
9919 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08009920 * {@hide}
9921 * @param predicate The predicate to evaluate.
9922 * @return The first view that matches the predicate or null.
9923 */
9924 protected View findViewByPredicateTraversal(Predicate<View> predicate) {
9925 if (predicate.apply(this)) {
9926 return this;
9927 }
9928 return null;
9929 }
9930
9931 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009932 * Look for a child view with the given id. If this view has the given
9933 * id, return this view.
9934 *
9935 * @param id The id to search for.
9936 * @return The view that has the given id in the hierarchy or null
9937 */
9938 public final View findViewById(int id) {
9939 if (id < 0) {
9940 return null;
9941 }
9942 return findViewTraversal(id);
9943 }
9944
9945 /**
9946 * Look for a child view with the given tag. If this view has the given
9947 * tag, return this view.
9948 *
9949 * @param tag The tag to search for, using "tag.equals(getTag())".
9950 * @return The View that has the given tag in the hierarchy or null
9951 */
9952 public final View findViewWithTag(Object tag) {
9953 if (tag == null) {
9954 return null;
9955 }
9956 return findViewWithTagTraversal(tag);
9957 }
9958
9959 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08009960 * {@hide}
9961 * Look for a child view that matches the specified predicate.
9962 * If this view matches the predicate, return this view.
9963 *
9964 * @param predicate The predicate to evaluate.
9965 * @return The first view that matches the predicate or null.
9966 */
9967 public final View findViewByPredicate(Predicate<View> predicate) {
9968 return findViewByPredicateTraversal(predicate);
9969 }
9970
9971 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009972 * Sets the identifier for this view. The identifier does not have to be
9973 * unique in this view's hierarchy. The identifier should be a positive
9974 * number.
9975 *
9976 * @see #NO_ID
9977 * @see #getId
9978 * @see #findViewById
9979 *
9980 * @param id a number used to identify the view
9981 *
9982 * @attr ref android.R.styleable#View_id
9983 */
9984 public void setId(int id) {
9985 mID = id;
9986 }
9987
9988 /**
9989 * {@hide}
9990 *
9991 * @param isRoot true if the view belongs to the root namespace, false
9992 * otherwise
9993 */
9994 public void setIsRootNamespace(boolean isRoot) {
9995 if (isRoot) {
9996 mPrivateFlags |= IS_ROOT_NAMESPACE;
9997 } else {
9998 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
9999 }
10000 }
10001
10002 /**
10003 * {@hide}
10004 *
10005 * @return true if the view belongs to the root namespace, false otherwise
10006 */
10007 public boolean isRootNamespace() {
10008 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
10009 }
10010
10011 /**
10012 * Returns this view's identifier.
10013 *
10014 * @return a positive integer used to identify the view or {@link #NO_ID}
10015 * if the view has no ID
10016 *
10017 * @see #setId
10018 * @see #findViewById
10019 * @attr ref android.R.styleable#View_id
10020 */
10021 @ViewDebug.CapturedViewProperty
10022 public int getId() {
10023 return mID;
10024 }
10025
10026 /**
10027 * Returns this view's tag.
10028 *
10029 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -070010030 *
10031 * @see #setTag(Object)
10032 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010033 */
10034 @ViewDebug.ExportedProperty
10035 public Object getTag() {
10036 return mTag;
10037 }
10038
10039 /**
10040 * Sets the tag associated with this view. A tag can be used to mark
10041 * a view in its hierarchy and does not have to be unique within the
10042 * hierarchy. Tags can also be used to store data within a view without
10043 * resorting to another data structure.
10044 *
10045 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -070010046 *
10047 * @see #getTag()
10048 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010049 */
10050 public void setTag(final Object tag) {
10051 mTag = tag;
10052 }
10053
10054 /**
Romain Guyd90a3312009-05-06 14:54:28 -070010055 * Returns the tag associated with this view and the specified key.
10056 *
10057 * @param key The key identifying the tag
10058 *
10059 * @return the Object stored in this view as a tag
10060 *
10061 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -070010062 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -070010063 */
10064 public Object getTag(int key) {
10065 SparseArray<Object> tags = null;
10066 synchronized (sTagsLock) {
10067 if (sTags != null) {
10068 tags = sTags.get(this);
10069 }
10070 }
10071
10072 if (tags != null) return tags.get(key);
10073 return null;
10074 }
10075
10076 /**
10077 * Sets a tag associated with this view and a key. A tag can be used
10078 * to mark a view in its hierarchy and does not have to be unique within
10079 * the hierarchy. Tags can also be used to store data within a view
10080 * without resorting to another data structure.
10081 *
10082 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -070010083 * application to ensure it is unique (see the <a
10084 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
10085 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -070010086 * the Android framework or not associated with any package will cause
10087 * an {@link IllegalArgumentException} to be thrown.
10088 *
10089 * @param key The key identifying the tag
10090 * @param tag An Object to tag the view with
10091 *
10092 * @throws IllegalArgumentException If they specified key is not valid
10093 *
10094 * @see #setTag(Object)
10095 * @see #getTag(int)
10096 */
10097 public void setTag(int key, final Object tag) {
10098 // If the package id is 0x00 or 0x01, it's either an undefined package
10099 // or a framework id
10100 if ((key >>> 24) < 2) {
10101 throw new IllegalArgumentException("The key must be an application-specific "
10102 + "resource id.");
10103 }
10104
10105 setTagInternal(this, key, tag);
10106 }
10107
10108 /**
10109 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
10110 * framework id.
10111 *
10112 * @hide
10113 */
10114 public void setTagInternal(int key, Object tag) {
10115 if ((key >>> 24) != 0x1) {
10116 throw new IllegalArgumentException("The key must be a framework-specific "
10117 + "resource id.");
10118 }
10119
Romain Guy8506ab42009-06-11 17:35:47 -070010120 setTagInternal(this, key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070010121 }
10122
10123 private static void setTagInternal(View view, int key, Object tag) {
10124 SparseArray<Object> tags = null;
10125 synchronized (sTagsLock) {
10126 if (sTags == null) {
10127 sTags = new WeakHashMap<View, SparseArray<Object>>();
10128 } else {
10129 tags = sTags.get(view);
10130 }
10131 }
10132
10133 if (tags == null) {
10134 tags = new SparseArray<Object>(2);
10135 synchronized (sTagsLock) {
10136 sTags.put(view, tags);
10137 }
10138 }
10139
10140 tags.put(key, tag);
10141 }
10142
10143 /**
Romain Guy13922e02009-05-12 17:56:14 -070010144 * @param consistency The type of consistency. See ViewDebug for more information.
10145 *
10146 * @hide
10147 */
10148 protected boolean dispatchConsistencyCheck(int consistency) {
10149 return onConsistencyCheck(consistency);
10150 }
10151
10152 /**
10153 * Method that subclasses should implement to check their consistency. The type of
10154 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -070010155 *
Romain Guy13922e02009-05-12 17:56:14 -070010156 * @param consistency The type of consistency. See ViewDebug for more information.
10157 *
10158 * @throws IllegalStateException if the view is in an inconsistent state.
10159 *
10160 * @hide
10161 */
10162 protected boolean onConsistencyCheck(int consistency) {
10163 boolean result = true;
10164
10165 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
10166 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
10167
10168 if (checkLayout) {
10169 if (getParent() == null) {
10170 result = false;
10171 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10172 "View " + this + " does not have a parent.");
10173 }
10174
10175 if (mAttachInfo == null) {
10176 result = false;
10177 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10178 "View " + this + " is not attached to a window.");
10179 }
10180 }
10181
10182 if (checkDrawing) {
10183 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
10184 // from their draw() method
10185
10186 if ((mPrivateFlags & DRAWN) != DRAWN &&
10187 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
10188 result = false;
10189 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10190 "View " + this + " was invalidated but its drawing cache is valid.");
10191 }
10192 }
10193
10194 return result;
10195 }
10196
10197 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010198 * Prints information about this view in the log output, with the tag
10199 * {@link #VIEW_LOG_TAG}.
10200 *
10201 * @hide
10202 */
10203 public void debug() {
10204 debug(0);
10205 }
10206
10207 /**
10208 * Prints information about this view in the log output, with the tag
10209 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
10210 * indentation defined by the <code>depth</code>.
10211 *
10212 * @param depth the indentation level
10213 *
10214 * @hide
10215 */
10216 protected void debug(int depth) {
10217 String output = debugIndent(depth - 1);
10218
10219 output += "+ " + this;
10220 int id = getId();
10221 if (id != -1) {
10222 output += " (id=" + id + ")";
10223 }
10224 Object tag = getTag();
10225 if (tag != null) {
10226 output += " (tag=" + tag + ")";
10227 }
10228 Log.d(VIEW_LOG_TAG, output);
10229
10230 if ((mPrivateFlags & FOCUSED) != 0) {
10231 output = debugIndent(depth) + " FOCUSED";
10232 Log.d(VIEW_LOG_TAG, output);
10233 }
10234
10235 output = debugIndent(depth);
10236 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
10237 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
10238 + "} ";
10239 Log.d(VIEW_LOG_TAG, output);
10240
10241 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
10242 || mPaddingBottom != 0) {
10243 output = debugIndent(depth);
10244 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
10245 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
10246 Log.d(VIEW_LOG_TAG, output);
10247 }
10248
10249 output = debugIndent(depth);
10250 output += "mMeasureWidth=" + mMeasuredWidth +
10251 " mMeasureHeight=" + mMeasuredHeight;
10252 Log.d(VIEW_LOG_TAG, output);
10253
10254 output = debugIndent(depth);
10255 if (mLayoutParams == null) {
10256 output += "BAD! no layout params";
10257 } else {
10258 output = mLayoutParams.debug(output);
10259 }
10260 Log.d(VIEW_LOG_TAG, output);
10261
10262 output = debugIndent(depth);
10263 output += "flags={";
10264 output += View.printFlags(mViewFlags);
10265 output += "}";
10266 Log.d(VIEW_LOG_TAG, output);
10267
10268 output = debugIndent(depth);
10269 output += "privateFlags={";
10270 output += View.printPrivateFlags(mPrivateFlags);
10271 output += "}";
10272 Log.d(VIEW_LOG_TAG, output);
10273 }
10274
10275 /**
10276 * Creates an string of whitespaces used for indentation.
10277 *
10278 * @param depth the indentation level
10279 * @return a String containing (depth * 2 + 3) * 2 white spaces
10280 *
10281 * @hide
10282 */
10283 protected static String debugIndent(int depth) {
10284 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
10285 for (int i = 0; i < (depth * 2) + 3; i++) {
10286 spaces.append(' ').append(' ');
10287 }
10288 return spaces.toString();
10289 }
10290
10291 /**
10292 * <p>Return the offset of the widget's text baseline from the widget's top
10293 * boundary. If this widget does not support baseline alignment, this
10294 * method returns -1. </p>
10295 *
10296 * @return the offset of the baseline within the widget's bounds or -1
10297 * if baseline alignment is not supported
10298 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070010299 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010300 public int getBaseline() {
10301 return -1;
10302 }
10303
10304 /**
10305 * Call this when something has changed which has invalidated the
10306 * layout of this view. This will schedule a layout pass of the view
10307 * tree.
10308 */
10309 public void requestLayout() {
10310 if (ViewDebug.TRACE_HIERARCHY) {
10311 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
10312 }
10313
10314 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080010315 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010316
10317 if (mParent != null && !mParent.isLayoutRequested()) {
10318 mParent.requestLayout();
10319 }
10320 }
10321
10322 /**
10323 * Forces this view to be laid out during the next layout pass.
10324 * This method does not call requestLayout() or forceLayout()
10325 * on the parent.
10326 */
10327 public void forceLayout() {
10328 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080010329 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010330 }
10331
10332 /**
10333 * <p>
10334 * This is called to find out how big a view should be. The parent
10335 * supplies constraint information in the width and height parameters.
10336 * </p>
10337 *
10338 * <p>
10339 * The actual mesurement work of a view is performed in
10340 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
10341 * {@link #onMeasure(int, int)} can and must be overriden by subclasses.
10342 * </p>
10343 *
10344 *
10345 * @param widthMeasureSpec Horizontal space requirements as imposed by the
10346 * parent
10347 * @param heightMeasureSpec Vertical space requirements as imposed by the
10348 * parent
10349 *
10350 * @see #onMeasure(int, int)
10351 */
10352 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
10353 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
10354 widthMeasureSpec != mOldWidthMeasureSpec ||
10355 heightMeasureSpec != mOldHeightMeasureSpec) {
10356
10357 // first clears the measured dimension flag
10358 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
10359
10360 if (ViewDebug.TRACE_HIERARCHY) {
10361 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
10362 }
10363
10364 // measure ourselves, this should set the measured dimension flag back
10365 onMeasure(widthMeasureSpec, heightMeasureSpec);
10366
10367 // flag not set, setMeasuredDimension() was not invoked, we raise
10368 // an exception to warn the developer
10369 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
10370 throw new IllegalStateException("onMeasure() did not set the"
10371 + " measured dimension by calling"
10372 + " setMeasuredDimension()");
10373 }
10374
10375 mPrivateFlags |= LAYOUT_REQUIRED;
10376 }
10377
10378 mOldWidthMeasureSpec = widthMeasureSpec;
10379 mOldHeightMeasureSpec = heightMeasureSpec;
10380 }
10381
10382 /**
10383 * <p>
10384 * Measure the view and its content to determine the measured width and the
10385 * measured height. This method is invoked by {@link #measure(int, int)} and
10386 * should be overriden by subclasses to provide accurate and efficient
10387 * measurement of their contents.
10388 * </p>
10389 *
10390 * <p>
10391 * <strong>CONTRACT:</strong> When overriding this method, you
10392 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
10393 * measured width and height of this view. Failure to do so will trigger an
10394 * <code>IllegalStateException</code>, thrown by
10395 * {@link #measure(int, int)}. Calling the superclass'
10396 * {@link #onMeasure(int, int)} is a valid use.
10397 * </p>
10398 *
10399 * <p>
10400 * The base class implementation of measure defaults to the background size,
10401 * unless a larger size is allowed by the MeasureSpec. Subclasses should
10402 * override {@link #onMeasure(int, int)} to provide better measurements of
10403 * their content.
10404 * </p>
10405 *
10406 * <p>
10407 * If this method is overridden, it is the subclass's responsibility to make
10408 * sure the measured height and width are at least the view's minimum height
10409 * and width ({@link #getSuggestedMinimumHeight()} and
10410 * {@link #getSuggestedMinimumWidth()}).
10411 * </p>
10412 *
10413 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
10414 * The requirements are encoded with
10415 * {@link android.view.View.MeasureSpec}.
10416 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
10417 * The requirements are encoded with
10418 * {@link android.view.View.MeasureSpec}.
10419 *
10420 * @see #getMeasuredWidth()
10421 * @see #getMeasuredHeight()
10422 * @see #setMeasuredDimension(int, int)
10423 * @see #getSuggestedMinimumHeight()
10424 * @see #getSuggestedMinimumWidth()
10425 * @see android.view.View.MeasureSpec#getMode(int)
10426 * @see android.view.View.MeasureSpec#getSize(int)
10427 */
10428 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
10429 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
10430 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
10431 }
10432
10433 /**
10434 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
10435 * measured width and measured height. Failing to do so will trigger an
10436 * exception at measurement time.</p>
10437 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080010438 * @param measuredWidth The measured width of this view. May be a complex
10439 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
10440 * {@link #MEASURED_STATE_TOO_SMALL}.
10441 * @param measuredHeight The measured height of this view. May be a complex
10442 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
10443 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010444 */
10445 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
10446 mMeasuredWidth = measuredWidth;
10447 mMeasuredHeight = measuredHeight;
10448
10449 mPrivateFlags |= MEASURED_DIMENSION_SET;
10450 }
10451
10452 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080010453 * Merge two states as returned by {@link #getMeasuredState()}.
10454 * @param curState The current state as returned from a view or the result
10455 * of combining multiple views.
10456 * @param newState The new view state to combine.
10457 * @return Returns a new integer reflecting the combination of the two
10458 * states.
10459 */
10460 public static int combineMeasuredStates(int curState, int newState) {
10461 return curState | newState;
10462 }
10463
10464 /**
10465 * Version of {@link #resolveSizeAndState(int, int, int)}
10466 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
10467 */
10468 public static int resolveSize(int size, int measureSpec) {
10469 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
10470 }
10471
10472 /**
10473 * Utility to reconcile a desired size and state, with constraints imposed
10474 * by a MeasureSpec. Will take the desired size, unless a different size
10475 * is imposed by the constraints. The returned value is a compound integer,
10476 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
10477 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
10478 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010479 *
10480 * @param size How big the view wants to be
10481 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080010482 * @return Size information bit mask as defined by
10483 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010484 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080010485 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010486 int result = size;
10487 int specMode = MeasureSpec.getMode(measureSpec);
10488 int specSize = MeasureSpec.getSize(measureSpec);
10489 switch (specMode) {
10490 case MeasureSpec.UNSPECIFIED:
10491 result = size;
10492 break;
10493 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080010494 if (specSize < size) {
10495 result = specSize | MEASURED_STATE_TOO_SMALL;
10496 } else {
10497 result = size;
10498 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010499 break;
10500 case MeasureSpec.EXACTLY:
10501 result = specSize;
10502 break;
10503 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080010504 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010505 }
10506
10507 /**
10508 * Utility to return a default size. Uses the supplied size if the
10509 * MeasureSpec imposed no contraints. Will get larger if allowed
10510 * by the MeasureSpec.
10511 *
10512 * @param size Default size for this view
10513 * @param measureSpec Constraints imposed by the parent
10514 * @return The size this view should be.
10515 */
10516 public static int getDefaultSize(int size, int measureSpec) {
10517 int result = size;
10518 int specMode = MeasureSpec.getMode(measureSpec);
10519 int specSize = MeasureSpec.getSize(measureSpec);
10520
10521 switch (specMode) {
10522 case MeasureSpec.UNSPECIFIED:
10523 result = size;
10524 break;
10525 case MeasureSpec.AT_MOST:
10526 case MeasureSpec.EXACTLY:
10527 result = specSize;
10528 break;
10529 }
10530 return result;
10531 }
10532
10533 /**
10534 * Returns the suggested minimum height that the view should use. This
10535 * returns the maximum of the view's minimum height
10536 * and the background's minimum height
10537 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
10538 * <p>
10539 * When being used in {@link #onMeasure(int, int)}, the caller should still
10540 * ensure the returned height is within the requirements of the parent.
10541 *
10542 * @return The suggested minimum height of the view.
10543 */
10544 protected int getSuggestedMinimumHeight() {
10545 int suggestedMinHeight = mMinHeight;
10546
10547 if (mBGDrawable != null) {
10548 final int bgMinHeight = mBGDrawable.getMinimumHeight();
10549 if (suggestedMinHeight < bgMinHeight) {
10550 suggestedMinHeight = bgMinHeight;
10551 }
10552 }
10553
10554 return suggestedMinHeight;
10555 }
10556
10557 /**
10558 * Returns the suggested minimum width that the view should use. This
10559 * returns the maximum of the view's minimum width)
10560 * and the background's minimum width
10561 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
10562 * <p>
10563 * When being used in {@link #onMeasure(int, int)}, the caller should still
10564 * ensure the returned width is within the requirements of the parent.
10565 *
10566 * @return The suggested minimum width of the view.
10567 */
10568 protected int getSuggestedMinimumWidth() {
10569 int suggestedMinWidth = mMinWidth;
10570
10571 if (mBGDrawable != null) {
10572 final int bgMinWidth = mBGDrawable.getMinimumWidth();
10573 if (suggestedMinWidth < bgMinWidth) {
10574 suggestedMinWidth = bgMinWidth;
10575 }
10576 }
10577
10578 return suggestedMinWidth;
10579 }
10580
10581 /**
10582 * Sets the minimum height of the view. It is not guaranteed the view will
10583 * be able to achieve this minimum height (for example, if its parent layout
10584 * constrains it with less available height).
10585 *
10586 * @param minHeight The minimum height the view will try to be.
10587 */
10588 public void setMinimumHeight(int minHeight) {
10589 mMinHeight = minHeight;
10590 }
10591
10592 /**
10593 * Sets the minimum width of the view. It is not guaranteed the view will
10594 * be able to achieve this minimum width (for example, if its parent layout
10595 * constrains it with less available width).
10596 *
10597 * @param minWidth The minimum width the view will try to be.
10598 */
10599 public void setMinimumWidth(int minWidth) {
10600 mMinWidth = minWidth;
10601 }
10602
10603 /**
10604 * Get the animation currently associated with this view.
10605 *
10606 * @return The animation that is currently playing or
10607 * scheduled to play for this view.
10608 */
10609 public Animation getAnimation() {
10610 return mCurrentAnimation;
10611 }
10612
10613 /**
10614 * Start the specified animation now.
10615 *
10616 * @param animation the animation to start now
10617 */
10618 public void startAnimation(Animation animation) {
10619 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
10620 setAnimation(animation);
Romain Guy0fd89bf2011-01-26 15:41:30 -080010621 invalidateParentCaches();
10622 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010623 }
10624
10625 /**
10626 * Cancels any animations for this view.
10627 */
10628 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080010629 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080010630 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080010631 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010632 mCurrentAnimation = null;
Romain Guy0fd89bf2011-01-26 15:41:30 -080010633 invalidateParentIfNeeded();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010634 }
10635
10636 /**
10637 * Sets the next animation to play for this view.
10638 * If you want the animation to play immediately, use
10639 * startAnimation. This method provides allows fine-grained
10640 * control over the start time and invalidation, but you
10641 * must make sure that 1) the animation has a start time set, and
10642 * 2) the view will be invalidated when the animation is supposed to
10643 * start.
10644 *
10645 * @param animation The next animation, or null.
10646 */
10647 public void setAnimation(Animation animation) {
10648 mCurrentAnimation = animation;
10649 if (animation != null) {
10650 animation.reset();
10651 }
10652 }
10653
10654 /**
10655 * Invoked by a parent ViewGroup to notify the start of the animation
10656 * currently associated with this view. If you override this method,
10657 * always call super.onAnimationStart();
10658 *
10659 * @see #setAnimation(android.view.animation.Animation)
10660 * @see #getAnimation()
10661 */
10662 protected void onAnimationStart() {
10663 mPrivateFlags |= ANIMATION_STARTED;
10664 }
10665
10666 /**
10667 * Invoked by a parent ViewGroup to notify the end of the animation
10668 * currently associated with this view. If you override this method,
10669 * always call super.onAnimationEnd();
10670 *
10671 * @see #setAnimation(android.view.animation.Animation)
10672 * @see #getAnimation()
10673 */
10674 protected void onAnimationEnd() {
10675 mPrivateFlags &= ~ANIMATION_STARTED;
10676 }
10677
10678 /**
10679 * Invoked if there is a Transform that involves alpha. Subclass that can
10680 * draw themselves with the specified alpha should return true, and then
10681 * respect that alpha when their onDraw() is called. If this returns false
10682 * then the view may be redirected to draw into an offscreen buffer to
10683 * fulfill the request, which will look fine, but may be slower than if the
10684 * subclass handles it internally. The default implementation returns false.
10685 *
10686 * @param alpha The alpha (0..255) to apply to the view's drawing
10687 * @return true if the view can draw with the specified alpha.
10688 */
10689 protected boolean onSetAlpha(int alpha) {
10690 return false;
10691 }
10692
10693 /**
10694 * This is used by the RootView to perform an optimization when
10695 * the view hierarchy contains one or several SurfaceView.
10696 * SurfaceView is always considered transparent, but its children are not,
10697 * therefore all View objects remove themselves from the global transparent
10698 * region (passed as a parameter to this function).
10699 *
10700 * @param region The transparent region for this ViewRoot (window).
10701 *
10702 * @return Returns true if the effective visibility of the view at this
10703 * point is opaque, regardless of the transparent region; returns false
10704 * if it is possible for underlying windows to be seen behind the view.
10705 *
10706 * {@hide}
10707 */
10708 public boolean gatherTransparentRegion(Region region) {
10709 final AttachInfo attachInfo = mAttachInfo;
10710 if (region != null && attachInfo != null) {
10711 final int pflags = mPrivateFlags;
10712 if ((pflags & SKIP_DRAW) == 0) {
10713 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
10714 // remove it from the transparent region.
10715 final int[] location = attachInfo.mTransparentLocation;
10716 getLocationInWindow(location);
10717 region.op(location[0], location[1], location[0] + mRight - mLeft,
10718 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
10719 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) {
10720 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
10721 // exists, so we remove the background drawable's non-transparent
10722 // parts from this transparent region.
10723 applyDrawableToTransparentRegion(mBGDrawable, region);
10724 }
10725 }
10726 return true;
10727 }
10728
10729 /**
10730 * Play a sound effect for this view.
10731 *
10732 * <p>The framework will play sound effects for some built in actions, such as
10733 * clicking, but you may wish to play these effects in your widget,
10734 * for instance, for internal navigation.
10735 *
10736 * <p>The sound effect will only be played if sound effects are enabled by the user, and
10737 * {@link #isSoundEffectsEnabled()} is true.
10738 *
10739 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
10740 */
10741 public void playSoundEffect(int soundConstant) {
10742 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
10743 return;
10744 }
10745 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
10746 }
10747
10748 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010749 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070010750 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010751 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010752 *
10753 * <p>The framework will provide haptic feedback for some built in actions,
10754 * such as long presses, but you may wish to provide feedback for your
10755 * own widget.
10756 *
10757 * <p>The feedback will only be performed if
10758 * {@link #isHapticFeedbackEnabled()} is true.
10759 *
10760 * @param feedbackConstant One of the constants defined in
10761 * {@link HapticFeedbackConstants}
10762 */
10763 public boolean performHapticFeedback(int feedbackConstant) {
10764 return performHapticFeedback(feedbackConstant, 0);
10765 }
10766
10767 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010768 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070010769 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070010770 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010771 *
10772 * @param feedbackConstant One of the constants defined in
10773 * {@link HapticFeedbackConstants}
10774 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
10775 */
10776 public boolean performHapticFeedback(int feedbackConstant, int flags) {
10777 if (mAttachInfo == null) {
10778 return false;
10779 }
Romain Guyf607bdc2010-09-10 19:20:06 -070010780 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070010781 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010782 && !isHapticFeedbackEnabled()) {
10783 return false;
10784 }
Romain Guy812ccbe2010-06-01 14:07:24 -070010785 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
10786 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010787 }
10788
10789 /**
Joe Onorato664644d2011-01-23 17:53:23 -080010790 * Request that the visibility of the status bar be changed.
10791 */
10792 public void setSystemUiVisibility(int visibility) {
10793 if (visibility != mSystemUiVisibility) {
10794 mSystemUiVisibility = visibility;
10795 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
10796 mParent.recomputeViewAttributes(this);
10797 }
10798 }
10799 }
10800
10801 /**
10802 * Returns the status bar visibility that this view has requested.
10803 */
Joe Onoratoe595cad2011-01-24 09:22:12 -080010804 public int getSystemUiVisibility() {
Joe Onorato664644d2011-01-23 17:53:23 -080010805 return mSystemUiVisibility;
10806 }
10807
10808 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) {
10809 mOnSystemUiVisibilityChangeListener = l;
10810 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
10811 mParent.recomputeViewAttributes(this);
10812 }
10813 }
10814
10815 /**
10816 */
10817 public void dispatchSystemUiVisibilityChanged(int visibility) {
10818 if (mOnSystemUiVisibilityChangeListener != null) {
10819 mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange(visibility);
10820 }
10821 }
10822
10823 /**
Christopher Tate2c095f32010-10-04 14:13:40 -070010824 * !!! TODO: real docs
10825 *
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010826 * The base class implementation makes the shadow the same size and appearance
Christopher Tate2c095f32010-10-04 14:13:40 -070010827 * as the view itself, and positions it with its center at the touch point.
10828 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010829 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070010830 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070010831
10832 /**
Christopher Tate17ed60c2011-01-18 12:50:26 -080010833 * Construct a shadow builder object for use with the given View object. The
10834 * default implementation will construct a drag shadow the same size and
10835 * appearance as the supplied View.
10836 *
10837 * @param view A view within the application's layout whose appearance
10838 * should be replicated as the drag shadow.
Christopher Tate2c095f32010-10-04 14:13:40 -070010839 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010840 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070010841 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070010842 }
10843
Christopher Tate17ed60c2011-01-18 12:50:26 -080010844 /**
10845 * Construct a shadow builder object with no associated View. This
10846 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)}
10847 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order
10848 * to supply the drag shadow's dimensions and appearance without
10849 * reference to any View object.
10850 */
10851 public DragShadowBuilder() {
10852 mView = new WeakReference<View>(null);
10853 }
10854
10855 /**
10856 * Returns the View object that had been passed to the
10857 * {@link #View.DragShadowBuilder(View)}
10858 * constructor. If that View parameter was {@code null} or if the
10859 * {@link #View.DragShadowBuilder()}
10860 * constructor was used to instantiate the builder object, this method will return
10861 * null.
10862 *
10863 * @return The View object associate with this builder object.
10864 */
Chris Tate6b391282010-10-14 15:48:59 -070010865 final public View getView() {
10866 return mView.get();
10867 }
10868
Christopher Tate2c095f32010-10-04 14:13:40 -070010869 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010870 * Provide the draggable-shadow metrics for the operation: the dimensions of
10871 * the shadow image itself, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070010872 * be centered under the touch location while dragging.
10873 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010874 * The default implementation sets the dimensions of the shadow to be the
Christopher Tate17ed60c2011-01-18 12:50:26 -080010875 * same as the dimensions of the View object that had been supplied to the
10876 * {@link #View.DragShadowBuilder(View)} constructor
10877 * when the builder object was instantiated, and centers the shadow under the touch
10878 * point.
Christopher Tate2c095f32010-10-04 14:13:40 -070010879 *
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010880 * @param shadowSize The application should set the {@code x} member of this
10881 * parameter to the desired shadow width, and the {@code y} member to
Christopher Tate2c095f32010-10-04 14:13:40 -070010882 * the desired height.
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010883 * @param shadowTouchPoint The application should set this point to be the
10884 * location within the shadow that should track directly underneath
Christopher Tate2c095f32010-10-04 14:13:40 -070010885 * the touch point on the screen during a drag.
10886 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010887 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070010888 final View view = mView.get();
10889 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010890 shadowSize.set(view.getWidth(), view.getHeight());
10891 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070010892 } else {
10893 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
10894 }
Christopher Tate2c095f32010-10-04 14:13:40 -070010895 }
10896
10897 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010898 * Draw the shadow image for the upcoming drag. The shadow canvas was
10899 * created with the dimensions supplied by the
10900 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate17ed60c2011-01-18 12:50:26 -080010901 * <p>
10902 * The default implementation replicates the appearance of the View object
10903 * that had been supplied to the
10904 * {@link #View.DragShadowBuilder(View)}
10905 * constructor when the builder object was instantiated.
Christopher Tate2c095f32010-10-04 14:13:40 -070010906 *
10907 * @param canvas
10908 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010909 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070010910 final View view = mView.get();
10911 if (view != null) {
10912 view.draw(canvas);
10913 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010914 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070010915 }
Christopher Tate2c095f32010-10-04 14:13:40 -070010916 }
10917 }
10918
10919 /**
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010920 * Drag and drop. App calls startDrag(), then callbacks to the shadow builder's
10921 * {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)} and
10922 * {@link DragShadowBuilder#onDrawShadow(Canvas)} methods happen, then the drag
Christopher Tate5ada6cb2010-10-05 14:15:29 -070010923 * operation is handed over to the OS.
Christopher Tatea53146c2010-09-07 11:57:52 -070010924 * !!! TODO: real docs
Christopher Tate407b4e92010-11-30 17:14:08 -080010925 *
10926 * @param data !!! TODO
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010927 * @param shadowBuilder !!! TODO
Christopher Tate407b4e92010-11-30 17:14:08 -080010928 * @param myLocalState An arbitrary object that will be passed as part of every DragEvent
10929 * delivered to the calling application during the course of the current drag operation.
10930 * This object is private to the application that called startDrag(), and is not
10931 * visible to other applications. It provides a lightweight way for the application to
10932 * propagate information from the initiator to the recipient of a drag within its own
10933 * application; for example, to help disambiguate between 'copy' and 'move' semantics.
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010934 * @param flags Flags affecting the drag operation. At present no flags are defined;
10935 * pass 0 for this parameter.
Christopher Tate407b4e92010-11-30 17:14:08 -080010936 * @return {@code true} if the drag operation was initiated successfully; {@code false} if
10937 * an error prevented the drag from taking place.
Christopher Tatea53146c2010-09-07 11:57:52 -070010938 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010939 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010940 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070010941 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010942 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070010943 }
10944 boolean okay = false;
10945
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010946 Point shadowSize = new Point();
10947 Point shadowTouchPoint = new Point();
10948 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070010949
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010950 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
10951 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
10952 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070010953 }
Christopher Tatea53146c2010-09-07 11:57:52 -070010954
Chris Tatea32dcf72010-10-14 12:13:50 -070010955 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010956 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
10957 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070010958 }
Christopher Tatea53146c2010-09-07 11:57:52 -070010959 Surface surface = new Surface();
10960 try {
10961 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080010962 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070010963 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070010964 + " surface=" + surface);
10965 if (token != null) {
10966 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070010967 try {
Chris Tate6b391282010-10-14 15:48:59 -070010968 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010969 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070010970 } finally {
10971 surface.unlockCanvasAndPost(canvas);
10972 }
Christopher Tatea53146c2010-09-07 11:57:52 -070010973
Christopher Tate407b4e92010-11-30 17:14:08 -080010974 final ViewRoot root = getViewRoot();
10975
10976 // Cache the local state object for delivery with DragEvents
10977 root.setLocalDragState(myLocalState);
10978
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010979 // repurpose 'shadowSize' for the last touch point
10980 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070010981
Christopher Tatea53146c2010-09-07 11:57:52 -070010982 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080010983 shadowSize.x, shadowSize.y,
10984 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070010985 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tatea53146c2010-09-07 11:57:52 -070010986 }
10987 } catch (Exception e) {
10988 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
10989 surface.destroy();
10990 }
10991
10992 return okay;
10993 }
10994
Christopher Tatea53146c2010-09-07 11:57:52 -070010995 /**
10996 * Drag-and-drop event dispatch. The event.getAction() verb is one of the DragEvent
10997 * constants DRAG_STARTED_EVENT, DRAG_EVENT, DROP_EVENT, and DRAG_ENDED_EVENT.
10998 *
10999 * For DRAG_STARTED_EVENT, event.getClipDescription() describes the content
11000 * being dragged. onDragEvent() should return 'true' if the view can handle
11001 * a drop of that content. A view that returns 'false' here will receive no
11002 * further calls to onDragEvent() about the drag/drop operation.
11003 *
11004 * For DRAG_ENTERED, event.getClipDescription() describes the content being
11005 * dragged. This will be the same content description passed in the
11006 * DRAG_STARTED_EVENT invocation.
11007 *
11008 * For DRAG_EXITED, event.getClipDescription() describes the content being
11009 * dragged. This will be the same content description passed in the
11010 * DRAG_STARTED_EVENT invocation. The view should return to its approriate
11011 * drag-acceptance visual state.
11012 *
11013 * For DRAG_LOCATION_EVENT, event.getX() and event.getY() give the location in View
11014 * coordinates of the current drag point. The view must return 'true' if it
11015 * can accept a drop of the current drag content, false otherwise.
11016 *
11017 * For DROP_EVENT, event.getX() and event.getY() give the location of the drop
11018 * within the view; also, event.getClipData() returns the full data payload
11019 * being dropped. The view should return 'true' if it consumed the dropped
11020 * content, 'false' if it did not.
11021 *
11022 * For DRAG_ENDED_EVENT, the 'event' argument may be null. The view should return
11023 * to its normal visual state.
11024 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070011025 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070011026 return false;
11027 }
11028
11029 /**
11030 * Views typically don't need to override dispatchDragEvent(); it just calls
Chris Tate32affef2010-10-18 15:29:21 -070011031 * onDragEvent(event) and passes the result up appropriately.
Christopher Tatea53146c2010-09-07 11:57:52 -070011032 */
11033 public boolean dispatchDragEvent(DragEvent event) {
Chris Tate32affef2010-10-18 15:29:21 -070011034 if (mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
11035 && mOnDragListener.onDrag(this, event)) {
11036 return true;
11037 }
Christopher Tatea53146c2010-09-07 11:57:52 -070011038 return onDragEvent(event);
11039 }
11040
11041 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070011042 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
11043 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070011044 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070011045 */
11046 public void onCloseSystemDialogs(String reason) {
11047 }
11048
11049 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011050 * Given a Drawable whose bounds have been set to draw into this view,
11051 * update a Region being computed for {@link #gatherTransparentRegion} so
11052 * that any non-transparent parts of the Drawable are removed from the
11053 * given transparent region.
11054 *
11055 * @param dr The Drawable whose transparency is to be applied to the region.
11056 * @param region A Region holding the current transparency information,
11057 * where any parts of the region that are set are considered to be
11058 * transparent. On return, this region will be modified to have the
11059 * transparency information reduced by the corresponding parts of the
11060 * Drawable that are not transparent.
11061 * {@hide}
11062 */
11063 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
11064 if (DBG) {
11065 Log.i("View", "Getting transparent region for: " + this);
11066 }
11067 final Region r = dr.getTransparentRegion();
11068 final Rect db = dr.getBounds();
11069 final AttachInfo attachInfo = mAttachInfo;
11070 if (r != null && attachInfo != null) {
11071 final int w = getRight()-getLeft();
11072 final int h = getBottom()-getTop();
11073 if (db.left > 0) {
11074 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
11075 r.op(0, 0, db.left, h, Region.Op.UNION);
11076 }
11077 if (db.right < w) {
11078 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
11079 r.op(db.right, 0, w, h, Region.Op.UNION);
11080 }
11081 if (db.top > 0) {
11082 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
11083 r.op(0, 0, w, db.top, Region.Op.UNION);
11084 }
11085 if (db.bottom < h) {
11086 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
11087 r.op(0, db.bottom, w, h, Region.Op.UNION);
11088 }
11089 final int[] location = attachInfo.mTransparentLocation;
11090 getLocationInWindow(location);
11091 r.translate(location[0], location[1]);
11092 region.op(r, Region.Op.INTERSECT);
11093 } else {
11094 region.op(db, Region.Op.DIFFERENCE);
11095 }
11096 }
11097
Adam Powelle14579b2009-12-16 18:39:52 -080011098 private void postCheckForLongClick(int delayOffset) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011099 mHasPerformedLongPress = false;
11100
11101 if (mPendingCheckForLongPress == null) {
11102 mPendingCheckForLongPress = new CheckForLongPress();
11103 }
11104 mPendingCheckForLongPress.rememberWindowAttachCount();
Adam Powelle14579b2009-12-16 18:39:52 -080011105 postDelayed(mPendingCheckForLongPress,
11106 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011107 }
11108
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011109 /**
11110 * Inflate a view from an XML resource. This convenience method wraps the {@link
11111 * LayoutInflater} class, which provides a full range of options for view inflation.
11112 *
11113 * @param context The Context object for your activity or application.
11114 * @param resource The resource ID to inflate
11115 * @param root A view group that will be the parent. Used to properly inflate the
11116 * layout_* parameters.
11117 * @see LayoutInflater
11118 */
11119 public static View inflate(Context context, int resource, ViewGroup root) {
11120 LayoutInflater factory = LayoutInflater.from(context);
11121 return factory.inflate(resource, root);
11122 }
Romain Guy33e72ae2010-07-17 12:40:29 -070011123
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011124 /**
Adam Powell637d3372010-08-25 14:37:03 -070011125 * Scroll the view with standard behavior for scrolling beyond the normal
11126 * content boundaries. Views that call this method should override
11127 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
11128 * results of an over-scroll operation.
11129 *
11130 * Views can use this method to handle any touch or fling-based scrolling.
11131 *
11132 * @param deltaX Change in X in pixels
11133 * @param deltaY Change in Y in pixels
11134 * @param scrollX Current X scroll value in pixels before applying deltaX
11135 * @param scrollY Current Y scroll value in pixels before applying deltaY
11136 * @param scrollRangeX Maximum content scroll range along the X axis
11137 * @param scrollRangeY Maximum content scroll range along the Y axis
11138 * @param maxOverScrollX Number of pixels to overscroll by in either direction
11139 * along the X axis.
11140 * @param maxOverScrollY Number of pixels to overscroll by in either direction
11141 * along the Y axis.
11142 * @param isTouchEvent true if this scroll operation is the result of a touch event.
11143 * @return true if scrolling was clamped to an over-scroll boundary along either
11144 * axis, false otherwise.
11145 */
11146 protected boolean overScrollBy(int deltaX, int deltaY,
11147 int scrollX, int scrollY,
11148 int scrollRangeX, int scrollRangeY,
11149 int maxOverScrollX, int maxOverScrollY,
11150 boolean isTouchEvent) {
11151 final int overScrollMode = mOverScrollMode;
11152 final boolean canScrollHorizontal =
11153 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
11154 final boolean canScrollVertical =
11155 computeVerticalScrollRange() > computeVerticalScrollExtent();
11156 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
11157 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
11158 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
11159 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
11160
11161 int newScrollX = scrollX + deltaX;
11162 if (!overScrollHorizontal) {
11163 maxOverScrollX = 0;
11164 }
11165
11166 int newScrollY = scrollY + deltaY;
11167 if (!overScrollVertical) {
11168 maxOverScrollY = 0;
11169 }
11170
11171 // Clamp values if at the limits and record
11172 final int left = -maxOverScrollX;
11173 final int right = maxOverScrollX + scrollRangeX;
11174 final int top = -maxOverScrollY;
11175 final int bottom = maxOverScrollY + scrollRangeY;
11176
11177 boolean clampedX = false;
11178 if (newScrollX > right) {
11179 newScrollX = right;
11180 clampedX = true;
11181 } else if (newScrollX < left) {
11182 newScrollX = left;
11183 clampedX = true;
11184 }
11185
11186 boolean clampedY = false;
11187 if (newScrollY > bottom) {
11188 newScrollY = bottom;
11189 clampedY = true;
11190 } else if (newScrollY < top) {
11191 newScrollY = top;
11192 clampedY = true;
11193 }
11194
11195 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
11196
11197 return clampedX || clampedY;
11198 }
11199
11200 /**
11201 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
11202 * respond to the results of an over-scroll operation.
11203 *
11204 * @param scrollX New X scroll value in pixels
11205 * @param scrollY New Y scroll value in pixels
11206 * @param clampedX True if scrollX was clamped to an over-scroll boundary
11207 * @param clampedY True if scrollY was clamped to an over-scroll boundary
11208 */
11209 protected void onOverScrolled(int scrollX, int scrollY,
11210 boolean clampedX, boolean clampedY) {
11211 // Intentionally empty.
11212 }
11213
11214 /**
11215 * Returns the over-scroll mode for this view. The result will be
11216 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
11217 * (allow over-scrolling only if the view content is larger than the container),
11218 * or {@link #OVER_SCROLL_NEVER}.
11219 *
11220 * @return This view's over-scroll mode.
11221 */
11222 public int getOverScrollMode() {
11223 return mOverScrollMode;
11224 }
11225
11226 /**
11227 * Set the over-scroll mode for this view. Valid over-scroll modes are
11228 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
11229 * (allow over-scrolling only if the view content is larger than the container),
11230 * or {@link #OVER_SCROLL_NEVER}.
11231 *
11232 * Setting the over-scroll mode of a view will have an effect only if the
11233 * view is capable of scrolling.
11234 *
11235 * @param overScrollMode The new over-scroll mode for this view.
11236 */
11237 public void setOverScrollMode(int overScrollMode) {
11238 if (overScrollMode != OVER_SCROLL_ALWAYS &&
11239 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
11240 overScrollMode != OVER_SCROLL_NEVER) {
11241 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
11242 }
11243 mOverScrollMode = overScrollMode;
11244 }
11245
11246 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011247 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
11248 * Each MeasureSpec represents a requirement for either the width or the height.
11249 * A MeasureSpec is comprised of a size and a mode. There are three possible
11250 * modes:
11251 * <dl>
11252 * <dt>UNSPECIFIED</dt>
11253 * <dd>
11254 * The parent has not imposed any constraint on the child. It can be whatever size
11255 * it wants.
11256 * </dd>
11257 *
11258 * <dt>EXACTLY</dt>
11259 * <dd>
11260 * The parent has determined an exact size for the child. The child is going to be
11261 * given those bounds regardless of how big it wants to be.
11262 * </dd>
11263 *
11264 * <dt>AT_MOST</dt>
11265 * <dd>
11266 * The child can be as large as it wants up to the specified size.
11267 * </dd>
11268 * </dl>
11269 *
11270 * MeasureSpecs are implemented as ints to reduce object allocation. This class
11271 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
11272 */
11273 public static class MeasureSpec {
11274 private static final int MODE_SHIFT = 30;
11275 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
11276
11277 /**
11278 * Measure specification mode: The parent has not imposed any constraint
11279 * on the child. It can be whatever size it wants.
11280 */
11281 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
11282
11283 /**
11284 * Measure specification mode: The parent has determined an exact size
11285 * for the child. The child is going to be given those bounds regardless
11286 * of how big it wants to be.
11287 */
11288 public static final int EXACTLY = 1 << MODE_SHIFT;
11289
11290 /**
11291 * Measure specification mode: The child can be as large as it wants up
11292 * to the specified size.
11293 */
11294 public static final int AT_MOST = 2 << MODE_SHIFT;
11295
11296 /**
11297 * Creates a measure specification based on the supplied size and mode.
11298 *
11299 * The mode must always be one of the following:
11300 * <ul>
11301 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
11302 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
11303 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
11304 * </ul>
11305 *
11306 * @param size the size of the measure specification
11307 * @param mode the mode of the measure specification
11308 * @return the measure specification based on size and mode
11309 */
11310 public static int makeMeasureSpec(int size, int mode) {
11311 return size + mode;
11312 }
11313
11314 /**
11315 * Extracts the mode from the supplied measure specification.
11316 *
11317 * @param measureSpec the measure specification to extract the mode from
11318 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
11319 * {@link android.view.View.MeasureSpec#AT_MOST} or
11320 * {@link android.view.View.MeasureSpec#EXACTLY}
11321 */
11322 public static int getMode(int measureSpec) {
11323 return (measureSpec & MODE_MASK);
11324 }
11325
11326 /**
11327 * Extracts the size from the supplied measure specification.
11328 *
11329 * @param measureSpec the measure specification to extract the size from
11330 * @return the size in pixels defined in the supplied measure specification
11331 */
11332 public static int getSize(int measureSpec) {
11333 return (measureSpec & ~MODE_MASK);
11334 }
11335
11336 /**
11337 * Returns a String representation of the specified measure
11338 * specification.
11339 *
11340 * @param measureSpec the measure specification to convert to a String
11341 * @return a String with the following format: "MeasureSpec: MODE SIZE"
11342 */
11343 public static String toString(int measureSpec) {
11344 int mode = getMode(measureSpec);
11345 int size = getSize(measureSpec);
11346
11347 StringBuilder sb = new StringBuilder("MeasureSpec: ");
11348
11349 if (mode == UNSPECIFIED)
11350 sb.append("UNSPECIFIED ");
11351 else if (mode == EXACTLY)
11352 sb.append("EXACTLY ");
11353 else if (mode == AT_MOST)
11354 sb.append("AT_MOST ");
11355 else
11356 sb.append(mode).append(" ");
11357
11358 sb.append(size);
11359 return sb.toString();
11360 }
11361 }
11362
11363 class CheckForLongPress implements Runnable {
11364
11365 private int mOriginalWindowAttachCount;
11366
11367 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070011368 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011369 && mOriginalWindowAttachCount == mWindowAttachCount) {
11370 if (performLongClick()) {
11371 mHasPerformedLongPress = true;
11372 }
11373 }
11374 }
11375
11376 public void rememberWindowAttachCount() {
11377 mOriginalWindowAttachCount = mWindowAttachCount;
11378 }
11379 }
Adam Powelle14579b2009-12-16 18:39:52 -080011380
11381 private final class CheckForTap implements Runnable {
11382 public void run() {
11383 mPrivateFlags &= ~PREPRESSED;
11384 mPrivateFlags |= PRESSED;
11385 refreshDrawableState();
11386 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
11387 postCheckForLongClick(ViewConfiguration.getTapTimeout());
11388 }
11389 }
11390 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011391
Adam Powella35d7682010-03-12 14:48:13 -080011392 private final class PerformClick implements Runnable {
11393 public void run() {
11394 performClick();
11395 }
11396 }
11397
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011398 /**
11399 * Interface definition for a callback to be invoked when a key event is
11400 * dispatched to this view. The callback will be invoked before the key
11401 * event is given to the view.
11402 */
11403 public interface OnKeyListener {
11404 /**
11405 * Called when a key is dispatched to a view. This allows listeners to
11406 * get a chance to respond before the target view.
11407 *
11408 * @param v The view the key has been dispatched to.
11409 * @param keyCode The code for the physical key that was pressed
11410 * @param event The KeyEvent object containing full information about
11411 * the event.
11412 * @return True if the listener has consumed the event, false otherwise.
11413 */
11414 boolean onKey(View v, int keyCode, KeyEvent event);
11415 }
11416
11417 /**
11418 * Interface definition for a callback to be invoked when a touch event is
11419 * dispatched to this view. The callback will be invoked before the touch
11420 * event is given to the view.
11421 */
11422 public interface OnTouchListener {
11423 /**
11424 * Called when a touch event is dispatched to a view. This allows listeners to
11425 * get a chance to respond before the target view.
11426 *
11427 * @param v The view the touch event has been dispatched to.
11428 * @param event The MotionEvent object containing full information about
11429 * the event.
11430 * @return True if the listener has consumed the event, false otherwise.
11431 */
11432 boolean onTouch(View v, MotionEvent event);
11433 }
11434
11435 /**
11436 * Interface definition for a callback to be invoked when a view has been clicked and held.
11437 */
11438 public interface OnLongClickListener {
11439 /**
11440 * Called when a view has been clicked and held.
11441 *
11442 * @param v The view that was clicked and held.
11443 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080011444 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011445 */
11446 boolean onLongClick(View v);
11447 }
11448
11449 /**
Chris Tate32affef2010-10-18 15:29:21 -070011450 * Interface definition for a callback to be invoked when a drag is being dispatched
11451 * to this view. The callback will be invoked before the hosting view's own
11452 * onDrag(event) method. If the listener wants to fall back to the hosting view's
11453 * onDrag(event) behavior, it should return 'false' from this callback.
11454 */
11455 public interface OnDragListener {
11456 /**
11457 * Called when a drag event is dispatched to a view. This allows listeners
11458 * to get a chance to override base View behavior.
11459 *
11460 * @param v The view the drag has been dispatched to.
11461 * @param event The DragEvent object containing full information
11462 * about the event.
11463 * @return true if the listener consumed the DragEvent, false in order to fall
11464 * back to the view's default handling.
11465 */
11466 boolean onDrag(View v, DragEvent event);
11467 }
11468
11469 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011470 * Interface definition for a callback to be invoked when the focus state of
11471 * a view changed.
11472 */
11473 public interface OnFocusChangeListener {
11474 /**
11475 * Called when the focus state of a view has changed.
11476 *
11477 * @param v The view whose state has changed.
11478 * @param hasFocus The new focus state of v.
11479 */
11480 void onFocusChange(View v, boolean hasFocus);
11481 }
11482
11483 /**
11484 * Interface definition for a callback to be invoked when a view is clicked.
11485 */
11486 public interface OnClickListener {
11487 /**
11488 * Called when a view has been clicked.
11489 *
11490 * @param v The view that was clicked.
11491 */
11492 void onClick(View v);
11493 }
11494
11495 /**
11496 * Interface definition for a callback to be invoked when the context menu
11497 * for this view is being built.
11498 */
11499 public interface OnCreateContextMenuListener {
11500 /**
11501 * Called when the context menu for this view is being built. It is not
11502 * safe to hold onto the menu after this method returns.
11503 *
11504 * @param menu The context menu that is being built
11505 * @param v The view for which the context menu is being built
11506 * @param menuInfo Extra information about the item for which the
11507 * context menu should be shown. This information will vary
11508 * depending on the class of v.
11509 */
11510 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
11511 }
11512
Joe Onorato664644d2011-01-23 17:53:23 -080011513 /**
11514 * Interface definition for a callback to be invoked when the status bar changes
11515 * visibility.
11516 *
11517 * @see #setOnSystemUiVisibilityChangeListener
11518 */
11519 public interface OnSystemUiVisibilityChangeListener {
11520 /**
11521 * Called when the status bar changes visibility because of a call to
11522 * {@link #setSystemUiVisibility}.
11523 *
11524 * @param visibility {@link #STATUS_BAR_VISIBLE} or {@link #STATUS_BAR_HIDDEN}.
11525 */
11526 public void onSystemUiVisibilityChange(int visibility);
11527 }
11528
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011529 private final class UnsetPressedState implements Runnable {
11530 public void run() {
11531 setPressed(false);
11532 }
11533 }
11534
11535 /**
11536 * Base class for derived classes that want to save and restore their own
11537 * state in {@link android.view.View#onSaveInstanceState()}.
11538 */
11539 public static class BaseSavedState extends AbsSavedState {
11540 /**
11541 * Constructor used when reading from a parcel. Reads the state of the superclass.
11542 *
11543 * @param source
11544 */
11545 public BaseSavedState(Parcel source) {
11546 super(source);
11547 }
11548
11549 /**
11550 * Constructor called by derived classes when creating their SavedState objects
11551 *
11552 * @param superState The state of the superclass of this view
11553 */
11554 public BaseSavedState(Parcelable superState) {
11555 super(superState);
11556 }
11557
11558 public static final Parcelable.Creator<BaseSavedState> CREATOR =
11559 new Parcelable.Creator<BaseSavedState>() {
11560 public BaseSavedState createFromParcel(Parcel in) {
11561 return new BaseSavedState(in);
11562 }
11563
11564 public BaseSavedState[] newArray(int size) {
11565 return new BaseSavedState[size];
11566 }
11567 };
11568 }
11569
11570 /**
11571 * A set of information given to a view when it is attached to its parent
11572 * window.
11573 */
11574 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011575 interface Callbacks {
11576 void playSoundEffect(int effectId);
11577 boolean performHapticFeedback(int effectId, boolean always);
11578 }
11579
11580 /**
11581 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
11582 * to a Handler. This class contains the target (View) to invalidate and
11583 * the coordinates of the dirty rectangle.
11584 *
11585 * For performance purposes, this class also implements a pool of up to
11586 * POOL_LIMIT objects that get reused. This reduces memory allocations
11587 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011588 */
Romain Guyd928d682009-03-31 17:52:16 -070011589 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011590 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070011591 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
11592 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070011593 public InvalidateInfo newInstance() {
11594 return new InvalidateInfo();
11595 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011596
Romain Guyd928d682009-03-31 17:52:16 -070011597 public void onAcquired(InvalidateInfo element) {
11598 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011599
Romain Guyd928d682009-03-31 17:52:16 -070011600 public void onReleased(InvalidateInfo element) {
11601 }
11602 }, POOL_LIMIT)
11603 );
11604
11605 private InvalidateInfo mNext;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011606
11607 View target;
11608
11609 int left;
11610 int top;
11611 int right;
11612 int bottom;
11613
Romain Guyd928d682009-03-31 17:52:16 -070011614 public void setNextPoolable(InvalidateInfo element) {
11615 mNext = element;
11616 }
11617
11618 public InvalidateInfo getNextPoolable() {
11619 return mNext;
11620 }
11621
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011622 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070011623 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011624 }
11625
11626 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070011627 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011628 }
11629 }
11630
11631 final IWindowSession mSession;
11632
11633 final IWindow mWindow;
11634
11635 final IBinder mWindowToken;
11636
11637 final Callbacks mRootCallbacks;
11638
Chet Haasedaf98e92011-01-10 14:10:36 -080011639 Canvas mHardwareCanvas;
11640
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011641 /**
11642 * The top view of the hierarchy.
11643 */
11644 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070011645
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011646 IBinder mPanelParentWindowToken;
11647 Surface mSurface;
11648
Romain Guyb051e892010-09-28 19:09:36 -070011649 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011650 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070011651 HardwareRenderer mHardwareRenderer;
Romain Guy2bffd262010-09-12 17:40:02 -070011652
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011653 /**
Romain Guy8506ab42009-06-11 17:35:47 -070011654 * Scale factor used by the compatibility mode
11655 */
11656 float mApplicationScale;
11657
11658 /**
11659 * Indicates whether the application is in compatibility mode
11660 */
11661 boolean mScalingRequired;
11662
11663 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011664 * Left position of this view's window
11665 */
11666 int mWindowLeft;
11667
11668 /**
11669 * Top position of this view's window
11670 */
11671 int mWindowTop;
11672
11673 /**
Adam Powell26153a32010-11-08 15:22:27 -080011674 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070011675 */
Adam Powell26153a32010-11-08 15:22:27 -080011676 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070011677
11678 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011679 * For windows that are full-screen but using insets to layout inside
11680 * of the screen decorations, these are the current insets for the
11681 * content of the window.
11682 */
11683 final Rect mContentInsets = new Rect();
11684
11685 /**
11686 * For windows that are full-screen but using insets to layout inside
11687 * of the screen decorations, these are the current insets for the
11688 * actual visible parts of the window.
11689 */
11690 final Rect mVisibleInsets = new Rect();
11691
11692 /**
11693 * The internal insets given by this window. This value is
11694 * supplied by the client (through
11695 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
11696 * be given to the window manager when changed to be used in laying
11697 * out windows behind it.
11698 */
11699 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
11700 = new ViewTreeObserver.InternalInsetsInfo();
11701
11702 /**
11703 * All views in the window's hierarchy that serve as scroll containers,
11704 * used to determine if the window can be resized or must be panned
11705 * to adjust for a soft input area.
11706 */
11707 final ArrayList<View> mScrollContainers = new ArrayList<View>();
11708
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070011709 final KeyEvent.DispatcherState mKeyDispatchState
11710 = new KeyEvent.DispatcherState();
11711
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011712 /**
11713 * Indicates whether the view's window currently has the focus.
11714 */
11715 boolean mHasWindowFocus;
11716
11717 /**
11718 * The current visibility of the window.
11719 */
11720 int mWindowVisibility;
11721
11722 /**
11723 * Indicates the time at which drawing started to occur.
11724 */
11725 long mDrawingTime;
11726
11727 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070011728 * Indicates whether or not ignoring the DIRTY_MASK flags.
11729 */
11730 boolean mIgnoreDirtyState;
11731
11732 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011733 * Indicates whether the view's window is currently in touch mode.
11734 */
11735 boolean mInTouchMode;
11736
11737 /**
11738 * Indicates that ViewRoot should trigger a global layout change
11739 * the next time it performs a traversal
11740 */
11741 boolean mRecomputeGlobalAttributes;
11742
11743 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011744 * Set during a traveral if any views want to keep the screen on.
11745 */
11746 boolean mKeepScreenOn;
11747
11748 /**
Joe Onorato664644d2011-01-23 17:53:23 -080011749 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility().
11750 */
11751 int mSystemUiVisibility;
11752
11753 /**
11754 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener
11755 * attached.
11756 */
11757 boolean mHasSystemUiListeners;
11758
11759 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011760 * Set if the visibility of any views has changed.
11761 */
11762 boolean mViewVisibilityChanged;
11763
11764 /**
11765 * Set to true if a view has been scrolled.
11766 */
11767 boolean mViewScrollChanged;
11768
11769 /**
11770 * Global to the view hierarchy used as a temporary for dealing with
11771 * x/y points in the transparent region computations.
11772 */
11773 final int[] mTransparentLocation = new int[2];
11774
11775 /**
11776 * Global to the view hierarchy used as a temporary for dealing with
11777 * x/y points in the ViewGroup.invalidateChild implementation.
11778 */
11779 final int[] mInvalidateChildLocation = new int[2];
11780
Chet Haasec3aa3612010-06-17 08:50:37 -070011781
11782 /**
11783 * Global to the view hierarchy used as a temporary for dealing with
11784 * x/y location when view is transformed.
11785 */
11786 final float[] mTmpTransformLocation = new float[2];
11787
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011788 /**
11789 * The view tree observer used to dispatch global events like
11790 * layout, pre-draw, touch mode change, etc.
11791 */
11792 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
11793
11794 /**
11795 * A Canvas used by the view hierarchy to perform bitmap caching.
11796 */
11797 Canvas mCanvas;
11798
11799 /**
11800 * A Handler supplied by a view's {@link android.view.ViewRoot}. This
11801 * handler can be used to pump events in the UI events queue.
11802 */
11803 final Handler mHandler;
11804
11805 /**
11806 * Identifier for messages requesting the view to be invalidated.
11807 * Such messages should be sent to {@link #mHandler}.
11808 */
11809 static final int INVALIDATE_MSG = 0x1;
11810
11811 /**
11812 * Identifier for messages requesting the view to invalidate a region.
11813 * Such messages should be sent to {@link #mHandler}.
11814 */
11815 static final int INVALIDATE_RECT_MSG = 0x2;
11816
11817 /**
11818 * Temporary for use in computing invalidate rectangles while
11819 * calling up the hierarchy.
11820 */
11821 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070011822
11823 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070011824 * Temporary for use in computing hit areas with transformed views
11825 */
11826 final RectF mTmpTransformRect = new RectF();
11827
11828 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070011829 * Temporary list for use in collecting focusable descendents of a view.
11830 */
11831 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24);
11832
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011833 /**
11834 * Creates a new set of attachment information with the specified
11835 * events handler and thread.
11836 *
11837 * @param handler the events handler the view must use
11838 */
11839 AttachInfo(IWindowSession session, IWindow window,
11840 Handler handler, Callbacks effectPlayer) {
11841 mSession = session;
11842 mWindow = window;
11843 mWindowToken = window.asBinder();
11844 mHandler = handler;
11845 mRootCallbacks = effectPlayer;
11846 }
11847 }
11848
11849 /**
11850 * <p>ScrollabilityCache holds various fields used by a View when scrolling
11851 * is supported. This avoids keeping too many unused fields in most
11852 * instances of View.</p>
11853 */
Mike Cleronf116bf82009-09-27 19:14:12 -070011854 private static class ScrollabilityCache implements Runnable {
11855
11856 /**
11857 * Scrollbars are not visible
11858 */
11859 public static final int OFF = 0;
11860
11861 /**
11862 * Scrollbars are visible
11863 */
11864 public static final int ON = 1;
11865
11866 /**
11867 * Scrollbars are fading away
11868 */
11869 public static final int FADING = 2;
11870
11871 public boolean fadeScrollBars;
11872
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011873 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070011874 public int scrollBarDefaultDelayBeforeFade;
11875 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011876
11877 public int scrollBarSize;
11878 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070011879 public float[] interpolatorValues;
11880 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011881
11882 public final Paint paint;
11883 public final Matrix matrix;
11884 public Shader shader;
11885
Mike Cleronf116bf82009-09-27 19:14:12 -070011886 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
11887
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080011888 private static final float[] OPAQUE = { 255 };
11889 private static final float[] TRANSPARENT = { 0.0f };
Mike Cleronf116bf82009-09-27 19:14:12 -070011890
11891 /**
11892 * When fading should start. This time moves into the future every time
11893 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
11894 */
11895 public long fadeStartTime;
11896
11897
11898 /**
11899 * The current state of the scrollbars: ON, OFF, or FADING
11900 */
11901 public int state = OFF;
11902
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011903 private int mLastColor;
11904
Mike Cleronf116bf82009-09-27 19:14:12 -070011905 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011906 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
11907 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070011908 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
11909 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011910
11911 paint = new Paint();
11912 matrix = new Matrix();
11913 // use use a height of 1, and then wack the matrix each time we
11914 // actually use it.
11915 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070011916
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011917 paint.setShader(shader);
11918 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070011919 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011920 }
Romain Guy8506ab42009-06-11 17:35:47 -070011921
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011922 public void setFadeColor(int color) {
11923 if (color != 0 && color != mLastColor) {
11924 mLastColor = color;
11925 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070011926
Romain Guye55e1a72009-08-27 10:42:26 -070011927 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
11928 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070011929
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011930 paint.setShader(shader);
11931 // Restore the default transfer mode (src_over)
11932 paint.setXfermode(null);
11933 }
11934 }
Mike Cleronf116bf82009-09-27 19:14:12 -070011935
11936 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070011937 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070011938 if (now >= fadeStartTime) {
11939
11940 // the animation fades the scrollbars out by changing
11941 // the opacity (alpha) from fully opaque to fully
11942 // transparent
11943 int nextFrame = (int) now;
11944 int framesCount = 0;
11945
11946 Interpolator interpolator = scrollBarInterpolator;
11947
11948 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080011949 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070011950
11951 // End transparent
11952 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080011953 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070011954
11955 state = FADING;
11956
11957 // Kick off the fade animation
Romain Guy0fd89bf2011-01-26 15:41:30 -080011958 host.invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -070011959 }
11960 }
11961
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011962 }
11963}