blob: 472f7b4d0c7e4053f3a7fafb3c28c26d07390a3d [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
Christopher Tatea53146c2010-09-07 11:57:52 -070019import android.content.ClipData;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080020import android.content.Context;
Dianne Hackborne36d6e22010-02-17 19:46:25 -080021import android.content.res.Configuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080022import android.content.res.Resources;
23import android.content.res.TypedArray;
24import android.graphics.Bitmap;
Adam Powell2b342f02010-08-18 18:14:13 -070025import android.graphics.Camera;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080026import android.graphics.Canvas;
Mike Cleronf116bf82009-09-27 19:14:12 -070027import android.graphics.Interpolator;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080028import android.graphics.LinearGradient;
29import android.graphics.Matrix;
30import android.graphics.Paint;
31import android.graphics.PixelFormat;
svetoslavganov75986cf2009-05-14 22:28:01 -070032import android.graphics.Point;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080033import android.graphics.PorterDuff;
34import android.graphics.PorterDuffXfermode;
35import android.graphics.Rect;
Adam Powell6e346362010-07-23 10:18:23 -070036import android.graphics.RectF;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080037import android.graphics.Region;
38import android.graphics.Shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080039import android.graphics.drawable.ColorDrawable;
40import android.graphics.drawable.Drawable;
41import android.os.Handler;
42import android.os.IBinder;
43import android.os.Message;
44import android.os.Parcel;
45import android.os.Parcelable;
46import android.os.RemoteException;
47import android.os.SystemClock;
48import android.os.SystemProperties;
49import android.util.AttributeSet;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080050import android.util.Log;
Romain Guyd928d682009-03-31 17:52:16 -070051import android.util.Pool;
svetoslavganov75986cf2009-05-14 22:28:01 -070052import android.util.Poolable;
Romain Guyd928d682009-03-31 17:52:16 -070053import android.util.PoolableManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070054import android.util.Pools;
55import android.util.SparseArray;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080056import android.view.ContextMenu.ContextMenuInfo;
svetoslavganov75986cf2009-05-14 22:28:01 -070057import android.view.accessibility.AccessibilityEvent;
58import android.view.accessibility.AccessibilityEventSource;
59import android.view.accessibility.AccessibilityManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080060import android.view.animation.Animation;
Mike Cleron3ecd58c2009-09-28 11:39:02 -070061import android.view.animation.AnimationUtils;
svetoslavganov75986cf2009-05-14 22:28:01 -070062import android.view.inputmethod.EditorInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080063import android.view.inputmethod.InputConnection;
64import android.view.inputmethod.InputMethodManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080065import android.widget.ScrollBarDrawable;
Romain Guyf607bdc2010-09-10 19:20:06 -070066import com.android.internal.R;
67import com.android.internal.view.menu.MenuBuilder;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080068
Christopher Tatea0374192010-10-05 13:06:41 -070069import java.lang.ref.WeakReference;
svetoslavganov75986cf2009-05-14 22:28:01 -070070import java.lang.reflect.InvocationTargetException;
71import java.lang.reflect.Method;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080072import java.util.ArrayList;
73import java.util.Arrays;
Chet Haase21cd1382010-09-01 17:42:29 -070074import java.util.List;
Romain Guyd90a3312009-05-06 14:54:28 -070075import java.util.WeakHashMap;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080076
77/**
78 * <p>
79 * This class represents the basic building block for user interface components. A View
80 * occupies a rectangular area on the screen and is responsible for drawing and
81 * event handling. View is the base class for <em>widgets</em>, which are
Romain Guy8506ab42009-06-11 17:35:47 -070082 * used to create interactive UI components (buttons, text fields, etc.). The
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080083 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which
84 * are invisible containers that hold other Views (or other ViewGroups) and define
85 * their layout properties.
86 * </p>
87 *
88 * <div class="special">
Romain Guy8506ab42009-06-11 17:35:47 -070089 * <p>For an introduction to using this class to develop your
90 * application's user interface, read the Developer Guide documentation on
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080091 * <strong><a href="{@docRoot}guide/topics/ui/index.html">User Interface</a></strong>. Special topics
Romain Guy8506ab42009-06-11 17:35:47 -070092 * include:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080093 * <br/><a href="{@docRoot}guide/topics/ui/declaring-layout.html">Declaring Layout</a>
94 * <br/><a href="{@docRoot}guide/topics/ui/menus.html">Creating Menus</a>
95 * <br/><a href="{@docRoot}guide/topics/ui/layout-objects.html">Common Layout Objects</a>
96 * <br/><a href="{@docRoot}guide/topics/ui/binding.html">Binding to Data with AdapterView</a>
97 * <br/><a href="{@docRoot}guide/topics/ui/ui-events.html">Handling UI Events</a>
98 * <br/><a href="{@docRoot}guide/topics/ui/themes.html">Applying Styles and Themes</a>
99 * <br/><a href="{@docRoot}guide/topics/ui/custom-components.html">Building Custom Components</a>
100 * <br/><a href="{@docRoot}guide/topics/ui/how-android-draws.html">How Android Draws Views</a>.
101 * </p>
102 * </div>
Romain Guy8506ab42009-06-11 17:35:47 -0700103 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800104 * <a name="Using"></a>
105 * <h3>Using Views</h3>
106 * <p>
107 * All of the views in a window are arranged in a single tree. You can add views
108 * either from code or by specifying a tree of views in one or more XML layout
109 * files. There are many specialized subclasses of views that act as controls or
110 * are capable of displaying text, images, or other content.
111 * </p>
112 * <p>
113 * Once you have created a tree of views, there are typically a few types of
114 * common operations you may wish to perform:
115 * <ul>
116 * <li><strong>Set properties:</strong> for example setting the text of a
117 * {@link android.widget.TextView}. The available properties and the methods
118 * that set them will vary among the different subclasses of views. Note that
119 * properties that are known at build time can be set in the XML layout
120 * files.</li>
121 * <li><strong>Set focus:</strong> The framework will handled moving focus in
122 * response to user input. To force focus to a specific view, call
123 * {@link #requestFocus}.</li>
124 * <li><strong>Set up listeners:</strong> Views allow clients to set listeners
125 * that will be notified when something interesting happens to the view. For
126 * example, all views will let you set a listener to be notified when the view
127 * gains or loses focus. You can register such a listener using
128 * {@link #setOnFocusChangeListener}. Other view subclasses offer more
129 * specialized listeners. For example, a Button exposes a listener to notify
130 * clients when the button is clicked.</li>
131 * <li><strong>Set visibility:</strong> You can hide or show views using
132 * {@link #setVisibility}.</li>
133 * </ul>
134 * </p>
135 * <p><em>
136 * Note: The Android framework is responsible for measuring, laying out and
137 * drawing views. You should not call methods that perform these actions on
138 * views yourself unless you are actually implementing a
139 * {@link android.view.ViewGroup}.
140 * </em></p>
141 *
142 * <a name="Lifecycle"></a>
143 * <h3>Implementing a Custom View</h3>
144 *
145 * <p>
146 * To implement a custom view, you will usually begin by providing overrides for
147 * some of the standard methods that the framework calls on all views. You do
148 * not need to override all of these methods. In fact, you can start by just
149 * overriding {@link #onDraw(android.graphics.Canvas)}.
150 * <table border="2" width="85%" align="center" cellpadding="5">
151 * <thead>
152 * <tr><th>Category</th> <th>Methods</th> <th>Description</th></tr>
153 * </thead>
154 *
155 * <tbody>
156 * <tr>
157 * <td rowspan="2">Creation</td>
158 * <td>Constructors</td>
159 * <td>There is a form of the constructor that are called when the view
160 * is created from code and a form that is called when the view is
161 * inflated from a layout file. The second form should parse and apply
162 * any attributes defined in the layout file.
163 * </td>
164 * </tr>
165 * <tr>
166 * <td><code>{@link #onFinishInflate()}</code></td>
167 * <td>Called after a view and all of its children has been inflated
168 * from XML.</td>
169 * </tr>
170 *
171 * <tr>
172 * <td rowspan="3">Layout</td>
173 * <td><code>{@link #onMeasure}</code></td>
174 * <td>Called to determine the size requirements for this view and all
175 * of its children.
176 * </td>
177 * </tr>
178 * <tr>
179 * <td><code>{@link #onLayout}</code></td>
180 * <td>Called when this view should assign a size and position to all
181 * of its children.
182 * </td>
183 * </tr>
184 * <tr>
185 * <td><code>{@link #onSizeChanged}</code></td>
186 * <td>Called when the size of this view has changed.
187 * </td>
188 * </tr>
189 *
190 * <tr>
191 * <td>Drawing</td>
192 * <td><code>{@link #onDraw}</code></td>
193 * <td>Called when the view should render its content.
194 * </td>
195 * </tr>
196 *
197 * <tr>
198 * <td rowspan="4">Event processing</td>
199 * <td><code>{@link #onKeyDown}</code></td>
200 * <td>Called when a new key event occurs.
201 * </td>
202 * </tr>
203 * <tr>
204 * <td><code>{@link #onKeyUp}</code></td>
205 * <td>Called when a key up event occurs.
206 * </td>
207 * </tr>
208 * <tr>
209 * <td><code>{@link #onTrackballEvent}</code></td>
210 * <td>Called when a trackball motion event occurs.
211 * </td>
212 * </tr>
213 * <tr>
214 * <td><code>{@link #onTouchEvent}</code></td>
215 * <td>Called when a touch screen motion event occurs.
216 * </td>
217 * </tr>
218 *
219 * <tr>
220 * <td rowspan="2">Focus</td>
221 * <td><code>{@link #onFocusChanged}</code></td>
222 * <td>Called when the view gains or loses focus.
223 * </td>
224 * </tr>
225 *
226 * <tr>
227 * <td><code>{@link #onWindowFocusChanged}</code></td>
228 * <td>Called when the window containing the view gains or loses focus.
229 * </td>
230 * </tr>
231 *
232 * <tr>
233 * <td rowspan="3">Attaching</td>
234 * <td><code>{@link #onAttachedToWindow()}</code></td>
235 * <td>Called when the view is attached to a window.
236 * </td>
237 * </tr>
238 *
239 * <tr>
240 * <td><code>{@link #onDetachedFromWindow}</code></td>
241 * <td>Called when the view is detached from its window.
242 * </td>
243 * </tr>
244 *
245 * <tr>
246 * <td><code>{@link #onWindowVisibilityChanged}</code></td>
247 * <td>Called when the visibility of the window containing the view
248 * has changed.
249 * </td>
250 * </tr>
251 * </tbody>
252 *
253 * </table>
254 * </p>
255 *
256 * <a name="IDs"></a>
257 * <h3>IDs</h3>
258 * Views may have an integer id associated with them. These ids are typically
259 * assigned in the layout XML files, and are used to find specific views within
260 * the view tree. A common pattern is to:
261 * <ul>
262 * <li>Define a Button in the layout file and assign it a unique ID.
263 * <pre>
Gilles Debunne0243caf2010-08-24 23:06:35 -0700264 * &lt;Button
265 * android:id="@+id/my_button"
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800266 * android:layout_width="wrap_content"
267 * android:layout_height="wrap_content"
268 * android:text="@string/my_button_text"/&gt;
269 * </pre></li>
270 * <li>From the onCreate method of an Activity, find the Button
271 * <pre class="prettyprint">
272 * Button myButton = (Button) findViewById(R.id.my_button);
273 * </pre></li>
274 * </ul>
275 * <p>
276 * View IDs need not be unique throughout the tree, but it is good practice to
277 * ensure that they are at least unique within the part of the tree you are
278 * searching.
279 * </p>
280 *
281 * <a name="Position"></a>
282 * <h3>Position</h3>
283 * <p>
284 * The geometry of a view is that of a rectangle. A view has a location,
285 * expressed as a pair of <em>left</em> and <em>top</em> coordinates, and
286 * two dimensions, expressed as a width and a height. The unit for location
287 * and dimensions is the pixel.
288 * </p>
289 *
290 * <p>
291 * It is possible to retrieve the location of a view by invoking the methods
292 * {@link #getLeft()} and {@link #getTop()}. The former returns the left, or X,
293 * coordinate of the rectangle representing the view. The latter returns the
294 * top, or Y, coordinate of the rectangle representing the view. These methods
295 * both return the location of the view relative to its parent. For instance,
296 * when getLeft() returns 20, that means the view is located 20 pixels to the
297 * right of the left edge of its direct parent.
298 * </p>
299 *
300 * <p>
301 * In addition, several convenience methods are offered to avoid unnecessary
302 * computations, namely {@link #getRight()} and {@link #getBottom()}.
303 * These methods return the coordinates of the right and bottom edges of the
304 * rectangle representing the view. For instance, calling {@link #getRight()}
305 * is similar to the following computation: <code>getLeft() + getWidth()</code>
306 * (see <a href="#SizePaddingMargins">Size</a> for more information about the width.)
307 * </p>
308 *
309 * <a name="SizePaddingMargins"></a>
310 * <h3>Size, padding and margins</h3>
311 * <p>
312 * The size of a view is expressed with a width and a height. A view actually
313 * possess two pairs of width and height values.
314 * </p>
315 *
316 * <p>
317 * The first pair is known as <em>measured width</em> and
318 * <em>measured height</em>. These dimensions define how big a view wants to be
319 * within its parent (see <a href="#Layout">Layout</a> for more details.) The
320 * measured dimensions can be obtained by calling {@link #getMeasuredWidth()}
321 * and {@link #getMeasuredHeight()}.
322 * </p>
323 *
324 * <p>
325 * The second pair is simply known as <em>width</em> and <em>height</em>, or
326 * sometimes <em>drawing width</em> and <em>drawing height</em>. These
327 * dimensions define the actual size of the view on screen, at drawing time and
328 * after layout. These values may, but do not have to, be different from the
329 * measured width and height. The width and height can be obtained by calling
330 * {@link #getWidth()} and {@link #getHeight()}.
331 * </p>
332 *
333 * <p>
334 * To measure its dimensions, a view takes into account its padding. The padding
335 * is expressed in pixels for the left, top, right and bottom parts of the view.
336 * Padding can be used to offset the content of the view by a specific amount of
337 * pixels. For instance, a left padding of 2 will push the view's content by
338 * 2 pixels to the right of the left edge. Padding can be set using the
339 * {@link #setPadding(int, int, int, int)} method and queried by calling
340 * {@link #getPaddingLeft()}, {@link #getPaddingTop()},
341 * {@link #getPaddingRight()} and {@link #getPaddingBottom()}.
342 * </p>
343 *
344 * <p>
345 * Even though a view can define a padding, it does not provide any support for
346 * margins. However, view groups provide such a support. Refer to
347 * {@link android.view.ViewGroup} and
348 * {@link android.view.ViewGroup.MarginLayoutParams} for further information.
349 * </p>
350 *
351 * <a name="Layout"></a>
352 * <h3>Layout</h3>
353 * <p>
354 * Layout is a two pass process: a measure pass and a layout pass. The measuring
355 * pass is implemented in {@link #measure(int, int)} and is a top-down traversal
356 * of the view tree. Each view pushes dimension specifications down the tree
357 * during the recursion. At the end of the measure pass, every view has stored
358 * its measurements. The second pass happens in
359 * {@link #layout(int,int,int,int)} and is also top-down. During
360 * this pass each parent is responsible for positioning all of its children
361 * using the sizes computed in the measure pass.
362 * </p>
363 *
364 * <p>
365 * When a view's measure() method returns, its {@link #getMeasuredWidth()} and
366 * {@link #getMeasuredHeight()} values must be set, along with those for all of
367 * that view's descendants. A view's measured width and measured height values
368 * must respect the constraints imposed by the view's parents. This guarantees
369 * that at the end of the measure pass, all parents accept all of their
370 * children's measurements. A parent view may call measure() more than once on
371 * its children. For example, the parent may measure each child once with
372 * unspecified dimensions to find out how big they want to be, then call
373 * measure() on them again with actual numbers if the sum of all the children's
374 * unconstrained sizes is too big or too small.
375 * </p>
376 *
377 * <p>
378 * The measure pass uses two classes to communicate dimensions. The
379 * {@link MeasureSpec} class is used by views to tell their parents how they
380 * want to be measured and positioned. The base LayoutParams class just
381 * describes how big the view wants to be for both width and height. For each
382 * dimension, it can specify one of:
383 * <ul>
384 * <li> an exact number
Romain Guy980a9382010-01-08 15:06:28 -0800385 * <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 -0800386 * (minus padding)
387 * <li> WRAP_CONTENT, which means that the view wants to be just big enough to
388 * enclose its content (plus padding).
389 * </ul>
390 * There are subclasses of LayoutParams for different subclasses of ViewGroup.
391 * For example, AbsoluteLayout has its own subclass of LayoutParams which adds
392 * an X and Y value.
393 * </p>
394 *
395 * <p>
396 * MeasureSpecs are used to push requirements down the tree from parent to
397 * child. A MeasureSpec can be in one of three modes:
398 * <ul>
399 * <li>UNSPECIFIED: This is used by a parent to determine the desired dimension
400 * of a child view. For example, a LinearLayout may call measure() on its child
401 * with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how
402 * tall the child view wants to be given a width of 240 pixels.
403 * <li>EXACTLY: This is used by the parent to impose an exact size on the
404 * child. The child must use this size, and guarantee that all of its
405 * descendants will fit within this size.
406 * <li>AT_MOST: This is used by the parent to impose a maximum size on the
407 * child. The child must gurantee that it and all of its descendants will fit
408 * within this size.
409 * </ul>
410 * </p>
411 *
412 * <p>
413 * To intiate a layout, call {@link #requestLayout}. This method is typically
414 * called by a view on itself when it believes that is can no longer fit within
415 * its current bounds.
416 * </p>
417 *
418 * <a name="Drawing"></a>
419 * <h3>Drawing</h3>
420 * <p>
421 * Drawing is handled by walking the tree and rendering each view that
422 * intersects the the invalid region. Because the tree is traversed in-order,
423 * this means that parents will draw before (i.e., behind) their children, with
424 * siblings drawn in the order they appear in the tree.
425 * If you set a background drawable for a View, then the View will draw it for you
426 * before calling back to its <code>onDraw()</code> method.
427 * </p>
428 *
429 * <p>
Romain Guy8506ab42009-06-11 17:35:47 -0700430 * 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 -0800431 * </p>
432 *
433 * <p>
434 * To force a view to draw, call {@link #invalidate()}.
435 * </p>
436 *
437 * <a name="EventHandlingThreading"></a>
438 * <h3>Event Handling and Threading</h3>
439 * <p>
440 * The basic cycle of a view is as follows:
441 * <ol>
442 * <li>An event comes in and is dispatched to the appropriate view. The view
443 * handles the event and notifies any listeners.</li>
444 * <li>If in the course of processing the event, the view's bounds may need
445 * to be changed, the view will call {@link #requestLayout()}.</li>
446 * <li>Similarly, if in the course of processing the event the view's appearance
447 * may need to be changed, the view will call {@link #invalidate()}.</li>
448 * <li>If either {@link #requestLayout()} or {@link #invalidate()} were called,
449 * the framework will take care of measuring, laying out, and drawing the tree
450 * as appropriate.</li>
451 * </ol>
452 * </p>
453 *
454 * <p><em>Note: The entire view tree is single threaded. You must always be on
455 * the UI thread when calling any method on any view.</em>
456 * If you are doing work on other threads and want to update the state of a view
457 * from that thread, you should use a {@link Handler}.
458 * </p>
459 *
460 * <a name="FocusHandling"></a>
461 * <h3>Focus Handling</h3>
462 * <p>
463 * The framework will handle routine focus movement in response to user input.
464 * This includes changing the focus as views are removed or hidden, or as new
465 * views become available. Views indicate their willingness to take focus
466 * through the {@link #isFocusable} method. To change whether a view can take
467 * focus, call {@link #setFocusable(boolean)}. When in touch mode (see notes below)
468 * views indicate whether they still would like focus via {@link #isFocusableInTouchMode}
469 * and can change this via {@link #setFocusableInTouchMode(boolean)}.
470 * </p>
471 * <p>
472 * Focus movement is based on an algorithm which finds the nearest neighbor in a
473 * given direction. In rare cases, the default algorithm may not match the
474 * intended behavior of the developer. In these situations, you can provide
475 * explicit overrides by using these XML attributes in the layout file:
476 * <pre>
477 * nextFocusDown
478 * nextFocusLeft
479 * nextFocusRight
480 * nextFocusUp
481 * </pre>
482 * </p>
483 *
484 *
485 * <p>
486 * To get a particular view to take focus, call {@link #requestFocus()}.
487 * </p>
488 *
489 * <a name="TouchMode"></a>
490 * <h3>Touch Mode</h3>
491 * <p>
492 * When a user is navigating a user interface via directional keys such as a D-pad, it is
493 * necessary to give focus to actionable items such as buttons so the user can see
494 * what will take input. If the device has touch capabilities, however, and the user
495 * begins interacting with the interface by touching it, it is no longer necessary to
496 * always highlight, or give focus to, a particular view. This motivates a mode
497 * for interaction named 'touch mode'.
498 * </p>
499 * <p>
500 * For a touch capable device, once the user touches the screen, the device
501 * will enter touch mode. From this point onward, only views for which
502 * {@link #isFocusableInTouchMode} is true will be focusable, such as text editing widgets.
503 * Other views that are touchable, like buttons, will not take focus when touched; they will
504 * only fire the on click listeners.
505 * </p>
506 * <p>
507 * Any time a user hits a directional key, such as a D-pad direction, the view device will
508 * exit touch mode, and find a view to take focus, so that the user may resume interacting
509 * with the user interface without touching the screen again.
510 * </p>
511 * <p>
512 * The touch mode state is maintained across {@link android.app.Activity}s. Call
513 * {@link #isInTouchMode} to see whether the device is currently in touch mode.
514 * </p>
515 *
516 * <a name="Scrolling"></a>
517 * <h3>Scrolling</h3>
518 * <p>
519 * The framework provides basic support for views that wish to internally
520 * scroll their content. This includes keeping track of the X and Y scroll
521 * offset as well as mechanisms for drawing scrollbars. See
Mike Cleronf116bf82009-09-27 19:14:12 -0700522 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and
523 * {@link #awakenScrollBars()} for more details.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800524 * </p>
525 *
526 * <a name="Tags"></a>
527 * <h3>Tags</h3>
528 * <p>
529 * Unlike IDs, tags are not used to identify views. Tags are essentially an
530 * extra piece of information that can be associated with a view. They are most
531 * often used as a convenience to store data related to views in the views
532 * themselves rather than by putting them in a separate structure.
533 * </p>
534 *
535 * <a name="Animation"></a>
536 * <h3>Animation</h3>
537 * <p>
538 * You can attach an {@link Animation} object to a view using
539 * {@link #setAnimation(Animation)} or
540 * {@link #startAnimation(Animation)}. The animation can alter the scale,
541 * rotation, translation and alpha of a view over time. If the animation is
542 * attached to a view that has children, the animation will affect the entire
543 * subtree rooted by that node. When an animation is started, the framework will
544 * take care of redrawing the appropriate views until the animation completes.
545 * </p>
546 *
Jeff Brown85a31762010-09-01 17:01:00 -0700547 * <a name="Security"></a>
548 * <h3>Security</h3>
549 * <p>
550 * Sometimes it is essential that an application be able to verify that an action
551 * is being performed with the full knowledge and consent of the user, such as
552 * granting a permission request, making a purchase or clicking on an advertisement.
553 * Unfortunately, a malicious application could try to spoof the user into
554 * performing these actions, unaware, by concealing the intended purpose of the view.
555 * As a remedy, the framework offers a touch filtering mechanism that can be used to
556 * improve the security of views that provide access to sensitive functionality.
557 * </p><p>
558 * To enable touch filtering, call {@link #setFilterTouchesWhenObscured} or set the
559 * andoird:filterTouchesWhenObscured attribute to true. When enabled, the framework
560 * will discard touches that are received whenever the view's window is obscured by
561 * another visible window. As a result, the view will not receive touches whenever a
562 * toast, dialog or other window appears above the view's window.
563 * </p><p>
564 * For more fine-grained control over security, consider overriding the
565 * {@link #onFilterTouchEventForSecurity} method to implement your own security policy.
566 * See also {@link MotionEvent#FLAG_WINDOW_IS_OBSCURED}.
567 * </p>
568 *
Romain Guyd6a463a2009-05-21 23:10:10 -0700569 * @attr ref android.R.styleable#View_background
570 * @attr ref android.R.styleable#View_clickable
571 * @attr ref android.R.styleable#View_contentDescription
572 * @attr ref android.R.styleable#View_drawingCacheQuality
573 * @attr ref android.R.styleable#View_duplicateParentState
574 * @attr ref android.R.styleable#View_id
575 * @attr ref android.R.styleable#View_fadingEdge
576 * @attr ref android.R.styleable#View_fadingEdgeLength
Jeff Brown85a31762010-09-01 17:01:00 -0700577 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800578 * @attr ref android.R.styleable#View_fitsSystemWindows
Romain Guyd6a463a2009-05-21 23:10:10 -0700579 * @attr ref android.R.styleable#View_isScrollContainer
580 * @attr ref android.R.styleable#View_focusable
581 * @attr ref android.R.styleable#View_focusableInTouchMode
582 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
583 * @attr ref android.R.styleable#View_keepScreenOn
584 * @attr ref android.R.styleable#View_longClickable
585 * @attr ref android.R.styleable#View_minHeight
586 * @attr ref android.R.styleable#View_minWidth
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800587 * @attr ref android.R.styleable#View_nextFocusDown
588 * @attr ref android.R.styleable#View_nextFocusLeft
589 * @attr ref android.R.styleable#View_nextFocusRight
590 * @attr ref android.R.styleable#View_nextFocusUp
Romain Guyd6a463a2009-05-21 23:10:10 -0700591 * @attr ref android.R.styleable#View_onClick
592 * @attr ref android.R.styleable#View_padding
593 * @attr ref android.R.styleable#View_paddingBottom
594 * @attr ref android.R.styleable#View_paddingLeft
595 * @attr ref android.R.styleable#View_paddingRight
596 * @attr ref android.R.styleable#View_paddingTop
597 * @attr ref android.R.styleable#View_saveEnabled
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800598 * @attr ref android.R.styleable#View_scrollX
599 * @attr ref android.R.styleable#View_scrollY
Romain Guyd6a463a2009-05-21 23:10:10 -0700600 * @attr ref android.R.styleable#View_scrollbarSize
601 * @attr ref android.R.styleable#View_scrollbarStyle
602 * @attr ref android.R.styleable#View_scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -0700603 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
604 * @attr ref android.R.styleable#View_scrollbarFadeDuration
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800605 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal
606 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800607 * @attr ref android.R.styleable#View_scrollbarThumbVertical
608 * @attr ref android.R.styleable#View_scrollbarTrackVertical
609 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack
610 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack
Romain Guyd6a463a2009-05-21 23:10:10 -0700611 * @attr ref android.R.styleable#View_soundEffectsEnabled
612 * @attr ref android.R.styleable#View_tag
613 * @attr ref android.R.styleable#View_visibility
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800614 *
615 * @see android.view.ViewGroup
616 */
svetoslavganov75986cf2009-05-14 22:28:01 -0700617public class View implements Drawable.Callback, KeyEvent.Callback, AccessibilityEventSource {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800618 private static final boolean DBG = false;
619
620 /**
621 * The logging tag used by this class with android.util.Log.
622 */
623 protected static final String VIEW_LOG_TAG = "View";
624
625 /**
626 * Used to mark a View that has no ID.
627 */
628 public static final int NO_ID = -1;
629
630 /**
631 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when
632 * calling setFlags.
633 */
634 private static final int NOT_FOCUSABLE = 0x00000000;
635
636 /**
637 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling
638 * setFlags.
639 */
640 private static final int FOCUSABLE = 0x00000001;
641
642 /**
643 * Mask for use with setFlags indicating bits used for focus.
644 */
645 private static final int FOCUSABLE_MASK = 0x00000001;
646
647 /**
648 * This view will adjust its padding to fit sytem windows (e.g. status bar)
649 */
650 private static final int FITS_SYSTEM_WINDOWS = 0x00000002;
651
652 /**
653 * This view is visible. Use with {@link #setVisibility}.
654 */
655 public static final int VISIBLE = 0x00000000;
656
657 /**
658 * This view is invisible, but it still takes up space for layout purposes.
659 * Use with {@link #setVisibility}.
660 */
661 public static final int INVISIBLE = 0x00000004;
662
663 /**
664 * This view is invisible, and it doesn't take any space for layout
665 * purposes. Use with {@link #setVisibility}.
666 */
667 public static final int GONE = 0x00000008;
668
669 /**
670 * Mask for use with setFlags indicating bits used for visibility.
671 * {@hide}
672 */
673 static final int VISIBILITY_MASK = 0x0000000C;
674
675 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE};
676
677 /**
678 * This view is enabled. Intrepretation varies by subclass.
679 * Use with ENABLED_MASK when calling setFlags.
680 * {@hide}
681 */
682 static final int ENABLED = 0x00000000;
683
684 /**
685 * This view is disabled. Intrepretation varies by subclass.
686 * Use with ENABLED_MASK when calling setFlags.
687 * {@hide}
688 */
689 static final int DISABLED = 0x00000020;
690
691 /**
692 * Mask for use with setFlags indicating bits used for indicating whether
693 * this view is enabled
694 * {@hide}
695 */
696 static final int ENABLED_MASK = 0x00000020;
697
698 /**
699 * This view won't draw. {@link #onDraw} won't be called and further
700 * optimizations
701 * will be performed. It is okay to have this flag set and a background.
702 * Use with DRAW_MASK when calling setFlags.
703 * {@hide}
704 */
705 static final int WILL_NOT_DRAW = 0x00000080;
706
707 /**
708 * Mask for use with setFlags indicating bits used for indicating whether
709 * this view is will draw
710 * {@hide}
711 */
712 static final int DRAW_MASK = 0x00000080;
713
714 /**
715 * <p>This view doesn't show scrollbars.</p>
716 * {@hide}
717 */
718 static final int SCROLLBARS_NONE = 0x00000000;
719
720 /**
721 * <p>This view shows horizontal scrollbars.</p>
722 * {@hide}
723 */
724 static final int SCROLLBARS_HORIZONTAL = 0x00000100;
725
726 /**
727 * <p>This view shows vertical scrollbars.</p>
728 * {@hide}
729 */
730 static final int SCROLLBARS_VERTICAL = 0x00000200;
731
732 /**
733 * <p>Mask for use with setFlags indicating bits used for indicating which
734 * scrollbars are enabled.</p>
735 * {@hide}
736 */
737 static final int SCROLLBARS_MASK = 0x00000300;
738
Jeff Brown85a31762010-09-01 17:01:00 -0700739 /**
740 * Indicates that the view should filter touches when its window is obscured.
741 * Refer to the class comments for more information about this security feature.
742 * {@hide}
743 */
744 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400;
745
746 // note flag value 0x00000800 is now available for next flags...
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800747
748 /**
749 * <p>This view doesn't show fading edges.</p>
750 * {@hide}
751 */
752 static final int FADING_EDGE_NONE = 0x00000000;
753
754 /**
755 * <p>This view shows horizontal fading edges.</p>
756 * {@hide}
757 */
758 static final int FADING_EDGE_HORIZONTAL = 0x00001000;
759
760 /**
761 * <p>This view shows vertical fading edges.</p>
762 * {@hide}
763 */
764 static final int FADING_EDGE_VERTICAL = 0x00002000;
765
766 /**
767 * <p>Mask for use with setFlags indicating bits used for indicating which
768 * fading edges are enabled.</p>
769 * {@hide}
770 */
771 static final int FADING_EDGE_MASK = 0x00003000;
772
773 /**
774 * <p>Indicates this view can be clicked. When clickable, a View reacts
775 * to clicks by notifying the OnClickListener.<p>
776 * {@hide}
777 */
778 static final int CLICKABLE = 0x00004000;
779
780 /**
781 * <p>Indicates this view is caching its drawing into a bitmap.</p>
782 * {@hide}
783 */
784 static final int DRAWING_CACHE_ENABLED = 0x00008000;
785
786 /**
787 * <p>Indicates that no icicle should be saved for this view.<p>
788 * {@hide}
789 */
790 static final int SAVE_DISABLED = 0x000010000;
791
792 /**
793 * <p>Mask for use with setFlags indicating bits used for the saveEnabled
794 * property.</p>
795 * {@hide}
796 */
797 static final int SAVE_DISABLED_MASK = 0x000010000;
798
799 /**
800 * <p>Indicates that no drawing cache should ever be created for this view.<p>
801 * {@hide}
802 */
803 static final int WILL_NOT_CACHE_DRAWING = 0x000020000;
804
805 /**
806 * <p>Indicates this view can take / keep focus when int touch mode.</p>
807 * {@hide}
808 */
809 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000;
810
811 /**
812 * <p>Enables low quality mode for the drawing cache.</p>
813 */
814 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000;
815
816 /**
817 * <p>Enables high quality mode for the drawing cache.</p>
818 */
819 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000;
820
821 /**
822 * <p>Enables automatic quality mode for the drawing cache.</p>
823 */
824 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000;
825
826 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = {
827 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH
828 };
829
830 /**
831 * <p>Mask for use with setFlags indicating bits used for the cache
832 * quality property.</p>
833 * {@hide}
834 */
835 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000;
836
837 /**
838 * <p>
839 * Indicates this view can be long clicked. When long clickable, a View
840 * reacts to long clicks by notifying the OnLongClickListener or showing a
841 * context menu.
842 * </p>
843 * {@hide}
844 */
845 static final int LONG_CLICKABLE = 0x00200000;
846
847 /**
848 * <p>Indicates that this view gets its drawable states from its direct parent
849 * and ignores its original internal states.</p>
850 *
851 * @hide
852 */
853 static final int DUPLICATE_PARENT_STATE = 0x00400000;
854
855 /**
856 * The scrollbar style to display the scrollbars inside the content area,
857 * without increasing the padding. The scrollbars will be overlaid with
858 * translucency on the view's content.
859 */
860 public static final int SCROLLBARS_INSIDE_OVERLAY = 0;
861
862 /**
863 * The scrollbar style to display the scrollbars inside the padded area,
864 * increasing the padding of the view. The scrollbars will not overlap the
865 * content area of the view.
866 */
867 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000;
868
869 /**
870 * The scrollbar style to display the scrollbars at the edge of the view,
871 * without increasing the padding. The scrollbars will be overlaid with
872 * translucency.
873 */
874 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000;
875
876 /**
877 * The scrollbar style to display the scrollbars at the edge of the view,
878 * increasing the padding of the view. The scrollbars will only overlap the
879 * background, if any.
880 */
881 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000;
882
883 /**
884 * Mask to check if the scrollbar style is overlay or inset.
885 * {@hide}
886 */
887 static final int SCROLLBARS_INSET_MASK = 0x01000000;
888
889 /**
890 * Mask to check if the scrollbar style is inside or outside.
891 * {@hide}
892 */
893 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000;
894
895 /**
896 * Mask for scrollbar style.
897 * {@hide}
898 */
899 static final int SCROLLBARS_STYLE_MASK = 0x03000000;
900
901 /**
902 * View flag indicating that the screen should remain on while the
903 * window containing this view is visible to the user. This effectively
904 * takes care of automatically setting the WindowManager's
905 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}.
906 */
907 public static final int KEEP_SCREEN_ON = 0x04000000;
908
909 /**
910 * View flag indicating whether this view should have sound effects enabled
911 * for events such as clicking and touching.
912 */
913 public static final int SOUND_EFFECTS_ENABLED = 0x08000000;
914
915 /**
916 * View flag indicating whether this view should have haptic feedback
917 * enabled for events such as long presses.
918 */
919 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000;
920
921 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700922 * <p>Indicates that the view hierarchy should stop saving state when
923 * it reaches this view. If state saving is initiated immediately at
924 * the view, it will be allowed.
925 * {@hide}
926 */
927 static final int PARENT_SAVE_DISABLED = 0x20000000;
928
929 /**
930 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p>
931 * {@hide}
932 */
933 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000;
934
935 /**
svetoslavganov75986cf2009-05-14 22:28:01 -0700936 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
937 * should add all focusable Views regardless if they are focusable in touch mode.
938 */
939 public static final int FOCUSABLES_ALL = 0x00000000;
940
941 /**
942 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
943 * should add only Views focusable in touch mode.
944 */
945 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001;
946
947 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800948 * Use with {@link #focusSearch}. Move focus to the previous selectable
949 * item.
950 */
951 public static final int FOCUS_BACKWARD = 0x00000001;
952
953 /**
954 * Use with {@link #focusSearch}. Move focus to the next selectable
955 * item.
956 */
957 public static final int FOCUS_FORWARD = 0x00000002;
958
959 /**
960 * Use with {@link #focusSearch}. Move focus to the left.
961 */
962 public static final int FOCUS_LEFT = 0x00000011;
963
964 /**
965 * Use with {@link #focusSearch}. Move focus up.
966 */
967 public static final int FOCUS_UP = 0x00000021;
968
969 /**
970 * Use with {@link #focusSearch}. Move focus to the right.
971 */
972 public static final int FOCUS_RIGHT = 0x00000042;
973
974 /**
975 * Use with {@link #focusSearch}. Move focus down.
976 */
977 public static final int FOCUS_DOWN = 0x00000082;
978
979 /**
980 * Base View state sets
981 */
982 // Singles
983 /**
984 * Indicates the view has no states set. States are used with
985 * {@link android.graphics.drawable.Drawable} to change the drawing of the
986 * view depending on its state.
987 *
988 * @see android.graphics.drawable.Drawable
989 * @see #getDrawableState()
990 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -0700991 protected static final int[] EMPTY_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800992 /**
993 * Indicates the view is enabled. States are used with
994 * {@link android.graphics.drawable.Drawable} to change the drawing of the
995 * view depending on its state.
996 *
997 * @see android.graphics.drawable.Drawable
998 * @see #getDrawableState()
999 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001000 protected static final int[] ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001001 /**
1002 * Indicates the view is focused. States are used with
1003 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1004 * view depending on its state.
1005 *
1006 * @see android.graphics.drawable.Drawable
1007 * @see #getDrawableState()
1008 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001009 protected static final int[] FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001010 /**
1011 * Indicates the view is selected. States are used with
1012 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1013 * view depending on its state.
1014 *
1015 * @see android.graphics.drawable.Drawable
1016 * @see #getDrawableState()
1017 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001018 protected static final int[] SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001019 /**
1020 * Indicates the view is pressed. States are used with
1021 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1022 * view depending on its state.
1023 *
1024 * @see android.graphics.drawable.Drawable
1025 * @see #getDrawableState()
1026 * @hide
1027 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001028 protected static final int[] PRESSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001029 /**
1030 * Indicates the view's window has focus. States are used with
1031 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1032 * view depending on its state.
1033 *
1034 * @see android.graphics.drawable.Drawable
1035 * @see #getDrawableState()
1036 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001037 protected static final int[] WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001038 // Doubles
1039 /**
1040 * Indicates the view is enabled and has the focus.
1041 *
1042 * @see #ENABLED_STATE_SET
1043 * @see #FOCUSED_STATE_SET
1044 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001045 protected static final int[] ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001046 /**
1047 * Indicates the view is enabled and selected.
1048 *
1049 * @see #ENABLED_STATE_SET
1050 * @see #SELECTED_STATE_SET
1051 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001052 protected static final int[] ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001053 /**
1054 * Indicates the view is enabled and that its window has focus.
1055 *
1056 * @see #ENABLED_STATE_SET
1057 * @see #WINDOW_FOCUSED_STATE_SET
1058 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001059 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001060 /**
1061 * Indicates the view is focused and selected.
1062 *
1063 * @see #FOCUSED_STATE_SET
1064 * @see #SELECTED_STATE_SET
1065 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001066 protected static final int[] FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001067 /**
1068 * Indicates the view has the focus and that its window has the focus.
1069 *
1070 * @see #FOCUSED_STATE_SET
1071 * @see #WINDOW_FOCUSED_STATE_SET
1072 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001073 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001074 /**
1075 * Indicates the view is selected and that its window has the focus.
1076 *
1077 * @see #SELECTED_STATE_SET
1078 * @see #WINDOW_FOCUSED_STATE_SET
1079 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001080 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001081 // Triples
1082 /**
1083 * Indicates the view is enabled, focused and selected.
1084 *
1085 * @see #ENABLED_STATE_SET
1086 * @see #FOCUSED_STATE_SET
1087 * @see #SELECTED_STATE_SET
1088 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001089 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001090 /**
1091 * Indicates the view is enabled, focused and its window has the focus.
1092 *
1093 * @see #ENABLED_STATE_SET
1094 * @see #FOCUSED_STATE_SET
1095 * @see #WINDOW_FOCUSED_STATE_SET
1096 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001097 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001098 /**
1099 * Indicates the view is enabled, selected and its window has the focus.
1100 *
1101 * @see #ENABLED_STATE_SET
1102 * @see #SELECTED_STATE_SET
1103 * @see #WINDOW_FOCUSED_STATE_SET
1104 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001105 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001106 /**
1107 * Indicates the view is focused, selected and its window has the focus.
1108 *
1109 * @see #FOCUSED_STATE_SET
1110 * @see #SELECTED_STATE_SET
1111 * @see #WINDOW_FOCUSED_STATE_SET
1112 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001113 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001114 /**
1115 * Indicates the view is enabled, focused, selected and its window
1116 * has the focus.
1117 *
1118 * @see #ENABLED_STATE_SET
1119 * @see #FOCUSED_STATE_SET
1120 * @see #SELECTED_STATE_SET
1121 * @see #WINDOW_FOCUSED_STATE_SET
1122 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001123 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001124 /**
1125 * Indicates the view is pressed and its window has the focus.
1126 *
1127 * @see #PRESSED_STATE_SET
1128 * @see #WINDOW_FOCUSED_STATE_SET
1129 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001130 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001131 /**
1132 * Indicates the view is pressed and selected.
1133 *
1134 * @see #PRESSED_STATE_SET
1135 * @see #SELECTED_STATE_SET
1136 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001137 protected static final int[] PRESSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001138 /**
1139 * Indicates the view is pressed, selected and its window has the focus.
1140 *
1141 * @see #PRESSED_STATE_SET
1142 * @see #SELECTED_STATE_SET
1143 * @see #WINDOW_FOCUSED_STATE_SET
1144 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001145 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001146 /**
1147 * Indicates the view is pressed and focused.
1148 *
1149 * @see #PRESSED_STATE_SET
1150 * @see #FOCUSED_STATE_SET
1151 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001152 protected static final int[] PRESSED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001153 /**
1154 * Indicates the view is pressed, focused and its window has the focus.
1155 *
1156 * @see #PRESSED_STATE_SET
1157 * @see #FOCUSED_STATE_SET
1158 * @see #WINDOW_FOCUSED_STATE_SET
1159 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001160 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001161 /**
1162 * Indicates the view is pressed, focused and selected.
1163 *
1164 * @see #PRESSED_STATE_SET
1165 * @see #SELECTED_STATE_SET
1166 * @see #FOCUSED_STATE_SET
1167 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001168 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001169 /**
1170 * Indicates the view is pressed, focused, selected and its window has the focus.
1171 *
1172 * @see #PRESSED_STATE_SET
1173 * @see #FOCUSED_STATE_SET
1174 * @see #SELECTED_STATE_SET
1175 * @see #WINDOW_FOCUSED_STATE_SET
1176 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001177 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001178 /**
1179 * Indicates the view is pressed and enabled.
1180 *
1181 * @see #PRESSED_STATE_SET
1182 * @see #ENABLED_STATE_SET
1183 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001184 protected static final int[] PRESSED_ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001185 /**
1186 * Indicates the view is pressed, enabled and its window has the focus.
1187 *
1188 * @see #PRESSED_STATE_SET
1189 * @see #ENABLED_STATE_SET
1190 * @see #WINDOW_FOCUSED_STATE_SET
1191 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001192 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001193 /**
1194 * Indicates the view is pressed, enabled and selected.
1195 *
1196 * @see #PRESSED_STATE_SET
1197 * @see #ENABLED_STATE_SET
1198 * @see #SELECTED_STATE_SET
1199 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001200 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001201 /**
1202 * Indicates the view is pressed, enabled, selected and its window has the
1203 * focus.
1204 *
1205 * @see #PRESSED_STATE_SET
1206 * @see #ENABLED_STATE_SET
1207 * @see #SELECTED_STATE_SET
1208 * @see #WINDOW_FOCUSED_STATE_SET
1209 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001210 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001211 /**
1212 * Indicates the view is pressed, enabled and focused.
1213 *
1214 * @see #PRESSED_STATE_SET
1215 * @see #ENABLED_STATE_SET
1216 * @see #FOCUSED_STATE_SET
1217 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001218 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001219 /**
1220 * Indicates the view is pressed, enabled, focused and its window has the
1221 * focus.
1222 *
1223 * @see #PRESSED_STATE_SET
1224 * @see #ENABLED_STATE_SET
1225 * @see #FOCUSED_STATE_SET
1226 * @see #WINDOW_FOCUSED_STATE_SET
1227 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001228 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001229 /**
1230 * Indicates the view is pressed, enabled, focused and selected.
1231 *
1232 * @see #PRESSED_STATE_SET
1233 * @see #ENABLED_STATE_SET
1234 * @see #SELECTED_STATE_SET
1235 * @see #FOCUSED_STATE_SET
1236 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001237 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001238 /**
1239 * Indicates the view is pressed, enabled, focused, selected and its window
1240 * has the focus.
1241 *
1242 * @see #PRESSED_STATE_SET
1243 * @see #ENABLED_STATE_SET
1244 * @see #SELECTED_STATE_SET
1245 * @see #FOCUSED_STATE_SET
1246 * @see #WINDOW_FOCUSED_STATE_SET
1247 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001248 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001249
1250 /**
1251 * The order here is very important to {@link #getDrawableState()}
1252 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001253 private static final int[][] VIEW_STATE_SETS;
1254
Romain Guyb051e892010-09-28 19:09:36 -07001255 static final int VIEW_STATE_WINDOW_FOCUSED = 1;
1256 static final int VIEW_STATE_SELECTED = 1 << 1;
1257 static final int VIEW_STATE_FOCUSED = 1 << 2;
1258 static final int VIEW_STATE_ENABLED = 1 << 3;
1259 static final int VIEW_STATE_PRESSED = 1 << 4;
1260 static final int VIEW_STATE_ACTIVATED = 1 << 5;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001261
1262 static final int[] VIEW_STATE_IDS = new int[] {
1263 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED,
1264 R.attr.state_selected, VIEW_STATE_SELECTED,
1265 R.attr.state_focused, VIEW_STATE_FOCUSED,
1266 R.attr.state_enabled, VIEW_STATE_ENABLED,
1267 R.attr.state_pressed, VIEW_STATE_PRESSED,
1268 R.attr.state_activated, VIEW_STATE_ACTIVATED,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001269 };
1270
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001271 static {
1272 int[] orderedIds = new int[VIEW_STATE_IDS.length];
Romain Guyb051e892010-09-28 19:09:36 -07001273 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001274 int viewState = R.styleable.ViewDrawableStates[i];
Romain Guyb051e892010-09-28 19:09:36 -07001275 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001276 if (VIEW_STATE_IDS[j] == viewState) {
Romain Guyb051e892010-09-28 19:09:36 -07001277 orderedIds[i * 2] = viewState;
1278 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1];
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001279 }
1280 }
1281 }
Romain Guyb051e892010-09-28 19:09:36 -07001282 final int NUM_BITS = VIEW_STATE_IDS.length / 2;
1283 VIEW_STATE_SETS = new int[1 << NUM_BITS][];
1284 for (int i = 0; i < VIEW_STATE_SETS.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001285 int numBits = Integer.bitCount(i);
1286 int[] set = new int[numBits];
1287 int pos = 0;
Romain Guyb051e892010-09-28 19:09:36 -07001288 for (int j = 0; j < orderedIds.length; j += 2) {
1289 if ((i & orderedIds[j+1]) != 0) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001290 set[pos++] = orderedIds[j];
1291 }
1292 }
1293 VIEW_STATE_SETS[i] = set;
1294 }
1295
1296 EMPTY_STATE_SET = VIEW_STATE_SETS[0];
1297 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED];
1298 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED];
1299 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1300 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED];
1301 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED];
1302 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1303 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED];
1304 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1305 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED];
1306 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1307 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1308 | VIEW_STATE_FOCUSED];
1309 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED];
1310 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1311 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED];
1312 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1313 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED];
1314 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1315 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1316 | VIEW_STATE_ENABLED];
1317 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1318 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED];
1319 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1320 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1321 | VIEW_STATE_ENABLED];
1322 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1323 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1324 | VIEW_STATE_ENABLED];
1325 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1326 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1327 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED];
1328
1329 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED];
1330 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1331 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED];
1332 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1333 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED];
1334 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1335 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1336 | VIEW_STATE_PRESSED];
1337 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1338 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1339 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1340 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1341 | VIEW_STATE_PRESSED];
1342 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1343 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1344 | VIEW_STATE_PRESSED];
1345 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1346 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1347 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1348 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[
1349 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1350 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1351 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED
1352 | VIEW_STATE_PRESSED];
1353 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1354 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED
1355 | VIEW_STATE_PRESSED];
1356 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1357 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1358 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1359 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1360 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED
1361 | VIEW_STATE_PRESSED];
1362 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1363 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1364 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1365 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1366 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1367 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1368 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1369 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1370 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED
1371 | VIEW_STATE_PRESSED];
1372 }
1373
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001374 /**
1375 * Used by views that contain lists of items. This state indicates that
1376 * the view is showing the last item.
1377 * @hide
1378 */
1379 protected static final int[] LAST_STATE_SET = {R.attr.state_last};
1380 /**
1381 * Used by views that contain lists of items. This state indicates that
1382 * the view is showing the first item.
1383 * @hide
1384 */
1385 protected static final int[] FIRST_STATE_SET = {R.attr.state_first};
1386 /**
1387 * Used by views that contain lists of items. This state indicates that
1388 * the view is showing the middle item.
1389 * @hide
1390 */
1391 protected static final int[] MIDDLE_STATE_SET = {R.attr.state_middle};
1392 /**
1393 * Used by views that contain lists of items. This state indicates that
1394 * the view is showing only one item.
1395 * @hide
1396 */
1397 protected static final int[] SINGLE_STATE_SET = {R.attr.state_single};
1398 /**
1399 * Used by views that contain lists of items. This state indicates that
1400 * the view is pressed and showing the last item.
1401 * @hide
1402 */
1403 protected static final int[] PRESSED_LAST_STATE_SET = {R.attr.state_last, R.attr.state_pressed};
1404 /**
1405 * Used by views that contain lists of items. This state indicates that
1406 * the view is pressed and showing the first item.
1407 * @hide
1408 */
1409 protected static final int[] PRESSED_FIRST_STATE_SET = {R.attr.state_first, R.attr.state_pressed};
1410 /**
1411 * Used by views that contain lists of items. This state indicates that
1412 * the view is pressed and showing the middle item.
1413 * @hide
1414 */
1415 protected static final int[] PRESSED_MIDDLE_STATE_SET = {R.attr.state_middle, R.attr.state_pressed};
1416 /**
1417 * Used by views that contain lists of items. This state indicates that
1418 * the view is pressed and showing only one item.
1419 * @hide
1420 */
1421 protected static final int[] PRESSED_SINGLE_STATE_SET = {R.attr.state_single, R.attr.state_pressed};
1422
1423 /**
1424 * Temporary Rect currently for use in setBackground(). This will probably
1425 * be extended in the future to hold our own class with more than just
1426 * a Rect. :)
1427 */
1428 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>();
Romain Guyd90a3312009-05-06 14:54:28 -07001429
1430 /**
1431 * Map used to store views' tags.
1432 */
1433 private static WeakHashMap<View, SparseArray<Object>> sTags;
1434
1435 /**
1436 * Lock used to access sTags.
1437 */
1438 private static final Object sTagsLock = new Object();
1439
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001440 /**
1441 * The animation currently associated with this view.
1442 * @hide
1443 */
1444 protected Animation mCurrentAnimation = null;
1445
1446 /**
1447 * Width as measured during measure pass.
1448 * {@hide}
1449 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001450 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001451 protected int mMeasuredWidth;
1452
1453 /**
1454 * Height as measured during measure pass.
1455 * {@hide}
1456 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001457 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001458 protected int mMeasuredHeight;
1459
1460 /**
1461 * The view's identifier.
1462 * {@hide}
1463 *
1464 * @see #setId(int)
1465 * @see #getId()
1466 */
1467 @ViewDebug.ExportedProperty(resolveId = true)
1468 int mID = NO_ID;
1469
1470 /**
1471 * The view's tag.
1472 * {@hide}
1473 *
1474 * @see #setTag(Object)
1475 * @see #getTag()
1476 */
1477 protected Object mTag;
1478
1479 // for mPrivateFlags:
1480 /** {@hide} */
1481 static final int WANTS_FOCUS = 0x00000001;
1482 /** {@hide} */
1483 static final int FOCUSED = 0x00000002;
1484 /** {@hide} */
1485 static final int SELECTED = 0x00000004;
1486 /** {@hide} */
1487 static final int IS_ROOT_NAMESPACE = 0x00000008;
1488 /** {@hide} */
1489 static final int HAS_BOUNDS = 0x00000010;
1490 /** {@hide} */
1491 static final int DRAWN = 0x00000020;
1492 /**
1493 * When this flag is set, this view is running an animation on behalf of its
1494 * children and should therefore not cancel invalidate requests, even if they
1495 * lie outside of this view's bounds.
1496 *
1497 * {@hide}
1498 */
1499 static final int DRAW_ANIMATION = 0x00000040;
1500 /** {@hide} */
1501 static final int SKIP_DRAW = 0x00000080;
1502 /** {@hide} */
1503 static final int ONLY_DRAWS_BACKGROUND = 0x00000100;
1504 /** {@hide} */
1505 static final int REQUEST_TRANSPARENT_REGIONS = 0x00000200;
1506 /** {@hide} */
1507 static final int DRAWABLE_STATE_DIRTY = 0x00000400;
1508 /** {@hide} */
1509 static final int MEASURED_DIMENSION_SET = 0x00000800;
1510 /** {@hide} */
1511 static final int FORCE_LAYOUT = 0x00001000;
Konstantin Lopyrevc6dc4572010-08-06 15:01:52 -07001512 /** {@hide} */
1513 static final int LAYOUT_REQUIRED = 0x00002000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001514
1515 private static final int PRESSED = 0x00004000;
1516
1517 /** {@hide} */
1518 static final int DRAWING_CACHE_VALID = 0x00008000;
1519 /**
1520 * Flag used to indicate that this view should be drawn once more (and only once
1521 * more) after its animation has completed.
1522 * {@hide}
1523 */
1524 static final int ANIMATION_STARTED = 0x00010000;
1525
1526 private static final int SAVE_STATE_CALLED = 0x00020000;
1527
1528 /**
1529 * Indicates that the View returned true when onSetAlpha() was called and that
1530 * the alpha must be restored.
1531 * {@hide}
1532 */
1533 static final int ALPHA_SET = 0x00040000;
1534
1535 /**
1536 * Set by {@link #setScrollContainer(boolean)}.
1537 */
1538 static final int SCROLL_CONTAINER = 0x00080000;
1539
1540 /**
1541 * Set by {@link #setScrollContainer(boolean)}.
1542 */
1543 static final int SCROLL_CONTAINER_ADDED = 0x00100000;
1544
1545 /**
Romain Guy809a7f62009-05-14 15:44:42 -07001546 * View flag indicating whether this view was invalidated (fully or partially.)
1547 *
1548 * @hide
1549 */
1550 static final int DIRTY = 0x00200000;
1551
1552 /**
1553 * View flag indicating whether this view was invalidated by an opaque
1554 * invalidate request.
1555 *
1556 * @hide
1557 */
1558 static final int DIRTY_OPAQUE = 0x00400000;
1559
1560 /**
1561 * Mask for {@link #DIRTY} and {@link #DIRTY_OPAQUE}.
1562 *
1563 * @hide
1564 */
1565 static final int DIRTY_MASK = 0x00600000;
1566
1567 /**
Romain Guy8f1344f52009-05-15 16:03:59 -07001568 * Indicates whether the background is opaque.
1569 *
1570 * @hide
1571 */
1572 static final int OPAQUE_BACKGROUND = 0x00800000;
1573
1574 /**
1575 * Indicates whether the scrollbars are opaque.
1576 *
1577 * @hide
1578 */
1579 static final int OPAQUE_SCROLLBARS = 0x01000000;
1580
1581 /**
1582 * Indicates whether the view is opaque.
1583 *
1584 * @hide
1585 */
1586 static final int OPAQUE_MASK = 0x01800000;
Adam Powelle14579b2009-12-16 18:39:52 -08001587
1588 /**
1589 * Indicates a prepressed state;
1590 * the short time between ACTION_DOWN and recognizing
1591 * a 'real' press. Prepressed is used to recognize quick taps
1592 * even when they are shorter than ViewConfiguration.getTapTimeout().
1593 *
1594 * @hide
1595 */
1596 private static final int PREPRESSED = 0x02000000;
Adam Powellc9fbaab2010-02-16 17:16:19 -08001597
1598 /**
Romain Guy8afa5152010-02-26 11:56:30 -08001599 * Indicates whether the view is temporarily detached.
1600 *
1601 * @hide
1602 */
1603 static final int CANCEL_NEXT_UP_EVENT = 0x04000000;
Adam Powell8568c3a2010-04-19 14:26:11 -07001604
1605 /**
1606 * Indicates that we should awaken scroll bars once attached
1607 *
1608 * @hide
1609 */
1610 private static final int AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000;
Romain Guy8f1344f52009-05-15 16:03:59 -07001611
1612 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001613 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center
1614 * for transform operations
1615 *
1616 * @hide
1617 */
Adam Powellf37df072010-09-17 16:22:49 -07001618 private static final int PIVOT_EXPLICITLY_SET = 0x20000000;
Chet Haasefd2b0022010-08-06 13:08:56 -07001619
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001620 /** {@hide} */
Adam Powellf37df072010-09-17 16:22:49 -07001621 static final int ACTIVATED = 0x40000000;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001622
Chet Haasefd2b0022010-08-06 13:08:56 -07001623 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001624 * The parent this view is attached to.
1625 * {@hide}
1626 *
1627 * @see #getParent()
1628 */
1629 protected ViewParent mParent;
1630
1631 /**
1632 * {@hide}
1633 */
1634 AttachInfo mAttachInfo;
1635
1636 /**
1637 * {@hide}
1638 */
Romain Guy809a7f62009-05-14 15:44:42 -07001639 @ViewDebug.ExportedProperty(flagMapping = {
1640 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT,
1641 name = "FORCE_LAYOUT"),
1642 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED,
1643 name = "LAYOUT_REQUIRED"),
1644 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07001645 name = "DRAWING_CACHE_INVALID", outputIf = false),
Romain Guy809a7f62009-05-14 15:44:42 -07001646 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true),
1647 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false),
1648 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
1649 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY")
1650 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001651 int mPrivateFlags;
1652
1653 /**
1654 * Count of how many windows this view has been attached to.
1655 */
1656 int mWindowAttachCount;
1657
1658 /**
1659 * The layout parameters associated with this view and used by the parent
1660 * {@link android.view.ViewGroup} to determine how this view should be
1661 * laid out.
1662 * {@hide}
1663 */
1664 protected ViewGroup.LayoutParams mLayoutParams;
1665
1666 /**
1667 * The view flags hold various views states.
1668 * {@hide}
1669 */
1670 @ViewDebug.ExportedProperty
1671 int mViewFlags;
1672
1673 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001674 * The transform matrix for the View. This transform is calculated internally
1675 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1676 * is used by default. Do *not* use this variable directly; instead call
1677 * getMatrix(), which will automatically recalculate the matrix if necessary
1678 * to get the correct matrix based on the latest rotation and scale properties.
1679 */
1680 private final Matrix mMatrix = new Matrix();
1681
1682 /**
1683 * The transform matrix for the View. This transform is calculated internally
1684 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1685 * is used by default. Do *not* use this variable directly; instead call
Jeff Brown86671742010-09-30 20:00:15 -07001686 * getInverseMatrix(), which will automatically recalculate the matrix if necessary
Chet Haasec3aa3612010-06-17 08:50:37 -07001687 * to get the correct matrix based on the latest rotation and scale properties.
1688 */
1689 private Matrix mInverseMatrix;
1690
1691 /**
1692 * An internal variable that tracks whether we need to recalculate the
1693 * transform matrix, based on whether the rotation or scaleX/Y properties
1694 * have changed since the matrix was last calculated.
1695 */
1696 private boolean mMatrixDirty = false;
1697
1698 /**
1699 * An internal variable that tracks whether we need to recalculate the
1700 * transform matrix, based on whether the rotation or scaleX/Y properties
1701 * have changed since the matrix was last calculated.
1702 */
1703 private boolean mInverseMatrixDirty = true;
1704
1705 /**
1706 * A variable that tracks whether we need to recalculate the
1707 * transform matrix, based on whether the rotation or scaleX/Y properties
1708 * have changed since the matrix was last calculated. This variable
Jeff Brown86671742010-09-30 20:00:15 -07001709 * is only valid after a call to updateMatrix() or to a function that
1710 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix().
Chet Haasec3aa3612010-06-17 08:50:37 -07001711 */
Romain Guy33e72ae2010-07-17 12:40:29 -07001712 private boolean mMatrixIsIdentity = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07001713
1714 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001715 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set.
1716 */
1717 private Camera mCamera = null;
1718
1719 /**
1720 * This matrix is used when computing the matrix for 3D rotations.
1721 */
1722 private Matrix matrix3D = null;
1723
1724 /**
1725 * These prev values are used to recalculate a centered pivot point when necessary. The
1726 * pivot point is only used in matrix operations (when rotation, scale, or translation are
1727 * set), so thes values are only used then as well.
1728 */
1729 private int mPrevWidth = -1;
1730 private int mPrevHeight = -1;
1731
1732 /**
1733 * Convenience value to check for float values that are close enough to zero to be considered
1734 * zero.
1735 */
Romain Guy2542d192010-08-18 11:47:12 -07001736 private static final float NONZERO_EPSILON = .001f;
Chet Haasefd2b0022010-08-06 13:08:56 -07001737
1738 /**
1739 * The degrees rotation around the vertical axis through the pivot point.
1740 */
1741 @ViewDebug.ExportedProperty
1742 private float mRotationY = 0f;
1743
1744 /**
1745 * The degrees rotation around the horizontal axis through the pivot point.
1746 */
1747 @ViewDebug.ExportedProperty
1748 private float mRotationX = 0f;
1749
1750 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001751 * The degrees rotation around the pivot point.
1752 */
1753 @ViewDebug.ExportedProperty
1754 private float mRotation = 0f;
1755
1756 /**
Chet Haasedf030d22010-07-30 17:22:38 -07001757 * The amount of translation of the object away from its left property (post-layout).
1758 */
1759 @ViewDebug.ExportedProperty
1760 private float mTranslationX = 0f;
1761
1762 /**
1763 * The amount of translation of the object away from its top property (post-layout).
1764 */
1765 @ViewDebug.ExportedProperty
1766 private float mTranslationY = 0f;
1767
1768 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001769 * The amount of scale in the x direction around the pivot point. A
1770 * value of 1 means no scaling is applied.
1771 */
1772 @ViewDebug.ExportedProperty
1773 private float mScaleX = 1f;
1774
1775 /**
1776 * The amount of scale in the y direction around the pivot point. A
1777 * value of 1 means no scaling is applied.
1778 */
1779 @ViewDebug.ExportedProperty
1780 private float mScaleY = 1f;
1781
1782 /**
1783 * The amount of scale in the x direction around the pivot point. A
1784 * value of 1 means no scaling is applied.
1785 */
1786 @ViewDebug.ExportedProperty
1787 private float mPivotX = 0f;
1788
1789 /**
1790 * The amount of scale in the y direction around the pivot point. A
1791 * value of 1 means no scaling is applied.
1792 */
1793 @ViewDebug.ExportedProperty
1794 private float mPivotY = 0f;
1795
1796 /**
1797 * The opacity of the View. This is a value from 0 to 1, where 0 means
1798 * completely transparent and 1 means completely opaque.
1799 */
1800 @ViewDebug.ExportedProperty
1801 private float mAlpha = 1f;
1802
1803 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001804 * The distance in pixels from the left edge of this view's parent
1805 * to the left edge of this view.
1806 * {@hide}
1807 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001808 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001809 protected int mLeft;
1810 /**
1811 * The distance in pixels from the left edge of this view's parent
1812 * to the right edge of this view.
1813 * {@hide}
1814 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001815 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001816 protected int mRight;
1817 /**
1818 * The distance in pixels from the top edge of this view's parent
1819 * to the top edge of this view.
1820 * {@hide}
1821 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001822 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001823 protected int mTop;
1824 /**
1825 * The distance in pixels from the top edge of this view's parent
1826 * to the bottom edge of this view.
1827 * {@hide}
1828 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001829 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001830 protected int mBottom;
1831
1832 /**
1833 * The offset, in pixels, by which the content of this view is scrolled
1834 * horizontally.
1835 * {@hide}
1836 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001837 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001838 protected int mScrollX;
1839 /**
1840 * The offset, in pixels, by which the content of this view is scrolled
1841 * vertically.
1842 * {@hide}
1843 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001844 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001845 protected int mScrollY;
1846
1847 /**
1848 * The left padding in pixels, that is the distance in pixels between the
1849 * left edge of this view and the left edge of its content.
1850 * {@hide}
1851 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001852 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001853 protected int mPaddingLeft;
1854 /**
1855 * The right padding in pixels, that is the distance in pixels between the
1856 * right edge of this view and the right edge of its content.
1857 * {@hide}
1858 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001859 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001860 protected int mPaddingRight;
1861 /**
1862 * The top padding in pixels, that is the distance in pixels between the
1863 * top edge of this view and the top edge of its content.
1864 * {@hide}
1865 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001866 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001867 protected int mPaddingTop;
1868 /**
1869 * The bottom padding in pixels, that is the distance in pixels between the
1870 * bottom edge of this view and the bottom edge of its content.
1871 * {@hide}
1872 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001873 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001874 protected int mPaddingBottom;
1875
1876 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07001877 * Briefly describes the view and is primarily used for accessibility support.
1878 */
1879 private CharSequence mContentDescription;
1880
1881 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001882 * Cache the paddingRight set by the user to append to the scrollbar's size.
1883 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001884 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001885 int mUserPaddingRight;
1886
1887 /**
1888 * Cache the paddingBottom set by the user to append to the scrollbar's size.
1889 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001890 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001891 int mUserPaddingBottom;
1892
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07001893 /**
1894 * @hide
1895 */
1896 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
1897 /**
1898 * @hide
1899 */
1900 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001901
1902 private Resources mResources = null;
1903
1904 private Drawable mBGDrawable;
1905
1906 private int mBackgroundResource;
1907 private boolean mBackgroundSizeChanged;
1908
1909 /**
1910 * Listener used to dispatch focus change events.
1911 * This field should be made private, so it is hidden from the SDK.
1912 * {@hide}
1913 */
1914 protected OnFocusChangeListener mOnFocusChangeListener;
1915
1916 /**
Chet Haase21cd1382010-09-01 17:42:29 -07001917 * Listeners for layout change events.
1918 */
1919 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
1920
1921 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001922 * Listener used to dispatch click events.
1923 * This field should be made private, so it is hidden from the SDK.
1924 * {@hide}
1925 */
1926 protected OnClickListener mOnClickListener;
1927
1928 /**
1929 * Listener used to dispatch long click events.
1930 * This field should be made private, so it is hidden from the SDK.
1931 * {@hide}
1932 */
1933 protected OnLongClickListener mOnLongClickListener;
1934
1935 /**
1936 * Listener used to build the context menu.
1937 * This field should be made private, so it is hidden from the SDK.
1938 * {@hide}
1939 */
1940 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
1941
1942 private OnKeyListener mOnKeyListener;
1943
1944 private OnTouchListener mOnTouchListener;
1945
1946 /**
1947 * The application environment this view lives in.
1948 * This field should be made private, so it is hidden from the SDK.
1949 * {@hide}
1950 */
1951 protected Context mContext;
1952
1953 private ScrollabilityCache mScrollCache;
1954
1955 private int[] mDrawableState = null;
1956
Romain Guy02890fd2010-08-06 17:58:44 -07001957 private Bitmap mDrawingCache;
1958 private Bitmap mUnscaledDrawingCache;
Romain Guyb051e892010-09-28 19:09:36 -07001959 private DisplayList mDisplayList;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001960
1961 /**
1962 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
1963 * the user may specify which view to go to next.
1964 */
1965 private int mNextFocusLeftId = View.NO_ID;
1966
1967 /**
1968 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
1969 * the user may specify which view to go to next.
1970 */
1971 private int mNextFocusRightId = View.NO_ID;
1972
1973 /**
1974 * When this view has focus and the next focus is {@link #FOCUS_UP},
1975 * the user may specify which view to go to next.
1976 */
1977 private int mNextFocusUpId = View.NO_ID;
1978
1979 /**
1980 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
1981 * the user may specify which view to go to next.
1982 */
1983 private int mNextFocusDownId = View.NO_ID;
1984
1985 private CheckForLongPress mPendingCheckForLongPress;
Adam Powelle14579b2009-12-16 18:39:52 -08001986 private CheckForTap mPendingCheckForTap = null;
Adam Powella35d7682010-03-12 14:48:13 -08001987 private PerformClick mPerformClick;
Adam Powelle14579b2009-12-16 18:39:52 -08001988
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001989 private UnsetPressedState mUnsetPressedState;
1990
1991 /**
1992 * Whether the long press's action has been invoked. The tap's action is invoked on the
1993 * up event while a long press is invoked as soon as the long press duration is reached, so
1994 * a long press could be performed before the tap is checked, in which case the tap's action
1995 * should not be invoked.
1996 */
1997 private boolean mHasPerformedLongPress;
1998
1999 /**
2000 * The minimum height of the view. We'll try our best to have the height
2001 * of this view to at least this amount.
2002 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002003 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002004 private int mMinHeight;
2005
2006 /**
2007 * The minimum width of the view. We'll try our best to have the width
2008 * of this view to at least this amount.
2009 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002010 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002011 private int mMinWidth;
2012
2013 /**
2014 * The delegate to handle touch events that are physically in this view
2015 * but should be handled by another view.
2016 */
2017 private TouchDelegate mTouchDelegate = null;
2018
2019 /**
2020 * Solid color to use as a background when creating the drawing cache. Enables
2021 * the cache to use 16 bit bitmaps instead of 32 bit.
2022 */
2023 private int mDrawingCacheBackgroundColor = 0;
2024
2025 /**
2026 * Special tree observer used when mAttachInfo is null.
2027 */
2028 private ViewTreeObserver mFloatingTreeObserver;
Adam Powelle14579b2009-12-16 18:39:52 -08002029
2030 /**
2031 * Cache the touch slop from the context that created the view.
2032 */
2033 private int mTouchSlop;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002034
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002035 /**
Christopher Tatea53146c2010-09-07 11:57:52 -07002036 * Cache drag/drop state
2037 *
2038 */
2039 boolean mCanAcceptDrop;
Christopher Tatea53146c2010-09-07 11:57:52 -07002040 private int mThumbnailWidth;
2041 private int mThumbnailHeight;
2042
2043 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002044 * Simple constructor to use when creating a view from code.
2045 *
2046 * @param context The Context the view is running in, through which it can
2047 * access the current theme, resources, etc.
2048 */
2049 public View(Context context) {
2050 mContext = context;
2051 mResources = context != null ? context.getResources() : null;
Romain Guy8f1344f52009-05-15 16:03:59 -07002052 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED;
Adam Powelle14579b2009-12-16 18:39:52 -08002053 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002054 }
2055
2056 /**
2057 * Constructor that is called when inflating a view from XML. This is called
2058 * when a view is being constructed from an XML file, supplying attributes
2059 * that were specified in the XML file. This version uses a default style of
2060 * 0, so the only attribute values applied are those in the Context's Theme
2061 * and the given AttributeSet.
2062 *
2063 * <p>
2064 * The method onFinishInflate() will be called after all children have been
2065 * added.
2066 *
2067 * @param context The Context the view is running in, through which it can
2068 * access the current theme, resources, etc.
2069 * @param attrs The attributes of the XML tag that is inflating the view.
2070 * @see #View(Context, AttributeSet, int)
2071 */
2072 public View(Context context, AttributeSet attrs) {
2073 this(context, attrs, 0);
2074 }
2075
2076 /**
2077 * Perform inflation from XML and apply a class-specific base style. This
2078 * constructor of View allows subclasses to use their own base style when
2079 * they are inflating. For example, a Button class's constructor would call
2080 * this version of the super class constructor and supply
2081 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
2082 * the theme's button style to modify all of the base view attributes (in
2083 * particular its background) as well as the Button class's attributes.
2084 *
2085 * @param context The Context the view is running in, through which it can
2086 * access the current theme, resources, etc.
2087 * @param attrs The attributes of the XML tag that is inflating the view.
2088 * @param defStyle The default style to apply to this view. If 0, no style
2089 * will be applied (beyond what is included in the theme). This may
2090 * either be an attribute resource, whose value will be retrieved
2091 * from the current theme, or an explicit style resource.
2092 * @see #View(Context, AttributeSet)
2093 */
2094 public View(Context context, AttributeSet attrs, int defStyle) {
2095 this(context);
2096
2097 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
2098 defStyle, 0);
2099
2100 Drawable background = null;
2101
2102 int leftPadding = -1;
2103 int topPadding = -1;
2104 int rightPadding = -1;
2105 int bottomPadding = -1;
2106
2107 int padding = -1;
2108
2109 int viewFlagValues = 0;
2110 int viewFlagMasks = 0;
2111
2112 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07002113
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002114 int x = 0;
2115 int y = 0;
2116
2117 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
2118
2119 final int N = a.getIndexCount();
2120 for (int i = 0; i < N; i++) {
2121 int attr = a.getIndex(i);
2122 switch (attr) {
2123 case com.android.internal.R.styleable.View_background:
2124 background = a.getDrawable(attr);
2125 break;
2126 case com.android.internal.R.styleable.View_padding:
2127 padding = a.getDimensionPixelSize(attr, -1);
2128 break;
2129 case com.android.internal.R.styleable.View_paddingLeft:
2130 leftPadding = a.getDimensionPixelSize(attr, -1);
2131 break;
2132 case com.android.internal.R.styleable.View_paddingTop:
2133 topPadding = a.getDimensionPixelSize(attr, -1);
2134 break;
2135 case com.android.internal.R.styleable.View_paddingRight:
2136 rightPadding = a.getDimensionPixelSize(attr, -1);
2137 break;
2138 case com.android.internal.R.styleable.View_paddingBottom:
2139 bottomPadding = a.getDimensionPixelSize(attr, -1);
2140 break;
2141 case com.android.internal.R.styleable.View_scrollX:
2142 x = a.getDimensionPixelOffset(attr, 0);
2143 break;
2144 case com.android.internal.R.styleable.View_scrollY:
2145 y = a.getDimensionPixelOffset(attr, 0);
2146 break;
2147 case com.android.internal.R.styleable.View_id:
2148 mID = a.getResourceId(attr, NO_ID);
2149 break;
2150 case com.android.internal.R.styleable.View_tag:
2151 mTag = a.getText(attr);
2152 break;
2153 case com.android.internal.R.styleable.View_fitsSystemWindows:
2154 if (a.getBoolean(attr, false)) {
2155 viewFlagValues |= FITS_SYSTEM_WINDOWS;
2156 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
2157 }
2158 break;
2159 case com.android.internal.R.styleable.View_focusable:
2160 if (a.getBoolean(attr, false)) {
2161 viewFlagValues |= FOCUSABLE;
2162 viewFlagMasks |= FOCUSABLE_MASK;
2163 }
2164 break;
2165 case com.android.internal.R.styleable.View_focusableInTouchMode:
2166 if (a.getBoolean(attr, false)) {
2167 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
2168 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
2169 }
2170 break;
2171 case com.android.internal.R.styleable.View_clickable:
2172 if (a.getBoolean(attr, false)) {
2173 viewFlagValues |= CLICKABLE;
2174 viewFlagMasks |= CLICKABLE;
2175 }
2176 break;
2177 case com.android.internal.R.styleable.View_longClickable:
2178 if (a.getBoolean(attr, false)) {
2179 viewFlagValues |= LONG_CLICKABLE;
2180 viewFlagMasks |= LONG_CLICKABLE;
2181 }
2182 break;
2183 case com.android.internal.R.styleable.View_saveEnabled:
2184 if (!a.getBoolean(attr, true)) {
2185 viewFlagValues |= SAVE_DISABLED;
2186 viewFlagMasks |= SAVE_DISABLED_MASK;
2187 }
2188 break;
2189 case com.android.internal.R.styleable.View_duplicateParentState:
2190 if (a.getBoolean(attr, false)) {
2191 viewFlagValues |= DUPLICATE_PARENT_STATE;
2192 viewFlagMasks |= DUPLICATE_PARENT_STATE;
2193 }
2194 break;
2195 case com.android.internal.R.styleable.View_visibility:
2196 final int visibility = a.getInt(attr, 0);
2197 if (visibility != 0) {
2198 viewFlagValues |= VISIBILITY_FLAGS[visibility];
2199 viewFlagMasks |= VISIBILITY_MASK;
2200 }
2201 break;
2202 case com.android.internal.R.styleable.View_drawingCacheQuality:
2203 final int cacheQuality = a.getInt(attr, 0);
2204 if (cacheQuality != 0) {
2205 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
2206 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
2207 }
2208 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07002209 case com.android.internal.R.styleable.View_contentDescription:
2210 mContentDescription = a.getString(attr);
2211 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002212 case com.android.internal.R.styleable.View_soundEffectsEnabled:
2213 if (!a.getBoolean(attr, true)) {
2214 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
2215 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
2216 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002217 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002218 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
2219 if (!a.getBoolean(attr, true)) {
2220 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
2221 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
2222 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002223 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002224 case R.styleable.View_scrollbars:
2225 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
2226 if (scrollbars != SCROLLBARS_NONE) {
2227 viewFlagValues |= scrollbars;
2228 viewFlagMasks |= SCROLLBARS_MASK;
2229 initializeScrollbars(a);
2230 }
2231 break;
2232 case R.styleable.View_fadingEdge:
2233 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
2234 if (fadingEdge != FADING_EDGE_NONE) {
2235 viewFlagValues |= fadingEdge;
2236 viewFlagMasks |= FADING_EDGE_MASK;
2237 initializeFadingEdge(a);
2238 }
2239 break;
2240 case R.styleable.View_scrollbarStyle:
2241 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
2242 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2243 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
2244 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
2245 }
2246 break;
2247 case R.styleable.View_isScrollContainer:
2248 setScrollContainer = true;
2249 if (a.getBoolean(attr, false)) {
2250 setScrollContainer(true);
2251 }
2252 break;
2253 case com.android.internal.R.styleable.View_keepScreenOn:
2254 if (a.getBoolean(attr, false)) {
2255 viewFlagValues |= KEEP_SCREEN_ON;
2256 viewFlagMasks |= KEEP_SCREEN_ON;
2257 }
2258 break;
Jeff Brown85a31762010-09-01 17:01:00 -07002259 case R.styleable.View_filterTouchesWhenObscured:
2260 if (a.getBoolean(attr, false)) {
2261 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED;
2262 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED;
2263 }
2264 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002265 case R.styleable.View_nextFocusLeft:
2266 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
2267 break;
2268 case R.styleable.View_nextFocusRight:
2269 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
2270 break;
2271 case R.styleable.View_nextFocusUp:
2272 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
2273 break;
2274 case R.styleable.View_nextFocusDown:
2275 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
2276 break;
2277 case R.styleable.View_minWidth:
2278 mMinWidth = a.getDimensionPixelSize(attr, 0);
2279 break;
2280 case R.styleable.View_minHeight:
2281 mMinHeight = a.getDimensionPixelSize(attr, 0);
2282 break;
Romain Guy9a817362009-05-01 10:57:14 -07002283 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07002284 if (context.isRestricted()) {
2285 throw new IllegalStateException("The android:onClick attribute cannot "
2286 + "be used within a restricted context");
2287 }
2288
Romain Guy9a817362009-05-01 10:57:14 -07002289 final String handlerName = a.getString(attr);
2290 if (handlerName != null) {
2291 setOnClickListener(new OnClickListener() {
2292 private Method mHandler;
2293
2294 public void onClick(View v) {
2295 if (mHandler == null) {
2296 try {
2297 mHandler = getContext().getClass().getMethod(handlerName,
2298 View.class);
2299 } catch (NoSuchMethodException e) {
Joe Onorato42e14d72010-03-11 14:51:17 -08002300 int id = getId();
2301 String idText = id == NO_ID ? "" : " with id '"
2302 + getContext().getResources().getResourceEntryName(
2303 id) + "'";
Romain Guy9a817362009-05-01 10:57:14 -07002304 throw new IllegalStateException("Could not find a method " +
Joe Onorato42e14d72010-03-11 14:51:17 -08002305 handlerName + "(View) in the activity "
2306 + getContext().getClass() + " for onClick handler"
2307 + " on view " + View.this.getClass() + idText, e);
Romain Guy9a817362009-05-01 10:57:14 -07002308 }
2309 }
2310
2311 try {
2312 mHandler.invoke(getContext(), View.this);
2313 } catch (IllegalAccessException e) {
2314 throw new IllegalStateException("Could not execute non "
2315 + "public method of the activity", e);
2316 } catch (InvocationTargetException e) {
2317 throw new IllegalStateException("Could not execute "
2318 + "method of the activity", e);
2319 }
2320 }
2321 });
2322 }
2323 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002324 }
2325 }
2326
2327 if (background != null) {
2328 setBackgroundDrawable(background);
2329 }
2330
2331 if (padding >= 0) {
2332 leftPadding = padding;
2333 topPadding = padding;
2334 rightPadding = padding;
2335 bottomPadding = padding;
2336 }
2337
2338 // If the user specified the padding (either with android:padding or
2339 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
2340 // use the default padding or the padding from the background drawable
2341 // (stored at this point in mPadding*)
2342 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
2343 topPadding >= 0 ? topPadding : mPaddingTop,
2344 rightPadding >= 0 ? rightPadding : mPaddingRight,
2345 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
2346
2347 if (viewFlagMasks != 0) {
2348 setFlags(viewFlagValues, viewFlagMasks);
2349 }
2350
2351 // Needs to be called after mViewFlags is set
2352 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2353 recomputePadding();
2354 }
2355
2356 if (x != 0 || y != 0) {
2357 scrollTo(x, y);
2358 }
2359
2360 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
2361 setScrollContainer(true);
2362 }
Romain Guy8f1344f52009-05-15 16:03:59 -07002363
2364 computeOpaqueFlags();
2365
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002366 a.recycle();
2367 }
2368
2369 /**
2370 * Non-public constructor for use in testing
2371 */
2372 View() {
2373 }
2374
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002375 /**
2376 * <p>
2377 * Initializes the fading edges from a given set of styled attributes. This
2378 * method should be called by subclasses that need fading edges and when an
2379 * instance of these subclasses is created programmatically rather than
2380 * being inflated from XML. This method is automatically called when the XML
2381 * is inflated.
2382 * </p>
2383 *
2384 * @param a the styled attributes set to initialize the fading edges from
2385 */
2386 protected void initializeFadingEdge(TypedArray a) {
2387 initScrollCache();
2388
2389 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
2390 R.styleable.View_fadingEdgeLength,
2391 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
2392 }
2393
2394 /**
2395 * Returns the size of the vertical faded edges used to indicate that more
2396 * content in this view is visible.
2397 *
2398 * @return The size in pixels of the vertical faded edge or 0 if vertical
2399 * faded edges are not enabled for this view.
2400 * @attr ref android.R.styleable#View_fadingEdgeLength
2401 */
2402 public int getVerticalFadingEdgeLength() {
2403 if (isVerticalFadingEdgeEnabled()) {
2404 ScrollabilityCache cache = mScrollCache;
2405 if (cache != null) {
2406 return cache.fadingEdgeLength;
2407 }
2408 }
2409 return 0;
2410 }
2411
2412 /**
2413 * Set the size of the faded edge used to indicate that more content in this
2414 * view is available. Will not change whether the fading edge is enabled; use
2415 * {@link #setVerticalFadingEdgeEnabled} or {@link #setHorizontalFadingEdgeEnabled}
2416 * to enable the fading edge for the vertical or horizontal fading edges.
2417 *
2418 * @param length The size in pixels of the faded edge used to indicate that more
2419 * content in this view is visible.
2420 */
2421 public void setFadingEdgeLength(int length) {
2422 initScrollCache();
2423 mScrollCache.fadingEdgeLength = length;
2424 }
2425
2426 /**
2427 * Returns the size of the horizontal faded edges used to indicate that more
2428 * content in this view is visible.
2429 *
2430 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
2431 * faded edges are not enabled for this view.
2432 * @attr ref android.R.styleable#View_fadingEdgeLength
2433 */
2434 public int getHorizontalFadingEdgeLength() {
2435 if (isHorizontalFadingEdgeEnabled()) {
2436 ScrollabilityCache cache = mScrollCache;
2437 if (cache != null) {
2438 return cache.fadingEdgeLength;
2439 }
2440 }
2441 return 0;
2442 }
2443
2444 /**
2445 * Returns the width of the vertical scrollbar.
2446 *
2447 * @return The width in pixels of the vertical scrollbar or 0 if there
2448 * is no vertical scrollbar.
2449 */
2450 public int getVerticalScrollbarWidth() {
2451 ScrollabilityCache cache = mScrollCache;
2452 if (cache != null) {
2453 ScrollBarDrawable scrollBar = cache.scrollBar;
2454 if (scrollBar != null) {
2455 int size = scrollBar.getSize(true);
2456 if (size <= 0) {
2457 size = cache.scrollBarSize;
2458 }
2459 return size;
2460 }
2461 return 0;
2462 }
2463 return 0;
2464 }
2465
2466 /**
2467 * Returns the height of the horizontal scrollbar.
2468 *
2469 * @return The height in pixels of the horizontal scrollbar or 0 if
2470 * there is no horizontal scrollbar.
2471 */
2472 protected int getHorizontalScrollbarHeight() {
2473 ScrollabilityCache cache = mScrollCache;
2474 if (cache != null) {
2475 ScrollBarDrawable scrollBar = cache.scrollBar;
2476 if (scrollBar != null) {
2477 int size = scrollBar.getSize(false);
2478 if (size <= 0) {
2479 size = cache.scrollBarSize;
2480 }
2481 return size;
2482 }
2483 return 0;
2484 }
2485 return 0;
2486 }
2487
2488 /**
2489 * <p>
2490 * Initializes the scrollbars from a given set of styled attributes. This
2491 * method should be called by subclasses that need scrollbars and when an
2492 * instance of these subclasses is created programmatically rather than
2493 * being inflated from XML. This method is automatically called when the XML
2494 * is inflated.
2495 * </p>
2496 *
2497 * @param a the styled attributes set to initialize the scrollbars from
2498 */
2499 protected void initializeScrollbars(TypedArray a) {
2500 initScrollCache();
2501
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002502 final ScrollabilityCache scrollabilityCache = mScrollCache;
Mike Cleronf116bf82009-09-27 19:14:12 -07002503
2504 if (scrollabilityCache.scrollBar == null) {
2505 scrollabilityCache.scrollBar = new ScrollBarDrawable();
2506 }
2507
Romain Guy8bda2482010-03-02 11:42:11 -08002508 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002509
Mike Cleronf116bf82009-09-27 19:14:12 -07002510 if (!fadeScrollbars) {
2511 scrollabilityCache.state = ScrollabilityCache.ON;
2512 }
2513 scrollabilityCache.fadeScrollBars = fadeScrollbars;
2514
2515
2516 scrollabilityCache.scrollBarFadeDuration = a.getInt(
2517 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
2518 .getScrollBarFadeDuration());
2519 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
2520 R.styleable.View_scrollbarDefaultDelayBeforeFade,
2521 ViewConfiguration.getScrollDefaultDelay());
2522
2523
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002524 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
2525 com.android.internal.R.styleable.View_scrollbarSize,
2526 ViewConfiguration.get(mContext).getScaledScrollBarSize());
2527
2528 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
2529 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
2530
2531 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
2532 if (thumb != null) {
2533 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
2534 }
2535
2536 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
2537 false);
2538 if (alwaysDraw) {
2539 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
2540 }
2541
2542 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
2543 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
2544
2545 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
2546 if (thumb != null) {
2547 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
2548 }
2549
2550 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
2551 false);
2552 if (alwaysDraw) {
2553 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
2554 }
2555
2556 // Re-apply user/background padding so that scrollbar(s) get added
2557 recomputePadding();
2558 }
2559
2560 /**
2561 * <p>
2562 * Initalizes the scrollability cache if necessary.
2563 * </p>
2564 */
2565 private void initScrollCache() {
2566 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07002567 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002568 }
2569 }
2570
2571 /**
2572 * Register a callback to be invoked when focus of this view changed.
2573 *
2574 * @param l The callback that will run.
2575 */
2576 public void setOnFocusChangeListener(OnFocusChangeListener l) {
2577 mOnFocusChangeListener = l;
2578 }
2579
2580 /**
Chet Haase21cd1382010-09-01 17:42:29 -07002581 * Add a listener that will be called when the bounds of the view change due to
2582 * layout processing.
2583 *
2584 * @param listener The listener that will be called when layout bounds change.
2585 */
2586 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) {
2587 if (mOnLayoutChangeListeners == null) {
2588 mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>();
2589 }
2590 mOnLayoutChangeListeners.add(listener);
2591 }
2592
2593 /**
2594 * Remove a listener for layout changes.
2595 *
2596 * @param listener The listener for layout bounds change.
2597 */
2598 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) {
2599 if (mOnLayoutChangeListeners == null) {
2600 return;
2601 }
2602 mOnLayoutChangeListeners.remove(listener);
2603 }
2604
2605 /**
2606 * Gets the current list of listeners for layout changes.
2607 * @return
2608 */
2609 public List<OnLayoutChangeListener> getOnLayoutChangeListeners() {
2610 return mOnLayoutChangeListeners;
2611 }
2612
2613 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002614 * Returns the focus-change callback registered for this view.
2615 *
2616 * @return The callback, or null if one is not registered.
2617 */
2618 public OnFocusChangeListener getOnFocusChangeListener() {
2619 return mOnFocusChangeListener;
2620 }
2621
2622 /**
2623 * Register a callback to be invoked when this view is clicked. If this view is not
2624 * clickable, it becomes clickable.
2625 *
2626 * @param l The callback that will run
2627 *
2628 * @see #setClickable(boolean)
2629 */
2630 public void setOnClickListener(OnClickListener l) {
2631 if (!isClickable()) {
2632 setClickable(true);
2633 }
2634 mOnClickListener = l;
2635 }
2636
2637 /**
2638 * Register a callback to be invoked when this view is clicked and held. If this view is not
2639 * long clickable, it becomes long clickable.
2640 *
2641 * @param l The callback that will run
2642 *
2643 * @see #setLongClickable(boolean)
2644 */
2645 public void setOnLongClickListener(OnLongClickListener l) {
2646 if (!isLongClickable()) {
2647 setLongClickable(true);
2648 }
2649 mOnLongClickListener = l;
2650 }
2651
2652 /**
2653 * Register a callback to be invoked when the context menu for this view is
2654 * being built. If this view is not long clickable, it becomes long clickable.
2655 *
2656 * @param l The callback that will run
2657 *
2658 */
2659 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
2660 if (!isLongClickable()) {
2661 setLongClickable(true);
2662 }
2663 mOnCreateContextMenuListener = l;
2664 }
2665
2666 /**
2667 * Call this view's OnClickListener, if it is defined.
2668 *
2669 * @return True there was an assigned OnClickListener that was called, false
2670 * otherwise is returned.
2671 */
2672 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07002673 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
2674
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002675 if (mOnClickListener != null) {
2676 playSoundEffect(SoundEffectConstants.CLICK);
2677 mOnClickListener.onClick(this);
2678 return true;
2679 }
2680
2681 return false;
2682 }
2683
2684 /**
Gilles Debunnef788a9f2010-07-22 10:17:23 -07002685 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the
2686 * OnLongClickListener did not consume the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002687 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07002688 * @return True if one of the above receivers consumed the event, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002689 */
2690 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07002691 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
2692
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002693 boolean handled = false;
2694 if (mOnLongClickListener != null) {
2695 handled = mOnLongClickListener.onLongClick(View.this);
2696 }
2697 if (!handled) {
2698 handled = showContextMenu();
2699 }
2700 if (handled) {
2701 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
2702 }
2703 return handled;
2704 }
2705
2706 /**
2707 * Bring up the context menu for this view.
2708 *
2709 * @return Whether a context menu was displayed.
2710 */
2711 public boolean showContextMenu() {
2712 return getParent().showContextMenuForChild(this);
2713 }
2714
2715 /**
Adam Powell6e346362010-07-23 10:18:23 -07002716 * Start an action mode.
2717 *
2718 * @param callback Callback that will control the lifecycle of the action mode
2719 * @return The new action mode if it is started, null otherwise
2720 *
2721 * @see ActionMode
2722 */
2723 public ActionMode startActionMode(ActionMode.Callback callback) {
2724 return getParent().startActionModeForChild(this, callback);
2725 }
2726
2727 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002728 * Register a callback to be invoked when a key is pressed in this view.
2729 * @param l the key listener to attach to this view
2730 */
2731 public void setOnKeyListener(OnKeyListener l) {
2732 mOnKeyListener = l;
2733 }
2734
2735 /**
2736 * Register a callback to be invoked when a touch event is sent to this view.
2737 * @param l the touch listener to attach to this view
2738 */
2739 public void setOnTouchListener(OnTouchListener l) {
2740 mOnTouchListener = l;
2741 }
2742
2743 /**
2744 * Give this view focus. This will cause {@link #onFocusChanged} to be called.
2745 *
2746 * Note: this does not check whether this {@link View} should get focus, it just
2747 * gives it focus no matter what. It should only be called internally by framework
2748 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
2749 *
2750 * @param direction values are View.FOCUS_UP, View.FOCUS_DOWN,
2751 * View.FOCUS_LEFT or View.FOCUS_RIGHT. This is the direction which
2752 * focus moved when requestFocus() is called. It may not always
2753 * apply, in which case use the default View.FOCUS_DOWN.
2754 * @param previouslyFocusedRect The rectangle of the view that had focus
2755 * prior in this View's coordinate system.
2756 */
2757 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
2758 if (DBG) {
2759 System.out.println(this + " requestFocus()");
2760 }
2761
2762 if ((mPrivateFlags & FOCUSED) == 0) {
2763 mPrivateFlags |= FOCUSED;
2764
2765 if (mParent != null) {
2766 mParent.requestChildFocus(this, this);
2767 }
2768
2769 onFocusChanged(true, direction, previouslyFocusedRect);
2770 refreshDrawableState();
2771 }
2772 }
2773
2774 /**
2775 * Request that a rectangle of this view be visible on the screen,
2776 * scrolling if necessary just enough.
2777 *
2778 * <p>A View should call this if it maintains some notion of which part
2779 * of its content is interesting. For example, a text editing view
2780 * should call this when its cursor moves.
2781 *
2782 * @param rectangle The rectangle.
2783 * @return Whether any parent scrolled.
2784 */
2785 public boolean requestRectangleOnScreen(Rect rectangle) {
2786 return requestRectangleOnScreen(rectangle, false);
2787 }
2788
2789 /**
2790 * Request that a rectangle of this view be visible on the screen,
2791 * scrolling if necessary just enough.
2792 *
2793 * <p>A View should call this if it maintains some notion of which part
2794 * of its content is interesting. For example, a text editing view
2795 * should call this when its cursor moves.
2796 *
2797 * <p>When <code>immediate</code> is set to true, scrolling will not be
2798 * animated.
2799 *
2800 * @param rectangle The rectangle.
2801 * @param immediate True to forbid animated scrolling, false otherwise
2802 * @return Whether any parent scrolled.
2803 */
2804 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
2805 View child = this;
2806 ViewParent parent = mParent;
2807 boolean scrolled = false;
2808 while (parent != null) {
2809 scrolled |= parent.requestChildRectangleOnScreen(child,
2810 rectangle, immediate);
2811
2812 // offset rect so next call has the rectangle in the
2813 // coordinate system of its direct child.
2814 rectangle.offset(child.getLeft(), child.getTop());
2815 rectangle.offset(-child.getScrollX(), -child.getScrollY());
2816
2817 if (!(parent instanceof View)) {
2818 break;
2819 }
Romain Guy8506ab42009-06-11 17:35:47 -07002820
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002821 child = (View) parent;
2822 parent = child.getParent();
2823 }
2824 return scrolled;
2825 }
2826
2827 /**
2828 * Called when this view wants to give up focus. This will cause
2829 * {@link #onFocusChanged} to be called.
2830 */
2831 public void clearFocus() {
2832 if (DBG) {
2833 System.out.println(this + " clearFocus()");
2834 }
2835
2836 if ((mPrivateFlags & FOCUSED) != 0) {
2837 mPrivateFlags &= ~FOCUSED;
2838
2839 if (mParent != null) {
2840 mParent.clearChildFocus(this);
2841 }
2842
2843 onFocusChanged(false, 0, null);
2844 refreshDrawableState();
2845 }
2846 }
2847
2848 /**
2849 * Called to clear the focus of a view that is about to be removed.
2850 * Doesn't call clearChildFocus, which prevents this view from taking
2851 * focus again before it has been removed from the parent
2852 */
2853 void clearFocusForRemoval() {
2854 if ((mPrivateFlags & FOCUSED) != 0) {
2855 mPrivateFlags &= ~FOCUSED;
2856
2857 onFocusChanged(false, 0, null);
2858 refreshDrawableState();
2859 }
2860 }
2861
2862 /**
2863 * Called internally by the view system when a new view is getting focus.
2864 * This is what clears the old focus.
2865 */
2866 void unFocus() {
2867 if (DBG) {
2868 System.out.println(this + " unFocus()");
2869 }
2870
2871 if ((mPrivateFlags & FOCUSED) != 0) {
2872 mPrivateFlags &= ~FOCUSED;
2873
2874 onFocusChanged(false, 0, null);
2875 refreshDrawableState();
2876 }
2877 }
2878
2879 /**
2880 * Returns true if this view has focus iteself, or is the ancestor of the
2881 * view that has focus.
2882 *
2883 * @return True if this view has or contains focus, false otherwise.
2884 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002885 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002886 public boolean hasFocus() {
2887 return (mPrivateFlags & FOCUSED) != 0;
2888 }
2889
2890 /**
2891 * Returns true if this view is focusable or if it contains a reachable View
2892 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
2893 * is a View whose parents do not block descendants focus.
2894 *
2895 * Only {@link #VISIBLE} views are considered focusable.
2896 *
2897 * @return True if the view is focusable or if the view contains a focusable
2898 * View, false otherwise.
2899 *
2900 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
2901 */
2902 public boolean hasFocusable() {
2903 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
2904 }
2905
2906 /**
2907 * Called by the view system when the focus state of this view changes.
2908 * When the focus change event is caused by directional navigation, direction
2909 * and previouslyFocusedRect provide insight into where the focus is coming from.
2910 * When overriding, be sure to call up through to the super class so that
2911 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07002912 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002913 * @param gainFocus True if the View has focus; false otherwise.
2914 * @param direction The direction focus has moved when requestFocus()
2915 * is called to give this view focus. Values are
Romain Guyea4823c2009-12-08 15:03:39 -08002916 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT} or
2917 * {@link #FOCUS_RIGHT}. It may not always apply, in which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002918 * case use the default.
2919 * @param previouslyFocusedRect The rectangle, in this view's coordinate
2920 * system, of the previously focused view. If applicable, this will be
2921 * passed in as finer grained information about where the focus is coming
2922 * from (in addition to direction). Will be <code>null</code> otherwise.
2923 */
2924 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07002925 if (gainFocus) {
2926 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
2927 }
2928
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002929 InputMethodManager imm = InputMethodManager.peekInstance();
2930 if (!gainFocus) {
2931 if (isPressed()) {
2932 setPressed(false);
2933 }
2934 if (imm != null && mAttachInfo != null
2935 && mAttachInfo.mHasWindowFocus) {
2936 imm.focusOut(this);
2937 }
Romain Guya2431d02009-04-30 16:30:00 -07002938 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002939 } else if (imm != null && mAttachInfo != null
2940 && mAttachInfo.mHasWindowFocus) {
2941 imm.focusIn(this);
2942 }
Romain Guy8506ab42009-06-11 17:35:47 -07002943
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002944 invalidate();
2945 if (mOnFocusChangeListener != null) {
2946 mOnFocusChangeListener.onFocusChange(this, gainFocus);
2947 }
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07002948
2949 if (mAttachInfo != null) {
2950 mAttachInfo.mKeyDispatchState.reset(this);
2951 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002952 }
2953
2954 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002955 * {@inheritDoc}
2956 */
2957 public void sendAccessibilityEvent(int eventType) {
2958 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
2959 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
2960 }
2961 }
2962
2963 /**
2964 * {@inheritDoc}
2965 */
2966 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
2967 event.setClassName(getClass().getName());
2968 event.setPackageName(getContext().getPackageName());
2969 event.setEnabled(isEnabled());
2970 event.setContentDescription(mContentDescription);
2971
2972 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) {
2973 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList;
2974 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, FOCUSABLES_ALL);
2975 event.setItemCount(focusablesTempList.size());
2976 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
2977 focusablesTempList.clear();
2978 }
2979
2980 dispatchPopulateAccessibilityEvent(event);
2981
2982 AccessibilityManager.getInstance(mContext).sendAccessibilityEvent(event);
2983 }
2984
2985 /**
2986 * Dispatches an {@link AccessibilityEvent} to the {@link View} children
2987 * to be populated.
2988 *
2989 * @param event The event.
2990 *
2991 * @return True if the event population was completed.
2992 */
2993 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
2994 return false;
2995 }
2996
2997 /**
2998 * Gets the {@link View} description. It briefly describes the view and is
2999 * primarily used for accessibility support. Set this property to enable
3000 * better accessibility support for your application. This is especially
3001 * true for views that do not have textual representation (For example,
3002 * ImageButton).
3003 *
3004 * @return The content descriptiopn.
3005 *
3006 * @attr ref android.R.styleable#View_contentDescription
3007 */
3008 public CharSequence getContentDescription() {
3009 return mContentDescription;
3010 }
3011
3012 /**
3013 * Sets the {@link View} description. It briefly describes the view and is
3014 * primarily used for accessibility support. Set this property to enable
3015 * better accessibility support for your application. This is especially
3016 * true for views that do not have textual representation (For example,
3017 * ImageButton).
3018 *
3019 * @param contentDescription The content description.
3020 *
3021 * @attr ref android.R.styleable#View_contentDescription
3022 */
3023 public void setContentDescription(CharSequence contentDescription) {
3024 mContentDescription = contentDescription;
3025 }
3026
3027 /**
Romain Guya2431d02009-04-30 16:30:00 -07003028 * Invoked whenever this view loses focus, either by losing window focus or by losing
3029 * focus within its window. This method can be used to clear any state tied to the
3030 * focus. For instance, if a button is held pressed with the trackball and the window
3031 * loses focus, this method can be used to cancel the press.
3032 *
3033 * Subclasses of View overriding this method should always call super.onFocusLost().
3034 *
3035 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07003036 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07003037 *
3038 * @hide pending API council approval
3039 */
3040 protected void onFocusLost() {
3041 resetPressedState();
3042 }
3043
3044 private void resetPressedState() {
3045 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
3046 return;
3047 }
3048
3049 if (isPressed()) {
3050 setPressed(false);
3051
3052 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05003053 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07003054 }
3055 }
3056 }
3057
3058 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003059 * Returns true if this view has focus
3060 *
3061 * @return True if this view has focus, false otherwise.
3062 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003063 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003064 public boolean isFocused() {
3065 return (mPrivateFlags & FOCUSED) != 0;
3066 }
3067
3068 /**
3069 * Find the view in the hierarchy rooted at this view that currently has
3070 * focus.
3071 *
3072 * @return The view that currently has focus, or null if no focused view can
3073 * be found.
3074 */
3075 public View findFocus() {
3076 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
3077 }
3078
3079 /**
3080 * Change whether this view is one of the set of scrollable containers in
3081 * its window. This will be used to determine whether the window can
3082 * resize or must pan when a soft input area is open -- scrollable
3083 * containers allow the window to use resize mode since the container
3084 * will appropriately shrink.
3085 */
3086 public void setScrollContainer(boolean isScrollContainer) {
3087 if (isScrollContainer) {
3088 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
3089 mAttachInfo.mScrollContainers.add(this);
3090 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
3091 }
3092 mPrivateFlags |= SCROLL_CONTAINER;
3093 } else {
3094 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
3095 mAttachInfo.mScrollContainers.remove(this);
3096 }
3097 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
3098 }
3099 }
3100
3101 /**
3102 * Returns the quality of the drawing cache.
3103 *
3104 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3105 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3106 *
3107 * @see #setDrawingCacheQuality(int)
3108 * @see #setDrawingCacheEnabled(boolean)
3109 * @see #isDrawingCacheEnabled()
3110 *
3111 * @attr ref android.R.styleable#View_drawingCacheQuality
3112 */
3113 public int getDrawingCacheQuality() {
3114 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
3115 }
3116
3117 /**
3118 * Set the drawing cache quality of this view. This value is used only when the
3119 * drawing cache is enabled
3120 *
3121 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3122 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3123 *
3124 * @see #getDrawingCacheQuality()
3125 * @see #setDrawingCacheEnabled(boolean)
3126 * @see #isDrawingCacheEnabled()
3127 *
3128 * @attr ref android.R.styleable#View_drawingCacheQuality
3129 */
3130 public void setDrawingCacheQuality(int quality) {
3131 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
3132 }
3133
3134 /**
3135 * Returns whether the screen should remain on, corresponding to the current
3136 * value of {@link #KEEP_SCREEN_ON}.
3137 *
3138 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
3139 *
3140 * @see #setKeepScreenOn(boolean)
3141 *
3142 * @attr ref android.R.styleable#View_keepScreenOn
3143 */
3144 public boolean getKeepScreenOn() {
3145 return (mViewFlags & KEEP_SCREEN_ON) != 0;
3146 }
3147
3148 /**
3149 * Controls whether the screen should remain on, modifying the
3150 * value of {@link #KEEP_SCREEN_ON}.
3151 *
3152 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
3153 *
3154 * @see #getKeepScreenOn()
3155 *
3156 * @attr ref android.R.styleable#View_keepScreenOn
3157 */
3158 public void setKeepScreenOn(boolean keepScreenOn) {
3159 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
3160 }
3161
3162 /**
3163 * @return The user specified next focus ID.
3164 *
3165 * @attr ref android.R.styleable#View_nextFocusLeft
3166 */
3167 public int getNextFocusLeftId() {
3168 return mNextFocusLeftId;
3169 }
3170
3171 /**
3172 * Set the id of the view to use for the next focus
3173 *
3174 * @param nextFocusLeftId
3175 *
3176 * @attr ref android.R.styleable#View_nextFocusLeft
3177 */
3178 public void setNextFocusLeftId(int nextFocusLeftId) {
3179 mNextFocusLeftId = nextFocusLeftId;
3180 }
3181
3182 /**
3183 * @return The user specified next focus ID.
3184 *
3185 * @attr ref android.R.styleable#View_nextFocusRight
3186 */
3187 public int getNextFocusRightId() {
3188 return mNextFocusRightId;
3189 }
3190
3191 /**
3192 * Set the id of the view to use for the next focus
3193 *
3194 * @param nextFocusRightId
3195 *
3196 * @attr ref android.R.styleable#View_nextFocusRight
3197 */
3198 public void setNextFocusRightId(int nextFocusRightId) {
3199 mNextFocusRightId = nextFocusRightId;
3200 }
3201
3202 /**
3203 * @return The user specified next focus ID.
3204 *
3205 * @attr ref android.R.styleable#View_nextFocusUp
3206 */
3207 public int getNextFocusUpId() {
3208 return mNextFocusUpId;
3209 }
3210
3211 /**
3212 * Set the id of the view to use for the next focus
3213 *
3214 * @param nextFocusUpId
3215 *
3216 * @attr ref android.R.styleable#View_nextFocusUp
3217 */
3218 public void setNextFocusUpId(int nextFocusUpId) {
3219 mNextFocusUpId = nextFocusUpId;
3220 }
3221
3222 /**
3223 * @return The user specified next focus ID.
3224 *
3225 * @attr ref android.R.styleable#View_nextFocusDown
3226 */
3227 public int getNextFocusDownId() {
3228 return mNextFocusDownId;
3229 }
3230
3231 /**
3232 * Set the id of the view to use for the next focus
3233 *
3234 * @param nextFocusDownId
3235 *
3236 * @attr ref android.R.styleable#View_nextFocusDown
3237 */
3238 public void setNextFocusDownId(int nextFocusDownId) {
3239 mNextFocusDownId = nextFocusDownId;
3240 }
3241
3242 /**
3243 * Returns the visibility of this view and all of its ancestors
3244 *
3245 * @return True if this view and all of its ancestors are {@link #VISIBLE}
3246 */
3247 public boolean isShown() {
3248 View current = this;
3249 //noinspection ConstantConditions
3250 do {
3251 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
3252 return false;
3253 }
3254 ViewParent parent = current.mParent;
3255 if (parent == null) {
3256 return false; // We are not attached to the view root
3257 }
3258 if (!(parent instanceof View)) {
3259 return true;
3260 }
3261 current = (View) parent;
3262 } while (current != null);
3263
3264 return false;
3265 }
3266
3267 /**
3268 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag
3269 * is set
3270 *
3271 * @param insets Insets for system windows
3272 *
3273 * @return True if this view applied the insets, false otherwise
3274 */
3275 protected boolean fitSystemWindows(Rect insets) {
3276 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
3277 mPaddingLeft = insets.left;
3278 mPaddingTop = insets.top;
3279 mPaddingRight = insets.right;
3280 mPaddingBottom = insets.bottom;
3281 requestLayout();
3282 return true;
3283 }
3284 return false;
3285 }
3286
3287 /**
Jim Miller0b2a6d02010-07-13 18:01:29 -07003288 * Determine if this view has the FITS_SYSTEM_WINDOWS flag set.
3289 * @return True if window has FITS_SYSTEM_WINDOWS set
3290 *
3291 * @hide
3292 */
3293 public boolean isFitsSystemWindowsFlagSet() {
3294 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
3295 }
3296
3297 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003298 * Returns the visibility status for this view.
3299 *
3300 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3301 * @attr ref android.R.styleable#View_visibility
3302 */
3303 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07003304 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
3305 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
3306 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003307 })
3308 public int getVisibility() {
3309 return mViewFlags & VISIBILITY_MASK;
3310 }
3311
3312 /**
3313 * Set the enabled state of this view.
3314 *
3315 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3316 * @attr ref android.R.styleable#View_visibility
3317 */
3318 @RemotableViewMethod
3319 public void setVisibility(int visibility) {
3320 setFlags(visibility, VISIBILITY_MASK);
3321 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false);
3322 }
3323
3324 /**
3325 * Returns the enabled status for this view. The interpretation of the
3326 * enabled state varies by subclass.
3327 *
3328 * @return True if this view is enabled, false otherwise.
3329 */
3330 @ViewDebug.ExportedProperty
3331 public boolean isEnabled() {
3332 return (mViewFlags & ENABLED_MASK) == ENABLED;
3333 }
3334
3335 /**
3336 * Set the enabled state of this view. The interpretation of the enabled
3337 * state varies by subclass.
3338 *
3339 * @param enabled True if this view is enabled, false otherwise.
3340 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08003341 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003342 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07003343 if (enabled == isEnabled()) return;
3344
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003345 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
3346
3347 /*
3348 * The View most likely has to change its appearance, so refresh
3349 * the drawable state.
3350 */
3351 refreshDrawableState();
3352
3353 // Invalidate too, since the default behavior for views is to be
3354 // be drawn at 50% alpha rather than to change the drawable.
3355 invalidate();
3356 }
3357
3358 /**
3359 * Set whether this view can receive the focus.
3360 *
3361 * Setting this to false will also ensure that this view is not focusable
3362 * in touch mode.
3363 *
3364 * @param focusable If true, this view can receive the focus.
3365 *
3366 * @see #setFocusableInTouchMode(boolean)
3367 * @attr ref android.R.styleable#View_focusable
3368 */
3369 public void setFocusable(boolean focusable) {
3370 if (!focusable) {
3371 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
3372 }
3373 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
3374 }
3375
3376 /**
3377 * Set whether this view can receive focus while in touch mode.
3378 *
3379 * Setting this to true will also ensure that this view is focusable.
3380 *
3381 * @param focusableInTouchMode If true, this view can receive the focus while
3382 * in touch mode.
3383 *
3384 * @see #setFocusable(boolean)
3385 * @attr ref android.R.styleable#View_focusableInTouchMode
3386 */
3387 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
3388 // Focusable in touch mode should always be set before the focusable flag
3389 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
3390 // which, in touch mode, will not successfully request focus on this view
3391 // because the focusable in touch mode flag is not set
3392 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
3393 if (focusableInTouchMode) {
3394 setFlags(FOCUSABLE, FOCUSABLE_MASK);
3395 }
3396 }
3397
3398 /**
3399 * Set whether this view should have sound effects enabled for events such as
3400 * clicking and touching.
3401 *
3402 * <p>You may wish to disable sound effects for a view if you already play sounds,
3403 * for instance, a dial key that plays dtmf tones.
3404 *
3405 * @param soundEffectsEnabled whether sound effects are enabled for this view.
3406 * @see #isSoundEffectsEnabled()
3407 * @see #playSoundEffect(int)
3408 * @attr ref android.R.styleable#View_soundEffectsEnabled
3409 */
3410 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
3411 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
3412 }
3413
3414 /**
3415 * @return whether this view should have sound effects enabled for events such as
3416 * clicking and touching.
3417 *
3418 * @see #setSoundEffectsEnabled(boolean)
3419 * @see #playSoundEffect(int)
3420 * @attr ref android.R.styleable#View_soundEffectsEnabled
3421 */
3422 @ViewDebug.ExportedProperty
3423 public boolean isSoundEffectsEnabled() {
3424 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
3425 }
3426
3427 /**
3428 * Set whether this view should have haptic feedback for events such as
3429 * long presses.
3430 *
3431 * <p>You may wish to disable haptic feedback if your view already controls
3432 * its own haptic feedback.
3433 *
3434 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
3435 * @see #isHapticFeedbackEnabled()
3436 * @see #performHapticFeedback(int)
3437 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3438 */
3439 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
3440 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
3441 }
3442
3443 /**
3444 * @return whether this view should have haptic feedback enabled for events
3445 * long presses.
3446 *
3447 * @see #setHapticFeedbackEnabled(boolean)
3448 * @see #performHapticFeedback(int)
3449 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3450 */
3451 @ViewDebug.ExportedProperty
3452 public boolean isHapticFeedbackEnabled() {
3453 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
3454 }
3455
3456 /**
3457 * If this view doesn't do any drawing on its own, set this flag to
3458 * allow further optimizations. By default, this flag is not set on
3459 * View, but could be set on some View subclasses such as ViewGroup.
3460 *
3461 * Typically, if you override {@link #onDraw} you should clear this flag.
3462 *
3463 * @param willNotDraw whether or not this View draw on its own
3464 */
3465 public void setWillNotDraw(boolean willNotDraw) {
3466 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
3467 }
3468
3469 /**
3470 * Returns whether or not this View draws on its own.
3471 *
3472 * @return true if this view has nothing to draw, false otherwise
3473 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003474 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003475 public boolean willNotDraw() {
3476 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
3477 }
3478
3479 /**
3480 * When a View's drawing cache is enabled, drawing is redirected to an
3481 * offscreen bitmap. Some views, like an ImageView, must be able to
3482 * bypass this mechanism if they already draw a single bitmap, to avoid
3483 * unnecessary usage of the memory.
3484 *
3485 * @param willNotCacheDrawing true if this view does not cache its
3486 * drawing, false otherwise
3487 */
3488 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
3489 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
3490 }
3491
3492 /**
3493 * Returns whether or not this View can cache its drawing or not.
3494 *
3495 * @return true if this view does not cache its drawing, false otherwise
3496 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003497 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003498 public boolean willNotCacheDrawing() {
3499 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
3500 }
3501
3502 /**
3503 * Indicates whether this view reacts to click events or not.
3504 *
3505 * @return true if the view is clickable, false otherwise
3506 *
3507 * @see #setClickable(boolean)
3508 * @attr ref android.R.styleable#View_clickable
3509 */
3510 @ViewDebug.ExportedProperty
3511 public boolean isClickable() {
3512 return (mViewFlags & CLICKABLE) == CLICKABLE;
3513 }
3514
3515 /**
3516 * Enables or disables click events for this view. When a view
3517 * is clickable it will change its state to "pressed" on every click.
3518 * Subclasses should set the view clickable to visually react to
3519 * user's clicks.
3520 *
3521 * @param clickable true to make the view clickable, false otherwise
3522 *
3523 * @see #isClickable()
3524 * @attr ref android.R.styleable#View_clickable
3525 */
3526 public void setClickable(boolean clickable) {
3527 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
3528 }
3529
3530 /**
3531 * Indicates whether this view reacts to long click events or not.
3532 *
3533 * @return true if the view is long clickable, false otherwise
3534 *
3535 * @see #setLongClickable(boolean)
3536 * @attr ref android.R.styleable#View_longClickable
3537 */
3538 public boolean isLongClickable() {
3539 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
3540 }
3541
3542 /**
3543 * Enables or disables long click events for this view. When a view is long
3544 * clickable it reacts to the user holding down the button for a longer
3545 * duration than a tap. This event can either launch the listener or a
3546 * context menu.
3547 *
3548 * @param longClickable true to make the view long clickable, false otherwise
3549 * @see #isLongClickable()
3550 * @attr ref android.R.styleable#View_longClickable
3551 */
3552 public void setLongClickable(boolean longClickable) {
3553 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
3554 }
3555
3556 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07003557 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003558 *
3559 * @see #isClickable()
3560 * @see #setClickable(boolean)
3561 *
3562 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
3563 * the View's internal state from a previously set "pressed" state.
3564 */
3565 public void setPressed(boolean pressed) {
3566 if (pressed) {
3567 mPrivateFlags |= PRESSED;
3568 } else {
3569 mPrivateFlags &= ~PRESSED;
3570 }
3571 refreshDrawableState();
3572 dispatchSetPressed(pressed);
3573 }
3574
3575 /**
3576 * Dispatch setPressed to all of this View's children.
3577 *
3578 * @see #setPressed(boolean)
3579 *
3580 * @param pressed The new pressed state
3581 */
3582 protected void dispatchSetPressed(boolean pressed) {
3583 }
3584
3585 /**
3586 * Indicates whether the view is currently in pressed state. Unless
3587 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
3588 * the pressed state.
3589 *
3590 * @see #setPressed
3591 * @see #isClickable()
3592 * @see #setClickable(boolean)
3593 *
3594 * @return true if the view is currently pressed, false otherwise
3595 */
3596 public boolean isPressed() {
3597 return (mPrivateFlags & PRESSED) == PRESSED;
3598 }
3599
3600 /**
3601 * Indicates whether this view will save its state (that is,
3602 * whether its {@link #onSaveInstanceState} method will be called).
3603 *
3604 * @return Returns true if the view state saving is enabled, else false.
3605 *
3606 * @see #setSaveEnabled(boolean)
3607 * @attr ref android.R.styleable#View_saveEnabled
3608 */
3609 public boolean isSaveEnabled() {
3610 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
3611 }
3612
3613 /**
3614 * Controls whether the saving of this view's state is
3615 * enabled (that is, whether its {@link #onSaveInstanceState} method
3616 * will be called). Note that even if freezing is enabled, the
3617 * view still must have an id assigned to it (via {@link #setId setId()})
3618 * for its state to be saved. This flag can only disable the
3619 * saving of this view; any child views may still have their state saved.
3620 *
3621 * @param enabled Set to false to <em>disable</em> state saving, or true
3622 * (the default) to allow it.
3623 *
3624 * @see #isSaveEnabled()
3625 * @see #setId(int)
3626 * @see #onSaveInstanceState()
3627 * @attr ref android.R.styleable#View_saveEnabled
3628 */
3629 public void setSaveEnabled(boolean enabled) {
3630 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
3631 }
3632
Jeff Brown85a31762010-09-01 17:01:00 -07003633 /**
3634 * Gets whether the framework should discard touches when the view's
3635 * window is obscured by another visible window.
3636 * Refer to the {@link View} security documentation for more details.
3637 *
3638 * @return True if touch filtering is enabled.
3639 *
3640 * @see #setFilterTouchesWhenObscured(boolean)
3641 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
3642 */
3643 @ViewDebug.ExportedProperty
3644 public boolean getFilterTouchesWhenObscured() {
3645 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
3646 }
3647
3648 /**
3649 * Sets whether the framework should discard touches when the view's
3650 * window is obscured by another visible window.
3651 * Refer to the {@link View} security documentation for more details.
3652 *
3653 * @param enabled True if touch filtering should be enabled.
3654 *
3655 * @see #getFilterTouchesWhenObscured
3656 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
3657 */
3658 public void setFilterTouchesWhenObscured(boolean enabled) {
3659 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
3660 FILTER_TOUCHES_WHEN_OBSCURED);
3661 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003662
3663 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07003664 * Indicates whether the entire hierarchy under this view will save its
3665 * state when a state saving traversal occurs from its parent. The default
3666 * is true; if false, these views will not be saved unless
3667 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
3668 *
3669 * @return Returns true if the view state saving from parent is enabled, else false.
3670 *
3671 * @see #setSaveFromParentEnabled(boolean)
3672 */
3673 public boolean isSaveFromParentEnabled() {
3674 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
3675 }
3676
3677 /**
3678 * Controls whether the entire hierarchy under this view will save its
3679 * state when a state saving traversal occurs from its parent. The default
3680 * is true; if false, these views will not be saved unless
3681 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
3682 *
3683 * @param enabled Set to false to <em>disable</em> state saving, or true
3684 * (the default) to allow it.
3685 *
3686 * @see #isSaveFromParentEnabled()
3687 * @see #setId(int)
3688 * @see #onSaveInstanceState()
3689 */
3690 public void setSaveFromParentEnabled(boolean enabled) {
3691 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
3692 }
3693
3694
3695 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003696 * Returns whether this View is able to take focus.
3697 *
3698 * @return True if this view can take focus, or false otherwise.
3699 * @attr ref android.R.styleable#View_focusable
3700 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003701 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003702 public final boolean isFocusable() {
3703 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
3704 }
3705
3706 /**
3707 * When a view is focusable, it may not want to take focus when in touch mode.
3708 * For example, a button would like focus when the user is navigating via a D-pad
3709 * so that the user can click on it, but once the user starts touching the screen,
3710 * the button shouldn't take focus
3711 * @return Whether the view is focusable in touch mode.
3712 * @attr ref android.R.styleable#View_focusableInTouchMode
3713 */
3714 @ViewDebug.ExportedProperty
3715 public final boolean isFocusableInTouchMode() {
3716 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
3717 }
3718
3719 /**
3720 * Find the nearest view in the specified direction that can take focus.
3721 * This does not actually give focus to that view.
3722 *
3723 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
3724 *
3725 * @return The nearest focusable in the specified direction, or null if none
3726 * can be found.
3727 */
3728 public View focusSearch(int direction) {
3729 if (mParent != null) {
3730 return mParent.focusSearch(this, direction);
3731 } else {
3732 return null;
3733 }
3734 }
3735
3736 /**
3737 * This method is the last chance for the focused view and its ancestors to
3738 * respond to an arrow key. This is called when the focused view did not
3739 * consume the key internally, nor could the view system find a new view in
3740 * the requested direction to give focus to.
3741 *
3742 * @param focused The currently focused view.
3743 * @param direction The direction focus wants to move. One of FOCUS_UP,
3744 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
3745 * @return True if the this view consumed this unhandled move.
3746 */
3747 public boolean dispatchUnhandledMove(View focused, int direction) {
3748 return false;
3749 }
3750
3751 /**
3752 * If a user manually specified the next view id for a particular direction,
3753 * use the root to look up the view. Once a view is found, it is cached
3754 * for future lookups.
3755 * @param root The root view of the hierarchy containing this view.
3756 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
3757 * @return The user specified next view, or null if there is none.
3758 */
3759 View findUserSetNextFocus(View root, int direction) {
3760 switch (direction) {
3761 case FOCUS_LEFT:
3762 if (mNextFocusLeftId == View.NO_ID) return null;
3763 return findViewShouldExist(root, mNextFocusLeftId);
3764 case FOCUS_RIGHT:
3765 if (mNextFocusRightId == View.NO_ID) return null;
3766 return findViewShouldExist(root, mNextFocusRightId);
3767 case FOCUS_UP:
3768 if (mNextFocusUpId == View.NO_ID) return null;
3769 return findViewShouldExist(root, mNextFocusUpId);
3770 case FOCUS_DOWN:
3771 if (mNextFocusDownId == View.NO_ID) return null;
3772 return findViewShouldExist(root, mNextFocusDownId);
3773 }
3774 return null;
3775 }
3776
3777 private static View findViewShouldExist(View root, int childViewId) {
3778 View result = root.findViewById(childViewId);
3779 if (result == null) {
3780 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
3781 + "by user for id " + childViewId);
3782 }
3783 return result;
3784 }
3785
3786 /**
3787 * Find and return all focusable views that are descendants of this view,
3788 * possibly including this view if it is focusable itself.
3789 *
3790 * @param direction The direction of the focus
3791 * @return A list of focusable views
3792 */
3793 public ArrayList<View> getFocusables(int direction) {
3794 ArrayList<View> result = new ArrayList<View>(24);
3795 addFocusables(result, direction);
3796 return result;
3797 }
3798
3799 /**
3800 * Add any focusable views that are descendants of this view (possibly
3801 * including this view if it is focusable itself) to views. If we are in touch mode,
3802 * only add views that are also focusable in touch mode.
3803 *
3804 * @param views Focusable views found so far
3805 * @param direction The direction of the focus
3806 */
3807 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07003808 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
3809 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003810
svetoslavganov75986cf2009-05-14 22:28:01 -07003811 /**
3812 * Adds any focusable views that are descendants of this view (possibly
3813 * including this view if it is focusable itself) to views. This method
3814 * adds all focusable views regardless if we are in touch mode or
3815 * only views focusable in touch mode if we are in touch mode depending on
3816 * the focusable mode paramater.
3817 *
3818 * @param views Focusable views found so far or null if all we are interested is
3819 * the number of focusables.
3820 * @param direction The direction of the focus.
3821 * @param focusableMode The type of focusables to be added.
3822 *
3823 * @see #FOCUSABLES_ALL
3824 * @see #FOCUSABLES_TOUCH_MODE
3825 */
3826 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
3827 if (!isFocusable()) {
3828 return;
3829 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003830
svetoslavganov75986cf2009-05-14 22:28:01 -07003831 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE &&
3832 isInTouchMode() && !isFocusableInTouchMode()) {
3833 return;
3834 }
3835
3836 if (views != null) {
3837 views.add(this);
3838 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003839 }
3840
3841 /**
3842 * Find and return all touchable views that are descendants of this view,
3843 * possibly including this view if it is touchable itself.
3844 *
3845 * @return A list of touchable views
3846 */
3847 public ArrayList<View> getTouchables() {
3848 ArrayList<View> result = new ArrayList<View>();
3849 addTouchables(result);
3850 return result;
3851 }
3852
3853 /**
3854 * Add any touchable views that are descendants of this view (possibly
3855 * including this view if it is touchable itself) to views.
3856 *
3857 * @param views Touchable views found so far
3858 */
3859 public void addTouchables(ArrayList<View> views) {
3860 final int viewFlags = mViewFlags;
3861
3862 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
3863 && (viewFlags & ENABLED_MASK) == ENABLED) {
3864 views.add(this);
3865 }
3866 }
3867
3868 /**
3869 * Call this to try to give focus to a specific view or to one of its
3870 * descendants.
3871 *
3872 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
3873 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
3874 * while the device is in touch mode.
3875 *
3876 * See also {@link #focusSearch}, which is what you call to say that you
3877 * have focus, and you want your parent to look for the next one.
3878 *
3879 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
3880 * {@link #FOCUS_DOWN} and <code>null</code>.
3881 *
3882 * @return Whether this view or one of its descendants actually took focus.
3883 */
3884 public final boolean requestFocus() {
3885 return requestFocus(View.FOCUS_DOWN);
3886 }
3887
3888
3889 /**
3890 * Call this to try to give focus to a specific view or to one of its
3891 * descendants and give it a hint about what direction focus is heading.
3892 *
3893 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
3894 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
3895 * while the device is in touch mode.
3896 *
3897 * See also {@link #focusSearch}, which is what you call to say that you
3898 * have focus, and you want your parent to look for the next one.
3899 *
3900 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
3901 * <code>null</code> set for the previously focused rectangle.
3902 *
3903 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
3904 * @return Whether this view or one of its descendants actually took focus.
3905 */
3906 public final boolean requestFocus(int direction) {
3907 return requestFocus(direction, null);
3908 }
3909
3910 /**
3911 * Call this to try to give focus to a specific view or to one of its descendants
3912 * and give it hints about the direction and a specific rectangle that the focus
3913 * is coming from. The rectangle can help give larger views a finer grained hint
3914 * about where focus is coming from, and therefore, where to show selection, or
3915 * forward focus change internally.
3916 *
3917 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
3918 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
3919 * while the device is in touch mode.
3920 *
3921 * A View will not take focus if it is not visible.
3922 *
3923 * A View will not take focus if one of its parents has {@link android.view.ViewGroup#getDescendantFocusability()}
3924 * equal to {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
3925 *
3926 * See also {@link #focusSearch}, which is what you call to say that you
3927 * have focus, and you want your parent to look for the next one.
3928 *
3929 * You may wish to override this method if your custom {@link View} has an internal
3930 * {@link View} that it wishes to forward the request to.
3931 *
3932 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
3933 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
3934 * to give a finer grained hint about where focus is coming from. May be null
3935 * if there is no hint.
3936 * @return Whether this view or one of its descendants actually took focus.
3937 */
3938 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
3939 // need to be focusable
3940 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
3941 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
3942 return false;
3943 }
3944
3945 // need to be focusable in touch mode if in touch mode
3946 if (isInTouchMode() &&
3947 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
3948 return false;
3949 }
3950
3951 // need to not have any parents blocking us
3952 if (hasAncestorThatBlocksDescendantFocus()) {
3953 return false;
3954 }
3955
3956 handleFocusGainInternal(direction, previouslyFocusedRect);
3957 return true;
3958 }
3959
Christopher Tate2c095f32010-10-04 14:13:40 -07003960 /** Gets the ViewRoot, or null if not attached. */
3961 /*package*/ ViewRoot getViewRoot() {
3962 View root = getRootView();
3963 return root != null ? (ViewRoot)root.getParent() : null;
3964 }
3965
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003966 /**
3967 * Call this to try to give focus to a specific view or to one of its descendants. This is a
3968 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
3969 * touch mode to request focus when they are touched.
3970 *
3971 * @return Whether this view or one of its descendants actually took focus.
3972 *
3973 * @see #isInTouchMode()
3974 *
3975 */
3976 public final boolean requestFocusFromTouch() {
3977 // Leave touch mode if we need to
3978 if (isInTouchMode()) {
Christopher Tate2c095f32010-10-04 14:13:40 -07003979 ViewRoot viewRoot = getViewRoot();
3980 if (viewRoot != null) {
3981 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003982 }
3983 }
3984 return requestFocus(View.FOCUS_DOWN);
3985 }
3986
3987 /**
3988 * @return Whether any ancestor of this view blocks descendant focus.
3989 */
3990 private boolean hasAncestorThatBlocksDescendantFocus() {
3991 ViewParent ancestor = mParent;
3992 while (ancestor instanceof ViewGroup) {
3993 final ViewGroup vgAncestor = (ViewGroup) ancestor;
3994 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
3995 return true;
3996 } else {
3997 ancestor = vgAncestor.getParent();
3998 }
3999 }
4000 return false;
4001 }
4002
4003 /**
Romain Guya440b002010-02-24 15:57:54 -08004004 * @hide
4005 */
4006 public void dispatchStartTemporaryDetach() {
4007 onStartTemporaryDetach();
4008 }
4009
4010 /**
4011 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004012 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
4013 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08004014 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004015 */
4016 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08004017 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08004018 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08004019 }
4020
4021 /**
4022 * @hide
4023 */
4024 public void dispatchFinishTemporaryDetach() {
4025 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004026 }
Romain Guy8506ab42009-06-11 17:35:47 -07004027
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004028 /**
4029 * Called after {@link #onStartTemporaryDetach} when the container is done
4030 * changing the view.
4031 */
4032 public void onFinishTemporaryDetach() {
4033 }
Romain Guy8506ab42009-06-11 17:35:47 -07004034
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004035 /**
4036 * capture information of this view for later analysis: developement only
4037 * check dynamic switch to make sure we only dump view
4038 * when ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW) is set
4039 */
4040 private static void captureViewInfo(String subTag, View v) {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07004041 if (v == null || SystemProperties.getInt(ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW, 0) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004042 return;
4043 }
4044 ViewDebug.dumpCapturedView(subTag, v);
4045 }
4046
4047 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004048 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
4049 * for this view's window. Returns null if the view is not currently attached
4050 * to the window. Normally you will not need to use this directly, but
4051 * just use the standard high-level event callbacks like {@link #onKeyDown}.
4052 */
4053 public KeyEvent.DispatcherState getKeyDispatcherState() {
4054 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
4055 }
4056
4057 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004058 * Dispatch a key event before it is processed by any input method
4059 * associated with the view hierarchy. This can be used to intercept
4060 * key events in special situations before the IME consumes them; a
4061 * typical example would be handling the BACK key to update the application's
4062 * UI instead of allowing the IME to see it and close itself.
4063 *
4064 * @param event The key event to be dispatched.
4065 * @return True if the event was handled, false otherwise.
4066 */
4067 public boolean dispatchKeyEventPreIme(KeyEvent event) {
4068 return onKeyPreIme(event.getKeyCode(), event);
4069 }
4070
4071 /**
4072 * Dispatch a key event to the next view on the focus path. This path runs
4073 * from the top of the view tree down to the currently focused view. If this
4074 * view has focus, it will dispatch to itself. Otherwise it will dispatch
4075 * the next node down the focus path. This method also fires any key
4076 * listeners.
4077 *
4078 * @param event The key event to be dispatched.
4079 * @return True if the event was handled, false otherwise.
4080 */
4081 public boolean dispatchKeyEvent(KeyEvent event) {
4082 // If any attached key listener a first crack at the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004083
Romain Guyf607bdc2010-09-10 19:20:06 -07004084 //noinspection SimplifiableIfStatement,deprecation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004085 if (android.util.Config.LOGV) {
4086 captureViewInfo("captureViewKeyEvent", this);
4087 }
4088
Romain Guyf607bdc2010-09-10 19:20:06 -07004089 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004090 if (mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
4091 && mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
4092 return true;
4093 }
4094
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004095 return event.dispatch(this, mAttachInfo != null
4096 ? mAttachInfo.mKeyDispatchState : null, this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004097 }
4098
4099 /**
4100 * Dispatches a key shortcut event.
4101 *
4102 * @param event The key event to be dispatched.
4103 * @return True if the event was handled by the view, false otherwise.
4104 */
4105 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
4106 return onKeyShortcut(event.getKeyCode(), event);
4107 }
4108
4109 /**
4110 * Pass the touch screen motion event down to the target view, or this
4111 * view if it is the target.
4112 *
4113 * @param event The motion event to be dispatched.
4114 * @return True if the event was handled by the view, false otherwise.
4115 */
4116 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown85a31762010-09-01 17:01:00 -07004117 if (!onFilterTouchEventForSecurity(event)) {
4118 return false;
4119 }
4120
Romain Guyf607bdc2010-09-10 19:20:06 -07004121 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004122 if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED &&
4123 mOnTouchListener.onTouch(this, event)) {
4124 return true;
4125 }
4126 return onTouchEvent(event);
4127 }
4128
4129 /**
Jeff Brown85a31762010-09-01 17:01:00 -07004130 * Filter the touch event to apply security policies.
4131 *
4132 * @param event The motion event to be filtered.
4133 * @return True if the event should be dispatched, false if the event should be dropped.
4134 *
4135 * @see #getFilterTouchesWhenObscured
4136 */
4137 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07004138 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07004139 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
4140 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
4141 // Window is obscured, drop this touch.
4142 return false;
4143 }
4144 return true;
4145 }
4146
4147 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004148 * Pass a trackball motion event down to the focused view.
4149 *
4150 * @param event The motion event to be dispatched.
4151 * @return True if the event was handled by the view, false otherwise.
4152 */
4153 public boolean dispatchTrackballEvent(MotionEvent event) {
4154 //Log.i("view", "view=" + this + ", " + event.toString());
4155 return onTrackballEvent(event);
4156 }
4157
4158 /**
4159 * Called when the window containing this view gains or loses window focus.
4160 * ViewGroups should override to route to their children.
4161 *
4162 * @param hasFocus True if the window containing this view now has focus,
4163 * false otherwise.
4164 */
4165 public void dispatchWindowFocusChanged(boolean hasFocus) {
4166 onWindowFocusChanged(hasFocus);
4167 }
4168
4169 /**
4170 * Called when the window containing this view gains or loses focus. Note
4171 * that this is separate from view focus: to receive key events, both
4172 * your view and its window must have focus. If a window is displayed
4173 * on top of yours that takes input focus, then your own window will lose
4174 * focus but the view focus will remain unchanged.
4175 *
4176 * @param hasWindowFocus True if the window containing this view now has
4177 * focus, false otherwise.
4178 */
4179 public void onWindowFocusChanged(boolean hasWindowFocus) {
4180 InputMethodManager imm = InputMethodManager.peekInstance();
4181 if (!hasWindowFocus) {
4182 if (isPressed()) {
4183 setPressed(false);
4184 }
4185 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4186 imm.focusOut(this);
4187 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05004188 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08004189 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004190 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004191 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4192 imm.focusIn(this);
4193 }
4194 refreshDrawableState();
4195 }
4196
4197 /**
4198 * Returns true if this view is in a window that currently has window focus.
4199 * Note that this is not the same as the view itself having focus.
4200 *
4201 * @return True if this view is in a window that currently has window focus.
4202 */
4203 public boolean hasWindowFocus() {
4204 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
4205 }
4206
4207 /**
Adam Powell326d8082009-12-09 15:10:07 -08004208 * Dispatch a view visibility change down the view hierarchy.
4209 * ViewGroups should override to route to their children.
4210 * @param changedView The view whose visibility changed. Could be 'this' or
4211 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004212 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4213 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004214 */
4215 protected void dispatchVisibilityChanged(View changedView, int visibility) {
4216 onVisibilityChanged(changedView, visibility);
4217 }
4218
4219 /**
4220 * Called when the visibility of the view or an ancestor of the view is changed.
4221 * @param changedView The view whose visibility changed. Could be 'this' or
4222 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004223 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4224 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004225 */
4226 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004227 if (visibility == VISIBLE) {
4228 if (mAttachInfo != null) {
4229 initialAwakenScrollBars();
4230 } else {
4231 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
4232 }
4233 }
Adam Powell326d8082009-12-09 15:10:07 -08004234 }
4235
4236 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08004237 * Dispatch a hint about whether this view is displayed. For instance, when
4238 * a View moves out of the screen, it might receives a display hint indicating
4239 * the view is not displayed. Applications should not <em>rely</em> on this hint
4240 * as there is no guarantee that they will receive one.
4241 *
4242 * @param hint A hint about whether or not this view is displayed:
4243 * {@link #VISIBLE} or {@link #INVISIBLE}.
4244 */
4245 public void dispatchDisplayHint(int hint) {
4246 onDisplayHint(hint);
4247 }
4248
4249 /**
4250 * Gives this view a hint about whether is displayed or not. For instance, when
4251 * a View moves out of the screen, it might receives a display hint indicating
4252 * the view is not displayed. Applications should not <em>rely</em> on this hint
4253 * as there is no guarantee that they will receive one.
4254 *
4255 * @param hint A hint about whether or not this view is displayed:
4256 * {@link #VISIBLE} or {@link #INVISIBLE}.
4257 */
4258 protected void onDisplayHint(int hint) {
4259 }
4260
4261 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004262 * Dispatch a window visibility change down the view hierarchy.
4263 * ViewGroups should override to route to their children.
4264 *
4265 * @param visibility The new visibility of the window.
4266 *
4267 * @see #onWindowVisibilityChanged
4268 */
4269 public void dispatchWindowVisibilityChanged(int visibility) {
4270 onWindowVisibilityChanged(visibility);
4271 }
4272
4273 /**
4274 * Called when the window containing has change its visibility
4275 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
4276 * that this tells you whether or not your window is being made visible
4277 * to the window manager; this does <em>not</em> tell you whether or not
4278 * your window is obscured by other windows on the screen, even if it
4279 * is itself visible.
4280 *
4281 * @param visibility The new visibility of the window.
4282 */
4283 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004284 if (visibility == VISIBLE) {
4285 initialAwakenScrollBars();
4286 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004287 }
4288
4289 /**
4290 * Returns the current visibility of the window this view is attached to
4291 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
4292 *
4293 * @return Returns the current visibility of the view's window.
4294 */
4295 public int getWindowVisibility() {
4296 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
4297 }
4298
4299 /**
4300 * Retrieve the overall visible display size in which the window this view is
4301 * attached to has been positioned in. This takes into account screen
4302 * decorations above the window, for both cases where the window itself
4303 * is being position inside of them or the window is being placed under
4304 * then and covered insets are used for the window to position its content
4305 * inside. In effect, this tells you the available area where content can
4306 * be placed and remain visible to users.
4307 *
4308 * <p>This function requires an IPC back to the window manager to retrieve
4309 * the requested information, so should not be used in performance critical
4310 * code like drawing.
4311 *
4312 * @param outRect Filled in with the visible display frame. If the view
4313 * is not attached to a window, this is simply the raw display size.
4314 */
4315 public void getWindowVisibleDisplayFrame(Rect outRect) {
4316 if (mAttachInfo != null) {
4317 try {
4318 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
4319 } catch (RemoteException e) {
4320 return;
4321 }
4322 // XXX This is really broken, and probably all needs to be done
4323 // in the window manager, and we need to know more about whether
4324 // we want the area behind or in front of the IME.
4325 final Rect insets = mAttachInfo.mVisibleInsets;
4326 outRect.left += insets.left;
4327 outRect.top += insets.top;
4328 outRect.right -= insets.right;
4329 outRect.bottom -= insets.bottom;
4330 return;
4331 }
4332 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
4333 outRect.set(0, 0, d.getWidth(), d.getHeight());
4334 }
4335
4336 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08004337 * Dispatch a notification about a resource configuration change down
4338 * the view hierarchy.
4339 * ViewGroups should override to route to their children.
4340 *
4341 * @param newConfig The new resource configuration.
4342 *
4343 * @see #onConfigurationChanged
4344 */
4345 public void dispatchConfigurationChanged(Configuration newConfig) {
4346 onConfigurationChanged(newConfig);
4347 }
4348
4349 /**
4350 * Called when the current configuration of the resources being used
4351 * by the application have changed. You can use this to decide when
4352 * to reload resources that can changed based on orientation and other
4353 * configuration characterstics. You only need to use this if you are
4354 * not relying on the normal {@link android.app.Activity} mechanism of
4355 * recreating the activity instance upon a configuration change.
4356 *
4357 * @param newConfig The new resource configuration.
4358 */
4359 protected void onConfigurationChanged(Configuration newConfig) {
4360 }
4361
4362 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004363 * Private function to aggregate all per-view attributes in to the view
4364 * root.
4365 */
4366 void dispatchCollectViewAttributes(int visibility) {
4367 performCollectViewAttributes(visibility);
4368 }
4369
4370 void performCollectViewAttributes(int visibility) {
4371 //noinspection PointlessBitwiseExpression
4372 if (((visibility | mViewFlags) & (VISIBILITY_MASK | KEEP_SCREEN_ON))
4373 == (VISIBLE | KEEP_SCREEN_ON)) {
4374 mAttachInfo.mKeepScreenOn = true;
4375 }
4376 }
4377
4378 void needGlobalAttributesUpdate(boolean force) {
4379 AttachInfo ai = mAttachInfo;
4380 if (ai != null) {
4381 if (ai.mKeepScreenOn || force) {
4382 ai.mRecomputeGlobalAttributes = true;
4383 }
4384 }
4385 }
4386
4387 /**
4388 * Returns whether the device is currently in touch mode. Touch mode is entered
4389 * once the user begins interacting with the device by touch, and affects various
4390 * things like whether focus is always visible to the user.
4391 *
4392 * @return Whether the device is in touch mode.
4393 */
4394 @ViewDebug.ExportedProperty
4395 public boolean isInTouchMode() {
4396 if (mAttachInfo != null) {
4397 return mAttachInfo.mInTouchMode;
4398 } else {
4399 return ViewRoot.isInTouchMode();
4400 }
4401 }
4402
4403 /**
4404 * Returns the context the view is running in, through which it can
4405 * access the current theme, resources, etc.
4406 *
4407 * @return The view's Context.
4408 */
4409 @ViewDebug.CapturedViewProperty
4410 public final Context getContext() {
4411 return mContext;
4412 }
4413
4414 /**
4415 * Handle a key event before it is processed by any input method
4416 * associated with the view hierarchy. This can be used to intercept
4417 * key events in special situations before the IME consumes them; a
4418 * typical example would be handling the BACK key to update the application's
4419 * UI instead of allowing the IME to see it and close itself.
4420 *
4421 * @param keyCode The value in event.getKeyCode().
4422 * @param event Description of the key event.
4423 * @return If you handled the event, return true. If you want to allow the
4424 * event to be handled by the next receiver, return false.
4425 */
4426 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
4427 return false;
4428 }
4429
4430 /**
4431 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
4432 * KeyEvent.Callback.onKeyMultiple()}: perform press of the view
4433 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
4434 * is released, if the view is enabled and clickable.
4435 *
4436 * @param keyCode A key code that represents the button pressed, from
4437 * {@link android.view.KeyEvent}.
4438 * @param event The KeyEvent object that defines the button action.
4439 */
4440 public boolean onKeyDown(int keyCode, KeyEvent event) {
4441 boolean result = false;
4442
4443 switch (keyCode) {
4444 case KeyEvent.KEYCODE_DPAD_CENTER:
4445 case KeyEvent.KEYCODE_ENTER: {
4446 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4447 return true;
4448 }
4449 // Long clickable items don't necessarily have to be clickable
4450 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
4451 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
4452 (event.getRepeatCount() == 0)) {
4453 setPressed(true);
4454 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
Adam Powelle14579b2009-12-16 18:39:52 -08004455 postCheckForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004456 }
4457 return true;
4458 }
4459 break;
4460 }
4461 }
4462 return result;
4463 }
4464
4465 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004466 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
4467 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
4468 * the event).
4469 */
4470 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
4471 return false;
4472 }
4473
4474 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004475 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
4476 * KeyEvent.Callback.onKeyMultiple()}: perform clicking of the view
4477 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
4478 * {@link KeyEvent#KEYCODE_ENTER} is released.
4479 *
4480 * @param keyCode A key code that represents the button pressed, from
4481 * {@link android.view.KeyEvent}.
4482 * @param event The KeyEvent object that defines the button action.
4483 */
4484 public boolean onKeyUp(int keyCode, KeyEvent event) {
4485 boolean result = false;
4486
4487 switch (keyCode) {
4488 case KeyEvent.KEYCODE_DPAD_CENTER:
4489 case KeyEvent.KEYCODE_ENTER: {
4490 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4491 return true;
4492 }
4493 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
4494 setPressed(false);
4495
4496 if (!mHasPerformedLongPress) {
4497 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05004498 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004499
4500 result = performClick();
4501 }
4502 }
4503 break;
4504 }
4505 }
4506 return result;
4507 }
4508
4509 /**
4510 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
4511 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
4512 * the event).
4513 *
4514 * @param keyCode A key code that represents the button pressed, from
4515 * {@link android.view.KeyEvent}.
4516 * @param repeatCount The number of times the action was made.
4517 * @param event The KeyEvent object that defines the button action.
4518 */
4519 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
4520 return false;
4521 }
4522
4523 /**
4524 * Called when an unhandled key shortcut event occurs.
4525 *
4526 * @param keyCode The value in event.getKeyCode().
4527 * @param event Description of the key event.
4528 * @return If you handled the event, return true. If you want to allow the
4529 * event to be handled by the next receiver, return false.
4530 */
4531 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
4532 return false;
4533 }
4534
4535 /**
4536 * Check whether the called view is a text editor, in which case it
4537 * would make sense to automatically display a soft input window for
4538 * it. Subclasses should override this if they implement
4539 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004540 * a call on that method would return a non-null InputConnection, and
4541 * they are really a first-class editor that the user would normally
4542 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07004543 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004544 * <p>The default implementation always returns false. This does
4545 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
4546 * will not be called or the user can not otherwise perform edits on your
4547 * view; it is just a hint to the system that this is not the primary
4548 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07004549 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004550 * @return Returns true if this view is a text editor, else false.
4551 */
4552 public boolean onCheckIsTextEditor() {
4553 return false;
4554 }
Romain Guy8506ab42009-06-11 17:35:47 -07004555
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004556 /**
4557 * Create a new InputConnection for an InputMethod to interact
4558 * with the view. The default implementation returns null, since it doesn't
4559 * support input methods. You can override this to implement such support.
4560 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07004561 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004562 * <p>When implementing this, you probably also want to implement
4563 * {@link #onCheckIsTextEditor()} to indicate you will return a
4564 * non-null InputConnection.
4565 *
4566 * @param outAttrs Fill in with attribute information about the connection.
4567 */
4568 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
4569 return null;
4570 }
4571
4572 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004573 * Called by the {@link android.view.inputmethod.InputMethodManager}
4574 * when a view who is not the current
4575 * input connection target is trying to make a call on the manager. The
4576 * default implementation returns false; you can override this to return
4577 * true for certain views if you are performing InputConnection proxying
4578 * to them.
4579 * @param view The View that is making the InputMethodManager call.
4580 * @return Return true to allow the call, false to reject.
4581 */
4582 public boolean checkInputConnectionProxy(View view) {
4583 return false;
4584 }
Romain Guy8506ab42009-06-11 17:35:47 -07004585
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07004586 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004587 * Show the context menu for this view. It is not safe to hold on to the
4588 * menu after returning from this method.
4589 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07004590 * You should normally not overload this method. Overload
4591 * {@link #onCreateContextMenu(ContextMenu)} or define an
4592 * {@link OnCreateContextMenuListener} to add items to the context menu.
4593 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004594 * @param menu The context menu to populate
4595 */
4596 public void createContextMenu(ContextMenu menu) {
4597 ContextMenuInfo menuInfo = getContextMenuInfo();
4598
4599 // Sets the current menu info so all items added to menu will have
4600 // my extra info set.
4601 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
4602
4603 onCreateContextMenu(menu);
4604 if (mOnCreateContextMenuListener != null) {
4605 mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
4606 }
4607
4608 // Clear the extra information so subsequent items that aren't mine don't
4609 // have my extra info.
4610 ((MenuBuilder)menu).setCurrentMenuInfo(null);
4611
4612 if (mParent != null) {
4613 mParent.createContextMenu(menu);
4614 }
4615 }
4616
4617 /**
4618 * Views should implement this if they have extra information to associate
4619 * with the context menu. The return result is supplied as a parameter to
4620 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
4621 * callback.
4622 *
4623 * @return Extra information about the item for which the context menu
4624 * should be shown. This information will vary across different
4625 * subclasses of View.
4626 */
4627 protected ContextMenuInfo getContextMenuInfo() {
4628 return null;
4629 }
4630
4631 /**
4632 * Views should implement this if the view itself is going to add items to
4633 * the context menu.
4634 *
4635 * @param menu the context menu to populate
4636 */
4637 protected void onCreateContextMenu(ContextMenu menu) {
4638 }
4639
4640 /**
4641 * Implement this method to handle trackball motion events. The
4642 * <em>relative</em> movement of the trackball since the last event
4643 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
4644 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
4645 * that a movement of 1 corresponds to the user pressing one DPAD key (so
4646 * they will often be fractional values, representing the more fine-grained
4647 * movement information available from a trackball).
4648 *
4649 * @param event The motion event.
4650 * @return True if the event was handled, false otherwise.
4651 */
4652 public boolean onTrackballEvent(MotionEvent event) {
4653 return false;
4654 }
4655
4656 /**
4657 * Implement this method to handle touch screen motion events.
4658 *
4659 * @param event The motion event.
4660 * @return True if the event was handled, false otherwise.
4661 */
4662 public boolean onTouchEvent(MotionEvent event) {
4663 final int viewFlags = mViewFlags;
4664
4665 if ((viewFlags & ENABLED_MASK) == DISABLED) {
4666 // A disabled view that is clickable still consumes the touch
4667 // events, it just doesn't respond to them.
4668 return (((viewFlags & CLICKABLE) == CLICKABLE ||
4669 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
4670 }
4671
4672 if (mTouchDelegate != null) {
4673 if (mTouchDelegate.onTouchEvent(event)) {
4674 return true;
4675 }
4676 }
4677
4678 if (((viewFlags & CLICKABLE) == CLICKABLE ||
4679 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
4680 switch (event.getAction()) {
4681 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08004682 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
4683 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004684 // take focus if we don't have it already and we should in
4685 // touch mode.
4686 boolean focusTaken = false;
4687 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
4688 focusTaken = requestFocus();
4689 }
4690
4691 if (!mHasPerformedLongPress) {
4692 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05004693 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004694
4695 // Only perform take click actions if we were in the pressed state
4696 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08004697 // Use a Runnable and post this rather than calling
4698 // performClick directly. This lets other visual state
4699 // of the view update before click actions start.
4700 if (mPerformClick == null) {
4701 mPerformClick = new PerformClick();
4702 }
4703 if (!post(mPerformClick)) {
4704 performClick();
4705 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004706 }
4707 }
4708
4709 if (mUnsetPressedState == null) {
4710 mUnsetPressedState = new UnsetPressedState();
4711 }
4712
Adam Powelle14579b2009-12-16 18:39:52 -08004713 if (prepressed) {
4714 mPrivateFlags |= PRESSED;
4715 refreshDrawableState();
4716 postDelayed(mUnsetPressedState,
4717 ViewConfiguration.getPressedStateDuration());
4718 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004719 // If the post failed, unpress right now
4720 mUnsetPressedState.run();
4721 }
Adam Powelle14579b2009-12-16 18:39:52 -08004722 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004723 }
4724 break;
4725
4726 case MotionEvent.ACTION_DOWN:
Adam Powelle14579b2009-12-16 18:39:52 -08004727 if (mPendingCheckForTap == null) {
4728 mPendingCheckForTap = new CheckForTap();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004729 }
Adam Powelle14579b2009-12-16 18:39:52 -08004730 mPrivateFlags |= PREPRESSED;
Adam Powell3b023392010-03-11 16:30:28 -08004731 mHasPerformedLongPress = false;
Adam Powelle14579b2009-12-16 18:39:52 -08004732 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004733 break;
4734
4735 case MotionEvent.ACTION_CANCEL:
4736 mPrivateFlags &= ~PRESSED;
4737 refreshDrawableState();
Adam Powelle14579b2009-12-16 18:39:52 -08004738 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004739 break;
4740
4741 case MotionEvent.ACTION_MOVE:
4742 final int x = (int) event.getX();
4743 final int y = (int) event.getY();
4744
4745 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07004746 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004747 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08004748 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004749 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08004750 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05004751 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004752
4753 // Need to switch from pressed to not pressed
4754 mPrivateFlags &= ~PRESSED;
4755 refreshDrawableState();
4756 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004757 }
4758 break;
4759 }
4760 return true;
4761 }
4762
4763 return false;
4764 }
4765
4766 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05004767 * Remove the longpress detection timer.
4768 */
4769 private void removeLongPressCallback() {
4770 if (mPendingCheckForLongPress != null) {
4771 removeCallbacks(mPendingCheckForLongPress);
4772 }
4773 }
Adam Powelle14579b2009-12-16 18:39:52 -08004774
4775 /**
Romain Guya440b002010-02-24 15:57:54 -08004776 * Remove the prepress detection timer.
4777 */
4778 private void removeUnsetPressCallback() {
4779 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
4780 setPressed(false);
4781 removeCallbacks(mUnsetPressedState);
4782 }
4783 }
4784
4785 /**
Adam Powelle14579b2009-12-16 18:39:52 -08004786 * Remove the tap detection timer.
4787 */
4788 private void removeTapCallback() {
4789 if (mPendingCheckForTap != null) {
4790 mPrivateFlags &= ~PREPRESSED;
4791 removeCallbacks(mPendingCheckForTap);
4792 }
4793 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05004794
4795 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004796 * Cancels a pending long press. Your subclass can use this if you
4797 * want the context menu to come up if the user presses and holds
4798 * at the same place, but you don't want it to come up if they press
4799 * and then move around enough to cause scrolling.
4800 */
4801 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05004802 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08004803
4804 /*
4805 * The prepressed state handled by the tap callback is a display
4806 * construct, but the tap callback will post a long press callback
4807 * less its own timeout. Remove it here.
4808 */
4809 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004810 }
4811
4812 /**
4813 * Sets the TouchDelegate for this View.
4814 */
4815 public void setTouchDelegate(TouchDelegate delegate) {
4816 mTouchDelegate = delegate;
4817 }
4818
4819 /**
4820 * Gets the TouchDelegate for this View.
4821 */
4822 public TouchDelegate getTouchDelegate() {
4823 return mTouchDelegate;
4824 }
4825
4826 /**
4827 * Set flags controlling behavior of this view.
4828 *
4829 * @param flags Constant indicating the value which should be set
4830 * @param mask Constant indicating the bit range that should be changed
4831 */
4832 void setFlags(int flags, int mask) {
4833 int old = mViewFlags;
4834 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
4835
4836 int changed = mViewFlags ^ old;
4837 if (changed == 0) {
4838 return;
4839 }
4840 int privateFlags = mPrivateFlags;
4841
4842 /* Check if the FOCUSABLE bit has changed */
4843 if (((changed & FOCUSABLE_MASK) != 0) &&
4844 ((privateFlags & HAS_BOUNDS) !=0)) {
4845 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
4846 && ((privateFlags & FOCUSED) != 0)) {
4847 /* Give up focus if we are no longer focusable */
4848 clearFocus();
4849 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
4850 && ((privateFlags & FOCUSED) == 0)) {
4851 /*
4852 * Tell the view system that we are now available to take focus
4853 * if no one else already has it.
4854 */
4855 if (mParent != null) mParent.focusableViewAvailable(this);
4856 }
4857 }
4858
4859 if ((flags & VISIBILITY_MASK) == VISIBLE) {
4860 if ((changed & VISIBILITY_MASK) != 0) {
4861 /*
4862 * If this view is becoming visible, set the DRAWN flag so that
4863 * the next invalidate() will not be skipped.
4864 */
4865 mPrivateFlags |= DRAWN;
4866
4867 needGlobalAttributesUpdate(true);
4868
4869 // a view becoming visible is worth notifying the parent
4870 // about in case nothing has focus. even if this specific view
4871 // isn't focusable, it may contain something that is, so let
4872 // the root view try to give this focus if nothing else does.
4873 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
4874 mParent.focusableViewAvailable(this);
4875 }
4876 }
4877 }
4878
4879 /* Check if the GONE bit has changed */
4880 if ((changed & GONE) != 0) {
4881 needGlobalAttributesUpdate(false);
4882 requestLayout();
4883 invalidate();
4884
Romain Guyecd80ee2009-12-03 17:13:02 -08004885 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
4886 if (hasFocus()) clearFocus();
4887 destroyDrawingCache();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004888 }
4889 if (mAttachInfo != null) {
4890 mAttachInfo.mViewVisibilityChanged = true;
4891 }
4892 }
4893
4894 /* Check if the VISIBLE bit has changed */
4895 if ((changed & INVISIBLE) != 0) {
4896 needGlobalAttributesUpdate(false);
4897 invalidate();
4898
4899 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
4900 // root view becoming invisible shouldn't clear focus
4901 if (getRootView() != this) {
4902 clearFocus();
4903 }
4904 }
4905 if (mAttachInfo != null) {
4906 mAttachInfo.mViewVisibilityChanged = true;
4907 }
4908 }
4909
Adam Powell326d8082009-12-09 15:10:07 -08004910 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07004911 if (mParent instanceof ViewGroup) {
4912 ((ViewGroup)mParent).onChildVisibilityChanged(this, (flags & VISIBILITY_MASK));
4913 }
Adam Powell326d8082009-12-09 15:10:07 -08004914 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
4915 }
4916
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004917 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
4918 destroyDrawingCache();
4919 }
4920
4921 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
4922 destroyDrawingCache();
4923 mPrivateFlags &= ~DRAWING_CACHE_VALID;
4924 }
4925
4926 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
4927 destroyDrawingCache();
4928 mPrivateFlags &= ~DRAWING_CACHE_VALID;
4929 }
4930
4931 if ((changed & DRAW_MASK) != 0) {
4932 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
4933 if (mBGDrawable != null) {
4934 mPrivateFlags &= ~SKIP_DRAW;
4935 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
4936 } else {
4937 mPrivateFlags |= SKIP_DRAW;
4938 }
4939 } else {
4940 mPrivateFlags &= ~SKIP_DRAW;
4941 }
4942 requestLayout();
4943 invalidate();
4944 }
4945
4946 if ((changed & KEEP_SCREEN_ON) != 0) {
4947 if (mParent != null) {
4948 mParent.recomputeViewAttributes(this);
4949 }
4950 }
4951 }
4952
4953 /**
4954 * Change the view's z order in the tree, so it's on top of other sibling
4955 * views
4956 */
4957 public void bringToFront() {
4958 if (mParent != null) {
4959 mParent.bringChildToFront(this);
4960 }
4961 }
4962
4963 /**
4964 * This is called in response to an internal scroll in this view (i.e., the
4965 * view scrolled its own contents). This is typically as a result of
4966 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
4967 * called.
4968 *
4969 * @param l Current horizontal scroll origin.
4970 * @param t Current vertical scroll origin.
4971 * @param oldl Previous horizontal scroll origin.
4972 * @param oldt Previous vertical scroll origin.
4973 */
4974 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
4975 mBackgroundSizeChanged = true;
4976
4977 final AttachInfo ai = mAttachInfo;
4978 if (ai != null) {
4979 ai.mViewScrollChanged = true;
4980 }
4981 }
4982
4983 /**
Chet Haase21cd1382010-09-01 17:42:29 -07004984 * Interface definition for a callback to be invoked when the layout bounds of a view
4985 * changes due to layout processing.
4986 */
4987 public interface OnLayoutChangeListener {
4988 /**
4989 * Called when the focus state of a view has changed.
4990 *
4991 * @param v The view whose state has changed.
4992 * @param left The new value of the view's left property.
4993 * @param top The new value of the view's top property.
4994 * @param right The new value of the view's right property.
4995 * @param bottom The new value of the view's bottom property.
4996 * @param oldLeft The previous value of the view's left property.
4997 * @param oldTop The previous value of the view's top property.
4998 * @param oldRight The previous value of the view's right property.
4999 * @param oldBottom The previous value of the view's bottom property.
5000 */
5001 void onLayoutChange(View v, int left, int top, int right, int bottom,
5002 int oldLeft, int oldTop, int oldRight, int oldBottom);
5003 }
5004
5005 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005006 * This is called during layout when the size of this view has changed. If
5007 * you were just added to the view hierarchy, you're called with the old
5008 * values of 0.
5009 *
5010 * @param w Current width of this view.
5011 * @param h Current height of this view.
5012 * @param oldw Old width of this view.
5013 * @param oldh Old height of this view.
5014 */
5015 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
5016 }
5017
5018 /**
5019 * Called by draw to draw the child views. This may be overridden
5020 * by derived classes to gain control just before its children are drawn
5021 * (but after its own view has been drawn).
5022 * @param canvas the canvas on which to draw the view
5023 */
5024 protected void dispatchDraw(Canvas canvas) {
5025 }
5026
5027 /**
5028 * Gets the parent of this view. Note that the parent is a
5029 * ViewParent and not necessarily a View.
5030 *
5031 * @return Parent of this view.
5032 */
5033 public final ViewParent getParent() {
5034 return mParent;
5035 }
5036
5037 /**
5038 * Return the scrolled left position of this view. This is the left edge of
5039 * the displayed part of your view. You do not need to draw any pixels
5040 * farther left, since those are outside of the frame of your view on
5041 * screen.
5042 *
5043 * @return The left edge of the displayed part of your view, in pixels.
5044 */
5045 public final int getScrollX() {
5046 return mScrollX;
5047 }
5048
5049 /**
5050 * Return the scrolled top position of this view. This is the top edge of
5051 * the displayed part of your view. You do not need to draw any pixels above
5052 * it, since those are outside of the frame of your view on screen.
5053 *
5054 * @return The top edge of the displayed part of your view, in pixels.
5055 */
5056 public final int getScrollY() {
5057 return mScrollY;
5058 }
5059
5060 /**
5061 * Return the width of the your view.
5062 *
5063 * @return The width of your view, in pixels.
5064 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005065 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005066 public final int getWidth() {
5067 return mRight - mLeft;
5068 }
5069
5070 /**
5071 * Return the height of your view.
5072 *
5073 * @return The height of your view, in pixels.
5074 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005075 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005076 public final int getHeight() {
5077 return mBottom - mTop;
5078 }
5079
5080 /**
5081 * Return the visible drawing bounds of your view. Fills in the output
5082 * rectangle with the values from getScrollX(), getScrollY(),
5083 * getWidth(), and getHeight().
5084 *
5085 * @param outRect The (scrolled) drawing bounds of the view.
5086 */
5087 public void getDrawingRect(Rect outRect) {
5088 outRect.left = mScrollX;
5089 outRect.top = mScrollY;
5090 outRect.right = mScrollX + (mRight - mLeft);
5091 outRect.bottom = mScrollY + (mBottom - mTop);
5092 }
5093
5094 /**
5095 * The width of this view as measured in the most recent call to measure().
5096 * This should be used during measurement and layout calculations only. Use
5097 * {@link #getWidth()} to see how wide a view is after layout.
5098 *
5099 * @return The measured width of this view.
5100 */
5101 public final int getMeasuredWidth() {
5102 return mMeasuredWidth;
5103 }
5104
5105 /**
5106 * The height of this view as measured in the most recent call to measure().
5107 * This should be used during measurement and layout calculations only. Use
5108 * {@link #getHeight()} to see how tall a view is after layout.
5109 *
5110 * @return The measured height of this view.
5111 */
5112 public final int getMeasuredHeight() {
5113 return mMeasuredHeight;
5114 }
5115
5116 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005117 * The transform matrix of this view, which is calculated based on the current
5118 * roation, scale, and pivot properties.
5119 *
5120 * @see #getRotation()
5121 * @see #getScaleX()
5122 * @see #getScaleY()
5123 * @see #getPivotX()
5124 * @see #getPivotY()
5125 * @return The current transform matrix for the view
5126 */
5127 public Matrix getMatrix() {
Jeff Brown86671742010-09-30 20:00:15 -07005128 updateMatrix();
Romain Guy33e72ae2010-07-17 12:40:29 -07005129 return mMatrix;
5130 }
5131
5132 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005133 * Utility function to determine if the value is far enough away from zero to be
5134 * considered non-zero.
5135 * @param value A floating point value to check for zero-ness
5136 * @return whether the passed-in value is far enough away from zero to be considered non-zero
5137 */
5138 private static boolean nonzero(float value) {
5139 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
5140 }
5141
5142 /**
Jeff Brown86671742010-09-30 20:00:15 -07005143 * Returns true if the transform matrix is the identity matrix.
5144 * Recomputes the matrix if necessary.
Romain Guy33e72ae2010-07-17 12:40:29 -07005145 *
5146 * @return True if the transform matrix is the identity matrix, false otherwise.
5147 */
Jeff Brown86671742010-09-30 20:00:15 -07005148 final boolean hasIdentityMatrix() {
5149 updateMatrix();
5150 return mMatrixIsIdentity;
5151 }
5152
5153 /**
5154 * Recomputes the transform matrix if necessary.
5155 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07005156 private void updateMatrix() {
Chet Haasec3aa3612010-06-17 08:50:37 -07005157 if (mMatrixDirty) {
5158 // transform-related properties have changed since the last time someone
5159 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07005160
5161 // Figure out if we need to update the pivot point
5162 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
5163 if ((mRight - mLeft) != mPrevWidth && (mBottom - mTop) != mPrevHeight) {
5164 mPrevWidth = mRight - mLeft;
5165 mPrevHeight = mBottom - mTop;
5166 mPivotX = (float) mPrevWidth / 2f;
5167 mPivotY = (float) mPrevHeight / 2f;
5168 }
5169 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005170 mMatrix.reset();
Chet Haase897247b2010-09-09 14:54:47 -07005171 if (!nonzero(mRotationX) && !nonzero(mRotationY)) {
5172 mMatrix.setTranslate(mTranslationX, mTranslationY);
5173 mMatrix.preRotate(mRotation, mPivotX, mPivotY);
5174 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
5175 } else {
Chet Haasefd2b0022010-08-06 13:08:56 -07005176 if (mCamera == null) {
5177 mCamera = new Camera();
5178 matrix3D = new Matrix();
5179 }
5180 mCamera.save();
Chet Haase897247b2010-09-09 14:54:47 -07005181 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
Chet Haasefd2b0022010-08-06 13:08:56 -07005182 mCamera.rotateX(mRotationX);
5183 mCamera.rotateY(mRotationY);
Chet Haase897247b2010-09-09 14:54:47 -07005184 mCamera.rotateZ(-mRotation);
Chet Haasefd2b0022010-08-06 13:08:56 -07005185 mCamera.getMatrix(matrix3D);
5186 matrix3D.preTranslate(-mPivotX, -mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07005187 matrix3D.postTranslate(mPivotX + mTranslationX, mPivotY + mTranslationY);
Chet Haasefd2b0022010-08-06 13:08:56 -07005188 mMatrix.postConcat(matrix3D);
5189 mCamera.restore();
5190 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005191 mMatrixDirty = false;
5192 mMatrixIsIdentity = mMatrix.isIdentity();
5193 mInverseMatrixDirty = true;
5194 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005195 }
5196
5197 /**
5198 * Utility method to retrieve the inverse of the current mMatrix property.
5199 * We cache the matrix to avoid recalculating it when transform properties
5200 * have not changed.
5201 *
5202 * @return The inverse of the current matrix of this view.
5203 */
Jeff Brown86671742010-09-30 20:00:15 -07005204 final Matrix getInverseMatrix() {
5205 updateMatrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07005206 if (mInverseMatrixDirty) {
5207 if (mInverseMatrix == null) {
5208 mInverseMatrix = new Matrix();
5209 }
5210 mMatrix.invert(mInverseMatrix);
5211 mInverseMatrixDirty = false;
5212 }
5213 return mInverseMatrix;
5214 }
5215
5216 /**
5217 * The degrees that the view is rotated around the pivot point.
5218 *
5219 * @see #getPivotX()
5220 * @see #getPivotY()
5221 * @return The degrees of rotation.
5222 */
5223 public float getRotation() {
5224 return mRotation;
5225 }
5226
5227 /**
Chet Haase897247b2010-09-09 14:54:47 -07005228 * Sets the degrees that the view is rotated around the pivot point. Increasing values
5229 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07005230 *
5231 * @param rotation The degrees of rotation.
5232 * @see #getPivotX()
5233 * @see #getPivotY()
5234 */
5235 public void setRotation(float rotation) {
5236 if (mRotation != rotation) {
5237 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005238 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005239 mRotation = rotation;
5240 mMatrixDirty = true;
5241 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005242 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005243 }
5244 }
5245
5246 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005247 * The degrees that the view is rotated around the vertical axis through the pivot point.
5248 *
5249 * @see #getPivotX()
5250 * @see #getPivotY()
5251 * @return The degrees of Y rotation.
5252 */
5253 public float getRotationY() {
5254 return mRotationY;
5255 }
5256
5257 /**
Chet Haase897247b2010-09-09 14:54:47 -07005258 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
5259 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
5260 * down the y axis.
Chet Haasefd2b0022010-08-06 13:08:56 -07005261 *
5262 * @param rotationY The degrees of Y rotation.
5263 * @see #getPivotX()
5264 * @see #getPivotY()
5265 */
5266 public void setRotationY(float rotationY) {
5267 if (mRotationY != rotationY) {
5268 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005269 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005270 mRotationY = rotationY;
5271 mMatrixDirty = true;
5272 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005273 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005274 }
5275 }
5276
5277 /**
5278 * The degrees that the view is rotated around the horizontal axis through the pivot point.
5279 *
5280 * @see #getPivotX()
5281 * @see #getPivotY()
5282 * @return The degrees of X rotation.
5283 */
5284 public float getRotationX() {
5285 return mRotationX;
5286 }
5287
5288 /**
Chet Haase897247b2010-09-09 14:54:47 -07005289 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
5290 * Increasing values result in clockwise rotation from the viewpoint of looking down the
5291 * x axis.
Chet Haasefd2b0022010-08-06 13:08:56 -07005292 *
5293 * @param rotationX The degrees of X rotation.
5294 * @see #getPivotX()
5295 * @see #getPivotY()
5296 */
5297 public void setRotationX(float rotationX) {
5298 if (mRotationX != rotationX) {
5299 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005300 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005301 mRotationX = rotationX;
5302 mMatrixDirty = true;
5303 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005304 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005305 }
5306 }
5307
5308 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005309 * The amount that the view is scaled in x around the pivot point, as a proportion of
5310 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
5311 *
Joe Onorato93162322010-09-16 15:42:01 -04005312 * <p>By default, this is 1.0f.
5313 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005314 * @see #getPivotX()
5315 * @see #getPivotY()
5316 * @return The scaling factor.
5317 */
5318 public float getScaleX() {
5319 return mScaleX;
5320 }
5321
5322 /**
5323 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
5324 * the view's unscaled width. A value of 1 means that no scaling is applied.
5325 *
5326 * @param scaleX The scaling factor.
5327 * @see #getPivotX()
5328 * @see #getPivotY()
5329 */
5330 public void setScaleX(float scaleX) {
5331 if (mScaleX != scaleX) {
5332 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005333 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005334 mScaleX = scaleX;
5335 mMatrixDirty = true;
5336 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005337 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005338 }
5339 }
5340
5341 /**
5342 * The amount that the view is scaled in y around the pivot point, as a proportion of
5343 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
5344 *
Joe Onorato93162322010-09-16 15:42:01 -04005345 * <p>By default, this is 1.0f.
5346 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005347 * @see #getPivotX()
5348 * @see #getPivotY()
5349 * @return The scaling factor.
5350 */
5351 public float getScaleY() {
5352 return mScaleY;
5353 }
5354
5355 /**
5356 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
5357 * the view's unscaled width. A value of 1 means that no scaling is applied.
5358 *
5359 * @param scaleY The scaling factor.
5360 * @see #getPivotX()
5361 * @see #getPivotY()
5362 */
5363 public void setScaleY(float scaleY) {
5364 if (mScaleY != scaleY) {
5365 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005366 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005367 mScaleY = scaleY;
5368 mMatrixDirty = true;
5369 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005370 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005371 }
5372 }
5373
5374 /**
5375 * The x location of the point around which the view is {@link #setRotation(float) rotated}
5376 * and {@link #setScaleX(float) scaled}.
5377 *
5378 * @see #getRotation()
5379 * @see #getScaleX()
5380 * @see #getScaleY()
5381 * @see #getPivotY()
5382 * @return The x location of the pivot point.
5383 */
5384 public float getPivotX() {
5385 return mPivotX;
5386 }
5387
5388 /**
5389 * Sets the x location of the point around which the view is
5390 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07005391 * By default, the pivot point is centered on the object.
5392 * Setting this property disables this behavior and causes the view to use only the
5393 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07005394 *
5395 * @param pivotX The x location of the pivot point.
5396 * @see #getRotation()
5397 * @see #getScaleX()
5398 * @see #getScaleY()
5399 * @see #getPivotY()
5400 */
5401 public void setPivotX(float pivotX) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005402 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07005403 if (mPivotX != pivotX) {
5404 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005405 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005406 mPivotX = pivotX;
5407 mMatrixDirty = true;
5408 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005409 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005410 }
5411 }
5412
5413 /**
5414 * The y location of the point around which the view is {@link #setRotation(float) rotated}
5415 * and {@link #setScaleY(float) scaled}.
5416 *
5417 * @see #getRotation()
5418 * @see #getScaleX()
5419 * @see #getScaleY()
5420 * @see #getPivotY()
5421 * @return The y location of the pivot point.
5422 */
5423 public float getPivotY() {
5424 return mPivotY;
5425 }
5426
5427 /**
5428 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07005429 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
5430 * Setting this property disables this behavior and causes the view to use only the
5431 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07005432 *
5433 * @param pivotY The y location of the pivot point.
5434 * @see #getRotation()
5435 * @see #getScaleX()
5436 * @see #getScaleY()
5437 * @see #getPivotY()
5438 */
5439 public void setPivotY(float pivotY) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005440 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07005441 if (mPivotY != pivotY) {
5442 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005443 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005444 mPivotY = pivotY;
5445 mMatrixDirty = true;
5446 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005447 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005448 }
5449 }
5450
5451 /**
5452 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
5453 * completely transparent and 1 means the view is completely opaque.
5454 *
Joe Onorato93162322010-09-16 15:42:01 -04005455 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07005456 * @return The opacity of the view.
5457 */
5458 public float getAlpha() {
5459 return mAlpha;
5460 }
5461
5462 /**
5463 * Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
5464 * completely transparent and 1 means the view is completely opaque.
5465 *
5466 * @param alpha The opacity of the view.
5467 */
5468 public void setAlpha(float alpha) {
5469 mAlpha = alpha;
Chet Haaseed032702010-10-01 14:05:54 -07005470 if (onSetAlpha((int) (alpha * 255))) {
5471 // subclass is handling alpha - don't optimize rendering cache invalidation
5472 invalidate();
5473 } else {
5474 invalidate(false);
5475 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005476 }
5477
5478 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005479 * Top position of this view relative to its parent.
5480 *
5481 * @return The top of this view, in pixels.
5482 */
5483 @ViewDebug.CapturedViewProperty
5484 public final int getTop() {
5485 return mTop;
5486 }
5487
5488 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005489 * Sets the top position of this view relative to its parent. This method is meant to be called
5490 * by the layout system and should not generally be called otherwise, because the property
5491 * may be changed at any time by the layout.
5492 *
5493 * @param top The top of this view, in pixels.
5494 */
5495 public final void setTop(int top) {
5496 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07005497 updateMatrix();
5498 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07005499 final ViewParent p = mParent;
5500 if (p != null && mAttachInfo != null) {
5501 final Rect r = mAttachInfo.mTmpInvalRect;
5502 int minTop;
5503 int yLoc;
5504 if (top < mTop) {
5505 minTop = top;
5506 yLoc = top - mTop;
5507 } else {
5508 minTop = mTop;
5509 yLoc = 0;
5510 }
5511 r.set(0, yLoc, mRight - mLeft, mBottom - minTop);
5512 p.invalidateChild(this, r);
5513 }
5514 } else {
5515 // Double-invalidation is necessary to capture view's old and new areas
5516 invalidate();
5517 }
5518
Chet Haaseed032702010-10-01 14:05:54 -07005519 int width = mRight - mLeft;
5520 int oldHeight = mBottom - mTop;
5521
Chet Haase21cd1382010-09-01 17:42:29 -07005522 mTop = top;
5523
Chet Haaseed032702010-10-01 14:05:54 -07005524 onSizeChanged(width, mBottom - mTop, width, oldHeight);
5525
Chet Haase21cd1382010-09-01 17:42:29 -07005526 if (!mMatrixIsIdentity) {
5527 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
5528 invalidate();
5529 }
5530 }
5531 }
5532
5533 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005534 * Bottom position of this view relative to its parent.
5535 *
5536 * @return The bottom of this view, in pixels.
5537 */
5538 @ViewDebug.CapturedViewProperty
5539 public final int getBottom() {
5540 return mBottom;
5541 }
5542
5543 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005544 * Sets the bottom position of this view relative to its parent. This method is meant to be
5545 * called by the layout system and should not generally be called otherwise, because the
5546 * property may be changed at any time by the layout.
5547 *
5548 * @param bottom The bottom of this view, in pixels.
5549 */
5550 public final void setBottom(int bottom) {
5551 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07005552 updateMatrix();
5553 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07005554 final ViewParent p = mParent;
5555 if (p != null && mAttachInfo != null) {
5556 final Rect r = mAttachInfo.mTmpInvalRect;
5557 int maxBottom;
5558 if (bottom < mBottom) {
5559 maxBottom = mBottom;
5560 } else {
5561 maxBottom = bottom;
5562 }
5563 r.set(0, 0, mRight - mLeft, maxBottom - mTop);
5564 p.invalidateChild(this, r);
5565 }
5566 } else {
5567 // Double-invalidation is necessary to capture view's old and new areas
5568 invalidate();
5569 }
5570
Chet Haaseed032702010-10-01 14:05:54 -07005571 int width = mRight - mLeft;
5572 int oldHeight = mBottom - mTop;
5573
Chet Haase21cd1382010-09-01 17:42:29 -07005574 mBottom = bottom;
5575
Chet Haaseed032702010-10-01 14:05:54 -07005576 onSizeChanged(width, mBottom - mTop, width, oldHeight);
5577
Chet Haase21cd1382010-09-01 17:42:29 -07005578 if (!mMatrixIsIdentity) {
5579 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
5580 invalidate();
5581 }
5582 }
5583 }
5584
5585 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005586 * Left position of this view relative to its parent.
5587 *
5588 * @return The left edge of this view, in pixels.
5589 */
5590 @ViewDebug.CapturedViewProperty
5591 public final int getLeft() {
5592 return mLeft;
5593 }
5594
5595 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005596 * Sets the left position of this view relative to its parent. This method is meant to be called
5597 * by the layout system and should not generally be called otherwise, because the property
5598 * may be changed at any time by the layout.
5599 *
5600 * @param left The bottom of this view, in pixels.
5601 */
5602 public final void setLeft(int left) {
5603 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07005604 updateMatrix();
5605 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07005606 final ViewParent p = mParent;
5607 if (p != null && mAttachInfo != null) {
5608 final Rect r = mAttachInfo.mTmpInvalRect;
5609 int minLeft;
5610 int xLoc;
5611 if (left < mLeft) {
5612 minLeft = left;
5613 xLoc = left - mLeft;
5614 } else {
5615 minLeft = mLeft;
5616 xLoc = 0;
5617 }
5618 r.set(xLoc, 0, mRight - minLeft, mBottom - mTop);
5619 p.invalidateChild(this, r);
5620 }
5621 } else {
5622 // Double-invalidation is necessary to capture view's old and new areas
5623 invalidate();
5624 }
5625
Chet Haaseed032702010-10-01 14:05:54 -07005626 int oldWidth = mRight - mLeft;
5627 int height = mBottom - mTop;
5628
Chet Haase21cd1382010-09-01 17:42:29 -07005629 mLeft = left;
5630
Chet Haaseed032702010-10-01 14:05:54 -07005631 onSizeChanged(mRight - mLeft, height, oldWidth, height);
5632
Chet Haase21cd1382010-09-01 17:42:29 -07005633 if (!mMatrixIsIdentity) {
5634 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
5635 invalidate();
5636 }
Chet Haaseed032702010-10-01 14:05:54 -07005637
Chet Haase21cd1382010-09-01 17:42:29 -07005638 }
5639 }
5640
5641 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005642 * Right position of this view relative to its parent.
5643 *
5644 * @return The right edge of this view, in pixels.
5645 */
5646 @ViewDebug.CapturedViewProperty
5647 public final int getRight() {
5648 return mRight;
5649 }
5650
5651 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005652 * Sets the right position of this view relative to its parent. This method is meant to be called
5653 * by the layout system and should not generally be called otherwise, because the property
5654 * may be changed at any time by the layout.
5655 *
5656 * @param right The bottom of this view, in pixels.
5657 */
5658 public final void setRight(int right) {
5659 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07005660 updateMatrix();
5661 if (mMatrixIsIdentity) {
Chet Haase21cd1382010-09-01 17:42:29 -07005662 final ViewParent p = mParent;
5663 if (p != null && mAttachInfo != null) {
5664 final Rect r = mAttachInfo.mTmpInvalRect;
5665 int maxRight;
5666 if (right < mRight) {
5667 maxRight = mRight;
5668 } else {
5669 maxRight = right;
5670 }
5671 r.set(0, 0, maxRight - mLeft, mBottom - mTop);
5672 p.invalidateChild(this, r);
5673 }
5674 } else {
5675 // Double-invalidation is necessary to capture view's old and new areas
5676 invalidate();
5677 }
5678
Chet Haaseed032702010-10-01 14:05:54 -07005679 int oldWidth = mRight - mLeft;
5680 int height = mBottom - mTop;
5681
Chet Haase21cd1382010-09-01 17:42:29 -07005682 mRight = right;
5683
Chet Haaseed032702010-10-01 14:05:54 -07005684 onSizeChanged(mRight - mLeft, height, oldWidth, height);
5685
Chet Haase21cd1382010-09-01 17:42:29 -07005686 if (!mMatrixIsIdentity) {
5687 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
5688 invalidate();
5689 }
5690 }
5691 }
5692
5693 /**
Chet Haasedf030d22010-07-30 17:22:38 -07005694 * The visual x position of this view, in pixels. This is equivalent to the
5695 * {@link #setTranslationX(float) translationX} property plus the current
5696 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07005697 *
Chet Haasedf030d22010-07-30 17:22:38 -07005698 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07005699 */
Chet Haasedf030d22010-07-30 17:22:38 -07005700 public float getX() {
5701 return mLeft + mTranslationX;
5702 }
Romain Guy33e72ae2010-07-17 12:40:29 -07005703
Chet Haasedf030d22010-07-30 17:22:38 -07005704 /**
5705 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
5706 * {@link #setTranslationX(float) translationX} property to be the difference between
5707 * the x value passed in and the current {@link #getLeft() left} property.
5708 *
5709 * @param x The visual x position of this view, in pixels.
5710 */
5711 public void setX(float x) {
5712 setTranslationX(x - mLeft);
5713 }
Romain Guy33e72ae2010-07-17 12:40:29 -07005714
Chet Haasedf030d22010-07-30 17:22:38 -07005715 /**
5716 * The visual y position of this view, in pixels. This is equivalent to the
5717 * {@link #setTranslationY(float) translationY} property plus the current
5718 * {@link #getTop() top} property.
5719 *
5720 * @return The visual y position of this view, in pixels.
5721 */
5722 public float getY() {
5723 return mTop + mTranslationY;
5724 }
5725
5726 /**
5727 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
5728 * {@link #setTranslationY(float) translationY} property to be the difference between
5729 * the y value passed in and the current {@link #getTop() top} property.
5730 *
5731 * @param y The visual y position of this view, in pixels.
5732 */
5733 public void setY(float y) {
5734 setTranslationY(y - mTop);
5735 }
5736
5737
5738 /**
5739 * The horizontal location of this view relative to its {@link #getLeft() left} position.
5740 * This position is post-layout, in addition to wherever the object's
5741 * layout placed it.
5742 *
5743 * @return The horizontal position of this view relative to its left position, in pixels.
5744 */
5745 public float getTranslationX() {
5746 return mTranslationX;
5747 }
5748
5749 /**
5750 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
5751 * This effectively positions the object post-layout, in addition to wherever the object's
5752 * layout placed it.
5753 *
5754 * @param translationX The horizontal position of this view relative to its left position,
5755 * in pixels.
5756 */
5757 public void setTranslationX(float translationX) {
5758 if (mTranslationX != translationX) {
5759 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005760 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07005761 mTranslationX = translationX;
5762 mMatrixDirty = true;
5763 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005764 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005765 }
5766 }
5767
5768 /**
Chet Haasedf030d22010-07-30 17:22:38 -07005769 * The horizontal location of this view relative to its {@link #getTop() top} position.
5770 * This position is post-layout, in addition to wherever the object's
5771 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07005772 *
Chet Haasedf030d22010-07-30 17:22:38 -07005773 * @return The vertical position of this view relative to its top position,
5774 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07005775 */
Chet Haasedf030d22010-07-30 17:22:38 -07005776 public float getTranslationY() {
5777 return mTranslationY;
Chet Haasec3aa3612010-06-17 08:50:37 -07005778 }
5779
5780 /**
Chet Haasedf030d22010-07-30 17:22:38 -07005781 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
5782 * This effectively positions the object post-layout, in addition to wherever the object's
5783 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07005784 *
Chet Haasedf030d22010-07-30 17:22:38 -07005785 * @param translationY The vertical position of this view relative to its top position,
5786 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07005787 */
Chet Haasedf030d22010-07-30 17:22:38 -07005788 public void setTranslationY(float translationY) {
5789 if (mTranslationY != translationY) {
5790 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005791 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07005792 mTranslationY = translationY;
5793 mMatrixDirty = true;
5794 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005795 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07005796 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005797 }
5798
5799 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005800 * Hit rectangle in parent's coordinates
5801 *
5802 * @param outRect The hit rectangle of the view.
5803 */
5804 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07005805 updateMatrix();
5806 if (mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07005807 outRect.set(mLeft, mTop, mRight, mBottom);
5808 } else {
5809 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Romain Guy33e72ae2010-07-17 12:40:29 -07005810 tmpRect.set(-mPivotX, -mPivotY, getWidth() - mPivotX, getHeight() - mPivotY);
Jeff Brown86671742010-09-30 20:00:15 -07005811 mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07005812 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
5813 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07005814 }
5815 }
5816
5817 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07005818 * Determines whether the given point, in local coordinates is inside the view.
5819 */
5820 /*package*/ final boolean pointInView(float localX, float localY) {
5821 return localX >= 0 && localX < (mRight - mLeft)
5822 && localY >= 0 && localY < (mBottom - mTop);
5823 }
5824
5825 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005826 * Utility method to determine whether the given point, in local coordinates,
5827 * is inside the view, where the area of the view is expanded by the slop factor.
5828 * This method is called while processing touch-move events to determine if the event
5829 * is still within the view.
5830 */
5831 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07005832 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07005833 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005834 }
5835
5836 /**
5837 * When a view has focus and the user navigates away from it, the next view is searched for
5838 * starting from the rectangle filled in by this method.
5839 *
5840 * By default, the rectange is the {@link #getDrawingRect})of the view. However, if your
5841 * view maintains some idea of internal selection, such as a cursor, or a selected row
5842 * or column, you should override this method and fill in a more specific rectangle.
5843 *
5844 * @param r The rectangle to fill in, in this view's coordinates.
5845 */
5846 public void getFocusedRect(Rect r) {
5847 getDrawingRect(r);
5848 }
5849
5850 /**
5851 * If some part of this view is not clipped by any of its parents, then
5852 * return that area in r in global (root) coordinates. To convert r to local
5853 * coordinates, offset it by -globalOffset (e.g. r.offset(-globalOffset.x,
5854 * -globalOffset.y)) If the view is completely clipped or translated out,
5855 * return false.
5856 *
5857 * @param r If true is returned, r holds the global coordinates of the
5858 * visible portion of this view.
5859 * @param globalOffset If true is returned, globalOffset holds the dx,dy
5860 * between this view and its root. globalOffet may be null.
5861 * @return true if r is non-empty (i.e. part of the view is visible at the
5862 * root level.
5863 */
5864 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
5865 int width = mRight - mLeft;
5866 int height = mBottom - mTop;
5867 if (width > 0 && height > 0) {
5868 r.set(0, 0, width, height);
5869 if (globalOffset != null) {
5870 globalOffset.set(-mScrollX, -mScrollY);
5871 }
5872 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
5873 }
5874 return false;
5875 }
5876
5877 public final boolean getGlobalVisibleRect(Rect r) {
5878 return getGlobalVisibleRect(r, null);
5879 }
5880
5881 public final boolean getLocalVisibleRect(Rect r) {
5882 Point offset = new Point();
5883 if (getGlobalVisibleRect(r, offset)) {
5884 r.offset(-offset.x, -offset.y); // make r local
5885 return true;
5886 }
5887 return false;
5888 }
5889
5890 /**
5891 * Offset this view's vertical location by the specified number of pixels.
5892 *
5893 * @param offset the number of pixels to offset the view by
5894 */
5895 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07005896 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07005897 updateMatrix();
5898 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07005899 final ViewParent p = mParent;
5900 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07005901 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07005902 int minTop;
5903 int maxBottom;
5904 int yLoc;
5905 if (offset < 0) {
5906 minTop = mTop + offset;
5907 maxBottom = mBottom;
5908 yLoc = offset;
5909 } else {
5910 minTop = mTop;
5911 maxBottom = mBottom + offset;
5912 yLoc = 0;
5913 }
5914 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
5915 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07005916 }
5917 } else {
Chet Haaseed032702010-10-01 14:05:54 -07005918 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005919 }
Romain Guy33e72ae2010-07-17 12:40:29 -07005920
Chet Haasec3aa3612010-06-17 08:50:37 -07005921 mTop += offset;
5922 mBottom += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07005923
Chet Haasec3aa3612010-06-17 08:50:37 -07005924 if (!mMatrixIsIdentity) {
5925 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005926 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005927 }
5928 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005929 }
5930
5931 /**
5932 * Offset this view's horizontal location by the specified amount of pixels.
5933 *
5934 * @param offset the numer of pixels to offset the view by
5935 */
5936 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07005937 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07005938 updateMatrix();
5939 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07005940 final ViewParent p = mParent;
5941 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07005942 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07005943 int minLeft;
5944 int maxRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07005945 if (offset < 0) {
5946 minLeft = mLeft + offset;
5947 maxRight = mRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07005948 } else {
5949 minLeft = mLeft;
5950 maxRight = mRight + offset;
Chet Haase8fbf8d22010-07-30 15:01:32 -07005951 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005952 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
Chet Haase8fbf8d22010-07-30 15:01:32 -07005953 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07005954 }
5955 } else {
Chet Haaseed032702010-10-01 14:05:54 -07005956 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005957 }
Romain Guy33e72ae2010-07-17 12:40:29 -07005958
Chet Haasec3aa3612010-06-17 08:50:37 -07005959 mLeft += offset;
5960 mRight += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07005961
Chet Haasec3aa3612010-06-17 08:50:37 -07005962 if (!mMatrixIsIdentity) {
5963 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005964 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005965 }
5966 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005967 }
5968
5969 /**
5970 * Get the LayoutParams associated with this view. All views should have
5971 * layout parameters. These supply parameters to the <i>parent</i> of this
5972 * view specifying how it should be arranged. There are many subclasses of
5973 * ViewGroup.LayoutParams, and these correspond to the different subclasses
5974 * of ViewGroup that are responsible for arranging their children.
5975 * @return The LayoutParams associated with this view
5976 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07005977 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005978 public ViewGroup.LayoutParams getLayoutParams() {
5979 return mLayoutParams;
5980 }
5981
5982 /**
5983 * Set the layout parameters associated with this view. These supply
5984 * parameters to the <i>parent</i> of this view specifying how it should be
5985 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
5986 * correspond to the different subclasses of ViewGroup that are responsible
5987 * for arranging their children.
5988 *
5989 * @param params the layout parameters for this view
5990 */
5991 public void setLayoutParams(ViewGroup.LayoutParams params) {
5992 if (params == null) {
5993 throw new NullPointerException("params == null");
5994 }
5995 mLayoutParams = params;
5996 requestLayout();
5997 }
5998
5999 /**
6000 * Set the scrolled position of your view. This will cause a call to
6001 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6002 * invalidated.
6003 * @param x the x position to scroll to
6004 * @param y the y position to scroll to
6005 */
6006 public void scrollTo(int x, int y) {
6007 if (mScrollX != x || mScrollY != y) {
6008 int oldX = mScrollX;
6009 int oldY = mScrollY;
6010 mScrollX = x;
6011 mScrollY = y;
6012 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07006013 if (!awakenScrollBars()) {
6014 invalidate();
6015 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006016 }
6017 }
6018
6019 /**
6020 * Move the scrolled position of your view. This will cause a call to
6021 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6022 * invalidated.
6023 * @param x the amount of pixels to scroll by horizontally
6024 * @param y the amount of pixels to scroll by vertically
6025 */
6026 public void scrollBy(int x, int y) {
6027 scrollTo(mScrollX + x, mScrollY + y);
6028 }
6029
6030 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006031 * <p>Trigger the scrollbars to draw. When invoked this method starts an
6032 * animation to fade the scrollbars out after a default delay. If a subclass
6033 * provides animated scrolling, the start delay should equal the duration
6034 * of the scrolling animation.</p>
6035 *
6036 * <p>The animation starts only if at least one of the scrollbars is
6037 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
6038 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6039 * this method returns true, and false otherwise. If the animation is
6040 * started, this method calls {@link #invalidate()}; in that case the
6041 * caller should not call {@link #invalidate()}.</p>
6042 *
6043 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07006044 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07006045 *
6046 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
6047 * and {@link #scrollTo(int, int)}.</p>
6048 *
6049 * @return true if the animation is played, false otherwise
6050 *
6051 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07006052 * @see #scrollBy(int, int)
6053 * @see #scrollTo(int, int)
6054 * @see #isHorizontalScrollBarEnabled()
6055 * @see #isVerticalScrollBarEnabled()
6056 * @see #setHorizontalScrollBarEnabled(boolean)
6057 * @see #setVerticalScrollBarEnabled(boolean)
6058 */
6059 protected boolean awakenScrollBars() {
6060 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07006061 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07006062 }
6063
6064 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07006065 * Trigger the scrollbars to draw.
6066 * This method differs from awakenScrollBars() only in its default duration.
6067 * initialAwakenScrollBars() will show the scroll bars for longer than
6068 * usual to give the user more of a chance to notice them.
6069 *
6070 * @return true if the animation is played, false otherwise.
6071 */
6072 private boolean initialAwakenScrollBars() {
6073 return mScrollCache != null &&
6074 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
6075 }
6076
6077 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006078 * <p>
6079 * Trigger the scrollbars to draw. When invoked this method starts an
6080 * animation to fade the scrollbars out after a fixed delay. If a subclass
6081 * provides animated scrolling, the start delay should equal the duration of
6082 * the scrolling animation.
6083 * </p>
6084 *
6085 * <p>
6086 * The animation starts only if at least one of the scrollbars is enabled,
6087 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6088 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6089 * this method returns true, and false otherwise. If the animation is
6090 * started, this method calls {@link #invalidate()}; in that case the caller
6091 * should not call {@link #invalidate()}.
6092 * </p>
6093 *
6094 * <p>
6095 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07006096 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07006097 * </p>
6098 *
6099 * @param startDelay the delay, in milliseconds, after which the animation
6100 * should start; when the delay is 0, the animation starts
6101 * immediately
6102 * @return true if the animation is played, false otherwise
6103 *
Mike Cleronf116bf82009-09-27 19:14:12 -07006104 * @see #scrollBy(int, int)
6105 * @see #scrollTo(int, int)
6106 * @see #isHorizontalScrollBarEnabled()
6107 * @see #isVerticalScrollBarEnabled()
6108 * @see #setHorizontalScrollBarEnabled(boolean)
6109 * @see #setVerticalScrollBarEnabled(boolean)
6110 */
6111 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07006112 return awakenScrollBars(startDelay, true);
6113 }
6114
6115 /**
6116 * <p>
6117 * Trigger the scrollbars to draw. When invoked this method starts an
6118 * animation to fade the scrollbars out after a fixed delay. If a subclass
6119 * provides animated scrolling, the start delay should equal the duration of
6120 * the scrolling animation.
6121 * </p>
6122 *
6123 * <p>
6124 * The animation starts only if at least one of the scrollbars is enabled,
6125 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6126 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6127 * this method returns true, and false otherwise. If the animation is
6128 * started, this method calls {@link #invalidate()} if the invalidate parameter
6129 * is set to true; in that case the caller
6130 * should not call {@link #invalidate()}.
6131 * </p>
6132 *
6133 * <p>
6134 * This method should be invoked everytime a subclass directly updates the
6135 * scroll parameters.
6136 * </p>
6137 *
6138 * @param startDelay the delay, in milliseconds, after which the animation
6139 * should start; when the delay is 0, the animation starts
6140 * immediately
6141 *
6142 * @param invalidate Wheter this method should call invalidate
6143 *
6144 * @return true if the animation is played, false otherwise
6145 *
6146 * @see #scrollBy(int, int)
6147 * @see #scrollTo(int, int)
6148 * @see #isHorizontalScrollBarEnabled()
6149 * @see #isVerticalScrollBarEnabled()
6150 * @see #setHorizontalScrollBarEnabled(boolean)
6151 * @see #setVerticalScrollBarEnabled(boolean)
6152 */
6153 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07006154 final ScrollabilityCache scrollCache = mScrollCache;
6155
6156 if (scrollCache == null || !scrollCache.fadeScrollBars) {
6157 return false;
6158 }
6159
6160 if (scrollCache.scrollBar == null) {
6161 scrollCache.scrollBar = new ScrollBarDrawable();
6162 }
6163
6164 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
6165
Mike Cleron290947b2009-09-29 18:34:32 -07006166 if (invalidate) {
6167 // Invalidate to show the scrollbars
6168 invalidate();
6169 }
Mike Cleronf116bf82009-09-27 19:14:12 -07006170
6171 if (scrollCache.state == ScrollabilityCache.OFF) {
6172 // FIXME: this is copied from WindowManagerService.
6173 // We should get this value from the system when it
6174 // is possible to do so.
6175 final int KEY_REPEAT_FIRST_DELAY = 750;
6176 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
6177 }
6178
6179 // Tell mScrollCache when we should start fading. This may
6180 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07006181 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07006182 scrollCache.fadeStartTime = fadeStartTime;
6183 scrollCache.state = ScrollabilityCache.ON;
6184
6185 // Schedule our fader to run, unscheduling any old ones first
6186 if (mAttachInfo != null) {
6187 mAttachInfo.mHandler.removeCallbacks(scrollCache);
6188 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
6189 }
6190
6191 return true;
6192 }
6193
6194 return false;
6195 }
6196
6197 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006198 * Mark the the area defined by dirty as needing to be drawn. If the view is
6199 * visible, {@link #onDraw} will be called at some point in the future.
6200 * This must be called from a UI thread. To call from a non-UI thread, call
6201 * {@link #postInvalidate()}.
6202 *
6203 * WARNING: This method is destructive to dirty.
6204 * @param dirty the rectangle representing the bounds of the dirty region
6205 */
6206 public void invalidate(Rect dirty) {
6207 if (ViewDebug.TRACE_HIERARCHY) {
6208 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6209 }
6210
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006211 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
6212 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006213 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6214 final ViewParent p = mParent;
6215 final AttachInfo ai = mAttachInfo;
6216 if (p != null && ai != null) {
6217 final int scrollX = mScrollX;
6218 final int scrollY = mScrollY;
6219 final Rect r = ai.mTmpInvalRect;
6220 r.set(dirty.left - scrollX, dirty.top - scrollY,
6221 dirty.right - scrollX, dirty.bottom - scrollY);
6222 mParent.invalidateChild(this, r);
6223 }
6224 }
6225 }
6226
6227 /**
6228 * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
6229 * The coordinates of the dirty rect are relative to the view.
6230 * If the view is visible, {@link #onDraw} will be called at some point
6231 * in the future. This must be called from a UI thread. To call
6232 * from a non-UI thread, call {@link #postInvalidate()}.
6233 * @param l the left position of the dirty region
6234 * @param t the top position of the dirty region
6235 * @param r the right position of the dirty region
6236 * @param b the bottom position of the dirty region
6237 */
6238 public void invalidate(int l, int t, int r, int b) {
6239 if (ViewDebug.TRACE_HIERARCHY) {
6240 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6241 }
6242
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006243 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
6244 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006245 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6246 final ViewParent p = mParent;
6247 final AttachInfo ai = mAttachInfo;
6248 if (p != null && ai != null && l < r && t < b) {
6249 final int scrollX = mScrollX;
6250 final int scrollY = mScrollY;
6251 final Rect tmpr = ai.mTmpInvalRect;
6252 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
6253 p.invalidateChild(this, tmpr);
6254 }
6255 }
6256 }
6257
6258 /**
6259 * Invalidate the whole view. If the view is visible, {@link #onDraw} will
6260 * be called at some point in the future. This must be called from a
6261 * UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
6262 */
6263 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -07006264 invalidate(true);
6265 }
6266
6267 /**
6268 * This is where the invalidate() work actually happens. A full invalidate()
6269 * causes the drawing cache to be invalidated, but this function can be called with
6270 * invalidateCache set to false to skip that invalidation step for cases that do not
6271 * need it (for example, a component that remains at the same dimensions with the same
6272 * content).
6273 *
6274 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
6275 * well. This is usually true for a full invalidate, but may be set to false if the
6276 * View's contents or dimensions have not changed.
6277 */
6278 private void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006279 if (ViewDebug.TRACE_HIERARCHY) {
6280 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
6281 }
6282
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006283 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
6284 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID)) {
Chet Haaseed032702010-10-01 14:05:54 -07006285 mPrivateFlags &= ~DRAWN;
6286 if (invalidateCache) {
6287 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6288 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006289 final ViewParent p = mParent;
6290 final AttachInfo ai = mAttachInfo;
6291 if (p != null && ai != null) {
6292 final Rect r = ai.mTmpInvalRect;
6293 r.set(0, 0, mRight - mLeft, mBottom - mTop);
6294 // Don't call invalidate -- we don't want to internally scroll
6295 // our own bounds
6296 p.invalidateChild(this, r);
6297 }
6298 }
6299 }
6300
6301 /**
Romain Guy24443ea2009-05-11 11:56:30 -07006302 * Indicates whether this View is opaque. An opaque View guarantees that it will
6303 * draw all the pixels overlapping its bounds using a fully opaque color.
6304 *
6305 * Subclasses of View should override this method whenever possible to indicate
6306 * whether an instance is opaque. Opaque Views are treated in a special way by
6307 * the View hierarchy, possibly allowing it to perform optimizations during
6308 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -07006309 *
Romain Guy24443ea2009-05-11 11:56:30 -07006310 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -07006311 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07006312 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -07006313 public boolean isOpaque() {
Romain Guy8f1344f52009-05-15 16:03:59 -07006314 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK;
6315 }
6316
6317 private void computeOpaqueFlags() {
6318 // Opaque if:
6319 // - Has a background
6320 // - Background is opaque
6321 // - Doesn't have scrollbars or scrollbars are inside overlay
6322
6323 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) {
6324 mPrivateFlags |= OPAQUE_BACKGROUND;
6325 } else {
6326 mPrivateFlags &= ~OPAQUE_BACKGROUND;
6327 }
6328
6329 final int flags = mViewFlags;
6330 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
6331 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
6332 mPrivateFlags |= OPAQUE_SCROLLBARS;
6333 } else {
6334 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
6335 }
6336 }
6337
6338 /**
6339 * @hide
6340 */
6341 protected boolean hasOpaqueScrollbars() {
6342 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -07006343 }
6344
6345 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006346 * @return A handler associated with the thread running the View. This
6347 * handler can be used to pump events in the UI events queue.
6348 */
6349 public Handler getHandler() {
6350 if (mAttachInfo != null) {
6351 return mAttachInfo.mHandler;
6352 }
6353 return null;
6354 }
6355
6356 /**
6357 * Causes the Runnable to be added to the message queue.
6358 * The runnable will be run on the user interface thread.
6359 *
6360 * @param action The Runnable that will be executed.
6361 *
6362 * @return Returns true if the Runnable was successfully placed in to the
6363 * message queue. Returns false on failure, usually because the
6364 * looper processing the message queue is exiting.
6365 */
6366 public boolean post(Runnable action) {
6367 Handler handler;
6368 if (mAttachInfo != null) {
6369 handler = mAttachInfo.mHandler;
6370 } else {
6371 // Assume that post will succeed later
6372 ViewRoot.getRunQueue().post(action);
6373 return true;
6374 }
6375
6376 return handler.post(action);
6377 }
6378
6379 /**
6380 * Causes the Runnable to be added to the message queue, to be run
6381 * after the specified amount of time elapses.
6382 * The runnable will be run on the user interface thread.
6383 *
6384 * @param action The Runnable that will be executed.
6385 * @param delayMillis The delay (in milliseconds) until the Runnable
6386 * will be executed.
6387 *
6388 * @return true if the Runnable was successfully placed in to the
6389 * message queue. Returns false on failure, usually because the
6390 * looper processing the message queue is exiting. Note that a
6391 * result of true does not mean the Runnable will be processed --
6392 * if the looper is quit before the delivery time of the message
6393 * occurs then the message will be dropped.
6394 */
6395 public boolean postDelayed(Runnable action, long delayMillis) {
6396 Handler handler;
6397 if (mAttachInfo != null) {
6398 handler = mAttachInfo.mHandler;
6399 } else {
6400 // Assume that post will succeed later
6401 ViewRoot.getRunQueue().postDelayed(action, delayMillis);
6402 return true;
6403 }
6404
6405 return handler.postDelayed(action, delayMillis);
6406 }
6407
6408 /**
6409 * Removes the specified Runnable from the message queue.
6410 *
6411 * @param action The Runnable to remove from the message handling queue
6412 *
6413 * @return true if this view could ask the Handler to remove the Runnable,
6414 * false otherwise. When the returned value is true, the Runnable
6415 * may or may not have been actually removed from the message queue
6416 * (for instance, if the Runnable was not in the queue already.)
6417 */
6418 public boolean removeCallbacks(Runnable action) {
6419 Handler handler;
6420 if (mAttachInfo != null) {
6421 handler = mAttachInfo.mHandler;
6422 } else {
6423 // Assume that post will succeed later
6424 ViewRoot.getRunQueue().removeCallbacks(action);
6425 return true;
6426 }
6427
6428 handler.removeCallbacks(action);
6429 return true;
6430 }
6431
6432 /**
6433 * Cause an invalidate to happen on a subsequent cycle through the event loop.
6434 * Use this to invalidate the View from a non-UI thread.
6435 *
6436 * @see #invalidate()
6437 */
6438 public void postInvalidate() {
6439 postInvalidateDelayed(0);
6440 }
6441
6442 /**
6443 * Cause an invalidate of the specified area to happen on a subsequent cycle
6444 * through the event loop. Use this to invalidate the View from a non-UI thread.
6445 *
6446 * @param left The left coordinate of the rectangle to invalidate.
6447 * @param top The top coordinate of the rectangle to invalidate.
6448 * @param right The right coordinate of the rectangle to invalidate.
6449 * @param bottom The bottom coordinate of the rectangle to invalidate.
6450 *
6451 * @see #invalidate(int, int, int, int)
6452 * @see #invalidate(Rect)
6453 */
6454 public void postInvalidate(int left, int top, int right, int bottom) {
6455 postInvalidateDelayed(0, left, top, right, bottom);
6456 }
6457
6458 /**
6459 * Cause an invalidate to happen on a subsequent cycle through the event
6460 * loop. Waits for the specified amount of time.
6461 *
6462 * @param delayMilliseconds the duration in milliseconds to delay the
6463 * invalidation by
6464 */
6465 public void postInvalidateDelayed(long delayMilliseconds) {
6466 // We try only with the AttachInfo because there's no point in invalidating
6467 // if we are not attached to our window
6468 if (mAttachInfo != null) {
6469 Message msg = Message.obtain();
6470 msg.what = AttachInfo.INVALIDATE_MSG;
6471 msg.obj = this;
6472 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
6473 }
6474 }
6475
6476 /**
6477 * Cause an invalidate of the specified area to happen on a subsequent cycle
6478 * through the event loop. Waits for the specified amount of time.
6479 *
6480 * @param delayMilliseconds the duration in milliseconds to delay the
6481 * invalidation by
6482 * @param left The left coordinate of the rectangle to invalidate.
6483 * @param top The top coordinate of the rectangle to invalidate.
6484 * @param right The right coordinate of the rectangle to invalidate.
6485 * @param bottom The bottom coordinate of the rectangle to invalidate.
6486 */
6487 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
6488 int right, int bottom) {
6489
6490 // We try only with the AttachInfo because there's no point in invalidating
6491 // if we are not attached to our window
6492 if (mAttachInfo != null) {
6493 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
6494 info.target = this;
6495 info.left = left;
6496 info.top = top;
6497 info.right = right;
6498 info.bottom = bottom;
6499
6500 final Message msg = Message.obtain();
6501 msg.what = AttachInfo.INVALIDATE_RECT_MSG;
6502 msg.obj = info;
6503 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
6504 }
6505 }
6506
6507 /**
6508 * Called by a parent to request that a child update its values for mScrollX
6509 * and mScrollY if necessary. This will typically be done if the child is
6510 * animating a scroll using a {@link android.widget.Scroller Scroller}
6511 * object.
6512 */
6513 public void computeScroll() {
6514 }
6515
6516 /**
6517 * <p>Indicate whether the horizontal edges are faded when the view is
6518 * scrolled horizontally.</p>
6519 *
6520 * @return true if the horizontal edges should are faded on scroll, false
6521 * otherwise
6522 *
6523 * @see #setHorizontalFadingEdgeEnabled(boolean)
6524 * @attr ref android.R.styleable#View_fadingEdge
6525 */
6526 public boolean isHorizontalFadingEdgeEnabled() {
6527 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
6528 }
6529
6530 /**
6531 * <p>Define whether the horizontal edges should be faded when this view
6532 * is scrolled horizontally.</p>
6533 *
6534 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
6535 * be faded when the view is scrolled
6536 * horizontally
6537 *
6538 * @see #isHorizontalFadingEdgeEnabled()
6539 * @attr ref android.R.styleable#View_fadingEdge
6540 */
6541 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
6542 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
6543 if (horizontalFadingEdgeEnabled) {
6544 initScrollCache();
6545 }
6546
6547 mViewFlags ^= FADING_EDGE_HORIZONTAL;
6548 }
6549 }
6550
6551 /**
6552 * <p>Indicate whether the vertical edges are faded when the view is
6553 * scrolled horizontally.</p>
6554 *
6555 * @return true if the vertical edges should are faded on scroll, false
6556 * otherwise
6557 *
6558 * @see #setVerticalFadingEdgeEnabled(boolean)
6559 * @attr ref android.R.styleable#View_fadingEdge
6560 */
6561 public boolean isVerticalFadingEdgeEnabled() {
6562 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
6563 }
6564
6565 /**
6566 * <p>Define whether the vertical edges should be faded when this view
6567 * is scrolled vertically.</p>
6568 *
6569 * @param verticalFadingEdgeEnabled true if the vertical edges should
6570 * be faded when the view is scrolled
6571 * vertically
6572 *
6573 * @see #isVerticalFadingEdgeEnabled()
6574 * @attr ref android.R.styleable#View_fadingEdge
6575 */
6576 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
6577 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
6578 if (verticalFadingEdgeEnabled) {
6579 initScrollCache();
6580 }
6581
6582 mViewFlags ^= FADING_EDGE_VERTICAL;
6583 }
6584 }
6585
6586 /**
6587 * Returns the strength, or intensity, of the top faded edge. The strength is
6588 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
6589 * returns 0.0 or 1.0 but no value in between.
6590 *
6591 * Subclasses should override this method to provide a smoother fade transition
6592 * when scrolling occurs.
6593 *
6594 * @return the intensity of the top fade as a float between 0.0f and 1.0f
6595 */
6596 protected float getTopFadingEdgeStrength() {
6597 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
6598 }
6599
6600 /**
6601 * Returns the strength, or intensity, of the bottom faded edge. The strength is
6602 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
6603 * returns 0.0 or 1.0 but no value in between.
6604 *
6605 * Subclasses should override this method to provide a smoother fade transition
6606 * when scrolling occurs.
6607 *
6608 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
6609 */
6610 protected float getBottomFadingEdgeStrength() {
6611 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
6612 computeVerticalScrollRange() ? 1.0f : 0.0f;
6613 }
6614
6615 /**
6616 * Returns the strength, or intensity, of the left faded edge. The strength is
6617 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
6618 * returns 0.0 or 1.0 but no value in between.
6619 *
6620 * Subclasses should override this method to provide a smoother fade transition
6621 * when scrolling occurs.
6622 *
6623 * @return the intensity of the left fade as a float between 0.0f and 1.0f
6624 */
6625 protected float getLeftFadingEdgeStrength() {
6626 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
6627 }
6628
6629 /**
6630 * Returns the strength, or intensity, of the right faded edge. The strength is
6631 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
6632 * returns 0.0 or 1.0 but no value in between.
6633 *
6634 * Subclasses should override this method to provide a smoother fade transition
6635 * when scrolling occurs.
6636 *
6637 * @return the intensity of the right fade as a float between 0.0f and 1.0f
6638 */
6639 protected float getRightFadingEdgeStrength() {
6640 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
6641 computeHorizontalScrollRange() ? 1.0f : 0.0f;
6642 }
6643
6644 /**
6645 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
6646 * scrollbar is not drawn by default.</p>
6647 *
6648 * @return true if the horizontal scrollbar should be painted, false
6649 * otherwise
6650 *
6651 * @see #setHorizontalScrollBarEnabled(boolean)
6652 */
6653 public boolean isHorizontalScrollBarEnabled() {
6654 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
6655 }
6656
6657 /**
6658 * <p>Define whether the horizontal scrollbar should be drawn or not. The
6659 * scrollbar is not drawn by default.</p>
6660 *
6661 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
6662 * be painted
6663 *
6664 * @see #isHorizontalScrollBarEnabled()
6665 */
6666 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
6667 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
6668 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07006669 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006670 recomputePadding();
6671 }
6672 }
6673
6674 /**
6675 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
6676 * scrollbar is not drawn by default.</p>
6677 *
6678 * @return true if the vertical scrollbar should be painted, false
6679 * otherwise
6680 *
6681 * @see #setVerticalScrollBarEnabled(boolean)
6682 */
6683 public boolean isVerticalScrollBarEnabled() {
6684 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
6685 }
6686
6687 /**
6688 * <p>Define whether the vertical scrollbar should be drawn or not. The
6689 * scrollbar is not drawn by default.</p>
6690 *
6691 * @param verticalScrollBarEnabled true if the vertical scrollbar should
6692 * be painted
6693 *
6694 * @see #isVerticalScrollBarEnabled()
6695 */
6696 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
6697 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
6698 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07006699 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006700 recomputePadding();
6701 }
6702 }
6703
6704 private void recomputePadding() {
6705 setPadding(mPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
6706 }
Mike Cleronfe81d382009-09-28 14:22:16 -07006707
6708 /**
6709 * Define whether scrollbars will fade when the view is not scrolling.
6710 *
6711 * @param fadeScrollbars wheter to enable fading
6712 *
6713 */
6714 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
6715 initScrollCache();
6716 final ScrollabilityCache scrollabilityCache = mScrollCache;
6717 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -07006718 if (fadeScrollbars) {
6719 scrollabilityCache.state = ScrollabilityCache.OFF;
6720 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -07006721 scrollabilityCache.state = ScrollabilityCache.ON;
6722 }
6723 }
6724
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006725 /**
Mike Cleron52f0a642009-09-28 18:21:37 -07006726 *
6727 * Returns true if scrollbars will fade when this view is not scrolling
6728 *
6729 * @return true if scrollbar fading is enabled
6730 */
6731 public boolean isScrollbarFadingEnabled() {
6732 return mScrollCache != null && mScrollCache.fadeScrollBars;
6733 }
6734
6735 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006736 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
6737 * inset. When inset, they add to the padding of the view. And the scrollbars
6738 * can be drawn inside the padding area or on the edge of the view. For example,
6739 * if a view has a background drawable and you want to draw the scrollbars
6740 * inside the padding specified by the drawable, you can use
6741 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
6742 * appear at the edge of the view, ignoring the padding, then you can use
6743 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
6744 * @param style the style of the scrollbars. Should be one of
6745 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
6746 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
6747 * @see #SCROLLBARS_INSIDE_OVERLAY
6748 * @see #SCROLLBARS_INSIDE_INSET
6749 * @see #SCROLLBARS_OUTSIDE_OVERLAY
6750 * @see #SCROLLBARS_OUTSIDE_INSET
6751 */
6752 public void setScrollBarStyle(int style) {
6753 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
6754 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -07006755 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006756 recomputePadding();
6757 }
6758 }
6759
6760 /**
6761 * <p>Returns the current scrollbar style.</p>
6762 * @return the current scrollbar style
6763 * @see #SCROLLBARS_INSIDE_OVERLAY
6764 * @see #SCROLLBARS_INSIDE_INSET
6765 * @see #SCROLLBARS_OUTSIDE_OVERLAY
6766 * @see #SCROLLBARS_OUTSIDE_INSET
6767 */
6768 public int getScrollBarStyle() {
6769 return mViewFlags & SCROLLBARS_STYLE_MASK;
6770 }
6771
6772 /**
6773 * <p>Compute the horizontal range that the horizontal scrollbar
6774 * represents.</p>
6775 *
6776 * <p>The range is expressed in arbitrary units that must be the same as the
6777 * units used by {@link #computeHorizontalScrollExtent()} and
6778 * {@link #computeHorizontalScrollOffset()}.</p>
6779 *
6780 * <p>The default range is the drawing width of this view.</p>
6781 *
6782 * @return the total horizontal range represented by the horizontal
6783 * scrollbar
6784 *
6785 * @see #computeHorizontalScrollExtent()
6786 * @see #computeHorizontalScrollOffset()
6787 * @see android.widget.ScrollBarDrawable
6788 */
6789 protected int computeHorizontalScrollRange() {
6790 return getWidth();
6791 }
6792
6793 /**
6794 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
6795 * within the horizontal range. This value is used to compute the position
6796 * of the thumb within the scrollbar's track.</p>
6797 *
6798 * <p>The range is expressed in arbitrary units that must be the same as the
6799 * units used by {@link #computeHorizontalScrollRange()} and
6800 * {@link #computeHorizontalScrollExtent()}.</p>
6801 *
6802 * <p>The default offset is the scroll offset of this view.</p>
6803 *
6804 * @return the horizontal offset of the scrollbar's thumb
6805 *
6806 * @see #computeHorizontalScrollRange()
6807 * @see #computeHorizontalScrollExtent()
6808 * @see android.widget.ScrollBarDrawable
6809 */
6810 protected int computeHorizontalScrollOffset() {
6811 return mScrollX;
6812 }
6813
6814 /**
6815 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
6816 * within the horizontal range. This value is used to compute the length
6817 * of the thumb within the scrollbar's track.</p>
6818 *
6819 * <p>The range is expressed in arbitrary units that must be the same as the
6820 * units used by {@link #computeHorizontalScrollRange()} and
6821 * {@link #computeHorizontalScrollOffset()}.</p>
6822 *
6823 * <p>The default extent is the drawing width of this view.</p>
6824 *
6825 * @return the horizontal extent of the scrollbar's thumb
6826 *
6827 * @see #computeHorizontalScrollRange()
6828 * @see #computeHorizontalScrollOffset()
6829 * @see android.widget.ScrollBarDrawable
6830 */
6831 protected int computeHorizontalScrollExtent() {
6832 return getWidth();
6833 }
6834
6835 /**
6836 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
6837 *
6838 * <p>The range is expressed in arbitrary units that must be the same as the
6839 * units used by {@link #computeVerticalScrollExtent()} and
6840 * {@link #computeVerticalScrollOffset()}.</p>
6841 *
6842 * @return the total vertical range represented by the vertical scrollbar
6843 *
6844 * <p>The default range is the drawing height of this view.</p>
6845 *
6846 * @see #computeVerticalScrollExtent()
6847 * @see #computeVerticalScrollOffset()
6848 * @see android.widget.ScrollBarDrawable
6849 */
6850 protected int computeVerticalScrollRange() {
6851 return getHeight();
6852 }
6853
6854 /**
6855 * <p>Compute the vertical offset of the vertical scrollbar's thumb
6856 * within the horizontal range. This value is used to compute the position
6857 * of the thumb within the scrollbar's track.</p>
6858 *
6859 * <p>The range is expressed in arbitrary units that must be the same as the
6860 * units used by {@link #computeVerticalScrollRange()} and
6861 * {@link #computeVerticalScrollExtent()}.</p>
6862 *
6863 * <p>The default offset is the scroll offset of this view.</p>
6864 *
6865 * @return the vertical offset of the scrollbar's thumb
6866 *
6867 * @see #computeVerticalScrollRange()
6868 * @see #computeVerticalScrollExtent()
6869 * @see android.widget.ScrollBarDrawable
6870 */
6871 protected int computeVerticalScrollOffset() {
6872 return mScrollY;
6873 }
6874
6875 /**
6876 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
6877 * within the vertical range. This value is used to compute the length
6878 * of the thumb within the scrollbar's track.</p>
6879 *
6880 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -08006881 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006882 * {@link #computeVerticalScrollOffset()}.</p>
6883 *
6884 * <p>The default extent is the drawing height of this view.</p>
6885 *
6886 * @return the vertical extent of the scrollbar's thumb
6887 *
6888 * @see #computeVerticalScrollRange()
6889 * @see #computeVerticalScrollOffset()
6890 * @see android.widget.ScrollBarDrawable
6891 */
6892 protected int computeVerticalScrollExtent() {
6893 return getHeight();
6894 }
6895
6896 /**
6897 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
6898 * scrollbars are painted only if they have been awakened first.</p>
6899 *
6900 * @param canvas the canvas on which to draw the scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -07006901 *
6902 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006903 */
Romain Guy1d5b3a62009-11-05 18:44:12 -08006904 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006905 // scrollbars are drawn only when the animation is running
6906 final ScrollabilityCache cache = mScrollCache;
6907 if (cache != null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07006908
6909 int state = cache.state;
6910
6911 if (state == ScrollabilityCache.OFF) {
6912 return;
6913 }
6914
6915 boolean invalidate = false;
6916
6917 if (state == ScrollabilityCache.FADING) {
6918 // We're fading -- get our fade interpolation
6919 if (cache.interpolatorValues == null) {
6920 cache.interpolatorValues = new float[1];
6921 }
6922
6923 float[] values = cache.interpolatorValues;
6924
6925 // Stops the animation if we're done
6926 if (cache.scrollBarInterpolator.timeToValues(values) ==
6927 Interpolator.Result.FREEZE_END) {
6928 cache.state = ScrollabilityCache.OFF;
6929 } else {
6930 cache.scrollBar.setAlpha(Math.round(values[0]));
6931 }
6932
6933 // This will make the scroll bars inval themselves after
6934 // drawing. We only want this when we're fading so that
6935 // we prevent excessive redraws
6936 invalidate = true;
6937 } else {
6938 // We're just on -- but we may have been fading before so
6939 // reset alpha
6940 cache.scrollBar.setAlpha(255);
6941 }
6942
6943
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006944 final int viewFlags = mViewFlags;
6945
6946 final boolean drawHorizontalScrollBar =
6947 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
6948 final boolean drawVerticalScrollBar =
6949 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
6950 && !isVerticalScrollBarHidden();
6951
6952 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
6953 final int width = mRight - mLeft;
6954 final int height = mBottom - mTop;
6955
6956 final ScrollBarDrawable scrollBar = cache.scrollBar;
6957 int size = scrollBar.getSize(false);
6958 if (size <= 0) {
6959 size = cache.scrollBarSize;
6960 }
6961
Mike Reede8853fc2009-09-04 14:01:48 -04006962 final int scrollX = mScrollX;
6963 final int scrollY = mScrollY;
6964 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
6965
Mike Cleronf116bf82009-09-27 19:14:12 -07006966 int left, top, right, bottom;
6967
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006968 if (drawHorizontalScrollBar) {
Mike Cleronf116bf82009-09-27 19:14:12 -07006969 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -04006970 computeHorizontalScrollOffset(),
6971 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -04006972 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -07006973 getVerticalScrollbarWidth() : 0;
6974 top = scrollY + height - size - (mUserPaddingBottom & inside);
6975 left = scrollX + (mPaddingLeft & inside);
6976 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
6977 bottom = top + size;
6978 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
6979 if (invalidate) {
6980 invalidate(left, top, right, bottom);
6981 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006982 }
6983
6984 if (drawVerticalScrollBar) {
Mike Reede8853fc2009-09-04 14:01:48 -04006985 scrollBar.setParameters(computeVerticalScrollRange(),
6986 computeVerticalScrollOffset(),
6987 computeVerticalScrollExtent(), true);
6988 // TODO: Deal with RTL languages to position scrollbar on left
Mike Cleronf116bf82009-09-27 19:14:12 -07006989 left = scrollX + width - size - (mUserPaddingRight & inside);
6990 top = scrollY + (mPaddingTop & inside);
6991 right = left + size;
6992 bottom = scrollY + height - (mUserPaddingBottom & inside);
6993 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
6994 if (invalidate) {
6995 invalidate(left, top, right, bottom);
6996 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006997 }
6998 }
6999 }
7000 }
Romain Guy8506ab42009-06-11 17:35:47 -07007001
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007002 /**
Romain Guy8506ab42009-06-11 17:35:47 -07007003 * 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 -08007004 * FastScroller is visible.
7005 * @return whether to temporarily hide the vertical scrollbar
7006 * @hide
7007 */
7008 protected boolean isVerticalScrollBarHidden() {
7009 return false;
7010 }
7011
7012 /**
7013 * <p>Draw the horizontal scrollbar if
7014 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
7015 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007016 * @param canvas the canvas on which to draw the scrollbar
7017 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007018 *
7019 * @see #isHorizontalScrollBarEnabled()
7020 * @see #computeHorizontalScrollRange()
7021 * @see #computeHorizontalScrollExtent()
7022 * @see #computeHorizontalScrollOffset()
7023 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -07007024 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007025 */
Romain Guy8fb95422010-08-17 18:38:51 -07007026 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
7027 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007028 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007029 scrollBar.draw(canvas);
7030 }
Mike Reede8853fc2009-09-04 14:01:48 -04007031
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007032 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007033 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
7034 * returns true.</p>
7035 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007036 * @param canvas the canvas on which to draw the scrollbar
7037 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007038 *
7039 * @see #isVerticalScrollBarEnabled()
7040 * @see #computeVerticalScrollRange()
7041 * @see #computeVerticalScrollExtent()
7042 * @see #computeVerticalScrollOffset()
7043 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -04007044 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007045 */
Romain Guy8fb95422010-08-17 18:38:51 -07007046 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
7047 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -04007048 scrollBar.setBounds(l, t, r, b);
7049 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007050 }
7051
7052 /**
7053 * Implement this to do your drawing.
7054 *
7055 * @param canvas the canvas on which the background will be drawn
7056 */
7057 protected void onDraw(Canvas canvas) {
7058 }
7059
7060 /*
7061 * Caller is responsible for calling requestLayout if necessary.
7062 * (This allows addViewInLayout to not request a new layout.)
7063 */
7064 void assignParent(ViewParent parent) {
7065 if (mParent == null) {
7066 mParent = parent;
7067 } else if (parent == null) {
7068 mParent = null;
7069 } else {
7070 throw new RuntimeException("view " + this + " being added, but"
7071 + " it already has a parent");
7072 }
7073 }
7074
7075 /**
7076 * This is called when the view is attached to a window. At this point it
7077 * has a Surface and will start drawing. Note that this function is
7078 * guaranteed to be called before {@link #onDraw}, however it may be called
7079 * any time before the first onDraw -- including before or after
7080 * {@link #onMeasure}.
7081 *
7082 * @see #onDetachedFromWindow()
7083 */
7084 protected void onAttachedToWindow() {
7085 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
7086 mParent.requestTransparentRegion(this);
7087 }
Adam Powell8568c3a2010-04-19 14:26:11 -07007088 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
7089 initialAwakenScrollBars();
7090 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
7091 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007092 }
7093
7094 /**
7095 * This is called when the view is detached from a window. At this point it
7096 * no longer has a surface for drawing.
7097 *
7098 * @see #onAttachedToWindow()
7099 */
7100 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -08007101 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08007102 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -05007103 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007104 destroyDrawingCache();
7105 }
7106
7107 /**
7108 * @return The number of times this view has been attached to a window
7109 */
7110 protected int getWindowAttachCount() {
7111 return mWindowAttachCount;
7112 }
7113
7114 /**
7115 * Retrieve a unique token identifying the window this view is attached to.
7116 * @return Return the window's token for use in
7117 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
7118 */
7119 public IBinder getWindowToken() {
7120 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
7121 }
7122
7123 /**
7124 * Retrieve a unique token identifying the top-level "real" window of
7125 * the window that this view is attached to. That is, this is like
7126 * {@link #getWindowToken}, except if the window this view in is a panel
7127 * window (attached to another containing window), then the token of
7128 * the containing window is returned instead.
7129 *
7130 * @return Returns the associated window token, either
7131 * {@link #getWindowToken()} or the containing window's token.
7132 */
7133 public IBinder getApplicationWindowToken() {
7134 AttachInfo ai = mAttachInfo;
7135 if (ai != null) {
7136 IBinder appWindowToken = ai.mPanelParentWindowToken;
7137 if (appWindowToken == null) {
7138 appWindowToken = ai.mWindowToken;
7139 }
7140 return appWindowToken;
7141 }
7142 return null;
7143 }
7144
7145 /**
7146 * Retrieve private session object this view hierarchy is using to
7147 * communicate with the window manager.
7148 * @return the session object to communicate with the window manager
7149 */
7150 /*package*/ IWindowSession getWindowSession() {
7151 return mAttachInfo != null ? mAttachInfo.mSession : null;
7152 }
7153
7154 /**
7155 * @param info the {@link android.view.View.AttachInfo} to associated with
7156 * this view
7157 */
7158 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
7159 //System.out.println("Attached! " + this);
7160 mAttachInfo = info;
7161 mWindowAttachCount++;
7162 if (mFloatingTreeObserver != null) {
7163 info.mTreeObserver.merge(mFloatingTreeObserver);
7164 mFloatingTreeObserver = null;
7165 }
7166 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
7167 mAttachInfo.mScrollContainers.add(this);
7168 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
7169 }
7170 performCollectViewAttributes(visibility);
7171 onAttachedToWindow();
7172 int vis = info.mWindowVisibility;
7173 if (vis != GONE) {
7174 onWindowVisibilityChanged(vis);
7175 }
7176 }
7177
7178 void dispatchDetachedFromWindow() {
7179 //System.out.println("Detached! " + this);
7180 AttachInfo info = mAttachInfo;
7181 if (info != null) {
7182 int vis = info.mWindowVisibility;
7183 if (vis != GONE) {
7184 onWindowVisibilityChanged(GONE);
7185 }
7186 }
7187
7188 onDetachedFromWindow();
7189 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
7190 mAttachInfo.mScrollContainers.remove(this);
7191 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
7192 }
7193 mAttachInfo = null;
7194 }
7195
7196 /**
7197 * Store this view hierarchy's frozen state into the given container.
7198 *
7199 * @param container The SparseArray in which to save the view's state.
7200 *
7201 * @see #restoreHierarchyState
7202 * @see #dispatchSaveInstanceState
7203 * @see #onSaveInstanceState
7204 */
7205 public void saveHierarchyState(SparseArray<Parcelable> container) {
7206 dispatchSaveInstanceState(container);
7207 }
7208
7209 /**
7210 * Called by {@link #saveHierarchyState} to store the state for this view and its children.
7211 * May be overridden to modify how freezing happens to a view's children; for example, some
7212 * views may want to not store state for their children.
7213 *
7214 * @param container The SparseArray in which to save the view's state.
7215 *
7216 * @see #dispatchRestoreInstanceState
7217 * @see #saveHierarchyState
7218 * @see #onSaveInstanceState
7219 */
7220 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
7221 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
7222 mPrivateFlags &= ~SAVE_STATE_CALLED;
7223 Parcelable state = onSaveInstanceState();
7224 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
7225 throw new IllegalStateException(
7226 "Derived class did not call super.onSaveInstanceState()");
7227 }
7228 if (state != null) {
7229 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
7230 // + ": " + state);
7231 container.put(mID, state);
7232 }
7233 }
7234 }
7235
7236 /**
7237 * Hook allowing a view to generate a representation of its internal state
7238 * that can later be used to create a new instance with that same state.
7239 * This state should only contain information that is not persistent or can
7240 * not be reconstructed later. For example, you will never store your
7241 * current position on screen because that will be computed again when a
7242 * new instance of the view is placed in its view hierarchy.
7243 * <p>
7244 * Some examples of things you may store here: the current cursor position
7245 * in a text view (but usually not the text itself since that is stored in a
7246 * content provider or other persistent storage), the currently selected
7247 * item in a list view.
7248 *
7249 * @return Returns a Parcelable object containing the view's current dynamic
7250 * state, or null if there is nothing interesting to save. The
7251 * default implementation returns null.
7252 * @see #onRestoreInstanceState
7253 * @see #saveHierarchyState
7254 * @see #dispatchSaveInstanceState
7255 * @see #setSaveEnabled(boolean)
7256 */
7257 protected Parcelable onSaveInstanceState() {
7258 mPrivateFlags |= SAVE_STATE_CALLED;
7259 return BaseSavedState.EMPTY_STATE;
7260 }
7261
7262 /**
7263 * Restore this view hierarchy's frozen state from the given container.
7264 *
7265 * @param container The SparseArray which holds previously frozen states.
7266 *
7267 * @see #saveHierarchyState
7268 * @see #dispatchRestoreInstanceState
7269 * @see #onRestoreInstanceState
7270 */
7271 public void restoreHierarchyState(SparseArray<Parcelable> container) {
7272 dispatchRestoreInstanceState(container);
7273 }
7274
7275 /**
7276 * Called by {@link #restoreHierarchyState} to retrieve the state for this view and its
7277 * children. May be overridden to modify how restoreing happens to a view's children; for
7278 * example, some views may want to not store state for their children.
7279 *
7280 * @param container The SparseArray which holds previously saved state.
7281 *
7282 * @see #dispatchSaveInstanceState
7283 * @see #restoreHierarchyState
7284 * @see #onRestoreInstanceState
7285 */
7286 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
7287 if (mID != NO_ID) {
7288 Parcelable state = container.get(mID);
7289 if (state != null) {
7290 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
7291 // + ": " + state);
7292 mPrivateFlags &= ~SAVE_STATE_CALLED;
7293 onRestoreInstanceState(state);
7294 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
7295 throw new IllegalStateException(
7296 "Derived class did not call super.onRestoreInstanceState()");
7297 }
7298 }
7299 }
7300 }
7301
7302 /**
7303 * Hook allowing a view to re-apply a representation of its internal state that had previously
7304 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
7305 * null state.
7306 *
7307 * @param state The frozen state that had previously been returned by
7308 * {@link #onSaveInstanceState}.
7309 *
7310 * @see #onSaveInstanceState
7311 * @see #restoreHierarchyState
7312 * @see #dispatchRestoreInstanceState
7313 */
7314 protected void onRestoreInstanceState(Parcelable state) {
7315 mPrivateFlags |= SAVE_STATE_CALLED;
7316 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -08007317 throw new IllegalArgumentException("Wrong state class, expecting View State but "
7318 + "received " + state.getClass().toString() + " instead. This usually happens "
7319 + "when two views of different type have the same id in the same hierarchy. "
7320 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
7321 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007322 }
7323 }
7324
7325 /**
7326 * <p>Return the time at which the drawing of the view hierarchy started.</p>
7327 *
7328 * @return the drawing start time in milliseconds
7329 */
7330 public long getDrawingTime() {
7331 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
7332 }
7333
7334 /**
7335 * <p>Enables or disables the duplication of the parent's state into this view. When
7336 * duplication is enabled, this view gets its drawable state from its parent rather
7337 * than from its own internal properties.</p>
7338 *
7339 * <p>Note: in the current implementation, setting this property to true after the
7340 * view was added to a ViewGroup might have no effect at all. This property should
7341 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
7342 *
7343 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
7344 * property is enabled, an exception will be thrown.</p>
7345 *
7346 * @param enabled True to enable duplication of the parent's drawable state, false
7347 * to disable it.
7348 *
7349 * @see #getDrawableState()
7350 * @see #isDuplicateParentStateEnabled()
7351 */
7352 public void setDuplicateParentStateEnabled(boolean enabled) {
7353 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
7354 }
7355
7356 /**
7357 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
7358 *
7359 * @return True if this view's drawable state is duplicated from the parent,
7360 * false otherwise
7361 *
7362 * @see #getDrawableState()
7363 * @see #setDuplicateParentStateEnabled(boolean)
7364 */
7365 public boolean isDuplicateParentStateEnabled() {
7366 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
7367 }
7368
7369 /**
7370 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
7371 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
7372 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
7373 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
7374 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
7375 * null.</p>
7376 *
7377 * @param enabled true to enable the drawing cache, false otherwise
7378 *
7379 * @see #isDrawingCacheEnabled()
7380 * @see #getDrawingCache()
7381 * @see #buildDrawingCache()
7382 */
7383 public void setDrawingCacheEnabled(boolean enabled) {
7384 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
7385 }
7386
7387 /**
7388 * <p>Indicates whether the drawing cache is enabled for this view.</p>
7389 *
7390 * @return true if the drawing cache is enabled
7391 *
7392 * @see #setDrawingCacheEnabled(boolean)
7393 * @see #getDrawingCache()
7394 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07007395 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007396 public boolean isDrawingCacheEnabled() {
7397 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
7398 }
7399
7400 /**
Romain Guyb051e892010-09-28 19:09:36 -07007401 * <p>Returns a display list that can be used to draw this view again
7402 * without executing its draw method.</p>
7403 *
7404 * @return A DisplayList ready to replay, or null if caching is not enabled.
7405 */
7406 DisplayList getDisplayList() {
7407 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
7408 return null;
7409 }
7410
7411 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) {
7412 return null;
7413 }
7414
7415 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED &&
7416 ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mDisplayList == null)) {
7417
7418 if (mDisplayList != null) {
7419 mDisplayList.destroy();
7420 }
7421
7422 mDisplayList = mAttachInfo.mHardwareRenderer.createDisplayList();
7423
7424 final HardwareCanvas canvas = mDisplayList.start();
7425 try {
7426 int width = mRight - mLeft;
7427 int height = mBottom - mTop;
7428
7429 canvas.setViewport(width, height);
7430 canvas.onPreDraw();
7431
7432 final int restoreCount = canvas.save();
7433
Romain Guy2fe9a8f2010-10-04 20:17:01 -07007434 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
Romain Guyb051e892010-09-28 19:09:36 -07007435
7436 // Fast path for layouts with no backgrounds
7437 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
7438 mPrivateFlags &= ~DIRTY_MASK;
7439 dispatchDraw(canvas);
7440 } else {
7441 draw(canvas);
7442 }
7443
7444 canvas.restoreToCount(restoreCount);
7445 } finally {
7446 canvas.onPostDraw();
7447
7448 mDisplayList.end();
7449
7450 canvas.destroy();
7451 }
7452 }
7453
7454 return mDisplayList;
7455 }
7456
7457 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07007458 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
7459 *
7460 * @return A non-scaled bitmap representing this view or null if cache is disabled.
7461 *
7462 * @see #getDrawingCache(boolean)
7463 */
7464 public Bitmap getDrawingCache() {
7465 return getDrawingCache(false);
7466 }
7467
7468 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007469 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
7470 * is null when caching is disabled. If caching is enabled and the cache is not ready,
7471 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
7472 * draw from the cache when the cache is enabled. To benefit from the cache, you must
7473 * request the drawing cache by calling this method and draw it on screen if the
7474 * returned bitmap is not null.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07007475 *
7476 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
7477 * this method will create a bitmap of the same size as this view. Because this bitmap
7478 * will be drawn scaled by the parent ViewGroup, the result on screen might show
7479 * scaling artifacts. To avoid such artifacts, you should call this method by setting
7480 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
7481 * size than the view. This implies that your application must be able to handle this
7482 * size.</p>
7483 *
7484 * @param autoScale Indicates whether the generated bitmap should be scaled based on
7485 * the current density of the screen when the application is in compatibility
7486 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007487 *
Romain Guyfbd8f692009-06-26 14:51:58 -07007488 * @return A bitmap representing this view or null if cache is disabled.
7489 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007490 * @see #setDrawingCacheEnabled(boolean)
7491 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -07007492 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007493 * @see #destroyDrawingCache()
7494 */
Romain Guyfbd8f692009-06-26 14:51:58 -07007495 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007496 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
7497 return null;
7498 }
7499 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -07007500 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007501 }
Romain Guy02890fd2010-08-06 17:58:44 -07007502 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007503 }
7504
7505 /**
7506 * <p>Frees the resources used by the drawing cache. If you call
7507 * {@link #buildDrawingCache()} manually without calling
7508 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
7509 * should cleanup the cache with this method afterwards.</p>
7510 *
7511 * @see #setDrawingCacheEnabled(boolean)
7512 * @see #buildDrawingCache()
7513 * @see #getDrawingCache()
7514 */
7515 public void destroyDrawingCache() {
7516 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07007517 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007518 mDrawingCache = null;
7519 }
Romain Guyfbd8f692009-06-26 14:51:58 -07007520 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07007521 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -07007522 mUnscaledDrawingCache = null;
7523 }
Romain Guyb051e892010-09-28 19:09:36 -07007524 if (mDisplayList != null) {
7525 mDisplayList.destroy();
7526 mDisplayList = null;
7527 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007528 }
7529
7530 /**
7531 * Setting a solid background color for the drawing cache's bitmaps will improve
7532 * perfromance and memory usage. Note, though that this should only be used if this
7533 * view will always be drawn on top of a solid color.
7534 *
7535 * @param color The background color to use for the drawing cache's bitmap
7536 *
7537 * @see #setDrawingCacheEnabled(boolean)
7538 * @see #buildDrawingCache()
7539 * @see #getDrawingCache()
7540 */
7541 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -08007542 if (color != mDrawingCacheBackgroundColor) {
7543 mDrawingCacheBackgroundColor = color;
7544 mPrivateFlags &= ~DRAWING_CACHE_VALID;
7545 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007546 }
7547
7548 /**
7549 * @see #setDrawingCacheBackgroundColor(int)
7550 *
7551 * @return The background color to used for the drawing cache's bitmap
7552 */
7553 public int getDrawingCacheBackgroundColor() {
7554 return mDrawingCacheBackgroundColor;
7555 }
7556
7557 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07007558 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
7559 *
7560 * @see #buildDrawingCache(boolean)
7561 */
7562 public void buildDrawingCache() {
7563 buildDrawingCache(false);
7564 }
7565
7566 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007567 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
7568 *
7569 * <p>If you call {@link #buildDrawingCache()} manually without calling
7570 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
7571 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Romain Guyfbd8f692009-06-26 14:51:58 -07007572 *
7573 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
7574 * this method will create a bitmap of the same size as this view. Because this bitmap
7575 * will be drawn scaled by the parent ViewGroup, the result on screen might show
7576 * scaling artifacts. To avoid such artifacts, you should call this method by setting
7577 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
7578 * size than the view. This implies that your application must be able to handle this
7579 * size.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007580 *
7581 * @see #getDrawingCache()
7582 * @see #destroyDrawingCache()
7583 */
Romain Guyfbd8f692009-06-26 14:51:58 -07007584 public void buildDrawingCache(boolean autoScale) {
7585 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -07007586 mDrawingCache == null : mUnscaledDrawingCache == null)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007587
7588 if (ViewDebug.TRACE_HIERARCHY) {
7589 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
7590 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007591
Romain Guy8506ab42009-06-11 17:35:47 -07007592 int width = mRight - mLeft;
7593 int height = mBottom - mTop;
7594
7595 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -07007596 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -07007597
Romain Guye1123222009-06-29 14:24:56 -07007598 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07007599 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
7600 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -07007601 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007602
7603 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -07007604 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Romain Guya62e4702009-10-08 10:48:54 -07007605 final boolean translucentWindow = attachInfo != null && attachInfo.mTranslucentWindow;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007606
7607 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -07007608 // Projected bitmap size in bytes
7609 (width * height * (opaque && !translucentWindow ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007610 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
7611 destroyDrawingCache();
7612 return;
7613 }
7614
7615 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -07007616 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007617
7618 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007619 Bitmap.Config quality;
7620 if (!opaque) {
7621 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
7622 case DRAWING_CACHE_QUALITY_AUTO:
7623 quality = Bitmap.Config.ARGB_8888;
7624 break;
7625 case DRAWING_CACHE_QUALITY_LOW:
7626 quality = Bitmap.Config.ARGB_4444;
7627 break;
7628 case DRAWING_CACHE_QUALITY_HIGH:
7629 quality = Bitmap.Config.ARGB_8888;
7630 break;
7631 default:
7632 quality = Bitmap.Config.ARGB_8888;
7633 break;
7634 }
7635 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -07007636 // Optimization for translucent windows
7637 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
7638 quality = translucentWindow ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007639 }
7640
7641 // Try to cleanup memory
7642 if (bitmap != null) bitmap.recycle();
7643
7644 try {
7645 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -07007646 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -07007647 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -07007648 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07007649 } else {
Romain Guy02890fd2010-08-06 17:58:44 -07007650 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07007651 }
Romain Guy35b38ce2009-10-07 13:38:55 -07007652 if (opaque && translucentWindow) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007653 } catch (OutOfMemoryError e) {
7654 // If there is not enough memory to create the bitmap cache, just
7655 // ignore the issue as bitmap caches are not required to draw the
7656 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -07007657 if (autoScale) {
7658 mDrawingCache = null;
7659 } else {
7660 mUnscaledDrawingCache = null;
7661 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007662 return;
7663 }
7664
7665 clear = drawingCacheBackgroundColor != 0;
7666 }
7667
7668 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007669 if (attachInfo != null) {
7670 canvas = attachInfo.mCanvas;
7671 if (canvas == null) {
7672 canvas = new Canvas();
7673 }
7674 canvas.setBitmap(bitmap);
7675 // Temporarily clobber the cached Canvas in case one of our children
7676 // is also using a drawing cache. Without this, the children would
7677 // steal the canvas by attaching their own bitmap to it and bad, bad
7678 // thing would happen (invisible views, corrupted drawings, etc.)
7679 attachInfo.mCanvas = null;
7680 } else {
7681 // This case should hopefully never or seldom happen
7682 canvas = new Canvas(bitmap);
7683 }
7684
7685 if (clear) {
7686 bitmap.eraseColor(drawingCacheBackgroundColor);
7687 }
7688
7689 computeScroll();
7690 final int restoreCount = canvas.save();
Romain Guyfbd8f692009-06-26 14:51:58 -07007691
Romain Guye1123222009-06-29 14:24:56 -07007692 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07007693 final float scale = attachInfo.mApplicationScale;
7694 canvas.scale(scale, scale);
7695 }
7696
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007697 canvas.translate(-mScrollX, -mScrollY);
7698
Romain Guy5bcdff42009-05-14 21:27:18 -07007699 mPrivateFlags |= DRAWN;
Romain Guyecd80ee2009-12-03 17:13:02 -08007700 mPrivateFlags |= DRAWING_CACHE_VALID;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007701
7702 // Fast path for layouts with no backgrounds
7703 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
7704 if (ViewDebug.TRACE_HIERARCHY) {
7705 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
7706 }
Romain Guy5bcdff42009-05-14 21:27:18 -07007707 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007708 dispatchDraw(canvas);
7709 } else {
7710 draw(canvas);
7711 }
7712
7713 canvas.restoreToCount(restoreCount);
7714
7715 if (attachInfo != null) {
7716 // Restore the cached Canvas for our siblings
7717 attachInfo.mCanvas = canvas;
7718 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007719 }
7720 }
7721
7722 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07007723 * Create a snapshot of the view into a bitmap. We should probably make
7724 * some form of this public, but should think about the API.
7725 */
Romain Guy223ff5c2010-03-02 17:07:47 -08007726 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -07007727 int width = mRight - mLeft;
7728 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07007729
Dianne Hackborn8cae1242009-09-10 14:32:16 -07007730 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -07007731 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -07007732 width = (int) ((width * scale) + 0.5f);
7733 height = (int) ((height * scale) + 0.5f);
7734
Romain Guy8c11e312009-09-14 15:15:30 -07007735 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07007736 if (bitmap == null) {
7737 throw new OutOfMemoryError();
7738 }
7739
Dianne Hackborn8cae1242009-09-10 14:32:16 -07007740 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
7741
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07007742 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07007743 if (attachInfo != null) {
7744 canvas = attachInfo.mCanvas;
7745 if (canvas == null) {
7746 canvas = new Canvas();
7747 }
7748 canvas.setBitmap(bitmap);
7749 // Temporarily clobber the cached Canvas in case one of our children
7750 // is also using a drawing cache. Without this, the children would
7751 // steal the canvas by attaching their own bitmap to it and bad, bad
7752 // things would happen (invisible views, corrupted drawings, etc.)
7753 attachInfo.mCanvas = null;
7754 } else {
7755 // This case should hopefully never or seldom happen
7756 canvas = new Canvas(bitmap);
7757 }
7758
Romain Guy5bcdff42009-05-14 21:27:18 -07007759 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07007760 bitmap.eraseColor(backgroundColor);
7761 }
7762
7763 computeScroll();
7764 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -07007765 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07007766 canvas.translate(-mScrollX, -mScrollY);
7767
Romain Guy5bcdff42009-05-14 21:27:18 -07007768 // Temporarily remove the dirty mask
7769 int flags = mPrivateFlags;
7770 mPrivateFlags &= ~DIRTY_MASK;
7771
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07007772 // Fast path for layouts with no backgrounds
7773 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
7774 dispatchDraw(canvas);
7775 } else {
7776 draw(canvas);
7777 }
7778
Romain Guy5bcdff42009-05-14 21:27:18 -07007779 mPrivateFlags = flags;
7780
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07007781 canvas.restoreToCount(restoreCount);
7782
7783 if (attachInfo != null) {
7784 // Restore the cached Canvas for our siblings
7785 attachInfo.mCanvas = canvas;
7786 }
Romain Guy8506ab42009-06-11 17:35:47 -07007787
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07007788 return bitmap;
7789 }
7790
7791 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007792 * Indicates whether this View is currently in edit mode. A View is usually
7793 * in edit mode when displayed within a developer tool. For instance, if
7794 * this View is being drawn by a visual user interface builder, this method
7795 * should return true.
7796 *
7797 * Subclasses should check the return value of this method to provide
7798 * different behaviors if their normal behavior might interfere with the
7799 * host environment. For instance: the class spawns a thread in its
7800 * constructor, the drawing code relies on device-specific features, etc.
7801 *
7802 * This method is usually checked in the drawing code of custom widgets.
7803 *
7804 * @return True if this View is in edit mode, false otherwise.
7805 */
7806 public boolean isInEditMode() {
7807 return false;
7808 }
7809
7810 /**
7811 * If the View draws content inside its padding and enables fading edges,
7812 * it needs to support padding offsets. Padding offsets are added to the
7813 * fading edges to extend the length of the fade so that it covers pixels
7814 * drawn inside the padding.
7815 *
7816 * Subclasses of this class should override this method if they need
7817 * to draw content inside the padding.
7818 *
7819 * @return True if padding offset must be applied, false otherwise.
7820 *
7821 * @see #getLeftPaddingOffset()
7822 * @see #getRightPaddingOffset()
7823 * @see #getTopPaddingOffset()
7824 * @see #getBottomPaddingOffset()
7825 *
7826 * @since CURRENT
7827 */
7828 protected boolean isPaddingOffsetRequired() {
7829 return false;
7830 }
7831
7832 /**
7833 * Amount by which to extend the left fading region. Called only when
7834 * {@link #isPaddingOffsetRequired()} returns true.
7835 *
7836 * @return The left padding offset in pixels.
7837 *
7838 * @see #isPaddingOffsetRequired()
7839 *
7840 * @since CURRENT
7841 */
7842 protected int getLeftPaddingOffset() {
7843 return 0;
7844 }
7845
7846 /**
7847 * Amount by which to extend the right fading region. Called only when
7848 * {@link #isPaddingOffsetRequired()} returns true.
7849 *
7850 * @return The right padding offset in pixels.
7851 *
7852 * @see #isPaddingOffsetRequired()
7853 *
7854 * @since CURRENT
7855 */
7856 protected int getRightPaddingOffset() {
7857 return 0;
7858 }
7859
7860 /**
7861 * Amount by which to extend the top fading region. Called only when
7862 * {@link #isPaddingOffsetRequired()} returns true.
7863 *
7864 * @return The top padding offset in pixels.
7865 *
7866 * @see #isPaddingOffsetRequired()
7867 *
7868 * @since CURRENT
7869 */
7870 protected int getTopPaddingOffset() {
7871 return 0;
7872 }
7873
7874 /**
7875 * Amount by which to extend the bottom fading region. Called only when
7876 * {@link #isPaddingOffsetRequired()} returns true.
7877 *
7878 * @return The bottom padding offset in pixels.
7879 *
7880 * @see #isPaddingOffsetRequired()
7881 *
7882 * @since CURRENT
7883 */
7884 protected int getBottomPaddingOffset() {
7885 return 0;
7886 }
7887
7888 /**
Romain Guy2bffd262010-09-12 17:40:02 -07007889 * <p>Indicates whether this view is attached to an hardware accelerated
7890 * window or not.</p>
7891 *
7892 * <p>Even if this method returns true, it does not mean that every call
7893 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
7894 * accelerated {@link android.graphics.Canvas}. For instance, if this view
7895 * is drawn onto an offscren {@link android.graphics.Bitmap} and its
7896 * window is hardware accelerated,
7897 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
7898 * return false, and this method will return true.</p>
7899 *
7900 * @return True if the view is attached to a window and the window is
7901 * hardware accelerated; false in any other case.
7902 */
7903 public boolean isHardwareAccelerated() {
7904 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
7905 }
7906
7907 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007908 * Manually render this view (and all of its children) to the given Canvas.
7909 * The view must have already done a full layout before this function is
7910 * called. When implementing a view, do not override this method; instead,
7911 * you should implement {@link #onDraw}.
7912 *
7913 * @param canvas The Canvas to which the View is rendered.
7914 */
7915 public void draw(Canvas canvas) {
7916 if (ViewDebug.TRACE_HIERARCHY) {
7917 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
7918 }
7919
Romain Guy5bcdff42009-05-14 21:27:18 -07007920 final int privateFlags = mPrivateFlags;
7921 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
7922 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
7923 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -07007924
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007925 /*
7926 * Draw traversal performs several drawing steps which must be executed
7927 * in the appropriate order:
7928 *
7929 * 1. Draw the background
7930 * 2. If necessary, save the canvas' layers to prepare for fading
7931 * 3. Draw view's content
7932 * 4. Draw children
7933 * 5. If necessary, draw the fading edges and restore layers
7934 * 6. Draw decorations (scrollbars for instance)
7935 */
7936
7937 // Step 1, draw the background, if needed
7938 int saveCount;
7939
Romain Guy24443ea2009-05-11 11:56:30 -07007940 if (!dirtyOpaque) {
7941 final Drawable background = mBGDrawable;
7942 if (background != null) {
7943 final int scrollX = mScrollX;
7944 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007945
Romain Guy24443ea2009-05-11 11:56:30 -07007946 if (mBackgroundSizeChanged) {
7947 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
7948 mBackgroundSizeChanged = false;
7949 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007950
Romain Guy24443ea2009-05-11 11:56:30 -07007951 if ((scrollX | scrollY) == 0) {
7952 background.draw(canvas);
7953 } else {
7954 canvas.translate(scrollX, scrollY);
7955 background.draw(canvas);
7956 canvas.translate(-scrollX, -scrollY);
7957 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007958 }
7959 }
7960
7961 // skip step 2 & 5 if possible (common case)
7962 final int viewFlags = mViewFlags;
7963 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
7964 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
7965 if (!verticalEdges && !horizontalEdges) {
7966 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07007967 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007968
7969 // Step 4, draw the children
7970 dispatchDraw(canvas);
7971
7972 // Step 6, draw decorations (scrollbars)
7973 onDrawScrollBars(canvas);
7974
7975 // we're done...
7976 return;
7977 }
7978
7979 /*
7980 * Here we do the full fledged routine...
7981 * (this is an uncommon case where speed matters less,
7982 * this is why we repeat some of the tests that have been
7983 * done above)
7984 */
7985
7986 boolean drawTop = false;
7987 boolean drawBottom = false;
7988 boolean drawLeft = false;
7989 boolean drawRight = false;
7990
7991 float topFadeStrength = 0.0f;
7992 float bottomFadeStrength = 0.0f;
7993 float leftFadeStrength = 0.0f;
7994 float rightFadeStrength = 0.0f;
7995
7996 // Step 2, save the canvas' layers
7997 int paddingLeft = mPaddingLeft;
7998 int paddingTop = mPaddingTop;
7999
8000 final boolean offsetRequired = isPaddingOffsetRequired();
8001 if (offsetRequired) {
8002 paddingLeft += getLeftPaddingOffset();
8003 paddingTop += getTopPaddingOffset();
8004 }
8005
8006 int left = mScrollX + paddingLeft;
8007 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
8008 int top = mScrollY + paddingTop;
8009 int bottom = top + mBottom - mTop - mPaddingBottom - paddingTop;
8010
8011 if (offsetRequired) {
8012 right += getRightPaddingOffset();
8013 bottom += getBottomPaddingOffset();
8014 }
8015
8016 final ScrollabilityCache scrollabilityCache = mScrollCache;
8017 int length = scrollabilityCache.fadingEdgeLength;
8018
8019 // clip the fade length if top and bottom fades overlap
8020 // overlapping fades produce odd-looking artifacts
8021 if (verticalEdges && (top + length > bottom - length)) {
8022 length = (bottom - top) / 2;
8023 }
8024
8025 // also clip horizontal fades if necessary
8026 if (horizontalEdges && (left + length > right - length)) {
8027 length = (right - left) / 2;
8028 }
8029
8030 if (verticalEdges) {
8031 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008032 drawTop = topFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008033 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008034 drawBottom = bottomFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008035 }
8036
8037 if (horizontalEdges) {
8038 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008039 drawLeft = leftFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008040 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07008041 drawRight = rightFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008042 }
8043
8044 saveCount = canvas.getSaveCount();
8045
8046 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -07008047 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008048 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
8049
8050 if (drawTop) {
8051 canvas.saveLayer(left, top, right, top + length, null, flags);
8052 }
8053
8054 if (drawBottom) {
8055 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
8056 }
8057
8058 if (drawLeft) {
8059 canvas.saveLayer(left, top, left + length, bottom, null, flags);
8060 }
8061
8062 if (drawRight) {
8063 canvas.saveLayer(right - length, top, right, bottom, null, flags);
8064 }
8065 } else {
8066 scrollabilityCache.setFadeColor(solidColor);
8067 }
8068
8069 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07008070 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008071
8072 // Step 4, draw the children
8073 dispatchDraw(canvas);
8074
8075 // Step 5, draw the fade effect and restore layers
8076 final Paint p = scrollabilityCache.paint;
8077 final Matrix matrix = scrollabilityCache.matrix;
8078 final Shader fade = scrollabilityCache.shader;
8079 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
8080
8081 if (drawTop) {
8082 matrix.setScale(1, fadeHeight * topFadeStrength);
8083 matrix.postTranslate(left, top);
8084 fade.setLocalMatrix(matrix);
8085 canvas.drawRect(left, top, right, top + length, p);
8086 }
8087
8088 if (drawBottom) {
8089 matrix.setScale(1, fadeHeight * bottomFadeStrength);
8090 matrix.postRotate(180);
8091 matrix.postTranslate(left, bottom);
8092 fade.setLocalMatrix(matrix);
8093 canvas.drawRect(left, bottom - length, right, bottom, p);
8094 }
8095
8096 if (drawLeft) {
8097 matrix.setScale(1, fadeHeight * leftFadeStrength);
8098 matrix.postRotate(-90);
8099 matrix.postTranslate(left, top);
8100 fade.setLocalMatrix(matrix);
8101 canvas.drawRect(left, top, left + length, bottom, p);
8102 }
8103
8104 if (drawRight) {
8105 matrix.setScale(1, fadeHeight * rightFadeStrength);
8106 matrix.postRotate(90);
8107 matrix.postTranslate(right, top);
8108 fade.setLocalMatrix(matrix);
8109 canvas.drawRect(right - length, top, right, bottom, p);
8110 }
8111
8112 canvas.restoreToCount(saveCount);
8113
8114 // Step 6, draw decorations (scrollbars)
8115 onDrawScrollBars(canvas);
8116 }
8117
8118 /**
8119 * Override this if your view is known to always be drawn on top of a solid color background,
8120 * and needs to draw fading edges. Returning a non-zero color enables the view system to
8121 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
8122 * should be set to 0xFF.
8123 *
8124 * @see #setVerticalFadingEdgeEnabled
8125 * @see #setHorizontalFadingEdgeEnabled
8126 *
8127 * @return The known solid color background for this view, or 0 if the color may vary
8128 */
8129 public int getSolidColor() {
8130 return 0;
8131 }
8132
8133 /**
8134 * Build a human readable string representation of the specified view flags.
8135 *
8136 * @param flags the view flags to convert to a string
8137 * @return a String representing the supplied flags
8138 */
8139 private static String printFlags(int flags) {
8140 String output = "";
8141 int numFlags = 0;
8142 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
8143 output += "TAKES_FOCUS";
8144 numFlags++;
8145 }
8146
8147 switch (flags & VISIBILITY_MASK) {
8148 case INVISIBLE:
8149 if (numFlags > 0) {
8150 output += " ";
8151 }
8152 output += "INVISIBLE";
8153 // USELESS HERE numFlags++;
8154 break;
8155 case GONE:
8156 if (numFlags > 0) {
8157 output += " ";
8158 }
8159 output += "GONE";
8160 // USELESS HERE numFlags++;
8161 break;
8162 default:
8163 break;
8164 }
8165 return output;
8166 }
8167
8168 /**
8169 * Build a human readable string representation of the specified private
8170 * view flags.
8171 *
8172 * @param privateFlags the private view flags to convert to a string
8173 * @return a String representing the supplied flags
8174 */
8175 private static String printPrivateFlags(int privateFlags) {
8176 String output = "";
8177 int numFlags = 0;
8178
8179 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
8180 output += "WANTS_FOCUS";
8181 numFlags++;
8182 }
8183
8184 if ((privateFlags & FOCUSED) == FOCUSED) {
8185 if (numFlags > 0) {
8186 output += " ";
8187 }
8188 output += "FOCUSED";
8189 numFlags++;
8190 }
8191
8192 if ((privateFlags & SELECTED) == SELECTED) {
8193 if (numFlags > 0) {
8194 output += " ";
8195 }
8196 output += "SELECTED";
8197 numFlags++;
8198 }
8199
8200 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
8201 if (numFlags > 0) {
8202 output += " ";
8203 }
8204 output += "IS_ROOT_NAMESPACE";
8205 numFlags++;
8206 }
8207
8208 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
8209 if (numFlags > 0) {
8210 output += " ";
8211 }
8212 output += "HAS_BOUNDS";
8213 numFlags++;
8214 }
8215
8216 if ((privateFlags & DRAWN) == DRAWN) {
8217 if (numFlags > 0) {
8218 output += " ";
8219 }
8220 output += "DRAWN";
8221 // USELESS HERE numFlags++;
8222 }
8223 return output;
8224 }
8225
8226 /**
8227 * <p>Indicates whether or not this view's layout will be requested during
8228 * the next hierarchy layout pass.</p>
8229 *
8230 * @return true if the layout will be forced during next layout pass
8231 */
8232 public boolean isLayoutRequested() {
8233 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
8234 }
8235
8236 /**
8237 * Assign a size and position to a view and all of its
8238 * descendants
8239 *
8240 * <p>This is the second phase of the layout mechanism.
8241 * (The first is measuring). In this phase, each parent calls
8242 * layout on all of its children to position them.
8243 * This is typically done using the child measurements
8244 * that were stored in the measure pass().
8245 *
8246 * Derived classes with children should override
8247 * onLayout. In that method, they should
Chet Haase21cd1382010-09-01 17:42:29 -07008248 * call layout on each of their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008249 *
8250 * @param l Left position, relative to parent
8251 * @param t Top position, relative to parent
8252 * @param r Right position, relative to parent
8253 * @param b Bottom position, relative to parent
8254 */
Romain Guy5429e1d2010-09-07 12:38:00 -07008255 @SuppressWarnings({"unchecked"})
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008256 public final void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -07008257 int oldL = mLeft;
8258 int oldT = mTop;
8259 int oldB = mBottom;
8260 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008261 boolean changed = setFrame(l, t, r, b);
8262 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
8263 if (ViewDebug.TRACE_HIERARCHY) {
8264 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
8265 }
8266
8267 onLayout(changed, l, t, r, b);
8268 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -07008269
8270 if (mOnLayoutChangeListeners != null) {
8271 ArrayList<OnLayoutChangeListener> listenersCopy =
8272 (ArrayList<OnLayoutChangeListener>) mOnLayoutChangeListeners.clone();
8273 int numListeners = listenersCopy.size();
8274 for (int i = 0; i < numListeners; ++i) {
8275 listenersCopy.get(i).onLayoutChange(this, l, r, t, b, oldL, oldT, oldR, oldB);
8276 }
8277 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008278 }
8279 mPrivateFlags &= ~FORCE_LAYOUT;
8280 }
8281
8282 /**
8283 * Called from layout when this view should
8284 * assign a size and position to each of its children.
8285 *
8286 * Derived classes with children should override
8287 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -07008288 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008289 * @param changed This is a new size or position for this view
8290 * @param left Left position, relative to parent
8291 * @param top Top position, relative to parent
8292 * @param right Right position, relative to parent
8293 * @param bottom Bottom position, relative to parent
8294 */
8295 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
8296 }
8297
8298 /**
8299 * Assign a size and position to this view.
8300 *
8301 * This is called from layout.
8302 *
8303 * @param left Left position, relative to parent
8304 * @param top Top position, relative to parent
8305 * @param right Right position, relative to parent
8306 * @param bottom Bottom position, relative to parent
8307 * @return true if the new size and position are different than the
8308 * previous ones
8309 * {@hide}
8310 */
8311 protected boolean setFrame(int left, int top, int right, int bottom) {
8312 boolean changed = false;
8313
8314 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -07008315 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008316 + right + "," + bottom + ")");
8317 }
8318
8319 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
8320 changed = true;
8321
8322 // Remember our drawn bit
8323 int drawn = mPrivateFlags & DRAWN;
8324
8325 // Invalidate our old position
8326 invalidate();
8327
8328
8329 int oldWidth = mRight - mLeft;
8330 int oldHeight = mBottom - mTop;
8331
8332 mLeft = left;
8333 mTop = top;
8334 mRight = right;
8335 mBottom = bottom;
8336
8337 mPrivateFlags |= HAS_BOUNDS;
8338
8339 int newWidth = right - left;
8340 int newHeight = bottom - top;
8341
8342 if (newWidth != oldWidth || newHeight != oldHeight) {
8343 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
8344 }
8345
8346 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
8347 // If we are visible, force the DRAWN bit to on so that
8348 // this invalidate will go through (at least to our parent).
8349 // This is because someone may have invalidated this view
8350 // before this call to setFrame came in, therby clearing
8351 // the DRAWN bit.
8352 mPrivateFlags |= DRAWN;
8353 invalidate();
8354 }
8355
8356 // Reset drawn bit to original value (invalidate turns it off)
8357 mPrivateFlags |= drawn;
8358
8359 mBackgroundSizeChanged = true;
8360 }
8361 return changed;
8362 }
8363
8364 /**
8365 * Finalize inflating a view from XML. This is called as the last phase
8366 * of inflation, after all child views have been added.
8367 *
8368 * <p>Even if the subclass overrides onFinishInflate, they should always be
8369 * sure to call the super method, so that we get called.
8370 */
8371 protected void onFinishInflate() {
8372 }
8373
8374 /**
8375 * Returns the resources associated with this view.
8376 *
8377 * @return Resources object.
8378 */
8379 public Resources getResources() {
8380 return mResources;
8381 }
8382
8383 /**
8384 * Invalidates the specified Drawable.
8385 *
8386 * @param drawable the drawable to invalidate
8387 */
8388 public void invalidateDrawable(Drawable drawable) {
8389 if (verifyDrawable(drawable)) {
8390 final Rect dirty = drawable.getBounds();
8391 final int scrollX = mScrollX;
8392 final int scrollY = mScrollY;
8393
8394 invalidate(dirty.left + scrollX, dirty.top + scrollY,
8395 dirty.right + scrollX, dirty.bottom + scrollY);
8396 }
8397 }
8398
8399 /**
8400 * Schedules an action on a drawable to occur at a specified time.
8401 *
8402 * @param who the recipient of the action
8403 * @param what the action to run on the drawable
8404 * @param when the time at which the action must occur. Uses the
8405 * {@link SystemClock#uptimeMillis} timebase.
8406 */
8407 public void scheduleDrawable(Drawable who, Runnable what, long when) {
8408 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
8409 mAttachInfo.mHandler.postAtTime(what, who, when);
8410 }
8411 }
8412
8413 /**
8414 * Cancels a scheduled action on a drawable.
8415 *
8416 * @param who the recipient of the action
8417 * @param what the action to cancel
8418 */
8419 public void unscheduleDrawable(Drawable who, Runnable what) {
8420 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
8421 mAttachInfo.mHandler.removeCallbacks(what, who);
8422 }
8423 }
8424
8425 /**
8426 * Unschedule any events associated with the given Drawable. This can be
8427 * used when selecting a new Drawable into a view, so that the previous
8428 * one is completely unscheduled.
8429 *
8430 * @param who The Drawable to unschedule.
8431 *
8432 * @see #drawableStateChanged
8433 */
8434 public void unscheduleDrawable(Drawable who) {
8435 if (mAttachInfo != null) {
8436 mAttachInfo.mHandler.removeCallbacksAndMessages(who);
8437 }
8438 }
8439
8440 /**
8441 * If your view subclass is displaying its own Drawable objects, it should
8442 * override this function and return true for any Drawable it is
8443 * displaying. This allows animations for those drawables to be
8444 * scheduled.
8445 *
8446 * <p>Be sure to call through to the super class when overriding this
8447 * function.
8448 *
8449 * @param who The Drawable to verify. Return true if it is one you are
8450 * displaying, else return the result of calling through to the
8451 * super class.
8452 *
8453 * @return boolean If true than the Drawable is being displayed in the
8454 * view; else false and it is not allowed to animate.
8455 *
8456 * @see #unscheduleDrawable
8457 * @see #drawableStateChanged
8458 */
8459 protected boolean verifyDrawable(Drawable who) {
8460 return who == mBGDrawable;
8461 }
8462
8463 /**
8464 * This function is called whenever the state of the view changes in such
8465 * a way that it impacts the state of drawables being shown.
8466 *
8467 * <p>Be sure to call through to the superclass when overriding this
8468 * function.
8469 *
8470 * @see Drawable#setState
8471 */
8472 protected void drawableStateChanged() {
8473 Drawable d = mBGDrawable;
8474 if (d != null && d.isStateful()) {
8475 d.setState(getDrawableState());
8476 }
8477 }
8478
8479 /**
8480 * Call this to force a view to update its drawable state. This will cause
8481 * drawableStateChanged to be called on this view. Views that are interested
8482 * in the new state should call getDrawableState.
8483 *
8484 * @see #drawableStateChanged
8485 * @see #getDrawableState
8486 */
8487 public void refreshDrawableState() {
8488 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
8489 drawableStateChanged();
8490
8491 ViewParent parent = mParent;
8492 if (parent != null) {
8493 parent.childDrawableStateChanged(this);
8494 }
8495 }
8496
8497 /**
8498 * Return an array of resource IDs of the drawable states representing the
8499 * current state of the view.
8500 *
8501 * @return The current drawable state
8502 *
8503 * @see Drawable#setState
8504 * @see #drawableStateChanged
8505 * @see #onCreateDrawableState
8506 */
8507 public final int[] getDrawableState() {
8508 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
8509 return mDrawableState;
8510 } else {
8511 mDrawableState = onCreateDrawableState(0);
8512 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
8513 return mDrawableState;
8514 }
8515 }
8516
8517 /**
8518 * Generate the new {@link android.graphics.drawable.Drawable} state for
8519 * this view. This is called by the view
8520 * system when the cached Drawable state is determined to be invalid. To
8521 * retrieve the current state, you should use {@link #getDrawableState}.
8522 *
8523 * @param extraSpace if non-zero, this is the number of extra entries you
8524 * would like in the returned array in which you can place your own
8525 * states.
8526 *
8527 * @return Returns an array holding the current {@link Drawable} state of
8528 * the view.
8529 *
8530 * @see #mergeDrawableStates
8531 */
8532 protected int[] onCreateDrawableState(int extraSpace) {
8533 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
8534 mParent instanceof View) {
8535 return ((View) mParent).onCreateDrawableState(extraSpace);
8536 }
8537
8538 int[] drawableState;
8539
8540 int privateFlags = mPrivateFlags;
8541
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07008542 int viewStateIndex = 0;
8543 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
8544 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
8545 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -07008546 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07008547 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
8548 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008549
8550 drawableState = VIEW_STATE_SETS[viewStateIndex];
8551
8552 //noinspection ConstantIfStatement
8553 if (false) {
8554 Log.i("View", "drawableStateIndex=" + viewStateIndex);
8555 Log.i("View", toString()
8556 + " pressed=" + ((privateFlags & PRESSED) != 0)
8557 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
8558 + " fo=" + hasFocus()
8559 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07008560 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008561 + ": " + Arrays.toString(drawableState));
8562 }
8563
8564 if (extraSpace == 0) {
8565 return drawableState;
8566 }
8567
8568 final int[] fullState;
8569 if (drawableState != null) {
8570 fullState = new int[drawableState.length + extraSpace];
8571 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
8572 } else {
8573 fullState = new int[extraSpace];
8574 }
8575
8576 return fullState;
8577 }
8578
8579 /**
8580 * Merge your own state values in <var>additionalState</var> into the base
8581 * state values <var>baseState</var> that were returned by
8582 * {@link #onCreateDrawableState}.
8583 *
8584 * @param baseState The base state values returned by
8585 * {@link #onCreateDrawableState}, which will be modified to also hold your
8586 * own additional state values.
8587 *
8588 * @param additionalState The additional state values you would like
8589 * added to <var>baseState</var>; this array is not modified.
8590 *
8591 * @return As a convenience, the <var>baseState</var> array you originally
8592 * passed into the function is returned.
8593 *
8594 * @see #onCreateDrawableState
8595 */
8596 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
8597 final int N = baseState.length;
8598 int i = N - 1;
8599 while (i >= 0 && baseState[i] == 0) {
8600 i--;
8601 }
8602 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
8603 return baseState;
8604 }
8605
8606 /**
8607 * Sets the background color for this view.
8608 * @param color the color of the background
8609 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00008610 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008611 public void setBackgroundColor(int color) {
8612 setBackgroundDrawable(new ColorDrawable(color));
8613 }
8614
8615 /**
8616 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -07008617 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008618 * @param resid The identifier of the resource.
8619 * @attr ref android.R.styleable#View_background
8620 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00008621 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008622 public void setBackgroundResource(int resid) {
8623 if (resid != 0 && resid == mBackgroundResource) {
8624 return;
8625 }
8626
8627 Drawable d= null;
8628 if (resid != 0) {
8629 d = mResources.getDrawable(resid);
8630 }
8631 setBackgroundDrawable(d);
8632
8633 mBackgroundResource = resid;
8634 }
8635
8636 /**
8637 * Set the background to a given Drawable, or remove the background. If the
8638 * background has padding, this View's padding is set to the background's
8639 * padding. However, when a background is removed, this View's padding isn't
8640 * touched. If setting the padding is desired, please use
8641 * {@link #setPadding(int, int, int, int)}.
8642 *
8643 * @param d The Drawable to use as the background, or null to remove the
8644 * background
8645 */
8646 public void setBackgroundDrawable(Drawable d) {
8647 boolean requestLayout = false;
8648
8649 mBackgroundResource = 0;
8650
8651 /*
8652 * Regardless of whether we're setting a new background or not, we want
8653 * to clear the previous drawable.
8654 */
8655 if (mBGDrawable != null) {
8656 mBGDrawable.setCallback(null);
8657 unscheduleDrawable(mBGDrawable);
8658 }
8659
8660 if (d != null) {
8661 Rect padding = sThreadLocal.get();
8662 if (padding == null) {
8663 padding = new Rect();
8664 sThreadLocal.set(padding);
8665 }
8666 if (d.getPadding(padding)) {
8667 setPadding(padding.left, padding.top, padding.right, padding.bottom);
8668 }
8669
8670 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
8671 // if it has a different minimum size, we should layout again
8672 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() ||
8673 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) {
8674 requestLayout = true;
8675 }
8676
8677 d.setCallback(this);
8678 if (d.isStateful()) {
8679 d.setState(getDrawableState());
8680 }
8681 d.setVisible(getVisibility() == VISIBLE, false);
8682 mBGDrawable = d;
8683
8684 if ((mPrivateFlags & SKIP_DRAW) != 0) {
8685 mPrivateFlags &= ~SKIP_DRAW;
8686 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
8687 requestLayout = true;
8688 }
8689 } else {
8690 /* Remove the background */
8691 mBGDrawable = null;
8692
8693 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
8694 /*
8695 * This view ONLY drew the background before and we're removing
8696 * the background, so now it won't draw anything
8697 * (hence we SKIP_DRAW)
8698 */
8699 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
8700 mPrivateFlags |= SKIP_DRAW;
8701 }
8702
8703 /*
8704 * When the background is set, we try to apply its padding to this
8705 * View. When the background is removed, we don't touch this View's
8706 * padding. This is noted in the Javadocs. Hence, we don't need to
8707 * requestLayout(), the invalidate() below is sufficient.
8708 */
8709
8710 // The old background's minimum size could have affected this
8711 // View's layout, so let's requestLayout
8712 requestLayout = true;
8713 }
8714
Romain Guy8f1344f52009-05-15 16:03:59 -07008715 computeOpaqueFlags();
8716
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008717 if (requestLayout) {
8718 requestLayout();
8719 }
8720
8721 mBackgroundSizeChanged = true;
8722 invalidate();
8723 }
8724
8725 /**
8726 * Gets the background drawable
8727 * @return The drawable used as the background for this view, if any.
8728 */
8729 public Drawable getBackground() {
8730 return mBGDrawable;
8731 }
8732
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008733 /**
8734 * Sets the padding. The view may add on the space required to display
8735 * the scrollbars, depending on the style and visibility of the scrollbars.
8736 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
8737 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
8738 * from the values set in this call.
8739 *
8740 * @attr ref android.R.styleable#View_padding
8741 * @attr ref android.R.styleable#View_paddingBottom
8742 * @attr ref android.R.styleable#View_paddingLeft
8743 * @attr ref android.R.styleable#View_paddingRight
8744 * @attr ref android.R.styleable#View_paddingTop
8745 * @param left the left padding in pixels
8746 * @param top the top padding in pixels
8747 * @param right the right padding in pixels
8748 * @param bottom the bottom padding in pixels
8749 */
8750 public void setPadding(int left, int top, int right, int bottom) {
8751 boolean changed = false;
8752
8753 mUserPaddingRight = right;
8754 mUserPaddingBottom = bottom;
8755
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07008756 final int viewFlags = mViewFlags;
Romain Guy8506ab42009-06-11 17:35:47 -07008757
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07008758 // Common case is there are no scroll bars.
8759 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
8760 // TODO: Deal with RTL languages to adjust left padding instead of right.
8761 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
8762 right += (viewFlags & SCROLLBARS_INSET_MASK) == 0
8763 ? 0 : getVerticalScrollbarWidth();
8764 }
8765 if ((viewFlags & SCROLLBARS_HORIZONTAL) == 0) {
8766 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
8767 ? 0 : getHorizontalScrollbarHeight();
8768 }
8769 }
Romain Guy8506ab42009-06-11 17:35:47 -07008770
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07008771 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008772 changed = true;
8773 mPaddingLeft = left;
8774 }
8775 if (mPaddingTop != top) {
8776 changed = true;
8777 mPaddingTop = top;
8778 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07008779 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008780 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07008781 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008782 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07008783 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008784 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07008785 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008786 }
8787
8788 if (changed) {
8789 requestLayout();
8790 }
8791 }
8792
8793 /**
8794 * Returns the top padding of this view.
8795 *
8796 * @return the top padding in pixels
8797 */
8798 public int getPaddingTop() {
8799 return mPaddingTop;
8800 }
8801
8802 /**
8803 * Returns the bottom padding of this view. If there are inset and enabled
8804 * scrollbars, this value may include the space required to display the
8805 * scrollbars as well.
8806 *
8807 * @return the bottom padding in pixels
8808 */
8809 public int getPaddingBottom() {
8810 return mPaddingBottom;
8811 }
8812
8813 /**
8814 * Returns the left padding of this view. If there are inset and enabled
8815 * scrollbars, this value may include the space required to display the
8816 * scrollbars as well.
8817 *
8818 * @return the left padding in pixels
8819 */
8820 public int getPaddingLeft() {
8821 return mPaddingLeft;
8822 }
8823
8824 /**
8825 * Returns the right padding of this view. If there are inset and enabled
8826 * scrollbars, this value may include the space required to display the
8827 * scrollbars as well.
8828 *
8829 * @return the right padding in pixels
8830 */
8831 public int getPaddingRight() {
8832 return mPaddingRight;
8833 }
8834
8835 /**
8836 * Changes the selection state of this view. A view can be selected or not.
8837 * Note that selection is not the same as focus. Views are typically
8838 * selected in the context of an AdapterView like ListView or GridView;
8839 * the selected view is the view that is highlighted.
8840 *
8841 * @param selected true if the view must be selected, false otherwise
8842 */
8843 public void setSelected(boolean selected) {
8844 if (((mPrivateFlags & SELECTED) != 0) != selected) {
8845 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -07008846 if (!selected) resetPressedState();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008847 invalidate();
8848 refreshDrawableState();
8849 dispatchSetSelected(selected);
8850 }
8851 }
8852
8853 /**
8854 * Dispatch setSelected to all of this View's children.
8855 *
8856 * @see #setSelected(boolean)
8857 *
8858 * @param selected The new selected state
8859 */
8860 protected void dispatchSetSelected(boolean selected) {
8861 }
8862
8863 /**
8864 * Indicates the selection state of this view.
8865 *
8866 * @return true if the view is selected, false otherwise
8867 */
8868 @ViewDebug.ExportedProperty
8869 public boolean isSelected() {
8870 return (mPrivateFlags & SELECTED) != 0;
8871 }
8872
8873 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07008874 * Changes the activated state of this view. A view can be activated or not.
8875 * Note that activation is not the same as selection. Selection is
8876 * a transient property, representing the view (hierarchy) the user is
8877 * currently interacting with. Activation is a longer-term state that the
8878 * user can move views in and out of. For example, in a list view with
8879 * single or multiple selection enabled, the views in the current selection
8880 * set are activated. (Um, yeah, we are deeply sorry about the terminology
8881 * here.) The activated state is propagated down to children of the view it
8882 * is set on.
8883 *
8884 * @param activated true if the view must be activated, false otherwise
8885 */
8886 public void setActivated(boolean activated) {
8887 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
8888 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
8889 invalidate();
8890 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -07008891 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07008892 }
8893 }
8894
8895 /**
8896 * Dispatch setActivated to all of this View's children.
8897 *
8898 * @see #setActivated(boolean)
8899 *
8900 * @param activated The new activated state
8901 */
8902 protected void dispatchSetActivated(boolean activated) {
8903 }
8904
8905 /**
8906 * Indicates the activation state of this view.
8907 *
8908 * @return true if the view is activated, false otherwise
8909 */
8910 @ViewDebug.ExportedProperty
8911 public boolean isActivated() {
8912 return (mPrivateFlags & ACTIVATED) != 0;
8913 }
8914
8915 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008916 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
8917 * observer can be used to get notifications when global events, like
8918 * layout, happen.
8919 *
8920 * The returned ViewTreeObserver observer is not guaranteed to remain
8921 * valid for the lifetime of this View. If the caller of this method keeps
8922 * a long-lived reference to ViewTreeObserver, it should always check for
8923 * the return value of {@link ViewTreeObserver#isAlive()}.
8924 *
8925 * @return The ViewTreeObserver for this view's hierarchy.
8926 */
8927 public ViewTreeObserver getViewTreeObserver() {
8928 if (mAttachInfo != null) {
8929 return mAttachInfo.mTreeObserver;
8930 }
8931 if (mFloatingTreeObserver == null) {
8932 mFloatingTreeObserver = new ViewTreeObserver();
8933 }
8934 return mFloatingTreeObserver;
8935 }
8936
8937 /**
8938 * <p>Finds the topmost view in the current view hierarchy.</p>
8939 *
8940 * @return the topmost view containing this view
8941 */
8942 public View getRootView() {
8943 if (mAttachInfo != null) {
8944 final View v = mAttachInfo.mRootView;
8945 if (v != null) {
8946 return v;
8947 }
8948 }
Romain Guy8506ab42009-06-11 17:35:47 -07008949
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008950 View parent = this;
8951
8952 while (parent.mParent != null && parent.mParent instanceof View) {
8953 parent = (View) parent.mParent;
8954 }
8955
8956 return parent;
8957 }
8958
8959 /**
8960 * <p>Computes the coordinates of this view on the screen. The argument
8961 * must be an array of two integers. After the method returns, the array
8962 * contains the x and y location in that order.</p>
8963 *
8964 * @param location an array of two integers in which to hold the coordinates
8965 */
8966 public void getLocationOnScreen(int[] location) {
8967 getLocationInWindow(location);
8968
8969 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -07008970 if (info != null) {
8971 location[0] += info.mWindowLeft;
8972 location[1] += info.mWindowTop;
8973 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008974 }
8975
8976 /**
8977 * <p>Computes the coordinates of this view in its window. The argument
8978 * must be an array of two integers. After the method returns, the array
8979 * contains the x and y location in that order.</p>
8980 *
8981 * @param location an array of two integers in which to hold the coordinates
8982 */
8983 public void getLocationInWindow(int[] location) {
8984 if (location == null || location.length < 2) {
8985 throw new IllegalArgumentException("location must be an array of "
8986 + "two integers");
8987 }
8988
8989 location[0] = mLeft;
8990 location[1] = mTop;
8991
8992 ViewParent viewParent = mParent;
8993 while (viewParent instanceof View) {
8994 final View view = (View)viewParent;
8995 location[0] += view.mLeft - view.mScrollX;
8996 location[1] += view.mTop - view.mScrollY;
8997 viewParent = view.mParent;
8998 }
Romain Guy8506ab42009-06-11 17:35:47 -07008999
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009000 if (viewParent instanceof ViewRoot) {
9001 // *cough*
9002 final ViewRoot vr = (ViewRoot)viewParent;
9003 location[1] -= vr.mCurScrollY;
9004 }
9005 }
9006
9007 /**
9008 * {@hide}
9009 * @param id the id of the view to be found
9010 * @return the view of the specified id, null if cannot be found
9011 */
9012 protected View findViewTraversal(int id) {
9013 if (id == mID) {
9014 return this;
9015 }
9016 return null;
9017 }
9018
9019 /**
9020 * {@hide}
9021 * @param tag the tag of the view to be found
9022 * @return the view of specified tag, null if cannot be found
9023 */
9024 protected View findViewWithTagTraversal(Object tag) {
9025 if (tag != null && tag.equals(mTag)) {
9026 return this;
9027 }
9028 return null;
9029 }
9030
9031 /**
9032 * Look for a child view with the given id. If this view has the given
9033 * id, return this view.
9034 *
9035 * @param id The id to search for.
9036 * @return The view that has the given id in the hierarchy or null
9037 */
9038 public final View findViewById(int id) {
9039 if (id < 0) {
9040 return null;
9041 }
9042 return findViewTraversal(id);
9043 }
9044
9045 /**
9046 * Look for a child view with the given tag. If this view has the given
9047 * tag, return this view.
9048 *
9049 * @param tag The tag to search for, using "tag.equals(getTag())".
9050 * @return The View that has the given tag in the hierarchy or null
9051 */
9052 public final View findViewWithTag(Object tag) {
9053 if (tag == null) {
9054 return null;
9055 }
9056 return findViewWithTagTraversal(tag);
9057 }
9058
9059 /**
9060 * Sets the identifier for this view. The identifier does not have to be
9061 * unique in this view's hierarchy. The identifier should be a positive
9062 * number.
9063 *
9064 * @see #NO_ID
9065 * @see #getId
9066 * @see #findViewById
9067 *
9068 * @param id a number used to identify the view
9069 *
9070 * @attr ref android.R.styleable#View_id
9071 */
9072 public void setId(int id) {
9073 mID = id;
9074 }
9075
9076 /**
9077 * {@hide}
9078 *
9079 * @param isRoot true if the view belongs to the root namespace, false
9080 * otherwise
9081 */
9082 public void setIsRootNamespace(boolean isRoot) {
9083 if (isRoot) {
9084 mPrivateFlags |= IS_ROOT_NAMESPACE;
9085 } else {
9086 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
9087 }
9088 }
9089
9090 /**
9091 * {@hide}
9092 *
9093 * @return true if the view belongs to the root namespace, false otherwise
9094 */
9095 public boolean isRootNamespace() {
9096 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
9097 }
9098
9099 /**
9100 * Returns this view's identifier.
9101 *
9102 * @return a positive integer used to identify the view or {@link #NO_ID}
9103 * if the view has no ID
9104 *
9105 * @see #setId
9106 * @see #findViewById
9107 * @attr ref android.R.styleable#View_id
9108 */
9109 @ViewDebug.CapturedViewProperty
9110 public int getId() {
9111 return mID;
9112 }
9113
9114 /**
9115 * Returns this view's tag.
9116 *
9117 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -07009118 *
9119 * @see #setTag(Object)
9120 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009121 */
9122 @ViewDebug.ExportedProperty
9123 public Object getTag() {
9124 return mTag;
9125 }
9126
9127 /**
9128 * Sets the tag associated with this view. A tag can be used to mark
9129 * a view in its hierarchy and does not have to be unique within the
9130 * hierarchy. Tags can also be used to store data within a view without
9131 * resorting to another data structure.
9132 *
9133 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -07009134 *
9135 * @see #getTag()
9136 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009137 */
9138 public void setTag(final Object tag) {
9139 mTag = tag;
9140 }
9141
9142 /**
Romain Guyd90a3312009-05-06 14:54:28 -07009143 * Returns the tag associated with this view and the specified key.
9144 *
9145 * @param key The key identifying the tag
9146 *
9147 * @return the Object stored in this view as a tag
9148 *
9149 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -07009150 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -07009151 */
9152 public Object getTag(int key) {
9153 SparseArray<Object> tags = null;
9154 synchronized (sTagsLock) {
9155 if (sTags != null) {
9156 tags = sTags.get(this);
9157 }
9158 }
9159
9160 if (tags != null) return tags.get(key);
9161 return null;
9162 }
9163
9164 /**
9165 * Sets a tag associated with this view and a key. A tag can be used
9166 * to mark a view in its hierarchy and does not have to be unique within
9167 * the hierarchy. Tags can also be used to store data within a view
9168 * without resorting to another data structure.
9169 *
9170 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -07009171 * application to ensure it is unique (see the <a
9172 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
9173 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -07009174 * the Android framework or not associated with any package will cause
9175 * an {@link IllegalArgumentException} to be thrown.
9176 *
9177 * @param key The key identifying the tag
9178 * @param tag An Object to tag the view with
9179 *
9180 * @throws IllegalArgumentException If they specified key is not valid
9181 *
9182 * @see #setTag(Object)
9183 * @see #getTag(int)
9184 */
9185 public void setTag(int key, final Object tag) {
9186 // If the package id is 0x00 or 0x01, it's either an undefined package
9187 // or a framework id
9188 if ((key >>> 24) < 2) {
9189 throw new IllegalArgumentException("The key must be an application-specific "
9190 + "resource id.");
9191 }
9192
9193 setTagInternal(this, key, tag);
9194 }
9195
9196 /**
9197 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
9198 * framework id.
9199 *
9200 * @hide
9201 */
9202 public void setTagInternal(int key, Object tag) {
9203 if ((key >>> 24) != 0x1) {
9204 throw new IllegalArgumentException("The key must be a framework-specific "
9205 + "resource id.");
9206 }
9207
Romain Guy8506ab42009-06-11 17:35:47 -07009208 setTagInternal(this, key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -07009209 }
9210
9211 private static void setTagInternal(View view, int key, Object tag) {
9212 SparseArray<Object> tags = null;
9213 synchronized (sTagsLock) {
9214 if (sTags == null) {
9215 sTags = new WeakHashMap<View, SparseArray<Object>>();
9216 } else {
9217 tags = sTags.get(view);
9218 }
9219 }
9220
9221 if (tags == null) {
9222 tags = new SparseArray<Object>(2);
9223 synchronized (sTagsLock) {
9224 sTags.put(view, tags);
9225 }
9226 }
9227
9228 tags.put(key, tag);
9229 }
9230
9231 /**
Romain Guy13922e02009-05-12 17:56:14 -07009232 * @param consistency The type of consistency. See ViewDebug for more information.
9233 *
9234 * @hide
9235 */
9236 protected boolean dispatchConsistencyCheck(int consistency) {
9237 return onConsistencyCheck(consistency);
9238 }
9239
9240 /**
9241 * Method that subclasses should implement to check their consistency. The type of
9242 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -07009243 *
Romain Guy13922e02009-05-12 17:56:14 -07009244 * @param consistency The type of consistency. See ViewDebug for more information.
9245 *
9246 * @throws IllegalStateException if the view is in an inconsistent state.
9247 *
9248 * @hide
9249 */
9250 protected boolean onConsistencyCheck(int consistency) {
9251 boolean result = true;
9252
9253 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
9254 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
9255
9256 if (checkLayout) {
9257 if (getParent() == null) {
9258 result = false;
9259 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
9260 "View " + this + " does not have a parent.");
9261 }
9262
9263 if (mAttachInfo == null) {
9264 result = false;
9265 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
9266 "View " + this + " is not attached to a window.");
9267 }
9268 }
9269
9270 if (checkDrawing) {
9271 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
9272 // from their draw() method
9273
9274 if ((mPrivateFlags & DRAWN) != DRAWN &&
9275 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
9276 result = false;
9277 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
9278 "View " + this + " was invalidated but its drawing cache is valid.");
9279 }
9280 }
9281
9282 return result;
9283 }
9284
9285 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009286 * Prints information about this view in the log output, with the tag
9287 * {@link #VIEW_LOG_TAG}.
9288 *
9289 * @hide
9290 */
9291 public void debug() {
9292 debug(0);
9293 }
9294
9295 /**
9296 * Prints information about this view in the log output, with the tag
9297 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
9298 * indentation defined by the <code>depth</code>.
9299 *
9300 * @param depth the indentation level
9301 *
9302 * @hide
9303 */
9304 protected void debug(int depth) {
9305 String output = debugIndent(depth - 1);
9306
9307 output += "+ " + this;
9308 int id = getId();
9309 if (id != -1) {
9310 output += " (id=" + id + ")";
9311 }
9312 Object tag = getTag();
9313 if (tag != null) {
9314 output += " (tag=" + tag + ")";
9315 }
9316 Log.d(VIEW_LOG_TAG, output);
9317
9318 if ((mPrivateFlags & FOCUSED) != 0) {
9319 output = debugIndent(depth) + " FOCUSED";
9320 Log.d(VIEW_LOG_TAG, output);
9321 }
9322
9323 output = debugIndent(depth);
9324 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
9325 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
9326 + "} ";
9327 Log.d(VIEW_LOG_TAG, output);
9328
9329 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
9330 || mPaddingBottom != 0) {
9331 output = debugIndent(depth);
9332 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
9333 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
9334 Log.d(VIEW_LOG_TAG, output);
9335 }
9336
9337 output = debugIndent(depth);
9338 output += "mMeasureWidth=" + mMeasuredWidth +
9339 " mMeasureHeight=" + mMeasuredHeight;
9340 Log.d(VIEW_LOG_TAG, output);
9341
9342 output = debugIndent(depth);
9343 if (mLayoutParams == null) {
9344 output += "BAD! no layout params";
9345 } else {
9346 output = mLayoutParams.debug(output);
9347 }
9348 Log.d(VIEW_LOG_TAG, output);
9349
9350 output = debugIndent(depth);
9351 output += "flags={";
9352 output += View.printFlags(mViewFlags);
9353 output += "}";
9354 Log.d(VIEW_LOG_TAG, output);
9355
9356 output = debugIndent(depth);
9357 output += "privateFlags={";
9358 output += View.printPrivateFlags(mPrivateFlags);
9359 output += "}";
9360 Log.d(VIEW_LOG_TAG, output);
9361 }
9362
9363 /**
9364 * Creates an string of whitespaces used for indentation.
9365 *
9366 * @param depth the indentation level
9367 * @return a String containing (depth * 2 + 3) * 2 white spaces
9368 *
9369 * @hide
9370 */
9371 protected static String debugIndent(int depth) {
9372 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
9373 for (int i = 0; i < (depth * 2) + 3; i++) {
9374 spaces.append(' ').append(' ');
9375 }
9376 return spaces.toString();
9377 }
9378
9379 /**
9380 * <p>Return the offset of the widget's text baseline from the widget's top
9381 * boundary. If this widget does not support baseline alignment, this
9382 * method returns -1. </p>
9383 *
9384 * @return the offset of the baseline within the widget's bounds or -1
9385 * if baseline alignment is not supported
9386 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07009387 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009388 public int getBaseline() {
9389 return -1;
9390 }
9391
9392 /**
9393 * Call this when something has changed which has invalidated the
9394 * layout of this view. This will schedule a layout pass of the view
9395 * tree.
9396 */
9397 public void requestLayout() {
9398 if (ViewDebug.TRACE_HIERARCHY) {
9399 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
9400 }
9401
9402 mPrivateFlags |= FORCE_LAYOUT;
9403
9404 if (mParent != null && !mParent.isLayoutRequested()) {
9405 mParent.requestLayout();
9406 }
9407 }
9408
9409 /**
9410 * Forces this view to be laid out during the next layout pass.
9411 * This method does not call requestLayout() or forceLayout()
9412 * on the parent.
9413 */
9414 public void forceLayout() {
9415 mPrivateFlags |= FORCE_LAYOUT;
9416 }
9417
9418 /**
9419 * <p>
9420 * This is called to find out how big a view should be. The parent
9421 * supplies constraint information in the width and height parameters.
9422 * </p>
9423 *
9424 * <p>
9425 * The actual mesurement work of a view is performed in
9426 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
9427 * {@link #onMeasure(int, int)} can and must be overriden by subclasses.
9428 * </p>
9429 *
9430 *
9431 * @param widthMeasureSpec Horizontal space requirements as imposed by the
9432 * parent
9433 * @param heightMeasureSpec Vertical space requirements as imposed by the
9434 * parent
9435 *
9436 * @see #onMeasure(int, int)
9437 */
9438 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
9439 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
9440 widthMeasureSpec != mOldWidthMeasureSpec ||
9441 heightMeasureSpec != mOldHeightMeasureSpec) {
9442
9443 // first clears the measured dimension flag
9444 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
9445
9446 if (ViewDebug.TRACE_HIERARCHY) {
9447 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
9448 }
9449
9450 // measure ourselves, this should set the measured dimension flag back
9451 onMeasure(widthMeasureSpec, heightMeasureSpec);
9452
9453 // flag not set, setMeasuredDimension() was not invoked, we raise
9454 // an exception to warn the developer
9455 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
9456 throw new IllegalStateException("onMeasure() did not set the"
9457 + " measured dimension by calling"
9458 + " setMeasuredDimension()");
9459 }
9460
9461 mPrivateFlags |= LAYOUT_REQUIRED;
9462 }
9463
9464 mOldWidthMeasureSpec = widthMeasureSpec;
9465 mOldHeightMeasureSpec = heightMeasureSpec;
9466 }
9467
9468 /**
9469 * <p>
9470 * Measure the view and its content to determine the measured width and the
9471 * measured height. This method is invoked by {@link #measure(int, int)} and
9472 * should be overriden by subclasses to provide accurate and efficient
9473 * measurement of their contents.
9474 * </p>
9475 *
9476 * <p>
9477 * <strong>CONTRACT:</strong> When overriding this method, you
9478 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
9479 * measured width and height of this view. Failure to do so will trigger an
9480 * <code>IllegalStateException</code>, thrown by
9481 * {@link #measure(int, int)}. Calling the superclass'
9482 * {@link #onMeasure(int, int)} is a valid use.
9483 * </p>
9484 *
9485 * <p>
9486 * The base class implementation of measure defaults to the background size,
9487 * unless a larger size is allowed by the MeasureSpec. Subclasses should
9488 * override {@link #onMeasure(int, int)} to provide better measurements of
9489 * their content.
9490 * </p>
9491 *
9492 * <p>
9493 * If this method is overridden, it is the subclass's responsibility to make
9494 * sure the measured height and width are at least the view's minimum height
9495 * and width ({@link #getSuggestedMinimumHeight()} and
9496 * {@link #getSuggestedMinimumWidth()}).
9497 * </p>
9498 *
9499 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
9500 * The requirements are encoded with
9501 * {@link android.view.View.MeasureSpec}.
9502 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
9503 * The requirements are encoded with
9504 * {@link android.view.View.MeasureSpec}.
9505 *
9506 * @see #getMeasuredWidth()
9507 * @see #getMeasuredHeight()
9508 * @see #setMeasuredDimension(int, int)
9509 * @see #getSuggestedMinimumHeight()
9510 * @see #getSuggestedMinimumWidth()
9511 * @see android.view.View.MeasureSpec#getMode(int)
9512 * @see android.view.View.MeasureSpec#getSize(int)
9513 */
9514 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
9515 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
9516 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
9517 }
9518
9519 /**
9520 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
9521 * measured width and measured height. Failing to do so will trigger an
9522 * exception at measurement time.</p>
9523 *
9524 * @param measuredWidth the measured width of this view
9525 * @param measuredHeight the measured height of this view
9526 */
9527 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
9528 mMeasuredWidth = measuredWidth;
9529 mMeasuredHeight = measuredHeight;
9530
9531 mPrivateFlags |= MEASURED_DIMENSION_SET;
9532 }
9533
9534 /**
9535 * Utility to reconcile a desired size with constraints imposed by a MeasureSpec.
9536 * Will take the desired size, unless a different size is imposed by the constraints.
9537 *
9538 * @param size How big the view wants to be
9539 * @param measureSpec Constraints imposed by the parent
9540 * @return The size this view should be.
9541 */
9542 public static int resolveSize(int size, int measureSpec) {
9543 int result = size;
9544 int specMode = MeasureSpec.getMode(measureSpec);
9545 int specSize = MeasureSpec.getSize(measureSpec);
9546 switch (specMode) {
9547 case MeasureSpec.UNSPECIFIED:
9548 result = size;
9549 break;
9550 case MeasureSpec.AT_MOST:
9551 result = Math.min(size, specSize);
9552 break;
9553 case MeasureSpec.EXACTLY:
9554 result = specSize;
9555 break;
9556 }
9557 return result;
9558 }
9559
9560 /**
9561 * Utility to return a default size. Uses the supplied size if the
9562 * MeasureSpec imposed no contraints. Will get larger if allowed
9563 * by the MeasureSpec.
9564 *
9565 * @param size Default size for this view
9566 * @param measureSpec Constraints imposed by the parent
9567 * @return The size this view should be.
9568 */
9569 public static int getDefaultSize(int size, int measureSpec) {
9570 int result = size;
9571 int specMode = MeasureSpec.getMode(measureSpec);
9572 int specSize = MeasureSpec.getSize(measureSpec);
9573
9574 switch (specMode) {
9575 case MeasureSpec.UNSPECIFIED:
9576 result = size;
9577 break;
9578 case MeasureSpec.AT_MOST:
9579 case MeasureSpec.EXACTLY:
9580 result = specSize;
9581 break;
9582 }
9583 return result;
9584 }
9585
9586 /**
9587 * Returns the suggested minimum height that the view should use. This
9588 * returns the maximum of the view's minimum height
9589 * and the background's minimum height
9590 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
9591 * <p>
9592 * When being used in {@link #onMeasure(int, int)}, the caller should still
9593 * ensure the returned height is within the requirements of the parent.
9594 *
9595 * @return The suggested minimum height of the view.
9596 */
9597 protected int getSuggestedMinimumHeight() {
9598 int suggestedMinHeight = mMinHeight;
9599
9600 if (mBGDrawable != null) {
9601 final int bgMinHeight = mBGDrawable.getMinimumHeight();
9602 if (suggestedMinHeight < bgMinHeight) {
9603 suggestedMinHeight = bgMinHeight;
9604 }
9605 }
9606
9607 return suggestedMinHeight;
9608 }
9609
9610 /**
9611 * Returns the suggested minimum width that the view should use. This
9612 * returns the maximum of the view's minimum width)
9613 * and the background's minimum width
9614 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
9615 * <p>
9616 * When being used in {@link #onMeasure(int, int)}, the caller should still
9617 * ensure the returned width is within the requirements of the parent.
9618 *
9619 * @return The suggested minimum width of the view.
9620 */
9621 protected int getSuggestedMinimumWidth() {
9622 int suggestedMinWidth = mMinWidth;
9623
9624 if (mBGDrawable != null) {
9625 final int bgMinWidth = mBGDrawable.getMinimumWidth();
9626 if (suggestedMinWidth < bgMinWidth) {
9627 suggestedMinWidth = bgMinWidth;
9628 }
9629 }
9630
9631 return suggestedMinWidth;
9632 }
9633
9634 /**
9635 * Sets the minimum height of the view. It is not guaranteed the view will
9636 * be able to achieve this minimum height (for example, if its parent layout
9637 * constrains it with less available height).
9638 *
9639 * @param minHeight The minimum height the view will try to be.
9640 */
9641 public void setMinimumHeight(int minHeight) {
9642 mMinHeight = minHeight;
9643 }
9644
9645 /**
9646 * Sets the minimum width of the view. It is not guaranteed the view will
9647 * be able to achieve this minimum width (for example, if its parent layout
9648 * constrains it with less available width).
9649 *
9650 * @param minWidth The minimum width the view will try to be.
9651 */
9652 public void setMinimumWidth(int minWidth) {
9653 mMinWidth = minWidth;
9654 }
9655
9656 /**
9657 * Get the animation currently associated with this view.
9658 *
9659 * @return The animation that is currently playing or
9660 * scheduled to play for this view.
9661 */
9662 public Animation getAnimation() {
9663 return mCurrentAnimation;
9664 }
9665
9666 /**
9667 * Start the specified animation now.
9668 *
9669 * @param animation the animation to start now
9670 */
9671 public void startAnimation(Animation animation) {
9672 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
9673 setAnimation(animation);
9674 invalidate();
9675 }
9676
9677 /**
9678 * Cancels any animations for this view.
9679 */
9680 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -08009681 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -08009682 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -08009683 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009684 mCurrentAnimation = null;
9685 }
9686
9687 /**
9688 * Sets the next animation to play for this view.
9689 * If you want the animation to play immediately, use
9690 * startAnimation. This method provides allows fine-grained
9691 * control over the start time and invalidation, but you
9692 * must make sure that 1) the animation has a start time set, and
9693 * 2) the view will be invalidated when the animation is supposed to
9694 * start.
9695 *
9696 * @param animation The next animation, or null.
9697 */
9698 public void setAnimation(Animation animation) {
9699 mCurrentAnimation = animation;
9700 if (animation != null) {
9701 animation.reset();
9702 }
9703 }
9704
9705 /**
9706 * Invoked by a parent ViewGroup to notify the start of the animation
9707 * currently associated with this view. If you override this method,
9708 * always call super.onAnimationStart();
9709 *
9710 * @see #setAnimation(android.view.animation.Animation)
9711 * @see #getAnimation()
9712 */
9713 protected void onAnimationStart() {
9714 mPrivateFlags |= ANIMATION_STARTED;
9715 }
9716
9717 /**
9718 * Invoked by a parent ViewGroup to notify the end of the animation
9719 * currently associated with this view. If you override this method,
9720 * always call super.onAnimationEnd();
9721 *
9722 * @see #setAnimation(android.view.animation.Animation)
9723 * @see #getAnimation()
9724 */
9725 protected void onAnimationEnd() {
9726 mPrivateFlags &= ~ANIMATION_STARTED;
9727 }
9728
9729 /**
9730 * Invoked if there is a Transform that involves alpha. Subclass that can
9731 * draw themselves with the specified alpha should return true, and then
9732 * respect that alpha when their onDraw() is called. If this returns false
9733 * then the view may be redirected to draw into an offscreen buffer to
9734 * fulfill the request, which will look fine, but may be slower than if the
9735 * subclass handles it internally. The default implementation returns false.
9736 *
9737 * @param alpha The alpha (0..255) to apply to the view's drawing
9738 * @return true if the view can draw with the specified alpha.
9739 */
9740 protected boolean onSetAlpha(int alpha) {
9741 return false;
9742 }
9743
9744 /**
9745 * This is used by the RootView to perform an optimization when
9746 * the view hierarchy contains one or several SurfaceView.
9747 * SurfaceView is always considered transparent, but its children are not,
9748 * therefore all View objects remove themselves from the global transparent
9749 * region (passed as a parameter to this function).
9750 *
9751 * @param region The transparent region for this ViewRoot (window).
9752 *
9753 * @return Returns true if the effective visibility of the view at this
9754 * point is opaque, regardless of the transparent region; returns false
9755 * if it is possible for underlying windows to be seen behind the view.
9756 *
9757 * {@hide}
9758 */
9759 public boolean gatherTransparentRegion(Region region) {
9760 final AttachInfo attachInfo = mAttachInfo;
9761 if (region != null && attachInfo != null) {
9762 final int pflags = mPrivateFlags;
9763 if ((pflags & SKIP_DRAW) == 0) {
9764 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
9765 // remove it from the transparent region.
9766 final int[] location = attachInfo.mTransparentLocation;
9767 getLocationInWindow(location);
9768 region.op(location[0], location[1], location[0] + mRight - mLeft,
9769 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
9770 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) {
9771 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
9772 // exists, so we remove the background drawable's non-transparent
9773 // parts from this transparent region.
9774 applyDrawableToTransparentRegion(mBGDrawable, region);
9775 }
9776 }
9777 return true;
9778 }
9779
9780 /**
9781 * Play a sound effect for this view.
9782 *
9783 * <p>The framework will play sound effects for some built in actions, such as
9784 * clicking, but you may wish to play these effects in your widget,
9785 * for instance, for internal navigation.
9786 *
9787 * <p>The sound effect will only be played if sound effects are enabled by the user, and
9788 * {@link #isSoundEffectsEnabled()} is true.
9789 *
9790 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
9791 */
9792 public void playSoundEffect(int soundConstant) {
9793 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
9794 return;
9795 }
9796 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
9797 }
9798
9799 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -07009800 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -07009801 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -07009802 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009803 *
9804 * <p>The framework will provide haptic feedback for some built in actions,
9805 * such as long presses, but you may wish to provide feedback for your
9806 * own widget.
9807 *
9808 * <p>The feedback will only be performed if
9809 * {@link #isHapticFeedbackEnabled()} is true.
9810 *
9811 * @param feedbackConstant One of the constants defined in
9812 * {@link HapticFeedbackConstants}
9813 */
9814 public boolean performHapticFeedback(int feedbackConstant) {
9815 return performHapticFeedback(feedbackConstant, 0);
9816 }
9817
9818 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -07009819 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -07009820 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -07009821 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009822 *
9823 * @param feedbackConstant One of the constants defined in
9824 * {@link HapticFeedbackConstants}
9825 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
9826 */
9827 public boolean performHapticFeedback(int feedbackConstant, int flags) {
9828 if (mAttachInfo == null) {
9829 return false;
9830 }
Romain Guyf607bdc2010-09-10 19:20:06 -07009831 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -07009832 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009833 && !isHapticFeedbackEnabled()) {
9834 return false;
9835 }
Romain Guy812ccbe2010-06-01 14:07:24 -07009836 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
9837 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009838 }
9839
9840 /**
Christopher Tate2c095f32010-10-04 14:13:40 -07009841 * !!! TODO: real docs
9842 *
9843 * The base class implementation makes the thumbnail the same size and appearance
9844 * as the view itself, and positions it with its center at the touch point.
9845 */
Christopher Tatea0374192010-10-05 13:06:41 -07009846 public static class DragThumbnailBuilder {
9847 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -07009848
9849 /**
9850 * Construct a thumbnail builder object for use with the given view.
9851 * @param view
9852 */
9853 public DragThumbnailBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -07009854 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -07009855 }
9856
9857 /**
9858 * Provide the draggable-thumbnail metrics for the operation: the dimensions of
9859 * the thumbnail image itself, and the point within that thumbnail that should
9860 * be centered under the touch location while dragging.
9861 * <p>
9862 * The default implementation sets the dimensions of the thumbnail to be the
9863 * same as the dimensions of the View itself and centers the thumbnail under
9864 * the touch point.
9865 *
9866 * @param thumbnailSize The application should set the {@code x} member of this
9867 * parameter to the desired thumbnail width, and the {@code y} member to
9868 * the desired height.
9869 * @param thumbnailTouchPoint The application should set this point to be the
9870 * location within the thumbnail that should track directly underneath
9871 * the touch point on the screen during a drag.
9872 */
9873 public void onProvideThumbnailMetrics(Point thumbnailSize, Point thumbnailTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -07009874 final View view = mView.get();
9875 if (view != null) {
9876 thumbnailSize.set(view.getWidth(), view.getHeight());
9877 thumbnailTouchPoint.set(thumbnailSize.x / 2, thumbnailSize.y / 2);
9878 } else {
9879 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
9880 }
Christopher Tate2c095f32010-10-04 14:13:40 -07009881 }
9882
9883 /**
9884 * Draw the thumbnail image for the upcoming drag. The thumbnail canvas was
9885 * created with the dimensions supplied by the onProvideThumbnailMetrics()
9886 * callback.
9887 *
9888 * @param canvas
9889 */
9890 public void onDrawThumbnail(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -07009891 final View view = mView.get();
9892 if (view != null) {
9893 view.draw(canvas);
9894 } else {
9895 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag thumb but no view");
9896 }
Christopher Tate2c095f32010-10-04 14:13:40 -07009897 }
9898 }
9899
9900 /**
Christopher Tate5ada6cb2010-10-05 14:15:29 -07009901 * Drag and drop. App calls startDrag(), then callbacks to the thumbnail builder's
9902 * onProvideThumbnailMetrics() and onDrawThumbnail() methods happen, then the drag
9903 * operation is handed over to the OS.
Christopher Tatea53146c2010-09-07 11:57:52 -07009904 * !!! TODO: real docs
Christopher Tatea53146c2010-09-07 11:57:52 -07009905 */
Christopher Tate2c095f32010-10-04 14:13:40 -07009906 public final boolean startDrag(ClipData data, DragThumbnailBuilder thumbBuilder,
9907 boolean myWindowOnly) {
9908 if (ViewDebug.DEBUG_DRAG) {
9909 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " local=" + myWindowOnly);
Christopher Tatea53146c2010-09-07 11:57:52 -07009910 }
9911 boolean okay = false;
9912
Christopher Tate2c095f32010-10-04 14:13:40 -07009913 Point thumbSize = new Point();
9914 Point thumbTouchPoint = new Point();
9915 thumbBuilder.onProvideThumbnailMetrics(thumbSize, thumbTouchPoint);
9916
9917 if ((thumbSize.x < 0) || (thumbSize.y < 0) ||
9918 (thumbTouchPoint.x < 0) || (thumbTouchPoint.y < 0)) {
9919 throw new IllegalStateException("Drag thumb dimensions must not be negative");
9920 }
Christopher Tatea53146c2010-09-07 11:57:52 -07009921
9922 Surface surface = new Surface();
9923 try {
9924 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
9925 myWindowOnly, mThumbnailWidth, mThumbnailHeight, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -07009926 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -07009927 + " surface=" + surface);
9928 if (token != null) {
9929 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -07009930 try {
Christopher Tate2c095f32010-10-04 14:13:40 -07009931 thumbBuilder.onDrawThumbnail(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -07009932 } finally {
9933 surface.unlockCanvasAndPost(canvas);
9934 }
Christopher Tatea53146c2010-09-07 11:57:52 -07009935
Christopher Tate2c095f32010-10-04 14:13:40 -07009936 // repurpose 'thumbSize' for the last touch point
9937 getViewRoot().getLastTouchPoint(thumbSize);
9938
Christopher Tatea53146c2010-09-07 11:57:52 -07009939 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate2c095f32010-10-04 14:13:40 -07009940 (float) thumbSize.x, (float) thumbSize.y,
9941 (float) thumbTouchPoint.x, (float) thumbTouchPoint.y, data);
9942 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tatea53146c2010-09-07 11:57:52 -07009943 }
9944 } catch (Exception e) {
9945 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
9946 surface.destroy();
9947 }
9948
9949 return okay;
9950 }
9951
9952 private void measureThumbnail() {
9953 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
9954
9955 onMeasureDragThumbnail();
9956
9957 // flag not set, setDragThumbnailDimension() was not invoked, we raise
9958 // an exception to warn the developer
9959 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
9960 throw new IllegalStateException("onMeasureDragThumbnail() did not set the"
9961 + " measured dimension by calling setDragThumbnailDimension()");
9962 }
9963
Christopher Tate2c095f32010-10-04 14:13:40 -07009964 if (ViewDebug.DEBUG_DRAG) {
Christopher Tatea53146c2010-09-07 11:57:52 -07009965 Log.d(VIEW_LOG_TAG, "Drag thumb measured: w=" + mThumbnailWidth
9966 + " h=" + mThumbnailHeight);
9967 }
9968 }
9969
9970 /**
9971 * The View must call this method from onMeasureDragThumbnail() in order to
9972 * specify the dimensions of the drag thumbnail image.
9973 *
Romain Guy0bb56672010-10-01 00:25:02 -07009974 * @param width The desired thumbnail width.
9975 * @param height The desired thumbnail height.
Christopher Tatea53146c2010-09-07 11:57:52 -07009976 */
9977 protected final void setDragThumbnailDimension(int width, int height) {
9978 mPrivateFlags |= MEASURED_DIMENSION_SET;
9979 mThumbnailWidth = width;
9980 mThumbnailHeight = height;
9981 }
9982
9983 /**
9984 * The default implementation specifies a drag thumbnail that matches the
9985 * View's current size and appearance.
9986 */
9987 protected void onMeasureDragThumbnail() {
9988 setDragThumbnailDimension(getWidth(), getHeight());
9989 }
9990
9991 /**
9992 * The default implementation just draws the current View appearance as the thumbnail
9993 * @param canvas
9994 */
9995 protected void onDrawDragThumbnail(Canvas canvas) {
9996 draw(canvas);
9997 }
9998
9999 /**
10000 * Drag-and-drop event dispatch. The event.getAction() verb is one of the DragEvent
10001 * constants DRAG_STARTED_EVENT, DRAG_EVENT, DROP_EVENT, and DRAG_ENDED_EVENT.
10002 *
10003 * For DRAG_STARTED_EVENT, event.getClipDescription() describes the content
10004 * being dragged. onDragEvent() should return 'true' if the view can handle
10005 * a drop of that content. A view that returns 'false' here will receive no
10006 * further calls to onDragEvent() about the drag/drop operation.
10007 *
10008 * For DRAG_ENTERED, event.getClipDescription() describes the content being
10009 * dragged. This will be the same content description passed in the
10010 * DRAG_STARTED_EVENT invocation.
10011 *
10012 * For DRAG_EXITED, event.getClipDescription() describes the content being
10013 * dragged. This will be the same content description passed in the
10014 * DRAG_STARTED_EVENT invocation. The view should return to its approriate
10015 * drag-acceptance visual state.
10016 *
10017 * For DRAG_LOCATION_EVENT, event.getX() and event.getY() give the location in View
10018 * coordinates of the current drag point. The view must return 'true' if it
10019 * can accept a drop of the current drag content, false otherwise.
10020 *
10021 * For DROP_EVENT, event.getX() and event.getY() give the location of the drop
10022 * within the view; also, event.getClipData() returns the full data payload
10023 * being dropped. The view should return 'true' if it consumed the dropped
10024 * content, 'false' if it did not.
10025 *
10026 * For DRAG_ENDED_EVENT, the 'event' argument may be null. The view should return
10027 * to its normal visual state.
10028 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070010029 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070010030 return false;
10031 }
10032
10033 /**
10034 * Views typically don't need to override dispatchDragEvent(); it just calls
10035 * onDragEvent(what, event) and passes the result up appropriately.
10036 *
10037 */
10038 public boolean dispatchDragEvent(DragEvent event) {
10039 return onDragEvent(event);
10040 }
10041
10042 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070010043 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
10044 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070010045 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070010046 */
10047 public void onCloseSystemDialogs(String reason) {
10048 }
10049
10050 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010051 * Given a Drawable whose bounds have been set to draw into this view,
10052 * update a Region being computed for {@link #gatherTransparentRegion} so
10053 * that any non-transparent parts of the Drawable are removed from the
10054 * given transparent region.
10055 *
10056 * @param dr The Drawable whose transparency is to be applied to the region.
10057 * @param region A Region holding the current transparency information,
10058 * where any parts of the region that are set are considered to be
10059 * transparent. On return, this region will be modified to have the
10060 * transparency information reduced by the corresponding parts of the
10061 * Drawable that are not transparent.
10062 * {@hide}
10063 */
10064 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
10065 if (DBG) {
10066 Log.i("View", "Getting transparent region for: " + this);
10067 }
10068 final Region r = dr.getTransparentRegion();
10069 final Rect db = dr.getBounds();
10070 final AttachInfo attachInfo = mAttachInfo;
10071 if (r != null && attachInfo != null) {
10072 final int w = getRight()-getLeft();
10073 final int h = getBottom()-getTop();
10074 if (db.left > 0) {
10075 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
10076 r.op(0, 0, db.left, h, Region.Op.UNION);
10077 }
10078 if (db.right < w) {
10079 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
10080 r.op(db.right, 0, w, h, Region.Op.UNION);
10081 }
10082 if (db.top > 0) {
10083 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
10084 r.op(0, 0, w, db.top, Region.Op.UNION);
10085 }
10086 if (db.bottom < h) {
10087 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
10088 r.op(0, db.bottom, w, h, Region.Op.UNION);
10089 }
10090 final int[] location = attachInfo.mTransparentLocation;
10091 getLocationInWindow(location);
10092 r.translate(location[0], location[1]);
10093 region.op(r, Region.Op.INTERSECT);
10094 } else {
10095 region.op(db, Region.Op.DIFFERENCE);
10096 }
10097 }
10098
Adam Powelle14579b2009-12-16 18:39:52 -080010099 private void postCheckForLongClick(int delayOffset) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010100 mHasPerformedLongPress = false;
10101
10102 if (mPendingCheckForLongPress == null) {
10103 mPendingCheckForLongPress = new CheckForLongPress();
10104 }
10105 mPendingCheckForLongPress.rememberWindowAttachCount();
Adam Powelle14579b2009-12-16 18:39:52 -080010106 postDelayed(mPendingCheckForLongPress,
10107 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010108 }
10109
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010110 /**
10111 * Inflate a view from an XML resource. This convenience method wraps the {@link
10112 * LayoutInflater} class, which provides a full range of options for view inflation.
10113 *
10114 * @param context The Context object for your activity or application.
10115 * @param resource The resource ID to inflate
10116 * @param root A view group that will be the parent. Used to properly inflate the
10117 * layout_* parameters.
10118 * @see LayoutInflater
10119 */
10120 public static View inflate(Context context, int resource, ViewGroup root) {
10121 LayoutInflater factory = LayoutInflater.from(context);
10122 return factory.inflate(resource, root);
10123 }
Romain Guy33e72ae2010-07-17 12:40:29 -070010124
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010125 /**
10126 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
10127 * Each MeasureSpec represents a requirement for either the width or the height.
10128 * A MeasureSpec is comprised of a size and a mode. There are three possible
10129 * modes:
10130 * <dl>
10131 * <dt>UNSPECIFIED</dt>
10132 * <dd>
10133 * The parent has not imposed any constraint on the child. It can be whatever size
10134 * it wants.
10135 * </dd>
10136 *
10137 * <dt>EXACTLY</dt>
10138 * <dd>
10139 * The parent has determined an exact size for the child. The child is going to be
10140 * given those bounds regardless of how big it wants to be.
10141 * </dd>
10142 *
10143 * <dt>AT_MOST</dt>
10144 * <dd>
10145 * The child can be as large as it wants up to the specified size.
10146 * </dd>
10147 * </dl>
10148 *
10149 * MeasureSpecs are implemented as ints to reduce object allocation. This class
10150 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
10151 */
10152 public static class MeasureSpec {
10153 private static final int MODE_SHIFT = 30;
10154 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
10155
10156 /**
10157 * Measure specification mode: The parent has not imposed any constraint
10158 * on the child. It can be whatever size it wants.
10159 */
10160 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
10161
10162 /**
10163 * Measure specification mode: The parent has determined an exact size
10164 * for the child. The child is going to be given those bounds regardless
10165 * of how big it wants to be.
10166 */
10167 public static final int EXACTLY = 1 << MODE_SHIFT;
10168
10169 /**
10170 * Measure specification mode: The child can be as large as it wants up
10171 * to the specified size.
10172 */
10173 public static final int AT_MOST = 2 << MODE_SHIFT;
10174
10175 /**
10176 * Creates a measure specification based on the supplied size and mode.
10177 *
10178 * The mode must always be one of the following:
10179 * <ul>
10180 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
10181 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
10182 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
10183 * </ul>
10184 *
10185 * @param size the size of the measure specification
10186 * @param mode the mode of the measure specification
10187 * @return the measure specification based on size and mode
10188 */
10189 public static int makeMeasureSpec(int size, int mode) {
10190 return size + mode;
10191 }
10192
10193 /**
10194 * Extracts the mode from the supplied measure specification.
10195 *
10196 * @param measureSpec the measure specification to extract the mode from
10197 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
10198 * {@link android.view.View.MeasureSpec#AT_MOST} or
10199 * {@link android.view.View.MeasureSpec#EXACTLY}
10200 */
10201 public static int getMode(int measureSpec) {
10202 return (measureSpec & MODE_MASK);
10203 }
10204
10205 /**
10206 * Extracts the size from the supplied measure specification.
10207 *
10208 * @param measureSpec the measure specification to extract the size from
10209 * @return the size in pixels defined in the supplied measure specification
10210 */
10211 public static int getSize(int measureSpec) {
10212 return (measureSpec & ~MODE_MASK);
10213 }
10214
10215 /**
10216 * Returns a String representation of the specified measure
10217 * specification.
10218 *
10219 * @param measureSpec the measure specification to convert to a String
10220 * @return a String with the following format: "MeasureSpec: MODE SIZE"
10221 */
10222 public static String toString(int measureSpec) {
10223 int mode = getMode(measureSpec);
10224 int size = getSize(measureSpec);
10225
10226 StringBuilder sb = new StringBuilder("MeasureSpec: ");
10227
10228 if (mode == UNSPECIFIED)
10229 sb.append("UNSPECIFIED ");
10230 else if (mode == EXACTLY)
10231 sb.append("EXACTLY ");
10232 else if (mode == AT_MOST)
10233 sb.append("AT_MOST ");
10234 else
10235 sb.append(mode).append(" ");
10236
10237 sb.append(size);
10238 return sb.toString();
10239 }
10240 }
10241
10242 class CheckForLongPress implements Runnable {
10243
10244 private int mOriginalWindowAttachCount;
10245
10246 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070010247 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010248 && mOriginalWindowAttachCount == mWindowAttachCount) {
10249 if (performLongClick()) {
10250 mHasPerformedLongPress = true;
10251 }
10252 }
10253 }
10254
10255 public void rememberWindowAttachCount() {
10256 mOriginalWindowAttachCount = mWindowAttachCount;
10257 }
10258 }
Adam Powelle14579b2009-12-16 18:39:52 -080010259
10260 private final class CheckForTap implements Runnable {
10261 public void run() {
10262 mPrivateFlags &= ~PREPRESSED;
10263 mPrivateFlags |= PRESSED;
10264 refreshDrawableState();
10265 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
10266 postCheckForLongClick(ViewConfiguration.getTapTimeout());
10267 }
10268 }
10269 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010270
Adam Powella35d7682010-03-12 14:48:13 -080010271 private final class PerformClick implements Runnable {
10272 public void run() {
10273 performClick();
10274 }
10275 }
10276
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010277 /**
10278 * Interface definition for a callback to be invoked when a key event is
10279 * dispatched to this view. The callback will be invoked before the key
10280 * event is given to the view.
10281 */
10282 public interface OnKeyListener {
10283 /**
10284 * Called when a key is dispatched to a view. This allows listeners to
10285 * get a chance to respond before the target view.
10286 *
10287 * @param v The view the key has been dispatched to.
10288 * @param keyCode The code for the physical key that was pressed
10289 * @param event The KeyEvent object containing full information about
10290 * the event.
10291 * @return True if the listener has consumed the event, false otherwise.
10292 */
10293 boolean onKey(View v, int keyCode, KeyEvent event);
10294 }
10295
10296 /**
10297 * Interface definition for a callback to be invoked when a touch event is
10298 * dispatched to this view. The callback will be invoked before the touch
10299 * event is given to the view.
10300 */
10301 public interface OnTouchListener {
10302 /**
10303 * Called when a touch event is dispatched to a view. This allows listeners to
10304 * get a chance to respond before the target view.
10305 *
10306 * @param v The view the touch event has been dispatched to.
10307 * @param event The MotionEvent object containing full information about
10308 * the event.
10309 * @return True if the listener has consumed the event, false otherwise.
10310 */
10311 boolean onTouch(View v, MotionEvent event);
10312 }
10313
10314 /**
10315 * Interface definition for a callback to be invoked when a view has been clicked and held.
10316 */
10317 public interface OnLongClickListener {
10318 /**
10319 * Called when a view has been clicked and held.
10320 *
10321 * @param v The view that was clicked and held.
10322 *
10323 * return True if the callback consumed the long click, false otherwise
10324 */
10325 boolean onLongClick(View v);
10326 }
10327
10328 /**
10329 * Interface definition for a callback to be invoked when the focus state of
10330 * a view changed.
10331 */
10332 public interface OnFocusChangeListener {
10333 /**
10334 * Called when the focus state of a view has changed.
10335 *
10336 * @param v The view whose state has changed.
10337 * @param hasFocus The new focus state of v.
10338 */
10339 void onFocusChange(View v, boolean hasFocus);
10340 }
10341
10342 /**
10343 * Interface definition for a callback to be invoked when a view is clicked.
10344 */
10345 public interface OnClickListener {
10346 /**
10347 * Called when a view has been clicked.
10348 *
10349 * @param v The view that was clicked.
10350 */
10351 void onClick(View v);
10352 }
10353
10354 /**
10355 * Interface definition for a callback to be invoked when the context menu
10356 * for this view is being built.
10357 */
10358 public interface OnCreateContextMenuListener {
10359 /**
10360 * Called when the context menu for this view is being built. It is not
10361 * safe to hold onto the menu after this method returns.
10362 *
10363 * @param menu The context menu that is being built
10364 * @param v The view for which the context menu is being built
10365 * @param menuInfo Extra information about the item for which the
10366 * context menu should be shown. This information will vary
10367 * depending on the class of v.
10368 */
10369 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
10370 }
10371
10372 private final class UnsetPressedState implements Runnable {
10373 public void run() {
10374 setPressed(false);
10375 }
10376 }
10377
10378 /**
10379 * Base class for derived classes that want to save and restore their own
10380 * state in {@link android.view.View#onSaveInstanceState()}.
10381 */
10382 public static class BaseSavedState extends AbsSavedState {
10383 /**
10384 * Constructor used when reading from a parcel. Reads the state of the superclass.
10385 *
10386 * @param source
10387 */
10388 public BaseSavedState(Parcel source) {
10389 super(source);
10390 }
10391
10392 /**
10393 * Constructor called by derived classes when creating their SavedState objects
10394 *
10395 * @param superState The state of the superclass of this view
10396 */
10397 public BaseSavedState(Parcelable superState) {
10398 super(superState);
10399 }
10400
10401 public static final Parcelable.Creator<BaseSavedState> CREATOR =
10402 new Parcelable.Creator<BaseSavedState>() {
10403 public BaseSavedState createFromParcel(Parcel in) {
10404 return new BaseSavedState(in);
10405 }
10406
10407 public BaseSavedState[] newArray(int size) {
10408 return new BaseSavedState[size];
10409 }
10410 };
10411 }
10412
10413 /**
10414 * A set of information given to a view when it is attached to its parent
10415 * window.
10416 */
10417 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010418 interface Callbacks {
10419 void playSoundEffect(int effectId);
10420 boolean performHapticFeedback(int effectId, boolean always);
10421 }
10422
10423 /**
10424 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
10425 * to a Handler. This class contains the target (View) to invalidate and
10426 * the coordinates of the dirty rectangle.
10427 *
10428 * For performance purposes, this class also implements a pool of up to
10429 * POOL_LIMIT objects that get reused. This reduces memory allocations
10430 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010431 */
Romain Guyd928d682009-03-31 17:52:16 -070010432 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010433 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070010434 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
10435 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070010436 public InvalidateInfo newInstance() {
10437 return new InvalidateInfo();
10438 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010439
Romain Guyd928d682009-03-31 17:52:16 -070010440 public void onAcquired(InvalidateInfo element) {
10441 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010442
Romain Guyd928d682009-03-31 17:52:16 -070010443 public void onReleased(InvalidateInfo element) {
10444 }
10445 }, POOL_LIMIT)
10446 );
10447
10448 private InvalidateInfo mNext;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010449
10450 View target;
10451
10452 int left;
10453 int top;
10454 int right;
10455 int bottom;
10456
Romain Guyd928d682009-03-31 17:52:16 -070010457 public void setNextPoolable(InvalidateInfo element) {
10458 mNext = element;
10459 }
10460
10461 public InvalidateInfo getNextPoolable() {
10462 return mNext;
10463 }
10464
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010465 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070010466 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010467 }
10468
10469 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070010470 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010471 }
10472 }
10473
10474 final IWindowSession mSession;
10475
10476 final IWindow mWindow;
10477
10478 final IBinder mWindowToken;
10479
10480 final Callbacks mRootCallbacks;
10481
10482 /**
10483 * The top view of the hierarchy.
10484 */
10485 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070010486
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010487 IBinder mPanelParentWindowToken;
10488 Surface mSurface;
10489
Romain Guyb051e892010-09-28 19:09:36 -070010490 boolean mHardwareAccelerated;
10491 HardwareRenderer mHardwareRenderer;
Romain Guy2bffd262010-09-12 17:40:02 -070010492
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010493 /**
Romain Guy8506ab42009-06-11 17:35:47 -070010494 * Scale factor used by the compatibility mode
10495 */
10496 float mApplicationScale;
10497
10498 /**
10499 * Indicates whether the application is in compatibility mode
10500 */
10501 boolean mScalingRequired;
10502
10503 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010504 * Left position of this view's window
10505 */
10506 int mWindowLeft;
10507
10508 /**
10509 * Top position of this view's window
10510 */
10511 int mWindowTop;
10512
10513 /**
Romain Guy35b38ce2009-10-07 13:38:55 -070010514 * Indicates whether the window is translucent/transparent
10515 */
10516 boolean mTranslucentWindow;
10517
10518 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010519 * For windows that are full-screen but using insets to layout inside
10520 * of the screen decorations, these are the current insets for the
10521 * content of the window.
10522 */
10523 final Rect mContentInsets = new Rect();
10524
10525 /**
10526 * For windows that are full-screen but using insets to layout inside
10527 * of the screen decorations, these are the current insets for the
10528 * actual visible parts of the window.
10529 */
10530 final Rect mVisibleInsets = new Rect();
10531
10532 /**
10533 * The internal insets given by this window. This value is
10534 * supplied by the client (through
10535 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
10536 * be given to the window manager when changed to be used in laying
10537 * out windows behind it.
10538 */
10539 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
10540 = new ViewTreeObserver.InternalInsetsInfo();
10541
10542 /**
10543 * All views in the window's hierarchy that serve as scroll containers,
10544 * used to determine if the window can be resized or must be panned
10545 * to adjust for a soft input area.
10546 */
10547 final ArrayList<View> mScrollContainers = new ArrayList<View>();
10548
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070010549 final KeyEvent.DispatcherState mKeyDispatchState
10550 = new KeyEvent.DispatcherState();
10551
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010552 /**
10553 * Indicates whether the view's window currently has the focus.
10554 */
10555 boolean mHasWindowFocus;
10556
10557 /**
10558 * The current visibility of the window.
10559 */
10560 int mWindowVisibility;
10561
10562 /**
10563 * Indicates the time at which drawing started to occur.
10564 */
10565 long mDrawingTime;
10566
10567 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070010568 * Indicates whether or not ignoring the DIRTY_MASK flags.
10569 */
10570 boolean mIgnoreDirtyState;
10571
10572 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010573 * Indicates whether the view's window is currently in touch mode.
10574 */
10575 boolean mInTouchMode;
10576
10577 /**
10578 * Indicates that ViewRoot should trigger a global layout change
10579 * the next time it performs a traversal
10580 */
10581 boolean mRecomputeGlobalAttributes;
10582
10583 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010584 * Set during a traveral if any views want to keep the screen on.
10585 */
10586 boolean mKeepScreenOn;
10587
10588 /**
10589 * Set if the visibility of any views has changed.
10590 */
10591 boolean mViewVisibilityChanged;
10592
10593 /**
10594 * Set to true if a view has been scrolled.
10595 */
10596 boolean mViewScrollChanged;
10597
10598 /**
10599 * Global to the view hierarchy used as a temporary for dealing with
10600 * x/y points in the transparent region computations.
10601 */
10602 final int[] mTransparentLocation = new int[2];
10603
10604 /**
10605 * Global to the view hierarchy used as a temporary for dealing with
10606 * x/y points in the ViewGroup.invalidateChild implementation.
10607 */
10608 final int[] mInvalidateChildLocation = new int[2];
10609
Chet Haasec3aa3612010-06-17 08:50:37 -070010610
10611 /**
10612 * Global to the view hierarchy used as a temporary for dealing with
10613 * x/y location when view is transformed.
10614 */
10615 final float[] mTmpTransformLocation = new float[2];
10616
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010617 /**
10618 * The view tree observer used to dispatch global events like
10619 * layout, pre-draw, touch mode change, etc.
10620 */
10621 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
10622
10623 /**
10624 * A Canvas used by the view hierarchy to perform bitmap caching.
10625 */
10626 Canvas mCanvas;
10627
10628 /**
10629 * A Handler supplied by a view's {@link android.view.ViewRoot}. This
10630 * handler can be used to pump events in the UI events queue.
10631 */
10632 final Handler mHandler;
10633
10634 /**
10635 * Identifier for messages requesting the view to be invalidated.
10636 * Such messages should be sent to {@link #mHandler}.
10637 */
10638 static final int INVALIDATE_MSG = 0x1;
10639
10640 /**
10641 * Identifier for messages requesting the view to invalidate a region.
10642 * Such messages should be sent to {@link #mHandler}.
10643 */
10644 static final int INVALIDATE_RECT_MSG = 0x2;
10645
10646 /**
10647 * Temporary for use in computing invalidate rectangles while
10648 * calling up the hierarchy.
10649 */
10650 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070010651
10652 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070010653 * Temporary for use in computing hit areas with transformed views
10654 */
10655 final RectF mTmpTransformRect = new RectF();
10656
10657 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070010658 * Temporary list for use in collecting focusable descendents of a view.
10659 */
10660 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24);
10661
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010662 /**
10663 * Creates a new set of attachment information with the specified
10664 * events handler and thread.
10665 *
10666 * @param handler the events handler the view must use
10667 */
10668 AttachInfo(IWindowSession session, IWindow window,
10669 Handler handler, Callbacks effectPlayer) {
10670 mSession = session;
10671 mWindow = window;
10672 mWindowToken = window.asBinder();
10673 mHandler = handler;
10674 mRootCallbacks = effectPlayer;
10675 }
10676 }
10677
10678 /**
10679 * <p>ScrollabilityCache holds various fields used by a View when scrolling
10680 * is supported. This avoids keeping too many unused fields in most
10681 * instances of View.</p>
10682 */
Mike Cleronf116bf82009-09-27 19:14:12 -070010683 private static class ScrollabilityCache implements Runnable {
10684
10685 /**
10686 * Scrollbars are not visible
10687 */
10688 public static final int OFF = 0;
10689
10690 /**
10691 * Scrollbars are visible
10692 */
10693 public static final int ON = 1;
10694
10695 /**
10696 * Scrollbars are fading away
10697 */
10698 public static final int FADING = 2;
10699
10700 public boolean fadeScrollBars;
10701
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010702 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070010703 public int scrollBarDefaultDelayBeforeFade;
10704 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010705
10706 public int scrollBarSize;
10707 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070010708 public float[] interpolatorValues;
10709 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010710
10711 public final Paint paint;
10712 public final Matrix matrix;
10713 public Shader shader;
10714
Mike Cleronf116bf82009-09-27 19:14:12 -070010715 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
10716
Romain Guy8fb95422010-08-17 18:38:51 -070010717 private final float[] mOpaque = { 255.0f };
10718 private final float[] mTransparent = { 0.0f };
Mike Cleronf116bf82009-09-27 19:14:12 -070010719
10720 /**
10721 * When fading should start. This time moves into the future every time
10722 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
10723 */
10724 public long fadeStartTime;
10725
10726
10727 /**
10728 * The current state of the scrollbars: ON, OFF, or FADING
10729 */
10730 public int state = OFF;
10731
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010732 private int mLastColor;
10733
Mike Cleronf116bf82009-09-27 19:14:12 -070010734 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010735 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
10736 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070010737 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
10738 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010739
10740 paint = new Paint();
10741 matrix = new Matrix();
10742 // use use a height of 1, and then wack the matrix each time we
10743 // actually use it.
10744 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070010745
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010746 paint.setShader(shader);
10747 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070010748 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010749 }
Romain Guy8506ab42009-06-11 17:35:47 -070010750
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010751 public void setFadeColor(int color) {
10752 if (color != 0 && color != mLastColor) {
10753 mLastColor = color;
10754 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070010755
Romain Guye55e1a72009-08-27 10:42:26 -070010756 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
10757 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070010758
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010759 paint.setShader(shader);
10760 // Restore the default transfer mode (src_over)
10761 paint.setXfermode(null);
10762 }
10763 }
Mike Cleronf116bf82009-09-27 19:14:12 -070010764
10765 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070010766 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070010767 if (now >= fadeStartTime) {
10768
10769 // the animation fades the scrollbars out by changing
10770 // the opacity (alpha) from fully opaque to fully
10771 // transparent
10772 int nextFrame = (int) now;
10773 int framesCount = 0;
10774
10775 Interpolator interpolator = scrollBarInterpolator;
10776
10777 // Start opaque
10778 interpolator.setKeyFrame(framesCount++, nextFrame, mOpaque);
10779
10780 // End transparent
10781 nextFrame += scrollBarFadeDuration;
10782 interpolator.setKeyFrame(framesCount, nextFrame, mTransparent);
10783
10784 state = FADING;
10785
10786 // Kick off the fade animation
10787 host.invalidate();
10788 }
10789 }
10790
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010791 }
10792}