blob: 65d93a6825f1fa25a16aa150e58b82f463f88df1 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.view;
18
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080019import com.android.internal.R;
20import com.android.internal.util.Predicate;
21import com.android.internal.view.menu.MenuBuilder;
22
Christopher Tatea53146c2010-09-07 11:57:52 -070023import android.content.ClipData;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080024import android.content.Context;
Dianne Hackborne36d6e22010-02-17 19:46:25 -080025import android.content.res.Configuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080026import android.content.res.Resources;
27import android.content.res.TypedArray;
28import android.graphics.Bitmap;
Adam Powell2b342f02010-08-18 18:14:13 -070029import android.graphics.Camera;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080030import android.graphics.Canvas;
Mike Cleronf116bf82009-09-27 19:14:12 -070031import android.graphics.Interpolator;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080032import android.graphics.LinearGradient;
33import android.graphics.Matrix;
34import android.graphics.Paint;
35import android.graphics.PixelFormat;
svetoslavganov75986cf2009-05-14 22:28:01 -070036import android.graphics.Point;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080037import android.graphics.PorterDuff;
38import android.graphics.PorterDuffXfermode;
39import android.graphics.Rect;
Adam Powell6e346362010-07-23 10:18:23 -070040import android.graphics.RectF;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080041import android.graphics.Region;
42import android.graphics.Shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080043import android.graphics.drawable.ColorDrawable;
44import android.graphics.drawable.Drawable;
45import android.os.Handler;
46import android.os.IBinder;
47import android.os.Message;
48import android.os.Parcel;
49import android.os.Parcelable;
50import android.os.RemoteException;
51import android.os.SystemClock;
52import android.os.SystemProperties;
53import android.util.AttributeSet;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080054import android.util.Log;
Romain Guyd928d682009-03-31 17:52:16 -070055import android.util.Pool;
svetoslavganov75986cf2009-05-14 22:28:01 -070056import android.util.Poolable;
Romain Guyd928d682009-03-31 17:52:16 -070057import android.util.PoolableManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070058import android.util.Pools;
59import android.util.SparseArray;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080060import android.view.ContextMenu.ContextMenuInfo;
svetoslavganov75986cf2009-05-14 22:28:01 -070061import android.view.accessibility.AccessibilityEvent;
62import android.view.accessibility.AccessibilityEventSource;
63import android.view.accessibility.AccessibilityManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080064import android.view.animation.Animation;
Mike Cleron3ecd58c2009-09-28 11:39:02 -070065import android.view.animation.AnimationUtils;
svetoslavganov75986cf2009-05-14 22:28:01 -070066import android.view.inputmethod.EditorInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080067import android.view.inputmethod.InputConnection;
68import android.view.inputmethod.InputMethodManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080069import android.widget.ScrollBarDrawable;
70
Christopher Tatea0374192010-10-05 13:06:41 -070071import java.lang.ref.WeakReference;
svetoslavganov75986cf2009-05-14 22:28:01 -070072import java.lang.reflect.InvocationTargetException;
73import java.lang.reflect.Method;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080074import java.util.ArrayList;
75import java.util.Arrays;
Romain Guyd90a3312009-05-06 14:54:28 -070076import java.util.WeakHashMap;
Adam Powell4afd62b2011-02-18 15:02:18 -080077import java.util.concurrent.CopyOnWriteArrayList;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080078
79/**
80 * <p>
81 * This class represents the basic building block for user interface components. A View
82 * occupies a rectangular area on the screen and is responsible for drawing and
83 * event handling. View is the base class for <em>widgets</em>, which are
Romain Guy8506ab42009-06-11 17:35:47 -070084 * used to create interactive UI components (buttons, text fields, etc.). The
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080085 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which
86 * are invisible containers that hold other Views (or other ViewGroups) and define
87 * their layout properties.
88 * </p>
89 *
90 * <div class="special">
Romain Guy8506ab42009-06-11 17:35:47 -070091 * <p>For an introduction to using this class to develop your
92 * application's user interface, read the Developer Guide documentation on
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080093 * <strong><a href="{@docRoot}guide/topics/ui/index.html">User Interface</a></strong>. Special topics
Romain Guy8506ab42009-06-11 17:35:47 -070094 * include:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080095 * <br/><a href="{@docRoot}guide/topics/ui/declaring-layout.html">Declaring Layout</a>
96 * <br/><a href="{@docRoot}guide/topics/ui/menus.html">Creating Menus</a>
97 * <br/><a href="{@docRoot}guide/topics/ui/layout-objects.html">Common Layout Objects</a>
98 * <br/><a href="{@docRoot}guide/topics/ui/binding.html">Binding to Data with AdapterView</a>
99 * <br/><a href="{@docRoot}guide/topics/ui/ui-events.html">Handling UI Events</a>
100 * <br/><a href="{@docRoot}guide/topics/ui/themes.html">Applying Styles and Themes</a>
101 * <br/><a href="{@docRoot}guide/topics/ui/custom-components.html">Building Custom Components</a>
102 * <br/><a href="{@docRoot}guide/topics/ui/how-android-draws.html">How Android Draws Views</a>.
103 * </p>
104 * </div>
Romain Guy8506ab42009-06-11 17:35:47 -0700105 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800106 * <a name="Using"></a>
107 * <h3>Using Views</h3>
108 * <p>
109 * All of the views in a window are arranged in a single tree. You can add views
110 * either from code or by specifying a tree of views in one or more XML layout
111 * files. There are many specialized subclasses of views that act as controls or
112 * are capable of displaying text, images, or other content.
113 * </p>
114 * <p>
115 * Once you have created a tree of views, there are typically a few types of
116 * common operations you may wish to perform:
117 * <ul>
118 * <li><strong>Set properties:</strong> for example setting the text of a
119 * {@link android.widget.TextView}. The available properties and the methods
120 * that set them will vary among the different subclasses of views. Note that
121 * properties that are known at build time can be set in the XML layout
122 * files.</li>
123 * <li><strong>Set focus:</strong> The framework will handled moving focus in
124 * response to user input. To force focus to a specific view, call
125 * {@link #requestFocus}.</li>
126 * <li><strong>Set up listeners:</strong> Views allow clients to set listeners
127 * that will be notified when something interesting happens to the view. For
128 * example, all views will let you set a listener to be notified when the view
129 * gains or loses focus. You can register such a listener using
130 * {@link #setOnFocusChangeListener}. Other view subclasses offer more
131 * specialized listeners. For example, a Button exposes a listener to notify
132 * clients when the button is clicked.</li>
133 * <li><strong>Set visibility:</strong> You can hide or show views using
134 * {@link #setVisibility}.</li>
135 * </ul>
136 * </p>
137 * <p><em>
138 * Note: The Android framework is responsible for measuring, laying out and
139 * drawing views. You should not call methods that perform these actions on
140 * views yourself unless you are actually implementing a
141 * {@link android.view.ViewGroup}.
142 * </em></p>
143 *
144 * <a name="Lifecycle"></a>
145 * <h3>Implementing a Custom View</h3>
146 *
147 * <p>
148 * To implement a custom view, you will usually begin by providing overrides for
149 * some of the standard methods that the framework calls on all views. You do
150 * not need to override all of these methods. In fact, you can start by just
151 * overriding {@link #onDraw(android.graphics.Canvas)}.
152 * <table border="2" width="85%" align="center" cellpadding="5">
153 * <thead>
154 * <tr><th>Category</th> <th>Methods</th> <th>Description</th></tr>
155 * </thead>
156 *
157 * <tbody>
158 * <tr>
159 * <td rowspan="2">Creation</td>
160 * <td>Constructors</td>
161 * <td>There is a form of the constructor that are called when the view
162 * is created from code and a form that is called when the view is
163 * inflated from a layout file. The second form should parse and apply
164 * any attributes defined in the layout file.
165 * </td>
166 * </tr>
167 * <tr>
168 * <td><code>{@link #onFinishInflate()}</code></td>
169 * <td>Called after a view and all of its children has been inflated
170 * from XML.</td>
171 * </tr>
172 *
173 * <tr>
174 * <td rowspan="3">Layout</td>
175 * <td><code>{@link #onMeasure}</code></td>
176 * <td>Called to determine the size requirements for this view and all
177 * of its children.
178 * </td>
179 * </tr>
180 * <tr>
181 * <td><code>{@link #onLayout}</code></td>
182 * <td>Called when this view should assign a size and position to all
183 * of its children.
184 * </td>
185 * </tr>
186 * <tr>
187 * <td><code>{@link #onSizeChanged}</code></td>
188 * <td>Called when the size of this view has changed.
189 * </td>
190 * </tr>
191 *
192 * <tr>
193 * <td>Drawing</td>
194 * <td><code>{@link #onDraw}</code></td>
195 * <td>Called when the view should render its content.
196 * </td>
197 * </tr>
198 *
199 * <tr>
200 * <td rowspan="4">Event processing</td>
201 * <td><code>{@link #onKeyDown}</code></td>
202 * <td>Called when a new key event occurs.
203 * </td>
204 * </tr>
205 * <tr>
206 * <td><code>{@link #onKeyUp}</code></td>
207 * <td>Called when a key up event occurs.
208 * </td>
209 * </tr>
210 * <tr>
211 * <td><code>{@link #onTrackballEvent}</code></td>
212 * <td>Called when a trackball motion event occurs.
213 * </td>
214 * </tr>
215 * <tr>
216 * <td><code>{@link #onTouchEvent}</code></td>
217 * <td>Called when a touch screen motion event occurs.
218 * </td>
219 * </tr>
220 *
221 * <tr>
222 * <td rowspan="2">Focus</td>
223 * <td><code>{@link #onFocusChanged}</code></td>
224 * <td>Called when the view gains or loses focus.
225 * </td>
226 * </tr>
227 *
228 * <tr>
229 * <td><code>{@link #onWindowFocusChanged}</code></td>
230 * <td>Called when the window containing the view gains or loses focus.
231 * </td>
232 * </tr>
233 *
234 * <tr>
235 * <td rowspan="3">Attaching</td>
236 * <td><code>{@link #onAttachedToWindow()}</code></td>
237 * <td>Called when the view is attached to a window.
238 * </td>
239 * </tr>
240 *
241 * <tr>
242 * <td><code>{@link #onDetachedFromWindow}</code></td>
243 * <td>Called when the view is detached from its window.
244 * </td>
245 * </tr>
246 *
247 * <tr>
248 * <td><code>{@link #onWindowVisibilityChanged}</code></td>
249 * <td>Called when the visibility of the window containing the view
250 * has changed.
251 * </td>
252 * </tr>
253 * </tbody>
254 *
255 * </table>
256 * </p>
257 *
258 * <a name="IDs"></a>
259 * <h3>IDs</h3>
260 * Views may have an integer id associated with them. These ids are typically
261 * assigned in the layout XML files, and are used to find specific views within
262 * the view tree. A common pattern is to:
263 * <ul>
264 * <li>Define a Button in the layout file and assign it a unique ID.
265 * <pre>
Gilles Debunne0243caf2010-08-24 23:06:35 -0700266 * &lt;Button
267 * android:id="@+id/my_button"
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800268 * android:layout_width="wrap_content"
269 * android:layout_height="wrap_content"
270 * android:text="@string/my_button_text"/&gt;
271 * </pre></li>
272 * <li>From the onCreate method of an Activity, find the Button
273 * <pre class="prettyprint">
274 * Button myButton = (Button) findViewById(R.id.my_button);
275 * </pre></li>
276 * </ul>
277 * <p>
278 * View IDs need not be unique throughout the tree, but it is good practice to
279 * ensure that they are at least unique within the part of the tree you are
280 * searching.
281 * </p>
282 *
283 * <a name="Position"></a>
284 * <h3>Position</h3>
285 * <p>
286 * The geometry of a view is that of a rectangle. A view has a location,
287 * expressed as a pair of <em>left</em> and <em>top</em> coordinates, and
288 * two dimensions, expressed as a width and a height. The unit for location
289 * and dimensions is the pixel.
290 * </p>
291 *
292 * <p>
293 * It is possible to retrieve the location of a view by invoking the methods
294 * {@link #getLeft()} and {@link #getTop()}. The former returns the left, or X,
295 * coordinate of the rectangle representing the view. The latter returns the
296 * top, or Y, coordinate of the rectangle representing the view. These methods
297 * both return the location of the view relative to its parent. For instance,
298 * when getLeft() returns 20, that means the view is located 20 pixels to the
299 * right of the left edge of its direct parent.
300 * </p>
301 *
302 * <p>
303 * In addition, several convenience methods are offered to avoid unnecessary
304 * computations, namely {@link #getRight()} and {@link #getBottom()}.
305 * These methods return the coordinates of the right and bottom edges of the
306 * rectangle representing the view. For instance, calling {@link #getRight()}
307 * is similar to the following computation: <code>getLeft() + getWidth()</code>
308 * (see <a href="#SizePaddingMargins">Size</a> for more information about the width.)
309 * </p>
310 *
311 * <a name="SizePaddingMargins"></a>
312 * <h3>Size, padding and margins</h3>
313 * <p>
314 * The size of a view is expressed with a width and a height. A view actually
315 * possess two pairs of width and height values.
316 * </p>
317 *
318 * <p>
319 * The first pair is known as <em>measured width</em> and
320 * <em>measured height</em>. These dimensions define how big a view wants to be
321 * within its parent (see <a href="#Layout">Layout</a> for more details.) The
322 * measured dimensions can be obtained by calling {@link #getMeasuredWidth()}
323 * and {@link #getMeasuredHeight()}.
324 * </p>
325 *
326 * <p>
327 * The second pair is simply known as <em>width</em> and <em>height</em>, or
328 * sometimes <em>drawing width</em> and <em>drawing height</em>. These
329 * dimensions define the actual size of the view on screen, at drawing time and
330 * after layout. These values may, but do not have to, be different from the
331 * measured width and height. The width and height can be obtained by calling
332 * {@link #getWidth()} and {@link #getHeight()}.
333 * </p>
334 *
335 * <p>
336 * To measure its dimensions, a view takes into account its padding. The padding
337 * is expressed in pixels for the left, top, right and bottom parts of the view.
338 * Padding can be used to offset the content of the view by a specific amount of
339 * pixels. For instance, a left padding of 2 will push the view's content by
340 * 2 pixels to the right of the left edge. Padding can be set using the
341 * {@link #setPadding(int, int, int, int)} method and queried by calling
342 * {@link #getPaddingLeft()}, {@link #getPaddingTop()},
343 * {@link #getPaddingRight()} and {@link #getPaddingBottom()}.
344 * </p>
345 *
346 * <p>
347 * Even though a view can define a padding, it does not provide any support for
348 * margins. However, view groups provide such a support. Refer to
349 * {@link android.view.ViewGroup} and
350 * {@link android.view.ViewGroup.MarginLayoutParams} for further information.
351 * </p>
352 *
353 * <a name="Layout"></a>
354 * <h3>Layout</h3>
355 * <p>
356 * Layout is a two pass process: a measure pass and a layout pass. The measuring
357 * pass is implemented in {@link #measure(int, int)} and is a top-down traversal
358 * of the view tree. Each view pushes dimension specifications down the tree
359 * during the recursion. At the end of the measure pass, every view has stored
360 * its measurements. The second pass happens in
361 * {@link #layout(int,int,int,int)} and is also top-down. During
362 * this pass each parent is responsible for positioning all of its children
363 * using the sizes computed in the measure pass.
364 * </p>
365 *
366 * <p>
367 * When a view's measure() method returns, its {@link #getMeasuredWidth()} and
368 * {@link #getMeasuredHeight()} values must be set, along with those for all of
369 * that view's descendants. A view's measured width and measured height values
370 * must respect the constraints imposed by the view's parents. This guarantees
371 * that at the end of the measure pass, all parents accept all of their
372 * children's measurements. A parent view may call measure() more than once on
373 * its children. For example, the parent may measure each child once with
374 * unspecified dimensions to find out how big they want to be, then call
375 * measure() on them again with actual numbers if the sum of all the children's
376 * unconstrained sizes is too big or too small.
377 * </p>
378 *
379 * <p>
380 * The measure pass uses two classes to communicate dimensions. The
381 * {@link MeasureSpec} class is used by views to tell their parents how they
382 * want to be measured and positioned. The base LayoutParams class just
383 * describes how big the view wants to be for both width and height. For each
384 * dimension, it can specify one of:
385 * <ul>
386 * <li> an exact number
Romain Guy980a9382010-01-08 15:06:28 -0800387 * <li>MATCH_PARENT, which means the view wants to be as big as its parent
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800388 * (minus padding)
389 * <li> WRAP_CONTENT, which means that the view wants to be just big enough to
390 * enclose its content (plus padding).
391 * </ul>
392 * There are subclasses of LayoutParams for different subclasses of ViewGroup.
393 * For example, AbsoluteLayout has its own subclass of LayoutParams which adds
394 * an X and Y value.
395 * </p>
396 *
397 * <p>
398 * MeasureSpecs are used to push requirements down the tree from parent to
399 * child. A MeasureSpec can be in one of three modes:
400 * <ul>
401 * <li>UNSPECIFIED: This is used by a parent to determine the desired dimension
402 * of a child view. For example, a LinearLayout may call measure() on its child
403 * with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how
404 * tall the child view wants to be given a width of 240 pixels.
405 * <li>EXACTLY: This is used by the parent to impose an exact size on the
406 * child. The child must use this size, and guarantee that all of its
407 * descendants will fit within this size.
408 * <li>AT_MOST: This is used by the parent to impose a maximum size on the
409 * child. The child must gurantee that it and all of its descendants will fit
410 * within this size.
411 * </ul>
412 * </p>
413 *
414 * <p>
415 * To intiate a layout, call {@link #requestLayout}. This method is typically
416 * called by a view on itself when it believes that is can no longer fit within
417 * its current bounds.
418 * </p>
419 *
420 * <a name="Drawing"></a>
421 * <h3>Drawing</h3>
422 * <p>
423 * Drawing is handled by walking the tree and rendering each view that
424 * intersects the the invalid region. Because the tree is traversed in-order,
425 * this means that parents will draw before (i.e., behind) their children, with
426 * siblings drawn in the order they appear in the tree.
427 * If you set a background drawable for a View, then the View will draw it for you
428 * before calling back to its <code>onDraw()</code> method.
429 * </p>
430 *
431 * <p>
Romain Guy8506ab42009-06-11 17:35:47 -0700432 * Note that the framework will not draw views that are not in the invalid region.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800433 * </p>
434 *
435 * <p>
436 * To force a view to draw, call {@link #invalidate()}.
437 * </p>
438 *
439 * <a name="EventHandlingThreading"></a>
440 * <h3>Event Handling and Threading</h3>
441 * <p>
442 * The basic cycle of a view is as follows:
443 * <ol>
444 * <li>An event comes in and is dispatched to the appropriate view. The view
445 * handles the event and notifies any listeners.</li>
446 * <li>If in the course of processing the event, the view's bounds may need
447 * to be changed, the view will call {@link #requestLayout()}.</li>
448 * <li>Similarly, if in the course of processing the event the view's appearance
449 * may need to be changed, the view will call {@link #invalidate()}.</li>
450 * <li>If either {@link #requestLayout()} or {@link #invalidate()} were called,
451 * the framework will take care of measuring, laying out, and drawing the tree
452 * as appropriate.</li>
453 * </ol>
454 * </p>
455 *
456 * <p><em>Note: The entire view tree is single threaded. You must always be on
457 * the UI thread when calling any method on any view.</em>
458 * If you are doing work on other threads and want to update the state of a view
459 * from that thread, you should use a {@link Handler}.
460 * </p>
461 *
462 * <a name="FocusHandling"></a>
463 * <h3>Focus Handling</h3>
464 * <p>
465 * The framework will handle routine focus movement in response to user input.
466 * This includes changing the focus as views are removed or hidden, or as new
467 * views become available. Views indicate their willingness to take focus
468 * through the {@link #isFocusable} method. To change whether a view can take
469 * focus, call {@link #setFocusable(boolean)}. When in touch mode (see notes below)
470 * views indicate whether they still would like focus via {@link #isFocusableInTouchMode}
471 * and can change this via {@link #setFocusableInTouchMode(boolean)}.
472 * </p>
473 * <p>
474 * Focus movement is based on an algorithm which finds the nearest neighbor in a
475 * given direction. In rare cases, the default algorithm may not match the
476 * intended behavior of the developer. In these situations, you can provide
477 * explicit overrides by using these XML attributes in the layout file:
478 * <pre>
479 * nextFocusDown
480 * nextFocusLeft
481 * nextFocusRight
482 * nextFocusUp
483 * </pre>
484 * </p>
485 *
486 *
487 * <p>
488 * To get a particular view to take focus, call {@link #requestFocus()}.
489 * </p>
490 *
491 * <a name="TouchMode"></a>
492 * <h3>Touch Mode</h3>
493 * <p>
494 * When a user is navigating a user interface via directional keys such as a D-pad, it is
495 * necessary to give focus to actionable items such as buttons so the user can see
496 * what will take input. If the device has touch capabilities, however, and the user
497 * begins interacting with the interface by touching it, it is no longer necessary to
498 * always highlight, or give focus to, a particular view. This motivates a mode
499 * for interaction named 'touch mode'.
500 * </p>
501 * <p>
502 * For a touch capable device, once the user touches the screen, the device
503 * will enter touch mode. From this point onward, only views for which
504 * {@link #isFocusableInTouchMode} is true will be focusable, such as text editing widgets.
505 * Other views that are touchable, like buttons, will not take focus when touched; they will
506 * only fire the on click listeners.
507 * </p>
508 * <p>
509 * Any time a user hits a directional key, such as a D-pad direction, the view device will
510 * exit touch mode, and find a view to take focus, so that the user may resume interacting
511 * with the user interface without touching the screen again.
512 * </p>
513 * <p>
514 * The touch mode state is maintained across {@link android.app.Activity}s. Call
515 * {@link #isInTouchMode} to see whether the device is currently in touch mode.
516 * </p>
517 *
518 * <a name="Scrolling"></a>
519 * <h3>Scrolling</h3>
520 * <p>
521 * The framework provides basic support for views that wish to internally
522 * scroll their content. This includes keeping track of the X and Y scroll
523 * offset as well as mechanisms for drawing scrollbars. See
Joe Malin32736f02011-01-19 16:14:20 -0800524 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and
Mike Cleronf116bf82009-09-27 19:14:12 -0700525 * {@link #awakenScrollBars()} for more details.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800526 * </p>
527 *
528 * <a name="Tags"></a>
529 * <h3>Tags</h3>
530 * <p>
531 * Unlike IDs, tags are not used to identify views. Tags are essentially an
532 * extra piece of information that can be associated with a view. They are most
533 * often used as a convenience to store data related to views in the views
534 * themselves rather than by putting them in a separate structure.
535 * </p>
536 *
537 * <a name="Animation"></a>
538 * <h3>Animation</h3>
539 * <p>
540 * You can attach an {@link Animation} object to a view using
541 * {@link #setAnimation(Animation)} or
542 * {@link #startAnimation(Animation)}. The animation can alter the scale,
543 * rotation, translation and alpha of a view over time. If the animation is
544 * attached to a view that has children, the animation will affect the entire
545 * subtree rooted by that node. When an animation is started, the framework will
546 * take care of redrawing the appropriate views until the animation completes.
547 * </p>
Romain Guy171c5922011-01-06 10:04:23 -0800548 * <p>
549 * Starting with Android 3.0, the preferred way of animating views is to use the
550 * {@link android.animation} package APIs.
551 * </p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800552 *
Jeff Brown85a31762010-09-01 17:01:00 -0700553 * <a name="Security"></a>
554 * <h3>Security</h3>
555 * <p>
556 * Sometimes it is essential that an application be able to verify that an action
557 * is being performed with the full knowledge and consent of the user, such as
558 * granting a permission request, making a purchase or clicking on an advertisement.
559 * Unfortunately, a malicious application could try to spoof the user into
560 * performing these actions, unaware, by concealing the intended purpose of the view.
561 * As a remedy, the framework offers a touch filtering mechanism that can be used to
562 * improve the security of views that provide access to sensitive functionality.
563 * </p><p>
564 * To enable touch filtering, call {@link #setFilterTouchesWhenObscured} or set the
Jeff Brown49ed71d2010-12-06 17:13:33 -0800565 * android:filterTouchesWhenObscured layout attribute to true. When enabled, the framework
Jeff Brown85a31762010-09-01 17:01:00 -0700566 * will discard touches that are received whenever the view's window is obscured by
567 * another visible window. As a result, the view will not receive touches whenever a
568 * toast, dialog or other window appears above the view's window.
569 * </p><p>
570 * For more fine-grained control over security, consider overriding the
571 * {@link #onFilterTouchEventForSecurity} method to implement your own security policy.
572 * See also {@link MotionEvent#FLAG_WINDOW_IS_OBSCURED}.
573 * </p>
574 *
Romain Guy171c5922011-01-06 10:04:23 -0800575 * @attr ref android.R.styleable#View_alpha
Romain Guyd6a463a2009-05-21 23:10:10 -0700576 * @attr ref android.R.styleable#View_background
577 * @attr ref android.R.styleable#View_clickable
578 * @attr ref android.R.styleable#View_contentDescription
579 * @attr ref android.R.styleable#View_drawingCacheQuality
580 * @attr ref android.R.styleable#View_duplicateParentState
581 * @attr ref android.R.styleable#View_id
582 * @attr ref android.R.styleable#View_fadingEdge
583 * @attr ref android.R.styleable#View_fadingEdgeLength
Jeff Brown85a31762010-09-01 17:01:00 -0700584 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800585 * @attr ref android.R.styleable#View_fitsSystemWindows
Romain Guyd6a463a2009-05-21 23:10:10 -0700586 * @attr ref android.R.styleable#View_isScrollContainer
587 * @attr ref android.R.styleable#View_focusable
588 * @attr ref android.R.styleable#View_focusableInTouchMode
589 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
590 * @attr ref android.R.styleable#View_keepScreenOn
Romain Guy171c5922011-01-06 10:04:23 -0800591 * @attr ref android.R.styleable#View_layerType
Romain Guyd6a463a2009-05-21 23:10:10 -0700592 * @attr ref android.R.styleable#View_longClickable
593 * @attr ref android.R.styleable#View_minHeight
594 * @attr ref android.R.styleable#View_minWidth
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800595 * @attr ref android.R.styleable#View_nextFocusDown
596 * @attr ref android.R.styleable#View_nextFocusLeft
597 * @attr ref android.R.styleable#View_nextFocusRight
598 * @attr ref android.R.styleable#View_nextFocusUp
Romain Guyd6a463a2009-05-21 23:10:10 -0700599 * @attr ref android.R.styleable#View_onClick
600 * @attr ref android.R.styleable#View_padding
601 * @attr ref android.R.styleable#View_paddingBottom
602 * @attr ref android.R.styleable#View_paddingLeft
603 * @attr ref android.R.styleable#View_paddingRight
604 * @attr ref android.R.styleable#View_paddingTop
605 * @attr ref android.R.styleable#View_saveEnabled
Chet Haase73066682010-11-29 15:55:32 -0800606 * @attr ref android.R.styleable#View_rotation
607 * @attr ref android.R.styleable#View_rotationX
608 * @attr ref android.R.styleable#View_rotationY
609 * @attr ref android.R.styleable#View_scaleX
610 * @attr ref android.R.styleable#View_scaleY
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800611 * @attr ref android.R.styleable#View_scrollX
612 * @attr ref android.R.styleable#View_scrollY
Romain Guyd6a463a2009-05-21 23:10:10 -0700613 * @attr ref android.R.styleable#View_scrollbarSize
614 * @attr ref android.R.styleable#View_scrollbarStyle
615 * @attr ref android.R.styleable#View_scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -0700616 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
617 * @attr ref android.R.styleable#View_scrollbarFadeDuration
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800618 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal
619 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800620 * @attr ref android.R.styleable#View_scrollbarThumbVertical
621 * @attr ref android.R.styleable#View_scrollbarTrackVertical
622 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack
623 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack
Romain Guyd6a463a2009-05-21 23:10:10 -0700624 * @attr ref android.R.styleable#View_soundEffectsEnabled
625 * @attr ref android.R.styleable#View_tag
Chet Haase73066682010-11-29 15:55:32 -0800626 * @attr ref android.R.styleable#View_transformPivotX
627 * @attr ref android.R.styleable#View_transformPivotY
628 * @attr ref android.R.styleable#View_translationX
629 * @attr ref android.R.styleable#View_translationY
Romain Guyd6a463a2009-05-21 23:10:10 -0700630 * @attr ref android.R.styleable#View_visibility
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800631 *
632 * @see android.view.ViewGroup
633 */
svetoslavganov75986cf2009-05-14 22:28:01 -0700634public class View implements Drawable.Callback, KeyEvent.Callback, AccessibilityEventSource {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800635 private static final boolean DBG = false;
636
637 /**
638 * The logging tag used by this class with android.util.Log.
639 */
640 protected static final String VIEW_LOG_TAG = "View";
641
642 /**
643 * Used to mark a View that has no ID.
644 */
645 public static final int NO_ID = -1;
646
647 /**
648 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when
649 * calling setFlags.
650 */
651 private static final int NOT_FOCUSABLE = 0x00000000;
652
653 /**
654 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling
655 * setFlags.
656 */
657 private static final int FOCUSABLE = 0x00000001;
658
659 /**
660 * Mask for use with setFlags indicating bits used for focus.
661 */
662 private static final int FOCUSABLE_MASK = 0x00000001;
663
664 /**
665 * This view will adjust its padding to fit sytem windows (e.g. status bar)
666 */
667 private static final int FITS_SYSTEM_WINDOWS = 0x00000002;
668
669 /**
670 * This view is visible. Use with {@link #setVisibility}.
671 */
672 public static final int VISIBLE = 0x00000000;
673
674 /**
675 * This view is invisible, but it still takes up space for layout purposes.
676 * Use with {@link #setVisibility}.
677 */
678 public static final int INVISIBLE = 0x00000004;
679
680 /**
681 * This view is invisible, and it doesn't take any space for layout
682 * purposes. Use with {@link #setVisibility}.
683 */
684 public static final int GONE = 0x00000008;
685
686 /**
687 * Mask for use with setFlags indicating bits used for visibility.
688 * {@hide}
689 */
690 static final int VISIBILITY_MASK = 0x0000000C;
691
692 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE};
693
694 /**
695 * This view is enabled. Intrepretation varies by subclass.
696 * Use with ENABLED_MASK when calling setFlags.
697 * {@hide}
698 */
699 static final int ENABLED = 0x00000000;
700
701 /**
702 * This view is disabled. Intrepretation varies by subclass.
703 * Use with ENABLED_MASK when calling setFlags.
704 * {@hide}
705 */
706 static final int DISABLED = 0x00000020;
707
708 /**
709 * Mask for use with setFlags indicating bits used for indicating whether
710 * this view is enabled
711 * {@hide}
712 */
713 static final int ENABLED_MASK = 0x00000020;
714
715 /**
716 * This view won't draw. {@link #onDraw} won't be called and further
717 * optimizations
718 * will be performed. It is okay to have this flag set and a background.
719 * Use with DRAW_MASK when calling setFlags.
720 * {@hide}
721 */
722 static final int WILL_NOT_DRAW = 0x00000080;
723
724 /**
725 * Mask for use with setFlags indicating bits used for indicating whether
726 * this view is will draw
727 * {@hide}
728 */
729 static final int DRAW_MASK = 0x00000080;
730
731 /**
732 * <p>This view doesn't show scrollbars.</p>
733 * {@hide}
734 */
735 static final int SCROLLBARS_NONE = 0x00000000;
736
737 /**
738 * <p>This view shows horizontal scrollbars.</p>
739 * {@hide}
740 */
741 static final int SCROLLBARS_HORIZONTAL = 0x00000100;
742
743 /**
744 * <p>This view shows vertical scrollbars.</p>
745 * {@hide}
746 */
747 static final int SCROLLBARS_VERTICAL = 0x00000200;
748
749 /**
750 * <p>Mask for use with setFlags indicating bits used for indicating which
751 * scrollbars are enabled.</p>
752 * {@hide}
753 */
754 static final int SCROLLBARS_MASK = 0x00000300;
755
Jeff Brown85a31762010-09-01 17:01:00 -0700756 /**
757 * Indicates that the view should filter touches when its window is obscured.
758 * Refer to the class comments for more information about this security feature.
759 * {@hide}
760 */
761 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400;
762
763 // note flag value 0x00000800 is now available for next flags...
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800764
765 /**
766 * <p>This view doesn't show fading edges.</p>
767 * {@hide}
768 */
769 static final int FADING_EDGE_NONE = 0x00000000;
770
771 /**
772 * <p>This view shows horizontal fading edges.</p>
773 * {@hide}
774 */
775 static final int FADING_EDGE_HORIZONTAL = 0x00001000;
776
777 /**
778 * <p>This view shows vertical fading edges.</p>
779 * {@hide}
780 */
781 static final int FADING_EDGE_VERTICAL = 0x00002000;
782
783 /**
784 * <p>Mask for use with setFlags indicating bits used for indicating which
785 * fading edges are enabled.</p>
786 * {@hide}
787 */
788 static final int FADING_EDGE_MASK = 0x00003000;
789
790 /**
791 * <p>Indicates this view can be clicked. When clickable, a View reacts
792 * to clicks by notifying the OnClickListener.<p>
793 * {@hide}
794 */
795 static final int CLICKABLE = 0x00004000;
796
797 /**
798 * <p>Indicates this view is caching its drawing into a bitmap.</p>
799 * {@hide}
800 */
801 static final int DRAWING_CACHE_ENABLED = 0x00008000;
802
803 /**
804 * <p>Indicates that no icicle should be saved for this view.<p>
805 * {@hide}
806 */
807 static final int SAVE_DISABLED = 0x000010000;
808
809 /**
810 * <p>Mask for use with setFlags indicating bits used for the saveEnabled
811 * property.</p>
812 * {@hide}
813 */
814 static final int SAVE_DISABLED_MASK = 0x000010000;
815
816 /**
817 * <p>Indicates that no drawing cache should ever be created for this view.<p>
818 * {@hide}
819 */
820 static final int WILL_NOT_CACHE_DRAWING = 0x000020000;
821
822 /**
823 * <p>Indicates this view can take / keep focus when int touch mode.</p>
824 * {@hide}
825 */
826 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000;
827
828 /**
829 * <p>Enables low quality mode for the drawing cache.</p>
830 */
831 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000;
832
833 /**
834 * <p>Enables high quality mode for the drawing cache.</p>
835 */
836 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000;
837
838 /**
839 * <p>Enables automatic quality mode for the drawing cache.</p>
840 */
841 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000;
842
843 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = {
844 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH
845 };
846
847 /**
848 * <p>Mask for use with setFlags indicating bits used for the cache
849 * quality property.</p>
850 * {@hide}
851 */
852 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000;
853
854 /**
855 * <p>
856 * Indicates this view can be long clicked. When long clickable, a View
857 * reacts to long clicks by notifying the OnLongClickListener or showing a
858 * context menu.
859 * </p>
860 * {@hide}
861 */
862 static final int LONG_CLICKABLE = 0x00200000;
863
864 /**
865 * <p>Indicates that this view gets its drawable states from its direct parent
866 * and ignores its original internal states.</p>
867 *
868 * @hide
869 */
870 static final int DUPLICATE_PARENT_STATE = 0x00400000;
871
872 /**
873 * The scrollbar style to display the scrollbars inside the content area,
874 * without increasing the padding. The scrollbars will be overlaid with
875 * translucency on the view's content.
876 */
877 public static final int SCROLLBARS_INSIDE_OVERLAY = 0;
878
879 /**
880 * The scrollbar style to display the scrollbars inside the padded area,
881 * increasing the padding of the view. The scrollbars will not overlap the
882 * content area of the view.
883 */
884 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000;
885
886 /**
887 * The scrollbar style to display the scrollbars at the edge of the view,
888 * without increasing the padding. The scrollbars will be overlaid with
889 * translucency.
890 */
891 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000;
892
893 /**
894 * The scrollbar style to display the scrollbars at the edge of the view,
895 * increasing the padding of the view. The scrollbars will only overlap the
896 * background, if any.
897 */
898 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000;
899
900 /**
901 * Mask to check if the scrollbar style is overlay or inset.
902 * {@hide}
903 */
904 static final int SCROLLBARS_INSET_MASK = 0x01000000;
905
906 /**
907 * Mask to check if the scrollbar style is inside or outside.
908 * {@hide}
909 */
910 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000;
911
912 /**
913 * Mask for scrollbar style.
914 * {@hide}
915 */
916 static final int SCROLLBARS_STYLE_MASK = 0x03000000;
917
918 /**
919 * View flag indicating that the screen should remain on while the
920 * window containing this view is visible to the user. This effectively
921 * takes care of automatically setting the WindowManager's
922 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}.
923 */
924 public static final int KEEP_SCREEN_ON = 0x04000000;
925
926 /**
927 * View flag indicating whether this view should have sound effects enabled
928 * for events such as clicking and touching.
929 */
930 public static final int SOUND_EFFECTS_ENABLED = 0x08000000;
931
932 /**
933 * View flag indicating whether this view should have haptic feedback
934 * enabled for events such as long presses.
935 */
936 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000;
937
938 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700939 * <p>Indicates that the view hierarchy should stop saving state when
940 * it reaches this view. If state saving is initiated immediately at
941 * the view, it will be allowed.
942 * {@hide}
943 */
944 static final int PARENT_SAVE_DISABLED = 0x20000000;
945
946 /**
947 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p>
948 * {@hide}
949 */
950 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000;
951
952 /**
svetoslavganov75986cf2009-05-14 22:28:01 -0700953 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
954 * should add all focusable Views regardless if they are focusable in touch mode.
955 */
956 public static final int FOCUSABLES_ALL = 0x00000000;
957
958 /**
959 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
960 * should add only Views focusable in touch mode.
961 */
962 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001;
963
964 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800965 * Use with {@link #focusSearch}. Move focus to the previous selectable
966 * item.
967 */
968 public static final int FOCUS_BACKWARD = 0x00000001;
969
970 /**
971 * Use with {@link #focusSearch}. Move focus to the next selectable
972 * item.
973 */
974 public static final int FOCUS_FORWARD = 0x00000002;
975
976 /**
977 * Use with {@link #focusSearch}. Move focus to the left.
978 */
979 public static final int FOCUS_LEFT = 0x00000011;
980
981 /**
982 * Use with {@link #focusSearch}. Move focus up.
983 */
984 public static final int FOCUS_UP = 0x00000021;
985
986 /**
987 * Use with {@link #focusSearch}. Move focus to the right.
988 */
989 public static final int FOCUS_RIGHT = 0x00000042;
990
991 /**
992 * Use with {@link #focusSearch}. Move focus down.
993 */
994 public static final int FOCUS_DOWN = 0x00000082;
995
996 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -0800997 * Bits of {@link #getMeasuredWidthAndState()} and
998 * {@link #getMeasuredWidthAndState()} that provide the actual measured size.
999 */
1000 public static final int MEASURED_SIZE_MASK = 0x00ffffff;
1001
1002 /**
1003 * Bits of {@link #getMeasuredWidthAndState()} and
1004 * {@link #getMeasuredWidthAndState()} that provide the additional state bits.
1005 */
1006 public static final int MEASURED_STATE_MASK = 0xff000000;
1007
1008 /**
1009 * Bit shift of {@link #MEASURED_STATE_MASK} to get to the height bits
1010 * for functions that combine both width and height into a single int,
1011 * such as {@link #getMeasuredState()} and the childState argument of
1012 * {@link #resolveSizeAndState(int, int, int)}.
1013 */
1014 public static final int MEASURED_HEIGHT_STATE_SHIFT = 16;
1015
1016 /**
1017 * Bit of {@link #getMeasuredWidthAndState()} and
1018 * {@link #getMeasuredWidthAndState()} that indicates the measured size
1019 * is smaller that the space the view would like to have.
1020 */
1021 public static final int MEASURED_STATE_TOO_SMALL = 0x01000000;
1022
1023 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001024 * Base View state sets
1025 */
1026 // Singles
1027 /**
1028 * Indicates the view has no states set. States are used with
1029 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1030 * view depending on its state.
1031 *
1032 * @see android.graphics.drawable.Drawable
1033 * @see #getDrawableState()
1034 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001035 protected static final int[] EMPTY_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001036 /**
1037 * Indicates the view is enabled. States are used with
1038 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1039 * view depending on its state.
1040 *
1041 * @see android.graphics.drawable.Drawable
1042 * @see #getDrawableState()
1043 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001044 protected static final int[] ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001045 /**
1046 * Indicates the view is focused. States are used with
1047 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1048 * view depending on its state.
1049 *
1050 * @see android.graphics.drawable.Drawable
1051 * @see #getDrawableState()
1052 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001053 protected static final int[] FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001054 /**
1055 * Indicates the view is selected. States are used with
1056 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1057 * view depending on its state.
1058 *
1059 * @see android.graphics.drawable.Drawable
1060 * @see #getDrawableState()
1061 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001062 protected static final int[] SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001063 /**
1064 * Indicates the view is pressed. States are used with
1065 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1066 * view depending on its state.
1067 *
1068 * @see android.graphics.drawable.Drawable
1069 * @see #getDrawableState()
1070 * @hide
1071 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001072 protected static final int[] PRESSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001073 /**
1074 * Indicates the view's window has focus. States are used with
1075 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1076 * view depending on its state.
1077 *
1078 * @see android.graphics.drawable.Drawable
1079 * @see #getDrawableState()
1080 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001081 protected static final int[] WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001082 // Doubles
1083 /**
1084 * Indicates the view is enabled and has the focus.
1085 *
1086 * @see #ENABLED_STATE_SET
1087 * @see #FOCUSED_STATE_SET
1088 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001089 protected static final int[] ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001090 /**
1091 * Indicates the view is enabled and selected.
1092 *
1093 * @see #ENABLED_STATE_SET
1094 * @see #SELECTED_STATE_SET
1095 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001096 protected static final int[] ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001097 /**
1098 * Indicates the view is enabled and that its window has focus.
1099 *
1100 * @see #ENABLED_STATE_SET
1101 * @see #WINDOW_FOCUSED_STATE_SET
1102 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001103 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001104 /**
1105 * Indicates the view is focused and selected.
1106 *
1107 * @see #FOCUSED_STATE_SET
1108 * @see #SELECTED_STATE_SET
1109 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001110 protected static final int[] FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001111 /**
1112 * Indicates the view has the focus and that its window has the focus.
1113 *
1114 * @see #FOCUSED_STATE_SET
1115 * @see #WINDOW_FOCUSED_STATE_SET
1116 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001117 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001118 /**
1119 * Indicates the view is selected and that its window has the focus.
1120 *
1121 * @see #SELECTED_STATE_SET
1122 * @see #WINDOW_FOCUSED_STATE_SET
1123 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001124 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001125 // Triples
1126 /**
1127 * Indicates the view is enabled, focused and selected.
1128 *
1129 * @see #ENABLED_STATE_SET
1130 * @see #FOCUSED_STATE_SET
1131 * @see #SELECTED_STATE_SET
1132 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001133 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001134 /**
1135 * Indicates the view is enabled, focused and its window has the focus.
1136 *
1137 * @see #ENABLED_STATE_SET
1138 * @see #FOCUSED_STATE_SET
1139 * @see #WINDOW_FOCUSED_STATE_SET
1140 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001141 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001142 /**
1143 * Indicates the view is enabled, selected and its window has the focus.
1144 *
1145 * @see #ENABLED_STATE_SET
1146 * @see #SELECTED_STATE_SET
1147 * @see #WINDOW_FOCUSED_STATE_SET
1148 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001149 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001150 /**
1151 * Indicates the view is focused, selected and its window has the focus.
1152 *
1153 * @see #FOCUSED_STATE_SET
1154 * @see #SELECTED_STATE_SET
1155 * @see #WINDOW_FOCUSED_STATE_SET
1156 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001157 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001158 /**
1159 * Indicates the view is enabled, focused, selected and its window
1160 * has the focus.
1161 *
1162 * @see #ENABLED_STATE_SET
1163 * @see #FOCUSED_STATE_SET
1164 * @see #SELECTED_STATE_SET
1165 * @see #WINDOW_FOCUSED_STATE_SET
1166 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001167 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001168 /**
1169 * Indicates the view is pressed and its window has the focus.
1170 *
1171 * @see #PRESSED_STATE_SET
1172 * @see #WINDOW_FOCUSED_STATE_SET
1173 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001174 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001175 /**
1176 * Indicates the view is pressed and selected.
1177 *
1178 * @see #PRESSED_STATE_SET
1179 * @see #SELECTED_STATE_SET
1180 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001181 protected static final int[] PRESSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001182 /**
1183 * Indicates the view is pressed, selected and its window has the focus.
1184 *
1185 * @see #PRESSED_STATE_SET
1186 * @see #SELECTED_STATE_SET
1187 * @see #WINDOW_FOCUSED_STATE_SET
1188 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001189 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001190 /**
1191 * Indicates the view is pressed and focused.
1192 *
1193 * @see #PRESSED_STATE_SET
1194 * @see #FOCUSED_STATE_SET
1195 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001196 protected static final int[] PRESSED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001197 /**
1198 * Indicates the view is pressed, focused and its window has the focus.
1199 *
1200 * @see #PRESSED_STATE_SET
1201 * @see #FOCUSED_STATE_SET
1202 * @see #WINDOW_FOCUSED_STATE_SET
1203 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001204 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001205 /**
1206 * Indicates the view is pressed, focused and selected.
1207 *
1208 * @see #PRESSED_STATE_SET
1209 * @see #SELECTED_STATE_SET
1210 * @see #FOCUSED_STATE_SET
1211 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001212 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001213 /**
1214 * Indicates the view is pressed, focused, selected and its window has the focus.
1215 *
1216 * @see #PRESSED_STATE_SET
1217 * @see #FOCUSED_STATE_SET
1218 * @see #SELECTED_STATE_SET
1219 * @see #WINDOW_FOCUSED_STATE_SET
1220 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001221 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001222 /**
1223 * Indicates the view is pressed and enabled.
1224 *
1225 * @see #PRESSED_STATE_SET
1226 * @see #ENABLED_STATE_SET
1227 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001228 protected static final int[] PRESSED_ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001229 /**
1230 * Indicates the view is pressed, enabled and its window has the focus.
1231 *
1232 * @see #PRESSED_STATE_SET
1233 * @see #ENABLED_STATE_SET
1234 * @see #WINDOW_FOCUSED_STATE_SET
1235 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001236 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001237 /**
1238 * Indicates the view is pressed, enabled and selected.
1239 *
1240 * @see #PRESSED_STATE_SET
1241 * @see #ENABLED_STATE_SET
1242 * @see #SELECTED_STATE_SET
1243 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001244 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001245 /**
1246 * Indicates the view is pressed, enabled, selected and its window has the
1247 * focus.
1248 *
1249 * @see #PRESSED_STATE_SET
1250 * @see #ENABLED_STATE_SET
1251 * @see #SELECTED_STATE_SET
1252 * @see #WINDOW_FOCUSED_STATE_SET
1253 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001254 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001255 /**
1256 * Indicates the view is pressed, enabled and focused.
1257 *
1258 * @see #PRESSED_STATE_SET
1259 * @see #ENABLED_STATE_SET
1260 * @see #FOCUSED_STATE_SET
1261 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001262 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001263 /**
1264 * Indicates the view is pressed, enabled, focused and its window has the
1265 * focus.
1266 *
1267 * @see #PRESSED_STATE_SET
1268 * @see #ENABLED_STATE_SET
1269 * @see #FOCUSED_STATE_SET
1270 * @see #WINDOW_FOCUSED_STATE_SET
1271 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001272 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001273 /**
1274 * Indicates the view is pressed, enabled, focused and selected.
1275 *
1276 * @see #PRESSED_STATE_SET
1277 * @see #ENABLED_STATE_SET
1278 * @see #SELECTED_STATE_SET
1279 * @see #FOCUSED_STATE_SET
1280 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001281 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001282 /**
1283 * Indicates the view is pressed, enabled, focused, selected and its window
1284 * has the focus.
1285 *
1286 * @see #PRESSED_STATE_SET
1287 * @see #ENABLED_STATE_SET
1288 * @see #SELECTED_STATE_SET
1289 * @see #FOCUSED_STATE_SET
1290 * @see #WINDOW_FOCUSED_STATE_SET
1291 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001292 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001293
1294 /**
1295 * The order here is very important to {@link #getDrawableState()}
1296 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001297 private static final int[][] VIEW_STATE_SETS;
1298
Romain Guyb051e892010-09-28 19:09:36 -07001299 static final int VIEW_STATE_WINDOW_FOCUSED = 1;
1300 static final int VIEW_STATE_SELECTED = 1 << 1;
1301 static final int VIEW_STATE_FOCUSED = 1 << 2;
1302 static final int VIEW_STATE_ENABLED = 1 << 3;
1303 static final int VIEW_STATE_PRESSED = 1 << 4;
1304 static final int VIEW_STATE_ACTIVATED = 1 << 5;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001305 static final int VIEW_STATE_ACCELERATED = 1 << 6;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001306
1307 static final int[] VIEW_STATE_IDS = new int[] {
1308 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED,
1309 R.attr.state_selected, VIEW_STATE_SELECTED,
1310 R.attr.state_focused, VIEW_STATE_FOCUSED,
1311 R.attr.state_enabled, VIEW_STATE_ENABLED,
1312 R.attr.state_pressed, VIEW_STATE_PRESSED,
1313 R.attr.state_activated, VIEW_STATE_ACTIVATED,
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001314 R.attr.state_accelerated, VIEW_STATE_ACCELERATED,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001315 };
1316
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001317 static {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001318 if ((VIEW_STATE_IDS.length/2) != R.styleable.ViewDrawableStates.length) {
1319 throw new IllegalStateException(
1320 "VIEW_STATE_IDs array length does not match ViewDrawableStates style array");
1321 }
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001322 int[] orderedIds = new int[VIEW_STATE_IDS.length];
Romain Guyb051e892010-09-28 19:09:36 -07001323 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001324 int viewState = R.styleable.ViewDrawableStates[i];
Romain Guyb051e892010-09-28 19:09:36 -07001325 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001326 if (VIEW_STATE_IDS[j] == viewState) {
Romain Guyb051e892010-09-28 19:09:36 -07001327 orderedIds[i * 2] = viewState;
1328 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1];
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001329 }
1330 }
1331 }
Romain Guyb051e892010-09-28 19:09:36 -07001332 final int NUM_BITS = VIEW_STATE_IDS.length / 2;
1333 VIEW_STATE_SETS = new int[1 << NUM_BITS][];
1334 for (int i = 0; i < VIEW_STATE_SETS.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001335 int numBits = Integer.bitCount(i);
1336 int[] set = new int[numBits];
1337 int pos = 0;
Romain Guyb051e892010-09-28 19:09:36 -07001338 for (int j = 0; j < orderedIds.length; j += 2) {
1339 if ((i & orderedIds[j+1]) != 0) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001340 set[pos++] = orderedIds[j];
1341 }
1342 }
1343 VIEW_STATE_SETS[i] = set;
1344 }
1345
1346 EMPTY_STATE_SET = VIEW_STATE_SETS[0];
1347 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED];
1348 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED];
1349 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1350 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED];
1351 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED];
1352 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1353 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED];
1354 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1355 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED];
1356 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1357 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1358 | VIEW_STATE_FOCUSED];
1359 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED];
1360 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1361 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED];
1362 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1363 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED];
1364 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1365 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1366 | VIEW_STATE_ENABLED];
1367 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1368 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED];
1369 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1370 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1371 | VIEW_STATE_ENABLED];
1372 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1373 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1374 | VIEW_STATE_ENABLED];
1375 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1376 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1377 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED];
1378
1379 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED];
1380 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1381 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED];
1382 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1383 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED];
1384 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1385 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1386 | VIEW_STATE_PRESSED];
1387 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1388 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1389 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1390 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1391 | VIEW_STATE_PRESSED];
1392 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1393 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1394 | VIEW_STATE_PRESSED];
1395 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1396 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1397 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1398 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[
1399 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1400 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1401 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED
1402 | VIEW_STATE_PRESSED];
1403 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1404 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED
1405 | VIEW_STATE_PRESSED];
1406 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1407 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1408 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1409 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1410 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED
1411 | VIEW_STATE_PRESSED];
1412 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1413 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1414 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1415 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1416 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1417 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1418 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1419 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1420 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED
1421 | VIEW_STATE_PRESSED];
1422 }
1423
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001424 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001425 * Temporary Rect currently for use in setBackground(). This will probably
1426 * be extended in the future to hold our own class with more than just
1427 * a Rect. :)
1428 */
1429 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>();
Romain Guyd90a3312009-05-06 14:54:28 -07001430
1431 /**
1432 * Map used to store views' tags.
1433 */
1434 private static WeakHashMap<View, SparseArray<Object>> sTags;
1435
1436 /**
1437 * Lock used to access sTags.
1438 */
1439 private static final Object sTagsLock = new Object();
1440
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001441 /**
1442 * The animation currently associated with this view.
1443 * @hide
1444 */
1445 protected Animation mCurrentAnimation = null;
1446
1447 /**
1448 * Width as measured during measure pass.
1449 * {@hide}
1450 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001451 @ViewDebug.ExportedProperty(category = "measurement")
Romain Guy676b1732011-02-14 14:45:33 -08001452 int mMeasuredWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001453
1454 /**
1455 * Height as measured during measure pass.
1456 * {@hide}
1457 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001458 @ViewDebug.ExportedProperty(category = "measurement")
Romain Guy676b1732011-02-14 14:45:33 -08001459 int mMeasuredHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001460
1461 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001462 * Flag to indicate that this view was marked INVALIDATED, or had its display list
1463 * invalidated, prior to the current drawing iteration. If true, the view must re-draw
1464 * its display list. This flag, used only when hw accelerated, allows us to clear the
1465 * flag while retaining this information until it's needed (at getDisplayList() time and
1466 * in drawChild(), when we decide to draw a view's children's display lists into our own).
1467 *
1468 * {@hide}
1469 */
1470 boolean mRecreateDisplayList = false;
1471
1472 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001473 * The view's identifier.
1474 * {@hide}
1475 *
1476 * @see #setId(int)
1477 * @see #getId()
1478 */
1479 @ViewDebug.ExportedProperty(resolveId = true)
1480 int mID = NO_ID;
1481
1482 /**
1483 * The view's tag.
1484 * {@hide}
1485 *
1486 * @see #setTag(Object)
1487 * @see #getTag()
1488 */
1489 protected Object mTag;
1490
1491 // for mPrivateFlags:
1492 /** {@hide} */
1493 static final int WANTS_FOCUS = 0x00000001;
1494 /** {@hide} */
1495 static final int FOCUSED = 0x00000002;
1496 /** {@hide} */
1497 static final int SELECTED = 0x00000004;
1498 /** {@hide} */
1499 static final int IS_ROOT_NAMESPACE = 0x00000008;
1500 /** {@hide} */
1501 static final int HAS_BOUNDS = 0x00000010;
1502 /** {@hide} */
1503 static final int DRAWN = 0x00000020;
1504 /**
1505 * When this flag is set, this view is running an animation on behalf of its
1506 * children and should therefore not cancel invalidate requests, even if they
1507 * lie outside of this view's bounds.
1508 *
1509 * {@hide}
1510 */
1511 static final int DRAW_ANIMATION = 0x00000040;
1512 /** {@hide} */
1513 static final int SKIP_DRAW = 0x00000080;
1514 /** {@hide} */
1515 static final int ONLY_DRAWS_BACKGROUND = 0x00000100;
1516 /** {@hide} */
1517 static final int REQUEST_TRANSPARENT_REGIONS = 0x00000200;
1518 /** {@hide} */
1519 static final int DRAWABLE_STATE_DIRTY = 0x00000400;
1520 /** {@hide} */
1521 static final int MEASURED_DIMENSION_SET = 0x00000800;
1522 /** {@hide} */
1523 static final int FORCE_LAYOUT = 0x00001000;
Konstantin Lopyrevc6dc4572010-08-06 15:01:52 -07001524 /** {@hide} */
1525 static final int LAYOUT_REQUIRED = 0x00002000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001526
1527 private static final int PRESSED = 0x00004000;
1528
1529 /** {@hide} */
1530 static final int DRAWING_CACHE_VALID = 0x00008000;
1531 /**
1532 * Flag used to indicate that this view should be drawn once more (and only once
1533 * more) after its animation has completed.
1534 * {@hide}
1535 */
1536 static final int ANIMATION_STARTED = 0x00010000;
1537
1538 private static final int SAVE_STATE_CALLED = 0x00020000;
1539
1540 /**
1541 * Indicates that the View returned true when onSetAlpha() was called and that
1542 * the alpha must be restored.
1543 * {@hide}
1544 */
1545 static final int ALPHA_SET = 0x00040000;
1546
1547 /**
1548 * Set by {@link #setScrollContainer(boolean)}.
1549 */
1550 static final int SCROLL_CONTAINER = 0x00080000;
1551
1552 /**
1553 * Set by {@link #setScrollContainer(boolean)}.
1554 */
1555 static final int SCROLL_CONTAINER_ADDED = 0x00100000;
1556
1557 /**
Romain Guy809a7f62009-05-14 15:44:42 -07001558 * View flag indicating whether this view was invalidated (fully or partially.)
1559 *
1560 * @hide
1561 */
1562 static final int DIRTY = 0x00200000;
1563
1564 /**
1565 * View flag indicating whether this view was invalidated by an opaque
1566 * invalidate request.
1567 *
1568 * @hide
1569 */
1570 static final int DIRTY_OPAQUE = 0x00400000;
1571
1572 /**
1573 * Mask for {@link #DIRTY} and {@link #DIRTY_OPAQUE}.
1574 *
1575 * @hide
1576 */
1577 static final int DIRTY_MASK = 0x00600000;
1578
1579 /**
Romain Guy8f1344f52009-05-15 16:03:59 -07001580 * Indicates whether the background is opaque.
1581 *
1582 * @hide
1583 */
1584 static final int OPAQUE_BACKGROUND = 0x00800000;
1585
1586 /**
1587 * Indicates whether the scrollbars are opaque.
1588 *
1589 * @hide
1590 */
1591 static final int OPAQUE_SCROLLBARS = 0x01000000;
1592
1593 /**
1594 * Indicates whether the view is opaque.
1595 *
1596 * @hide
1597 */
1598 static final int OPAQUE_MASK = 0x01800000;
Joe Malin32736f02011-01-19 16:14:20 -08001599
Adam Powelle14579b2009-12-16 18:39:52 -08001600 /**
1601 * Indicates a prepressed state;
1602 * the short time between ACTION_DOWN and recognizing
1603 * a 'real' press. Prepressed is used to recognize quick taps
1604 * even when they are shorter than ViewConfiguration.getTapTimeout().
Joe Malin32736f02011-01-19 16:14:20 -08001605 *
Adam Powelle14579b2009-12-16 18:39:52 -08001606 * @hide
1607 */
1608 private static final int PREPRESSED = 0x02000000;
Joe Malin32736f02011-01-19 16:14:20 -08001609
Adam Powellc9fbaab2010-02-16 17:16:19 -08001610 /**
Romain Guy8afa5152010-02-26 11:56:30 -08001611 * Indicates whether the view is temporarily detached.
1612 *
1613 * @hide
1614 */
1615 static final int CANCEL_NEXT_UP_EVENT = 0x04000000;
Joe Malin32736f02011-01-19 16:14:20 -08001616
Adam Powell8568c3a2010-04-19 14:26:11 -07001617 /**
1618 * Indicates that we should awaken scroll bars once attached
Joe Malin32736f02011-01-19 16:14:20 -08001619 *
Adam Powell8568c3a2010-04-19 14:26:11 -07001620 * @hide
1621 */
1622 private static final int AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000;
Romain Guy8f1344f52009-05-15 16:03:59 -07001623
1624 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001625 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center
1626 * for transform operations
1627 *
1628 * @hide
1629 */
Adam Powellf37df072010-09-17 16:22:49 -07001630 private static final int PIVOT_EXPLICITLY_SET = 0x20000000;
Chet Haasefd2b0022010-08-06 13:08:56 -07001631
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001632 /** {@hide} */
Adam Powellf37df072010-09-17 16:22:49 -07001633 static final int ACTIVATED = 0x40000000;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001634
Chet Haasefd2b0022010-08-06 13:08:56 -07001635 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001636 * Indicates that this view was specifically invalidated, not just dirtied because some
1637 * child view was invalidated. The flag is used to determine when we need to recreate
1638 * a view's display list (as opposed to just returning a reference to its existing
1639 * display list).
1640 *
1641 * @hide
1642 */
1643 static final int INVALIDATED = 0x80000000;
1644
1645 /**
Adam Powell637d3372010-08-25 14:37:03 -07001646 * Always allow a user to over-scroll this view, provided it is a
1647 * view that can scroll.
1648 *
1649 * @see #getOverScrollMode()
1650 * @see #setOverScrollMode(int)
1651 */
1652 public static final int OVER_SCROLL_ALWAYS = 0;
1653
1654 /**
1655 * Allow a user to over-scroll this view only if the content is large
1656 * enough to meaningfully scroll, provided it is a view that can scroll.
1657 *
1658 * @see #getOverScrollMode()
1659 * @see #setOverScrollMode(int)
1660 */
1661 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1;
1662
1663 /**
1664 * Never allow a user to over-scroll this view.
1665 *
1666 * @see #getOverScrollMode()
1667 * @see #setOverScrollMode(int)
1668 */
1669 public static final int OVER_SCROLL_NEVER = 2;
1670
1671 /**
Joe Onorato664644d2011-01-23 17:53:23 -08001672 * View has requested the status bar to be visible (the default).
1673 *
Joe Malin32736f02011-01-19 16:14:20 -08001674 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08001675 */
1676 public static final int STATUS_BAR_VISIBLE = 0;
1677
1678 /**
1679 * View has requested the status bar to be visible (the default).
1680 *
Joe Malin32736f02011-01-19 16:14:20 -08001681 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08001682 */
1683 public static final int STATUS_BAR_HIDDEN = 0x00000001;
1684
1685 /**
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001686 * @hide
1687 *
1688 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1689 * out of the public fields to keep the undefined bits out of the developer's way.
1690 *
1691 * Flag to make the status bar not expandable. Unless you also
1692 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show.
1693 */
1694 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000;
1695
1696 /**
1697 * @hide
1698 *
1699 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1700 * out of the public fields to keep the undefined bits out of the developer's way.
1701 *
1702 * Flag to hide notification icons and scrolling ticker text.
1703 */
1704 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000;
1705
1706 /**
1707 * @hide
1708 *
1709 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1710 * out of the public fields to keep the undefined bits out of the developer's way.
1711 *
1712 * Flag to disable incoming notification alerts. This will not block
1713 * icons, but it will block sound, vibrating and other visual or aural notifications.
1714 */
1715 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000;
1716
1717 /**
1718 * @hide
1719 *
1720 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1721 * out of the public fields to keep the undefined bits out of the developer's way.
1722 *
1723 * Flag to hide only the scrolling ticker. Note that
1724 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies
1725 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}.
1726 */
1727 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000;
1728
1729 /**
1730 * @hide
1731 *
1732 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1733 * out of the public fields to keep the undefined bits out of the developer's way.
1734 *
1735 * Flag to hide the center system info area.
1736 */
1737 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000;
1738
1739 /**
1740 * @hide
1741 *
1742 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1743 * out of the public fields to keep the undefined bits out of the developer's way.
1744 *
1745 * Flag to hide only the navigation buttons. Don't use this
1746 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
Joe Onorato6478adc2011-01-27 21:15:01 -08001747 *
1748 * THIS DOES NOT DISABLE THE BACK BUTTON
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001749 */
1750 public static final int STATUS_BAR_DISABLE_NAVIGATION = 0x00200000;
1751
1752 /**
1753 * @hide
1754 *
1755 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1756 * out of the public fields to keep the undefined bits out of the developer's way.
1757 *
Joe Onorato6478adc2011-01-27 21:15:01 -08001758 * Flag to hide only the back button. Don't use this
1759 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
1760 */
1761 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000;
1762
1763 /**
1764 * @hide
1765 *
1766 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1767 * out of the public fields to keep the undefined bits out of the developer's way.
1768 *
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001769 * Flag to hide only the clock. You might use this if your activity has
1770 * its own clock making the status bar's clock redundant.
1771 */
Joe Onorato6478adc2011-01-27 21:15:01 -08001772 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000;
1773
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001774
1775 /**
1776 * @hide
1777 */
1778 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = STATUS_BAR_HIDDEN;
1779
1780
1781 /**
Adam Powell637d3372010-08-25 14:37:03 -07001782 * Controls the over-scroll mode for this view.
1783 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)},
1784 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS},
1785 * and {@link #OVER_SCROLL_NEVER}.
1786 */
1787 private int mOverScrollMode;
1788
1789 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001790 * The parent this view is attached to.
1791 * {@hide}
1792 *
1793 * @see #getParent()
1794 */
1795 protected ViewParent mParent;
1796
1797 /**
1798 * {@hide}
1799 */
1800 AttachInfo mAttachInfo;
1801
1802 /**
1803 * {@hide}
1804 */
Romain Guy809a7f62009-05-14 15:44:42 -07001805 @ViewDebug.ExportedProperty(flagMapping = {
1806 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT,
1807 name = "FORCE_LAYOUT"),
1808 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED,
1809 name = "LAYOUT_REQUIRED"),
1810 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07001811 name = "DRAWING_CACHE_INVALID", outputIf = false),
Romain Guy809a7f62009-05-14 15:44:42 -07001812 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true),
1813 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false),
1814 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
1815 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY")
1816 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001817 int mPrivateFlags;
1818
1819 /**
Joe Onorato664644d2011-01-23 17:53:23 -08001820 * This view's request for the visibility of the status bar.
1821 * @hide
1822 */
Joe Onoratoac0ee892011-01-30 15:38:30 -08001823 @ViewDebug.ExportedProperty()
Joe Onorato664644d2011-01-23 17:53:23 -08001824 int mSystemUiVisibility;
1825
1826 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001827 * Count of how many windows this view has been attached to.
1828 */
1829 int mWindowAttachCount;
1830
1831 /**
1832 * The layout parameters associated with this view and used by the parent
1833 * {@link android.view.ViewGroup} to determine how this view should be
1834 * laid out.
1835 * {@hide}
1836 */
1837 protected ViewGroup.LayoutParams mLayoutParams;
1838
1839 /**
1840 * The view flags hold various views states.
1841 * {@hide}
1842 */
1843 @ViewDebug.ExportedProperty
1844 int mViewFlags;
1845
1846 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001847 * The transform matrix for the View. This transform is calculated internally
1848 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1849 * is used by default. Do *not* use this variable directly; instead call
1850 * getMatrix(), which will automatically recalculate the matrix if necessary
1851 * to get the correct matrix based on the latest rotation and scale properties.
1852 */
1853 private final Matrix mMatrix = new Matrix();
1854
1855 /**
1856 * The transform matrix for the View. This transform is calculated internally
1857 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1858 * is used by default. Do *not* use this variable directly; instead call
Jeff Brown86671742010-09-30 20:00:15 -07001859 * getInverseMatrix(), which will automatically recalculate the matrix if necessary
Chet Haasec3aa3612010-06-17 08:50:37 -07001860 * to get the correct matrix based on the latest rotation and scale properties.
1861 */
1862 private Matrix mInverseMatrix;
1863
1864 /**
1865 * An internal variable that tracks whether we need to recalculate the
1866 * transform matrix, based on whether the rotation or scaleX/Y properties
1867 * have changed since the matrix was last calculated.
1868 */
Chet Haasea00f3862011-02-22 06:34:40 -08001869 boolean mMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07001870
1871 /**
1872 * An internal variable that tracks whether we need to recalculate the
1873 * transform matrix, based on whether the rotation or scaleX/Y properties
1874 * have changed since the matrix was last calculated.
1875 */
1876 private boolean mInverseMatrixDirty = true;
1877
1878 /**
1879 * A variable that tracks whether we need to recalculate the
1880 * transform matrix, based on whether the rotation or scaleX/Y properties
1881 * have changed since the matrix was last calculated. This variable
Jeff Brown86671742010-09-30 20:00:15 -07001882 * is only valid after a call to updateMatrix() or to a function that
1883 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix().
Chet Haasec3aa3612010-06-17 08:50:37 -07001884 */
Romain Guy33e72ae2010-07-17 12:40:29 -07001885 private boolean mMatrixIsIdentity = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07001886
1887 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001888 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set.
1889 */
1890 private Camera mCamera = null;
1891
1892 /**
1893 * This matrix is used when computing the matrix for 3D rotations.
1894 */
1895 private Matrix matrix3D = null;
1896
1897 /**
1898 * These prev values are used to recalculate a centered pivot point when necessary. The
1899 * pivot point is only used in matrix operations (when rotation, scale, or translation are
1900 * set), so thes values are only used then as well.
1901 */
1902 private int mPrevWidth = -1;
1903 private int mPrevHeight = -1;
1904
Joe Malin32736f02011-01-19 16:14:20 -08001905 private boolean mLastIsOpaque;
1906
Chet Haasefd2b0022010-08-06 13:08:56 -07001907 /**
1908 * Convenience value to check for float values that are close enough to zero to be considered
1909 * zero.
1910 */
Romain Guy2542d192010-08-18 11:47:12 -07001911 private static final float NONZERO_EPSILON = .001f;
Chet Haasefd2b0022010-08-06 13:08:56 -07001912
1913 /**
1914 * The degrees rotation around the vertical axis through the pivot point.
1915 */
1916 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08001917 float mRotationY = 0f;
Chet Haasefd2b0022010-08-06 13:08:56 -07001918
1919 /**
1920 * The degrees rotation around the horizontal axis through the pivot point.
1921 */
1922 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08001923 float mRotationX = 0f;
Chet Haasefd2b0022010-08-06 13:08:56 -07001924
1925 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001926 * The degrees rotation around the pivot point.
1927 */
1928 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08001929 float mRotation = 0f;
Chet Haasec3aa3612010-06-17 08:50:37 -07001930
1931 /**
Chet Haasedf030d22010-07-30 17:22:38 -07001932 * The amount of translation of the object away from its left property (post-layout).
1933 */
1934 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08001935 float mTranslationX = 0f;
Chet Haasedf030d22010-07-30 17:22:38 -07001936
1937 /**
1938 * The amount of translation of the object away from its top property (post-layout).
1939 */
1940 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08001941 float mTranslationY = 0f;
Chet Haasedf030d22010-07-30 17:22:38 -07001942
1943 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001944 * The amount of scale in the x direction around the pivot point. A
1945 * value of 1 means no scaling is applied.
1946 */
1947 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08001948 float mScaleX = 1f;
Chet Haasec3aa3612010-06-17 08:50:37 -07001949
1950 /**
1951 * The amount of scale in the y direction around the pivot point. A
1952 * value of 1 means no scaling is applied.
1953 */
1954 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08001955 float mScaleY = 1f;
Chet Haasec3aa3612010-06-17 08:50:37 -07001956
1957 /**
1958 * The amount of scale in the x direction around the pivot point. A
1959 * value of 1 means no scaling is applied.
1960 */
1961 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08001962 float mPivotX = 0f;
Chet Haasec3aa3612010-06-17 08:50:37 -07001963
1964 /**
1965 * The amount of scale in the y direction around the pivot point. A
1966 * value of 1 means no scaling is applied.
1967 */
1968 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08001969 float mPivotY = 0f;
Chet Haasec3aa3612010-06-17 08:50:37 -07001970
1971 /**
1972 * The opacity of the View. This is a value from 0 to 1, where 0 means
1973 * completely transparent and 1 means completely opaque.
1974 */
1975 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08001976 float mAlpha = 1f;
Chet Haasec3aa3612010-06-17 08:50:37 -07001977
1978 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001979 * The distance in pixels from the left edge of this view's parent
1980 * to the left edge of this view.
1981 * {@hide}
1982 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001983 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001984 protected int mLeft;
1985 /**
1986 * The distance in pixels from the left edge of this view's parent
1987 * to the right edge of this view.
1988 * {@hide}
1989 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001990 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001991 protected int mRight;
1992 /**
1993 * The distance in pixels from the top edge of this view's parent
1994 * to the top edge of this view.
1995 * {@hide}
1996 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001997 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001998 protected int mTop;
1999 /**
2000 * The distance in pixels from the top edge of this view's parent
2001 * to the bottom edge of this view.
2002 * {@hide}
2003 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002004 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002005 protected int mBottom;
2006
2007 /**
2008 * The offset, in pixels, by which the content of this view is scrolled
2009 * horizontally.
2010 * {@hide}
2011 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002012 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002013 protected int mScrollX;
2014 /**
2015 * The offset, in pixels, by which the content of this view is scrolled
2016 * vertically.
2017 * {@hide}
2018 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002019 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002020 protected int mScrollY;
2021
2022 /**
2023 * The left padding in pixels, that is the distance in pixels between the
2024 * left edge of this view and the left edge of its content.
2025 * {@hide}
2026 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002027 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002028 protected int mPaddingLeft;
2029 /**
2030 * The right padding in pixels, that is the distance in pixels between the
2031 * right edge of this view and the right edge of its content.
2032 * {@hide}
2033 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002034 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002035 protected int mPaddingRight;
2036 /**
2037 * The top padding in pixels, that is the distance in pixels between the
2038 * top edge of this view and the top edge of its content.
2039 * {@hide}
2040 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002041 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002042 protected int mPaddingTop;
2043 /**
2044 * The bottom padding in pixels, that is the distance in pixels between the
2045 * bottom edge of this view and the bottom edge of its content.
2046 * {@hide}
2047 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002048 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002049 protected int mPaddingBottom;
2050
2051 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002052 * Briefly describes the view and is primarily used for accessibility support.
2053 */
2054 private CharSequence mContentDescription;
2055
2056 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002057 * Cache the paddingRight set by the user to append to the scrollbar's size.
2058 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002059 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002060 int mUserPaddingRight;
2061
2062 /**
2063 * Cache the paddingBottom set by the user to append to the scrollbar's size.
2064 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002065 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002066 int mUserPaddingBottom;
2067
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002068 /**
Adam Powell20232d02010-12-08 21:08:53 -08002069 * Cache the paddingLeft set by the user to append to the scrollbar's size.
2070 */
2071 @ViewDebug.ExportedProperty(category = "padding")
2072 int mUserPaddingLeft;
2073
2074 /**
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002075 * @hide
2076 */
2077 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
2078 /**
2079 * @hide
2080 */
2081 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002082
2083 private Resources mResources = null;
2084
2085 private Drawable mBGDrawable;
2086
2087 private int mBackgroundResource;
2088 private boolean mBackgroundSizeChanged;
2089
2090 /**
2091 * Listener used to dispatch focus change events.
2092 * This field should be made private, so it is hidden from the SDK.
2093 * {@hide}
2094 */
2095 protected OnFocusChangeListener mOnFocusChangeListener;
2096
2097 /**
Chet Haase21cd1382010-09-01 17:42:29 -07002098 * Listeners for layout change events.
2099 */
2100 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
2101
2102 /**
Adam Powell4afd62b2011-02-18 15:02:18 -08002103 * Listeners for attach events.
2104 */
2105 private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners;
2106
2107 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002108 * Listener used to dispatch click events.
2109 * This field should be made private, so it is hidden from the SDK.
2110 * {@hide}
2111 */
2112 protected OnClickListener mOnClickListener;
2113
2114 /**
2115 * Listener used to dispatch long click events.
2116 * This field should be made private, so it is hidden from the SDK.
2117 * {@hide}
2118 */
2119 protected OnLongClickListener mOnLongClickListener;
2120
2121 /**
2122 * Listener used to build the context menu.
2123 * This field should be made private, so it is hidden from the SDK.
2124 * {@hide}
2125 */
2126 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
2127
2128 private OnKeyListener mOnKeyListener;
2129
2130 private OnTouchListener mOnTouchListener;
2131
Chris Tate32affef2010-10-18 15:29:21 -07002132 private OnDragListener mOnDragListener;
2133
Joe Onorato664644d2011-01-23 17:53:23 -08002134 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener;
2135
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002136 /**
2137 * The application environment this view lives in.
2138 * This field should be made private, so it is hidden from the SDK.
2139 * {@hide}
2140 */
2141 protected Context mContext;
2142
2143 private ScrollabilityCache mScrollCache;
2144
2145 private int[] mDrawableState = null;
2146
Romain Guy0211a0a2011-02-14 16:34:59 -08002147 /**
2148 * Set to true when drawing cache is enabled and cannot be created.
2149 *
2150 * @hide
2151 */
2152 public boolean mCachingFailed;
2153
Romain Guy02890fd2010-08-06 17:58:44 -07002154 private Bitmap mDrawingCache;
2155 private Bitmap mUnscaledDrawingCache;
Romain Guyb051e892010-09-28 19:09:36 -07002156 private DisplayList mDisplayList;
Romain Guy6c319ca2011-01-11 14:29:25 -08002157 private HardwareLayer mHardwareLayer;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002158
2159 /**
2160 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
2161 * the user may specify which view to go to next.
2162 */
2163 private int mNextFocusLeftId = View.NO_ID;
2164
2165 /**
2166 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
2167 * the user may specify which view to go to next.
2168 */
2169 private int mNextFocusRightId = View.NO_ID;
2170
2171 /**
2172 * When this view has focus and the next focus is {@link #FOCUS_UP},
2173 * the user may specify which view to go to next.
2174 */
2175 private int mNextFocusUpId = View.NO_ID;
2176
2177 /**
2178 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
2179 * the user may specify which view to go to next.
2180 */
2181 private int mNextFocusDownId = View.NO_ID;
2182
Jeff Brown4e6319b2010-12-13 10:36:51 -08002183 /**
2184 * When this view has focus and the next focus is {@link #FOCUS_FORWARD},
2185 * the user may specify which view to go to next.
2186 */
2187 int mNextFocusForwardId = View.NO_ID;
2188
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002189 private CheckForLongPress mPendingCheckForLongPress;
Adam Powelle14579b2009-12-16 18:39:52 -08002190 private CheckForTap mPendingCheckForTap = null;
Adam Powella35d7682010-03-12 14:48:13 -08002191 private PerformClick mPerformClick;
Joe Malin32736f02011-01-19 16:14:20 -08002192
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002193 private UnsetPressedState mUnsetPressedState;
2194
2195 /**
2196 * Whether the long press's action has been invoked. The tap's action is invoked on the
2197 * up event while a long press is invoked as soon as the long press duration is reached, so
2198 * a long press could be performed before the tap is checked, in which case the tap's action
2199 * should not be invoked.
2200 */
2201 private boolean mHasPerformedLongPress;
2202
2203 /**
2204 * The minimum height of the view. We'll try our best to have the height
2205 * of this view to at least this amount.
2206 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002207 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002208 private int mMinHeight;
2209
2210 /**
2211 * The minimum width of the view. We'll try our best to have the width
2212 * of this view to at least this amount.
2213 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002214 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002215 private int mMinWidth;
2216
2217 /**
2218 * The delegate to handle touch events that are physically in this view
2219 * but should be handled by another view.
2220 */
2221 private TouchDelegate mTouchDelegate = null;
2222
2223 /**
2224 * Solid color to use as a background when creating the drawing cache. Enables
2225 * the cache to use 16 bit bitmaps instead of 32 bit.
2226 */
2227 private int mDrawingCacheBackgroundColor = 0;
2228
2229 /**
2230 * Special tree observer used when mAttachInfo is null.
2231 */
2232 private ViewTreeObserver mFloatingTreeObserver;
Joe Malin32736f02011-01-19 16:14:20 -08002233
Adam Powelle14579b2009-12-16 18:39:52 -08002234 /**
2235 * Cache the touch slop from the context that created the view.
2236 */
2237 private int mTouchSlop;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002238
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002239 /**
Chet Haasea00f3862011-02-22 06:34:40 -08002240 * Object that handles automatic animation of view properties.
2241 */
2242 private ViewPropertyAnimator mAnimator = null;
2243
2244 /**
Christopher Tatea53146c2010-09-07 11:57:52 -07002245 * Cache drag/drop state
2246 *
2247 */
2248 boolean mCanAcceptDrop;
Christopher Tatea53146c2010-09-07 11:57:52 -07002249
2250 /**
Christopher Tate251602f2011-01-28 17:54:12 -08002251 * Flag indicating that a drag can cross window boundaries. When
2252 * {@link #startDrag(ClipData, DragShadowBuilder, Object, int)} is called
2253 * with this flag set, all visible applications will be able to participate
2254 * in the drag operation and receive the dragged content.
Christopher Tate7f9ff9d2011-02-14 17:31:13 -08002255 *
2256 * @hide
Christopher Tate02d2b3b2011-01-10 20:43:53 -08002257 */
2258 public static final int DRAG_FLAG_GLOBAL = 1;
2259
2260 /**
Adam Powell20232d02010-12-08 21:08:53 -08002261 * Position of the vertical scroll bar.
2262 */
2263 private int mVerticalScrollbarPosition;
2264
2265 /**
2266 * Position the scroll bar at the default position as determined by the system.
2267 */
2268 public static final int SCROLLBAR_POSITION_DEFAULT = 0;
2269
2270 /**
2271 * Position the scroll bar along the left edge.
2272 */
2273 public static final int SCROLLBAR_POSITION_LEFT = 1;
2274
2275 /**
2276 * Position the scroll bar along the right edge.
2277 */
2278 public static final int SCROLLBAR_POSITION_RIGHT = 2;
2279
2280 /**
Romain Guy171c5922011-01-06 10:04:23 -08002281 * Indicates that the view does not have a layer.
Joe Malin32736f02011-01-19 16:14:20 -08002282 *
2283 * @see #getLayerType()
2284 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08002285 * @see #LAYER_TYPE_SOFTWARE
Joe Malin32736f02011-01-19 16:14:20 -08002286 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08002287 */
2288 public static final int LAYER_TYPE_NONE = 0;
2289
2290 /**
2291 * <p>Indicates that the view has a software layer. A software layer is backed
2292 * by a bitmap and causes the view to be rendered using Android's software
2293 * rendering pipeline, even if hardware acceleration is enabled.</p>
Joe Malin32736f02011-01-19 16:14:20 -08002294 *
Romain Guy171c5922011-01-06 10:04:23 -08002295 * <p>Software layers have various usages:</p>
2296 * <p>When the application is not using hardware acceleration, a software layer
2297 * is useful to apply a specific color filter and/or blending mode and/or
2298 * translucency to a view and all its children.</p>
2299 * <p>When the application is using hardware acceleration, a software layer
2300 * is useful to render drawing primitives not supported by the hardware
2301 * accelerated pipeline. It can also be used to cache a complex view tree
2302 * into a texture and reduce the complexity of drawing operations. For instance,
2303 * when animating a complex view tree with a translation, a software layer can
2304 * be used to render the view tree only once.</p>
2305 * <p>Software layers should be avoided when the affected view tree updates
2306 * often. Every update will require to re-render the software layer, which can
2307 * potentially be slow (particularly when hardware acceleration is turned on
2308 * since the layer will have to be uploaded into a hardware texture after every
2309 * update.)</p>
Joe Malin32736f02011-01-19 16:14:20 -08002310 *
2311 * @see #getLayerType()
2312 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08002313 * @see #LAYER_TYPE_NONE
Joe Malin32736f02011-01-19 16:14:20 -08002314 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08002315 */
2316 public static final int LAYER_TYPE_SOFTWARE = 1;
2317
2318 /**
2319 * <p>Indicates that the view has a hardware layer. A hardware layer is backed
2320 * by a hardware specific texture (generally Frame Buffer Objects or FBO on
2321 * OpenGL hardware) and causes the view to be rendered using Android's hardware
2322 * rendering pipeline, but only if hardware acceleration is turned on for the
2323 * view hierarchy. When hardware acceleration is turned off, hardware layers
2324 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p>
Joe Malin32736f02011-01-19 16:14:20 -08002325 *
Romain Guy171c5922011-01-06 10:04:23 -08002326 * <p>A hardware layer is useful to apply a specific color filter and/or
2327 * blending mode and/or translucency to a view and all its children.</p>
Romain Guy6c319ca2011-01-11 14:29:25 -08002328 * <p>A hardware layer can be used to cache a complex view tree into a
2329 * texture and reduce the complexity of drawing operations. For instance,
2330 * when animating a complex view tree with a translation, a hardware layer can
2331 * be used to render the view tree only once.</p>
Romain Guy171c5922011-01-06 10:04:23 -08002332 * <p>A hardware layer can also be used to increase the rendering quality when
2333 * rotation transformations are applied on a view. It can also be used to
2334 * prevent potential clipping issues when applying 3D transforms on a view.</p>
Joe Malin32736f02011-01-19 16:14:20 -08002335 *
2336 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -08002337 * @see #setLayerType(int, android.graphics.Paint)
2338 * @see #LAYER_TYPE_NONE
2339 * @see #LAYER_TYPE_SOFTWARE
2340 */
2341 public static final int LAYER_TYPE_HARDWARE = 2;
Joe Malin32736f02011-01-19 16:14:20 -08002342
Romain Guy3aaff3a2011-01-12 14:18:47 -08002343 @ViewDebug.ExportedProperty(category = "drawing", mapping = {
2344 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"),
2345 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"),
2346 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE")
2347 })
Romain Guy171c5922011-01-06 10:04:23 -08002348 int mLayerType = LAYER_TYPE_NONE;
2349 Paint mLayerPaint;
Romain Guy3a3133d2011-02-01 22:59:58 -08002350 Rect mLocalDirtyRect;
Romain Guy171c5922011-01-06 10:04:23 -08002351
2352 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002353 * Simple constructor to use when creating a view from code.
2354 *
2355 * @param context The Context the view is running in, through which it can
2356 * access the current theme, resources, etc.
2357 */
2358 public View(Context context) {
2359 mContext = context;
2360 mResources = context != null ? context.getResources() : null;
Romain Guy8f1344f52009-05-15 16:03:59 -07002361 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED;
Adam Powelle14579b2009-12-16 18:39:52 -08002362 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop();
Adam Powell637d3372010-08-25 14:37:03 -07002363 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002364 }
2365
2366 /**
2367 * Constructor that is called when inflating a view from XML. This is called
2368 * when a view is being constructed from an XML file, supplying attributes
2369 * that were specified in the XML file. This version uses a default style of
2370 * 0, so the only attribute values applied are those in the Context's Theme
2371 * and the given AttributeSet.
2372 *
2373 * <p>
2374 * The method onFinishInflate() will be called after all children have been
2375 * added.
2376 *
2377 * @param context The Context the view is running in, through which it can
2378 * access the current theme, resources, etc.
2379 * @param attrs The attributes of the XML tag that is inflating the view.
2380 * @see #View(Context, AttributeSet, int)
2381 */
2382 public View(Context context, AttributeSet attrs) {
2383 this(context, attrs, 0);
2384 }
2385
2386 /**
2387 * Perform inflation from XML and apply a class-specific base style. This
2388 * constructor of View allows subclasses to use their own base style when
2389 * they are inflating. For example, a Button class's constructor would call
2390 * this version of the super class constructor and supply
2391 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
2392 * the theme's button style to modify all of the base view attributes (in
2393 * particular its background) as well as the Button class's attributes.
2394 *
2395 * @param context The Context the view is running in, through which it can
2396 * access the current theme, resources, etc.
2397 * @param attrs The attributes of the XML tag that is inflating the view.
2398 * @param defStyle The default style to apply to this view. If 0, no style
2399 * will be applied (beyond what is included in the theme). This may
2400 * either be an attribute resource, whose value will be retrieved
2401 * from the current theme, or an explicit style resource.
2402 * @see #View(Context, AttributeSet)
2403 */
2404 public View(Context context, AttributeSet attrs, int defStyle) {
2405 this(context);
2406
2407 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
2408 defStyle, 0);
2409
2410 Drawable background = null;
2411
2412 int leftPadding = -1;
2413 int topPadding = -1;
2414 int rightPadding = -1;
2415 int bottomPadding = -1;
2416
2417 int padding = -1;
2418
2419 int viewFlagValues = 0;
2420 int viewFlagMasks = 0;
2421
2422 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07002423
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002424 int x = 0;
2425 int y = 0;
2426
Chet Haase73066682010-11-29 15:55:32 -08002427 float tx = 0;
2428 float ty = 0;
2429 float rotation = 0;
2430 float rotationX = 0;
2431 float rotationY = 0;
2432 float sx = 1f;
2433 float sy = 1f;
2434 boolean transformSet = false;
2435
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002436 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
2437
Adam Powell637d3372010-08-25 14:37:03 -07002438 int overScrollMode = mOverScrollMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002439 final int N = a.getIndexCount();
2440 for (int i = 0; i < N; i++) {
2441 int attr = a.getIndex(i);
2442 switch (attr) {
2443 case com.android.internal.R.styleable.View_background:
2444 background = a.getDrawable(attr);
2445 break;
2446 case com.android.internal.R.styleable.View_padding:
2447 padding = a.getDimensionPixelSize(attr, -1);
2448 break;
2449 case com.android.internal.R.styleable.View_paddingLeft:
2450 leftPadding = a.getDimensionPixelSize(attr, -1);
2451 break;
2452 case com.android.internal.R.styleable.View_paddingTop:
2453 topPadding = a.getDimensionPixelSize(attr, -1);
2454 break;
2455 case com.android.internal.R.styleable.View_paddingRight:
2456 rightPadding = a.getDimensionPixelSize(attr, -1);
2457 break;
2458 case com.android.internal.R.styleable.View_paddingBottom:
2459 bottomPadding = a.getDimensionPixelSize(attr, -1);
2460 break;
2461 case com.android.internal.R.styleable.View_scrollX:
2462 x = a.getDimensionPixelOffset(attr, 0);
2463 break;
2464 case com.android.internal.R.styleable.View_scrollY:
2465 y = a.getDimensionPixelOffset(attr, 0);
2466 break;
Chet Haase73066682010-11-29 15:55:32 -08002467 case com.android.internal.R.styleable.View_alpha:
2468 setAlpha(a.getFloat(attr, 1f));
2469 break;
2470 case com.android.internal.R.styleable.View_transformPivotX:
2471 setPivotX(a.getDimensionPixelOffset(attr, 0));
2472 break;
2473 case com.android.internal.R.styleable.View_transformPivotY:
2474 setPivotY(a.getDimensionPixelOffset(attr, 0));
2475 break;
2476 case com.android.internal.R.styleable.View_translationX:
2477 tx = a.getDimensionPixelOffset(attr, 0);
2478 transformSet = true;
2479 break;
2480 case com.android.internal.R.styleable.View_translationY:
2481 ty = a.getDimensionPixelOffset(attr, 0);
2482 transformSet = true;
2483 break;
2484 case com.android.internal.R.styleable.View_rotation:
2485 rotation = a.getFloat(attr, 0);
2486 transformSet = true;
2487 break;
2488 case com.android.internal.R.styleable.View_rotationX:
2489 rotationX = a.getFloat(attr, 0);
2490 transformSet = true;
2491 break;
2492 case com.android.internal.R.styleable.View_rotationY:
2493 rotationY = a.getFloat(attr, 0);
2494 transformSet = true;
2495 break;
2496 case com.android.internal.R.styleable.View_scaleX:
2497 sx = a.getFloat(attr, 1f);
2498 transformSet = true;
2499 break;
2500 case com.android.internal.R.styleable.View_scaleY:
2501 sy = a.getFloat(attr, 1f);
2502 transformSet = true;
2503 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002504 case com.android.internal.R.styleable.View_id:
2505 mID = a.getResourceId(attr, NO_ID);
2506 break;
2507 case com.android.internal.R.styleable.View_tag:
2508 mTag = a.getText(attr);
2509 break;
2510 case com.android.internal.R.styleable.View_fitsSystemWindows:
2511 if (a.getBoolean(attr, false)) {
2512 viewFlagValues |= FITS_SYSTEM_WINDOWS;
2513 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
2514 }
2515 break;
2516 case com.android.internal.R.styleable.View_focusable:
2517 if (a.getBoolean(attr, false)) {
2518 viewFlagValues |= FOCUSABLE;
2519 viewFlagMasks |= FOCUSABLE_MASK;
2520 }
2521 break;
2522 case com.android.internal.R.styleable.View_focusableInTouchMode:
2523 if (a.getBoolean(attr, false)) {
2524 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
2525 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
2526 }
2527 break;
2528 case com.android.internal.R.styleable.View_clickable:
2529 if (a.getBoolean(attr, false)) {
2530 viewFlagValues |= CLICKABLE;
2531 viewFlagMasks |= CLICKABLE;
2532 }
2533 break;
2534 case com.android.internal.R.styleable.View_longClickable:
2535 if (a.getBoolean(attr, false)) {
2536 viewFlagValues |= LONG_CLICKABLE;
2537 viewFlagMasks |= LONG_CLICKABLE;
2538 }
2539 break;
2540 case com.android.internal.R.styleable.View_saveEnabled:
2541 if (!a.getBoolean(attr, true)) {
2542 viewFlagValues |= SAVE_DISABLED;
2543 viewFlagMasks |= SAVE_DISABLED_MASK;
2544 }
2545 break;
2546 case com.android.internal.R.styleable.View_duplicateParentState:
2547 if (a.getBoolean(attr, false)) {
2548 viewFlagValues |= DUPLICATE_PARENT_STATE;
2549 viewFlagMasks |= DUPLICATE_PARENT_STATE;
2550 }
2551 break;
2552 case com.android.internal.R.styleable.View_visibility:
2553 final int visibility = a.getInt(attr, 0);
2554 if (visibility != 0) {
2555 viewFlagValues |= VISIBILITY_FLAGS[visibility];
2556 viewFlagMasks |= VISIBILITY_MASK;
2557 }
2558 break;
2559 case com.android.internal.R.styleable.View_drawingCacheQuality:
2560 final int cacheQuality = a.getInt(attr, 0);
2561 if (cacheQuality != 0) {
2562 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
2563 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
2564 }
2565 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07002566 case com.android.internal.R.styleable.View_contentDescription:
2567 mContentDescription = a.getString(attr);
2568 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002569 case com.android.internal.R.styleable.View_soundEffectsEnabled:
2570 if (!a.getBoolean(attr, true)) {
2571 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
2572 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
2573 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002574 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002575 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
2576 if (!a.getBoolean(attr, true)) {
2577 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
2578 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
2579 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002580 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002581 case R.styleable.View_scrollbars:
2582 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
2583 if (scrollbars != SCROLLBARS_NONE) {
2584 viewFlagValues |= scrollbars;
2585 viewFlagMasks |= SCROLLBARS_MASK;
2586 initializeScrollbars(a);
2587 }
2588 break;
2589 case R.styleable.View_fadingEdge:
2590 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
2591 if (fadingEdge != FADING_EDGE_NONE) {
2592 viewFlagValues |= fadingEdge;
2593 viewFlagMasks |= FADING_EDGE_MASK;
2594 initializeFadingEdge(a);
2595 }
2596 break;
2597 case R.styleable.View_scrollbarStyle:
2598 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
2599 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2600 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
2601 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
2602 }
2603 break;
2604 case R.styleable.View_isScrollContainer:
2605 setScrollContainer = true;
2606 if (a.getBoolean(attr, false)) {
2607 setScrollContainer(true);
2608 }
2609 break;
2610 case com.android.internal.R.styleable.View_keepScreenOn:
2611 if (a.getBoolean(attr, false)) {
2612 viewFlagValues |= KEEP_SCREEN_ON;
2613 viewFlagMasks |= KEEP_SCREEN_ON;
2614 }
2615 break;
Jeff Brown85a31762010-09-01 17:01:00 -07002616 case R.styleable.View_filterTouchesWhenObscured:
2617 if (a.getBoolean(attr, false)) {
2618 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED;
2619 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED;
2620 }
2621 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002622 case R.styleable.View_nextFocusLeft:
2623 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
2624 break;
2625 case R.styleable.View_nextFocusRight:
2626 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
2627 break;
2628 case R.styleable.View_nextFocusUp:
2629 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
2630 break;
2631 case R.styleable.View_nextFocusDown:
2632 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
2633 break;
Jeff Brown4e6319b2010-12-13 10:36:51 -08002634 case R.styleable.View_nextFocusForward:
2635 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID);
2636 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002637 case R.styleable.View_minWidth:
2638 mMinWidth = a.getDimensionPixelSize(attr, 0);
2639 break;
2640 case R.styleable.View_minHeight:
2641 mMinHeight = a.getDimensionPixelSize(attr, 0);
2642 break;
Romain Guy9a817362009-05-01 10:57:14 -07002643 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07002644 if (context.isRestricted()) {
Joe Malin32736f02011-01-19 16:14:20 -08002645 throw new IllegalStateException("The android:onClick attribute cannot "
Romain Guy870e09f2009-07-06 16:35:25 -07002646 + "be used within a restricted context");
2647 }
2648
Romain Guy9a817362009-05-01 10:57:14 -07002649 final String handlerName = a.getString(attr);
2650 if (handlerName != null) {
2651 setOnClickListener(new OnClickListener() {
2652 private Method mHandler;
2653
2654 public void onClick(View v) {
2655 if (mHandler == null) {
2656 try {
2657 mHandler = getContext().getClass().getMethod(handlerName,
2658 View.class);
2659 } catch (NoSuchMethodException e) {
Joe Onorato42e14d72010-03-11 14:51:17 -08002660 int id = getId();
2661 String idText = id == NO_ID ? "" : " with id '"
2662 + getContext().getResources().getResourceEntryName(
2663 id) + "'";
Romain Guy9a817362009-05-01 10:57:14 -07002664 throw new IllegalStateException("Could not find a method " +
Joe Onorato42e14d72010-03-11 14:51:17 -08002665 handlerName + "(View) in the activity "
2666 + getContext().getClass() + " for onClick handler"
2667 + " on view " + View.this.getClass() + idText, e);
Romain Guy9a817362009-05-01 10:57:14 -07002668 }
2669 }
2670
2671 try {
2672 mHandler.invoke(getContext(), View.this);
2673 } catch (IllegalAccessException e) {
2674 throw new IllegalStateException("Could not execute non "
2675 + "public method of the activity", e);
2676 } catch (InvocationTargetException e) {
2677 throw new IllegalStateException("Could not execute "
2678 + "method of the activity", e);
2679 }
2680 }
2681 });
2682 }
2683 break;
Adam Powell637d3372010-08-25 14:37:03 -07002684 case R.styleable.View_overScrollMode:
2685 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS);
2686 break;
Adam Powell20232d02010-12-08 21:08:53 -08002687 case R.styleable.View_verticalScrollbarPosition:
2688 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT);
2689 break;
Romain Guy171c5922011-01-06 10:04:23 -08002690 case R.styleable.View_layerType:
2691 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null);
2692 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002693 }
2694 }
2695
Adam Powell637d3372010-08-25 14:37:03 -07002696 setOverScrollMode(overScrollMode);
2697
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002698 if (background != null) {
2699 setBackgroundDrawable(background);
2700 }
2701
2702 if (padding >= 0) {
2703 leftPadding = padding;
2704 topPadding = padding;
2705 rightPadding = padding;
2706 bottomPadding = padding;
2707 }
2708
2709 // If the user specified the padding (either with android:padding or
2710 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
2711 // use the default padding or the padding from the background drawable
2712 // (stored at this point in mPadding*)
2713 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
2714 topPadding >= 0 ? topPadding : mPaddingTop,
2715 rightPadding >= 0 ? rightPadding : mPaddingRight,
2716 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
2717
2718 if (viewFlagMasks != 0) {
2719 setFlags(viewFlagValues, viewFlagMasks);
2720 }
2721
2722 // Needs to be called after mViewFlags is set
2723 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2724 recomputePadding();
2725 }
2726
2727 if (x != 0 || y != 0) {
2728 scrollTo(x, y);
2729 }
2730
Chet Haase73066682010-11-29 15:55:32 -08002731 if (transformSet) {
2732 setTranslationX(tx);
2733 setTranslationY(ty);
2734 setRotation(rotation);
2735 setRotationX(rotationX);
2736 setRotationY(rotationY);
2737 setScaleX(sx);
2738 setScaleY(sy);
2739 }
2740
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002741 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
2742 setScrollContainer(true);
2743 }
Romain Guy8f1344f52009-05-15 16:03:59 -07002744
2745 computeOpaqueFlags();
2746
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002747 a.recycle();
2748 }
2749
2750 /**
2751 * Non-public constructor for use in testing
2752 */
2753 View() {
2754 }
2755
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002756 /**
2757 * <p>
2758 * Initializes the fading edges from a given set of styled attributes. This
2759 * method should be called by subclasses that need fading edges and when an
2760 * instance of these subclasses is created programmatically rather than
2761 * being inflated from XML. This method is automatically called when the XML
2762 * is inflated.
2763 * </p>
2764 *
2765 * @param a the styled attributes set to initialize the fading edges from
2766 */
2767 protected void initializeFadingEdge(TypedArray a) {
2768 initScrollCache();
2769
2770 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
2771 R.styleable.View_fadingEdgeLength,
2772 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
2773 }
2774
2775 /**
2776 * Returns the size of the vertical faded edges used to indicate that more
2777 * content in this view is visible.
2778 *
2779 * @return The size in pixels of the vertical faded edge or 0 if vertical
2780 * faded edges are not enabled for this view.
2781 * @attr ref android.R.styleable#View_fadingEdgeLength
2782 */
2783 public int getVerticalFadingEdgeLength() {
2784 if (isVerticalFadingEdgeEnabled()) {
2785 ScrollabilityCache cache = mScrollCache;
2786 if (cache != null) {
2787 return cache.fadingEdgeLength;
2788 }
2789 }
2790 return 0;
2791 }
2792
2793 /**
2794 * Set the size of the faded edge used to indicate that more content in this
2795 * view is available. Will not change whether the fading edge is enabled; use
2796 * {@link #setVerticalFadingEdgeEnabled} or {@link #setHorizontalFadingEdgeEnabled}
2797 * to enable the fading edge for the vertical or horizontal fading edges.
2798 *
2799 * @param length The size in pixels of the faded edge used to indicate that more
2800 * content in this view is visible.
2801 */
2802 public void setFadingEdgeLength(int length) {
2803 initScrollCache();
2804 mScrollCache.fadingEdgeLength = length;
2805 }
2806
2807 /**
2808 * Returns the size of the horizontal faded edges used to indicate that more
2809 * content in this view is visible.
2810 *
2811 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
2812 * faded edges are not enabled for this view.
2813 * @attr ref android.R.styleable#View_fadingEdgeLength
2814 */
2815 public int getHorizontalFadingEdgeLength() {
2816 if (isHorizontalFadingEdgeEnabled()) {
2817 ScrollabilityCache cache = mScrollCache;
2818 if (cache != null) {
2819 return cache.fadingEdgeLength;
2820 }
2821 }
2822 return 0;
2823 }
2824
2825 /**
2826 * Returns the width of the vertical scrollbar.
2827 *
2828 * @return The width in pixels of the vertical scrollbar or 0 if there
2829 * is no vertical scrollbar.
2830 */
2831 public int getVerticalScrollbarWidth() {
2832 ScrollabilityCache cache = mScrollCache;
2833 if (cache != null) {
2834 ScrollBarDrawable scrollBar = cache.scrollBar;
2835 if (scrollBar != null) {
2836 int size = scrollBar.getSize(true);
2837 if (size <= 0) {
2838 size = cache.scrollBarSize;
2839 }
2840 return size;
2841 }
2842 return 0;
2843 }
2844 return 0;
2845 }
2846
2847 /**
2848 * Returns the height of the horizontal scrollbar.
2849 *
2850 * @return The height in pixels of the horizontal scrollbar or 0 if
2851 * there is no horizontal scrollbar.
2852 */
2853 protected int getHorizontalScrollbarHeight() {
2854 ScrollabilityCache cache = mScrollCache;
2855 if (cache != null) {
2856 ScrollBarDrawable scrollBar = cache.scrollBar;
2857 if (scrollBar != null) {
2858 int size = scrollBar.getSize(false);
2859 if (size <= 0) {
2860 size = cache.scrollBarSize;
2861 }
2862 return size;
2863 }
2864 return 0;
2865 }
2866 return 0;
2867 }
2868
2869 /**
2870 * <p>
2871 * Initializes the scrollbars from a given set of styled attributes. This
2872 * method should be called by subclasses that need scrollbars and when an
2873 * instance of these subclasses is created programmatically rather than
2874 * being inflated from XML. This method is automatically called when the XML
2875 * is inflated.
2876 * </p>
2877 *
2878 * @param a the styled attributes set to initialize the scrollbars from
2879 */
2880 protected void initializeScrollbars(TypedArray a) {
2881 initScrollCache();
2882
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002883 final ScrollabilityCache scrollabilityCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08002884
Mike Cleronf116bf82009-09-27 19:14:12 -07002885 if (scrollabilityCache.scrollBar == null) {
2886 scrollabilityCache.scrollBar = new ScrollBarDrawable();
2887 }
Joe Malin32736f02011-01-19 16:14:20 -08002888
Romain Guy8bda2482010-03-02 11:42:11 -08002889 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002890
Mike Cleronf116bf82009-09-27 19:14:12 -07002891 if (!fadeScrollbars) {
2892 scrollabilityCache.state = ScrollabilityCache.ON;
2893 }
2894 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Joe Malin32736f02011-01-19 16:14:20 -08002895
2896
Mike Cleronf116bf82009-09-27 19:14:12 -07002897 scrollabilityCache.scrollBarFadeDuration = a.getInt(
2898 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
2899 .getScrollBarFadeDuration());
2900 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
2901 R.styleable.View_scrollbarDefaultDelayBeforeFade,
2902 ViewConfiguration.getScrollDefaultDelay());
2903
Joe Malin32736f02011-01-19 16:14:20 -08002904
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002905 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
2906 com.android.internal.R.styleable.View_scrollbarSize,
2907 ViewConfiguration.get(mContext).getScaledScrollBarSize());
2908
2909 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
2910 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
2911
2912 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
2913 if (thumb != null) {
2914 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
2915 }
2916
2917 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
2918 false);
2919 if (alwaysDraw) {
2920 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
2921 }
2922
2923 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
2924 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
2925
2926 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
2927 if (thumb != null) {
2928 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
2929 }
2930
2931 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
2932 false);
2933 if (alwaysDraw) {
2934 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
2935 }
2936
2937 // Re-apply user/background padding so that scrollbar(s) get added
2938 recomputePadding();
2939 }
2940
2941 /**
2942 * <p>
2943 * Initalizes the scrollability cache if necessary.
2944 * </p>
2945 */
2946 private void initScrollCache() {
2947 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07002948 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002949 }
2950 }
2951
2952 /**
Adam Powell20232d02010-12-08 21:08:53 -08002953 * Set the position of the vertical scroll bar. Should be one of
2954 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or
2955 * {@link #SCROLLBAR_POSITION_RIGHT}.
2956 *
2957 * @param position Where the vertical scroll bar should be positioned.
2958 */
2959 public void setVerticalScrollbarPosition(int position) {
2960 if (mVerticalScrollbarPosition != position) {
2961 mVerticalScrollbarPosition = position;
2962 computeOpaqueFlags();
2963 recomputePadding();
2964 }
2965 }
2966
2967 /**
2968 * @return The position where the vertical scroll bar will show, if applicable.
2969 * @see #setVerticalScrollbarPosition(int)
2970 */
2971 public int getVerticalScrollbarPosition() {
2972 return mVerticalScrollbarPosition;
2973 }
2974
2975 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002976 * Register a callback to be invoked when focus of this view changed.
2977 *
2978 * @param l The callback that will run.
2979 */
2980 public void setOnFocusChangeListener(OnFocusChangeListener l) {
2981 mOnFocusChangeListener = l;
2982 }
2983
2984 /**
Chet Haase21cd1382010-09-01 17:42:29 -07002985 * Add a listener that will be called when the bounds of the view change due to
2986 * layout processing.
2987 *
2988 * @param listener The listener that will be called when layout bounds change.
2989 */
2990 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) {
2991 if (mOnLayoutChangeListeners == null) {
2992 mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>();
2993 }
2994 mOnLayoutChangeListeners.add(listener);
2995 }
2996
2997 /**
2998 * Remove a listener for layout changes.
2999 *
3000 * @param listener The listener for layout bounds change.
3001 */
3002 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) {
3003 if (mOnLayoutChangeListeners == null) {
3004 return;
3005 }
3006 mOnLayoutChangeListeners.remove(listener);
3007 }
3008
3009 /**
Adam Powell4afd62b2011-02-18 15:02:18 -08003010 * Add a listener for attach state changes.
3011 *
3012 * This listener will be called whenever this view is attached or detached
3013 * from a window. Remove the listener using
3014 * {@link #removeOnAttachStateChangeListener(OnAttachStateChangeListener)}.
3015 *
3016 * @param listener Listener to attach
3017 * @see #removeOnAttachStateChangeListener(OnAttachStateChangeListener)
3018 */
3019 public void addOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
3020 if (mOnAttachStateChangeListeners == null) {
3021 mOnAttachStateChangeListeners = new CopyOnWriteArrayList<OnAttachStateChangeListener>();
3022 }
3023 mOnAttachStateChangeListeners.add(listener);
3024 }
3025
3026 /**
3027 * Remove a listener for attach state changes. The listener will receive no further
3028 * notification of window attach/detach events.
3029 *
3030 * @param listener Listener to remove
3031 * @see #addOnAttachStateChangeListener(OnAttachStateChangeListener)
3032 */
3033 public void removeOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
3034 if (mOnAttachStateChangeListeners == null) {
3035 return;
3036 }
3037 mOnAttachStateChangeListeners.remove(listener);
3038 }
3039
3040 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003041 * Returns the focus-change callback registered for this view.
3042 *
3043 * @return The callback, or null if one is not registered.
3044 */
3045 public OnFocusChangeListener getOnFocusChangeListener() {
3046 return mOnFocusChangeListener;
3047 }
3048
3049 /**
3050 * Register a callback to be invoked when this view is clicked. If this view is not
3051 * clickable, it becomes clickable.
3052 *
3053 * @param l The callback that will run
3054 *
3055 * @see #setClickable(boolean)
3056 */
3057 public void setOnClickListener(OnClickListener l) {
3058 if (!isClickable()) {
3059 setClickable(true);
3060 }
3061 mOnClickListener = l;
3062 }
3063
3064 /**
3065 * Register a callback to be invoked when this view is clicked and held. If this view is not
3066 * long clickable, it becomes long clickable.
3067 *
3068 * @param l The callback that will run
3069 *
3070 * @see #setLongClickable(boolean)
3071 */
3072 public void setOnLongClickListener(OnLongClickListener l) {
3073 if (!isLongClickable()) {
3074 setLongClickable(true);
3075 }
3076 mOnLongClickListener = l;
3077 }
3078
3079 /**
3080 * Register a callback to be invoked when the context menu for this view is
3081 * being built. If this view is not long clickable, it becomes long clickable.
3082 *
3083 * @param l The callback that will run
3084 *
3085 */
3086 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
3087 if (!isLongClickable()) {
3088 setLongClickable(true);
3089 }
3090 mOnCreateContextMenuListener = l;
3091 }
3092
3093 /**
3094 * Call this view's OnClickListener, if it is defined.
3095 *
3096 * @return True there was an assigned OnClickListener that was called, false
3097 * otherwise is returned.
3098 */
3099 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003100 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
3101
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003102 if (mOnClickListener != null) {
3103 playSoundEffect(SoundEffectConstants.CLICK);
3104 mOnClickListener.onClick(this);
3105 return true;
3106 }
3107
3108 return false;
3109 }
3110
3111 /**
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003112 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the
3113 * OnLongClickListener did not consume the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003114 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003115 * @return True if one of the above receivers consumed the event, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003116 */
3117 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003118 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
3119
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003120 boolean handled = false;
3121 if (mOnLongClickListener != null) {
3122 handled = mOnLongClickListener.onLongClick(View.this);
3123 }
3124 if (!handled) {
3125 handled = showContextMenu();
3126 }
3127 if (handled) {
3128 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
3129 }
3130 return handled;
3131 }
3132
3133 /**
3134 * Bring up the context menu for this view.
3135 *
3136 * @return Whether a context menu was displayed.
3137 */
3138 public boolean showContextMenu() {
3139 return getParent().showContextMenuForChild(this);
3140 }
3141
3142 /**
Adam Powell6e346362010-07-23 10:18:23 -07003143 * Start an action mode.
3144 *
3145 * @param callback Callback that will control the lifecycle of the action mode
3146 * @return The new action mode if it is started, null otherwise
3147 *
3148 * @see ActionMode
3149 */
3150 public ActionMode startActionMode(ActionMode.Callback callback) {
3151 return getParent().startActionModeForChild(this, callback);
3152 }
3153
3154 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003155 * Register a callback to be invoked when a key is pressed in this view.
3156 * @param l the key listener to attach to this view
3157 */
3158 public void setOnKeyListener(OnKeyListener l) {
3159 mOnKeyListener = l;
3160 }
3161
3162 /**
3163 * Register a callback to be invoked when a touch event is sent to this view.
3164 * @param l the touch listener to attach to this view
3165 */
3166 public void setOnTouchListener(OnTouchListener l) {
3167 mOnTouchListener = l;
3168 }
3169
3170 /**
Joe Malin32736f02011-01-19 16:14:20 -08003171 * Register a drag event listener callback object for this View. The parameter is
3172 * an implementation of {@link android.view.View.OnDragListener}. To send a drag event to a
3173 * View, the system calls the
3174 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent)} method.
3175 * @param l An implementation of {@link android.view.View.OnDragListener}.
Chris Tate32affef2010-10-18 15:29:21 -07003176 */
3177 public void setOnDragListener(OnDragListener l) {
3178 mOnDragListener = l;
3179 }
3180
3181 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003182 * Give this view focus. This will cause {@link #onFocusChanged} to be called.
3183 *
3184 * Note: this does not check whether this {@link View} should get focus, it just
3185 * gives it focus no matter what. It should only be called internally by framework
3186 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
3187 *
3188 * @param direction values are View.FOCUS_UP, View.FOCUS_DOWN,
3189 * View.FOCUS_LEFT or View.FOCUS_RIGHT. This is the direction which
3190 * focus moved when requestFocus() is called. It may not always
3191 * apply, in which case use the default View.FOCUS_DOWN.
3192 * @param previouslyFocusedRect The rectangle of the view that had focus
3193 * prior in this View's coordinate system.
3194 */
3195 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
3196 if (DBG) {
3197 System.out.println(this + " requestFocus()");
3198 }
3199
3200 if ((mPrivateFlags & FOCUSED) == 0) {
3201 mPrivateFlags |= FOCUSED;
3202
3203 if (mParent != null) {
3204 mParent.requestChildFocus(this, this);
3205 }
3206
3207 onFocusChanged(true, direction, previouslyFocusedRect);
3208 refreshDrawableState();
3209 }
3210 }
3211
3212 /**
3213 * Request that a rectangle of this view be visible on the screen,
3214 * scrolling if necessary just enough.
3215 *
3216 * <p>A View should call this if it maintains some notion of which part
3217 * of its content is interesting. For example, a text editing view
3218 * should call this when its cursor moves.
3219 *
3220 * @param rectangle The rectangle.
3221 * @return Whether any parent scrolled.
3222 */
3223 public boolean requestRectangleOnScreen(Rect rectangle) {
3224 return requestRectangleOnScreen(rectangle, false);
3225 }
3226
3227 /**
3228 * Request that a rectangle of this view be visible on the screen,
3229 * scrolling if necessary just enough.
3230 *
3231 * <p>A View should call this if it maintains some notion of which part
3232 * of its content is interesting. For example, a text editing view
3233 * should call this when its cursor moves.
3234 *
3235 * <p>When <code>immediate</code> is set to true, scrolling will not be
3236 * animated.
3237 *
3238 * @param rectangle The rectangle.
3239 * @param immediate True to forbid animated scrolling, false otherwise
3240 * @return Whether any parent scrolled.
3241 */
3242 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
3243 View child = this;
3244 ViewParent parent = mParent;
3245 boolean scrolled = false;
3246 while (parent != null) {
3247 scrolled |= parent.requestChildRectangleOnScreen(child,
3248 rectangle, immediate);
3249
3250 // offset rect so next call has the rectangle in the
3251 // coordinate system of its direct child.
3252 rectangle.offset(child.getLeft(), child.getTop());
3253 rectangle.offset(-child.getScrollX(), -child.getScrollY());
3254
3255 if (!(parent instanceof View)) {
3256 break;
3257 }
Romain Guy8506ab42009-06-11 17:35:47 -07003258
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003259 child = (View) parent;
3260 parent = child.getParent();
3261 }
3262 return scrolled;
3263 }
3264
3265 /**
3266 * Called when this view wants to give up focus. This will cause
3267 * {@link #onFocusChanged} to be called.
3268 */
3269 public void clearFocus() {
3270 if (DBG) {
3271 System.out.println(this + " clearFocus()");
3272 }
3273
3274 if ((mPrivateFlags & FOCUSED) != 0) {
3275 mPrivateFlags &= ~FOCUSED;
3276
3277 if (mParent != null) {
3278 mParent.clearChildFocus(this);
3279 }
3280
3281 onFocusChanged(false, 0, null);
3282 refreshDrawableState();
3283 }
3284 }
3285
3286 /**
3287 * Called to clear the focus of a view that is about to be removed.
3288 * Doesn't call clearChildFocus, which prevents this view from taking
3289 * focus again before it has been removed from the parent
3290 */
3291 void clearFocusForRemoval() {
3292 if ((mPrivateFlags & FOCUSED) != 0) {
3293 mPrivateFlags &= ~FOCUSED;
3294
3295 onFocusChanged(false, 0, null);
3296 refreshDrawableState();
3297 }
3298 }
3299
3300 /**
3301 * Called internally by the view system when a new view is getting focus.
3302 * This is what clears the old focus.
3303 */
3304 void unFocus() {
3305 if (DBG) {
3306 System.out.println(this + " unFocus()");
3307 }
3308
3309 if ((mPrivateFlags & FOCUSED) != 0) {
3310 mPrivateFlags &= ~FOCUSED;
3311
3312 onFocusChanged(false, 0, null);
3313 refreshDrawableState();
3314 }
3315 }
3316
3317 /**
3318 * Returns true if this view has focus iteself, or is the ancestor of the
3319 * view that has focus.
3320 *
3321 * @return True if this view has or contains focus, false otherwise.
3322 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003323 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003324 public boolean hasFocus() {
3325 return (mPrivateFlags & FOCUSED) != 0;
3326 }
3327
3328 /**
3329 * Returns true if this view is focusable or if it contains a reachable View
3330 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
3331 * is a View whose parents do not block descendants focus.
3332 *
3333 * Only {@link #VISIBLE} views are considered focusable.
3334 *
3335 * @return True if the view is focusable or if the view contains a focusable
3336 * View, false otherwise.
3337 *
3338 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
3339 */
3340 public boolean hasFocusable() {
3341 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
3342 }
3343
3344 /**
3345 * Called by the view system when the focus state of this view changes.
3346 * When the focus change event is caused by directional navigation, direction
3347 * and previouslyFocusedRect provide insight into where the focus is coming from.
3348 * When overriding, be sure to call up through to the super class so that
3349 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07003350 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003351 * @param gainFocus True if the View has focus; false otherwise.
3352 * @param direction The direction focus has moved when requestFocus()
3353 * is called to give this view focus. Values are
Jeff Brown4e6319b2010-12-13 10:36:51 -08003354 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT},
3355 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}.
3356 * It may not always apply, in which case use the default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003357 * @param previouslyFocusedRect The rectangle, in this view's coordinate
3358 * system, of the previously focused view. If applicable, this will be
3359 * passed in as finer grained information about where the focus is coming
3360 * from (in addition to direction). Will be <code>null</code> otherwise.
3361 */
3362 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07003363 if (gainFocus) {
3364 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
3365 }
3366
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003367 InputMethodManager imm = InputMethodManager.peekInstance();
3368 if (!gainFocus) {
3369 if (isPressed()) {
3370 setPressed(false);
3371 }
3372 if (imm != null && mAttachInfo != null
3373 && mAttachInfo.mHasWindowFocus) {
3374 imm.focusOut(this);
3375 }
Romain Guya2431d02009-04-30 16:30:00 -07003376 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003377 } else if (imm != null && mAttachInfo != null
3378 && mAttachInfo.mHasWindowFocus) {
3379 imm.focusIn(this);
3380 }
Romain Guy8506ab42009-06-11 17:35:47 -07003381
Romain Guy0fd89bf2011-01-26 15:41:30 -08003382 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003383 if (mOnFocusChangeListener != null) {
3384 mOnFocusChangeListener.onFocusChange(this, gainFocus);
3385 }
Joe Malin32736f02011-01-19 16:14:20 -08003386
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07003387 if (mAttachInfo != null) {
3388 mAttachInfo.mKeyDispatchState.reset(this);
3389 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003390 }
3391
3392 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07003393 * {@inheritDoc}
3394 */
3395 public void sendAccessibilityEvent(int eventType) {
3396 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
3397 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
3398 }
3399 }
3400
3401 /**
3402 * {@inheritDoc}
3403 */
3404 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
Svetoslav Ganov9cd1eca2011-01-13 14:24:02 -08003405 if (!isShown()) {
3406 return;
3407 }
svetoslavganov75986cf2009-05-14 22:28:01 -07003408 event.setClassName(getClass().getName());
3409 event.setPackageName(getContext().getPackageName());
3410 event.setEnabled(isEnabled());
3411 event.setContentDescription(mContentDescription);
3412
3413 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) {
3414 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList;
3415 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD, FOCUSABLES_ALL);
3416 event.setItemCount(focusablesTempList.size());
3417 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
3418 focusablesTempList.clear();
3419 }
3420
3421 dispatchPopulateAccessibilityEvent(event);
3422
3423 AccessibilityManager.getInstance(mContext).sendAccessibilityEvent(event);
3424 }
3425
3426 /**
3427 * Dispatches an {@link AccessibilityEvent} to the {@link View} children
3428 * to be populated.
3429 *
3430 * @param event The event.
3431 *
3432 * @return True if the event population was completed.
3433 */
3434 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
3435 return false;
3436 }
3437
3438 /**
3439 * Gets the {@link View} description. It briefly describes the view and is
3440 * primarily used for accessibility support. Set this property to enable
3441 * better accessibility support for your application. This is especially
3442 * true for views that do not have textual representation (For example,
3443 * ImageButton).
3444 *
3445 * @return The content descriptiopn.
3446 *
3447 * @attr ref android.R.styleable#View_contentDescription
3448 */
3449 public CharSequence getContentDescription() {
3450 return mContentDescription;
3451 }
3452
3453 /**
3454 * Sets the {@link View} description. It briefly describes the view and is
3455 * primarily used for accessibility support. Set this property to enable
3456 * better accessibility support for your application. This is especially
3457 * true for views that do not have textual representation (For example,
3458 * ImageButton).
3459 *
3460 * @param contentDescription The content description.
3461 *
3462 * @attr ref android.R.styleable#View_contentDescription
3463 */
3464 public void setContentDescription(CharSequence contentDescription) {
3465 mContentDescription = contentDescription;
3466 }
3467
3468 /**
Romain Guya2431d02009-04-30 16:30:00 -07003469 * Invoked whenever this view loses focus, either by losing window focus or by losing
3470 * focus within its window. This method can be used to clear any state tied to the
3471 * focus. For instance, if a button is held pressed with the trackball and the window
3472 * loses focus, this method can be used to cancel the press.
3473 *
3474 * Subclasses of View overriding this method should always call super.onFocusLost().
3475 *
3476 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07003477 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07003478 *
3479 * @hide pending API council approval
3480 */
3481 protected void onFocusLost() {
3482 resetPressedState();
3483 }
3484
3485 private void resetPressedState() {
3486 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
3487 return;
3488 }
3489
3490 if (isPressed()) {
3491 setPressed(false);
3492
3493 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05003494 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07003495 }
3496 }
3497 }
3498
3499 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003500 * Returns true if this view has focus
3501 *
3502 * @return True if this view has focus, false otherwise.
3503 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003504 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003505 public boolean isFocused() {
3506 return (mPrivateFlags & FOCUSED) != 0;
3507 }
3508
3509 /**
3510 * Find the view in the hierarchy rooted at this view that currently has
3511 * focus.
3512 *
3513 * @return The view that currently has focus, or null if no focused view can
3514 * be found.
3515 */
3516 public View findFocus() {
3517 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
3518 }
3519
3520 /**
3521 * Change whether this view is one of the set of scrollable containers in
3522 * its window. This will be used to determine whether the window can
3523 * resize or must pan when a soft input area is open -- scrollable
3524 * containers allow the window to use resize mode since the container
3525 * will appropriately shrink.
3526 */
3527 public void setScrollContainer(boolean isScrollContainer) {
3528 if (isScrollContainer) {
3529 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
3530 mAttachInfo.mScrollContainers.add(this);
3531 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
3532 }
3533 mPrivateFlags |= SCROLL_CONTAINER;
3534 } else {
3535 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
3536 mAttachInfo.mScrollContainers.remove(this);
3537 }
3538 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
3539 }
3540 }
3541
3542 /**
3543 * Returns the quality of the drawing cache.
3544 *
3545 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3546 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3547 *
3548 * @see #setDrawingCacheQuality(int)
3549 * @see #setDrawingCacheEnabled(boolean)
3550 * @see #isDrawingCacheEnabled()
3551 *
3552 * @attr ref android.R.styleable#View_drawingCacheQuality
3553 */
3554 public int getDrawingCacheQuality() {
3555 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
3556 }
3557
3558 /**
3559 * Set the drawing cache quality of this view. This value is used only when the
3560 * drawing cache is enabled
3561 *
3562 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
3563 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
3564 *
3565 * @see #getDrawingCacheQuality()
3566 * @see #setDrawingCacheEnabled(boolean)
3567 * @see #isDrawingCacheEnabled()
3568 *
3569 * @attr ref android.R.styleable#View_drawingCacheQuality
3570 */
3571 public void setDrawingCacheQuality(int quality) {
3572 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
3573 }
3574
3575 /**
3576 * Returns whether the screen should remain on, corresponding to the current
3577 * value of {@link #KEEP_SCREEN_ON}.
3578 *
3579 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
3580 *
3581 * @see #setKeepScreenOn(boolean)
3582 *
3583 * @attr ref android.R.styleable#View_keepScreenOn
3584 */
3585 public boolean getKeepScreenOn() {
3586 return (mViewFlags & KEEP_SCREEN_ON) != 0;
3587 }
3588
3589 /**
3590 * Controls whether the screen should remain on, modifying the
3591 * value of {@link #KEEP_SCREEN_ON}.
3592 *
3593 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
3594 *
3595 * @see #getKeepScreenOn()
3596 *
3597 * @attr ref android.R.styleable#View_keepScreenOn
3598 */
3599 public void setKeepScreenOn(boolean keepScreenOn) {
3600 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
3601 }
3602
3603 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003604 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
3605 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003606 *
3607 * @attr ref android.R.styleable#View_nextFocusLeft
3608 */
3609 public int getNextFocusLeftId() {
3610 return mNextFocusLeftId;
3611 }
3612
3613 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003614 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
3615 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
3616 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003617 *
3618 * @attr ref android.R.styleable#View_nextFocusLeft
3619 */
3620 public void setNextFocusLeftId(int nextFocusLeftId) {
3621 mNextFocusLeftId = nextFocusLeftId;
3622 }
3623
3624 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003625 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
3626 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003627 *
3628 * @attr ref android.R.styleable#View_nextFocusRight
3629 */
3630 public int getNextFocusRightId() {
3631 return mNextFocusRightId;
3632 }
3633
3634 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003635 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
3636 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
3637 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003638 *
3639 * @attr ref android.R.styleable#View_nextFocusRight
3640 */
3641 public void setNextFocusRightId(int nextFocusRightId) {
3642 mNextFocusRightId = nextFocusRightId;
3643 }
3644
3645 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003646 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
3647 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003648 *
3649 * @attr ref android.R.styleable#View_nextFocusUp
3650 */
3651 public int getNextFocusUpId() {
3652 return mNextFocusUpId;
3653 }
3654
3655 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003656 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
3657 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
3658 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003659 *
3660 * @attr ref android.R.styleable#View_nextFocusUp
3661 */
3662 public void setNextFocusUpId(int nextFocusUpId) {
3663 mNextFocusUpId = nextFocusUpId;
3664 }
3665
3666 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003667 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
3668 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003669 *
3670 * @attr ref android.R.styleable#View_nextFocusDown
3671 */
3672 public int getNextFocusDownId() {
3673 return mNextFocusDownId;
3674 }
3675
3676 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003677 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
3678 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
3679 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003680 *
3681 * @attr ref android.R.styleable#View_nextFocusDown
3682 */
3683 public void setNextFocusDownId(int nextFocusDownId) {
3684 mNextFocusDownId = nextFocusDownId;
3685 }
3686
3687 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08003688 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
3689 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
3690 *
3691 * @attr ref android.R.styleable#View_nextFocusForward
3692 */
3693 public int getNextFocusForwardId() {
3694 return mNextFocusForwardId;
3695 }
3696
3697 /**
3698 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
3699 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
3700 * decide automatically.
3701 *
3702 * @attr ref android.R.styleable#View_nextFocusForward
3703 */
3704 public void setNextFocusForwardId(int nextFocusForwardId) {
3705 mNextFocusForwardId = nextFocusForwardId;
3706 }
3707
3708 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003709 * Returns the visibility of this view and all of its ancestors
3710 *
3711 * @return True if this view and all of its ancestors are {@link #VISIBLE}
3712 */
3713 public boolean isShown() {
3714 View current = this;
3715 //noinspection ConstantConditions
3716 do {
3717 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
3718 return false;
3719 }
3720 ViewParent parent = current.mParent;
3721 if (parent == null) {
3722 return false; // We are not attached to the view root
3723 }
3724 if (!(parent instanceof View)) {
3725 return true;
3726 }
3727 current = (View) parent;
3728 } while (current != null);
3729
3730 return false;
3731 }
3732
3733 /**
3734 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag
3735 * is set
3736 *
3737 * @param insets Insets for system windows
3738 *
3739 * @return True if this view applied the insets, false otherwise
3740 */
3741 protected boolean fitSystemWindows(Rect insets) {
3742 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
3743 mPaddingLeft = insets.left;
3744 mPaddingTop = insets.top;
3745 mPaddingRight = insets.right;
3746 mPaddingBottom = insets.bottom;
3747 requestLayout();
3748 return true;
3749 }
3750 return false;
3751 }
3752
3753 /**
3754 * Returns the visibility status for this view.
3755 *
3756 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3757 * @attr ref android.R.styleable#View_visibility
3758 */
3759 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07003760 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
3761 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
3762 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003763 })
3764 public int getVisibility() {
3765 return mViewFlags & VISIBILITY_MASK;
3766 }
3767
3768 /**
3769 * Set the enabled state of this view.
3770 *
3771 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
3772 * @attr ref android.R.styleable#View_visibility
3773 */
3774 @RemotableViewMethod
3775 public void setVisibility(int visibility) {
3776 setFlags(visibility, VISIBILITY_MASK);
3777 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false);
3778 }
3779
3780 /**
3781 * Returns the enabled status for this view. The interpretation of the
3782 * enabled state varies by subclass.
3783 *
3784 * @return True if this view is enabled, false otherwise.
3785 */
3786 @ViewDebug.ExportedProperty
3787 public boolean isEnabled() {
3788 return (mViewFlags & ENABLED_MASK) == ENABLED;
3789 }
3790
3791 /**
3792 * Set the enabled state of this view. The interpretation of the enabled
3793 * state varies by subclass.
3794 *
3795 * @param enabled True if this view is enabled, false otherwise.
3796 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08003797 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003798 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07003799 if (enabled == isEnabled()) return;
3800
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003801 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
3802
3803 /*
3804 * The View most likely has to change its appearance, so refresh
3805 * the drawable state.
3806 */
3807 refreshDrawableState();
3808
3809 // Invalidate too, since the default behavior for views is to be
3810 // be drawn at 50% alpha rather than to change the drawable.
Romain Guy0fd89bf2011-01-26 15:41:30 -08003811 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003812 }
3813
3814 /**
3815 * Set whether this view can receive the focus.
3816 *
3817 * Setting this to false will also ensure that this view is not focusable
3818 * in touch mode.
3819 *
3820 * @param focusable If true, this view can receive the focus.
3821 *
3822 * @see #setFocusableInTouchMode(boolean)
3823 * @attr ref android.R.styleable#View_focusable
3824 */
3825 public void setFocusable(boolean focusable) {
3826 if (!focusable) {
3827 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
3828 }
3829 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
3830 }
3831
3832 /**
3833 * Set whether this view can receive focus while in touch mode.
3834 *
3835 * Setting this to true will also ensure that this view is focusable.
3836 *
3837 * @param focusableInTouchMode If true, this view can receive the focus while
3838 * in touch mode.
3839 *
3840 * @see #setFocusable(boolean)
3841 * @attr ref android.R.styleable#View_focusableInTouchMode
3842 */
3843 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
3844 // Focusable in touch mode should always be set before the focusable flag
3845 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
3846 // which, in touch mode, will not successfully request focus on this view
3847 // because the focusable in touch mode flag is not set
3848 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
3849 if (focusableInTouchMode) {
3850 setFlags(FOCUSABLE, FOCUSABLE_MASK);
3851 }
3852 }
3853
3854 /**
3855 * Set whether this view should have sound effects enabled for events such as
3856 * clicking and touching.
3857 *
3858 * <p>You may wish to disable sound effects for a view if you already play sounds,
3859 * for instance, a dial key that plays dtmf tones.
3860 *
3861 * @param soundEffectsEnabled whether sound effects are enabled for this view.
3862 * @see #isSoundEffectsEnabled()
3863 * @see #playSoundEffect(int)
3864 * @attr ref android.R.styleable#View_soundEffectsEnabled
3865 */
3866 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
3867 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
3868 }
3869
3870 /**
3871 * @return whether this view should have sound effects enabled for events such as
3872 * clicking and touching.
3873 *
3874 * @see #setSoundEffectsEnabled(boolean)
3875 * @see #playSoundEffect(int)
3876 * @attr ref android.R.styleable#View_soundEffectsEnabled
3877 */
3878 @ViewDebug.ExportedProperty
3879 public boolean isSoundEffectsEnabled() {
3880 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
3881 }
3882
3883 /**
3884 * Set whether this view should have haptic feedback for events such as
3885 * long presses.
3886 *
3887 * <p>You may wish to disable haptic feedback if your view already controls
3888 * its own haptic feedback.
3889 *
3890 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
3891 * @see #isHapticFeedbackEnabled()
3892 * @see #performHapticFeedback(int)
3893 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3894 */
3895 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
3896 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
3897 }
3898
3899 /**
3900 * @return whether this view should have haptic feedback enabled for events
3901 * long presses.
3902 *
3903 * @see #setHapticFeedbackEnabled(boolean)
3904 * @see #performHapticFeedback(int)
3905 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
3906 */
3907 @ViewDebug.ExportedProperty
3908 public boolean isHapticFeedbackEnabled() {
3909 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
3910 }
3911
3912 /**
3913 * If this view doesn't do any drawing on its own, set this flag to
3914 * allow further optimizations. By default, this flag is not set on
3915 * View, but could be set on some View subclasses such as ViewGroup.
3916 *
3917 * Typically, if you override {@link #onDraw} you should clear this flag.
3918 *
3919 * @param willNotDraw whether or not this View draw on its own
3920 */
3921 public void setWillNotDraw(boolean willNotDraw) {
3922 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
3923 }
3924
3925 /**
3926 * Returns whether or not this View draws on its own.
3927 *
3928 * @return true if this view has nothing to draw, false otherwise
3929 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003930 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003931 public boolean willNotDraw() {
3932 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
3933 }
3934
3935 /**
3936 * When a View's drawing cache is enabled, drawing is redirected to an
3937 * offscreen bitmap. Some views, like an ImageView, must be able to
3938 * bypass this mechanism if they already draw a single bitmap, to avoid
3939 * unnecessary usage of the memory.
3940 *
3941 * @param willNotCacheDrawing true if this view does not cache its
3942 * drawing, false otherwise
3943 */
3944 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
3945 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
3946 }
3947
3948 /**
3949 * Returns whether or not this View can cache its drawing or not.
3950 *
3951 * @return true if this view does not cache its drawing, false otherwise
3952 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003953 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003954 public boolean willNotCacheDrawing() {
3955 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
3956 }
3957
3958 /**
3959 * Indicates whether this view reacts to click events or not.
3960 *
3961 * @return true if the view is clickable, false otherwise
3962 *
3963 * @see #setClickable(boolean)
3964 * @attr ref android.R.styleable#View_clickable
3965 */
3966 @ViewDebug.ExportedProperty
3967 public boolean isClickable() {
3968 return (mViewFlags & CLICKABLE) == CLICKABLE;
3969 }
3970
3971 /**
3972 * Enables or disables click events for this view. When a view
3973 * is clickable it will change its state to "pressed" on every click.
3974 * Subclasses should set the view clickable to visually react to
3975 * user's clicks.
3976 *
3977 * @param clickable true to make the view clickable, false otherwise
3978 *
3979 * @see #isClickable()
3980 * @attr ref android.R.styleable#View_clickable
3981 */
3982 public void setClickable(boolean clickable) {
3983 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
3984 }
3985
3986 /**
3987 * Indicates whether this view reacts to long click events or not.
3988 *
3989 * @return true if the view is long clickable, false otherwise
3990 *
3991 * @see #setLongClickable(boolean)
3992 * @attr ref android.R.styleable#View_longClickable
3993 */
3994 public boolean isLongClickable() {
3995 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
3996 }
3997
3998 /**
3999 * Enables or disables long click events for this view. When a view is long
4000 * clickable it reacts to the user holding down the button for a longer
4001 * duration than a tap. This event can either launch the listener or a
4002 * context menu.
4003 *
4004 * @param longClickable true to make the view long clickable, false otherwise
4005 * @see #isLongClickable()
4006 * @attr ref android.R.styleable#View_longClickable
4007 */
4008 public void setLongClickable(boolean longClickable) {
4009 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
4010 }
4011
4012 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07004013 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004014 *
4015 * @see #isClickable()
4016 * @see #setClickable(boolean)
4017 *
4018 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
4019 * the View's internal state from a previously set "pressed" state.
4020 */
4021 public void setPressed(boolean pressed) {
4022 if (pressed) {
4023 mPrivateFlags |= PRESSED;
4024 } else {
4025 mPrivateFlags &= ~PRESSED;
4026 }
4027 refreshDrawableState();
4028 dispatchSetPressed(pressed);
4029 }
4030
4031 /**
4032 * Dispatch setPressed to all of this View's children.
4033 *
4034 * @see #setPressed(boolean)
4035 *
4036 * @param pressed The new pressed state
4037 */
4038 protected void dispatchSetPressed(boolean pressed) {
4039 }
4040
4041 /**
4042 * Indicates whether the view is currently in pressed state. Unless
4043 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
4044 * the pressed state.
4045 *
4046 * @see #setPressed
4047 * @see #isClickable()
4048 * @see #setClickable(boolean)
4049 *
4050 * @return true if the view is currently pressed, false otherwise
4051 */
4052 public boolean isPressed() {
4053 return (mPrivateFlags & PRESSED) == PRESSED;
4054 }
4055
4056 /**
4057 * Indicates whether this view will save its state (that is,
4058 * whether its {@link #onSaveInstanceState} method will be called).
4059 *
4060 * @return Returns true if the view state saving is enabled, else false.
4061 *
4062 * @see #setSaveEnabled(boolean)
4063 * @attr ref android.R.styleable#View_saveEnabled
4064 */
4065 public boolean isSaveEnabled() {
4066 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
4067 }
4068
4069 /**
4070 * Controls whether the saving of this view's state is
4071 * enabled (that is, whether its {@link #onSaveInstanceState} method
4072 * will be called). Note that even if freezing is enabled, the
4073 * view still must have an id assigned to it (via {@link #setId setId()})
4074 * for its state to be saved. This flag can only disable the
4075 * saving of this view; any child views may still have their state saved.
4076 *
4077 * @param enabled Set to false to <em>disable</em> state saving, or true
4078 * (the default) to allow it.
4079 *
4080 * @see #isSaveEnabled()
4081 * @see #setId(int)
4082 * @see #onSaveInstanceState()
4083 * @attr ref android.R.styleable#View_saveEnabled
4084 */
4085 public void setSaveEnabled(boolean enabled) {
4086 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
4087 }
4088
Jeff Brown85a31762010-09-01 17:01:00 -07004089 /**
4090 * Gets whether the framework should discard touches when the view's
4091 * window is obscured by another visible window.
4092 * Refer to the {@link View} security documentation for more details.
4093 *
4094 * @return True if touch filtering is enabled.
4095 *
4096 * @see #setFilterTouchesWhenObscured(boolean)
4097 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
4098 */
4099 @ViewDebug.ExportedProperty
4100 public boolean getFilterTouchesWhenObscured() {
4101 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
4102 }
4103
4104 /**
4105 * Sets whether the framework should discard touches when the view's
4106 * window is obscured by another visible window.
4107 * Refer to the {@link View} security documentation for more details.
4108 *
4109 * @param enabled True if touch filtering should be enabled.
4110 *
4111 * @see #getFilterTouchesWhenObscured
4112 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
4113 */
4114 public void setFilterTouchesWhenObscured(boolean enabled) {
4115 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
4116 FILTER_TOUCHES_WHEN_OBSCURED);
4117 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004118
4119 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004120 * Indicates whether the entire hierarchy under this view will save its
4121 * state when a state saving traversal occurs from its parent. The default
4122 * is true; if false, these views will not be saved unless
4123 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4124 *
4125 * @return Returns true if the view state saving from parent is enabled, else false.
4126 *
4127 * @see #setSaveFromParentEnabled(boolean)
4128 */
4129 public boolean isSaveFromParentEnabled() {
4130 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
4131 }
4132
4133 /**
4134 * Controls whether the entire hierarchy under this view will save its
4135 * state when a state saving traversal occurs from its parent. The default
4136 * is true; if false, these views will not be saved unless
4137 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4138 *
4139 * @param enabled Set to false to <em>disable</em> state saving, or true
4140 * (the default) to allow it.
4141 *
4142 * @see #isSaveFromParentEnabled()
4143 * @see #setId(int)
4144 * @see #onSaveInstanceState()
4145 */
4146 public void setSaveFromParentEnabled(boolean enabled) {
4147 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
4148 }
4149
4150
4151 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004152 * Returns whether this View is able to take focus.
4153 *
4154 * @return True if this view can take focus, or false otherwise.
4155 * @attr ref android.R.styleable#View_focusable
4156 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004157 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004158 public final boolean isFocusable() {
4159 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
4160 }
4161
4162 /**
4163 * When a view is focusable, it may not want to take focus when in touch mode.
4164 * For example, a button would like focus when the user is navigating via a D-pad
4165 * so that the user can click on it, but once the user starts touching the screen,
4166 * the button shouldn't take focus
4167 * @return Whether the view is focusable in touch mode.
4168 * @attr ref android.R.styleable#View_focusableInTouchMode
4169 */
4170 @ViewDebug.ExportedProperty
4171 public final boolean isFocusableInTouchMode() {
4172 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
4173 }
4174
4175 /**
4176 * Find the nearest view in the specified direction that can take focus.
4177 * This does not actually give focus to that view.
4178 *
4179 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4180 *
4181 * @return The nearest focusable in the specified direction, or null if none
4182 * can be found.
4183 */
4184 public View focusSearch(int direction) {
4185 if (mParent != null) {
4186 return mParent.focusSearch(this, direction);
4187 } else {
4188 return null;
4189 }
4190 }
4191
4192 /**
4193 * This method is the last chance for the focused view and its ancestors to
4194 * respond to an arrow key. This is called when the focused view did not
4195 * consume the key internally, nor could the view system find a new view in
4196 * the requested direction to give focus to.
4197 *
4198 * @param focused The currently focused view.
4199 * @param direction The direction focus wants to move. One of FOCUS_UP,
4200 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
4201 * @return True if the this view consumed this unhandled move.
4202 */
4203 public boolean dispatchUnhandledMove(View focused, int direction) {
4204 return false;
4205 }
4206
4207 /**
4208 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08004209 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004210 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08004211 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
4212 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004213 * @return The user specified next view, or null if there is none.
4214 */
4215 View findUserSetNextFocus(View root, int direction) {
4216 switch (direction) {
4217 case FOCUS_LEFT:
4218 if (mNextFocusLeftId == View.NO_ID) return null;
4219 return findViewShouldExist(root, mNextFocusLeftId);
4220 case FOCUS_RIGHT:
4221 if (mNextFocusRightId == View.NO_ID) return null;
4222 return findViewShouldExist(root, mNextFocusRightId);
4223 case FOCUS_UP:
4224 if (mNextFocusUpId == View.NO_ID) return null;
4225 return findViewShouldExist(root, mNextFocusUpId);
4226 case FOCUS_DOWN:
4227 if (mNextFocusDownId == View.NO_ID) return null;
4228 return findViewShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08004229 case FOCUS_FORWARD:
4230 if (mNextFocusForwardId == View.NO_ID) return null;
4231 return findViewShouldExist(root, mNextFocusForwardId);
4232 case FOCUS_BACKWARD: {
4233 final int id = mID;
4234 return root.findViewByPredicate(new Predicate<View>() {
4235 @Override
4236 public boolean apply(View t) {
4237 return t.mNextFocusForwardId == id;
4238 }
4239 });
4240 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004241 }
4242 return null;
4243 }
4244
4245 private static View findViewShouldExist(View root, int childViewId) {
4246 View result = root.findViewById(childViewId);
4247 if (result == null) {
4248 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
4249 + "by user for id " + childViewId);
4250 }
4251 return result;
4252 }
4253
4254 /**
4255 * Find and return all focusable views that are descendants of this view,
4256 * possibly including this view if it is focusable itself.
4257 *
4258 * @param direction The direction of the focus
4259 * @return A list of focusable views
4260 */
4261 public ArrayList<View> getFocusables(int direction) {
4262 ArrayList<View> result = new ArrayList<View>(24);
4263 addFocusables(result, direction);
4264 return result;
4265 }
4266
4267 /**
4268 * Add any focusable views that are descendants of this view (possibly
4269 * including this view if it is focusable itself) to views. If we are in touch mode,
4270 * only add views that are also focusable in touch mode.
4271 *
4272 * @param views Focusable views found so far
4273 * @param direction The direction of the focus
4274 */
4275 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004276 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
4277 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004278
svetoslavganov75986cf2009-05-14 22:28:01 -07004279 /**
4280 * Adds any focusable views that are descendants of this view (possibly
4281 * including this view if it is focusable itself) to views. This method
4282 * adds all focusable views regardless if we are in touch mode or
4283 * only views focusable in touch mode if we are in touch mode depending on
4284 * the focusable mode paramater.
4285 *
4286 * @param views Focusable views found so far or null if all we are interested is
4287 * the number of focusables.
4288 * @param direction The direction of the focus.
4289 * @param focusableMode The type of focusables to be added.
4290 *
4291 * @see #FOCUSABLES_ALL
4292 * @see #FOCUSABLES_TOUCH_MODE
4293 */
4294 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
4295 if (!isFocusable()) {
4296 return;
4297 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004298
svetoslavganov75986cf2009-05-14 22:28:01 -07004299 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE &&
4300 isInTouchMode() && !isFocusableInTouchMode()) {
4301 return;
4302 }
4303
4304 if (views != null) {
4305 views.add(this);
4306 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004307 }
4308
4309 /**
4310 * Find and return all touchable views that are descendants of this view,
4311 * possibly including this view if it is touchable itself.
4312 *
4313 * @return A list of touchable views
4314 */
4315 public ArrayList<View> getTouchables() {
4316 ArrayList<View> result = new ArrayList<View>();
4317 addTouchables(result);
4318 return result;
4319 }
4320
4321 /**
4322 * Add any touchable views that are descendants of this view (possibly
4323 * including this view if it is touchable itself) to views.
4324 *
4325 * @param views Touchable views found so far
4326 */
4327 public void addTouchables(ArrayList<View> views) {
4328 final int viewFlags = mViewFlags;
4329
4330 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
4331 && (viewFlags & ENABLED_MASK) == ENABLED) {
4332 views.add(this);
4333 }
4334 }
4335
4336 /**
4337 * Call this to try to give focus to a specific view or to one of its
4338 * descendants.
4339 *
4340 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4341 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4342 * while the device is in touch mode.
4343 *
4344 * See also {@link #focusSearch}, which is what you call to say that you
4345 * have focus, and you want your parent to look for the next one.
4346 *
4347 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
4348 * {@link #FOCUS_DOWN} and <code>null</code>.
4349 *
4350 * @return Whether this view or one of its descendants actually took focus.
4351 */
4352 public final boolean requestFocus() {
4353 return requestFocus(View.FOCUS_DOWN);
4354 }
4355
4356
4357 /**
4358 * Call this to try to give focus to a specific view or to one of its
4359 * descendants and give it a hint about what direction focus is heading.
4360 *
4361 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4362 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4363 * while the device is in touch mode.
4364 *
4365 * See also {@link #focusSearch}, which is what you call to say that you
4366 * have focus, and you want your parent to look for the next one.
4367 *
4368 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
4369 * <code>null</code> set for the previously focused rectangle.
4370 *
4371 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4372 * @return Whether this view or one of its descendants actually took focus.
4373 */
4374 public final boolean requestFocus(int direction) {
4375 return requestFocus(direction, null);
4376 }
4377
4378 /**
4379 * Call this to try to give focus to a specific view or to one of its descendants
4380 * and give it hints about the direction and a specific rectangle that the focus
4381 * is coming from. The rectangle can help give larger views a finer grained hint
4382 * about where focus is coming from, and therefore, where to show selection, or
4383 * forward focus change internally.
4384 *
4385 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns false),
4386 * or if it is focusable and it is not focusable in touch mode ({@link #isFocusableInTouchMode})
4387 * while the device is in touch mode.
4388 *
4389 * A View will not take focus if it is not visible.
4390 *
4391 * A View will not take focus if one of its parents has {@link android.view.ViewGroup#getDescendantFocusability()}
4392 * equal to {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
4393 *
4394 * See also {@link #focusSearch}, which is what you call to say that you
4395 * have focus, and you want your parent to look for the next one.
4396 *
4397 * You may wish to override this method if your custom {@link View} has an internal
4398 * {@link View} that it wishes to forward the request to.
4399 *
4400 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4401 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
4402 * to give a finer grained hint about where focus is coming from. May be null
4403 * if there is no hint.
4404 * @return Whether this view or one of its descendants actually took focus.
4405 */
4406 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
4407 // need to be focusable
4408 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
4409 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
4410 return false;
4411 }
4412
4413 // need to be focusable in touch mode if in touch mode
4414 if (isInTouchMode() &&
4415 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
4416 return false;
4417 }
4418
4419 // need to not have any parents blocking us
4420 if (hasAncestorThatBlocksDescendantFocus()) {
4421 return false;
4422 }
4423
4424 handleFocusGainInternal(direction, previouslyFocusedRect);
4425 return true;
4426 }
4427
Christopher Tate2c095f32010-10-04 14:13:40 -07004428 /** Gets the ViewRoot, or null if not attached. */
4429 /*package*/ ViewRoot getViewRoot() {
4430 View root = getRootView();
4431 return root != null ? (ViewRoot)root.getParent() : null;
4432 }
4433
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004434 /**
4435 * Call this to try to give focus to a specific view or to one of its descendants. This is a
4436 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
4437 * touch mode to request focus when they are touched.
4438 *
4439 * @return Whether this view or one of its descendants actually took focus.
4440 *
4441 * @see #isInTouchMode()
4442 *
4443 */
4444 public final boolean requestFocusFromTouch() {
4445 // Leave touch mode if we need to
4446 if (isInTouchMode()) {
Christopher Tate2c095f32010-10-04 14:13:40 -07004447 ViewRoot viewRoot = getViewRoot();
4448 if (viewRoot != null) {
4449 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004450 }
4451 }
4452 return requestFocus(View.FOCUS_DOWN);
4453 }
4454
4455 /**
4456 * @return Whether any ancestor of this view blocks descendant focus.
4457 */
4458 private boolean hasAncestorThatBlocksDescendantFocus() {
4459 ViewParent ancestor = mParent;
4460 while (ancestor instanceof ViewGroup) {
4461 final ViewGroup vgAncestor = (ViewGroup) ancestor;
4462 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
4463 return true;
4464 } else {
4465 ancestor = vgAncestor.getParent();
4466 }
4467 }
4468 return false;
4469 }
4470
4471 /**
Romain Guya440b002010-02-24 15:57:54 -08004472 * @hide
4473 */
4474 public void dispatchStartTemporaryDetach() {
4475 onStartTemporaryDetach();
4476 }
4477
4478 /**
4479 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004480 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
4481 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08004482 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004483 */
4484 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08004485 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08004486 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08004487 }
4488
4489 /**
4490 * @hide
4491 */
4492 public void dispatchFinishTemporaryDetach() {
4493 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004494 }
Romain Guy8506ab42009-06-11 17:35:47 -07004495
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004496 /**
4497 * Called after {@link #onStartTemporaryDetach} when the container is done
4498 * changing the view.
4499 */
4500 public void onFinishTemporaryDetach() {
4501 }
Romain Guy8506ab42009-06-11 17:35:47 -07004502
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004503 /**
4504 * capture information of this view for later analysis: developement only
4505 * check dynamic switch to make sure we only dump view
4506 * when ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW) is set
4507 */
4508 private static void captureViewInfo(String subTag, View v) {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07004509 if (v == null || SystemProperties.getInt(ViewDebug.SYSTEM_PROPERTY_CAPTURE_VIEW, 0) == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004510 return;
4511 }
4512 ViewDebug.dumpCapturedView(subTag, v);
4513 }
4514
4515 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004516 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
4517 * for this view's window. Returns null if the view is not currently attached
4518 * to the window. Normally you will not need to use this directly, but
4519 * just use the standard high-level event callbacks like {@link #onKeyDown}.
4520 */
4521 public KeyEvent.DispatcherState getKeyDispatcherState() {
4522 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
4523 }
Joe Malin32736f02011-01-19 16:14:20 -08004524
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004525 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004526 * Dispatch a key event before it is processed by any input method
4527 * associated with the view hierarchy. This can be used to intercept
4528 * key events in special situations before the IME consumes them; a
4529 * typical example would be handling the BACK key to update the application's
4530 * UI instead of allowing the IME to see it and close itself.
4531 *
4532 * @param event The key event to be dispatched.
4533 * @return True if the event was handled, false otherwise.
4534 */
4535 public boolean dispatchKeyEventPreIme(KeyEvent event) {
4536 return onKeyPreIme(event.getKeyCode(), event);
4537 }
4538
4539 /**
4540 * Dispatch a key event to the next view on the focus path. This path runs
4541 * from the top of the view tree down to the currently focused view. If this
4542 * view has focus, it will dispatch to itself. Otherwise it will dispatch
4543 * the next node down the focus path. This method also fires any key
4544 * listeners.
4545 *
4546 * @param event The key event to be dispatched.
4547 * @return True if the event was handled, false otherwise.
4548 */
4549 public boolean dispatchKeyEvent(KeyEvent event) {
4550 // If any attached key listener a first crack at the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004551
Romain Guyf607bdc2010-09-10 19:20:06 -07004552 //noinspection SimplifiableIfStatement,deprecation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004553 if (android.util.Config.LOGV) {
4554 captureViewInfo("captureViewKeyEvent", this);
4555 }
4556
Romain Guyf607bdc2010-09-10 19:20:06 -07004557 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004558 if (mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
4559 && mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
4560 return true;
4561 }
4562
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004563 return event.dispatch(this, mAttachInfo != null
4564 ? mAttachInfo.mKeyDispatchState : null, this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004565 }
4566
4567 /**
4568 * Dispatches a key shortcut event.
4569 *
4570 * @param event The key event to be dispatched.
4571 * @return True if the event was handled by the view, false otherwise.
4572 */
4573 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
4574 return onKeyShortcut(event.getKeyCode(), event);
4575 }
4576
4577 /**
4578 * Pass the touch screen motion event down to the target view, or this
4579 * view if it is the target.
4580 *
4581 * @param event The motion event to be dispatched.
4582 * @return True if the event was handled by the view, false otherwise.
4583 */
4584 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown85a31762010-09-01 17:01:00 -07004585 if (!onFilterTouchEventForSecurity(event)) {
4586 return false;
4587 }
4588
Romain Guyf607bdc2010-09-10 19:20:06 -07004589 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004590 if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED &&
4591 mOnTouchListener.onTouch(this, event)) {
4592 return true;
4593 }
4594 return onTouchEvent(event);
4595 }
4596
4597 /**
Jeff Brown85a31762010-09-01 17:01:00 -07004598 * Filter the touch event to apply security policies.
4599 *
4600 * @param event The motion event to be filtered.
4601 * @return True if the event should be dispatched, false if the event should be dropped.
Joe Malin32736f02011-01-19 16:14:20 -08004602 *
Jeff Brown85a31762010-09-01 17:01:00 -07004603 * @see #getFilterTouchesWhenObscured
4604 */
4605 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07004606 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07004607 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
4608 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
4609 // Window is obscured, drop this touch.
4610 return false;
4611 }
4612 return true;
4613 }
4614
4615 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004616 * Pass a trackball motion event down to the focused view.
4617 *
4618 * @param event The motion event to be dispatched.
4619 * @return True if the event was handled by the view, false otherwise.
4620 */
4621 public boolean dispatchTrackballEvent(MotionEvent event) {
4622 //Log.i("view", "view=" + this + ", " + event.toString());
4623 return onTrackballEvent(event);
4624 }
4625
4626 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08004627 * Pass a generic motion event down to the focused view.
4628 *
4629 * @param event The motion event to be dispatched.
4630 * @return True if the event was handled by the view, false otherwise.
4631 */
4632 public boolean dispatchGenericMotionEvent(MotionEvent event) {
4633 return onGenericMotionEvent(event);
4634 }
4635
4636 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004637 * Called when the window containing this view gains or loses window focus.
4638 * ViewGroups should override to route to their children.
4639 *
4640 * @param hasFocus True if the window containing this view now has focus,
4641 * false otherwise.
4642 */
4643 public void dispatchWindowFocusChanged(boolean hasFocus) {
4644 onWindowFocusChanged(hasFocus);
4645 }
4646
4647 /**
4648 * Called when the window containing this view gains or loses focus. Note
4649 * that this is separate from view focus: to receive key events, both
4650 * your view and its window must have focus. If a window is displayed
4651 * on top of yours that takes input focus, then your own window will lose
4652 * focus but the view focus will remain unchanged.
4653 *
4654 * @param hasWindowFocus True if the window containing this view now has
4655 * focus, false otherwise.
4656 */
4657 public void onWindowFocusChanged(boolean hasWindowFocus) {
4658 InputMethodManager imm = InputMethodManager.peekInstance();
4659 if (!hasWindowFocus) {
4660 if (isPressed()) {
4661 setPressed(false);
4662 }
4663 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4664 imm.focusOut(this);
4665 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05004666 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08004667 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004668 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004669 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
4670 imm.focusIn(this);
4671 }
4672 refreshDrawableState();
4673 }
4674
4675 /**
4676 * Returns true if this view is in a window that currently has window focus.
4677 * Note that this is not the same as the view itself having focus.
4678 *
4679 * @return True if this view is in a window that currently has window focus.
4680 */
4681 public boolean hasWindowFocus() {
4682 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
4683 }
4684
4685 /**
Adam Powell326d8082009-12-09 15:10:07 -08004686 * Dispatch a view visibility change down the view hierarchy.
4687 * ViewGroups should override to route to their children.
4688 * @param changedView The view whose visibility changed. Could be 'this' or
4689 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004690 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4691 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004692 */
4693 protected void dispatchVisibilityChanged(View changedView, int visibility) {
4694 onVisibilityChanged(changedView, visibility);
4695 }
4696
4697 /**
4698 * Called when the visibility of the view or an ancestor of the view is changed.
4699 * @param changedView The view whose visibility changed. Could be 'this' or
4700 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08004701 * @param visibility The new visibility of changedView: {@link #VISIBLE},
4702 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08004703 */
4704 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004705 if (visibility == VISIBLE) {
4706 if (mAttachInfo != null) {
4707 initialAwakenScrollBars();
4708 } else {
4709 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
4710 }
4711 }
Adam Powell326d8082009-12-09 15:10:07 -08004712 }
4713
4714 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08004715 * Dispatch a hint about whether this view is displayed. For instance, when
4716 * a View moves out of the screen, it might receives a display hint indicating
4717 * the view is not displayed. Applications should not <em>rely</em> on this hint
4718 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08004719 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08004720 * @param hint A hint about whether or not this view is displayed:
4721 * {@link #VISIBLE} or {@link #INVISIBLE}.
4722 */
4723 public void dispatchDisplayHint(int hint) {
4724 onDisplayHint(hint);
4725 }
4726
4727 /**
4728 * Gives this view a hint about whether is displayed or not. For instance, when
4729 * a View moves out of the screen, it might receives a display hint indicating
4730 * the view is not displayed. Applications should not <em>rely</em> on this hint
4731 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08004732 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08004733 * @param hint A hint about whether or not this view is displayed:
4734 * {@link #VISIBLE} or {@link #INVISIBLE}.
4735 */
4736 protected void onDisplayHint(int hint) {
4737 }
4738
4739 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004740 * Dispatch a window visibility change down the view hierarchy.
4741 * ViewGroups should override to route to their children.
4742 *
4743 * @param visibility The new visibility of the window.
4744 *
4745 * @see #onWindowVisibilityChanged
4746 */
4747 public void dispatchWindowVisibilityChanged(int visibility) {
4748 onWindowVisibilityChanged(visibility);
4749 }
4750
4751 /**
4752 * Called when the window containing has change its visibility
4753 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
4754 * that this tells you whether or not your window is being made visible
4755 * to the window manager; this does <em>not</em> tell you whether or not
4756 * your window is obscured by other windows on the screen, even if it
4757 * is itself visible.
4758 *
4759 * @param visibility The new visibility of the window.
4760 */
4761 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07004762 if (visibility == VISIBLE) {
4763 initialAwakenScrollBars();
4764 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004765 }
4766
4767 /**
4768 * Returns the current visibility of the window this view is attached to
4769 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
4770 *
4771 * @return Returns the current visibility of the view's window.
4772 */
4773 public int getWindowVisibility() {
4774 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
4775 }
4776
4777 /**
4778 * Retrieve the overall visible display size in which the window this view is
4779 * attached to has been positioned in. This takes into account screen
4780 * decorations above the window, for both cases where the window itself
4781 * is being position inside of them or the window is being placed under
4782 * then and covered insets are used for the window to position its content
4783 * inside. In effect, this tells you the available area where content can
4784 * be placed and remain visible to users.
4785 *
4786 * <p>This function requires an IPC back to the window manager to retrieve
4787 * the requested information, so should not be used in performance critical
4788 * code like drawing.
4789 *
4790 * @param outRect Filled in with the visible display frame. If the view
4791 * is not attached to a window, this is simply the raw display size.
4792 */
4793 public void getWindowVisibleDisplayFrame(Rect outRect) {
4794 if (mAttachInfo != null) {
4795 try {
4796 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
4797 } catch (RemoteException e) {
4798 return;
4799 }
4800 // XXX This is really broken, and probably all needs to be done
4801 // in the window manager, and we need to know more about whether
4802 // we want the area behind or in front of the IME.
4803 final Rect insets = mAttachInfo.mVisibleInsets;
4804 outRect.left += insets.left;
4805 outRect.top += insets.top;
4806 outRect.right -= insets.right;
4807 outRect.bottom -= insets.bottom;
4808 return;
4809 }
4810 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
4811 outRect.set(0, 0, d.getWidth(), d.getHeight());
4812 }
4813
4814 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08004815 * Dispatch a notification about a resource configuration change down
4816 * the view hierarchy.
4817 * ViewGroups should override to route to their children.
4818 *
4819 * @param newConfig The new resource configuration.
4820 *
4821 * @see #onConfigurationChanged
4822 */
4823 public void dispatchConfigurationChanged(Configuration newConfig) {
4824 onConfigurationChanged(newConfig);
4825 }
4826
4827 /**
4828 * Called when the current configuration of the resources being used
4829 * by the application have changed. You can use this to decide when
4830 * to reload resources that can changed based on orientation and other
4831 * configuration characterstics. You only need to use this if you are
4832 * not relying on the normal {@link android.app.Activity} mechanism of
4833 * recreating the activity instance upon a configuration change.
4834 *
4835 * @param newConfig The new resource configuration.
4836 */
4837 protected void onConfigurationChanged(Configuration newConfig) {
4838 }
4839
4840 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004841 * Private function to aggregate all per-view attributes in to the view
4842 * root.
4843 */
4844 void dispatchCollectViewAttributes(int visibility) {
4845 performCollectViewAttributes(visibility);
4846 }
4847
4848 void performCollectViewAttributes(int visibility) {
Romain Guyd30b36d2011-01-26 10:54:43 -08004849 if ((visibility & VISIBILITY_MASK) == VISIBLE && mAttachInfo != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08004850 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) {
4851 mAttachInfo.mKeepScreenOn = true;
4852 }
4853 mAttachInfo.mSystemUiVisibility |= mSystemUiVisibility;
4854 if (mOnSystemUiVisibilityChangeListener != null) {
4855 mAttachInfo.mHasSystemUiListeners = true;
4856 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004857 }
4858 }
4859
4860 void needGlobalAttributesUpdate(boolean force) {
Joe Onorato664644d2011-01-23 17:53:23 -08004861 final AttachInfo ai = mAttachInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004862 if (ai != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08004863 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0)
4864 || ai.mHasSystemUiListeners) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004865 ai.mRecomputeGlobalAttributes = true;
4866 }
4867 }
4868 }
4869
4870 /**
4871 * Returns whether the device is currently in touch mode. Touch mode is entered
4872 * once the user begins interacting with the device by touch, and affects various
4873 * things like whether focus is always visible to the user.
4874 *
4875 * @return Whether the device is in touch mode.
4876 */
4877 @ViewDebug.ExportedProperty
4878 public boolean isInTouchMode() {
4879 if (mAttachInfo != null) {
4880 return mAttachInfo.mInTouchMode;
4881 } else {
4882 return ViewRoot.isInTouchMode();
4883 }
4884 }
4885
4886 /**
4887 * Returns the context the view is running in, through which it can
4888 * access the current theme, resources, etc.
4889 *
4890 * @return The view's Context.
4891 */
4892 @ViewDebug.CapturedViewProperty
4893 public final Context getContext() {
4894 return mContext;
4895 }
4896
4897 /**
4898 * Handle a key event before it is processed by any input method
4899 * associated with the view hierarchy. This can be used to intercept
4900 * key events in special situations before the IME consumes them; a
4901 * typical example would be handling the BACK key to update the application's
4902 * UI instead of allowing the IME to see it and close itself.
4903 *
4904 * @param keyCode The value in event.getKeyCode().
4905 * @param event Description of the key event.
4906 * @return If you handled the event, return true. If you want to allow the
4907 * event to be handled by the next receiver, return false.
4908 */
4909 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
4910 return false;
4911 }
4912
4913 /**
Jeff Brown995e7742010-12-22 16:59:36 -08004914 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
4915 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004916 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
4917 * is released, if the view is enabled and clickable.
4918 *
4919 * @param keyCode A key code that represents the button pressed, from
4920 * {@link android.view.KeyEvent}.
4921 * @param event The KeyEvent object that defines the button action.
4922 */
4923 public boolean onKeyDown(int keyCode, KeyEvent event) {
4924 boolean result = false;
4925
4926 switch (keyCode) {
4927 case KeyEvent.KEYCODE_DPAD_CENTER:
4928 case KeyEvent.KEYCODE_ENTER: {
4929 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4930 return true;
4931 }
4932 // Long clickable items don't necessarily have to be clickable
4933 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
4934 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
4935 (event.getRepeatCount() == 0)) {
4936 setPressed(true);
4937 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
Adam Powelle14579b2009-12-16 18:39:52 -08004938 postCheckForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004939 }
4940 return true;
4941 }
4942 break;
4943 }
4944 }
4945 return result;
4946 }
4947
4948 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004949 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
4950 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
4951 * the event).
4952 */
4953 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
4954 return false;
4955 }
4956
4957 /**
Jeff Brown995e7742010-12-22 16:59:36 -08004958 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
4959 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004960 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
4961 * {@link KeyEvent#KEYCODE_ENTER} is released.
4962 *
4963 * @param keyCode A key code that represents the button pressed, from
4964 * {@link android.view.KeyEvent}.
4965 * @param event The KeyEvent object that defines the button action.
4966 */
4967 public boolean onKeyUp(int keyCode, KeyEvent event) {
4968 boolean result = false;
4969
4970 switch (keyCode) {
4971 case KeyEvent.KEYCODE_DPAD_CENTER:
4972 case KeyEvent.KEYCODE_ENTER: {
4973 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4974 return true;
4975 }
4976 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
4977 setPressed(false);
4978
4979 if (!mHasPerformedLongPress) {
4980 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05004981 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004982
4983 result = performClick();
4984 }
4985 }
4986 break;
4987 }
4988 }
4989 return result;
4990 }
4991
4992 /**
4993 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
4994 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
4995 * the event).
4996 *
4997 * @param keyCode A key code that represents the button pressed, from
4998 * {@link android.view.KeyEvent}.
4999 * @param repeatCount The number of times the action was made.
5000 * @param event The KeyEvent object that defines the button action.
5001 */
5002 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
5003 return false;
5004 }
5005
5006 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08005007 * Called on the focused view when a key shortcut event is not handled.
5008 * Override this method to implement local key shortcuts for the View.
5009 * Key shortcuts can also be implemented by setting the
5010 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005011 *
5012 * @param keyCode The value in event.getKeyCode().
5013 * @param event Description of the key event.
5014 * @return If you handled the event, return true. If you want to allow the
5015 * event to be handled by the next receiver, return false.
5016 */
5017 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
5018 return false;
5019 }
5020
5021 /**
5022 * Check whether the called view is a text editor, in which case it
5023 * would make sense to automatically display a soft input window for
5024 * it. Subclasses should override this if they implement
5025 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005026 * a call on that method would return a non-null InputConnection, and
5027 * they are really a first-class editor that the user would normally
5028 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07005029 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005030 * <p>The default implementation always returns false. This does
5031 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
5032 * will not be called or the user can not otherwise perform edits on your
5033 * view; it is just a hint to the system that this is not the primary
5034 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07005035 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005036 * @return Returns true if this view is a text editor, else false.
5037 */
5038 public boolean onCheckIsTextEditor() {
5039 return false;
5040 }
Romain Guy8506ab42009-06-11 17:35:47 -07005041
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005042 /**
5043 * Create a new InputConnection for an InputMethod to interact
5044 * with the view. The default implementation returns null, since it doesn't
5045 * support input methods. You can override this to implement such support.
5046 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07005047 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005048 * <p>When implementing this, you probably also want to implement
5049 * {@link #onCheckIsTextEditor()} to indicate you will return a
5050 * non-null InputConnection.
5051 *
5052 * @param outAttrs Fill in with attribute information about the connection.
5053 */
5054 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
5055 return null;
5056 }
5057
5058 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005059 * Called by the {@link android.view.inputmethod.InputMethodManager}
5060 * when a view who is not the current
5061 * input connection target is trying to make a call on the manager. The
5062 * default implementation returns false; you can override this to return
5063 * true for certain views if you are performing InputConnection proxying
5064 * to them.
5065 * @param view The View that is making the InputMethodManager call.
5066 * @return Return true to allow the call, false to reject.
5067 */
5068 public boolean checkInputConnectionProxy(View view) {
5069 return false;
5070 }
Romain Guy8506ab42009-06-11 17:35:47 -07005071
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005072 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005073 * Show the context menu for this view. It is not safe to hold on to the
5074 * menu after returning from this method.
5075 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07005076 * You should normally not overload this method. Overload
5077 * {@link #onCreateContextMenu(ContextMenu)} or define an
5078 * {@link OnCreateContextMenuListener} to add items to the context menu.
5079 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005080 * @param menu The context menu to populate
5081 */
5082 public void createContextMenu(ContextMenu menu) {
5083 ContextMenuInfo menuInfo = getContextMenuInfo();
5084
5085 // Sets the current menu info so all items added to menu will have
5086 // my extra info set.
5087 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
5088
5089 onCreateContextMenu(menu);
5090 if (mOnCreateContextMenuListener != null) {
5091 mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
5092 }
5093
5094 // Clear the extra information so subsequent items that aren't mine don't
5095 // have my extra info.
5096 ((MenuBuilder)menu).setCurrentMenuInfo(null);
5097
5098 if (mParent != null) {
5099 mParent.createContextMenu(menu);
5100 }
5101 }
5102
5103 /**
5104 * Views should implement this if they have extra information to associate
5105 * with the context menu. The return result is supplied as a parameter to
5106 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
5107 * callback.
5108 *
5109 * @return Extra information about the item for which the context menu
5110 * should be shown. This information will vary across different
5111 * subclasses of View.
5112 */
5113 protected ContextMenuInfo getContextMenuInfo() {
5114 return null;
5115 }
5116
5117 /**
5118 * Views should implement this if the view itself is going to add items to
5119 * the context menu.
5120 *
5121 * @param menu the context menu to populate
5122 */
5123 protected void onCreateContextMenu(ContextMenu menu) {
5124 }
5125
5126 /**
5127 * Implement this method to handle trackball motion events. The
5128 * <em>relative</em> movement of the trackball since the last event
5129 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
5130 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
5131 * that a movement of 1 corresponds to the user pressing one DPAD key (so
5132 * they will often be fractional values, representing the more fine-grained
5133 * movement information available from a trackball).
5134 *
5135 * @param event The motion event.
5136 * @return True if the event was handled, false otherwise.
5137 */
5138 public boolean onTrackballEvent(MotionEvent event) {
5139 return false;
5140 }
5141
5142 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08005143 * Implement this method to handle generic motion events.
5144 * <p>
5145 * Generic motion events are dispatched to the focused view to describe
5146 * the motions of input devices such as joysticks. The
5147 * {@link MotionEvent#getSource() source} of the motion event specifies
5148 * the class of input that was received. Implementations of this method
5149 * must examine the bits in the source before processing the event.
5150 * The following code example shows how this is done.
5151 * </p>
5152 * <code>
5153 * public boolean onGenericMotionEvent(MotionEvent event) {
5154 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_JOYSTICK) != 0) {
5155 * float x = event.getX();
5156 * float y = event.getY();
5157 * // process the joystick motion
5158 * return true;
5159 * }
5160 * return super.onGenericMotionEvent(event);
5161 * }
5162 * </code>
5163 *
5164 * @param event The generic motion event being processed.
5165 *
5166 * @return Return true if you have consumed the event, false if you haven't.
5167 * The default implementation always returns false.
5168 */
5169 public boolean onGenericMotionEvent(MotionEvent event) {
5170 return false;
5171 }
5172
5173 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005174 * Implement this method to handle touch screen motion events.
5175 *
5176 * @param event The motion event.
5177 * @return True if the event was handled, false otherwise.
5178 */
5179 public boolean onTouchEvent(MotionEvent event) {
5180 final int viewFlags = mViewFlags;
5181
5182 if ((viewFlags & ENABLED_MASK) == DISABLED) {
5183 // A disabled view that is clickable still consumes the touch
5184 // events, it just doesn't respond to them.
5185 return (((viewFlags & CLICKABLE) == CLICKABLE ||
5186 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
5187 }
5188
5189 if (mTouchDelegate != null) {
5190 if (mTouchDelegate.onTouchEvent(event)) {
5191 return true;
5192 }
5193 }
5194
5195 if (((viewFlags & CLICKABLE) == CLICKABLE ||
5196 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
5197 switch (event.getAction()) {
5198 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08005199 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
5200 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005201 // take focus if we don't have it already and we should in
5202 // touch mode.
5203 boolean focusTaken = false;
5204 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
5205 focusTaken = requestFocus();
5206 }
5207
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08005208 if (prepressed) {
5209 // The button is being released before we actually
5210 // showed it as pressed. Make it show the pressed
5211 // state now (before scheduling the click) to ensure
5212 // the user sees it.
5213 mPrivateFlags |= PRESSED;
5214 refreshDrawableState();
5215 }
Joe Malin32736f02011-01-19 16:14:20 -08005216
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005217 if (!mHasPerformedLongPress) {
5218 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05005219 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005220
5221 // Only perform take click actions if we were in the pressed state
5222 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08005223 // Use a Runnable and post this rather than calling
5224 // performClick directly. This lets other visual state
5225 // of the view update before click actions start.
5226 if (mPerformClick == null) {
5227 mPerformClick = new PerformClick();
5228 }
5229 if (!post(mPerformClick)) {
5230 performClick();
5231 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005232 }
5233 }
5234
5235 if (mUnsetPressedState == null) {
5236 mUnsetPressedState = new UnsetPressedState();
5237 }
5238
Adam Powelle14579b2009-12-16 18:39:52 -08005239 if (prepressed) {
Adam Powelle14579b2009-12-16 18:39:52 -08005240 postDelayed(mUnsetPressedState,
5241 ViewConfiguration.getPressedStateDuration());
5242 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005243 // If the post failed, unpress right now
5244 mUnsetPressedState.run();
5245 }
Adam Powelle14579b2009-12-16 18:39:52 -08005246 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005247 }
5248 break;
5249
5250 case MotionEvent.ACTION_DOWN:
Adam Powelle14579b2009-12-16 18:39:52 -08005251 if (mPendingCheckForTap == null) {
5252 mPendingCheckForTap = new CheckForTap();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005253 }
Adam Powelle14579b2009-12-16 18:39:52 -08005254 mPrivateFlags |= PREPRESSED;
Adam Powell3b023392010-03-11 16:30:28 -08005255 mHasPerformedLongPress = false;
Adam Powelle14579b2009-12-16 18:39:52 -08005256 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005257 break;
5258
5259 case MotionEvent.ACTION_CANCEL:
5260 mPrivateFlags &= ~PRESSED;
5261 refreshDrawableState();
Adam Powelle14579b2009-12-16 18:39:52 -08005262 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005263 break;
5264
5265 case MotionEvent.ACTION_MOVE:
5266 final int x = (int) event.getX();
5267 final int y = (int) event.getY();
5268
5269 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07005270 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005271 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08005272 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005273 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08005274 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05005275 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005276
5277 // Need to switch from pressed to not pressed
5278 mPrivateFlags &= ~PRESSED;
5279 refreshDrawableState();
5280 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005281 }
5282 break;
5283 }
5284 return true;
5285 }
5286
5287 return false;
5288 }
5289
5290 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05005291 * Remove the longpress detection timer.
5292 */
5293 private void removeLongPressCallback() {
5294 if (mPendingCheckForLongPress != null) {
5295 removeCallbacks(mPendingCheckForLongPress);
5296 }
5297 }
Adam Powell3cb8b632011-01-21 15:34:14 -08005298
5299 /**
5300 * Remove the pending click action
5301 */
5302 private void removePerformClickCallback() {
5303 if (mPerformClick != null) {
5304 removeCallbacks(mPerformClick);
5305 }
5306 }
5307
Adam Powelle14579b2009-12-16 18:39:52 -08005308 /**
Romain Guya440b002010-02-24 15:57:54 -08005309 * Remove the prepress detection timer.
5310 */
5311 private void removeUnsetPressCallback() {
5312 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
5313 setPressed(false);
5314 removeCallbacks(mUnsetPressedState);
5315 }
5316 }
5317
5318 /**
Adam Powelle14579b2009-12-16 18:39:52 -08005319 * Remove the tap detection timer.
5320 */
5321 private void removeTapCallback() {
5322 if (mPendingCheckForTap != null) {
5323 mPrivateFlags &= ~PREPRESSED;
5324 removeCallbacks(mPendingCheckForTap);
5325 }
5326 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05005327
5328 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005329 * Cancels a pending long press. Your subclass can use this if you
5330 * want the context menu to come up if the user presses and holds
5331 * at the same place, but you don't want it to come up if they press
5332 * and then move around enough to cause scrolling.
5333 */
5334 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05005335 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08005336
5337 /*
5338 * The prepressed state handled by the tap callback is a display
5339 * construct, but the tap callback will post a long press callback
5340 * less its own timeout. Remove it here.
5341 */
5342 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005343 }
5344
5345 /**
5346 * Sets the TouchDelegate for this View.
5347 */
5348 public void setTouchDelegate(TouchDelegate delegate) {
5349 mTouchDelegate = delegate;
5350 }
5351
5352 /**
5353 * Gets the TouchDelegate for this View.
5354 */
5355 public TouchDelegate getTouchDelegate() {
5356 return mTouchDelegate;
5357 }
5358
5359 /**
5360 * Set flags controlling behavior of this view.
5361 *
5362 * @param flags Constant indicating the value which should be set
5363 * @param mask Constant indicating the bit range that should be changed
5364 */
5365 void setFlags(int flags, int mask) {
5366 int old = mViewFlags;
5367 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
5368
5369 int changed = mViewFlags ^ old;
5370 if (changed == 0) {
5371 return;
5372 }
5373 int privateFlags = mPrivateFlags;
5374
5375 /* Check if the FOCUSABLE bit has changed */
5376 if (((changed & FOCUSABLE_MASK) != 0) &&
5377 ((privateFlags & HAS_BOUNDS) !=0)) {
5378 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
5379 && ((privateFlags & FOCUSED) != 0)) {
5380 /* Give up focus if we are no longer focusable */
5381 clearFocus();
5382 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
5383 && ((privateFlags & FOCUSED) == 0)) {
5384 /*
5385 * Tell the view system that we are now available to take focus
5386 * if no one else already has it.
5387 */
5388 if (mParent != null) mParent.focusableViewAvailable(this);
5389 }
5390 }
5391
5392 if ((flags & VISIBILITY_MASK) == VISIBLE) {
5393 if ((changed & VISIBILITY_MASK) != 0) {
5394 /*
5395 * If this view is becoming visible, set the DRAWN flag so that
5396 * the next invalidate() will not be skipped.
5397 */
5398 mPrivateFlags |= DRAWN;
5399
5400 needGlobalAttributesUpdate(true);
5401
5402 // a view becoming visible is worth notifying the parent
5403 // about in case nothing has focus. even if this specific view
5404 // isn't focusable, it may contain something that is, so let
5405 // the root view try to give this focus if nothing else does.
5406 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
5407 mParent.focusableViewAvailable(this);
5408 }
5409 }
5410 }
5411
5412 /* Check if the GONE bit has changed */
5413 if ((changed & GONE) != 0) {
5414 needGlobalAttributesUpdate(false);
5415 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08005416 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005417
Romain Guyecd80ee2009-12-03 17:13:02 -08005418 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
5419 if (hasFocus()) clearFocus();
5420 destroyDrawingCache();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005421 }
5422 if (mAttachInfo != null) {
5423 mAttachInfo.mViewVisibilityChanged = true;
5424 }
5425 }
5426
5427 /* Check if the VISIBLE bit has changed */
5428 if ((changed & INVISIBLE) != 0) {
5429 needGlobalAttributesUpdate(false);
Romain Guy0fd89bf2011-01-26 15:41:30 -08005430 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005431
5432 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
5433 // root view becoming invisible shouldn't clear focus
5434 if (getRootView() != this) {
5435 clearFocus();
5436 }
5437 }
5438 if (mAttachInfo != null) {
5439 mAttachInfo.mViewVisibilityChanged = true;
5440 }
5441 }
5442
Adam Powell326d8082009-12-09 15:10:07 -08005443 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07005444 if (mParent instanceof ViewGroup) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005445 ((ViewGroup) mParent).onChildVisibilityChanged(this, (flags & VISIBILITY_MASK));
5446 ((View) mParent).invalidate(true);
Chet Haase5e25c2c2010-09-16 11:15:56 -07005447 }
Adam Powell326d8082009-12-09 15:10:07 -08005448 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
5449 }
5450
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005451 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
5452 destroyDrawingCache();
5453 }
5454
5455 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
5456 destroyDrawingCache();
5457 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Romain Guy0fd89bf2011-01-26 15:41:30 -08005458 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005459 }
5460
5461 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
5462 destroyDrawingCache();
5463 mPrivateFlags &= ~DRAWING_CACHE_VALID;
5464 }
5465
5466 if ((changed & DRAW_MASK) != 0) {
5467 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
5468 if (mBGDrawable != null) {
5469 mPrivateFlags &= ~SKIP_DRAW;
5470 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
5471 } else {
5472 mPrivateFlags |= SKIP_DRAW;
5473 }
5474 } else {
5475 mPrivateFlags &= ~SKIP_DRAW;
5476 }
5477 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08005478 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005479 }
5480
5481 if ((changed & KEEP_SCREEN_ON) != 0) {
Joe Onorato664644d2011-01-23 17:53:23 -08005482 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005483 mParent.recomputeViewAttributes(this);
5484 }
5485 }
5486 }
5487
5488 /**
5489 * Change the view's z order in the tree, so it's on top of other sibling
5490 * views
5491 */
5492 public void bringToFront() {
5493 if (mParent != null) {
5494 mParent.bringChildToFront(this);
5495 }
5496 }
5497
5498 /**
5499 * This is called in response to an internal scroll in this view (i.e., the
5500 * view scrolled its own contents). This is typically as a result of
5501 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
5502 * called.
5503 *
5504 * @param l Current horizontal scroll origin.
5505 * @param t Current vertical scroll origin.
5506 * @param oldl Previous horizontal scroll origin.
5507 * @param oldt Previous vertical scroll origin.
5508 */
5509 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
5510 mBackgroundSizeChanged = true;
5511
5512 final AttachInfo ai = mAttachInfo;
5513 if (ai != null) {
5514 ai.mViewScrollChanged = true;
5515 }
5516 }
5517
5518 /**
Chet Haase21cd1382010-09-01 17:42:29 -07005519 * Interface definition for a callback to be invoked when the layout bounds of a view
5520 * changes due to layout processing.
5521 */
5522 public interface OnLayoutChangeListener {
5523 /**
5524 * Called when the focus state of a view has changed.
5525 *
5526 * @param v The view whose state has changed.
5527 * @param left The new value of the view's left property.
5528 * @param top The new value of the view's top property.
5529 * @param right The new value of the view's right property.
5530 * @param bottom The new value of the view's bottom property.
5531 * @param oldLeft The previous value of the view's left property.
5532 * @param oldTop The previous value of the view's top property.
5533 * @param oldRight The previous value of the view's right property.
5534 * @param oldBottom The previous value of the view's bottom property.
5535 */
5536 void onLayoutChange(View v, int left, int top, int right, int bottom,
5537 int oldLeft, int oldTop, int oldRight, int oldBottom);
5538 }
5539
5540 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005541 * This is called during layout when the size of this view has changed. If
5542 * you were just added to the view hierarchy, you're called with the old
5543 * values of 0.
5544 *
5545 * @param w Current width of this view.
5546 * @param h Current height of this view.
5547 * @param oldw Old width of this view.
5548 * @param oldh Old height of this view.
5549 */
5550 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
5551 }
5552
5553 /**
5554 * Called by draw to draw the child views. This may be overridden
5555 * by derived classes to gain control just before its children are drawn
5556 * (but after its own view has been drawn).
5557 * @param canvas the canvas on which to draw the view
5558 */
5559 protected void dispatchDraw(Canvas canvas) {
5560 }
5561
5562 /**
5563 * Gets the parent of this view. Note that the parent is a
5564 * ViewParent and not necessarily a View.
5565 *
5566 * @return Parent of this view.
5567 */
5568 public final ViewParent getParent() {
5569 return mParent;
5570 }
5571
5572 /**
5573 * Return the scrolled left position of this view. This is the left edge of
5574 * the displayed part of your view. You do not need to draw any pixels
5575 * farther left, since those are outside of the frame of your view on
5576 * screen.
5577 *
5578 * @return The left edge of the displayed part of your view, in pixels.
5579 */
5580 public final int getScrollX() {
5581 return mScrollX;
5582 }
5583
5584 /**
5585 * Return the scrolled top position of this view. This is the top edge of
5586 * the displayed part of your view. You do not need to draw any pixels above
5587 * it, since those are outside of the frame of your view on screen.
5588 *
5589 * @return The top edge of the displayed part of your view, in pixels.
5590 */
5591 public final int getScrollY() {
5592 return mScrollY;
5593 }
5594
5595 /**
5596 * Return the width of the your view.
5597 *
5598 * @return The width of your view, in pixels.
5599 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005600 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005601 public final int getWidth() {
5602 return mRight - mLeft;
5603 }
5604
5605 /**
5606 * Return the height of your view.
5607 *
5608 * @return The height of your view, in pixels.
5609 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005610 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005611 public final int getHeight() {
5612 return mBottom - mTop;
5613 }
5614
5615 /**
5616 * Return the visible drawing bounds of your view. Fills in the output
5617 * rectangle with the values from getScrollX(), getScrollY(),
5618 * getWidth(), and getHeight().
5619 *
5620 * @param outRect The (scrolled) drawing bounds of the view.
5621 */
5622 public void getDrawingRect(Rect outRect) {
5623 outRect.left = mScrollX;
5624 outRect.top = mScrollY;
5625 outRect.right = mScrollX + (mRight - mLeft);
5626 outRect.bottom = mScrollY + (mBottom - mTop);
5627 }
5628
5629 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005630 * Like {@link #getMeasuredWidthAndState()}, but only returns the
5631 * raw width component (that is the result is masked by
5632 * {@link #MEASURED_SIZE_MASK}).
5633 *
5634 * @return The raw measured width of this view.
5635 */
5636 public final int getMeasuredWidth() {
5637 return mMeasuredWidth & MEASURED_SIZE_MASK;
5638 }
5639
5640 /**
5641 * Return the full width measurement information for this view as computed
5642 * by the most recent call to {@link #measure}. This result is a bit mask
5643 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005644 * This should be used during measurement and layout calculations only. Use
5645 * {@link #getWidth()} to see how wide a view is after layout.
5646 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08005647 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005648 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08005649 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005650 return mMeasuredWidth;
5651 }
5652
5653 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005654 * Like {@link #getMeasuredHeightAndState()}, but only returns the
5655 * raw width component (that is the result is masked by
5656 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005657 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08005658 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005659 */
5660 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08005661 return mMeasuredHeight & MEASURED_SIZE_MASK;
5662 }
5663
5664 /**
5665 * Return the full height measurement information for this view as computed
5666 * by the most recent call to {@link #measure}. This result is a bit mask
5667 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
5668 * This should be used during measurement and layout calculations only. Use
5669 * {@link #getHeight()} to see how wide a view is after layout.
5670 *
5671 * @return The measured width of this view as a bit mask.
5672 */
5673 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005674 return mMeasuredHeight;
5675 }
5676
5677 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08005678 * Return only the state bits of {@link #getMeasuredWidthAndState()}
5679 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
5680 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
5681 * and the height component is at the shifted bits
5682 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
5683 */
5684 public final int getMeasuredState() {
5685 return (mMeasuredWidth&MEASURED_STATE_MASK)
5686 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
5687 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
5688 }
5689
5690 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005691 * The transform matrix of this view, which is calculated based on the current
5692 * roation, scale, and pivot properties.
5693 *
5694 * @see #getRotation()
5695 * @see #getScaleX()
5696 * @see #getScaleY()
5697 * @see #getPivotX()
5698 * @see #getPivotY()
5699 * @return The current transform matrix for the view
5700 */
5701 public Matrix getMatrix() {
Jeff Brown86671742010-09-30 20:00:15 -07005702 updateMatrix();
Romain Guy33e72ae2010-07-17 12:40:29 -07005703 return mMatrix;
5704 }
5705
5706 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005707 * Utility function to determine if the value is far enough away from zero to be
5708 * considered non-zero.
5709 * @param value A floating point value to check for zero-ness
5710 * @return whether the passed-in value is far enough away from zero to be considered non-zero
5711 */
5712 private static boolean nonzero(float value) {
5713 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
5714 }
5715
5716 /**
Jeff Brown86671742010-09-30 20:00:15 -07005717 * Returns true if the transform matrix is the identity matrix.
5718 * Recomputes the matrix if necessary.
Joe Malin32736f02011-01-19 16:14:20 -08005719 *
Romain Guy33e72ae2010-07-17 12:40:29 -07005720 * @return True if the transform matrix is the identity matrix, false otherwise.
5721 */
Jeff Brown86671742010-09-30 20:00:15 -07005722 final boolean hasIdentityMatrix() {
5723 updateMatrix();
5724 return mMatrixIsIdentity;
5725 }
5726
5727 /**
5728 * Recomputes the transform matrix if necessary.
5729 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07005730 private void updateMatrix() {
Chet Haasec3aa3612010-06-17 08:50:37 -07005731 if (mMatrixDirty) {
5732 // transform-related properties have changed since the last time someone
5733 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07005734
5735 // Figure out if we need to update the pivot point
5736 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08005737 if ((mRight - mLeft) != mPrevWidth || (mBottom - mTop) != mPrevHeight) {
Chet Haasefd2b0022010-08-06 13:08:56 -07005738 mPrevWidth = mRight - mLeft;
5739 mPrevHeight = mBottom - mTop;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -08005740 mPivotX = mPrevWidth / 2f;
5741 mPivotY = mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07005742 }
5743 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005744 mMatrix.reset();
Chet Haase897247b2010-09-09 14:54:47 -07005745 if (!nonzero(mRotationX) && !nonzero(mRotationY)) {
5746 mMatrix.setTranslate(mTranslationX, mTranslationY);
5747 mMatrix.preRotate(mRotation, mPivotX, mPivotY);
5748 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
5749 } else {
Chet Haasefd2b0022010-08-06 13:08:56 -07005750 if (mCamera == null) {
5751 mCamera = new Camera();
5752 matrix3D = new Matrix();
5753 }
5754 mCamera.save();
Chet Haase897247b2010-09-09 14:54:47 -07005755 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
Romain Guy47b8ade2011-02-23 19:46:33 -08005756 mCamera.rotate(mRotationX, mRotationY, -mRotation);
Chet Haasefd2b0022010-08-06 13:08:56 -07005757 mCamera.getMatrix(matrix3D);
5758 matrix3D.preTranslate(-mPivotX, -mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07005759 matrix3D.postTranslate(mPivotX + mTranslationX, mPivotY + mTranslationY);
Chet Haasefd2b0022010-08-06 13:08:56 -07005760 mMatrix.postConcat(matrix3D);
5761 mCamera.restore();
5762 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005763 mMatrixDirty = false;
5764 mMatrixIsIdentity = mMatrix.isIdentity();
5765 mInverseMatrixDirty = true;
5766 }
Chet Haasec3aa3612010-06-17 08:50:37 -07005767 }
5768
5769 /**
5770 * Utility method to retrieve the inverse of the current mMatrix property.
5771 * We cache the matrix to avoid recalculating it when transform properties
5772 * have not changed.
5773 *
5774 * @return The inverse of the current matrix of this view.
5775 */
Jeff Brown86671742010-09-30 20:00:15 -07005776 final Matrix getInverseMatrix() {
5777 updateMatrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07005778 if (mInverseMatrixDirty) {
5779 if (mInverseMatrix == null) {
5780 mInverseMatrix = new Matrix();
5781 }
5782 mMatrix.invert(mInverseMatrix);
5783 mInverseMatrixDirty = false;
5784 }
5785 return mInverseMatrix;
5786 }
5787
5788 /**
Romain Guya5364ee2011-02-24 14:46:04 -08005789 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which
5790 * views are drawn) from the camera to this view. The camera's distance
5791 * affects 3D transformations, for instance rotations around the X and Y
5792 * axis. If the rotationX or rotationY properties are changed and this view is
5793 * large (more than half the size of the screen), it is recommended to always
5794 * use a camera distance that's greater than the height (X axis rotation) or
5795 * the width (Y axis rotation) of this view.</p>
5796 *
5797 * <p>The distance of the camera from the view plane can have an affect on the
5798 * perspective distortion of the view when it is rotated around the x or y axis.
5799 * For example, a large distance will result in a large viewing angle, and there
5800 * will not be much perspective distortion of the view as it rotates. A short
5801 * distance may cause much more perspective distortion upon rotation, and can
5802 * also result in some drawing artifacts if the rotated view ends up partially
5803 * behind the camera (which is why the recommendation is to use a distance at
5804 * least as far as the size of the view, if the view is to be rotated.)</p>
5805 *
5806 * <p>The distance is expressed in "depth pixels." The default distance depends
5807 * on the screen density. For instance, on a medium density display, the
5808 * default distance is 1280. On a high density display, the default distance
5809 * is 1920.</p>
5810 *
5811 * <p>If you want to specify a distance that leads to visually consistent
5812 * results across various densities, use the following formula:</p>
5813 * <pre>
5814 * float scale = context.getResources().getDisplayMetrics().density;
5815 * view.setCameraDistance(distance * scale);
5816 * </pre>
5817 *
5818 * <p>The density scale factor of a high density display is 1.5,
5819 * and 1920 = 1280 * 1.5.</p>
5820 *
5821 * @param distance The distance in "depth pixels", if negative the opposite
5822 * value is used
5823 *
5824 * @see #setRotationX(float)
5825 * @see #setRotationY(float)
5826 */
5827 public void setCameraDistance(float distance) {
5828 invalidateParentCaches();
5829 invalidate(false);
5830
5831 final float dpi = mResources.getDisplayMetrics().densityDpi;
5832 if (mCamera == null) {
5833 mCamera = new Camera();
5834 matrix3D = new Matrix();
5835 }
5836
5837 mCamera.setLocation(0.0f, 0.0f, -Math.abs(distance) / dpi);
5838 mMatrixDirty = true;
5839
5840 invalidate(false);
5841 }
5842
5843 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005844 * The degrees that the view is rotated around the pivot point.
5845 *
Romain Guya5364ee2011-02-24 14:46:04 -08005846 * @see #setRotation(float)
Chet Haasec3aa3612010-06-17 08:50:37 -07005847 * @see #getPivotX()
5848 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08005849 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005850 * @return The degrees of rotation.
5851 */
5852 public float getRotation() {
5853 return mRotation;
5854 }
5855
5856 /**
Chet Haase897247b2010-09-09 14:54:47 -07005857 * Sets the degrees that the view is rotated around the pivot point. Increasing values
5858 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07005859 *
5860 * @param rotation The degrees of rotation.
Romain Guya5364ee2011-02-24 14:46:04 -08005861 *
5862 * @see #getRotation()
Chet Haasec3aa3612010-06-17 08:50:37 -07005863 * @see #getPivotX()
5864 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08005865 * @see #setRotationX(float)
5866 * @see #setRotationY(float)
Chet Haase73066682010-11-29 15:55:32 -08005867 *
5868 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07005869 */
5870 public void setRotation(float rotation) {
5871 if (mRotation != rotation) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005872 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005873 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005874 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005875 mRotation = rotation;
5876 mMatrixDirty = true;
5877 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005878 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005879 }
5880 }
5881
5882 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07005883 * The degrees that the view is rotated around the vertical axis through the pivot point.
5884 *
5885 * @see #getPivotX()
5886 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08005887 * @see #setRotationY(float)
5888 *
Chet Haasefd2b0022010-08-06 13:08:56 -07005889 * @return The degrees of Y rotation.
5890 */
5891 public float getRotationY() {
5892 return mRotationY;
5893 }
5894
5895 /**
Chet Haase897247b2010-09-09 14:54:47 -07005896 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
5897 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
5898 * down the y axis.
Romain Guya5364ee2011-02-24 14:46:04 -08005899 *
5900 * When rotating large views, it is recommended to adjust the camera distance
5901 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07005902 *
5903 * @param rotationY The degrees of Y rotation.
Romain Guya5364ee2011-02-24 14:46:04 -08005904 *
5905 * @see #getRotationY()
Chet Haasefd2b0022010-08-06 13:08:56 -07005906 * @see #getPivotX()
5907 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08005908 * @see #setRotation(float)
5909 * @see #setRotationX(float)
5910 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08005911 *
5912 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07005913 */
5914 public void setRotationY(float rotationY) {
5915 if (mRotationY != rotationY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005916 invalidateParentCaches();
Chet Haasefd2b0022010-08-06 13:08:56 -07005917 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005918 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005919 mRotationY = rotationY;
5920 mMatrixDirty = true;
5921 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005922 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005923 }
5924 }
5925
5926 /**
5927 * The degrees that the view is rotated around the horizontal axis through the pivot point.
5928 *
5929 * @see #getPivotX()
5930 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08005931 * @see #setRotationX(float)
5932 *
Chet Haasefd2b0022010-08-06 13:08:56 -07005933 * @return The degrees of X rotation.
5934 */
5935 public float getRotationX() {
5936 return mRotationX;
5937 }
5938
5939 /**
Chet Haase897247b2010-09-09 14:54:47 -07005940 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
5941 * Increasing values result in clockwise rotation from the viewpoint of looking down the
5942 * x axis.
Romain Guya5364ee2011-02-24 14:46:04 -08005943 *
5944 * When rotating large views, it is recommended to adjust the camera distance
5945 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07005946 *
5947 * @param rotationX The degrees of X rotation.
Romain Guya5364ee2011-02-24 14:46:04 -08005948 *
5949 * @see #getRotationX()
Chet Haasefd2b0022010-08-06 13:08:56 -07005950 * @see #getPivotX()
5951 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08005952 * @see #setRotation(float)
5953 * @see #setRotationY(float)
5954 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08005955 *
5956 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07005957 */
5958 public void setRotationX(float rotationX) {
5959 if (mRotationX != rotationX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005960 invalidateParentCaches();
Chet Haasefd2b0022010-08-06 13:08:56 -07005961 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005962 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005963 mRotationX = rotationX;
5964 mMatrixDirty = true;
5965 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07005966 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07005967 }
5968 }
5969
5970 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07005971 * The amount that the view is scaled in x around the pivot point, as a proportion of
5972 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
5973 *
Joe Onorato93162322010-09-16 15:42:01 -04005974 * <p>By default, this is 1.0f.
5975 *
Chet Haasec3aa3612010-06-17 08:50:37 -07005976 * @see #getPivotX()
5977 * @see #getPivotY()
5978 * @return The scaling factor.
5979 */
5980 public float getScaleX() {
5981 return mScaleX;
5982 }
5983
5984 /**
5985 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
5986 * the view's unscaled width. A value of 1 means that no scaling is applied.
5987 *
5988 * @param scaleX The scaling factor.
5989 * @see #getPivotX()
5990 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08005991 *
5992 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07005993 */
5994 public void setScaleX(float scaleX) {
5995 if (mScaleX != scaleX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08005996 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07005997 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07005998 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07005999 mScaleX = scaleX;
6000 mMatrixDirty = true;
6001 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006002 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006003 }
6004 }
6005
6006 /**
6007 * The amount that the view is scaled in y around the pivot point, as a proportion of
6008 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
6009 *
Joe Onorato93162322010-09-16 15:42:01 -04006010 * <p>By default, this is 1.0f.
6011 *
Chet Haasec3aa3612010-06-17 08:50:37 -07006012 * @see #getPivotX()
6013 * @see #getPivotY()
6014 * @return The scaling factor.
6015 */
6016 public float getScaleY() {
6017 return mScaleY;
6018 }
6019
6020 /**
6021 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
6022 * the view's unscaled width. A value of 1 means that no scaling is applied.
6023 *
6024 * @param scaleY The scaling factor.
6025 * @see #getPivotX()
6026 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08006027 *
6028 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07006029 */
6030 public void setScaleY(float scaleY) {
6031 if (mScaleY != scaleY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006032 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07006033 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006034 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006035 mScaleY = scaleY;
6036 mMatrixDirty = true;
6037 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006038 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006039 }
6040 }
6041
6042 /**
6043 * The x location of the point around which the view is {@link #setRotation(float) rotated}
6044 * and {@link #setScaleX(float) scaled}.
6045 *
6046 * @see #getRotation()
6047 * @see #getScaleX()
6048 * @see #getScaleY()
6049 * @see #getPivotY()
6050 * @return The x location of the pivot point.
6051 */
6052 public float getPivotX() {
6053 return mPivotX;
6054 }
6055
6056 /**
6057 * Sets the x location of the point around which the view is
6058 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07006059 * By default, the pivot point is centered on the object.
6060 * Setting this property disables this behavior and causes the view to use only the
6061 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07006062 *
6063 * @param pivotX The x location of the pivot point.
6064 * @see #getRotation()
6065 * @see #getScaleX()
6066 * @see #getScaleY()
6067 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08006068 *
6069 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07006070 */
6071 public void setPivotX(float pivotX) {
Chet Haasefd2b0022010-08-06 13:08:56 -07006072 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07006073 if (mPivotX != pivotX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006074 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07006075 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006076 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006077 mPivotX = pivotX;
6078 mMatrixDirty = true;
6079 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006080 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006081 }
6082 }
6083
6084 /**
6085 * The y location of the point around which the view is {@link #setRotation(float) rotated}
6086 * and {@link #setScaleY(float) scaled}.
6087 *
6088 * @see #getRotation()
6089 * @see #getScaleX()
6090 * @see #getScaleY()
6091 * @see #getPivotY()
6092 * @return The y location of the pivot point.
6093 */
6094 public float getPivotY() {
6095 return mPivotY;
6096 }
6097
6098 /**
6099 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07006100 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
6101 * Setting this property disables this behavior and causes the view to use only the
6102 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07006103 *
6104 * @param pivotY The y location of the pivot point.
6105 * @see #getRotation()
6106 * @see #getScaleX()
6107 * @see #getScaleY()
6108 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08006109 *
6110 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07006111 */
6112 public void setPivotY(float pivotY) {
Chet Haasefd2b0022010-08-06 13:08:56 -07006113 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07006114 if (mPivotY != pivotY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006115 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07006116 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006117 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006118 mPivotY = pivotY;
6119 mMatrixDirty = true;
6120 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006121 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006122 }
6123 }
6124
6125 /**
6126 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
6127 * completely transparent and 1 means the view is completely opaque.
6128 *
Joe Onorato93162322010-09-16 15:42:01 -04006129 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07006130 * @return The opacity of the view.
6131 */
6132 public float getAlpha() {
6133 return mAlpha;
6134 }
6135
6136 /**
Romain Guy171c5922011-01-06 10:04:23 -08006137 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
6138 * completely transparent and 1 means the view is completely opaque.</p>
Joe Malin32736f02011-01-19 16:14:20 -08006139 *
Romain Guy171c5922011-01-06 10:04:23 -08006140 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
6141 * responsible for applying the opacity itself. Otherwise, calling this method is
6142 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
Joe Malin32736f02011-01-19 16:14:20 -08006143 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07006144 *
6145 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08006146 *
Joe Malin32736f02011-01-19 16:14:20 -08006147 * @see #setLayerType(int, android.graphics.Paint)
6148 *
Chet Haase73066682010-11-29 15:55:32 -08006149 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07006150 */
6151 public void setAlpha(float alpha) {
6152 mAlpha = alpha;
Romain Guy0fd89bf2011-01-26 15:41:30 -08006153 invalidateParentCaches();
Chet Haaseed032702010-10-01 14:05:54 -07006154 if (onSetAlpha((int) (alpha * 255))) {
Romain Guya3496a92010-10-12 11:53:24 -07006155 mPrivateFlags |= ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07006156 // subclass is handling alpha - don't optimize rendering cache invalidation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006157 invalidate(true);
Chet Haaseed032702010-10-01 14:05:54 -07006158 } else {
Romain Guya3496a92010-10-12 11:53:24 -07006159 mPrivateFlags &= ~ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07006160 invalidate(false);
6161 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006162 }
6163
6164 /**
Chet Haasea00f3862011-02-22 06:34:40 -08006165 * Faster version of setAlpha() which performs the same steps except there are
6166 * no calls to invalidate(). The caller of this function should perform proper invalidation
6167 * on the parent and this object. The return value indicates whether the subclass handles
6168 * alpha (the return value for onSetAlpha()).
6169 *
6170 * @param alpha The new value for the alpha property
6171 * @return true if the View subclass handles alpha (the return value for onSetAlpha())
6172 */
6173 boolean setAlphaNoInvalidation(float alpha) {
6174 mAlpha = alpha;
6175 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255));
6176 if (subclassHandlesAlpha) {
6177 mPrivateFlags |= ALPHA_SET;
6178 } else {
6179 mPrivateFlags &= ~ALPHA_SET;
6180 }
6181 return subclassHandlesAlpha;
6182 }
6183
6184 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006185 * Top position of this view relative to its parent.
6186 *
6187 * @return The top of this view, in pixels.
6188 */
6189 @ViewDebug.CapturedViewProperty
6190 public final int getTop() {
6191 return mTop;
6192 }
6193
6194 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006195 * Sets the top position of this view relative to its parent. This method is meant to be called
6196 * by the layout system and should not generally be called otherwise, because the property
6197 * may be changed at any time by the layout.
6198 *
6199 * @param top The top of this view, in pixels.
6200 */
6201 public final void setTop(int top) {
6202 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07006203 updateMatrix();
6204 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08006205 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07006206 int minTop;
6207 int yLoc;
6208 if (top < mTop) {
6209 minTop = top;
6210 yLoc = top - mTop;
6211 } else {
6212 minTop = mTop;
6213 yLoc = 0;
6214 }
Chet Haasee9140a72011-02-16 16:23:29 -08006215 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop);
Chet Haase21cd1382010-09-01 17:42:29 -07006216 }
6217 } else {
6218 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08006219 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006220 }
6221
Chet Haaseed032702010-10-01 14:05:54 -07006222 int width = mRight - mLeft;
6223 int oldHeight = mBottom - mTop;
6224
Chet Haase21cd1382010-09-01 17:42:29 -07006225 mTop = top;
6226
Chet Haaseed032702010-10-01 14:05:54 -07006227 onSizeChanged(width, mBottom - mTop, width, oldHeight);
6228
Chet Haase21cd1382010-09-01 17:42:29 -07006229 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006230 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6231 // A change in dimension means an auto-centered pivot point changes, too
6232 mMatrixDirty = true;
6233 }
Chet Haase21cd1382010-09-01 17:42:29 -07006234 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006235 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006236 }
Chet Haase55dbb652010-12-21 20:15:08 -08006237 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08006238 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07006239 }
6240 }
6241
6242 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006243 * Bottom position of this view relative to its parent.
6244 *
6245 * @return The bottom of this view, in pixels.
6246 */
6247 @ViewDebug.CapturedViewProperty
6248 public final int getBottom() {
6249 return mBottom;
6250 }
6251
6252 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08006253 * True if this view has changed since the last time being drawn.
6254 *
6255 * @return The dirty state of this view.
6256 */
6257 public boolean isDirty() {
6258 return (mPrivateFlags & DIRTY_MASK) != 0;
6259 }
6260
6261 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006262 * Sets the bottom position of this view relative to its parent. This method is meant to be
6263 * called by the layout system and should not generally be called otherwise, because the
6264 * property may be changed at any time by the layout.
6265 *
6266 * @param bottom The bottom of this view, in pixels.
6267 */
6268 public final void setBottom(int bottom) {
6269 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07006270 updateMatrix();
6271 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08006272 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07006273 int maxBottom;
6274 if (bottom < mBottom) {
6275 maxBottom = mBottom;
6276 } else {
6277 maxBottom = bottom;
6278 }
Chet Haasee9140a72011-02-16 16:23:29 -08006279 invalidate(0, 0, mRight - mLeft, maxBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07006280 }
6281 } else {
6282 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08006283 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006284 }
6285
Chet Haaseed032702010-10-01 14:05:54 -07006286 int width = mRight - mLeft;
6287 int oldHeight = mBottom - mTop;
6288
Chet Haase21cd1382010-09-01 17:42:29 -07006289 mBottom = bottom;
6290
Chet Haaseed032702010-10-01 14:05:54 -07006291 onSizeChanged(width, mBottom - mTop, width, oldHeight);
6292
Chet Haase21cd1382010-09-01 17:42:29 -07006293 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006294 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6295 // A change in dimension means an auto-centered pivot point changes, too
6296 mMatrixDirty = true;
6297 }
Chet Haase21cd1382010-09-01 17:42:29 -07006298 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006299 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006300 }
Chet Haase55dbb652010-12-21 20:15:08 -08006301 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08006302 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07006303 }
6304 }
6305
6306 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006307 * Left position of this view relative to its parent.
6308 *
6309 * @return The left edge of this view, in pixels.
6310 */
6311 @ViewDebug.CapturedViewProperty
6312 public final int getLeft() {
6313 return mLeft;
6314 }
6315
6316 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006317 * Sets the left position of this view relative to its parent. This method is meant to be called
6318 * by the layout system and should not generally be called otherwise, because the property
6319 * may be changed at any time by the layout.
6320 *
6321 * @param left The bottom of this view, in pixels.
6322 */
6323 public final void setLeft(int left) {
6324 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07006325 updateMatrix();
6326 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08006327 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07006328 int minLeft;
6329 int xLoc;
6330 if (left < mLeft) {
6331 minLeft = left;
6332 xLoc = left - mLeft;
6333 } else {
6334 minLeft = mLeft;
6335 xLoc = 0;
6336 }
Chet Haasee9140a72011-02-16 16:23:29 -08006337 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07006338 }
6339 } else {
6340 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08006341 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006342 }
6343
Chet Haaseed032702010-10-01 14:05:54 -07006344 int oldWidth = mRight - mLeft;
6345 int height = mBottom - mTop;
6346
Chet Haase21cd1382010-09-01 17:42:29 -07006347 mLeft = left;
6348
Chet Haaseed032702010-10-01 14:05:54 -07006349 onSizeChanged(mRight - mLeft, height, oldWidth, height);
6350
Chet Haase21cd1382010-09-01 17:42:29 -07006351 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006352 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6353 // A change in dimension means an auto-centered pivot point changes, too
6354 mMatrixDirty = true;
6355 }
Chet Haase21cd1382010-09-01 17:42:29 -07006356 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006357 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006358 }
Chet Haase55dbb652010-12-21 20:15:08 -08006359 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08006360 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07006361 }
6362 }
6363
6364 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006365 * Right position of this view relative to its parent.
6366 *
6367 * @return The right edge of this view, in pixels.
6368 */
6369 @ViewDebug.CapturedViewProperty
6370 public final int getRight() {
6371 return mRight;
6372 }
6373
6374 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006375 * Sets the right position of this view relative to its parent. This method is meant to be called
6376 * by the layout system and should not generally be called otherwise, because the property
6377 * may be changed at any time by the layout.
6378 *
6379 * @param right The bottom of this view, in pixels.
6380 */
6381 public final void setRight(int right) {
6382 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07006383 updateMatrix();
6384 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08006385 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07006386 int maxRight;
6387 if (right < mRight) {
6388 maxRight = mRight;
6389 } else {
6390 maxRight = right;
6391 }
Chet Haasee9140a72011-02-16 16:23:29 -08006392 invalidate(0, 0, maxRight - mLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07006393 }
6394 } else {
6395 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08006396 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006397 }
6398
Chet Haaseed032702010-10-01 14:05:54 -07006399 int oldWidth = mRight - mLeft;
6400 int height = mBottom - mTop;
6401
Chet Haase21cd1382010-09-01 17:42:29 -07006402 mRight = right;
6403
Chet Haaseed032702010-10-01 14:05:54 -07006404 onSizeChanged(mRight - mLeft, height, oldWidth, height);
6405
Chet Haase21cd1382010-09-01 17:42:29 -07006406 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006407 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
6408 // A change in dimension means an auto-centered pivot point changes, too
6409 mMatrixDirty = true;
6410 }
Chet Haase21cd1382010-09-01 17:42:29 -07006411 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08006412 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07006413 }
Chet Haase55dbb652010-12-21 20:15:08 -08006414 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08006415 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07006416 }
6417 }
6418
6419 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006420 * The visual x position of this view, in pixels. This is equivalent to the
6421 * {@link #setTranslationX(float) translationX} property plus the current
Joe Malin32736f02011-01-19 16:14:20 -08006422 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07006423 *
Chet Haasedf030d22010-07-30 17:22:38 -07006424 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07006425 */
Chet Haasedf030d22010-07-30 17:22:38 -07006426 public float getX() {
6427 return mLeft + mTranslationX;
6428 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006429
Chet Haasedf030d22010-07-30 17:22:38 -07006430 /**
6431 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
6432 * {@link #setTranslationX(float) translationX} property to be the difference between
6433 * the x value passed in and the current {@link #getLeft() left} property.
6434 *
6435 * @param x The visual x position of this view, in pixels.
6436 */
6437 public void setX(float x) {
6438 setTranslationX(x - mLeft);
6439 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006440
Chet Haasedf030d22010-07-30 17:22:38 -07006441 /**
6442 * The visual y position of this view, in pixels. This is equivalent to the
6443 * {@link #setTranslationY(float) translationY} property plus the current
6444 * {@link #getTop() top} property.
6445 *
6446 * @return The visual y position of this view, in pixels.
6447 */
6448 public float getY() {
6449 return mTop + mTranslationY;
6450 }
6451
6452 /**
6453 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
6454 * {@link #setTranslationY(float) translationY} property to be the difference between
6455 * the y value passed in and the current {@link #getTop() top} property.
6456 *
6457 * @param y The visual y position of this view, in pixels.
6458 */
6459 public void setY(float y) {
6460 setTranslationY(y - mTop);
6461 }
6462
6463
6464 /**
6465 * The horizontal location of this view relative to its {@link #getLeft() left} position.
6466 * This position is post-layout, in addition to wherever the object's
6467 * layout placed it.
6468 *
6469 * @return The horizontal position of this view relative to its left position, in pixels.
6470 */
6471 public float getTranslationX() {
6472 return mTranslationX;
6473 }
6474
6475 /**
6476 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
6477 * This effectively positions the object post-layout, in addition to wherever the object's
6478 * layout placed it.
6479 *
6480 * @param translationX The horizontal position of this view relative to its left position,
6481 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08006482 *
6483 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07006484 */
6485 public void setTranslationX(float translationX) {
6486 if (mTranslationX != translationX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006487 invalidateParentCaches();
Chet Haasedf030d22010-07-30 17:22:38 -07006488 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006489 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006490 mTranslationX = translationX;
6491 mMatrixDirty = true;
6492 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006493 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006494 }
6495 }
6496
6497 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006498 * The horizontal location of this view relative to its {@link #getTop() top} position.
6499 * This position is post-layout, in addition to wherever the object's
6500 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07006501 *
Chet Haasedf030d22010-07-30 17:22:38 -07006502 * @return The vertical position of this view relative to its top position,
6503 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07006504 */
Chet Haasedf030d22010-07-30 17:22:38 -07006505 public float getTranslationY() {
6506 return mTranslationY;
Chet Haasec3aa3612010-06-17 08:50:37 -07006507 }
6508
6509 /**
Chet Haasedf030d22010-07-30 17:22:38 -07006510 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
6511 * This effectively positions the object post-layout, in addition to wherever the object's
6512 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07006513 *
Chet Haasedf030d22010-07-30 17:22:38 -07006514 * @param translationY The vertical position of this view relative to its top position,
6515 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08006516 *
6517 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07006518 */
Chet Haasedf030d22010-07-30 17:22:38 -07006519 public void setTranslationY(float translationY) {
6520 if (mTranslationY != translationY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006521 invalidateParentCaches();
Chet Haasedf030d22010-07-30 17:22:38 -07006522 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006523 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006524 mTranslationY = translationY;
6525 mMatrixDirty = true;
6526 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006527 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07006528 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006529 }
6530
6531 /**
Romain Guyda489792011-02-03 01:05:15 -08006532 * @hide
6533 */
Michael Jurkadece29f2011-02-03 01:41:49 -08006534 public void setFastTranslationX(float x) {
6535 mTranslationX = x;
6536 mMatrixDirty = true;
6537 }
6538
6539 /**
6540 * @hide
6541 */
6542 public void setFastTranslationY(float y) {
6543 mTranslationY = y;
6544 mMatrixDirty = true;
6545 }
6546
6547 /**
6548 * @hide
6549 */
Romain Guyda489792011-02-03 01:05:15 -08006550 public void setFastX(float x) {
6551 mTranslationX = x - mLeft;
6552 mMatrixDirty = true;
6553 }
6554
6555 /**
6556 * @hide
6557 */
6558 public void setFastY(float y) {
6559 mTranslationY = y - mTop;
6560 mMatrixDirty = true;
6561 }
6562
6563 /**
6564 * @hide
6565 */
6566 public void setFastScaleX(float x) {
6567 mScaleX = x;
6568 mMatrixDirty = true;
6569 }
6570
6571 /**
6572 * @hide
6573 */
6574 public void setFastScaleY(float y) {
6575 mScaleY = y;
6576 mMatrixDirty = true;
6577 }
6578
6579 /**
6580 * @hide
6581 */
6582 public void setFastAlpha(float alpha) {
6583 mAlpha = alpha;
6584 }
6585
6586 /**
6587 * @hide
6588 */
6589 public void setFastRotationY(float y) {
6590 mRotationY = y;
6591 mMatrixDirty = true;
6592 }
6593
6594 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006595 * Hit rectangle in parent's coordinates
6596 *
6597 * @param outRect The hit rectangle of the view.
6598 */
6599 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07006600 updateMatrix();
6601 if (mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006602 outRect.set(mLeft, mTop, mRight, mBottom);
6603 } else {
6604 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Romain Guy33e72ae2010-07-17 12:40:29 -07006605 tmpRect.set(-mPivotX, -mPivotY, getWidth() - mPivotX, getHeight() - mPivotY);
Jeff Brown86671742010-09-30 20:00:15 -07006606 mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07006607 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
6608 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07006609 }
6610 }
6611
6612 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07006613 * Determines whether the given point, in local coordinates is inside the view.
6614 */
6615 /*package*/ final boolean pointInView(float localX, float localY) {
6616 return localX >= 0 && localX < (mRight - mLeft)
6617 && localY >= 0 && localY < (mBottom - mTop);
6618 }
6619
6620 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07006621 * Utility method to determine whether the given point, in local coordinates,
6622 * is inside the view, where the area of the view is expanded by the slop factor.
6623 * This method is called while processing touch-move events to determine if the event
6624 * is still within the view.
6625 */
6626 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07006627 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07006628 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006629 }
6630
6631 /**
6632 * When a view has focus and the user navigates away from it, the next view is searched for
6633 * starting from the rectangle filled in by this method.
6634 *
6635 * By default, the rectange is the {@link #getDrawingRect})of the view. However, if your
6636 * view maintains some idea of internal selection, such as a cursor, or a selected row
6637 * or column, you should override this method and fill in a more specific rectangle.
6638 *
6639 * @param r The rectangle to fill in, in this view's coordinates.
6640 */
6641 public void getFocusedRect(Rect r) {
6642 getDrawingRect(r);
6643 }
6644
6645 /**
6646 * If some part of this view is not clipped by any of its parents, then
6647 * return that area in r in global (root) coordinates. To convert r to local
6648 * coordinates, offset it by -globalOffset (e.g. r.offset(-globalOffset.x,
6649 * -globalOffset.y)) If the view is completely clipped or translated out,
6650 * return false.
6651 *
6652 * @param r If true is returned, r holds the global coordinates of the
6653 * visible portion of this view.
6654 * @param globalOffset If true is returned, globalOffset holds the dx,dy
6655 * between this view and its root. globalOffet may be null.
6656 * @return true if r is non-empty (i.e. part of the view is visible at the
6657 * root level.
6658 */
6659 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
6660 int width = mRight - mLeft;
6661 int height = mBottom - mTop;
6662 if (width > 0 && height > 0) {
6663 r.set(0, 0, width, height);
6664 if (globalOffset != null) {
6665 globalOffset.set(-mScrollX, -mScrollY);
6666 }
6667 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
6668 }
6669 return false;
6670 }
6671
6672 public final boolean getGlobalVisibleRect(Rect r) {
6673 return getGlobalVisibleRect(r, null);
6674 }
6675
6676 public final boolean getLocalVisibleRect(Rect r) {
6677 Point offset = new Point();
6678 if (getGlobalVisibleRect(r, offset)) {
6679 r.offset(-offset.x, -offset.y); // make r local
6680 return true;
6681 }
6682 return false;
6683 }
6684
6685 /**
6686 * Offset this view's vertical location by the specified number of pixels.
6687 *
6688 * @param offset the number of pixels to offset the view by
6689 */
6690 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006691 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07006692 updateMatrix();
6693 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006694 final ViewParent p = mParent;
6695 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006696 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006697 int minTop;
6698 int maxBottom;
6699 int yLoc;
6700 if (offset < 0) {
6701 minTop = mTop + offset;
6702 maxBottom = mBottom;
6703 yLoc = offset;
6704 } else {
6705 minTop = mTop;
6706 maxBottom = mBottom + offset;
6707 yLoc = 0;
6708 }
6709 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
6710 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07006711 }
6712 } else {
Chet Haaseed032702010-10-01 14:05:54 -07006713 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006714 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006715
Chet Haasec3aa3612010-06-17 08:50:37 -07006716 mTop += offset;
6717 mBottom += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07006718
Chet Haasec3aa3612010-06-17 08:50:37 -07006719 if (!mMatrixIsIdentity) {
6720 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006721 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006722 }
Chet Haase678e0ad2011-01-25 09:37:18 -08006723 invalidateParentIfNeeded();
Chet Haasec3aa3612010-06-17 08:50:37 -07006724 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006725 }
6726
6727 /**
6728 * Offset this view's horizontal location by the specified amount of pixels.
6729 *
6730 * @param offset the numer of pixels to offset the view by
6731 */
6732 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006733 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07006734 updateMatrix();
6735 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006736 final ViewParent p = mParent;
6737 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07006738 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006739 int minLeft;
6740 int maxRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006741 if (offset < 0) {
6742 minLeft = mLeft + offset;
6743 maxRight = mRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006744 } else {
6745 minLeft = mLeft;
6746 maxRight = mRight + offset;
Chet Haase8fbf8d22010-07-30 15:01:32 -07006747 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006748 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
Chet Haase8fbf8d22010-07-30 15:01:32 -07006749 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07006750 }
6751 } else {
Chet Haaseed032702010-10-01 14:05:54 -07006752 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006753 }
Romain Guy33e72ae2010-07-17 12:40:29 -07006754
Chet Haasec3aa3612010-06-17 08:50:37 -07006755 mLeft += offset;
6756 mRight += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07006757
Chet Haasec3aa3612010-06-17 08:50:37 -07006758 if (!mMatrixIsIdentity) {
6759 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006760 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006761 }
Chet Haase678e0ad2011-01-25 09:37:18 -08006762 invalidateParentIfNeeded();
Chet Haasec3aa3612010-06-17 08:50:37 -07006763 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006764 }
6765
6766 /**
6767 * Get the LayoutParams associated with this view. All views should have
6768 * layout parameters. These supply parameters to the <i>parent</i> of this
6769 * view specifying how it should be arranged. There are many subclasses of
6770 * ViewGroup.LayoutParams, and these correspond to the different subclasses
6771 * of ViewGroup that are responsible for arranging their children.
Romain Guy01c174b2011-02-22 11:51:06 -08006772 *
6773 * This method may return null if this View is not attached to a parent
6774 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)}
6775 * was not invoked successfully. When a View is attached to a parent
6776 * ViewGroup, this method must not return null.
6777 *
6778 * @return The LayoutParams associated with this view, or null if no
6779 * parameters have been set yet
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006780 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07006781 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006782 public ViewGroup.LayoutParams getLayoutParams() {
6783 return mLayoutParams;
6784 }
6785
6786 /**
6787 * Set the layout parameters associated with this view. These supply
6788 * parameters to the <i>parent</i> of this view specifying how it should be
6789 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
6790 * correspond to the different subclasses of ViewGroup that are responsible
6791 * for arranging their children.
6792 *
Romain Guy01c174b2011-02-22 11:51:06 -08006793 * @param params The layout parameters for this view, cannot be null
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006794 */
6795 public void setLayoutParams(ViewGroup.LayoutParams params) {
6796 if (params == null) {
Romain Guy01c174b2011-02-22 11:51:06 -08006797 throw new NullPointerException("Layout parameters cannot be null");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006798 }
6799 mLayoutParams = params;
6800 requestLayout();
6801 }
6802
6803 /**
6804 * Set the scrolled position of your view. This will cause a call to
6805 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6806 * invalidated.
6807 * @param x the x position to scroll to
6808 * @param y the y position to scroll to
6809 */
6810 public void scrollTo(int x, int y) {
6811 if (mScrollX != x || mScrollY != y) {
6812 int oldX = mScrollX;
6813 int oldY = mScrollY;
6814 mScrollX = x;
6815 mScrollY = y;
Romain Guy0fd89bf2011-01-26 15:41:30 -08006816 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006817 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07006818 if (!awakenScrollBars()) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006819 invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -07006820 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006821 }
6822 }
6823
6824 /**
6825 * Move the scrolled position of your view. This will cause a call to
6826 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6827 * invalidated.
6828 * @param x the amount of pixels to scroll by horizontally
6829 * @param y the amount of pixels to scroll by vertically
6830 */
6831 public void scrollBy(int x, int y) {
6832 scrollTo(mScrollX + x, mScrollY + y);
6833 }
6834
6835 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006836 * <p>Trigger the scrollbars to draw. When invoked this method starts an
6837 * animation to fade the scrollbars out after a default delay. If a subclass
6838 * provides animated scrolling, the start delay should equal the duration
6839 * of the scrolling animation.</p>
6840 *
6841 * <p>The animation starts only if at least one of the scrollbars is
6842 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
6843 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6844 * this method returns true, and false otherwise. If the animation is
6845 * started, this method calls {@link #invalidate()}; in that case the
6846 * caller should not call {@link #invalidate()}.</p>
6847 *
6848 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07006849 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07006850 *
6851 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
6852 * and {@link #scrollTo(int, int)}.</p>
6853 *
6854 * @return true if the animation is played, false otherwise
6855 *
6856 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07006857 * @see #scrollBy(int, int)
6858 * @see #scrollTo(int, int)
6859 * @see #isHorizontalScrollBarEnabled()
6860 * @see #isVerticalScrollBarEnabled()
6861 * @see #setHorizontalScrollBarEnabled(boolean)
6862 * @see #setVerticalScrollBarEnabled(boolean)
6863 */
6864 protected boolean awakenScrollBars() {
6865 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07006866 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07006867 }
6868
6869 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07006870 * Trigger the scrollbars to draw.
6871 * This method differs from awakenScrollBars() only in its default duration.
6872 * initialAwakenScrollBars() will show the scroll bars for longer than
6873 * usual to give the user more of a chance to notice them.
6874 *
6875 * @return true if the animation is played, false otherwise.
6876 */
6877 private boolean initialAwakenScrollBars() {
6878 return mScrollCache != null &&
6879 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
6880 }
6881
6882 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07006883 * <p>
6884 * Trigger the scrollbars to draw. When invoked this method starts an
6885 * animation to fade the scrollbars out after a fixed delay. If a subclass
6886 * provides animated scrolling, the start delay should equal the duration of
6887 * the scrolling animation.
6888 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08006889 *
Mike Cleronf116bf82009-09-27 19:14:12 -07006890 * <p>
6891 * The animation starts only if at least one of the scrollbars is enabled,
6892 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6893 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6894 * this method returns true, and false otherwise. If the animation is
6895 * started, this method calls {@link #invalidate()}; in that case the caller
6896 * should not call {@link #invalidate()}.
6897 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08006898 *
Mike Cleronf116bf82009-09-27 19:14:12 -07006899 * <p>
6900 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07006901 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07006902 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08006903 *
Mike Cleronf116bf82009-09-27 19:14:12 -07006904 * @param startDelay the delay, in milliseconds, after which the animation
6905 * should start; when the delay is 0, the animation starts
6906 * immediately
6907 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08006908 *
Mike Cleronf116bf82009-09-27 19:14:12 -07006909 * @see #scrollBy(int, int)
6910 * @see #scrollTo(int, int)
6911 * @see #isHorizontalScrollBarEnabled()
6912 * @see #isVerticalScrollBarEnabled()
6913 * @see #setHorizontalScrollBarEnabled(boolean)
6914 * @see #setVerticalScrollBarEnabled(boolean)
6915 */
6916 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07006917 return awakenScrollBars(startDelay, true);
6918 }
Joe Malin32736f02011-01-19 16:14:20 -08006919
Mike Cleron290947b2009-09-29 18:34:32 -07006920 /**
6921 * <p>
6922 * Trigger the scrollbars to draw. When invoked this method starts an
6923 * animation to fade the scrollbars out after a fixed delay. If a subclass
6924 * provides animated scrolling, the start delay should equal the duration of
6925 * the scrolling animation.
6926 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08006927 *
Mike Cleron290947b2009-09-29 18:34:32 -07006928 * <p>
6929 * The animation starts only if at least one of the scrollbars is enabled,
6930 * as specified by {@link #isHorizontalScrollBarEnabled()} and
6931 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
6932 * this method returns true, and false otherwise. If the animation is
Joe Malin32736f02011-01-19 16:14:20 -08006933 * started, this method calls {@link #invalidate()} if the invalidate parameter
Mike Cleron290947b2009-09-29 18:34:32 -07006934 * is set to true; in that case the caller
6935 * should not call {@link #invalidate()}.
6936 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08006937 *
Mike Cleron290947b2009-09-29 18:34:32 -07006938 * <p>
6939 * This method should be invoked everytime a subclass directly updates the
6940 * scroll parameters.
6941 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08006942 *
Mike Cleron290947b2009-09-29 18:34:32 -07006943 * @param startDelay the delay, in milliseconds, after which the animation
6944 * should start; when the delay is 0, the animation starts
6945 * immediately
Joe Malin32736f02011-01-19 16:14:20 -08006946 *
Mike Cleron290947b2009-09-29 18:34:32 -07006947 * @param invalidate Wheter this method should call invalidate
Joe Malin32736f02011-01-19 16:14:20 -08006948 *
Mike Cleron290947b2009-09-29 18:34:32 -07006949 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08006950 *
Mike Cleron290947b2009-09-29 18:34:32 -07006951 * @see #scrollBy(int, int)
6952 * @see #scrollTo(int, int)
6953 * @see #isHorizontalScrollBarEnabled()
6954 * @see #isVerticalScrollBarEnabled()
6955 * @see #setHorizontalScrollBarEnabled(boolean)
6956 * @see #setVerticalScrollBarEnabled(boolean)
6957 */
6958 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07006959 final ScrollabilityCache scrollCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08006960
Mike Cleronf116bf82009-09-27 19:14:12 -07006961 if (scrollCache == null || !scrollCache.fadeScrollBars) {
6962 return false;
6963 }
6964
6965 if (scrollCache.scrollBar == null) {
6966 scrollCache.scrollBar = new ScrollBarDrawable();
6967 }
6968
6969 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
6970
Mike Cleron290947b2009-09-29 18:34:32 -07006971 if (invalidate) {
6972 // Invalidate to show the scrollbars
Romain Guy0fd89bf2011-01-26 15:41:30 -08006973 invalidate(true);
Mike Cleron290947b2009-09-29 18:34:32 -07006974 }
Mike Cleronf116bf82009-09-27 19:14:12 -07006975
6976 if (scrollCache.state == ScrollabilityCache.OFF) {
6977 // FIXME: this is copied from WindowManagerService.
6978 // We should get this value from the system when it
6979 // is possible to do so.
6980 final int KEY_REPEAT_FIRST_DELAY = 750;
6981 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
6982 }
6983
6984 // Tell mScrollCache when we should start fading. This may
6985 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07006986 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07006987 scrollCache.fadeStartTime = fadeStartTime;
6988 scrollCache.state = ScrollabilityCache.ON;
6989
6990 // Schedule our fader to run, unscheduling any old ones first
6991 if (mAttachInfo != null) {
6992 mAttachInfo.mHandler.removeCallbacks(scrollCache);
6993 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
6994 }
6995
6996 return true;
6997 }
6998
6999 return false;
7000 }
7001
7002 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007003 * Mark the the area defined by dirty as needing to be drawn. If the view is
7004 * visible, {@link #onDraw} will be called at some point in the future.
7005 * This must be called from a UI thread. To call from a non-UI thread, call
7006 * {@link #postInvalidate()}.
7007 *
7008 * WARNING: This method is destructive to dirty.
7009 * @param dirty the rectangle representing the bounds of the dirty region
7010 */
7011 public void invalidate(Rect dirty) {
7012 if (ViewDebug.TRACE_HIERARCHY) {
7013 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
7014 }
7015
Romain Guy2fe9a8f2010-10-04 20:17:01 -07007016 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08007017 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
7018 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007019 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08007020 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007021 final ViewParent p = mParent;
7022 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08007023 //noinspection PointlessBooleanExpression,ConstantConditions
7024 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
7025 if (p != null && ai != null && ai.mHardwareAccelerated) {
7026 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
7027 // with a null dirty rect, which tells the ViewRoot to redraw everything
7028 p.invalidateChild(this, null);
7029 return;
7030 }
Romain Guyaf636eb2010-12-09 17:47:21 -08007031 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007032 if (p != null && ai != null) {
7033 final int scrollX = mScrollX;
7034 final int scrollY = mScrollY;
7035 final Rect r = ai.mTmpInvalRect;
7036 r.set(dirty.left - scrollX, dirty.top - scrollY,
7037 dirty.right - scrollX, dirty.bottom - scrollY);
7038 mParent.invalidateChild(this, r);
7039 }
7040 }
7041 }
7042
7043 /**
7044 * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
7045 * The coordinates of the dirty rect are relative to the view.
7046 * If the view is visible, {@link #onDraw} will be called at some point
7047 * in the future. This must be called from a UI thread. To call
7048 * from a non-UI thread, call {@link #postInvalidate()}.
7049 * @param l the left position of the dirty region
7050 * @param t the top position of the dirty region
7051 * @param r the right position of the dirty region
7052 * @param b the bottom position of the dirty region
7053 */
7054 public void invalidate(int l, int t, int r, int b) {
7055 if (ViewDebug.TRACE_HIERARCHY) {
7056 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
7057 }
7058
Romain Guy2fe9a8f2010-10-04 20:17:01 -07007059 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08007060 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
7061 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007062 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08007063 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007064 final ViewParent p = mParent;
7065 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08007066 //noinspection PointlessBooleanExpression,ConstantConditions
7067 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
7068 if (p != null && ai != null && ai.mHardwareAccelerated) {
7069 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
7070 // with a null dirty rect, which tells the ViewRoot to redraw everything
7071 p.invalidateChild(this, null);
7072 return;
7073 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08007074 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007075 if (p != null && ai != null && l < r && t < b) {
7076 final int scrollX = mScrollX;
7077 final int scrollY = mScrollY;
7078 final Rect tmpr = ai.mTmpInvalRect;
7079 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
7080 p.invalidateChild(this, tmpr);
7081 }
7082 }
7083 }
7084
7085 /**
7086 * Invalidate the whole view. If the view is visible, {@link #onDraw} will
7087 * be called at some point in the future. This must be called from a
7088 * UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
7089 */
7090 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -07007091 invalidate(true);
7092 }
Joe Malin32736f02011-01-19 16:14:20 -08007093
Chet Haaseed032702010-10-01 14:05:54 -07007094 /**
7095 * This is where the invalidate() work actually happens. A full invalidate()
7096 * causes the drawing cache to be invalidated, but this function can be called with
7097 * invalidateCache set to false to skip that invalidation step for cases that do not
7098 * need it (for example, a component that remains at the same dimensions with the same
7099 * content).
7100 *
7101 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
7102 * well. This is usually true for a full invalidate, but may be set to false if the
7103 * View's contents or dimensions have not changed.
7104 */
Romain Guy849d0a32011-02-01 17:20:48 -08007105 void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007106 if (ViewDebug.TRACE_HIERARCHY) {
7107 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
7108 }
7109
Romain Guy2fe9a8f2010-10-04 20:17:01 -07007110 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Romain Guyc5d55862011-01-21 19:01:46 -08007111 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) ||
Romain Guy0fd89bf2011-01-26 15:41:30 -08007112 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) {
7113 mLastIsOpaque = isOpaque();
Chet Haaseed032702010-10-01 14:05:54 -07007114 mPrivateFlags &= ~DRAWN;
7115 if (invalidateCache) {
Chet Haasedaf98e92011-01-10 14:10:36 -08007116 mPrivateFlags |= INVALIDATED;
Chet Haaseed032702010-10-01 14:05:54 -07007117 mPrivateFlags &= ~DRAWING_CACHE_VALID;
7118 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007119 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -07007120 final ViewParent p = mParent;
Romain Guy7d7b5492011-01-24 16:33:45 -08007121 //noinspection PointlessBooleanExpression,ConstantConditions
7122 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
7123 if (p != null && ai != null && ai.mHardwareAccelerated) {
7124 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
7125 // with a null dirty rect, which tells the ViewRoot to redraw everything
7126 p.invalidateChild(this, null);
7127 return;
7128 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08007129 }
Michael Jurkaebefea42010-11-15 16:04:01 -08007130
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007131 if (p != null && ai != null) {
7132 final Rect r = ai.mTmpInvalRect;
7133 r.set(0, 0, mRight - mLeft, mBottom - mTop);
7134 // Don't call invalidate -- we don't want to internally scroll
7135 // our own bounds
7136 p.invalidateChild(this, r);
7137 }
7138 }
7139 }
7140
7141 /**
Romain Guyda489792011-02-03 01:05:15 -08007142 * @hide
7143 */
7144 public void fastInvalidate() {
7145 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
7146 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
7147 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
7148 if (mParent instanceof View) {
7149 ((View) mParent).mPrivateFlags |= INVALIDATED;
7150 }
7151 mPrivateFlags &= ~DRAWN;
7152 mPrivateFlags |= INVALIDATED;
7153 mPrivateFlags &= ~DRAWING_CACHE_VALID;
7154 if (mParent != null && mAttachInfo != null && mAttachInfo.mHardwareAccelerated) {
7155 mParent.invalidateChild(this, null);
7156 }
7157 }
7158 }
7159
7160 /**
Romain Guy0fd89bf2011-01-26 15:41:30 -08007161 * Used to indicate that the parent of this view should clear its caches. This functionality
Chet Haasedaf98e92011-01-10 14:10:36 -08007162 * is used to force the parent to rebuild its display list (when hardware-accelerated),
7163 * which is necessary when various parent-managed properties of the view change, such as
Romain Guy0fd89bf2011-01-26 15:41:30 -08007164 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only
7165 * clears the parent caches and does not causes an invalidate event.
Chet Haasedaf98e92011-01-10 14:10:36 -08007166 *
7167 * @hide
7168 */
Romain Guy0fd89bf2011-01-26 15:41:30 -08007169 protected void invalidateParentCaches() {
7170 if (mParent instanceof View) {
7171 ((View) mParent).mPrivateFlags |= INVALIDATED;
7172 }
7173 }
Joe Malin32736f02011-01-19 16:14:20 -08007174
Romain Guy0fd89bf2011-01-26 15:41:30 -08007175 /**
7176 * Used to indicate that the parent of this view should be invalidated. This functionality
7177 * is used to force the parent to rebuild its display list (when hardware-accelerated),
7178 * which is necessary when various parent-managed properties of the view change, such as
7179 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate
7180 * an invalidation event to the parent.
7181 *
7182 * @hide
7183 */
7184 protected void invalidateParentIfNeeded() {
Chet Haasedaf98e92011-01-10 14:10:36 -08007185 if (isHardwareAccelerated() && mParent instanceof View) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007186 ((View) mParent).invalidate(true);
Chet Haasedaf98e92011-01-10 14:10:36 -08007187 }
7188 }
7189
7190 /**
Romain Guy24443ea2009-05-11 11:56:30 -07007191 * Indicates whether this View is opaque. An opaque View guarantees that it will
7192 * draw all the pixels overlapping its bounds using a fully opaque color.
7193 *
7194 * Subclasses of View should override this method whenever possible to indicate
7195 * whether an instance is opaque. Opaque Views are treated in a special way by
7196 * the View hierarchy, possibly allowing it to perform optimizations during
7197 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -07007198 *
Romain Guy24443ea2009-05-11 11:56:30 -07007199 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -07007200 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07007201 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -07007202 public boolean isOpaque() {
Chet Haase70d4ba12010-10-06 09:46:45 -07007203 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK &&
7204 (mAlpha >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD);
Romain Guy8f1344f52009-05-15 16:03:59 -07007205 }
7206
Adam Powell20232d02010-12-08 21:08:53 -08007207 /**
7208 * @hide
7209 */
7210 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -07007211 // Opaque if:
7212 // - Has a background
7213 // - Background is opaque
7214 // - Doesn't have scrollbars or scrollbars are inside overlay
7215
7216 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) {
7217 mPrivateFlags |= OPAQUE_BACKGROUND;
7218 } else {
7219 mPrivateFlags &= ~OPAQUE_BACKGROUND;
7220 }
7221
7222 final int flags = mViewFlags;
7223 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
7224 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
7225 mPrivateFlags |= OPAQUE_SCROLLBARS;
7226 } else {
7227 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
7228 }
7229 }
7230
7231 /**
7232 * @hide
7233 */
7234 protected boolean hasOpaqueScrollbars() {
7235 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -07007236 }
7237
7238 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007239 * @return A handler associated with the thread running the View. This
7240 * handler can be used to pump events in the UI events queue.
7241 */
7242 public Handler getHandler() {
7243 if (mAttachInfo != null) {
7244 return mAttachInfo.mHandler;
7245 }
7246 return null;
7247 }
7248
7249 /**
7250 * Causes the Runnable to be added to the message queue.
7251 * The runnable will be run on the user interface thread.
7252 *
7253 * @param action The Runnable that will be executed.
7254 *
7255 * @return Returns true if the Runnable was successfully placed in to the
7256 * message queue. Returns false on failure, usually because the
7257 * looper processing the message queue is exiting.
7258 */
7259 public boolean post(Runnable action) {
7260 Handler handler;
7261 if (mAttachInfo != null) {
7262 handler = mAttachInfo.mHandler;
7263 } else {
7264 // Assume that post will succeed later
7265 ViewRoot.getRunQueue().post(action);
7266 return true;
7267 }
7268
7269 return handler.post(action);
7270 }
7271
7272 /**
7273 * Causes the Runnable to be added to the message queue, to be run
7274 * after the specified amount of time elapses.
7275 * The runnable will be run on the user interface thread.
7276 *
7277 * @param action The Runnable that will be executed.
7278 * @param delayMillis The delay (in milliseconds) until the Runnable
7279 * will be executed.
7280 *
7281 * @return true if the Runnable was successfully placed in to the
7282 * message queue. Returns false on failure, usually because the
7283 * looper processing the message queue is exiting. Note that a
7284 * result of true does not mean the Runnable will be processed --
7285 * if the looper is quit before the delivery time of the message
7286 * occurs then the message will be dropped.
7287 */
7288 public boolean postDelayed(Runnable action, long delayMillis) {
7289 Handler handler;
7290 if (mAttachInfo != null) {
7291 handler = mAttachInfo.mHandler;
7292 } else {
7293 // Assume that post will succeed later
7294 ViewRoot.getRunQueue().postDelayed(action, delayMillis);
7295 return true;
7296 }
7297
7298 return handler.postDelayed(action, delayMillis);
7299 }
7300
7301 /**
7302 * Removes the specified Runnable from the message queue.
7303 *
7304 * @param action The Runnable to remove from the message handling queue
7305 *
7306 * @return true if this view could ask the Handler to remove the Runnable,
7307 * false otherwise. When the returned value is true, the Runnable
7308 * may or may not have been actually removed from the message queue
7309 * (for instance, if the Runnable was not in the queue already.)
7310 */
7311 public boolean removeCallbacks(Runnable action) {
7312 Handler handler;
7313 if (mAttachInfo != null) {
7314 handler = mAttachInfo.mHandler;
7315 } else {
7316 // Assume that post will succeed later
7317 ViewRoot.getRunQueue().removeCallbacks(action);
7318 return true;
7319 }
7320
7321 handler.removeCallbacks(action);
7322 return true;
7323 }
7324
7325 /**
7326 * Cause an invalidate to happen on a subsequent cycle through the event loop.
7327 * Use this to invalidate the View from a non-UI thread.
7328 *
7329 * @see #invalidate()
7330 */
7331 public void postInvalidate() {
7332 postInvalidateDelayed(0);
7333 }
7334
7335 /**
7336 * Cause an invalidate of the specified area to happen on a subsequent cycle
7337 * through the event loop. Use this to invalidate the View from a non-UI thread.
7338 *
7339 * @param left The left coordinate of the rectangle to invalidate.
7340 * @param top The top coordinate of the rectangle to invalidate.
7341 * @param right The right coordinate of the rectangle to invalidate.
7342 * @param bottom The bottom coordinate of the rectangle to invalidate.
7343 *
7344 * @see #invalidate(int, int, int, int)
7345 * @see #invalidate(Rect)
7346 */
7347 public void postInvalidate(int left, int top, int right, int bottom) {
7348 postInvalidateDelayed(0, left, top, right, bottom);
7349 }
7350
7351 /**
7352 * Cause an invalidate to happen on a subsequent cycle through the event
7353 * loop. Waits for the specified amount of time.
7354 *
7355 * @param delayMilliseconds the duration in milliseconds to delay the
7356 * invalidation by
7357 */
7358 public void postInvalidateDelayed(long delayMilliseconds) {
7359 // We try only with the AttachInfo because there's no point in invalidating
7360 // if we are not attached to our window
7361 if (mAttachInfo != null) {
7362 Message msg = Message.obtain();
7363 msg.what = AttachInfo.INVALIDATE_MSG;
7364 msg.obj = this;
7365 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
7366 }
7367 }
7368
7369 /**
7370 * Cause an invalidate of the specified area to happen on a subsequent cycle
7371 * through the event loop. Waits for the specified amount of time.
7372 *
7373 * @param delayMilliseconds the duration in milliseconds to delay the
7374 * invalidation by
7375 * @param left The left coordinate of the rectangle to invalidate.
7376 * @param top The top coordinate of the rectangle to invalidate.
7377 * @param right The right coordinate of the rectangle to invalidate.
7378 * @param bottom The bottom coordinate of the rectangle to invalidate.
7379 */
7380 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
7381 int right, int bottom) {
7382
7383 // We try only with the AttachInfo because there's no point in invalidating
7384 // if we are not attached to our window
7385 if (mAttachInfo != null) {
7386 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
7387 info.target = this;
7388 info.left = left;
7389 info.top = top;
7390 info.right = right;
7391 info.bottom = bottom;
7392
7393 final Message msg = Message.obtain();
7394 msg.what = AttachInfo.INVALIDATE_RECT_MSG;
7395 msg.obj = info;
7396 mAttachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
7397 }
7398 }
7399
7400 /**
7401 * Called by a parent to request that a child update its values for mScrollX
7402 * and mScrollY if necessary. This will typically be done if the child is
7403 * animating a scroll using a {@link android.widget.Scroller Scroller}
7404 * object.
7405 */
7406 public void computeScroll() {
7407 }
7408
7409 /**
7410 * <p>Indicate whether the horizontal edges are faded when the view is
7411 * scrolled horizontally.</p>
7412 *
7413 * @return true if the horizontal edges should are faded on scroll, false
7414 * otherwise
7415 *
7416 * @see #setHorizontalFadingEdgeEnabled(boolean)
7417 * @attr ref android.R.styleable#View_fadingEdge
7418 */
7419 public boolean isHorizontalFadingEdgeEnabled() {
7420 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
7421 }
7422
7423 /**
7424 * <p>Define whether the horizontal edges should be faded when this view
7425 * is scrolled horizontally.</p>
7426 *
7427 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
7428 * be faded when the view is scrolled
7429 * horizontally
7430 *
7431 * @see #isHorizontalFadingEdgeEnabled()
7432 * @attr ref android.R.styleable#View_fadingEdge
7433 */
7434 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
7435 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
7436 if (horizontalFadingEdgeEnabled) {
7437 initScrollCache();
7438 }
7439
7440 mViewFlags ^= FADING_EDGE_HORIZONTAL;
7441 }
7442 }
7443
7444 /**
7445 * <p>Indicate whether the vertical edges are faded when the view is
7446 * scrolled horizontally.</p>
7447 *
7448 * @return true if the vertical edges should are faded on scroll, false
7449 * otherwise
7450 *
7451 * @see #setVerticalFadingEdgeEnabled(boolean)
7452 * @attr ref android.R.styleable#View_fadingEdge
7453 */
7454 public boolean isVerticalFadingEdgeEnabled() {
7455 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
7456 }
7457
7458 /**
7459 * <p>Define whether the vertical edges should be faded when this view
7460 * is scrolled vertically.</p>
7461 *
7462 * @param verticalFadingEdgeEnabled true if the vertical edges should
7463 * be faded when the view is scrolled
7464 * vertically
7465 *
7466 * @see #isVerticalFadingEdgeEnabled()
7467 * @attr ref android.R.styleable#View_fadingEdge
7468 */
7469 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
7470 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
7471 if (verticalFadingEdgeEnabled) {
7472 initScrollCache();
7473 }
7474
7475 mViewFlags ^= FADING_EDGE_VERTICAL;
7476 }
7477 }
7478
7479 /**
7480 * Returns the strength, or intensity, of the top faded edge. The strength is
7481 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7482 * returns 0.0 or 1.0 but no value in between.
7483 *
7484 * Subclasses should override this method to provide a smoother fade transition
7485 * when scrolling occurs.
7486 *
7487 * @return the intensity of the top fade as a float between 0.0f and 1.0f
7488 */
7489 protected float getTopFadingEdgeStrength() {
7490 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
7491 }
7492
7493 /**
7494 * Returns the strength, or intensity, of the bottom faded edge. The strength is
7495 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7496 * returns 0.0 or 1.0 but no value in between.
7497 *
7498 * Subclasses should override this method to provide a smoother fade transition
7499 * when scrolling occurs.
7500 *
7501 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
7502 */
7503 protected float getBottomFadingEdgeStrength() {
7504 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
7505 computeVerticalScrollRange() ? 1.0f : 0.0f;
7506 }
7507
7508 /**
7509 * Returns the strength, or intensity, of the left faded edge. The strength is
7510 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7511 * returns 0.0 or 1.0 but no value in between.
7512 *
7513 * Subclasses should override this method to provide a smoother fade transition
7514 * when scrolling occurs.
7515 *
7516 * @return the intensity of the left fade as a float between 0.0f and 1.0f
7517 */
7518 protected float getLeftFadingEdgeStrength() {
7519 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
7520 }
7521
7522 /**
7523 * Returns the strength, or intensity, of the right faded edge. The strength is
7524 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
7525 * returns 0.0 or 1.0 but no value in between.
7526 *
7527 * Subclasses should override this method to provide a smoother fade transition
7528 * when scrolling occurs.
7529 *
7530 * @return the intensity of the right fade as a float between 0.0f and 1.0f
7531 */
7532 protected float getRightFadingEdgeStrength() {
7533 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
7534 computeHorizontalScrollRange() ? 1.0f : 0.0f;
7535 }
7536
7537 /**
7538 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
7539 * scrollbar is not drawn by default.</p>
7540 *
7541 * @return true if the horizontal scrollbar should be painted, false
7542 * otherwise
7543 *
7544 * @see #setHorizontalScrollBarEnabled(boolean)
7545 */
7546 public boolean isHorizontalScrollBarEnabled() {
7547 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
7548 }
7549
7550 /**
7551 * <p>Define whether the horizontal scrollbar should be drawn or not. The
7552 * scrollbar is not drawn by default.</p>
7553 *
7554 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
7555 * be painted
7556 *
7557 * @see #isHorizontalScrollBarEnabled()
7558 */
7559 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
7560 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
7561 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07007562 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007563 recomputePadding();
7564 }
7565 }
7566
7567 /**
7568 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
7569 * scrollbar is not drawn by default.</p>
7570 *
7571 * @return true if the vertical scrollbar should be painted, false
7572 * otherwise
7573 *
7574 * @see #setVerticalScrollBarEnabled(boolean)
7575 */
7576 public boolean isVerticalScrollBarEnabled() {
7577 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
7578 }
7579
7580 /**
7581 * <p>Define whether the vertical scrollbar should be drawn or not. The
7582 * scrollbar is not drawn by default.</p>
7583 *
7584 * @param verticalScrollBarEnabled true if the vertical scrollbar should
7585 * be painted
7586 *
7587 * @see #isVerticalScrollBarEnabled()
7588 */
7589 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
7590 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
7591 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07007592 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007593 recomputePadding();
7594 }
7595 }
7596
Adam Powell20232d02010-12-08 21:08:53 -08007597 /**
7598 * @hide
7599 */
7600 protected void recomputePadding() {
7601 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007602 }
Joe Malin32736f02011-01-19 16:14:20 -08007603
Mike Cleronfe81d382009-09-28 14:22:16 -07007604 /**
7605 * Define whether scrollbars will fade when the view is not scrolling.
Joe Malin32736f02011-01-19 16:14:20 -08007606 *
Mike Cleronfe81d382009-09-28 14:22:16 -07007607 * @param fadeScrollbars wheter to enable fading
Joe Malin32736f02011-01-19 16:14:20 -08007608 *
Mike Cleronfe81d382009-09-28 14:22:16 -07007609 */
7610 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
7611 initScrollCache();
7612 final ScrollabilityCache scrollabilityCache = mScrollCache;
7613 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -07007614 if (fadeScrollbars) {
7615 scrollabilityCache.state = ScrollabilityCache.OFF;
7616 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -07007617 scrollabilityCache.state = ScrollabilityCache.ON;
7618 }
7619 }
Joe Malin32736f02011-01-19 16:14:20 -08007620
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007621 /**
Joe Malin32736f02011-01-19 16:14:20 -08007622 *
Mike Cleron52f0a642009-09-28 18:21:37 -07007623 * Returns true if scrollbars will fade when this view is not scrolling
Joe Malin32736f02011-01-19 16:14:20 -08007624 *
Mike Cleron52f0a642009-09-28 18:21:37 -07007625 * @return true if scrollbar fading is enabled
7626 */
7627 public boolean isScrollbarFadingEnabled() {
Joe Malin32736f02011-01-19 16:14:20 -08007628 return mScrollCache != null && mScrollCache.fadeScrollBars;
Mike Cleron52f0a642009-09-28 18:21:37 -07007629 }
Joe Malin32736f02011-01-19 16:14:20 -08007630
Mike Cleron52f0a642009-09-28 18:21:37 -07007631 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007632 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
7633 * inset. When inset, they add to the padding of the view. And the scrollbars
7634 * can be drawn inside the padding area or on the edge of the view. For example,
7635 * if a view has a background drawable and you want to draw the scrollbars
7636 * inside the padding specified by the drawable, you can use
7637 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
7638 * appear at the edge of the view, ignoring the padding, then you can use
7639 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
7640 * @param style the style of the scrollbars. Should be one of
7641 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
7642 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
7643 * @see #SCROLLBARS_INSIDE_OVERLAY
7644 * @see #SCROLLBARS_INSIDE_INSET
7645 * @see #SCROLLBARS_OUTSIDE_OVERLAY
7646 * @see #SCROLLBARS_OUTSIDE_INSET
7647 */
7648 public void setScrollBarStyle(int style) {
7649 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
7650 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -07007651 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007652 recomputePadding();
7653 }
7654 }
7655
7656 /**
7657 * <p>Returns the current scrollbar style.</p>
7658 * @return the current scrollbar style
7659 * @see #SCROLLBARS_INSIDE_OVERLAY
7660 * @see #SCROLLBARS_INSIDE_INSET
7661 * @see #SCROLLBARS_OUTSIDE_OVERLAY
7662 * @see #SCROLLBARS_OUTSIDE_INSET
7663 */
7664 public int getScrollBarStyle() {
7665 return mViewFlags & SCROLLBARS_STYLE_MASK;
7666 }
7667
7668 /**
7669 * <p>Compute the horizontal range that the horizontal scrollbar
7670 * represents.</p>
7671 *
7672 * <p>The range is expressed in arbitrary units that must be the same as the
7673 * units used by {@link #computeHorizontalScrollExtent()} and
7674 * {@link #computeHorizontalScrollOffset()}.</p>
7675 *
7676 * <p>The default range is the drawing width of this view.</p>
7677 *
7678 * @return the total horizontal range represented by the horizontal
7679 * scrollbar
7680 *
7681 * @see #computeHorizontalScrollExtent()
7682 * @see #computeHorizontalScrollOffset()
7683 * @see android.widget.ScrollBarDrawable
7684 */
7685 protected int computeHorizontalScrollRange() {
7686 return getWidth();
7687 }
7688
7689 /**
7690 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
7691 * within the horizontal range. This value is used to compute the position
7692 * of the thumb within the scrollbar's track.</p>
7693 *
7694 * <p>The range is expressed in arbitrary units that must be the same as the
7695 * units used by {@link #computeHorizontalScrollRange()} and
7696 * {@link #computeHorizontalScrollExtent()}.</p>
7697 *
7698 * <p>The default offset is the scroll offset of this view.</p>
7699 *
7700 * @return the horizontal offset of the scrollbar's thumb
7701 *
7702 * @see #computeHorizontalScrollRange()
7703 * @see #computeHorizontalScrollExtent()
7704 * @see android.widget.ScrollBarDrawable
7705 */
7706 protected int computeHorizontalScrollOffset() {
7707 return mScrollX;
7708 }
7709
7710 /**
7711 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
7712 * within the horizontal range. This value is used to compute the length
7713 * of the thumb within the scrollbar's track.</p>
7714 *
7715 * <p>The range is expressed in arbitrary units that must be the same as the
7716 * units used by {@link #computeHorizontalScrollRange()} and
7717 * {@link #computeHorizontalScrollOffset()}.</p>
7718 *
7719 * <p>The default extent is the drawing width of this view.</p>
7720 *
7721 * @return the horizontal extent of the scrollbar's thumb
7722 *
7723 * @see #computeHorizontalScrollRange()
7724 * @see #computeHorizontalScrollOffset()
7725 * @see android.widget.ScrollBarDrawable
7726 */
7727 protected int computeHorizontalScrollExtent() {
7728 return getWidth();
7729 }
7730
7731 /**
7732 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
7733 *
7734 * <p>The range is expressed in arbitrary units that must be the same as the
7735 * units used by {@link #computeVerticalScrollExtent()} and
7736 * {@link #computeVerticalScrollOffset()}.</p>
7737 *
7738 * @return the total vertical range represented by the vertical scrollbar
7739 *
7740 * <p>The default range is the drawing height of this view.</p>
7741 *
7742 * @see #computeVerticalScrollExtent()
7743 * @see #computeVerticalScrollOffset()
7744 * @see android.widget.ScrollBarDrawable
7745 */
7746 protected int computeVerticalScrollRange() {
7747 return getHeight();
7748 }
7749
7750 /**
7751 * <p>Compute the vertical offset of the vertical scrollbar's thumb
7752 * within the horizontal range. This value is used to compute the position
7753 * of the thumb within the scrollbar's track.</p>
7754 *
7755 * <p>The range is expressed in arbitrary units that must be the same as the
7756 * units used by {@link #computeVerticalScrollRange()} and
7757 * {@link #computeVerticalScrollExtent()}.</p>
7758 *
7759 * <p>The default offset is the scroll offset of this view.</p>
7760 *
7761 * @return the vertical offset of the scrollbar's thumb
7762 *
7763 * @see #computeVerticalScrollRange()
7764 * @see #computeVerticalScrollExtent()
7765 * @see android.widget.ScrollBarDrawable
7766 */
7767 protected int computeVerticalScrollOffset() {
7768 return mScrollY;
7769 }
7770
7771 /**
7772 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
7773 * within the vertical range. This value is used to compute the length
7774 * of the thumb within the scrollbar's track.</p>
7775 *
7776 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -08007777 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007778 * {@link #computeVerticalScrollOffset()}.</p>
7779 *
7780 * <p>The default extent is the drawing height of this view.</p>
7781 *
7782 * @return the vertical extent of the scrollbar's thumb
7783 *
7784 * @see #computeVerticalScrollRange()
7785 * @see #computeVerticalScrollOffset()
7786 * @see android.widget.ScrollBarDrawable
7787 */
7788 protected int computeVerticalScrollExtent() {
7789 return getHeight();
7790 }
7791
7792 /**
7793 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
7794 * scrollbars are painted only if they have been awakened first.</p>
7795 *
7796 * @param canvas the canvas on which to draw the scrollbars
Joe Malin32736f02011-01-19 16:14:20 -08007797 *
Mike Cleronf116bf82009-09-27 19:14:12 -07007798 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007799 */
Romain Guy1d5b3a62009-11-05 18:44:12 -08007800 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007801 // scrollbars are drawn only when the animation is running
7802 final ScrollabilityCache cache = mScrollCache;
7803 if (cache != null) {
Joe Malin32736f02011-01-19 16:14:20 -08007804
Mike Cleronf116bf82009-09-27 19:14:12 -07007805 int state = cache.state;
Joe Malin32736f02011-01-19 16:14:20 -08007806
Mike Cleronf116bf82009-09-27 19:14:12 -07007807 if (state == ScrollabilityCache.OFF) {
7808 return;
7809 }
Joe Malin32736f02011-01-19 16:14:20 -08007810
Mike Cleronf116bf82009-09-27 19:14:12 -07007811 boolean invalidate = false;
Joe Malin32736f02011-01-19 16:14:20 -08007812
Mike Cleronf116bf82009-09-27 19:14:12 -07007813 if (state == ScrollabilityCache.FADING) {
7814 // We're fading -- get our fade interpolation
7815 if (cache.interpolatorValues == null) {
7816 cache.interpolatorValues = new float[1];
7817 }
Joe Malin32736f02011-01-19 16:14:20 -08007818
Mike Cleronf116bf82009-09-27 19:14:12 -07007819 float[] values = cache.interpolatorValues;
Joe Malin32736f02011-01-19 16:14:20 -08007820
Mike Cleronf116bf82009-09-27 19:14:12 -07007821 // Stops the animation if we're done
7822 if (cache.scrollBarInterpolator.timeToValues(values) ==
7823 Interpolator.Result.FREEZE_END) {
7824 cache.state = ScrollabilityCache.OFF;
7825 } else {
7826 cache.scrollBar.setAlpha(Math.round(values[0]));
7827 }
Joe Malin32736f02011-01-19 16:14:20 -08007828
7829 // This will make the scroll bars inval themselves after
Mike Cleronf116bf82009-09-27 19:14:12 -07007830 // drawing. We only want this when we're fading so that
7831 // we prevent excessive redraws
7832 invalidate = true;
7833 } else {
7834 // We're just on -- but we may have been fading before so
7835 // reset alpha
7836 cache.scrollBar.setAlpha(255);
7837 }
7838
Joe Malin32736f02011-01-19 16:14:20 -08007839
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007840 final int viewFlags = mViewFlags;
7841
7842 final boolean drawHorizontalScrollBar =
7843 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
7844 final boolean drawVerticalScrollBar =
7845 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
7846 && !isVerticalScrollBarHidden();
7847
7848 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
7849 final int width = mRight - mLeft;
7850 final int height = mBottom - mTop;
7851
7852 final ScrollBarDrawable scrollBar = cache.scrollBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007853
Mike Reede8853fc2009-09-04 14:01:48 -04007854 final int scrollX = mScrollX;
7855 final int scrollY = mScrollY;
7856 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
7857
Mike Cleronf116bf82009-09-27 19:14:12 -07007858 int left, top, right, bottom;
Joe Malin32736f02011-01-19 16:14:20 -08007859
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007860 if (drawHorizontalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -08007861 int size = scrollBar.getSize(false);
7862 if (size <= 0) {
7863 size = cache.scrollBarSize;
7864 }
7865
Mike Cleronf116bf82009-09-27 19:14:12 -07007866 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -04007867 computeHorizontalScrollOffset(),
7868 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -04007869 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -07007870 getVerticalScrollbarWidth() : 0;
Joe Malin32736f02011-01-19 16:14:20 -08007871 top = scrollY + height - size - (mUserPaddingBottom & inside);
Mike Cleronf116bf82009-09-27 19:14:12 -07007872 left = scrollX + (mPaddingLeft & inside);
7873 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
7874 bottom = top + size;
7875 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
7876 if (invalidate) {
7877 invalidate(left, top, right, bottom);
7878 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007879 }
7880
7881 if (drawVerticalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -08007882 int size = scrollBar.getSize(true);
7883 if (size <= 0) {
7884 size = cache.scrollBarSize;
7885 }
7886
Mike Reede8853fc2009-09-04 14:01:48 -04007887 scrollBar.setParameters(computeVerticalScrollRange(),
7888 computeVerticalScrollOffset(),
7889 computeVerticalScrollExtent(), true);
Adam Powell20232d02010-12-08 21:08:53 -08007890 switch (mVerticalScrollbarPosition) {
7891 default:
7892 case SCROLLBAR_POSITION_DEFAULT:
7893 case SCROLLBAR_POSITION_RIGHT:
7894 left = scrollX + width - size - (mUserPaddingRight & inside);
7895 break;
7896 case SCROLLBAR_POSITION_LEFT:
7897 left = scrollX + (mUserPaddingLeft & inside);
7898 break;
7899 }
Mike Cleronf116bf82009-09-27 19:14:12 -07007900 top = scrollY + (mPaddingTop & inside);
7901 right = left + size;
7902 bottom = scrollY + height - (mUserPaddingBottom & inside);
7903 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
7904 if (invalidate) {
7905 invalidate(left, top, right, bottom);
7906 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007907 }
7908 }
7909 }
7910 }
Romain Guy8506ab42009-06-11 17:35:47 -07007911
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007912 /**
Romain Guy8506ab42009-06-11 17:35:47 -07007913 * 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 -08007914 * FastScroller is visible.
7915 * @return whether to temporarily hide the vertical scrollbar
7916 * @hide
7917 */
7918 protected boolean isVerticalScrollBarHidden() {
7919 return false;
7920 }
7921
7922 /**
7923 * <p>Draw the horizontal scrollbar if
7924 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
7925 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007926 * @param canvas the canvas on which to draw the scrollbar
7927 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007928 *
7929 * @see #isHorizontalScrollBarEnabled()
7930 * @see #computeHorizontalScrollRange()
7931 * @see #computeHorizontalScrollExtent()
7932 * @see #computeHorizontalScrollOffset()
7933 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -07007934 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007935 */
Romain Guy8fb95422010-08-17 18:38:51 -07007936 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
7937 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007938 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007939 scrollBar.draw(canvas);
7940 }
Mike Reede8853fc2009-09-04 14:01:48 -04007941
Mike Reed4d6fe5f2009-09-03 13:29:05 -04007942 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007943 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
7944 * returns true.</p>
7945 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007946 * @param canvas the canvas on which to draw the scrollbar
7947 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007948 *
7949 * @see #isVerticalScrollBarEnabled()
7950 * @see #computeVerticalScrollRange()
7951 * @see #computeVerticalScrollExtent()
7952 * @see #computeVerticalScrollOffset()
7953 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -04007954 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007955 */
Romain Guy8fb95422010-08-17 18:38:51 -07007956 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
7957 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -04007958 scrollBar.setBounds(l, t, r, b);
7959 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007960 }
7961
7962 /**
7963 * Implement this to do your drawing.
7964 *
7965 * @param canvas the canvas on which the background will be drawn
7966 */
7967 protected void onDraw(Canvas canvas) {
7968 }
7969
7970 /*
7971 * Caller is responsible for calling requestLayout if necessary.
7972 * (This allows addViewInLayout to not request a new layout.)
7973 */
7974 void assignParent(ViewParent parent) {
7975 if (mParent == null) {
7976 mParent = parent;
7977 } else if (parent == null) {
7978 mParent = null;
7979 } else {
7980 throw new RuntimeException("view " + this + " being added, but"
7981 + " it already has a parent");
7982 }
7983 }
7984
7985 /**
7986 * This is called when the view is attached to a window. At this point it
7987 * has a Surface and will start drawing. Note that this function is
7988 * guaranteed to be called before {@link #onDraw}, however it may be called
7989 * any time before the first onDraw -- including before or after
7990 * {@link #onMeasure}.
7991 *
7992 * @see #onDetachedFromWindow()
7993 */
7994 protected void onAttachedToWindow() {
7995 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
7996 mParent.requestTransparentRegion(this);
7997 }
Adam Powell8568c3a2010-04-19 14:26:11 -07007998 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
7999 initialAwakenScrollBars();
8000 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
8001 }
Chet Haasea9b61ac2010-12-20 07:40:25 -08008002 jumpDrawablesToCurrentState();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008003 }
8004
8005 /**
8006 * This is called when the view is detached from a window. At this point it
8007 * no longer has a surface for drawing.
8008 *
8009 * @see #onAttachedToWindow()
8010 */
8011 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -08008012 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -08008013
Romain Guya440b002010-02-24 15:57:54 -08008014 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -05008015 removeLongPressCallback();
Adam Powell3cb8b632011-01-21 15:34:14 -08008016 removePerformClickCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -08008017
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008018 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -08008019
8020 if (mHardwareLayer != null) {
8021 mHardwareLayer.destroy();
8022 mHardwareLayer = null;
8023 }
Romain Guy8dd5b1e2011-01-14 17:28:51 -08008024
Chet Haasedaf98e92011-01-10 14:10:36 -08008025 if (mDisplayList != null) {
8026 mDisplayList.invalidate();
8027 }
8028
Romain Guy8dd5b1e2011-01-14 17:28:51 -08008029 if (mAttachInfo != null) {
8030 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_MSG, this);
8031 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_RECT_MSG, this);
8032 }
8033
Patrick Dubroyec84c3a2011-01-13 17:55:37 -08008034 mCurrentAnimation = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008035 }
8036
8037 /**
8038 * @return The number of times this view has been attached to a window
8039 */
8040 protected int getWindowAttachCount() {
8041 return mWindowAttachCount;
8042 }
8043
8044 /**
8045 * Retrieve a unique token identifying the window this view is attached to.
8046 * @return Return the window's token for use in
8047 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
8048 */
8049 public IBinder getWindowToken() {
8050 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
8051 }
8052
8053 /**
8054 * Retrieve a unique token identifying the top-level "real" window of
8055 * the window that this view is attached to. That is, this is like
8056 * {@link #getWindowToken}, except if the window this view in is a panel
8057 * window (attached to another containing window), then the token of
8058 * the containing window is returned instead.
8059 *
8060 * @return Returns the associated window token, either
8061 * {@link #getWindowToken()} or the containing window's token.
8062 */
8063 public IBinder getApplicationWindowToken() {
8064 AttachInfo ai = mAttachInfo;
8065 if (ai != null) {
8066 IBinder appWindowToken = ai.mPanelParentWindowToken;
8067 if (appWindowToken == null) {
8068 appWindowToken = ai.mWindowToken;
8069 }
8070 return appWindowToken;
8071 }
8072 return null;
8073 }
8074
8075 /**
8076 * Retrieve private session object this view hierarchy is using to
8077 * communicate with the window manager.
8078 * @return the session object to communicate with the window manager
8079 */
8080 /*package*/ IWindowSession getWindowSession() {
8081 return mAttachInfo != null ? mAttachInfo.mSession : null;
8082 }
8083
8084 /**
8085 * @param info the {@link android.view.View.AttachInfo} to associated with
8086 * this view
8087 */
8088 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
8089 //System.out.println("Attached! " + this);
8090 mAttachInfo = info;
8091 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08008092 // We will need to evaluate the drawable state at least once.
8093 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008094 if (mFloatingTreeObserver != null) {
8095 info.mTreeObserver.merge(mFloatingTreeObserver);
8096 mFloatingTreeObserver = null;
8097 }
8098 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
8099 mAttachInfo.mScrollContainers.add(this);
8100 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
8101 }
8102 performCollectViewAttributes(visibility);
8103 onAttachedToWindow();
Adam Powell4afd62b2011-02-18 15:02:18 -08008104
8105 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
8106 mOnAttachStateChangeListeners;
8107 if (listeners != null && listeners.size() > 0) {
8108 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
8109 // perform the dispatching. The iterator is a safe guard against listeners that
8110 // could mutate the list by calling the various add/remove methods. This prevents
8111 // the array from being modified while we iterate it.
8112 for (OnAttachStateChangeListener listener : listeners) {
8113 listener.onViewAttachedToWindow(this);
8114 }
8115 }
8116
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008117 int vis = info.mWindowVisibility;
8118 if (vis != GONE) {
8119 onWindowVisibilityChanged(vis);
8120 }
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08008121 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) {
8122 // If nobody has evaluated the drawable state yet, then do it now.
8123 refreshDrawableState();
8124 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008125 }
8126
8127 void dispatchDetachedFromWindow() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008128 AttachInfo info = mAttachInfo;
8129 if (info != null) {
8130 int vis = info.mWindowVisibility;
8131 if (vis != GONE) {
8132 onWindowVisibilityChanged(GONE);
8133 }
8134 }
8135
8136 onDetachedFromWindow();
Romain Guy01d5edc2011-01-28 11:28:53 -08008137
Adam Powell4afd62b2011-02-18 15:02:18 -08008138 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
8139 mOnAttachStateChangeListeners;
8140 if (listeners != null && listeners.size() > 0) {
8141 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
8142 // perform the dispatching. The iterator is a safe guard against listeners that
8143 // could mutate the list by calling the various add/remove methods. This prevents
8144 // the array from being modified while we iterate it.
8145 for (OnAttachStateChangeListener listener : listeners) {
8146 listener.onViewDetachedFromWindow(this);
8147 }
8148 }
8149
Romain Guy01d5edc2011-01-28 11:28:53 -08008150 if ((mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008151 mAttachInfo.mScrollContainers.remove(this);
8152 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
8153 }
Romain Guy01d5edc2011-01-28 11:28:53 -08008154
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008155 mAttachInfo = null;
8156 }
8157
8158 /**
8159 * Store this view hierarchy's frozen state into the given container.
8160 *
8161 * @param container The SparseArray in which to save the view's state.
8162 *
8163 * @see #restoreHierarchyState
8164 * @see #dispatchSaveInstanceState
8165 * @see #onSaveInstanceState
8166 */
8167 public void saveHierarchyState(SparseArray<Parcelable> container) {
8168 dispatchSaveInstanceState(container);
8169 }
8170
8171 /**
8172 * Called by {@link #saveHierarchyState} to store the state for this view and its children.
8173 * May be overridden to modify how freezing happens to a view's children; for example, some
8174 * views may want to not store state for their children.
8175 *
8176 * @param container The SparseArray in which to save the view's state.
8177 *
8178 * @see #dispatchRestoreInstanceState
8179 * @see #saveHierarchyState
8180 * @see #onSaveInstanceState
8181 */
8182 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
8183 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
8184 mPrivateFlags &= ~SAVE_STATE_CALLED;
8185 Parcelable state = onSaveInstanceState();
8186 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
8187 throw new IllegalStateException(
8188 "Derived class did not call super.onSaveInstanceState()");
8189 }
8190 if (state != null) {
8191 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
8192 // + ": " + state);
8193 container.put(mID, state);
8194 }
8195 }
8196 }
8197
8198 /**
8199 * Hook allowing a view to generate a representation of its internal state
8200 * that can later be used to create a new instance with that same state.
8201 * This state should only contain information that is not persistent or can
8202 * not be reconstructed later. For example, you will never store your
8203 * current position on screen because that will be computed again when a
8204 * new instance of the view is placed in its view hierarchy.
8205 * <p>
8206 * Some examples of things you may store here: the current cursor position
8207 * in a text view (but usually not the text itself since that is stored in a
8208 * content provider or other persistent storage), the currently selected
8209 * item in a list view.
8210 *
8211 * @return Returns a Parcelable object containing the view's current dynamic
8212 * state, or null if there is nothing interesting to save. The
8213 * default implementation returns null.
8214 * @see #onRestoreInstanceState
8215 * @see #saveHierarchyState
8216 * @see #dispatchSaveInstanceState
8217 * @see #setSaveEnabled(boolean)
8218 */
8219 protected Parcelable onSaveInstanceState() {
8220 mPrivateFlags |= SAVE_STATE_CALLED;
8221 return BaseSavedState.EMPTY_STATE;
8222 }
8223
8224 /**
8225 * Restore this view hierarchy's frozen state from the given container.
8226 *
8227 * @param container The SparseArray which holds previously frozen states.
8228 *
8229 * @see #saveHierarchyState
8230 * @see #dispatchRestoreInstanceState
8231 * @see #onRestoreInstanceState
8232 */
8233 public void restoreHierarchyState(SparseArray<Parcelable> container) {
8234 dispatchRestoreInstanceState(container);
8235 }
8236
8237 /**
8238 * Called by {@link #restoreHierarchyState} to retrieve the state for this view and its
8239 * children. May be overridden to modify how restoreing happens to a view's children; for
8240 * example, some views may want to not store state for their children.
8241 *
8242 * @param container The SparseArray which holds previously saved state.
8243 *
8244 * @see #dispatchSaveInstanceState
8245 * @see #restoreHierarchyState
8246 * @see #onRestoreInstanceState
8247 */
8248 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
8249 if (mID != NO_ID) {
8250 Parcelable state = container.get(mID);
8251 if (state != null) {
8252 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
8253 // + ": " + state);
8254 mPrivateFlags &= ~SAVE_STATE_CALLED;
8255 onRestoreInstanceState(state);
8256 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
8257 throw new IllegalStateException(
8258 "Derived class did not call super.onRestoreInstanceState()");
8259 }
8260 }
8261 }
8262 }
8263
8264 /**
8265 * Hook allowing a view to re-apply a representation of its internal state that had previously
8266 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
8267 * null state.
8268 *
8269 * @param state The frozen state that had previously been returned by
8270 * {@link #onSaveInstanceState}.
8271 *
8272 * @see #onSaveInstanceState
8273 * @see #restoreHierarchyState
8274 * @see #dispatchRestoreInstanceState
8275 */
8276 protected void onRestoreInstanceState(Parcelable state) {
8277 mPrivateFlags |= SAVE_STATE_CALLED;
8278 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -08008279 throw new IllegalArgumentException("Wrong state class, expecting View State but "
8280 + "received " + state.getClass().toString() + " instead. This usually happens "
Joe Malin32736f02011-01-19 16:14:20 -08008281 + "when two views of different type have the same id in the same hierarchy. "
8282 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
Romain Guy237c1ce2009-12-08 11:30:25 -08008283 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008284 }
8285 }
8286
8287 /**
8288 * <p>Return the time at which the drawing of the view hierarchy started.</p>
8289 *
8290 * @return the drawing start time in milliseconds
8291 */
8292 public long getDrawingTime() {
8293 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
8294 }
8295
8296 /**
8297 * <p>Enables or disables the duplication of the parent's state into this view. When
8298 * duplication is enabled, this view gets its drawable state from its parent rather
8299 * than from its own internal properties.</p>
8300 *
8301 * <p>Note: in the current implementation, setting this property to true after the
8302 * view was added to a ViewGroup might have no effect at all. This property should
8303 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
8304 *
8305 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
8306 * property is enabled, an exception will be thrown.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008307 *
Gilles Debunnefb817032011-01-13 13:52:49 -08008308 * <p>Note: if the child view uses and updates additionnal states which are unknown to the
8309 * parent, these states should not be affected by this method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008310 *
8311 * @param enabled True to enable duplication of the parent's drawable state, false
8312 * to disable it.
8313 *
8314 * @see #getDrawableState()
8315 * @see #isDuplicateParentStateEnabled()
8316 */
8317 public void setDuplicateParentStateEnabled(boolean enabled) {
8318 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
8319 }
8320
8321 /**
8322 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
8323 *
8324 * @return True if this view's drawable state is duplicated from the parent,
8325 * false otherwise
8326 *
8327 * @see #getDrawableState()
8328 * @see #setDuplicateParentStateEnabled(boolean)
8329 */
8330 public boolean isDuplicateParentStateEnabled() {
8331 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
8332 }
8333
8334 /**
Romain Guy171c5922011-01-06 10:04:23 -08008335 * <p>Specifies the type of layer backing this view. The layer can be
8336 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
8337 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008338 *
Romain Guy171c5922011-01-06 10:04:23 -08008339 * <p>A layer is associated with an optional {@link android.graphics.Paint}
8340 * instance that controls how the layer is composed on screen. The following
8341 * properties of the paint are taken into account when composing the layer:</p>
8342 * <ul>
8343 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
8344 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
8345 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
8346 * </ul>
Joe Malin32736f02011-01-19 16:14:20 -08008347 *
Romain Guy171c5922011-01-06 10:04:23 -08008348 * <p>If this view has an alpha value set to < 1.0 by calling
8349 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
8350 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
8351 * equivalent to setting a hardware layer on this view and providing a paint with
8352 * the desired alpha value.<p>
Joe Malin32736f02011-01-19 16:14:20 -08008353 *
Romain Guy171c5922011-01-06 10:04:23 -08008354 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
8355 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
8356 * for more information on when and how to use layers.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008357 *
Romain Guy171c5922011-01-06 10:04:23 -08008358 * @param layerType The ype of layer to use with this view, must be one of
8359 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
8360 * {@link #LAYER_TYPE_HARDWARE}
8361 * @param paint The paint used to compose the layer. This argument is optional
8362 * and can be null. It is ignored when the layer type is
8363 * {@link #LAYER_TYPE_NONE}
Joe Malin32736f02011-01-19 16:14:20 -08008364 *
8365 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -08008366 * @see #LAYER_TYPE_NONE
8367 * @see #LAYER_TYPE_SOFTWARE
8368 * @see #LAYER_TYPE_HARDWARE
Joe Malin32736f02011-01-19 16:14:20 -08008369 * @see #setAlpha(float)
8370 *
Romain Guy171c5922011-01-06 10:04:23 -08008371 * @attr ref android.R.styleable#View_layerType
8372 */
8373 public void setLayerType(int layerType, Paint paint) {
8374 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
Joe Malin32736f02011-01-19 16:14:20 -08008375 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
Romain Guy171c5922011-01-06 10:04:23 -08008376 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
8377 }
Chet Haasedaf98e92011-01-10 14:10:36 -08008378
Romain Guyd6cd5722011-01-17 14:42:41 -08008379 if (layerType == mLayerType) {
8380 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) {
8381 mLayerPaint = paint == null ? new Paint() : paint;
Romain Guy0fd89bf2011-01-26 15:41:30 -08008382 invalidateParentCaches();
8383 invalidate(true);
Romain Guyd6cd5722011-01-17 14:42:41 -08008384 }
8385 return;
8386 }
Romain Guy171c5922011-01-06 10:04:23 -08008387
8388 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -08008389 switch (mLayerType) {
8390 case LAYER_TYPE_SOFTWARE:
8391 if (mDrawingCache != null) {
8392 mDrawingCache.recycle();
8393 mDrawingCache = null;
8394 }
Joe Malin32736f02011-01-19 16:14:20 -08008395
Romain Guy6c319ca2011-01-11 14:29:25 -08008396 if (mUnscaledDrawingCache != null) {
8397 mUnscaledDrawingCache.recycle();
8398 mUnscaledDrawingCache = null;
8399 }
8400 break;
8401 case LAYER_TYPE_HARDWARE:
8402 if (mHardwareLayer != null) {
8403 mHardwareLayer.destroy();
8404 mHardwareLayer = null;
8405 }
8406 break;
8407 default:
8408 break;
Romain Guy171c5922011-01-06 10:04:23 -08008409 }
8410
8411 mLayerType = layerType;
Romain Guy3a3133d2011-02-01 22:59:58 -08008412 final boolean layerDisabled = mLayerType == LAYER_TYPE_NONE;
8413 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint);
8414 mLocalDirtyRect = layerDisabled ? null : new Rect();
Romain Guy171c5922011-01-06 10:04:23 -08008415
Romain Guy0fd89bf2011-01-26 15:41:30 -08008416 invalidateParentCaches();
8417 invalidate(true);
Romain Guy171c5922011-01-06 10:04:23 -08008418 }
8419
8420 /**
8421 * Indicates what type of layer is currently associated with this view. By default
8422 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
8423 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
8424 * for more information on the different types of layers.
Joe Malin32736f02011-01-19 16:14:20 -08008425 *
Romain Guy171c5922011-01-06 10:04:23 -08008426 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
8427 * {@link #LAYER_TYPE_HARDWARE}
Joe Malin32736f02011-01-19 16:14:20 -08008428 *
8429 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08008430 * @see #LAYER_TYPE_NONE
8431 * @see #LAYER_TYPE_SOFTWARE
8432 * @see #LAYER_TYPE_HARDWARE
8433 */
8434 public int getLayerType() {
8435 return mLayerType;
8436 }
Joe Malin32736f02011-01-19 16:14:20 -08008437
Romain Guy6c319ca2011-01-11 14:29:25 -08008438 /**
8439 * <p>Returns a hardware layer that can be used to draw this view again
8440 * without executing its draw method.</p>
8441 *
8442 * @return A HardwareLayer ready to render, or null if an error occurred.
8443 */
Romain Guy5e7f7662011-01-24 22:35:56 -08008444 HardwareLayer getHardwareLayer() {
Romain Guy6c319ca2011-01-11 14:29:25 -08008445 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) {
8446 return null;
8447 }
8448
8449 final int width = mRight - mLeft;
8450 final int height = mBottom - mTop;
Joe Malin32736f02011-01-19 16:14:20 -08008451
Romain Guy6c319ca2011-01-11 14:29:25 -08008452 if (width == 0 || height == 0) {
8453 return null;
8454 }
8455
8456 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
8457 if (mHardwareLayer == null) {
8458 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
8459 width, height, isOpaque());
Romain Guy62687ec2011-02-02 15:44:19 -08008460 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -08008461 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
8462 mHardwareLayer.resize(width, height);
Romain Guy62687ec2011-02-02 15:44:19 -08008463 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -08008464 }
8465
Romain Guy5e7f7662011-01-24 22:35:56 -08008466 Canvas currentCanvas = mAttachInfo.mHardwareCanvas;
8467 final HardwareCanvas canvas = mHardwareLayer.start(currentCanvas);
8468 mAttachInfo.mHardwareCanvas = canvas;
Romain Guy6c319ca2011-01-11 14:29:25 -08008469 try {
8470 canvas.setViewport(width, height);
Romain Guy3a3133d2011-02-01 22:59:58 -08008471 canvas.onPreDraw(mLocalDirtyRect);
Romain Guy62687ec2011-02-02 15:44:19 -08008472 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -08008473
Romain Guy4f09f542011-01-26 22:41:43 -08008474 final int restoreCount = canvas.save();
8475
Romain Guy6c319ca2011-01-11 14:29:25 -08008476 computeScroll();
8477 canvas.translate(-mScrollX, -mScrollY);
8478
Romain Guy6c319ca2011-01-11 14:29:25 -08008479 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
Joe Malin32736f02011-01-19 16:14:20 -08008480
Romain Guy6c319ca2011-01-11 14:29:25 -08008481 // Fast path for layouts with no backgrounds
8482 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8483 mPrivateFlags &= ~DIRTY_MASK;
8484 dispatchDraw(canvas);
8485 } else {
8486 draw(canvas);
8487 }
Joe Malin32736f02011-01-19 16:14:20 -08008488
Romain Guy6c319ca2011-01-11 14:29:25 -08008489 canvas.restoreToCount(restoreCount);
8490 } finally {
8491 canvas.onPostDraw();
Romain Guy5e7f7662011-01-24 22:35:56 -08008492 mHardwareLayer.end(currentCanvas);
8493 mAttachInfo.mHardwareCanvas = currentCanvas;
Romain Guy6c319ca2011-01-11 14:29:25 -08008494 }
8495 }
8496
8497 return mHardwareLayer;
8498 }
Romain Guy171c5922011-01-06 10:04:23 -08008499
8500 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008501 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
8502 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
8503 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
8504 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
8505 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
8506 * null.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008507 *
Romain Guy171c5922011-01-06 10:04:23 -08008508 * <p>Enabling the drawing cache is similar to
8509 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
Chet Haasedaf98e92011-01-10 14:10:36 -08008510 * acceleration is turned off. When hardware acceleration is turned on, enabling the
8511 * drawing cache has no effect on rendering because the system uses a different mechanism
8512 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even
8513 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)}
8514 * for information on how to enable software and hardware layers.</p>
8515 *
8516 * <p>This API can be used to manually generate
8517 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling
8518 * {@link #getDrawingCache()}.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008519 *
8520 * @param enabled true to enable the drawing cache, false otherwise
8521 *
8522 * @see #isDrawingCacheEnabled()
8523 * @see #getDrawingCache()
8524 * @see #buildDrawingCache()
Joe Malin32736f02011-01-19 16:14:20 -08008525 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008526 */
8527 public void setDrawingCacheEnabled(boolean enabled) {
Romain Guy0211a0a2011-02-14 16:34:59 -08008528 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008529 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
8530 }
8531
8532 /**
8533 * <p>Indicates whether the drawing cache is enabled for this view.</p>
8534 *
8535 * @return true if the drawing cache is enabled
8536 *
8537 * @see #setDrawingCacheEnabled(boolean)
8538 * @see #getDrawingCache()
8539 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008540 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008541 public boolean isDrawingCacheEnabled() {
8542 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
8543 }
8544
8545 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08008546 * Debugging utility which recursively outputs the dirty state of a view and its
8547 * descendants.
Joe Malin32736f02011-01-19 16:14:20 -08008548 *
Chet Haasedaf98e92011-01-10 14:10:36 -08008549 * @hide
8550 */
Romain Guy676b1732011-02-14 14:45:33 -08008551 @SuppressWarnings({"UnusedDeclaration"})
Chet Haasedaf98e92011-01-10 14:10:36 -08008552 public void outputDirtyFlags(String indent, boolean clear, int clearMask) {
8553 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) +
8554 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" +
8555 (mPrivateFlags & View.DRAWING_CACHE_VALID) +
8556 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")");
8557 if (clear) {
8558 mPrivateFlags &= clearMask;
8559 }
8560 if (this instanceof ViewGroup) {
8561 ViewGroup parent = (ViewGroup) this;
8562 final int count = parent.getChildCount();
8563 for (int i = 0; i < count; i++) {
Romain Guy7d7b5492011-01-24 16:33:45 -08008564 final View child = parent.getChildAt(i);
Chet Haasedaf98e92011-01-10 14:10:36 -08008565 child.outputDirtyFlags(indent + " ", clear, clearMask);
8566 }
8567 }
8568 }
8569
8570 /**
8571 * This method is used by ViewGroup to cause its children to restore or recreate their
8572 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need
8573 * to recreate its own display list, which would happen if it went through the normal
8574 * draw/dispatchDraw mechanisms.
8575 *
8576 * @hide
8577 */
8578 protected void dispatchGetDisplayList() {}
Chet Haasef4ac5472011-01-27 10:30:25 -08008579
8580 /**
8581 * A view that is not attached or hardware accelerated cannot create a display list.
8582 * This method checks these conditions and returns the appropriate result.
8583 *
8584 * @return true if view has the ability to create a display list, false otherwise.
8585 *
8586 * @hide
8587 */
8588 public boolean canHaveDisplayList() {
Romain Guy676b1732011-02-14 14:45:33 -08008589 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null);
Chet Haasef4ac5472011-01-27 10:30:25 -08008590 }
Joe Malin32736f02011-01-19 16:14:20 -08008591
Chet Haasedaf98e92011-01-10 14:10:36 -08008592 /**
Romain Guyb051e892010-09-28 19:09:36 -07008593 * <p>Returns a display list that can be used to draw this view again
8594 * without executing its draw method.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008595 *
Romain Guyb051e892010-09-28 19:09:36 -07008596 * @return A DisplayList ready to replay, or null if caching is not enabled.
Chet Haasedaf98e92011-01-10 14:10:36 -08008597 *
8598 * @hide
Romain Guyb051e892010-09-28 19:09:36 -07008599 */
Chet Haasedaf98e92011-01-10 14:10:36 -08008600 public DisplayList getDisplayList() {
Chet Haasef4ac5472011-01-27 10:30:25 -08008601 if (!canHaveDisplayList()) {
Romain Guyb051e892010-09-28 19:09:36 -07008602 return null;
8603 }
8604
Chet Haasedaf98e92011-01-10 14:10:36 -08008605 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 ||
8606 mDisplayList == null || !mDisplayList.isValid() ||
8607 mRecreateDisplayList)) {
8608 // Don't need to recreate the display list, just need to tell our
8609 // children to restore/recreate theirs
8610 if (mDisplayList != null && mDisplayList.isValid() &&
8611 !mRecreateDisplayList) {
8612 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
8613 mPrivateFlags &= ~DIRTY_MASK;
8614 dispatchGetDisplayList();
8615
8616 return mDisplayList;
8617 }
8618
8619 // If we got here, we're recreating it. Mark it as such to ensure that
8620 // we copy in child display lists into ours in drawChild()
8621 mRecreateDisplayList = true;
Chet Haase9e90a992011-01-04 16:23:21 -08008622 if (mDisplayList == null) {
Chet Haasedaf98e92011-01-10 14:10:36 -08008623 mDisplayList = mAttachInfo.mHardwareRenderer.createDisplayList(this);
8624 // If we're creating a new display list, make sure our parent gets invalidated
8625 // since they will need to recreate their display list to account for this
8626 // new child display list.
Romain Guy0fd89bf2011-01-26 15:41:30 -08008627 invalidateParentCaches();
Chet Haase9e90a992011-01-04 16:23:21 -08008628 }
Romain Guyb051e892010-09-28 19:09:36 -07008629
8630 final HardwareCanvas canvas = mDisplayList.start();
8631 try {
8632 int width = mRight - mLeft;
8633 int height = mBottom - mTop;
8634
8635 canvas.setViewport(width, height);
Romain Guy7d7b5492011-01-24 16:33:45 -08008636 // The dirty rect should always be null for a display list
8637 canvas.onPreDraw(null);
Romain Guyb051e892010-09-28 19:09:36 -07008638
8639 final int restoreCount = canvas.save();
8640
Chet Haasedaf98e92011-01-10 14:10:36 -08008641 computeScroll();
8642 canvas.translate(-mScrollX, -mScrollY);
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008643 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
Joe Malin32736f02011-01-19 16:14:20 -08008644
Romain Guyb051e892010-09-28 19:09:36 -07008645 // Fast path for layouts with no backgrounds
8646 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8647 mPrivateFlags &= ~DIRTY_MASK;
8648 dispatchDraw(canvas);
8649 } else {
8650 draw(canvas);
8651 }
Joe Malin32736f02011-01-19 16:14:20 -08008652
Romain Guyb051e892010-09-28 19:09:36 -07008653 canvas.restoreToCount(restoreCount);
8654 } finally {
8655 canvas.onPostDraw();
8656
8657 mDisplayList.end();
Romain Guyb051e892010-09-28 19:09:36 -07008658 }
Chet Haase77785f92011-01-25 23:22:09 -08008659 } else {
8660 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
8661 mPrivateFlags &= ~DIRTY_MASK;
Romain Guyb051e892010-09-28 19:09:36 -07008662 }
8663
8664 return mDisplayList;
8665 }
8666
8667 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07008668 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008669 *
Romain Guyfbd8f692009-06-26 14:51:58 -07008670 * @return A non-scaled bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -08008671 *
Romain Guyfbd8f692009-06-26 14:51:58 -07008672 * @see #getDrawingCache(boolean)
8673 */
8674 public Bitmap getDrawingCache() {
8675 return getDrawingCache(false);
8676 }
8677
8678 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008679 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
8680 * is null when caching is disabled. If caching is enabled and the cache is not ready,
8681 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
8682 * draw from the cache when the cache is enabled. To benefit from the cache, you must
8683 * request the drawing cache by calling this method and draw it on screen if the
8684 * returned bitmap is not null.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008685 *
Romain Guyfbd8f692009-06-26 14:51:58 -07008686 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
8687 * this method will create a bitmap of the same size as this view. Because this bitmap
8688 * will be drawn scaled by the parent ViewGroup, the result on screen might show
8689 * scaling artifacts. To avoid such artifacts, you should call this method by setting
8690 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
8691 * size than the view. This implies that your application must be able to handle this
8692 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008693 *
Romain Guyfbd8f692009-06-26 14:51:58 -07008694 * @param autoScale Indicates whether the generated bitmap should be scaled based on
8695 * the current density of the screen when the application is in compatibility
8696 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008697 *
Romain Guyfbd8f692009-06-26 14:51:58 -07008698 * @return A bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -08008699 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008700 * @see #setDrawingCacheEnabled(boolean)
8701 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -07008702 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008703 * @see #destroyDrawingCache()
8704 */
Romain Guyfbd8f692009-06-26 14:51:58 -07008705 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008706 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
8707 return null;
8708 }
8709 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008710 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008711 }
Romain Guy02890fd2010-08-06 17:58:44 -07008712 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008713 }
8714
8715 /**
8716 * <p>Frees the resources used by the drawing cache. If you call
8717 * {@link #buildDrawingCache()} manually without calling
8718 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
8719 * should cleanup the cache with this method afterwards.</p>
8720 *
8721 * @see #setDrawingCacheEnabled(boolean)
8722 * @see #buildDrawingCache()
8723 * @see #getDrawingCache()
8724 */
8725 public void destroyDrawingCache() {
8726 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07008727 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008728 mDrawingCache = null;
8729 }
Romain Guyfbd8f692009-06-26 14:51:58 -07008730 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07008731 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -07008732 mUnscaledDrawingCache = null;
8733 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008734 }
8735
8736 /**
8737 * Setting a solid background color for the drawing cache's bitmaps will improve
8738 * perfromance and memory usage. Note, though that this should only be used if this
8739 * view will always be drawn on top of a solid color.
8740 *
8741 * @param color The background color to use for the drawing cache's bitmap
8742 *
8743 * @see #setDrawingCacheEnabled(boolean)
8744 * @see #buildDrawingCache()
8745 * @see #getDrawingCache()
8746 */
8747 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -08008748 if (color != mDrawingCacheBackgroundColor) {
8749 mDrawingCacheBackgroundColor = color;
8750 mPrivateFlags &= ~DRAWING_CACHE_VALID;
8751 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008752 }
8753
8754 /**
8755 * @see #setDrawingCacheBackgroundColor(int)
8756 *
8757 * @return The background color to used for the drawing cache's bitmap
8758 */
8759 public int getDrawingCacheBackgroundColor() {
8760 return mDrawingCacheBackgroundColor;
8761 }
8762
8763 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07008764 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008765 *
Romain Guyfbd8f692009-06-26 14:51:58 -07008766 * @see #buildDrawingCache(boolean)
8767 */
8768 public void buildDrawingCache() {
8769 buildDrawingCache(false);
8770 }
Romain Guy0211a0a2011-02-14 16:34:59 -08008771
Romain Guyfbd8f692009-06-26 14:51:58 -07008772 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008773 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
8774 *
8775 * <p>If you call {@link #buildDrawingCache()} manually without calling
8776 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
8777 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008778 *
Romain Guyfbd8f692009-06-26 14:51:58 -07008779 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
8780 * this method will create a bitmap of the same size as this view. Because this bitmap
8781 * will be drawn scaled by the parent ViewGroup, the result on screen might show
8782 * scaling artifacts. To avoid such artifacts, you should call this method by setting
8783 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
8784 * size than the view. This implies that your application must be able to handle this
8785 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008786 *
Romain Guy0d9275e2010-10-26 14:22:30 -07008787 * <p>You should avoid calling this method when hardware acceleration is enabled. If
8788 * you do not need the drawing cache bitmap, calling this method will increase memory
Joe Malin32736f02011-01-19 16:14:20 -08008789 * usage and cause the view to be rendered in software once, thus negatively impacting
Romain Guy0d9275e2010-10-26 14:22:30 -07008790 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008791 *
8792 * @see #getDrawingCache()
8793 * @see #destroyDrawingCache()
8794 */
Romain Guyfbd8f692009-06-26 14:51:58 -07008795 public void buildDrawingCache(boolean autoScale) {
8796 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -07008797 mDrawingCache == null : mUnscaledDrawingCache == null)) {
Romain Guy0211a0a2011-02-14 16:34:59 -08008798 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008799
8800 if (ViewDebug.TRACE_HIERARCHY) {
8801 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
8802 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008803
Romain Guy8506ab42009-06-11 17:35:47 -07008804 int width = mRight - mLeft;
8805 int height = mBottom - mTop;
8806
8807 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -07008808 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -07008809
Romain Guye1123222009-06-29 14:24:56 -07008810 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008811 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
8812 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -07008813 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008814
8815 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -07008816 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -08008817 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008818
8819 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -07008820 // Projected bitmap size in bytes
Adam Powell26153a32010-11-08 15:22:27 -08008821 (width * height * (opaque && !use32BitCache ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008822 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
8823 destroyDrawingCache();
Romain Guy0211a0a2011-02-14 16:34:59 -08008824 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008825 return;
8826 }
8827
8828 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -07008829 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008830
8831 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008832 Bitmap.Config quality;
8833 if (!opaque) {
Romain Guy676b1732011-02-14 14:45:33 -08008834 // Never pick ARGB_4444 because it looks awful
8835 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008836 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
8837 case DRAWING_CACHE_QUALITY_AUTO:
8838 quality = Bitmap.Config.ARGB_8888;
8839 break;
8840 case DRAWING_CACHE_QUALITY_LOW:
Romain Guy676b1732011-02-14 14:45:33 -08008841 quality = Bitmap.Config.ARGB_8888;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008842 break;
8843 case DRAWING_CACHE_QUALITY_HIGH:
8844 quality = Bitmap.Config.ARGB_8888;
8845 break;
8846 default:
8847 quality = Bitmap.Config.ARGB_8888;
8848 break;
8849 }
8850 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -07008851 // Optimization for translucent windows
8852 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -08008853 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008854 }
8855
8856 // Try to cleanup memory
8857 if (bitmap != null) bitmap.recycle();
8858
8859 try {
8860 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -07008861 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -07008862 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -07008863 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07008864 } else {
Romain Guy02890fd2010-08-06 17:58:44 -07008865 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -07008866 }
Adam Powell26153a32010-11-08 15:22:27 -08008867 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008868 } catch (OutOfMemoryError e) {
8869 // If there is not enough memory to create the bitmap cache, just
8870 // ignore the issue as bitmap caches are not required to draw the
8871 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -07008872 if (autoScale) {
8873 mDrawingCache = null;
8874 } else {
8875 mUnscaledDrawingCache = null;
8876 }
Romain Guy0211a0a2011-02-14 16:34:59 -08008877 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008878 return;
8879 }
8880
8881 clear = drawingCacheBackgroundColor != 0;
8882 }
8883
8884 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008885 if (attachInfo != null) {
8886 canvas = attachInfo.mCanvas;
8887 if (canvas == null) {
8888 canvas = new Canvas();
8889 }
8890 canvas.setBitmap(bitmap);
8891 // Temporarily clobber the cached Canvas in case one of our children
8892 // is also using a drawing cache. Without this, the children would
8893 // steal the canvas by attaching their own bitmap to it and bad, bad
8894 // thing would happen (invisible views, corrupted drawings, etc.)
8895 attachInfo.mCanvas = null;
8896 } else {
8897 // This case should hopefully never or seldom happen
8898 canvas = new Canvas(bitmap);
8899 }
8900
8901 if (clear) {
8902 bitmap.eraseColor(drawingCacheBackgroundColor);
8903 }
8904
8905 computeScroll();
8906 final int restoreCount = canvas.save();
Joe Malin32736f02011-01-19 16:14:20 -08008907
Romain Guye1123222009-06-29 14:24:56 -07008908 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -07008909 final float scale = attachInfo.mApplicationScale;
8910 canvas.scale(scale, scale);
8911 }
Joe Malin32736f02011-01-19 16:14:20 -08008912
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008913 canvas.translate(-mScrollX, -mScrollY);
8914
Romain Guy5bcdff42009-05-14 21:27:18 -07008915 mPrivateFlags |= DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -08008916 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
8917 mLayerType != LAYER_TYPE_NONE) {
Romain Guy0d9275e2010-10-26 14:22:30 -07008918 mPrivateFlags |= DRAWING_CACHE_VALID;
8919 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008920
8921 // Fast path for layouts with no backgrounds
8922 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8923 if (ViewDebug.TRACE_HIERARCHY) {
8924 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
8925 }
Romain Guy5bcdff42009-05-14 21:27:18 -07008926 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008927 dispatchDraw(canvas);
8928 } else {
8929 draw(canvas);
8930 }
8931
8932 canvas.restoreToCount(restoreCount);
8933
8934 if (attachInfo != null) {
8935 // Restore the cached Canvas for our siblings
8936 attachInfo.mCanvas = canvas;
8937 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008938 }
8939 }
8940
8941 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008942 * Create a snapshot of the view into a bitmap. We should probably make
8943 * some form of this public, but should think about the API.
8944 */
Romain Guy223ff5c2010-03-02 17:07:47 -08008945 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008946 int width = mRight - mLeft;
8947 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008948
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008949 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -07008950 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008951 width = (int) ((width * scale) + 0.5f);
8952 height = (int) ((height * scale) + 0.5f);
Joe Malin32736f02011-01-19 16:14:20 -08008953
Romain Guy8c11e312009-09-14 15:15:30 -07008954 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008955 if (bitmap == null) {
8956 throw new OutOfMemoryError();
8957 }
8958
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008959 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Joe Malin32736f02011-01-19 16:14:20 -08008960
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008961 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008962 if (attachInfo != null) {
8963 canvas = attachInfo.mCanvas;
8964 if (canvas == null) {
8965 canvas = new Canvas();
8966 }
8967 canvas.setBitmap(bitmap);
8968 // Temporarily clobber the cached Canvas in case one of our children
8969 // is also using a drawing cache. Without this, the children would
8970 // steal the canvas by attaching their own bitmap to it and bad, bad
8971 // things would happen (invisible views, corrupted drawings, etc.)
8972 attachInfo.mCanvas = null;
8973 } else {
8974 // This case should hopefully never or seldom happen
8975 canvas = new Canvas(bitmap);
8976 }
8977
Romain Guy5bcdff42009-05-14 21:27:18 -07008978 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008979 bitmap.eraseColor(backgroundColor);
8980 }
8981
8982 computeScroll();
8983 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -07008984 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008985 canvas.translate(-mScrollX, -mScrollY);
8986
Romain Guy5bcdff42009-05-14 21:27:18 -07008987 // Temporarily remove the dirty mask
8988 int flags = mPrivateFlags;
8989 mPrivateFlags &= ~DIRTY_MASK;
8990
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07008991 // Fast path for layouts with no backgrounds
8992 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
8993 dispatchDraw(canvas);
8994 } else {
8995 draw(canvas);
8996 }
8997
Romain Guy5bcdff42009-05-14 21:27:18 -07008998 mPrivateFlags = flags;
8999
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07009000 canvas.restoreToCount(restoreCount);
9001
9002 if (attachInfo != null) {
9003 // Restore the cached Canvas for our siblings
9004 attachInfo.mCanvas = canvas;
9005 }
Romain Guy8506ab42009-06-11 17:35:47 -07009006
Dianne Hackborn958b9ad2009-03-31 18:00:36 -07009007 return bitmap;
9008 }
9009
9010 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009011 * Indicates whether this View is currently in edit mode. A View is usually
9012 * in edit mode when displayed within a developer tool. For instance, if
9013 * this View is being drawn by a visual user interface builder, this method
9014 * should return true.
9015 *
9016 * Subclasses should check the return value of this method to provide
9017 * different behaviors if their normal behavior might interfere with the
9018 * host environment. For instance: the class spawns a thread in its
9019 * constructor, the drawing code relies on device-specific features, etc.
9020 *
9021 * This method is usually checked in the drawing code of custom widgets.
9022 *
9023 * @return True if this View is in edit mode, false otherwise.
9024 */
9025 public boolean isInEditMode() {
9026 return false;
9027 }
9028
9029 /**
9030 * If the View draws content inside its padding and enables fading edges,
9031 * it needs to support padding offsets. Padding offsets are added to the
9032 * fading edges to extend the length of the fade so that it covers pixels
9033 * drawn inside the padding.
9034 *
9035 * Subclasses of this class should override this method if they need
9036 * to draw content inside the padding.
9037 *
9038 * @return True if padding offset must be applied, false otherwise.
9039 *
9040 * @see #getLeftPaddingOffset()
9041 * @see #getRightPaddingOffset()
9042 * @see #getTopPaddingOffset()
9043 * @see #getBottomPaddingOffset()
9044 *
9045 * @since CURRENT
9046 */
9047 protected boolean isPaddingOffsetRequired() {
9048 return false;
9049 }
9050
9051 /**
9052 * Amount by which to extend the left fading region. Called only when
9053 * {@link #isPaddingOffsetRequired()} returns true.
9054 *
9055 * @return The left padding offset in pixels.
9056 *
9057 * @see #isPaddingOffsetRequired()
9058 *
9059 * @since CURRENT
9060 */
9061 protected int getLeftPaddingOffset() {
9062 return 0;
9063 }
9064
9065 /**
9066 * Amount by which to extend the right fading region. Called only when
9067 * {@link #isPaddingOffsetRequired()} returns true.
9068 *
9069 * @return The right padding offset in pixels.
9070 *
9071 * @see #isPaddingOffsetRequired()
9072 *
9073 * @since CURRENT
9074 */
9075 protected int getRightPaddingOffset() {
9076 return 0;
9077 }
9078
9079 /**
9080 * Amount by which to extend the top fading region. Called only when
9081 * {@link #isPaddingOffsetRequired()} returns true.
9082 *
9083 * @return The top padding offset in pixels.
9084 *
9085 * @see #isPaddingOffsetRequired()
9086 *
9087 * @since CURRENT
9088 */
9089 protected int getTopPaddingOffset() {
9090 return 0;
9091 }
9092
9093 /**
9094 * Amount by which to extend the bottom fading region. Called only when
9095 * {@link #isPaddingOffsetRequired()} returns true.
9096 *
9097 * @return The bottom padding offset in pixels.
9098 *
9099 * @see #isPaddingOffsetRequired()
9100 *
9101 * @since CURRENT
9102 */
9103 protected int getBottomPaddingOffset() {
9104 return 0;
9105 }
9106
9107 /**
Romain Guy2bffd262010-09-12 17:40:02 -07009108 * <p>Indicates whether this view is attached to an hardware accelerated
9109 * window or not.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009110 *
Romain Guy2bffd262010-09-12 17:40:02 -07009111 * <p>Even if this method returns true, it does not mean that every call
9112 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
9113 * accelerated {@link android.graphics.Canvas}. For instance, if this view
9114 * is drawn onto an offscren {@link android.graphics.Bitmap} and its
9115 * window is hardware accelerated,
9116 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
9117 * return false, and this method will return true.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009118 *
Romain Guy2bffd262010-09-12 17:40:02 -07009119 * @return True if the view is attached to a window and the window is
9120 * hardware accelerated; false in any other case.
9121 */
9122 public boolean isHardwareAccelerated() {
9123 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
9124 }
Joe Malin32736f02011-01-19 16:14:20 -08009125
Romain Guy2bffd262010-09-12 17:40:02 -07009126 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009127 * Manually render this view (and all of its children) to the given Canvas.
9128 * The view must have already done a full layout before this function is
Chet Haasec75ec332010-12-17 07:44:30 -08009129 * called. When implementing a view, implement {@link #onDraw} instead of
9130 * overriding this method. If you do need to override this method, call
9131 * the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009132 *
9133 * @param canvas The Canvas to which the View is rendered.
9134 */
9135 public void draw(Canvas canvas) {
9136 if (ViewDebug.TRACE_HIERARCHY) {
9137 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
9138 }
9139
Romain Guy5bcdff42009-05-14 21:27:18 -07009140 final int privateFlags = mPrivateFlags;
9141 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
9142 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
9143 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -07009144
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009145 /*
9146 * Draw traversal performs several drawing steps which must be executed
9147 * in the appropriate order:
9148 *
9149 * 1. Draw the background
9150 * 2. If necessary, save the canvas' layers to prepare for fading
9151 * 3. Draw view's content
9152 * 4. Draw children
9153 * 5. If necessary, draw the fading edges and restore layers
9154 * 6. Draw decorations (scrollbars for instance)
9155 */
9156
9157 // Step 1, draw the background, if needed
9158 int saveCount;
9159
Romain Guy24443ea2009-05-11 11:56:30 -07009160 if (!dirtyOpaque) {
9161 final Drawable background = mBGDrawable;
9162 if (background != null) {
9163 final int scrollX = mScrollX;
9164 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009165
Romain Guy24443ea2009-05-11 11:56:30 -07009166 if (mBackgroundSizeChanged) {
9167 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
9168 mBackgroundSizeChanged = false;
9169 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009170
Romain Guy24443ea2009-05-11 11:56:30 -07009171 if ((scrollX | scrollY) == 0) {
9172 background.draw(canvas);
9173 } else {
9174 canvas.translate(scrollX, scrollY);
9175 background.draw(canvas);
9176 canvas.translate(-scrollX, -scrollY);
9177 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009178 }
9179 }
9180
9181 // skip step 2 & 5 if possible (common case)
9182 final int viewFlags = mViewFlags;
9183 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
9184 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
9185 if (!verticalEdges && !horizontalEdges) {
9186 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07009187 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009188
9189 // Step 4, draw the children
9190 dispatchDraw(canvas);
9191
9192 // Step 6, draw decorations (scrollbars)
9193 onDrawScrollBars(canvas);
9194
9195 // we're done...
9196 return;
9197 }
9198
9199 /*
9200 * Here we do the full fledged routine...
9201 * (this is an uncommon case where speed matters less,
9202 * this is why we repeat some of the tests that have been
9203 * done above)
9204 */
9205
9206 boolean drawTop = false;
9207 boolean drawBottom = false;
9208 boolean drawLeft = false;
9209 boolean drawRight = false;
9210
9211 float topFadeStrength = 0.0f;
9212 float bottomFadeStrength = 0.0f;
9213 float leftFadeStrength = 0.0f;
9214 float rightFadeStrength = 0.0f;
9215
9216 // Step 2, save the canvas' layers
9217 int paddingLeft = mPaddingLeft;
9218 int paddingTop = mPaddingTop;
9219
9220 final boolean offsetRequired = isPaddingOffsetRequired();
9221 if (offsetRequired) {
9222 paddingLeft += getLeftPaddingOffset();
9223 paddingTop += getTopPaddingOffset();
9224 }
9225
9226 int left = mScrollX + paddingLeft;
9227 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
9228 int top = mScrollY + paddingTop;
9229 int bottom = top + mBottom - mTop - mPaddingBottom - paddingTop;
9230
9231 if (offsetRequired) {
9232 right += getRightPaddingOffset();
9233 bottom += getBottomPaddingOffset();
9234 }
9235
9236 final ScrollabilityCache scrollabilityCache = mScrollCache;
9237 int length = scrollabilityCache.fadingEdgeLength;
9238
9239 // clip the fade length if top and bottom fades overlap
9240 // overlapping fades produce odd-looking artifacts
9241 if (verticalEdges && (top + length > bottom - length)) {
9242 length = (bottom - top) / 2;
9243 }
9244
9245 // also clip horizontal fades if necessary
9246 if (horizontalEdges && (left + length > right - length)) {
9247 length = (right - left) / 2;
9248 }
9249
9250 if (verticalEdges) {
9251 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07009252 drawTop = topFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009253 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07009254 drawBottom = bottomFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009255 }
9256
9257 if (horizontalEdges) {
9258 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07009259 drawLeft = leftFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009260 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guydac5f9f2010-07-08 11:40:54 -07009261 drawRight = rightFadeStrength > 0.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009262 }
9263
9264 saveCount = canvas.getSaveCount();
9265
9266 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -07009267 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009268 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
9269
9270 if (drawTop) {
9271 canvas.saveLayer(left, top, right, top + length, null, flags);
9272 }
9273
9274 if (drawBottom) {
9275 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
9276 }
9277
9278 if (drawLeft) {
9279 canvas.saveLayer(left, top, left + length, bottom, null, flags);
9280 }
9281
9282 if (drawRight) {
9283 canvas.saveLayer(right - length, top, right, bottom, null, flags);
9284 }
9285 } else {
9286 scrollabilityCache.setFadeColor(solidColor);
9287 }
9288
9289 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -07009290 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009291
9292 // Step 4, draw the children
9293 dispatchDraw(canvas);
9294
9295 // Step 5, draw the fade effect and restore layers
9296 final Paint p = scrollabilityCache.paint;
9297 final Matrix matrix = scrollabilityCache.matrix;
9298 final Shader fade = scrollabilityCache.shader;
9299 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
9300
9301 if (drawTop) {
9302 matrix.setScale(1, fadeHeight * topFadeStrength);
9303 matrix.postTranslate(left, top);
9304 fade.setLocalMatrix(matrix);
9305 canvas.drawRect(left, top, right, top + length, p);
9306 }
9307
9308 if (drawBottom) {
9309 matrix.setScale(1, fadeHeight * bottomFadeStrength);
9310 matrix.postRotate(180);
9311 matrix.postTranslate(left, bottom);
9312 fade.setLocalMatrix(matrix);
9313 canvas.drawRect(left, bottom - length, right, bottom, p);
9314 }
9315
9316 if (drawLeft) {
9317 matrix.setScale(1, fadeHeight * leftFadeStrength);
9318 matrix.postRotate(-90);
9319 matrix.postTranslate(left, top);
9320 fade.setLocalMatrix(matrix);
9321 canvas.drawRect(left, top, left + length, bottom, p);
9322 }
9323
9324 if (drawRight) {
9325 matrix.setScale(1, fadeHeight * rightFadeStrength);
9326 matrix.postRotate(90);
9327 matrix.postTranslate(right, top);
9328 fade.setLocalMatrix(matrix);
9329 canvas.drawRect(right - length, top, right, bottom, p);
9330 }
9331
9332 canvas.restoreToCount(saveCount);
9333
9334 // Step 6, draw decorations (scrollbars)
9335 onDrawScrollBars(canvas);
9336 }
9337
9338 /**
9339 * Override this if your view is known to always be drawn on top of a solid color background,
9340 * and needs to draw fading edges. Returning a non-zero color enables the view system to
9341 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
9342 * should be set to 0xFF.
9343 *
9344 * @see #setVerticalFadingEdgeEnabled
9345 * @see #setHorizontalFadingEdgeEnabled
9346 *
9347 * @return The known solid color background for this view, or 0 if the color may vary
9348 */
9349 public int getSolidColor() {
9350 return 0;
9351 }
9352
9353 /**
9354 * Build a human readable string representation of the specified view flags.
9355 *
9356 * @param flags the view flags to convert to a string
9357 * @return a String representing the supplied flags
9358 */
9359 private static String printFlags(int flags) {
9360 String output = "";
9361 int numFlags = 0;
9362 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
9363 output += "TAKES_FOCUS";
9364 numFlags++;
9365 }
9366
9367 switch (flags & VISIBILITY_MASK) {
9368 case INVISIBLE:
9369 if (numFlags > 0) {
9370 output += " ";
9371 }
9372 output += "INVISIBLE";
9373 // USELESS HERE numFlags++;
9374 break;
9375 case GONE:
9376 if (numFlags > 0) {
9377 output += " ";
9378 }
9379 output += "GONE";
9380 // USELESS HERE numFlags++;
9381 break;
9382 default:
9383 break;
9384 }
9385 return output;
9386 }
9387
9388 /**
9389 * Build a human readable string representation of the specified private
9390 * view flags.
9391 *
9392 * @param privateFlags the private view flags to convert to a string
9393 * @return a String representing the supplied flags
9394 */
9395 private static String printPrivateFlags(int privateFlags) {
9396 String output = "";
9397 int numFlags = 0;
9398
9399 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
9400 output += "WANTS_FOCUS";
9401 numFlags++;
9402 }
9403
9404 if ((privateFlags & FOCUSED) == FOCUSED) {
9405 if (numFlags > 0) {
9406 output += " ";
9407 }
9408 output += "FOCUSED";
9409 numFlags++;
9410 }
9411
9412 if ((privateFlags & SELECTED) == SELECTED) {
9413 if (numFlags > 0) {
9414 output += " ";
9415 }
9416 output += "SELECTED";
9417 numFlags++;
9418 }
9419
9420 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
9421 if (numFlags > 0) {
9422 output += " ";
9423 }
9424 output += "IS_ROOT_NAMESPACE";
9425 numFlags++;
9426 }
9427
9428 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
9429 if (numFlags > 0) {
9430 output += " ";
9431 }
9432 output += "HAS_BOUNDS";
9433 numFlags++;
9434 }
9435
9436 if ((privateFlags & DRAWN) == DRAWN) {
9437 if (numFlags > 0) {
9438 output += " ";
9439 }
9440 output += "DRAWN";
9441 // USELESS HERE numFlags++;
9442 }
9443 return output;
9444 }
9445
9446 /**
9447 * <p>Indicates whether or not this view's layout will be requested during
9448 * the next hierarchy layout pass.</p>
9449 *
9450 * @return true if the layout will be forced during next layout pass
9451 */
9452 public boolean isLayoutRequested() {
9453 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
9454 }
9455
9456 /**
9457 * Assign a size and position to a view and all of its
9458 * descendants
9459 *
9460 * <p>This is the second phase of the layout mechanism.
9461 * (The first is measuring). In this phase, each parent calls
9462 * layout on all of its children to position them.
9463 * This is typically done using the child measurements
Chet Haase9c087442011-01-12 16:20:16 -08009464 * that were stored in the measure pass().</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009465 *
Chet Haase9c087442011-01-12 16:20:16 -08009466 * <p>Derived classes should not override this method.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009467 * Derived classes with children should override
9468 * onLayout. In that method, they should
Chet Haase9c087442011-01-12 16:20:16 -08009469 * call layout on each of their children.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009470 *
9471 * @param l Left position, relative to parent
9472 * @param t Top position, relative to parent
9473 * @param r Right position, relative to parent
9474 * @param b Bottom position, relative to parent
9475 */
Romain Guy5429e1d2010-09-07 12:38:00 -07009476 @SuppressWarnings({"unchecked"})
Chet Haase9c087442011-01-12 16:20:16 -08009477 public void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -07009478 int oldL = mLeft;
9479 int oldT = mTop;
9480 int oldB = mBottom;
9481 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009482 boolean changed = setFrame(l, t, r, b);
9483 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
9484 if (ViewDebug.TRACE_HIERARCHY) {
9485 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
9486 }
9487
9488 onLayout(changed, l, t, r, b);
9489 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -07009490
9491 if (mOnLayoutChangeListeners != null) {
9492 ArrayList<OnLayoutChangeListener> listenersCopy =
9493 (ArrayList<OnLayoutChangeListener>) mOnLayoutChangeListeners.clone();
9494 int numListeners = listenersCopy.size();
9495 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -07009496 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -07009497 }
9498 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009499 }
9500 mPrivateFlags &= ~FORCE_LAYOUT;
9501 }
9502
9503 /**
9504 * Called from layout when this view should
9505 * assign a size and position to each of its children.
9506 *
9507 * Derived classes with children should override
9508 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -07009509 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009510 * @param changed This is a new size or position for this view
9511 * @param left Left position, relative to parent
9512 * @param top Top position, relative to parent
9513 * @param right Right position, relative to parent
9514 * @param bottom Bottom position, relative to parent
9515 */
9516 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
9517 }
9518
9519 /**
9520 * Assign a size and position to this view.
9521 *
9522 * This is called from layout.
9523 *
9524 * @param left Left position, relative to parent
9525 * @param top Top position, relative to parent
9526 * @param right Right position, relative to parent
9527 * @param bottom Bottom position, relative to parent
9528 * @return true if the new size and position are different than the
9529 * previous ones
9530 * {@hide}
9531 */
9532 protected boolean setFrame(int left, int top, int right, int bottom) {
9533 boolean changed = false;
9534
9535 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -07009536 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009537 + right + "," + bottom + ")");
9538 }
9539
9540 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
9541 changed = true;
9542
9543 // Remember our drawn bit
9544 int drawn = mPrivateFlags & DRAWN;
9545
9546 // Invalidate our old position
Romain Guy0fd89bf2011-01-26 15:41:30 -08009547 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009548
9549
9550 int oldWidth = mRight - mLeft;
9551 int oldHeight = mBottom - mTop;
9552
9553 mLeft = left;
9554 mTop = top;
9555 mRight = right;
9556 mBottom = bottom;
9557
9558 mPrivateFlags |= HAS_BOUNDS;
9559
9560 int newWidth = right - left;
9561 int newHeight = bottom - top;
9562
9563 if (newWidth != oldWidth || newHeight != oldHeight) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009564 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9565 // A change in dimension means an auto-centered pivot point changes, too
9566 mMatrixDirty = true;
9567 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009568 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
9569 }
9570
9571 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
9572 // If we are visible, force the DRAWN bit to on so that
9573 // this invalidate will go through (at least to our parent).
9574 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009575 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009576 // the DRAWN bit.
9577 mPrivateFlags |= DRAWN;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009578 invalidate(true);
Chet Haasef28595e2011-01-31 18:52:12 -08009579 // parent display list may need to be recreated based on a change in the bounds
9580 // of any child
9581 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009582 }
9583
9584 // Reset drawn bit to original value (invalidate turns it off)
9585 mPrivateFlags |= drawn;
9586
9587 mBackgroundSizeChanged = true;
9588 }
9589 return changed;
9590 }
9591
9592 /**
9593 * Finalize inflating a view from XML. This is called as the last phase
9594 * of inflation, after all child views have been added.
9595 *
9596 * <p>Even if the subclass overrides onFinishInflate, they should always be
9597 * sure to call the super method, so that we get called.
9598 */
9599 protected void onFinishInflate() {
9600 }
9601
9602 /**
9603 * Returns the resources associated with this view.
9604 *
9605 * @return Resources object.
9606 */
9607 public Resources getResources() {
9608 return mResources;
9609 }
9610
9611 /**
9612 * Invalidates the specified Drawable.
9613 *
9614 * @param drawable the drawable to invalidate
9615 */
9616 public void invalidateDrawable(Drawable drawable) {
9617 if (verifyDrawable(drawable)) {
9618 final Rect dirty = drawable.getBounds();
9619 final int scrollX = mScrollX;
9620 final int scrollY = mScrollY;
9621
9622 invalidate(dirty.left + scrollX, dirty.top + scrollY,
9623 dirty.right + scrollX, dirty.bottom + scrollY);
9624 }
9625 }
9626
9627 /**
9628 * Schedules an action on a drawable to occur at a specified time.
9629 *
9630 * @param who the recipient of the action
9631 * @param what the action to run on the drawable
9632 * @param when the time at which the action must occur. Uses the
9633 * {@link SystemClock#uptimeMillis} timebase.
9634 */
9635 public void scheduleDrawable(Drawable who, Runnable what, long when) {
9636 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
9637 mAttachInfo.mHandler.postAtTime(what, who, when);
9638 }
9639 }
9640
9641 /**
9642 * Cancels a scheduled action on a drawable.
9643 *
9644 * @param who the recipient of the action
9645 * @param what the action to cancel
9646 */
9647 public void unscheduleDrawable(Drawable who, Runnable what) {
9648 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
9649 mAttachInfo.mHandler.removeCallbacks(what, who);
9650 }
9651 }
9652
9653 /**
9654 * Unschedule any events associated with the given Drawable. This can be
9655 * used when selecting a new Drawable into a view, so that the previous
9656 * one is completely unscheduled.
9657 *
9658 * @param who The Drawable to unschedule.
9659 *
9660 * @see #drawableStateChanged
9661 */
9662 public void unscheduleDrawable(Drawable who) {
9663 if (mAttachInfo != null) {
9664 mAttachInfo.mHandler.removeCallbacksAndMessages(who);
9665 }
9666 }
9667
9668 /**
9669 * If your view subclass is displaying its own Drawable objects, it should
9670 * override this function and return true for any Drawable it is
9671 * displaying. This allows animations for those drawables to be
9672 * scheduled.
9673 *
9674 * <p>Be sure to call through to the super class when overriding this
9675 * function.
9676 *
9677 * @param who The Drawable to verify. Return true if it is one you are
9678 * displaying, else return the result of calling through to the
9679 * super class.
9680 *
9681 * @return boolean If true than the Drawable is being displayed in the
9682 * view; else false and it is not allowed to animate.
9683 *
9684 * @see #unscheduleDrawable
9685 * @see #drawableStateChanged
9686 */
9687 protected boolean verifyDrawable(Drawable who) {
9688 return who == mBGDrawable;
9689 }
9690
9691 /**
9692 * This function is called whenever the state of the view changes in such
9693 * a way that it impacts the state of drawables being shown.
9694 *
9695 * <p>Be sure to call through to the superclass when overriding this
9696 * function.
9697 *
9698 * @see Drawable#setState
9699 */
9700 protected void drawableStateChanged() {
9701 Drawable d = mBGDrawable;
9702 if (d != null && d.isStateful()) {
9703 d.setState(getDrawableState());
9704 }
9705 }
9706
9707 /**
9708 * Call this to force a view to update its drawable state. This will cause
9709 * drawableStateChanged to be called on this view. Views that are interested
9710 * in the new state should call getDrawableState.
9711 *
9712 * @see #drawableStateChanged
9713 * @see #getDrawableState
9714 */
9715 public void refreshDrawableState() {
9716 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
9717 drawableStateChanged();
9718
9719 ViewParent parent = mParent;
9720 if (parent != null) {
9721 parent.childDrawableStateChanged(this);
9722 }
9723 }
9724
9725 /**
9726 * Return an array of resource IDs of the drawable states representing the
9727 * current state of the view.
9728 *
9729 * @return The current drawable state
9730 *
9731 * @see Drawable#setState
9732 * @see #drawableStateChanged
9733 * @see #onCreateDrawableState
9734 */
9735 public final int[] getDrawableState() {
9736 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
9737 return mDrawableState;
9738 } else {
9739 mDrawableState = onCreateDrawableState(0);
9740 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
9741 return mDrawableState;
9742 }
9743 }
9744
9745 /**
9746 * Generate the new {@link android.graphics.drawable.Drawable} state for
9747 * this view. This is called by the view
9748 * system when the cached Drawable state is determined to be invalid. To
9749 * retrieve the current state, you should use {@link #getDrawableState}.
9750 *
9751 * @param extraSpace if non-zero, this is the number of extra entries you
9752 * would like in the returned array in which you can place your own
9753 * states.
9754 *
9755 * @return Returns an array holding the current {@link Drawable} state of
9756 * the view.
9757 *
9758 * @see #mergeDrawableStates
9759 */
9760 protected int[] onCreateDrawableState(int extraSpace) {
9761 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
9762 mParent instanceof View) {
9763 return ((View) mParent).onCreateDrawableState(extraSpace);
9764 }
9765
9766 int[] drawableState;
9767
9768 int privateFlags = mPrivateFlags;
9769
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009770 int viewStateIndex = 0;
9771 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
9772 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
9773 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -07009774 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009775 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
9776 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08009777 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested) {
9778 // This is set if HW acceleration is requested, even if the current
9779 // process doesn't allow it. This is just to allow app preview
9780 // windows to better match their app.
9781 viewStateIndex |= VIEW_STATE_ACCELERATED;
9782 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009783
9784 drawableState = VIEW_STATE_SETS[viewStateIndex];
9785
9786 //noinspection ConstantIfStatement
9787 if (false) {
9788 Log.i("View", "drawableStateIndex=" + viewStateIndex);
9789 Log.i("View", toString()
9790 + " pressed=" + ((privateFlags & PRESSED) != 0)
9791 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
9792 + " fo=" + hasFocus()
9793 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07009794 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009795 + ": " + Arrays.toString(drawableState));
9796 }
9797
9798 if (extraSpace == 0) {
9799 return drawableState;
9800 }
9801
9802 final int[] fullState;
9803 if (drawableState != null) {
9804 fullState = new int[drawableState.length + extraSpace];
9805 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
9806 } else {
9807 fullState = new int[extraSpace];
9808 }
9809
9810 return fullState;
9811 }
9812
9813 /**
9814 * Merge your own state values in <var>additionalState</var> into the base
9815 * state values <var>baseState</var> that were returned by
9816 * {@link #onCreateDrawableState}.
9817 *
9818 * @param baseState The base state values returned by
9819 * {@link #onCreateDrawableState}, which will be modified to also hold your
9820 * own additional state values.
9821 *
9822 * @param additionalState The additional state values you would like
9823 * added to <var>baseState</var>; this array is not modified.
9824 *
9825 * @return As a convenience, the <var>baseState</var> array you originally
9826 * passed into the function is returned.
9827 *
9828 * @see #onCreateDrawableState
9829 */
9830 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
9831 final int N = baseState.length;
9832 int i = N - 1;
9833 while (i >= 0 && baseState[i] == 0) {
9834 i--;
9835 }
9836 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
9837 return baseState;
9838 }
9839
9840 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -07009841 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
9842 * on all Drawable objects associated with this view.
9843 */
9844 public void jumpDrawablesToCurrentState() {
9845 if (mBGDrawable != null) {
9846 mBGDrawable.jumpToCurrentState();
9847 }
9848 }
9849
9850 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009851 * Sets the background color for this view.
9852 * @param color the color of the background
9853 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00009854 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009855 public void setBackgroundColor(int color) {
Chet Haase70d4ba12010-10-06 09:46:45 -07009856 if (mBGDrawable instanceof ColorDrawable) {
9857 ((ColorDrawable) mBGDrawable).setColor(color);
9858 } else {
9859 setBackgroundDrawable(new ColorDrawable(color));
9860 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009861 }
9862
9863 /**
9864 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -07009865 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009866 * @param resid The identifier of the resource.
9867 * @attr ref android.R.styleable#View_background
9868 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +00009869 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009870 public void setBackgroundResource(int resid) {
9871 if (resid != 0 && resid == mBackgroundResource) {
9872 return;
9873 }
9874
9875 Drawable d= null;
9876 if (resid != 0) {
9877 d = mResources.getDrawable(resid);
9878 }
9879 setBackgroundDrawable(d);
9880
9881 mBackgroundResource = resid;
9882 }
9883
9884 /**
9885 * Set the background to a given Drawable, or remove the background. If the
9886 * background has padding, this View's padding is set to the background's
9887 * padding. However, when a background is removed, this View's padding isn't
9888 * touched. If setting the padding is desired, please use
9889 * {@link #setPadding(int, int, int, int)}.
9890 *
9891 * @param d The Drawable to use as the background, or null to remove the
9892 * background
9893 */
9894 public void setBackgroundDrawable(Drawable d) {
9895 boolean requestLayout = false;
9896
9897 mBackgroundResource = 0;
9898
9899 /*
9900 * Regardless of whether we're setting a new background or not, we want
9901 * to clear the previous drawable.
9902 */
9903 if (mBGDrawable != null) {
9904 mBGDrawable.setCallback(null);
9905 unscheduleDrawable(mBGDrawable);
9906 }
9907
9908 if (d != null) {
9909 Rect padding = sThreadLocal.get();
9910 if (padding == null) {
9911 padding = new Rect();
9912 sThreadLocal.set(padding);
9913 }
9914 if (d.getPadding(padding)) {
9915 setPadding(padding.left, padding.top, padding.right, padding.bottom);
9916 }
9917
9918 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
9919 // if it has a different minimum size, we should layout again
9920 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() ||
9921 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) {
9922 requestLayout = true;
9923 }
9924
9925 d.setCallback(this);
9926 if (d.isStateful()) {
9927 d.setState(getDrawableState());
9928 }
9929 d.setVisible(getVisibility() == VISIBLE, false);
9930 mBGDrawable = d;
9931
9932 if ((mPrivateFlags & SKIP_DRAW) != 0) {
9933 mPrivateFlags &= ~SKIP_DRAW;
9934 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
9935 requestLayout = true;
9936 }
9937 } else {
9938 /* Remove the background */
9939 mBGDrawable = null;
9940
9941 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
9942 /*
9943 * This view ONLY drew the background before and we're removing
9944 * the background, so now it won't draw anything
9945 * (hence we SKIP_DRAW)
9946 */
9947 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
9948 mPrivateFlags |= SKIP_DRAW;
9949 }
9950
9951 /*
9952 * When the background is set, we try to apply its padding to this
9953 * View. When the background is removed, we don't touch this View's
9954 * padding. This is noted in the Javadocs. Hence, we don't need to
9955 * requestLayout(), the invalidate() below is sufficient.
9956 */
9957
9958 // The old background's minimum size could have affected this
9959 // View's layout, so let's requestLayout
9960 requestLayout = true;
9961 }
9962
Romain Guy8f1344f52009-05-15 16:03:59 -07009963 computeOpaqueFlags();
9964
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009965 if (requestLayout) {
9966 requestLayout();
9967 }
9968
9969 mBackgroundSizeChanged = true;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009970 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009971 }
9972
9973 /**
9974 * Gets the background drawable
9975 * @return The drawable used as the background for this view, if any.
9976 */
9977 public Drawable getBackground() {
9978 return mBGDrawable;
9979 }
9980
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009981 /**
9982 * Sets the padding. The view may add on the space required to display
9983 * the scrollbars, depending on the style and visibility of the scrollbars.
9984 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
9985 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
9986 * from the values set in this call.
9987 *
9988 * @attr ref android.R.styleable#View_padding
9989 * @attr ref android.R.styleable#View_paddingBottom
9990 * @attr ref android.R.styleable#View_paddingLeft
9991 * @attr ref android.R.styleable#View_paddingRight
9992 * @attr ref android.R.styleable#View_paddingTop
9993 * @param left the left padding in pixels
9994 * @param top the top padding in pixels
9995 * @param right the right padding in pixels
9996 * @param bottom the bottom padding in pixels
9997 */
9998 public void setPadding(int left, int top, int right, int bottom) {
9999 boolean changed = false;
10000
Adam Powell20232d02010-12-08 21:08:53 -080010001 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010002 mUserPaddingRight = right;
10003 mUserPaddingBottom = bottom;
10004
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070010005 final int viewFlags = mViewFlags;
Romain Guy8506ab42009-06-11 17:35:47 -070010006
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070010007 // Common case is there are no scroll bars.
10008 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070010009 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -080010010 // TODO Determine what to do with SCROLLBAR_POSITION_DEFAULT based on RTL settings.
10011 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070010012 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -080010013 switch (mVerticalScrollbarPosition) {
10014 case SCROLLBAR_POSITION_DEFAULT:
10015 case SCROLLBAR_POSITION_RIGHT:
10016 right += offset;
10017 break;
10018 case SCROLLBAR_POSITION_LEFT:
10019 left += offset;
10020 break;
10021 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070010022 }
Adam Powell20232d02010-12-08 21:08:53 -080010023 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070010024 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
10025 ? 0 : getHorizontalScrollbarHeight();
10026 }
10027 }
Romain Guy8506ab42009-06-11 17:35:47 -070010028
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070010029 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010030 changed = true;
10031 mPaddingLeft = left;
10032 }
10033 if (mPaddingTop != top) {
10034 changed = true;
10035 mPaddingTop = top;
10036 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070010037 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010038 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070010039 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010040 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070010041 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010042 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070010043 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010044 }
10045
10046 if (changed) {
10047 requestLayout();
10048 }
10049 }
10050
10051 /**
10052 * Returns the top padding of this view.
10053 *
10054 * @return the top padding in pixels
10055 */
10056 public int getPaddingTop() {
10057 return mPaddingTop;
10058 }
10059
10060 /**
10061 * Returns the bottom padding of this view. If there are inset and enabled
10062 * scrollbars, this value may include the space required to display the
10063 * scrollbars as well.
10064 *
10065 * @return the bottom padding in pixels
10066 */
10067 public int getPaddingBottom() {
10068 return mPaddingBottom;
10069 }
10070
10071 /**
10072 * Returns the left padding of this view. If there are inset and enabled
10073 * scrollbars, this value may include the space required to display the
10074 * scrollbars as well.
10075 *
10076 * @return the left padding in pixels
10077 */
10078 public int getPaddingLeft() {
10079 return mPaddingLeft;
10080 }
10081
10082 /**
10083 * Returns the right padding of this view. If there are inset and enabled
10084 * scrollbars, this value may include the space required to display the
10085 * scrollbars as well.
10086 *
10087 * @return the right padding in pixels
10088 */
10089 public int getPaddingRight() {
10090 return mPaddingRight;
10091 }
10092
10093 /**
10094 * Changes the selection state of this view. A view can be selected or not.
10095 * Note that selection is not the same as focus. Views are typically
10096 * selected in the context of an AdapterView like ListView or GridView;
10097 * the selected view is the view that is highlighted.
10098 *
10099 * @param selected true if the view must be selected, false otherwise
10100 */
10101 public void setSelected(boolean selected) {
10102 if (((mPrivateFlags & SELECTED) != 0) != selected) {
10103 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -070010104 if (!selected) resetPressedState();
Romain Guy0fd89bf2011-01-26 15:41:30 -080010105 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010106 refreshDrawableState();
10107 dispatchSetSelected(selected);
10108 }
10109 }
10110
10111 /**
10112 * Dispatch setSelected to all of this View's children.
10113 *
10114 * @see #setSelected(boolean)
10115 *
10116 * @param selected The new selected state
10117 */
10118 protected void dispatchSetSelected(boolean selected) {
10119 }
10120
10121 /**
10122 * Indicates the selection state of this view.
10123 *
10124 * @return true if the view is selected, false otherwise
10125 */
10126 @ViewDebug.ExportedProperty
10127 public boolean isSelected() {
10128 return (mPrivateFlags & SELECTED) != 0;
10129 }
10130
10131 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070010132 * Changes the activated state of this view. A view can be activated or not.
10133 * Note that activation is not the same as selection. Selection is
10134 * a transient property, representing the view (hierarchy) the user is
10135 * currently interacting with. Activation is a longer-term state that the
10136 * user can move views in and out of. For example, in a list view with
10137 * single or multiple selection enabled, the views in the current selection
10138 * set are activated. (Um, yeah, we are deeply sorry about the terminology
10139 * here.) The activated state is propagated down to children of the view it
10140 * is set on.
10141 *
10142 * @param activated true if the view must be activated, false otherwise
10143 */
10144 public void setActivated(boolean activated) {
10145 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
10146 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
Romain Guy0fd89bf2011-01-26 15:41:30 -080010147 invalidate(true);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070010148 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -070010149 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070010150 }
10151 }
10152
10153 /**
10154 * Dispatch setActivated to all of this View's children.
10155 *
10156 * @see #setActivated(boolean)
10157 *
10158 * @param activated The new activated state
10159 */
10160 protected void dispatchSetActivated(boolean activated) {
10161 }
10162
10163 /**
10164 * Indicates the activation state of this view.
10165 *
10166 * @return true if the view is activated, false otherwise
10167 */
10168 @ViewDebug.ExportedProperty
10169 public boolean isActivated() {
10170 return (mPrivateFlags & ACTIVATED) != 0;
10171 }
10172
10173 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010174 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
10175 * observer can be used to get notifications when global events, like
10176 * layout, happen.
10177 *
10178 * The returned ViewTreeObserver observer is not guaranteed to remain
10179 * valid for the lifetime of this View. If the caller of this method keeps
10180 * a long-lived reference to ViewTreeObserver, it should always check for
10181 * the return value of {@link ViewTreeObserver#isAlive()}.
10182 *
10183 * @return The ViewTreeObserver for this view's hierarchy.
10184 */
10185 public ViewTreeObserver getViewTreeObserver() {
10186 if (mAttachInfo != null) {
10187 return mAttachInfo.mTreeObserver;
10188 }
10189 if (mFloatingTreeObserver == null) {
10190 mFloatingTreeObserver = new ViewTreeObserver();
10191 }
10192 return mFloatingTreeObserver;
10193 }
10194
10195 /**
10196 * <p>Finds the topmost view in the current view hierarchy.</p>
10197 *
10198 * @return the topmost view containing this view
10199 */
10200 public View getRootView() {
10201 if (mAttachInfo != null) {
10202 final View v = mAttachInfo.mRootView;
10203 if (v != null) {
10204 return v;
10205 }
10206 }
Romain Guy8506ab42009-06-11 17:35:47 -070010207
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010208 View parent = this;
10209
10210 while (parent.mParent != null && parent.mParent instanceof View) {
10211 parent = (View) parent.mParent;
10212 }
10213
10214 return parent;
10215 }
10216
10217 /**
10218 * <p>Computes the coordinates of this view on the screen. The argument
10219 * must be an array of two integers. After the method returns, the array
10220 * contains the x and y location in that order.</p>
10221 *
10222 * @param location an array of two integers in which to hold the coordinates
10223 */
10224 public void getLocationOnScreen(int[] location) {
10225 getLocationInWindow(location);
10226
10227 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -070010228 if (info != null) {
10229 location[0] += info.mWindowLeft;
10230 location[1] += info.mWindowTop;
10231 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010232 }
10233
10234 /**
10235 * <p>Computes the coordinates of this view in its window. The argument
10236 * must be an array of two integers. After the method returns, the array
10237 * contains the x and y location in that order.</p>
10238 *
10239 * @param location an array of two integers in which to hold the coordinates
10240 */
10241 public void getLocationInWindow(int[] location) {
10242 if (location == null || location.length < 2) {
10243 throw new IllegalArgumentException("location must be an array of "
10244 + "two integers");
10245 }
10246
Michael Jurka4d2bd4c2010-11-30 18:15:11 -080010247 location[0] = mLeft + (int) (mTranslationX + 0.5f);
10248 location[1] = mTop + (int) (mTranslationY + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010249
10250 ViewParent viewParent = mParent;
10251 while (viewParent instanceof View) {
10252 final View view = (View)viewParent;
Michael Jurka4d2bd4c2010-11-30 18:15:11 -080010253 location[0] += view.mLeft + (int) (view.mTranslationX + 0.5f) - view.mScrollX;
10254 location[1] += view.mTop + (int) (view.mTranslationY + 0.5f) - view.mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010255 viewParent = view.mParent;
10256 }
Romain Guy8506ab42009-06-11 17:35:47 -070010257
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010258 if (viewParent instanceof ViewRoot) {
10259 // *cough*
10260 final ViewRoot vr = (ViewRoot)viewParent;
10261 location[1] -= vr.mCurScrollY;
10262 }
10263 }
10264
10265 /**
10266 * {@hide}
10267 * @param id the id of the view to be found
10268 * @return the view of the specified id, null if cannot be found
10269 */
10270 protected View findViewTraversal(int id) {
10271 if (id == mID) {
10272 return this;
10273 }
10274 return null;
10275 }
10276
10277 /**
10278 * {@hide}
10279 * @param tag the tag of the view to be found
10280 * @return the view of specified tag, null if cannot be found
10281 */
10282 protected View findViewWithTagTraversal(Object tag) {
10283 if (tag != null && tag.equals(mTag)) {
10284 return this;
10285 }
10286 return null;
10287 }
10288
10289 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080010290 * {@hide}
10291 * @param predicate The predicate to evaluate.
10292 * @return The first view that matches the predicate or null.
10293 */
10294 protected View findViewByPredicateTraversal(Predicate<View> predicate) {
10295 if (predicate.apply(this)) {
10296 return this;
10297 }
10298 return null;
10299 }
10300
10301 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010302 * Look for a child view with the given id. If this view has the given
10303 * id, return this view.
10304 *
10305 * @param id The id to search for.
10306 * @return The view that has the given id in the hierarchy or null
10307 */
10308 public final View findViewById(int id) {
10309 if (id < 0) {
10310 return null;
10311 }
10312 return findViewTraversal(id);
10313 }
10314
10315 /**
10316 * Look for a child view with the given tag. If this view has the given
10317 * tag, return this view.
10318 *
10319 * @param tag The tag to search for, using "tag.equals(getTag())".
10320 * @return The View that has the given tag in the hierarchy or null
10321 */
10322 public final View findViewWithTag(Object tag) {
10323 if (tag == null) {
10324 return null;
10325 }
10326 return findViewWithTagTraversal(tag);
10327 }
10328
10329 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080010330 * {@hide}
10331 * Look for a child view that matches the specified predicate.
10332 * If this view matches the predicate, return this view.
10333 *
10334 * @param predicate The predicate to evaluate.
10335 * @return The first view that matches the predicate or null.
10336 */
10337 public final View findViewByPredicate(Predicate<View> predicate) {
10338 return findViewByPredicateTraversal(predicate);
10339 }
10340
10341 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010342 * Sets the identifier for this view. The identifier does not have to be
10343 * unique in this view's hierarchy. The identifier should be a positive
10344 * number.
10345 *
10346 * @see #NO_ID
10347 * @see #getId
10348 * @see #findViewById
10349 *
10350 * @param id a number used to identify the view
10351 *
10352 * @attr ref android.R.styleable#View_id
10353 */
10354 public void setId(int id) {
10355 mID = id;
10356 }
10357
10358 /**
10359 * {@hide}
10360 *
10361 * @param isRoot true if the view belongs to the root namespace, false
10362 * otherwise
10363 */
10364 public void setIsRootNamespace(boolean isRoot) {
10365 if (isRoot) {
10366 mPrivateFlags |= IS_ROOT_NAMESPACE;
10367 } else {
10368 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
10369 }
10370 }
10371
10372 /**
10373 * {@hide}
10374 *
10375 * @return true if the view belongs to the root namespace, false otherwise
10376 */
10377 public boolean isRootNamespace() {
10378 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
10379 }
10380
10381 /**
10382 * Returns this view's identifier.
10383 *
10384 * @return a positive integer used to identify the view or {@link #NO_ID}
10385 * if the view has no ID
10386 *
10387 * @see #setId
10388 * @see #findViewById
10389 * @attr ref android.R.styleable#View_id
10390 */
10391 @ViewDebug.CapturedViewProperty
10392 public int getId() {
10393 return mID;
10394 }
10395
10396 /**
10397 * Returns this view's tag.
10398 *
10399 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -070010400 *
10401 * @see #setTag(Object)
10402 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010403 */
10404 @ViewDebug.ExportedProperty
10405 public Object getTag() {
10406 return mTag;
10407 }
10408
10409 /**
10410 * Sets the tag associated with this view. A tag can be used to mark
10411 * a view in its hierarchy and does not have to be unique within the
10412 * hierarchy. Tags can also be used to store data within a view without
10413 * resorting to another data structure.
10414 *
10415 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -070010416 *
10417 * @see #getTag()
10418 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010419 */
10420 public void setTag(final Object tag) {
10421 mTag = tag;
10422 }
10423
10424 /**
Romain Guyd90a3312009-05-06 14:54:28 -070010425 * Returns the tag associated with this view and the specified key.
10426 *
10427 * @param key The key identifying the tag
10428 *
10429 * @return the Object stored in this view as a tag
10430 *
10431 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -070010432 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -070010433 */
10434 public Object getTag(int key) {
10435 SparseArray<Object> tags = null;
10436 synchronized (sTagsLock) {
10437 if (sTags != null) {
10438 tags = sTags.get(this);
10439 }
10440 }
10441
10442 if (tags != null) return tags.get(key);
10443 return null;
10444 }
10445
10446 /**
10447 * Sets a tag associated with this view and a key. A tag can be used
10448 * to mark a view in its hierarchy and does not have to be unique within
10449 * the hierarchy. Tags can also be used to store data within a view
10450 * without resorting to another data structure.
10451 *
10452 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -070010453 * application to ensure it is unique (see the <a
10454 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
10455 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -070010456 * the Android framework or not associated with any package will cause
10457 * an {@link IllegalArgumentException} to be thrown.
10458 *
10459 * @param key The key identifying the tag
10460 * @param tag An Object to tag the view with
10461 *
10462 * @throws IllegalArgumentException If they specified key is not valid
10463 *
10464 * @see #setTag(Object)
10465 * @see #getTag(int)
10466 */
10467 public void setTag(int key, final Object tag) {
10468 // If the package id is 0x00 or 0x01, it's either an undefined package
10469 // or a framework id
10470 if ((key >>> 24) < 2) {
10471 throw new IllegalArgumentException("The key must be an application-specific "
10472 + "resource id.");
10473 }
10474
10475 setTagInternal(this, key, tag);
10476 }
10477
10478 /**
10479 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
10480 * framework id.
10481 *
10482 * @hide
10483 */
10484 public void setTagInternal(int key, Object tag) {
10485 if ((key >>> 24) != 0x1) {
10486 throw new IllegalArgumentException("The key must be a framework-specific "
10487 + "resource id.");
10488 }
10489
Romain Guy8506ab42009-06-11 17:35:47 -070010490 setTagInternal(this, key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070010491 }
10492
10493 private static void setTagInternal(View view, int key, Object tag) {
10494 SparseArray<Object> tags = null;
10495 synchronized (sTagsLock) {
10496 if (sTags == null) {
10497 sTags = new WeakHashMap<View, SparseArray<Object>>();
10498 } else {
10499 tags = sTags.get(view);
10500 }
10501 }
10502
10503 if (tags == null) {
10504 tags = new SparseArray<Object>(2);
10505 synchronized (sTagsLock) {
10506 sTags.put(view, tags);
10507 }
10508 }
10509
10510 tags.put(key, tag);
10511 }
10512
10513 /**
Romain Guy13922e02009-05-12 17:56:14 -070010514 * @param consistency The type of consistency. See ViewDebug for more information.
10515 *
10516 * @hide
10517 */
10518 protected boolean dispatchConsistencyCheck(int consistency) {
10519 return onConsistencyCheck(consistency);
10520 }
10521
10522 /**
10523 * Method that subclasses should implement to check their consistency. The type of
10524 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -070010525 *
Romain Guy13922e02009-05-12 17:56:14 -070010526 * @param consistency The type of consistency. See ViewDebug for more information.
10527 *
10528 * @throws IllegalStateException if the view is in an inconsistent state.
10529 *
10530 * @hide
10531 */
10532 protected boolean onConsistencyCheck(int consistency) {
10533 boolean result = true;
10534
10535 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
10536 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
10537
10538 if (checkLayout) {
10539 if (getParent() == null) {
10540 result = false;
10541 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10542 "View " + this + " does not have a parent.");
10543 }
10544
10545 if (mAttachInfo == null) {
10546 result = false;
10547 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10548 "View " + this + " is not attached to a window.");
10549 }
10550 }
10551
10552 if (checkDrawing) {
10553 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
10554 // from their draw() method
10555
10556 if ((mPrivateFlags & DRAWN) != DRAWN &&
10557 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
10558 result = false;
10559 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
10560 "View " + this + " was invalidated but its drawing cache is valid.");
10561 }
10562 }
10563
10564 return result;
10565 }
10566
10567 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010568 * Prints information about this view in the log output, with the tag
10569 * {@link #VIEW_LOG_TAG}.
10570 *
10571 * @hide
10572 */
10573 public void debug() {
10574 debug(0);
10575 }
10576
10577 /**
10578 * Prints information about this view in the log output, with the tag
10579 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
10580 * indentation defined by the <code>depth</code>.
10581 *
10582 * @param depth the indentation level
10583 *
10584 * @hide
10585 */
10586 protected void debug(int depth) {
10587 String output = debugIndent(depth - 1);
10588
10589 output += "+ " + this;
10590 int id = getId();
10591 if (id != -1) {
10592 output += " (id=" + id + ")";
10593 }
10594 Object tag = getTag();
10595 if (tag != null) {
10596 output += " (tag=" + tag + ")";
10597 }
10598 Log.d(VIEW_LOG_TAG, output);
10599
10600 if ((mPrivateFlags & FOCUSED) != 0) {
10601 output = debugIndent(depth) + " FOCUSED";
10602 Log.d(VIEW_LOG_TAG, output);
10603 }
10604
10605 output = debugIndent(depth);
10606 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
10607 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
10608 + "} ";
10609 Log.d(VIEW_LOG_TAG, output);
10610
10611 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
10612 || mPaddingBottom != 0) {
10613 output = debugIndent(depth);
10614 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
10615 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
10616 Log.d(VIEW_LOG_TAG, output);
10617 }
10618
10619 output = debugIndent(depth);
10620 output += "mMeasureWidth=" + mMeasuredWidth +
10621 " mMeasureHeight=" + mMeasuredHeight;
10622 Log.d(VIEW_LOG_TAG, output);
10623
10624 output = debugIndent(depth);
10625 if (mLayoutParams == null) {
10626 output += "BAD! no layout params";
10627 } else {
10628 output = mLayoutParams.debug(output);
10629 }
10630 Log.d(VIEW_LOG_TAG, output);
10631
10632 output = debugIndent(depth);
10633 output += "flags={";
10634 output += View.printFlags(mViewFlags);
10635 output += "}";
10636 Log.d(VIEW_LOG_TAG, output);
10637
10638 output = debugIndent(depth);
10639 output += "privateFlags={";
10640 output += View.printPrivateFlags(mPrivateFlags);
10641 output += "}";
10642 Log.d(VIEW_LOG_TAG, output);
10643 }
10644
10645 /**
10646 * Creates an string of whitespaces used for indentation.
10647 *
10648 * @param depth the indentation level
10649 * @return a String containing (depth * 2 + 3) * 2 white spaces
10650 *
10651 * @hide
10652 */
10653 protected static String debugIndent(int depth) {
10654 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
10655 for (int i = 0; i < (depth * 2) + 3; i++) {
10656 spaces.append(' ').append(' ');
10657 }
10658 return spaces.toString();
10659 }
10660
10661 /**
10662 * <p>Return the offset of the widget's text baseline from the widget's top
10663 * boundary. If this widget does not support baseline alignment, this
10664 * method returns -1. </p>
10665 *
10666 * @return the offset of the baseline within the widget's bounds or -1
10667 * if baseline alignment is not supported
10668 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070010669 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010670 public int getBaseline() {
10671 return -1;
10672 }
10673
10674 /**
10675 * Call this when something has changed which has invalidated the
10676 * layout of this view. This will schedule a layout pass of the view
10677 * tree.
10678 */
10679 public void requestLayout() {
10680 if (ViewDebug.TRACE_HIERARCHY) {
10681 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
10682 }
10683
10684 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080010685 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010686
10687 if (mParent != null && !mParent.isLayoutRequested()) {
10688 mParent.requestLayout();
10689 }
10690 }
10691
10692 /**
10693 * Forces this view to be laid out during the next layout pass.
10694 * This method does not call requestLayout() or forceLayout()
10695 * on the parent.
10696 */
10697 public void forceLayout() {
10698 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080010699 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010700 }
10701
10702 /**
10703 * <p>
10704 * This is called to find out how big a view should be. The parent
10705 * supplies constraint information in the width and height parameters.
10706 * </p>
10707 *
10708 * <p>
10709 * The actual mesurement work of a view is performed in
10710 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
10711 * {@link #onMeasure(int, int)} can and must be overriden by subclasses.
10712 * </p>
10713 *
10714 *
10715 * @param widthMeasureSpec Horizontal space requirements as imposed by the
10716 * parent
10717 * @param heightMeasureSpec Vertical space requirements as imposed by the
10718 * parent
10719 *
10720 * @see #onMeasure(int, int)
10721 */
10722 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
10723 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
10724 widthMeasureSpec != mOldWidthMeasureSpec ||
10725 heightMeasureSpec != mOldHeightMeasureSpec) {
10726
10727 // first clears the measured dimension flag
10728 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
10729
10730 if (ViewDebug.TRACE_HIERARCHY) {
10731 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
10732 }
10733
10734 // measure ourselves, this should set the measured dimension flag back
10735 onMeasure(widthMeasureSpec, heightMeasureSpec);
10736
10737 // flag not set, setMeasuredDimension() was not invoked, we raise
10738 // an exception to warn the developer
10739 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
10740 throw new IllegalStateException("onMeasure() did not set the"
10741 + " measured dimension by calling"
10742 + " setMeasuredDimension()");
10743 }
10744
10745 mPrivateFlags |= LAYOUT_REQUIRED;
10746 }
10747
10748 mOldWidthMeasureSpec = widthMeasureSpec;
10749 mOldHeightMeasureSpec = heightMeasureSpec;
10750 }
10751
10752 /**
10753 * <p>
10754 * Measure the view and its content to determine the measured width and the
10755 * measured height. This method is invoked by {@link #measure(int, int)} and
10756 * should be overriden by subclasses to provide accurate and efficient
10757 * measurement of their contents.
10758 * </p>
10759 *
10760 * <p>
10761 * <strong>CONTRACT:</strong> When overriding this method, you
10762 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
10763 * measured width and height of this view. Failure to do so will trigger an
10764 * <code>IllegalStateException</code>, thrown by
10765 * {@link #measure(int, int)}. Calling the superclass'
10766 * {@link #onMeasure(int, int)} is a valid use.
10767 * </p>
10768 *
10769 * <p>
10770 * The base class implementation of measure defaults to the background size,
10771 * unless a larger size is allowed by the MeasureSpec. Subclasses should
10772 * override {@link #onMeasure(int, int)} to provide better measurements of
10773 * their content.
10774 * </p>
10775 *
10776 * <p>
10777 * If this method is overridden, it is the subclass's responsibility to make
10778 * sure the measured height and width are at least the view's minimum height
10779 * and width ({@link #getSuggestedMinimumHeight()} and
10780 * {@link #getSuggestedMinimumWidth()}).
10781 * </p>
10782 *
10783 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
10784 * The requirements are encoded with
10785 * {@link android.view.View.MeasureSpec}.
10786 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
10787 * The requirements are encoded with
10788 * {@link android.view.View.MeasureSpec}.
10789 *
10790 * @see #getMeasuredWidth()
10791 * @see #getMeasuredHeight()
10792 * @see #setMeasuredDimension(int, int)
10793 * @see #getSuggestedMinimumHeight()
10794 * @see #getSuggestedMinimumWidth()
10795 * @see android.view.View.MeasureSpec#getMode(int)
10796 * @see android.view.View.MeasureSpec#getSize(int)
10797 */
10798 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
10799 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
10800 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
10801 }
10802
10803 /**
10804 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
10805 * measured width and measured height. Failing to do so will trigger an
10806 * exception at measurement time.</p>
10807 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080010808 * @param measuredWidth The measured width of this view. May be a complex
10809 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
10810 * {@link #MEASURED_STATE_TOO_SMALL}.
10811 * @param measuredHeight The measured height of this view. May be a complex
10812 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
10813 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010814 */
10815 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
10816 mMeasuredWidth = measuredWidth;
10817 mMeasuredHeight = measuredHeight;
10818
10819 mPrivateFlags |= MEASURED_DIMENSION_SET;
10820 }
10821
10822 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080010823 * Merge two states as returned by {@link #getMeasuredState()}.
10824 * @param curState The current state as returned from a view or the result
10825 * of combining multiple views.
10826 * @param newState The new view state to combine.
10827 * @return Returns a new integer reflecting the combination of the two
10828 * states.
10829 */
10830 public static int combineMeasuredStates(int curState, int newState) {
10831 return curState | newState;
10832 }
10833
10834 /**
10835 * Version of {@link #resolveSizeAndState(int, int, int)}
10836 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
10837 */
10838 public static int resolveSize(int size, int measureSpec) {
10839 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
10840 }
10841
10842 /**
10843 * Utility to reconcile a desired size and state, with constraints imposed
10844 * by a MeasureSpec. Will take the desired size, unless a different size
10845 * is imposed by the constraints. The returned value is a compound integer,
10846 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
10847 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
10848 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010849 *
10850 * @param size How big the view wants to be
10851 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080010852 * @return Size information bit mask as defined by
10853 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010854 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080010855 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010856 int result = size;
10857 int specMode = MeasureSpec.getMode(measureSpec);
10858 int specSize = MeasureSpec.getSize(measureSpec);
10859 switch (specMode) {
10860 case MeasureSpec.UNSPECIFIED:
10861 result = size;
10862 break;
10863 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080010864 if (specSize < size) {
10865 result = specSize | MEASURED_STATE_TOO_SMALL;
10866 } else {
10867 result = size;
10868 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010869 break;
10870 case MeasureSpec.EXACTLY:
10871 result = specSize;
10872 break;
10873 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080010874 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010875 }
10876
10877 /**
10878 * Utility to return a default size. Uses the supplied size if the
10879 * MeasureSpec imposed no contraints. Will get larger if allowed
10880 * by the MeasureSpec.
10881 *
10882 * @param size Default size for this view
10883 * @param measureSpec Constraints imposed by the parent
10884 * @return The size this view should be.
10885 */
10886 public static int getDefaultSize(int size, int measureSpec) {
10887 int result = size;
10888 int specMode = MeasureSpec.getMode(measureSpec);
10889 int specSize = MeasureSpec.getSize(measureSpec);
10890
10891 switch (specMode) {
10892 case MeasureSpec.UNSPECIFIED:
10893 result = size;
10894 break;
10895 case MeasureSpec.AT_MOST:
10896 case MeasureSpec.EXACTLY:
10897 result = specSize;
10898 break;
10899 }
10900 return result;
10901 }
10902
10903 /**
10904 * Returns the suggested minimum height that the view should use. This
10905 * returns the maximum of the view's minimum height
10906 * and the background's minimum height
10907 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
10908 * <p>
10909 * When being used in {@link #onMeasure(int, int)}, the caller should still
10910 * ensure the returned height is within the requirements of the parent.
10911 *
10912 * @return The suggested minimum height of the view.
10913 */
10914 protected int getSuggestedMinimumHeight() {
10915 int suggestedMinHeight = mMinHeight;
10916
10917 if (mBGDrawable != null) {
10918 final int bgMinHeight = mBGDrawable.getMinimumHeight();
10919 if (suggestedMinHeight < bgMinHeight) {
10920 suggestedMinHeight = bgMinHeight;
10921 }
10922 }
10923
10924 return suggestedMinHeight;
10925 }
10926
10927 /**
10928 * Returns the suggested minimum width that the view should use. This
10929 * returns the maximum of the view's minimum width)
10930 * and the background's minimum width
10931 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
10932 * <p>
10933 * When being used in {@link #onMeasure(int, int)}, the caller should still
10934 * ensure the returned width is within the requirements of the parent.
10935 *
10936 * @return The suggested minimum width of the view.
10937 */
10938 protected int getSuggestedMinimumWidth() {
10939 int suggestedMinWidth = mMinWidth;
10940
10941 if (mBGDrawable != null) {
10942 final int bgMinWidth = mBGDrawable.getMinimumWidth();
10943 if (suggestedMinWidth < bgMinWidth) {
10944 suggestedMinWidth = bgMinWidth;
10945 }
10946 }
10947
10948 return suggestedMinWidth;
10949 }
10950
10951 /**
10952 * Sets the minimum height of the view. It is not guaranteed the view will
10953 * be able to achieve this minimum height (for example, if its parent layout
10954 * constrains it with less available height).
10955 *
10956 * @param minHeight The minimum height the view will try to be.
10957 */
10958 public void setMinimumHeight(int minHeight) {
10959 mMinHeight = minHeight;
10960 }
10961
10962 /**
10963 * Sets the minimum width of the view. It is not guaranteed the view will
10964 * be able to achieve this minimum width (for example, if its parent layout
10965 * constrains it with less available width).
10966 *
10967 * @param minWidth The minimum width the view will try to be.
10968 */
10969 public void setMinimumWidth(int minWidth) {
10970 mMinWidth = minWidth;
10971 }
10972
10973 /**
10974 * Get the animation currently associated with this view.
10975 *
10976 * @return The animation that is currently playing or
10977 * scheduled to play for this view.
10978 */
10979 public Animation getAnimation() {
10980 return mCurrentAnimation;
10981 }
10982
10983 /**
10984 * Start the specified animation now.
10985 *
10986 * @param animation the animation to start now
10987 */
10988 public void startAnimation(Animation animation) {
10989 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
10990 setAnimation(animation);
Romain Guy0fd89bf2011-01-26 15:41:30 -080010991 invalidateParentCaches();
10992 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010993 }
10994
10995 /**
10996 * Cancels any animations for this view.
10997 */
10998 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080010999 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080011000 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080011001 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011002 mCurrentAnimation = null;
Romain Guy0fd89bf2011-01-26 15:41:30 -080011003 invalidateParentIfNeeded();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011004 }
11005
11006 /**
11007 * Sets the next animation to play for this view.
11008 * If you want the animation to play immediately, use
11009 * startAnimation. This method provides allows fine-grained
11010 * control over the start time and invalidation, but you
11011 * must make sure that 1) the animation has a start time set, and
11012 * 2) the view will be invalidated when the animation is supposed to
11013 * start.
11014 *
11015 * @param animation The next animation, or null.
11016 */
11017 public void setAnimation(Animation animation) {
11018 mCurrentAnimation = animation;
11019 if (animation != null) {
11020 animation.reset();
11021 }
11022 }
11023
11024 /**
11025 * Invoked by a parent ViewGroup to notify the start of the animation
11026 * currently associated with this view. If you override this method,
11027 * always call super.onAnimationStart();
11028 *
11029 * @see #setAnimation(android.view.animation.Animation)
11030 * @see #getAnimation()
11031 */
11032 protected void onAnimationStart() {
11033 mPrivateFlags |= ANIMATION_STARTED;
11034 }
11035
11036 /**
11037 * Invoked by a parent ViewGroup to notify the end of the animation
11038 * currently associated with this view. If you override this method,
11039 * always call super.onAnimationEnd();
11040 *
11041 * @see #setAnimation(android.view.animation.Animation)
11042 * @see #getAnimation()
11043 */
11044 protected void onAnimationEnd() {
11045 mPrivateFlags &= ~ANIMATION_STARTED;
11046 }
11047
11048 /**
11049 * Invoked if there is a Transform that involves alpha. Subclass that can
11050 * draw themselves with the specified alpha should return true, and then
11051 * respect that alpha when their onDraw() is called. If this returns false
11052 * then the view may be redirected to draw into an offscreen buffer to
11053 * fulfill the request, which will look fine, but may be slower than if the
11054 * subclass handles it internally. The default implementation returns false.
11055 *
11056 * @param alpha The alpha (0..255) to apply to the view's drawing
11057 * @return true if the view can draw with the specified alpha.
11058 */
11059 protected boolean onSetAlpha(int alpha) {
11060 return false;
11061 }
11062
11063 /**
11064 * This is used by the RootView to perform an optimization when
11065 * the view hierarchy contains one or several SurfaceView.
11066 * SurfaceView is always considered transparent, but its children are not,
11067 * therefore all View objects remove themselves from the global transparent
11068 * region (passed as a parameter to this function).
11069 *
11070 * @param region The transparent region for this ViewRoot (window).
11071 *
11072 * @return Returns true if the effective visibility of the view at this
11073 * point is opaque, regardless of the transparent region; returns false
11074 * if it is possible for underlying windows to be seen behind the view.
11075 *
11076 * {@hide}
11077 */
11078 public boolean gatherTransparentRegion(Region region) {
11079 final AttachInfo attachInfo = mAttachInfo;
11080 if (region != null && attachInfo != null) {
11081 final int pflags = mPrivateFlags;
11082 if ((pflags & SKIP_DRAW) == 0) {
11083 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
11084 // remove it from the transparent region.
11085 final int[] location = attachInfo.mTransparentLocation;
11086 getLocationInWindow(location);
11087 region.op(location[0], location[1], location[0] + mRight - mLeft,
11088 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
11089 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) {
11090 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
11091 // exists, so we remove the background drawable's non-transparent
11092 // parts from this transparent region.
11093 applyDrawableToTransparentRegion(mBGDrawable, region);
11094 }
11095 }
11096 return true;
11097 }
11098
11099 /**
11100 * Play a sound effect for this view.
11101 *
11102 * <p>The framework will play sound effects for some built in actions, such as
11103 * clicking, but you may wish to play these effects in your widget,
11104 * for instance, for internal navigation.
11105 *
11106 * <p>The sound effect will only be played if sound effects are enabled by the user, and
11107 * {@link #isSoundEffectsEnabled()} is true.
11108 *
11109 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
11110 */
11111 public void playSoundEffect(int soundConstant) {
11112 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
11113 return;
11114 }
11115 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
11116 }
11117
11118 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070011119 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070011120 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070011121 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011122 *
11123 * <p>The framework will provide haptic feedback for some built in actions,
11124 * such as long presses, but you may wish to provide feedback for your
11125 * own widget.
11126 *
11127 * <p>The feedback will only be performed if
11128 * {@link #isHapticFeedbackEnabled()} is true.
11129 *
11130 * @param feedbackConstant One of the constants defined in
11131 * {@link HapticFeedbackConstants}
11132 */
11133 public boolean performHapticFeedback(int feedbackConstant) {
11134 return performHapticFeedback(feedbackConstant, 0);
11135 }
11136
11137 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070011138 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070011139 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070011140 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011141 *
11142 * @param feedbackConstant One of the constants defined in
11143 * {@link HapticFeedbackConstants}
11144 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
11145 */
11146 public boolean performHapticFeedback(int feedbackConstant, int flags) {
11147 if (mAttachInfo == null) {
11148 return false;
11149 }
Romain Guyf607bdc2010-09-10 19:20:06 -070011150 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070011151 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011152 && !isHapticFeedbackEnabled()) {
11153 return false;
11154 }
Romain Guy812ccbe2010-06-01 14:07:24 -070011155 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
11156 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011157 }
11158
11159 /**
Joe Onorato664644d2011-01-23 17:53:23 -080011160 * Request that the visibility of the status bar be changed.
11161 */
11162 public void setSystemUiVisibility(int visibility) {
11163 if (visibility != mSystemUiVisibility) {
11164 mSystemUiVisibility = visibility;
11165 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
11166 mParent.recomputeViewAttributes(this);
11167 }
11168 }
11169 }
11170
11171 /**
11172 * Returns the status bar visibility that this view has requested.
11173 */
Joe Onoratoe595cad2011-01-24 09:22:12 -080011174 public int getSystemUiVisibility() {
Joe Onorato664644d2011-01-23 17:53:23 -080011175 return mSystemUiVisibility;
11176 }
11177
11178 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) {
11179 mOnSystemUiVisibilityChangeListener = l;
11180 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
11181 mParent.recomputeViewAttributes(this);
11182 }
11183 }
11184
11185 /**
11186 */
11187 public void dispatchSystemUiVisibilityChanged(int visibility) {
11188 if (mOnSystemUiVisibilityChangeListener != null) {
Joe Onorato7bb8eeb2011-01-27 16:00:58 -080011189 mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange(
Joe Onorato6ab77bd2011-01-31 11:21:10 -080011190 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK);
Joe Onorato664644d2011-01-23 17:53:23 -080011191 }
11192 }
11193
11194 /**
Joe Malin32736f02011-01-19 16:14:20 -080011195 * Creates an image that the system displays during the drag and drop
11196 * operation. This is called a &quot;drag shadow&quot;. The default implementation
11197 * for a DragShadowBuilder based on a View returns an image that has exactly the same
11198 * appearance as the given View. The default also positions the center of the drag shadow
11199 * directly under the touch point. If no View is provided (the constructor with no parameters
11200 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and
11201 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the
11202 * default is an invisible drag shadow.
11203 * <p>
11204 * You are not required to use the View you provide to the constructor as the basis of the
11205 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw
11206 * anything you want as the drag shadow.
11207 * </p>
11208 * <p>
11209 * You pass a DragShadowBuilder object to the system when you start the drag. The system
11210 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the
11211 * size and position of the drag shadow. It uses this data to construct a
11212 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()}
11213 * so that your application can draw the shadow image in the Canvas.
11214 * </p>
Christopher Tate2c095f32010-10-04 14:13:40 -070011215 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011216 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070011217 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070011218
11219 /**
Joe Malin32736f02011-01-19 16:14:20 -080011220 * Constructs a shadow image builder based on a View. By default, the resulting drag
11221 * shadow will have the same appearance and dimensions as the View, with the touch point
11222 * over the center of the View.
11223 * @param view A View. Any View in scope can be used.
Christopher Tate2c095f32010-10-04 14:13:40 -070011224 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011225 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070011226 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070011227 }
11228
Christopher Tate17ed60c2011-01-18 12:50:26 -080011229 /**
11230 * Construct a shadow builder object with no associated View. This
11231 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)}
11232 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order
11233 * to supply the drag shadow's dimensions and appearance without
Joe Malin32736f02011-01-19 16:14:20 -080011234 * reference to any View object. If they are not overridden, then the result is an
11235 * invisible drag shadow.
Christopher Tate17ed60c2011-01-18 12:50:26 -080011236 */
11237 public DragShadowBuilder() {
11238 mView = new WeakReference<View>(null);
11239 }
11240
11241 /**
11242 * Returns the View object that had been passed to the
11243 * {@link #View.DragShadowBuilder(View)}
11244 * constructor. If that View parameter was {@code null} or if the
11245 * {@link #View.DragShadowBuilder()}
11246 * constructor was used to instantiate the builder object, this method will return
11247 * null.
11248 *
11249 * @return The View object associate with this builder object.
11250 */
Chris Tate6b391282010-10-14 15:48:59 -070011251 final public View getView() {
11252 return mView.get();
11253 }
11254
Christopher Tate2c095f32010-10-04 14:13:40 -070011255 /**
Joe Malin32736f02011-01-19 16:14:20 -080011256 * Provides the metrics for the shadow image. These include the dimensions of
11257 * the shadow image, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070011258 * be centered under the touch location while dragging.
11259 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011260 * The default implementation sets the dimensions of the shadow to be the
Joe Malin32736f02011-01-19 16:14:20 -080011261 * same as the dimensions of the View itself and centers the shadow under
11262 * the touch point.
11263 * </p>
Christopher Tate2c095f32010-10-04 14:13:40 -070011264 *
Joe Malin32736f02011-01-19 16:14:20 -080011265 * @param shadowSize A {@link android.graphics.Point} containing the width and height
11266 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the
11267 * desired width and must set {@link android.graphics.Point#y} to the desired height of the
11268 * image.
11269 *
11270 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the
11271 * shadow image that should be underneath the touch point during the drag and drop
11272 * operation. Your application must set {@link android.graphics.Point#x} to the
11273 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position.
Christopher Tate2c095f32010-10-04 14:13:40 -070011274 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011275 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070011276 final View view = mView.get();
11277 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011278 shadowSize.set(view.getWidth(), view.getHeight());
11279 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070011280 } else {
11281 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
11282 }
Christopher Tate2c095f32010-10-04 14:13:40 -070011283 }
11284
11285 /**
Joe Malin32736f02011-01-19 16:14:20 -080011286 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object
11287 * based on the dimensions it received from the
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011288 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate2c095f32010-10-04 14:13:40 -070011289 *
Joe Malin32736f02011-01-19 16:14:20 -080011290 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image.
Christopher Tate2c095f32010-10-04 14:13:40 -070011291 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011292 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070011293 final View view = mView.get();
11294 if (view != null) {
11295 view.draw(canvas);
11296 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011297 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070011298 }
Christopher Tate2c095f32010-10-04 14:13:40 -070011299 }
11300 }
11301
11302 /**
Joe Malin32736f02011-01-19 16:14:20 -080011303 * Starts a drag and drop operation. When your application calls this method, it passes a
11304 * {@link android.view.View.DragShadowBuilder} object to the system. The
11305 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)}
11306 * to get metrics for the drag shadow, and then calls the object's
11307 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself.
11308 * <p>
11309 * Once the system has the drag shadow, it begins the drag and drop operation by sending
11310 * drag events to all the View objects in your application that are currently visible. It does
11311 * this either by calling the View object's drag listener (an implementation of
11312 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the
11313 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method.
11314 * Both are passed a {@link android.view.DragEvent} object that has a
11315 * {@link android.view.DragEvent#getAction()} value of
11316 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}.
11317 * </p>
11318 * <p>
11319 * Your application can invoke startDrag() on any attached View object. The View object does not
11320 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to
11321 * be related to the View the user selected for dragging.
11322 * </p>
11323 * @param data A {@link android.content.ClipData} object pointing to the data to be
11324 * transferred by the drag and drop operation.
11325 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the
11326 * drag shadow.
11327 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and
11328 * drop operation. This Object is put into every DragEvent object sent by the system during the
11329 * current drag.
11330 * <p>
11331 * myLocalState is a lightweight mechanism for the sending information from the dragged View
11332 * to the target Views. For example, it can contain flags that differentiate between a
11333 * a copy operation and a move operation.
11334 * </p>
11335 * @param flags Flags that control the drag and drop operation. No flags are currently defined,
11336 * so the parameter should be set to 0.
11337 * @return {@code true} if the method completes successfully, or
11338 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to
11339 * do a drag, and so no drag operation is in progress.
Christopher Tatea53146c2010-09-07 11:57:52 -070011340 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011341 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080011342 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070011343 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080011344 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070011345 }
11346 boolean okay = false;
11347
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011348 Point shadowSize = new Point();
11349 Point shadowTouchPoint = new Point();
11350 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070011351
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011352 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
11353 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
11354 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070011355 }
Christopher Tatea53146c2010-09-07 11:57:52 -070011356
Chris Tatea32dcf72010-10-14 12:13:50 -070011357 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011358 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
11359 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070011360 }
Christopher Tatea53146c2010-09-07 11:57:52 -070011361 Surface surface = new Surface();
11362 try {
11363 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080011364 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070011365 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070011366 + " surface=" + surface);
11367 if (token != null) {
11368 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070011369 try {
Chris Tate6b391282010-10-14 15:48:59 -070011370 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011371 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070011372 } finally {
11373 surface.unlockCanvasAndPost(canvas);
11374 }
Christopher Tatea53146c2010-09-07 11:57:52 -070011375
Christopher Tate407b4e92010-11-30 17:14:08 -080011376 final ViewRoot root = getViewRoot();
11377
11378 // Cache the local state object for delivery with DragEvents
11379 root.setLocalDragState(myLocalState);
11380
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011381 // repurpose 'shadowSize' for the last touch point
11382 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070011383
Christopher Tatea53146c2010-09-07 11:57:52 -070011384 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080011385 shadowSize.x, shadowSize.y,
11386 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070011387 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tatea53146c2010-09-07 11:57:52 -070011388 }
11389 } catch (Exception e) {
11390 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
11391 surface.destroy();
11392 }
11393
11394 return okay;
11395 }
11396
Christopher Tatea53146c2010-09-07 11:57:52 -070011397 /**
Joe Malin32736f02011-01-19 16:14:20 -080011398 * Handles drag events sent by the system following a call to
11399 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}.
11400 *<p>
11401 * When the system calls this method, it passes a
11402 * {@link android.view.DragEvent} object. A call to
11403 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined
11404 * in DragEvent. The method uses these to determine what is happening in the drag and drop
11405 * operation.
11406 * @param event The {@link android.view.DragEvent} sent by the system.
11407 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined
11408 * in DragEvent, indicating the type of drag event represented by this object.
11409 * @return {@code true} if the method was successful, otherwise {@code false}.
11410 * <p>
11411 * The method should return {@code true} in response to an action type of
11412 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current
11413 * operation.
11414 * </p>
11415 * <p>
11416 * The method should also return {@code true} in response to an action type of
11417 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or
11418 * {@code false} if it didn't.
11419 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070011420 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070011421 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070011422 return false;
11423 }
11424
11425 /**
Joe Malin32736f02011-01-19 16:14:20 -080011426 * Detects if this View is enabled and has a drag event listener.
11427 * If both are true, then it calls the drag event listener with the
11428 * {@link android.view.DragEvent} it received. If the drag event listener returns
11429 * {@code true}, then dispatchDragEvent() returns {@code true}.
11430 * <p>
11431 * For all other cases, the method calls the
11432 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler
11433 * method and returns its result.
11434 * </p>
11435 * <p>
11436 * This ensures that a drag event is always consumed, even if the View does not have a drag
11437 * event listener. However, if the View has a listener and the listener returns true, then
11438 * onDragEvent() is not called.
11439 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070011440 */
11441 public boolean dispatchDragEvent(DragEvent event) {
Romain Guy676b1732011-02-14 14:45:33 -080011442 //noinspection SimplifiableIfStatement
Chris Tate32affef2010-10-18 15:29:21 -070011443 if (mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
11444 && mOnDragListener.onDrag(this, event)) {
11445 return true;
11446 }
Christopher Tatea53146c2010-09-07 11:57:52 -070011447 return onDragEvent(event);
11448 }
11449
11450 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070011451 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
11452 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070011453 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070011454 */
11455 public void onCloseSystemDialogs(String reason) {
11456 }
Joe Malin32736f02011-01-19 16:14:20 -080011457
Dianne Hackbornffa42482009-09-23 22:20:11 -070011458 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011459 * Given a Drawable whose bounds have been set to draw into this view,
11460 * update a Region being computed for {@link #gatherTransparentRegion} so
11461 * that any non-transparent parts of the Drawable are removed from the
11462 * given transparent region.
11463 *
11464 * @param dr The Drawable whose transparency is to be applied to the region.
11465 * @param region A Region holding the current transparency information,
11466 * where any parts of the region that are set are considered to be
11467 * transparent. On return, this region will be modified to have the
11468 * transparency information reduced by the corresponding parts of the
11469 * Drawable that are not transparent.
11470 * {@hide}
11471 */
11472 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
11473 if (DBG) {
11474 Log.i("View", "Getting transparent region for: " + this);
11475 }
11476 final Region r = dr.getTransparentRegion();
11477 final Rect db = dr.getBounds();
11478 final AttachInfo attachInfo = mAttachInfo;
11479 if (r != null && attachInfo != null) {
11480 final int w = getRight()-getLeft();
11481 final int h = getBottom()-getTop();
11482 if (db.left > 0) {
11483 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
11484 r.op(0, 0, db.left, h, Region.Op.UNION);
11485 }
11486 if (db.right < w) {
11487 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
11488 r.op(db.right, 0, w, h, Region.Op.UNION);
11489 }
11490 if (db.top > 0) {
11491 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
11492 r.op(0, 0, w, db.top, Region.Op.UNION);
11493 }
11494 if (db.bottom < h) {
11495 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
11496 r.op(0, db.bottom, w, h, Region.Op.UNION);
11497 }
11498 final int[] location = attachInfo.mTransparentLocation;
11499 getLocationInWindow(location);
11500 r.translate(location[0], location[1]);
11501 region.op(r, Region.Op.INTERSECT);
11502 } else {
11503 region.op(db, Region.Op.DIFFERENCE);
11504 }
11505 }
11506
Adam Powelle14579b2009-12-16 18:39:52 -080011507 private void postCheckForLongClick(int delayOffset) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011508 mHasPerformedLongPress = false;
11509
11510 if (mPendingCheckForLongPress == null) {
11511 mPendingCheckForLongPress = new CheckForLongPress();
11512 }
11513 mPendingCheckForLongPress.rememberWindowAttachCount();
Adam Powelle14579b2009-12-16 18:39:52 -080011514 postDelayed(mPendingCheckForLongPress,
11515 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011516 }
11517
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011518 /**
11519 * Inflate a view from an XML resource. This convenience method wraps the {@link
11520 * LayoutInflater} class, which provides a full range of options for view inflation.
11521 *
11522 * @param context The Context object for your activity or application.
11523 * @param resource The resource ID to inflate
11524 * @param root A view group that will be the parent. Used to properly inflate the
11525 * layout_* parameters.
11526 * @see LayoutInflater
11527 */
11528 public static View inflate(Context context, int resource, ViewGroup root) {
11529 LayoutInflater factory = LayoutInflater.from(context);
11530 return factory.inflate(resource, root);
11531 }
Romain Guy33e72ae2010-07-17 12:40:29 -070011532
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011533 /**
Adam Powell637d3372010-08-25 14:37:03 -070011534 * Scroll the view with standard behavior for scrolling beyond the normal
11535 * content boundaries. Views that call this method should override
11536 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
11537 * results of an over-scroll operation.
11538 *
11539 * Views can use this method to handle any touch or fling-based scrolling.
11540 *
11541 * @param deltaX Change in X in pixels
11542 * @param deltaY Change in Y in pixels
11543 * @param scrollX Current X scroll value in pixels before applying deltaX
11544 * @param scrollY Current Y scroll value in pixels before applying deltaY
11545 * @param scrollRangeX Maximum content scroll range along the X axis
11546 * @param scrollRangeY Maximum content scroll range along the Y axis
11547 * @param maxOverScrollX Number of pixels to overscroll by in either direction
11548 * along the X axis.
11549 * @param maxOverScrollY Number of pixels to overscroll by in either direction
11550 * along the Y axis.
11551 * @param isTouchEvent true if this scroll operation is the result of a touch event.
11552 * @return true if scrolling was clamped to an over-scroll boundary along either
11553 * axis, false otherwise.
11554 */
11555 protected boolean overScrollBy(int deltaX, int deltaY,
11556 int scrollX, int scrollY,
11557 int scrollRangeX, int scrollRangeY,
11558 int maxOverScrollX, int maxOverScrollY,
11559 boolean isTouchEvent) {
11560 final int overScrollMode = mOverScrollMode;
11561 final boolean canScrollHorizontal =
11562 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
11563 final boolean canScrollVertical =
11564 computeVerticalScrollRange() > computeVerticalScrollExtent();
11565 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
11566 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
11567 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
11568 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
11569
11570 int newScrollX = scrollX + deltaX;
11571 if (!overScrollHorizontal) {
11572 maxOverScrollX = 0;
11573 }
11574
11575 int newScrollY = scrollY + deltaY;
11576 if (!overScrollVertical) {
11577 maxOverScrollY = 0;
11578 }
11579
11580 // Clamp values if at the limits and record
11581 final int left = -maxOverScrollX;
11582 final int right = maxOverScrollX + scrollRangeX;
11583 final int top = -maxOverScrollY;
11584 final int bottom = maxOverScrollY + scrollRangeY;
11585
11586 boolean clampedX = false;
11587 if (newScrollX > right) {
11588 newScrollX = right;
11589 clampedX = true;
11590 } else if (newScrollX < left) {
11591 newScrollX = left;
11592 clampedX = true;
11593 }
11594
11595 boolean clampedY = false;
11596 if (newScrollY > bottom) {
11597 newScrollY = bottom;
11598 clampedY = true;
11599 } else if (newScrollY < top) {
11600 newScrollY = top;
11601 clampedY = true;
11602 }
11603
11604 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
11605
11606 return clampedX || clampedY;
11607 }
11608
11609 /**
11610 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
11611 * respond to the results of an over-scroll operation.
11612 *
11613 * @param scrollX New X scroll value in pixels
11614 * @param scrollY New Y scroll value in pixels
11615 * @param clampedX True if scrollX was clamped to an over-scroll boundary
11616 * @param clampedY True if scrollY was clamped to an over-scroll boundary
11617 */
11618 protected void onOverScrolled(int scrollX, int scrollY,
11619 boolean clampedX, boolean clampedY) {
11620 // Intentionally empty.
11621 }
11622
11623 /**
11624 * Returns the over-scroll mode for this view. The result will be
11625 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
11626 * (allow over-scrolling only if the view content is larger than the container),
11627 * or {@link #OVER_SCROLL_NEVER}.
11628 *
11629 * @return This view's over-scroll mode.
11630 */
11631 public int getOverScrollMode() {
11632 return mOverScrollMode;
11633 }
11634
11635 /**
11636 * Set the over-scroll mode for this view. Valid over-scroll modes are
11637 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
11638 * (allow over-scrolling only if the view content is larger than the container),
11639 * or {@link #OVER_SCROLL_NEVER}.
11640 *
11641 * Setting the over-scroll mode of a view will have an effect only if the
11642 * view is capable of scrolling.
11643 *
11644 * @param overScrollMode The new over-scroll mode for this view.
11645 */
11646 public void setOverScrollMode(int overScrollMode) {
11647 if (overScrollMode != OVER_SCROLL_ALWAYS &&
11648 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
11649 overScrollMode != OVER_SCROLL_NEVER) {
11650 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
11651 }
11652 mOverScrollMode = overScrollMode;
11653 }
11654
11655 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011656 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
11657 * Each MeasureSpec represents a requirement for either the width or the height.
11658 * A MeasureSpec is comprised of a size and a mode. There are three possible
11659 * modes:
11660 * <dl>
11661 * <dt>UNSPECIFIED</dt>
11662 * <dd>
11663 * The parent has not imposed any constraint on the child. It can be whatever size
11664 * it wants.
11665 * </dd>
11666 *
11667 * <dt>EXACTLY</dt>
11668 * <dd>
11669 * The parent has determined an exact size for the child. The child is going to be
11670 * given those bounds regardless of how big it wants to be.
11671 * </dd>
11672 *
11673 * <dt>AT_MOST</dt>
11674 * <dd>
11675 * The child can be as large as it wants up to the specified size.
11676 * </dd>
11677 * </dl>
11678 *
11679 * MeasureSpecs are implemented as ints to reduce object allocation. This class
11680 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
11681 */
11682 public static class MeasureSpec {
11683 private static final int MODE_SHIFT = 30;
11684 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
11685
11686 /**
11687 * Measure specification mode: The parent has not imposed any constraint
11688 * on the child. It can be whatever size it wants.
11689 */
11690 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
11691
11692 /**
11693 * Measure specification mode: The parent has determined an exact size
11694 * for the child. The child is going to be given those bounds regardless
11695 * of how big it wants to be.
11696 */
11697 public static final int EXACTLY = 1 << MODE_SHIFT;
11698
11699 /**
11700 * Measure specification mode: The child can be as large as it wants up
11701 * to the specified size.
11702 */
11703 public static final int AT_MOST = 2 << MODE_SHIFT;
11704
11705 /**
11706 * Creates a measure specification based on the supplied size and mode.
11707 *
11708 * The mode must always be one of the following:
11709 * <ul>
11710 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
11711 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
11712 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
11713 * </ul>
11714 *
11715 * @param size the size of the measure specification
11716 * @param mode the mode of the measure specification
11717 * @return the measure specification based on size and mode
11718 */
11719 public static int makeMeasureSpec(int size, int mode) {
11720 return size + mode;
11721 }
11722
11723 /**
11724 * Extracts the mode from the supplied measure specification.
11725 *
11726 * @param measureSpec the measure specification to extract the mode from
11727 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
11728 * {@link android.view.View.MeasureSpec#AT_MOST} or
11729 * {@link android.view.View.MeasureSpec#EXACTLY}
11730 */
11731 public static int getMode(int measureSpec) {
11732 return (measureSpec & MODE_MASK);
11733 }
11734
11735 /**
11736 * Extracts the size from the supplied measure specification.
11737 *
11738 * @param measureSpec the measure specification to extract the size from
11739 * @return the size in pixels defined in the supplied measure specification
11740 */
11741 public static int getSize(int measureSpec) {
11742 return (measureSpec & ~MODE_MASK);
11743 }
11744
11745 /**
11746 * Returns a String representation of the specified measure
11747 * specification.
11748 *
11749 * @param measureSpec the measure specification to convert to a String
11750 * @return a String with the following format: "MeasureSpec: MODE SIZE"
11751 */
11752 public static String toString(int measureSpec) {
11753 int mode = getMode(measureSpec);
11754 int size = getSize(measureSpec);
11755
11756 StringBuilder sb = new StringBuilder("MeasureSpec: ");
11757
11758 if (mode == UNSPECIFIED)
11759 sb.append("UNSPECIFIED ");
11760 else if (mode == EXACTLY)
11761 sb.append("EXACTLY ");
11762 else if (mode == AT_MOST)
11763 sb.append("AT_MOST ");
11764 else
11765 sb.append(mode).append(" ");
11766
11767 sb.append(size);
11768 return sb.toString();
11769 }
11770 }
11771
11772 class CheckForLongPress implements Runnable {
11773
11774 private int mOriginalWindowAttachCount;
11775
11776 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070011777 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011778 && mOriginalWindowAttachCount == mWindowAttachCount) {
11779 if (performLongClick()) {
11780 mHasPerformedLongPress = true;
11781 }
11782 }
11783 }
11784
11785 public void rememberWindowAttachCount() {
11786 mOriginalWindowAttachCount = mWindowAttachCount;
11787 }
11788 }
Joe Malin32736f02011-01-19 16:14:20 -080011789
Adam Powelle14579b2009-12-16 18:39:52 -080011790 private final class CheckForTap implements Runnable {
11791 public void run() {
11792 mPrivateFlags &= ~PREPRESSED;
11793 mPrivateFlags |= PRESSED;
11794 refreshDrawableState();
11795 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
11796 postCheckForLongClick(ViewConfiguration.getTapTimeout());
11797 }
11798 }
11799 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011800
Adam Powella35d7682010-03-12 14:48:13 -080011801 private final class PerformClick implements Runnable {
11802 public void run() {
11803 performClick();
11804 }
11805 }
11806
Dianne Hackborn63042d62011-01-26 18:56:29 -080011807 /** @hide */
11808 public void hackTurnOffWindowResizeAnim(boolean off) {
11809 mAttachInfo.mTurnOffWindowResizeAnim = off;
11810 }
Joe Malin32736f02011-01-19 16:14:20 -080011811
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011812 /**
Chet Haasea00f3862011-02-22 06:34:40 -080011813 * This method returns a ViewPropertyAnimator object, which can be used to animate
11814 * specific properties on this View.
11815 *
11816 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View.
11817 */
11818 public ViewPropertyAnimator animate() {
11819 if (mAnimator == null) {
11820 mAnimator = new ViewPropertyAnimator(this);
11821 }
11822 return mAnimator;
11823 }
11824
11825 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011826 * Interface definition for a callback to be invoked when a key event is
11827 * dispatched to this view. The callback will be invoked before the key
11828 * event is given to the view.
11829 */
11830 public interface OnKeyListener {
11831 /**
11832 * Called when a key is dispatched to a view. This allows listeners to
11833 * get a chance to respond before the target view.
11834 *
11835 * @param v The view the key has been dispatched to.
11836 * @param keyCode The code for the physical key that was pressed
11837 * @param event The KeyEvent object containing full information about
11838 * the event.
11839 * @return True if the listener has consumed the event, false otherwise.
11840 */
11841 boolean onKey(View v, int keyCode, KeyEvent event);
11842 }
11843
11844 /**
11845 * Interface definition for a callback to be invoked when a touch event is
11846 * dispatched to this view. The callback will be invoked before the touch
11847 * event is given to the view.
11848 */
11849 public interface OnTouchListener {
11850 /**
11851 * Called when a touch event is dispatched to a view. This allows listeners to
11852 * get a chance to respond before the target view.
11853 *
11854 * @param v The view the touch event has been dispatched to.
11855 * @param event The MotionEvent object containing full information about
11856 * the event.
11857 * @return True if the listener has consumed the event, false otherwise.
11858 */
11859 boolean onTouch(View v, MotionEvent event);
11860 }
11861
11862 /**
11863 * Interface definition for a callback to be invoked when a view has been clicked and held.
11864 */
11865 public interface OnLongClickListener {
11866 /**
11867 * Called when a view has been clicked and held.
11868 *
11869 * @param v The view that was clicked and held.
11870 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080011871 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011872 */
11873 boolean onLongClick(View v);
11874 }
11875
11876 /**
Chris Tate32affef2010-10-18 15:29:21 -070011877 * Interface definition for a callback to be invoked when a drag is being dispatched
11878 * to this view. The callback will be invoked before the hosting view's own
11879 * onDrag(event) method. If the listener wants to fall back to the hosting view's
11880 * onDrag(event) behavior, it should return 'false' from this callback.
11881 */
11882 public interface OnDragListener {
11883 /**
11884 * Called when a drag event is dispatched to a view. This allows listeners
11885 * to get a chance to override base View behavior.
11886 *
Joe Malin32736f02011-01-19 16:14:20 -080011887 * @param v The View that received the drag event.
11888 * @param event The {@link android.view.DragEvent} object for the drag event.
11889 * @return {@code true} if the drag event was handled successfully, or {@code false}
11890 * if the drag event was not handled. Note that {@code false} will trigger the View
11891 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler.
Chris Tate32affef2010-10-18 15:29:21 -070011892 */
11893 boolean onDrag(View v, DragEvent event);
11894 }
11895
11896 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011897 * Interface definition for a callback to be invoked when the focus state of
11898 * a view changed.
11899 */
11900 public interface OnFocusChangeListener {
11901 /**
11902 * Called when the focus state of a view has changed.
11903 *
11904 * @param v The view whose state has changed.
11905 * @param hasFocus The new focus state of v.
11906 */
11907 void onFocusChange(View v, boolean hasFocus);
11908 }
11909
11910 /**
11911 * Interface definition for a callback to be invoked when a view is clicked.
11912 */
11913 public interface OnClickListener {
11914 /**
11915 * Called when a view has been clicked.
11916 *
11917 * @param v The view that was clicked.
11918 */
11919 void onClick(View v);
11920 }
11921
11922 /**
11923 * Interface definition for a callback to be invoked when the context menu
11924 * for this view is being built.
11925 */
11926 public interface OnCreateContextMenuListener {
11927 /**
11928 * Called when the context menu for this view is being built. It is not
11929 * safe to hold onto the menu after this method returns.
11930 *
11931 * @param menu The context menu that is being built
11932 * @param v The view for which the context menu is being built
11933 * @param menuInfo Extra information about the item for which the
11934 * context menu should be shown. This information will vary
11935 * depending on the class of v.
11936 */
11937 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
11938 }
11939
Joe Onorato664644d2011-01-23 17:53:23 -080011940 /**
11941 * Interface definition for a callback to be invoked when the status bar changes
11942 * visibility.
11943 *
11944 * @see #setOnSystemUiVisibilityChangeListener
11945 */
11946 public interface OnSystemUiVisibilityChangeListener {
11947 /**
11948 * Called when the status bar changes visibility because of a call to
11949 * {@link #setSystemUiVisibility}.
11950 *
11951 * @param visibility {@link #STATUS_BAR_VISIBLE} or {@link #STATUS_BAR_HIDDEN}.
11952 */
11953 public void onSystemUiVisibilityChange(int visibility);
11954 }
11955
Adam Powell4afd62b2011-02-18 15:02:18 -080011956 /**
11957 * Interface definition for a callback to be invoked when this view is attached
11958 * or detached from its window.
11959 */
11960 public interface OnAttachStateChangeListener {
11961 /**
11962 * Called when the view is attached to a window.
11963 * @param v The view that was attached
11964 */
11965 public void onViewAttachedToWindow(View v);
11966 /**
11967 * Called when the view is detached from a window.
11968 * @param v The view that was detached
11969 */
11970 public void onViewDetachedFromWindow(View v);
11971 }
11972
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011973 private final class UnsetPressedState implements Runnable {
11974 public void run() {
11975 setPressed(false);
11976 }
11977 }
11978
11979 /**
11980 * Base class for derived classes that want to save and restore their own
11981 * state in {@link android.view.View#onSaveInstanceState()}.
11982 */
11983 public static class BaseSavedState extends AbsSavedState {
11984 /**
11985 * Constructor used when reading from a parcel. Reads the state of the superclass.
11986 *
11987 * @param source
11988 */
11989 public BaseSavedState(Parcel source) {
11990 super(source);
11991 }
11992
11993 /**
11994 * Constructor called by derived classes when creating their SavedState objects
11995 *
11996 * @param superState The state of the superclass of this view
11997 */
11998 public BaseSavedState(Parcelable superState) {
11999 super(superState);
12000 }
12001
12002 public static final Parcelable.Creator<BaseSavedState> CREATOR =
12003 new Parcelable.Creator<BaseSavedState>() {
12004 public BaseSavedState createFromParcel(Parcel in) {
12005 return new BaseSavedState(in);
12006 }
12007
12008 public BaseSavedState[] newArray(int size) {
12009 return new BaseSavedState[size];
12010 }
12011 };
12012 }
12013
12014 /**
12015 * A set of information given to a view when it is attached to its parent
12016 * window.
12017 */
12018 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012019 interface Callbacks {
12020 void playSoundEffect(int effectId);
12021 boolean performHapticFeedback(int effectId, boolean always);
12022 }
12023
12024 /**
12025 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
12026 * to a Handler. This class contains the target (View) to invalidate and
12027 * the coordinates of the dirty rectangle.
12028 *
12029 * For performance purposes, this class also implements a pool of up to
12030 * POOL_LIMIT objects that get reused. This reduces memory allocations
12031 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012032 */
Romain Guyd928d682009-03-31 17:52:16 -070012033 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012034 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070012035 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
12036 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070012037 public InvalidateInfo newInstance() {
12038 return new InvalidateInfo();
12039 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012040
Romain Guyd928d682009-03-31 17:52:16 -070012041 public void onAcquired(InvalidateInfo element) {
12042 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012043
Romain Guyd928d682009-03-31 17:52:16 -070012044 public void onReleased(InvalidateInfo element) {
12045 }
12046 }, POOL_LIMIT)
12047 );
12048
12049 private InvalidateInfo mNext;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012050
12051 View target;
12052
12053 int left;
12054 int top;
12055 int right;
12056 int bottom;
12057
Romain Guyd928d682009-03-31 17:52:16 -070012058 public void setNextPoolable(InvalidateInfo element) {
12059 mNext = element;
12060 }
12061
12062 public InvalidateInfo getNextPoolable() {
12063 return mNext;
12064 }
12065
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012066 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070012067 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012068 }
12069
12070 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070012071 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012072 }
12073 }
12074
12075 final IWindowSession mSession;
12076
12077 final IWindow mWindow;
12078
12079 final IBinder mWindowToken;
12080
12081 final Callbacks mRootCallbacks;
12082
Chet Haasedaf98e92011-01-10 14:10:36 -080012083 Canvas mHardwareCanvas;
12084
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012085 /**
12086 * The top view of the hierarchy.
12087 */
12088 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070012089
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012090 IBinder mPanelParentWindowToken;
12091 Surface mSurface;
12092
Romain Guyb051e892010-09-28 19:09:36 -070012093 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080012094 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070012095 HardwareRenderer mHardwareRenderer;
Joe Malin32736f02011-01-19 16:14:20 -080012096
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012097 /**
Romain Guy8506ab42009-06-11 17:35:47 -070012098 * Scale factor used by the compatibility mode
12099 */
12100 float mApplicationScale;
12101
12102 /**
12103 * Indicates whether the application is in compatibility mode
12104 */
12105 boolean mScalingRequired;
12106
12107 /**
Dianne Hackborn63042d62011-01-26 18:56:29 -080012108 * If set, ViewRoot doesn't use its lame animation for when the window resizes.
12109 */
12110 boolean mTurnOffWindowResizeAnim;
Joe Malin32736f02011-01-19 16:14:20 -080012111
Dianne Hackborn63042d62011-01-26 18:56:29 -080012112 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012113 * Left position of this view's window
12114 */
12115 int mWindowLeft;
12116
12117 /**
12118 * Top position of this view's window
12119 */
12120 int mWindowTop;
12121
12122 /**
Adam Powell26153a32010-11-08 15:22:27 -080012123 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070012124 */
Adam Powell26153a32010-11-08 15:22:27 -080012125 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070012126
12127 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012128 * For windows that are full-screen but using insets to layout inside
12129 * of the screen decorations, these are the current insets for the
12130 * content of the window.
12131 */
12132 final Rect mContentInsets = new Rect();
12133
12134 /**
12135 * For windows that are full-screen but using insets to layout inside
12136 * of the screen decorations, these are the current insets for the
12137 * actual visible parts of the window.
12138 */
12139 final Rect mVisibleInsets = new Rect();
12140
12141 /**
12142 * The internal insets given by this window. This value is
12143 * supplied by the client (through
12144 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
12145 * be given to the window manager when changed to be used in laying
12146 * out windows behind it.
12147 */
12148 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
12149 = new ViewTreeObserver.InternalInsetsInfo();
12150
12151 /**
12152 * All views in the window's hierarchy that serve as scroll containers,
12153 * used to determine if the window can be resized or must be panned
12154 * to adjust for a soft input area.
12155 */
12156 final ArrayList<View> mScrollContainers = new ArrayList<View>();
12157
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070012158 final KeyEvent.DispatcherState mKeyDispatchState
12159 = new KeyEvent.DispatcherState();
12160
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012161 /**
12162 * Indicates whether the view's window currently has the focus.
12163 */
12164 boolean mHasWindowFocus;
12165
12166 /**
12167 * The current visibility of the window.
12168 */
12169 int mWindowVisibility;
12170
12171 /**
12172 * Indicates the time at which drawing started to occur.
12173 */
12174 long mDrawingTime;
12175
12176 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070012177 * Indicates whether or not ignoring the DIRTY_MASK flags.
12178 */
12179 boolean mIgnoreDirtyState;
12180
12181 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012182 * Indicates whether the view's window is currently in touch mode.
12183 */
12184 boolean mInTouchMode;
12185
12186 /**
12187 * Indicates that ViewRoot should trigger a global layout change
12188 * the next time it performs a traversal
12189 */
12190 boolean mRecomputeGlobalAttributes;
12191
12192 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012193 * Set during a traveral if any views want to keep the screen on.
12194 */
12195 boolean mKeepScreenOn;
12196
12197 /**
Joe Onorato664644d2011-01-23 17:53:23 -080012198 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility().
12199 */
12200 int mSystemUiVisibility;
12201
12202 /**
12203 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener
12204 * attached.
12205 */
12206 boolean mHasSystemUiListeners;
12207
12208 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012209 * Set if the visibility of any views has changed.
12210 */
12211 boolean mViewVisibilityChanged;
12212
12213 /**
12214 * Set to true if a view has been scrolled.
12215 */
12216 boolean mViewScrollChanged;
12217
12218 /**
12219 * Global to the view hierarchy used as a temporary for dealing with
12220 * x/y points in the transparent region computations.
12221 */
12222 final int[] mTransparentLocation = new int[2];
12223
12224 /**
12225 * Global to the view hierarchy used as a temporary for dealing with
12226 * x/y points in the ViewGroup.invalidateChild implementation.
12227 */
12228 final int[] mInvalidateChildLocation = new int[2];
12229
Chet Haasec3aa3612010-06-17 08:50:37 -070012230
12231 /**
12232 * Global to the view hierarchy used as a temporary for dealing with
12233 * x/y location when view is transformed.
12234 */
12235 final float[] mTmpTransformLocation = new float[2];
12236
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012237 /**
12238 * The view tree observer used to dispatch global events like
12239 * layout, pre-draw, touch mode change, etc.
12240 */
12241 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
12242
12243 /**
12244 * A Canvas used by the view hierarchy to perform bitmap caching.
12245 */
12246 Canvas mCanvas;
12247
12248 /**
12249 * A Handler supplied by a view's {@link android.view.ViewRoot}. This
12250 * handler can be used to pump events in the UI events queue.
12251 */
12252 final Handler mHandler;
12253
12254 /**
12255 * Identifier for messages requesting the view to be invalidated.
12256 * Such messages should be sent to {@link #mHandler}.
12257 */
12258 static final int INVALIDATE_MSG = 0x1;
12259
12260 /**
12261 * Identifier for messages requesting the view to invalidate a region.
12262 * Such messages should be sent to {@link #mHandler}.
12263 */
12264 static final int INVALIDATE_RECT_MSG = 0x2;
12265
12266 /**
12267 * Temporary for use in computing invalidate rectangles while
12268 * calling up the hierarchy.
12269 */
12270 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070012271
12272 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070012273 * Temporary for use in computing hit areas with transformed views
12274 */
12275 final RectF mTmpTransformRect = new RectF();
12276
12277 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070012278 * Temporary list for use in collecting focusable descendents of a view.
12279 */
12280 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24);
12281
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012282 /**
12283 * Creates a new set of attachment information with the specified
12284 * events handler and thread.
12285 *
12286 * @param handler the events handler the view must use
12287 */
12288 AttachInfo(IWindowSession session, IWindow window,
12289 Handler handler, Callbacks effectPlayer) {
12290 mSession = session;
12291 mWindow = window;
12292 mWindowToken = window.asBinder();
12293 mHandler = handler;
12294 mRootCallbacks = effectPlayer;
12295 }
12296 }
12297
12298 /**
12299 * <p>ScrollabilityCache holds various fields used by a View when scrolling
12300 * is supported. This avoids keeping too many unused fields in most
12301 * instances of View.</p>
12302 */
Mike Cleronf116bf82009-09-27 19:14:12 -070012303 private static class ScrollabilityCache implements Runnable {
Joe Malin32736f02011-01-19 16:14:20 -080012304
Mike Cleronf116bf82009-09-27 19:14:12 -070012305 /**
12306 * Scrollbars are not visible
12307 */
12308 public static final int OFF = 0;
12309
12310 /**
12311 * Scrollbars are visible
12312 */
12313 public static final int ON = 1;
12314
12315 /**
12316 * Scrollbars are fading away
12317 */
12318 public static final int FADING = 2;
12319
12320 public boolean fadeScrollBars;
Joe Malin32736f02011-01-19 16:14:20 -080012321
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012322 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070012323 public int scrollBarDefaultDelayBeforeFade;
12324 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012325
12326 public int scrollBarSize;
12327 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070012328 public float[] interpolatorValues;
12329 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012330
12331 public final Paint paint;
12332 public final Matrix matrix;
12333 public Shader shader;
12334
Mike Cleronf116bf82009-09-27 19:14:12 -070012335 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
12336
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080012337 private static final float[] OPAQUE = { 255 };
12338 private static final float[] TRANSPARENT = { 0.0f };
Joe Malin32736f02011-01-19 16:14:20 -080012339
Mike Cleronf116bf82009-09-27 19:14:12 -070012340 /**
12341 * When fading should start. This time moves into the future every time
12342 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
12343 */
12344 public long fadeStartTime;
12345
12346
12347 /**
12348 * The current state of the scrollbars: ON, OFF, or FADING
12349 */
12350 public int state = OFF;
12351
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012352 private int mLastColor;
12353
Mike Cleronf116bf82009-09-27 19:14:12 -070012354 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012355 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
12356 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070012357 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
12358 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012359
12360 paint = new Paint();
12361 matrix = new Matrix();
12362 // use use a height of 1, and then wack the matrix each time we
12363 // actually use it.
12364 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070012365
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012366 paint.setShader(shader);
12367 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070012368 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012369 }
Romain Guy8506ab42009-06-11 17:35:47 -070012370
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012371 public void setFadeColor(int color) {
12372 if (color != 0 && color != mLastColor) {
12373 mLastColor = color;
12374 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070012375
Romain Guye55e1a72009-08-27 10:42:26 -070012376 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
12377 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070012378
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012379 paint.setShader(shader);
12380 // Restore the default transfer mode (src_over)
12381 paint.setXfermode(null);
12382 }
12383 }
Joe Malin32736f02011-01-19 16:14:20 -080012384
Mike Cleronf116bf82009-09-27 19:14:12 -070012385 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070012386 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070012387 if (now >= fadeStartTime) {
12388
12389 // the animation fades the scrollbars out by changing
12390 // the opacity (alpha) from fully opaque to fully
12391 // transparent
12392 int nextFrame = (int) now;
12393 int framesCount = 0;
12394
12395 Interpolator interpolator = scrollBarInterpolator;
12396
12397 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080012398 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070012399
12400 // End transparent
12401 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080012402 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070012403
12404 state = FADING;
12405
12406 // Kick off the fade animation
Romain Guy0fd89bf2011-01-26 15:41:30 -080012407 host.invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -070012408 }
12409 }
12410
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012411 }
12412}