blob: 5b8a2019a0a96ec06a16d76b589239f2306b5c49 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.view;
18
Christopher Tatea53146c2010-09-07 11:57:52 -070019import android.content.ClipData;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080020import android.content.Context;
Dianne Hackborne36d6e22010-02-17 19:46:25 -080021import android.content.res.Configuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080022import android.content.res.Resources;
23import android.content.res.TypedArray;
24import android.graphics.Bitmap;
Adam Powell2b342f02010-08-18 18:14:13 -070025import android.graphics.Camera;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080026import android.graphics.Canvas;
Mike Cleronf116bf82009-09-27 19:14:12 -070027import android.graphics.Interpolator;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080028import android.graphics.LinearGradient;
29import android.graphics.Matrix;
30import android.graphics.Paint;
31import android.graphics.PixelFormat;
svetoslavganov75986cf2009-05-14 22:28:01 -070032import android.graphics.Point;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080033import android.graphics.PorterDuff;
34import android.graphics.PorterDuffXfermode;
35import android.graphics.Rect;
Adam Powell6e346362010-07-23 10:18:23 -070036import android.graphics.RectF;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080037import android.graphics.Region;
38import android.graphics.Shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080039import android.graphics.drawable.ColorDrawable;
40import android.graphics.drawable.Drawable;
41import android.os.Handler;
42import android.os.IBinder;
43import android.os.Message;
44import android.os.Parcel;
45import android.os.Parcelable;
46import android.os.RemoteException;
47import android.os.SystemClock;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080048import android.util.AttributeSet;
Doug Feltcb3791202011-07-07 11:57:48 -070049import android.util.FloatProperty;
50import android.util.LocaleUtil;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080051import android.util.Log;
Romain Guyd928d682009-03-31 17:52:16 -070052import android.util.Pool;
svetoslavganov75986cf2009-05-14 22:28:01 -070053import android.util.Poolable;
Romain Guyd928d682009-03-31 17:52:16 -070054import android.util.PoolableManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070055import android.util.Pools;
Doug Feltcb3791202011-07-07 11:57:48 -070056import android.util.Property;
svetoslavganov75986cf2009-05-14 22:28:01 -070057import android.util.SparseArray;
Jeff Brown33bbfd22011-02-24 20:55:35 -080058import android.util.TypedValue;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080059import android.view.ContextMenu.ContextMenuInfo;
svetoslavganov75986cf2009-05-14 22:28:01 -070060import android.view.accessibility.AccessibilityEvent;
61import android.view.accessibility.AccessibilityEventSource;
62import android.view.accessibility.AccessibilityManager;
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070063import android.view.accessibility.AccessibilityNodeInfo;
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
Doug Feltcb3791202011-07-07 11:57:48 -070071import com.android.internal.R;
72import com.android.internal.util.Predicate;
73import com.android.internal.view.menu.MenuBuilder;
74
Christopher Tatea0374192010-10-05 13:06:41 -070075import java.lang.ref.WeakReference;
svetoslavganov75986cf2009-05-14 22:28:01 -070076import java.lang.reflect.InvocationTargetException;
77import java.lang.reflect.Method;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080078import java.util.ArrayList;
79import java.util.Arrays;
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070080import java.util.Locale;
Romain Guyd90a3312009-05-06 14:54:28 -070081import java.util.WeakHashMap;
Adam Powell4afd62b2011-02-18 15:02:18 -080082import java.util.concurrent.CopyOnWriteArrayList;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080083
84/**
85 * <p>
86 * This class represents the basic building block for user interface components. A View
87 * occupies a rectangular area on the screen and is responsible for drawing and
88 * event handling. View is the base class for <em>widgets</em>, which are
Romain Guy8506ab42009-06-11 17:35:47 -070089 * used to create interactive UI components (buttons, text fields, etc.). The
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080090 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which
91 * are invisible containers that hold other Views (or other ViewGroups) and define
92 * their layout properties.
93 * </p>
94 *
95 * <div class="special">
Romain Guy8506ab42009-06-11 17:35:47 -070096 * <p>For an introduction to using this class to develop your
97 * application's user interface, read the Developer Guide documentation on
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080098 * <strong><a href="{@docRoot}guide/topics/ui/index.html">User Interface</a></strong>. Special topics
Romain Guy8506ab42009-06-11 17:35:47 -070099 * include:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800100 * <br/><a href="{@docRoot}guide/topics/ui/declaring-layout.html">Declaring Layout</a>
101 * <br/><a href="{@docRoot}guide/topics/ui/menus.html">Creating Menus</a>
102 * <br/><a href="{@docRoot}guide/topics/ui/layout-objects.html">Common Layout Objects</a>
103 * <br/><a href="{@docRoot}guide/topics/ui/binding.html">Binding to Data with AdapterView</a>
104 * <br/><a href="{@docRoot}guide/topics/ui/ui-events.html">Handling UI Events</a>
105 * <br/><a href="{@docRoot}guide/topics/ui/themes.html">Applying Styles and Themes</a>
106 * <br/><a href="{@docRoot}guide/topics/ui/custom-components.html">Building Custom Components</a>
107 * <br/><a href="{@docRoot}guide/topics/ui/how-android-draws.html">How Android Draws Views</a>.
108 * </p>
109 * </div>
Romain Guy8506ab42009-06-11 17:35:47 -0700110 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800111 * <a name="Using"></a>
112 * <h3>Using Views</h3>
113 * <p>
114 * All of the views in a window are arranged in a single tree. You can add views
115 * either from code or by specifying a tree of views in one or more XML layout
116 * files. There are many specialized subclasses of views that act as controls or
117 * are capable of displaying text, images, or other content.
118 * </p>
119 * <p>
120 * Once you have created a tree of views, there are typically a few types of
121 * common operations you may wish to perform:
122 * <ul>
123 * <li><strong>Set properties:</strong> for example setting the text of a
124 * {@link android.widget.TextView}. The available properties and the methods
125 * that set them will vary among the different subclasses of views. Note that
126 * properties that are known at build time can be set in the XML layout
127 * files.</li>
128 * <li><strong>Set focus:</strong> The framework will handled moving focus in
129 * response to user input. To force focus to a specific view, call
130 * {@link #requestFocus}.</li>
131 * <li><strong>Set up listeners:</strong> Views allow clients to set listeners
132 * that will be notified when something interesting happens to the view. For
133 * example, all views will let you set a listener to be notified when the view
134 * gains or loses focus. You can register such a listener using
Romain Guy5c22a8c2011-05-13 11:48:45 -0700135 * {@link #setOnFocusChangeListener(android.view.View.OnFocusChangeListener)}.
136 * Other view subclasses offer more specialized listeners. For example, a Button
137 * exposes a listener to notify clients when the button is clicked.</li>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800138 * <li><strong>Set visibility:</strong> You can hide or show views using
Romain Guy5c22a8c2011-05-13 11:48:45 -0700139 * {@link #setVisibility(int)}.</li>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800140 * </ul>
141 * </p>
142 * <p><em>
143 * Note: The Android framework is responsible for measuring, laying out and
144 * drawing views. You should not call methods that perform these actions on
145 * views yourself unless you are actually implementing a
146 * {@link android.view.ViewGroup}.
147 * </em></p>
148 *
149 * <a name="Lifecycle"></a>
150 * <h3>Implementing a Custom View</h3>
151 *
152 * <p>
153 * To implement a custom view, you will usually begin by providing overrides for
154 * some of the standard methods that the framework calls on all views. You do
155 * not need to override all of these methods. In fact, you can start by just
156 * overriding {@link #onDraw(android.graphics.Canvas)}.
157 * <table border="2" width="85%" align="center" cellpadding="5">
158 * <thead>
159 * <tr><th>Category</th> <th>Methods</th> <th>Description</th></tr>
160 * </thead>
161 *
162 * <tbody>
163 * <tr>
164 * <td rowspan="2">Creation</td>
165 * <td>Constructors</td>
166 * <td>There is a form of the constructor that are called when the view
167 * is created from code and a form that is called when the view is
168 * inflated from a layout file. The second form should parse and apply
169 * any attributes defined in the layout file.
170 * </td>
171 * </tr>
172 * <tr>
173 * <td><code>{@link #onFinishInflate()}</code></td>
174 * <td>Called after a view and all of its children has been inflated
175 * from XML.</td>
176 * </tr>
177 *
178 * <tr>
179 * <td rowspan="3">Layout</td>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700180 * <td><code>{@link #onMeasure(int, int)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800181 * <td>Called to determine the size requirements for this view and all
182 * of its children.
183 * </td>
184 * </tr>
185 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700186 * <td><code>{@link #onLayout(boolean, int, int, int, int)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800187 * <td>Called when this view should assign a size and position to all
188 * of its children.
189 * </td>
190 * </tr>
191 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700192 * <td><code>{@link #onSizeChanged(int, int, int, int)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800193 * <td>Called when the size of this view has changed.
194 * </td>
195 * </tr>
196 *
197 * <tr>
198 * <td>Drawing</td>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700199 * <td><code>{@link #onDraw(android.graphics.Canvas)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800200 * <td>Called when the view should render its content.
201 * </td>
202 * </tr>
203 *
204 * <tr>
205 * <td rowspan="4">Event processing</td>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700206 * <td><code>{@link #onKeyDown(int, KeyEvent)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800207 * <td>Called when a new key event occurs.
208 * </td>
209 * </tr>
210 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700211 * <td><code>{@link #onKeyUp(int, KeyEvent)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800212 * <td>Called when a key up event occurs.
213 * </td>
214 * </tr>
215 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700216 * <td><code>{@link #onTrackballEvent(MotionEvent)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800217 * <td>Called when a trackball motion event occurs.
218 * </td>
219 * </tr>
220 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700221 * <td><code>{@link #onTouchEvent(MotionEvent)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800222 * <td>Called when a touch screen motion event occurs.
223 * </td>
224 * </tr>
225 *
226 * <tr>
227 * <td rowspan="2">Focus</td>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700228 * <td><code>{@link #onFocusChanged(boolean, int, android.graphics.Rect)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800229 * <td>Called when the view gains or loses focus.
230 * </td>
231 * </tr>
232 *
233 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700234 * <td><code>{@link #onWindowFocusChanged(boolean)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800235 * <td>Called when the window containing the view gains or loses focus.
236 * </td>
237 * </tr>
238 *
239 * <tr>
240 * <td rowspan="3">Attaching</td>
241 * <td><code>{@link #onAttachedToWindow()}</code></td>
242 * <td>Called when the view is attached to a window.
243 * </td>
244 * </tr>
245 *
246 * <tr>
247 * <td><code>{@link #onDetachedFromWindow}</code></td>
248 * <td>Called when the view is detached from its window.
249 * </td>
250 * </tr>
251 *
252 * <tr>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700253 * <td><code>{@link #onWindowVisibilityChanged(int)}</code></td>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800254 * <td>Called when the visibility of the window containing the view
255 * has changed.
256 * </td>
257 * </tr>
258 * </tbody>
259 *
260 * </table>
261 * </p>
262 *
263 * <a name="IDs"></a>
264 * <h3>IDs</h3>
265 * Views may have an integer id associated with them. These ids are typically
266 * assigned in the layout XML files, and are used to find specific views within
267 * the view tree. A common pattern is to:
268 * <ul>
269 * <li>Define a Button in the layout file and assign it a unique ID.
270 * <pre>
Gilles Debunne0243caf2010-08-24 23:06:35 -0700271 * &lt;Button
272 * android:id="@+id/my_button"
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800273 * android:layout_width="wrap_content"
274 * android:layout_height="wrap_content"
275 * android:text="@string/my_button_text"/&gt;
276 * </pre></li>
277 * <li>From the onCreate method of an Activity, find the Button
278 * <pre class="prettyprint">
279 * Button myButton = (Button) findViewById(R.id.my_button);
280 * </pre></li>
281 * </ul>
282 * <p>
283 * View IDs need not be unique throughout the tree, but it is good practice to
284 * ensure that they are at least unique within the part of the tree you are
285 * searching.
286 * </p>
287 *
288 * <a name="Position"></a>
289 * <h3>Position</h3>
290 * <p>
291 * The geometry of a view is that of a rectangle. A view has a location,
292 * expressed as a pair of <em>left</em> and <em>top</em> coordinates, and
293 * two dimensions, expressed as a width and a height. The unit for location
294 * and dimensions is the pixel.
295 * </p>
296 *
297 * <p>
298 * It is possible to retrieve the location of a view by invoking the methods
299 * {@link #getLeft()} and {@link #getTop()}. The former returns the left, or X,
300 * coordinate of the rectangle representing the view. The latter returns the
301 * top, or Y, coordinate of the rectangle representing the view. These methods
302 * both return the location of the view relative to its parent. For instance,
303 * when getLeft() returns 20, that means the view is located 20 pixels to the
304 * right of the left edge of its direct parent.
305 * </p>
306 *
307 * <p>
308 * In addition, several convenience methods are offered to avoid unnecessary
309 * computations, namely {@link #getRight()} and {@link #getBottom()}.
310 * These methods return the coordinates of the right and bottom edges of the
311 * rectangle representing the view. For instance, calling {@link #getRight()}
312 * is similar to the following computation: <code>getLeft() + getWidth()</code>
313 * (see <a href="#SizePaddingMargins">Size</a> for more information about the width.)
314 * </p>
315 *
316 * <a name="SizePaddingMargins"></a>
317 * <h3>Size, padding and margins</h3>
318 * <p>
319 * The size of a view is expressed with a width and a height. A view actually
320 * possess two pairs of width and height values.
321 * </p>
322 *
323 * <p>
324 * The first pair is known as <em>measured width</em> and
325 * <em>measured height</em>. These dimensions define how big a view wants to be
326 * within its parent (see <a href="#Layout">Layout</a> for more details.) The
327 * measured dimensions can be obtained by calling {@link #getMeasuredWidth()}
328 * and {@link #getMeasuredHeight()}.
329 * </p>
330 *
331 * <p>
332 * The second pair is simply known as <em>width</em> and <em>height</em>, or
333 * sometimes <em>drawing width</em> and <em>drawing height</em>. These
334 * dimensions define the actual size of the view on screen, at drawing time and
335 * after layout. These values may, but do not have to, be different from the
336 * measured width and height. The width and height can be obtained by calling
337 * {@link #getWidth()} and {@link #getHeight()}.
338 * </p>
339 *
340 * <p>
341 * To measure its dimensions, a view takes into account its padding. The padding
342 * is expressed in pixels for the left, top, right and bottom parts of the view.
343 * Padding can be used to offset the content of the view by a specific amount of
344 * pixels. For instance, a left padding of 2 will push the view's content by
345 * 2 pixels to the right of the left edge. Padding can be set using the
346 * {@link #setPadding(int, int, int, int)} method and queried by calling
347 * {@link #getPaddingLeft()}, {@link #getPaddingTop()},
Fabrice Di Megliod8703a92011-06-16 18:54:08 -0700348 * {@link #getPaddingRight()}, {@link #getPaddingBottom()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800349 * </p>
350 *
351 * <p>
352 * Even though a view can define a padding, it does not provide any support for
353 * margins. However, view groups provide such a support. Refer to
354 * {@link android.view.ViewGroup} and
355 * {@link android.view.ViewGroup.MarginLayoutParams} for further information.
356 * </p>
357 *
358 * <a name="Layout"></a>
359 * <h3>Layout</h3>
360 * <p>
361 * Layout is a two pass process: a measure pass and a layout pass. The measuring
362 * pass is implemented in {@link #measure(int, int)} and is a top-down traversal
363 * of the view tree. Each view pushes dimension specifications down the tree
364 * during the recursion. At the end of the measure pass, every view has stored
365 * its measurements. The second pass happens in
366 * {@link #layout(int,int,int,int)} and is also top-down. During
367 * this pass each parent is responsible for positioning all of its children
368 * using the sizes computed in the measure pass.
369 * </p>
370 *
371 * <p>
372 * When a view's measure() method returns, its {@link #getMeasuredWidth()} and
373 * {@link #getMeasuredHeight()} values must be set, along with those for all of
374 * that view's descendants. A view's measured width and measured height values
375 * must respect the constraints imposed by the view's parents. This guarantees
376 * that at the end of the measure pass, all parents accept all of their
377 * children's measurements. A parent view may call measure() more than once on
378 * its children. For example, the parent may measure each child once with
379 * unspecified dimensions to find out how big they want to be, then call
380 * measure() on them again with actual numbers if the sum of all the children's
381 * unconstrained sizes is too big or too small.
382 * </p>
383 *
384 * <p>
385 * The measure pass uses two classes to communicate dimensions. The
386 * {@link MeasureSpec} class is used by views to tell their parents how they
387 * want to be measured and positioned. The base LayoutParams class just
388 * describes how big the view wants to be for both width and height. For each
389 * dimension, it can specify one of:
390 * <ul>
391 * <li> an exact number
Romain Guy980a9382010-01-08 15:06:28 -0800392 * <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 -0800393 * (minus padding)
394 * <li> WRAP_CONTENT, which means that the view wants to be just big enough to
395 * enclose its content (plus padding).
396 * </ul>
397 * There are subclasses of LayoutParams for different subclasses of ViewGroup.
398 * For example, AbsoluteLayout has its own subclass of LayoutParams which adds
399 * an X and Y value.
400 * </p>
401 *
402 * <p>
403 * MeasureSpecs are used to push requirements down the tree from parent to
404 * child. A MeasureSpec can be in one of three modes:
405 * <ul>
406 * <li>UNSPECIFIED: This is used by a parent to determine the desired dimension
407 * of a child view. For example, a LinearLayout may call measure() on its child
408 * with the height set to UNSPECIFIED and a width of EXACTLY 240 to find out how
409 * tall the child view wants to be given a width of 240 pixels.
410 * <li>EXACTLY: This is used by the parent to impose an exact size on the
411 * child. The child must use this size, and guarantee that all of its
412 * descendants will fit within this size.
413 * <li>AT_MOST: This is used by the parent to impose a maximum size on the
414 * child. The child must gurantee that it and all of its descendants will fit
415 * within this size.
416 * </ul>
417 * </p>
418 *
419 * <p>
420 * To intiate a layout, call {@link #requestLayout}. This method is typically
421 * called by a view on itself when it believes that is can no longer fit within
422 * its current bounds.
423 * </p>
424 *
425 * <a name="Drawing"></a>
426 * <h3>Drawing</h3>
427 * <p>
428 * Drawing is handled by walking the tree and rendering each view that
429 * intersects the the invalid region. Because the tree is traversed in-order,
430 * this means that parents will draw before (i.e., behind) their children, with
431 * siblings drawn in the order they appear in the tree.
432 * If you set a background drawable for a View, then the View will draw it for you
433 * before calling back to its <code>onDraw()</code> method.
434 * </p>
435 *
436 * <p>
Romain Guy8506ab42009-06-11 17:35:47 -0700437 * 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 -0800438 * </p>
439 *
440 * <p>
441 * To force a view to draw, call {@link #invalidate()}.
442 * </p>
443 *
444 * <a name="EventHandlingThreading"></a>
445 * <h3>Event Handling and Threading</h3>
446 * <p>
447 * The basic cycle of a view is as follows:
448 * <ol>
449 * <li>An event comes in and is dispatched to the appropriate view. The view
450 * handles the event and notifies any listeners.</li>
451 * <li>If in the course of processing the event, the view's bounds may need
452 * to be changed, the view will call {@link #requestLayout()}.</li>
453 * <li>Similarly, if in the course of processing the event the view's appearance
454 * may need to be changed, the view will call {@link #invalidate()}.</li>
455 * <li>If either {@link #requestLayout()} or {@link #invalidate()} were called,
456 * the framework will take care of measuring, laying out, and drawing the tree
457 * as appropriate.</li>
458 * </ol>
459 * </p>
460 *
461 * <p><em>Note: The entire view tree is single threaded. You must always be on
462 * the UI thread when calling any method on any view.</em>
463 * If you are doing work on other threads and want to update the state of a view
464 * from that thread, you should use a {@link Handler}.
465 * </p>
466 *
467 * <a name="FocusHandling"></a>
468 * <h3>Focus Handling</h3>
469 * <p>
470 * The framework will handle routine focus movement in response to user input.
471 * This includes changing the focus as views are removed or hidden, or as new
472 * views become available. Views indicate their willingness to take focus
473 * through the {@link #isFocusable} method. To change whether a view can take
474 * focus, call {@link #setFocusable(boolean)}. When in touch mode (see notes below)
475 * views indicate whether they still would like focus via {@link #isFocusableInTouchMode}
476 * and can change this via {@link #setFocusableInTouchMode(boolean)}.
477 * </p>
478 * <p>
479 * Focus movement is based on an algorithm which finds the nearest neighbor in a
480 * given direction. In rare cases, the default algorithm may not match the
481 * intended behavior of the developer. In these situations, you can provide
482 * explicit overrides by using these XML attributes in the layout file:
483 * <pre>
484 * nextFocusDown
485 * nextFocusLeft
486 * nextFocusRight
487 * nextFocusUp
488 * </pre>
489 * </p>
490 *
491 *
492 * <p>
493 * To get a particular view to take focus, call {@link #requestFocus()}.
494 * </p>
495 *
496 * <a name="TouchMode"></a>
497 * <h3>Touch Mode</h3>
498 * <p>
499 * When a user is navigating a user interface via directional keys such as a D-pad, it is
500 * necessary to give focus to actionable items such as buttons so the user can see
501 * what will take input. If the device has touch capabilities, however, and the user
502 * begins interacting with the interface by touching it, it is no longer necessary to
503 * always highlight, or give focus to, a particular view. This motivates a mode
504 * for interaction named 'touch mode'.
505 * </p>
506 * <p>
507 * For a touch capable device, once the user touches the screen, the device
508 * will enter touch mode. From this point onward, only views for which
509 * {@link #isFocusableInTouchMode} is true will be focusable, such as text editing widgets.
510 * Other views that are touchable, like buttons, will not take focus when touched; they will
511 * only fire the on click listeners.
512 * </p>
513 * <p>
514 * Any time a user hits a directional key, such as a D-pad direction, the view device will
515 * exit touch mode, and find a view to take focus, so that the user may resume interacting
516 * with the user interface without touching the screen again.
517 * </p>
518 * <p>
519 * The touch mode state is maintained across {@link android.app.Activity}s. Call
520 * {@link #isInTouchMode} to see whether the device is currently in touch mode.
521 * </p>
522 *
523 * <a name="Scrolling"></a>
524 * <h3>Scrolling</h3>
525 * <p>
526 * The framework provides basic support for views that wish to internally
527 * scroll their content. This includes keeping track of the X and Y scroll
528 * offset as well as mechanisms for drawing scrollbars. See
Joe Malin32736f02011-01-19 16:14:20 -0800529 * {@link #scrollBy(int, int)}, {@link #scrollTo(int, int)}, and
Mike Cleronf116bf82009-09-27 19:14:12 -0700530 * {@link #awakenScrollBars()} for more details.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800531 * </p>
532 *
533 * <a name="Tags"></a>
534 * <h3>Tags</h3>
535 * <p>
536 * Unlike IDs, tags are not used to identify views. Tags are essentially an
537 * extra piece of information that can be associated with a view. They are most
538 * often used as a convenience to store data related to views in the views
539 * themselves rather than by putting them in a separate structure.
540 * </p>
541 *
542 * <a name="Animation"></a>
543 * <h3>Animation</h3>
544 * <p>
545 * You can attach an {@link Animation} object to a view using
546 * {@link #setAnimation(Animation)} or
547 * {@link #startAnimation(Animation)}. The animation can alter the scale,
548 * rotation, translation and alpha of a view over time. If the animation is
549 * attached to a view that has children, the animation will affect the entire
550 * subtree rooted by that node. When an animation is started, the framework will
551 * take care of redrawing the appropriate views until the animation completes.
552 * </p>
Romain Guy171c5922011-01-06 10:04:23 -0800553 * <p>
554 * Starting with Android 3.0, the preferred way of animating views is to use the
555 * {@link android.animation} package APIs.
556 * </p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800557 *
Jeff Brown85a31762010-09-01 17:01:00 -0700558 * <a name="Security"></a>
559 * <h3>Security</h3>
560 * <p>
561 * Sometimes it is essential that an application be able to verify that an action
562 * is being performed with the full knowledge and consent of the user, such as
563 * granting a permission request, making a purchase or clicking on an advertisement.
564 * Unfortunately, a malicious application could try to spoof the user into
565 * performing these actions, unaware, by concealing the intended purpose of the view.
566 * As a remedy, the framework offers a touch filtering mechanism that can be used to
567 * improve the security of views that provide access to sensitive functionality.
568 * </p><p>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700569 * To enable touch filtering, call {@link #setFilterTouchesWhenObscured(boolean)} or set the
Jeff Brown49ed71d2010-12-06 17:13:33 -0800570 * android:filterTouchesWhenObscured layout attribute to true. When enabled, the framework
Jeff Brown85a31762010-09-01 17:01:00 -0700571 * will discard touches that are received whenever the view's window is obscured by
572 * another visible window. As a result, the view will not receive touches whenever a
573 * toast, dialog or other window appears above the view's window.
574 * </p><p>
575 * For more fine-grained control over security, consider overriding the
Romain Guy5c22a8c2011-05-13 11:48:45 -0700576 * {@link #onFilterTouchEventForSecurity(MotionEvent)} method to implement your own
577 * security policy. See also {@link MotionEvent#FLAG_WINDOW_IS_OBSCURED}.
Jeff Brown85a31762010-09-01 17:01:00 -0700578 * </p>
579 *
Romain Guy171c5922011-01-06 10:04:23 -0800580 * @attr ref android.R.styleable#View_alpha
Romain Guyd6a463a2009-05-21 23:10:10 -0700581 * @attr ref android.R.styleable#View_background
582 * @attr ref android.R.styleable#View_clickable
583 * @attr ref android.R.styleable#View_contentDescription
584 * @attr ref android.R.styleable#View_drawingCacheQuality
585 * @attr ref android.R.styleable#View_duplicateParentState
586 * @attr ref android.R.styleable#View_id
587 * @attr ref android.R.styleable#View_fadingEdge
588 * @attr ref android.R.styleable#View_fadingEdgeLength
Jeff Brown85a31762010-09-01 17:01:00 -0700589 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800590 * @attr ref android.R.styleable#View_fitsSystemWindows
Romain Guyd6a463a2009-05-21 23:10:10 -0700591 * @attr ref android.R.styleable#View_isScrollContainer
592 * @attr ref android.R.styleable#View_focusable
593 * @attr ref android.R.styleable#View_focusableInTouchMode
594 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
595 * @attr ref android.R.styleable#View_keepScreenOn
Romain Guy171c5922011-01-06 10:04:23 -0800596 * @attr ref android.R.styleable#View_layerType
Romain Guyd6a463a2009-05-21 23:10:10 -0700597 * @attr ref android.R.styleable#View_longClickable
598 * @attr ref android.R.styleable#View_minHeight
599 * @attr ref android.R.styleable#View_minWidth
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800600 * @attr ref android.R.styleable#View_nextFocusDown
601 * @attr ref android.R.styleable#View_nextFocusLeft
602 * @attr ref android.R.styleable#View_nextFocusRight
603 * @attr ref android.R.styleable#View_nextFocusUp
Romain Guyd6a463a2009-05-21 23:10:10 -0700604 * @attr ref android.R.styleable#View_onClick
605 * @attr ref android.R.styleable#View_padding
606 * @attr ref android.R.styleable#View_paddingBottom
607 * @attr ref android.R.styleable#View_paddingLeft
608 * @attr ref android.R.styleable#View_paddingRight
609 * @attr ref android.R.styleable#View_paddingTop
610 * @attr ref android.R.styleable#View_saveEnabled
Chet Haase73066682010-11-29 15:55:32 -0800611 * @attr ref android.R.styleable#View_rotation
612 * @attr ref android.R.styleable#View_rotationX
613 * @attr ref android.R.styleable#View_rotationY
614 * @attr ref android.R.styleable#View_scaleX
615 * @attr ref android.R.styleable#View_scaleY
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800616 * @attr ref android.R.styleable#View_scrollX
617 * @attr ref android.R.styleable#View_scrollY
Romain Guyd6a463a2009-05-21 23:10:10 -0700618 * @attr ref android.R.styleable#View_scrollbarSize
619 * @attr ref android.R.styleable#View_scrollbarStyle
620 * @attr ref android.R.styleable#View_scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -0700621 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
622 * @attr ref android.R.styleable#View_scrollbarFadeDuration
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800623 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal
624 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800625 * @attr ref android.R.styleable#View_scrollbarThumbVertical
626 * @attr ref android.R.styleable#View_scrollbarTrackVertical
627 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack
628 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack
Romain Guyd6a463a2009-05-21 23:10:10 -0700629 * @attr ref android.R.styleable#View_soundEffectsEnabled
630 * @attr ref android.R.styleable#View_tag
Chet Haase73066682010-11-29 15:55:32 -0800631 * @attr ref android.R.styleable#View_transformPivotX
632 * @attr ref android.R.styleable#View_transformPivotY
633 * @attr ref android.R.styleable#View_translationX
634 * @attr ref android.R.styleable#View_translationY
Romain Guyd6a463a2009-05-21 23:10:10 -0700635 * @attr ref android.R.styleable#View_visibility
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800636 *
637 * @see android.view.ViewGroup
638 */
Fabrice Di Meglio6a036402011-05-23 14:43:23 -0700639public class View implements Drawable.Callback2, KeyEvent.Callback, AccessibilityEventSource {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800640 private static final boolean DBG = false;
641
642 /**
643 * The logging tag used by this class with android.util.Log.
644 */
645 protected static final String VIEW_LOG_TAG = "View";
646
647 /**
648 * Used to mark a View that has no ID.
649 */
650 public static final int NO_ID = -1;
651
652 /**
653 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when
654 * calling setFlags.
655 */
656 private static final int NOT_FOCUSABLE = 0x00000000;
657
658 /**
659 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling
660 * setFlags.
661 */
662 private static final int FOCUSABLE = 0x00000001;
663
664 /**
665 * Mask for use with setFlags indicating bits used for focus.
666 */
667 private static final int FOCUSABLE_MASK = 0x00000001;
668
669 /**
670 * This view will adjust its padding to fit sytem windows (e.g. status bar)
671 */
672 private static final int FITS_SYSTEM_WINDOWS = 0x00000002;
673
674 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -0700675 * This view is visible. Use with {@link #setVisibility(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800676 */
677 public static final int VISIBLE = 0x00000000;
678
679 /**
680 * This view is invisible, but it still takes up space for layout purposes.
Romain Guy5c22a8c2011-05-13 11:48:45 -0700681 * Use with {@link #setVisibility(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800682 */
683 public static final int INVISIBLE = 0x00000004;
684
685 /**
686 * This view is invisible, and it doesn't take any space for layout
Romain Guy5c22a8c2011-05-13 11:48:45 -0700687 * purposes. Use with {@link #setVisibility(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800688 */
689 public static final int GONE = 0x00000008;
690
691 /**
692 * Mask for use with setFlags indicating bits used for visibility.
693 * {@hide}
694 */
695 static final int VISIBILITY_MASK = 0x0000000C;
696
697 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE};
698
699 /**
700 * This view is enabled. Intrepretation varies by subclass.
701 * Use with ENABLED_MASK when calling setFlags.
702 * {@hide}
703 */
704 static final int ENABLED = 0x00000000;
705
706 /**
707 * This view is disabled. Intrepretation varies by subclass.
708 * Use with ENABLED_MASK when calling setFlags.
709 * {@hide}
710 */
711 static final int DISABLED = 0x00000020;
712
713 /**
714 * Mask for use with setFlags indicating bits used for indicating whether
715 * this view is enabled
716 * {@hide}
717 */
718 static final int ENABLED_MASK = 0x00000020;
719
720 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -0700721 * This view won't draw. {@link #onDraw(android.graphics.Canvas)} won't be
722 * called and further optimizations will be performed. It is okay to have
723 * this flag set and a background. Use with DRAW_MASK when calling setFlags.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800724 * {@hide}
725 */
726 static final int WILL_NOT_DRAW = 0x00000080;
727
728 /**
729 * Mask for use with setFlags indicating bits used for indicating whether
730 * this view is will draw
731 * {@hide}
732 */
733 static final int DRAW_MASK = 0x00000080;
734
735 /**
736 * <p>This view doesn't show scrollbars.</p>
737 * {@hide}
738 */
739 static final int SCROLLBARS_NONE = 0x00000000;
740
741 /**
742 * <p>This view shows horizontal scrollbars.</p>
743 * {@hide}
744 */
745 static final int SCROLLBARS_HORIZONTAL = 0x00000100;
746
747 /**
748 * <p>This view shows vertical scrollbars.</p>
749 * {@hide}
750 */
751 static final int SCROLLBARS_VERTICAL = 0x00000200;
752
753 /**
754 * <p>Mask for use with setFlags indicating bits used for indicating which
755 * scrollbars are enabled.</p>
756 * {@hide}
757 */
758 static final int SCROLLBARS_MASK = 0x00000300;
759
Jeff Brown85a31762010-09-01 17:01:00 -0700760 /**
761 * Indicates that the view should filter touches when its window is obscured.
762 * Refer to the class comments for more information about this security feature.
763 * {@hide}
764 */
765 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400;
766
767 // note flag value 0x00000800 is now available for next flags...
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800768
769 /**
770 * <p>This view doesn't show fading edges.</p>
771 * {@hide}
772 */
773 static final int FADING_EDGE_NONE = 0x00000000;
774
775 /**
776 * <p>This view shows horizontal fading edges.</p>
777 * {@hide}
778 */
779 static final int FADING_EDGE_HORIZONTAL = 0x00001000;
780
781 /**
782 * <p>This view shows vertical fading edges.</p>
783 * {@hide}
784 */
785 static final int FADING_EDGE_VERTICAL = 0x00002000;
786
787 /**
788 * <p>Mask for use with setFlags indicating bits used for indicating which
789 * fading edges are enabled.</p>
790 * {@hide}
791 */
792 static final int FADING_EDGE_MASK = 0x00003000;
793
794 /**
795 * <p>Indicates this view can be clicked. When clickable, a View reacts
796 * to clicks by notifying the OnClickListener.<p>
797 * {@hide}
798 */
799 static final int CLICKABLE = 0x00004000;
800
801 /**
802 * <p>Indicates this view is caching its drawing into a bitmap.</p>
803 * {@hide}
804 */
805 static final int DRAWING_CACHE_ENABLED = 0x00008000;
806
807 /**
808 * <p>Indicates that no icicle should be saved for this view.<p>
809 * {@hide}
810 */
811 static final int SAVE_DISABLED = 0x000010000;
812
813 /**
814 * <p>Mask for use with setFlags indicating bits used for the saveEnabled
815 * property.</p>
816 * {@hide}
817 */
818 static final int SAVE_DISABLED_MASK = 0x000010000;
819
820 /**
821 * <p>Indicates that no drawing cache should ever be created for this view.<p>
822 * {@hide}
823 */
824 static final int WILL_NOT_CACHE_DRAWING = 0x000020000;
825
826 /**
827 * <p>Indicates this view can take / keep focus when int touch mode.</p>
828 * {@hide}
829 */
830 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000;
831
832 /**
833 * <p>Enables low quality mode for the drawing cache.</p>
834 */
835 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000;
836
837 /**
838 * <p>Enables high quality mode for the drawing cache.</p>
839 */
840 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000;
841
842 /**
843 * <p>Enables automatic quality mode for the drawing cache.</p>
844 */
845 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000;
846
847 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = {
848 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH
849 };
850
851 /**
852 * <p>Mask for use with setFlags indicating bits used for the cache
853 * quality property.</p>
854 * {@hide}
855 */
856 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000;
857
858 /**
859 * <p>
860 * Indicates this view can be long clicked. When long clickable, a View
861 * reacts to long clicks by notifying the OnLongClickListener or showing a
862 * context menu.
863 * </p>
864 * {@hide}
865 */
866 static final int LONG_CLICKABLE = 0x00200000;
867
868 /**
869 * <p>Indicates that this view gets its drawable states from its direct parent
870 * and ignores its original internal states.</p>
871 *
872 * @hide
873 */
874 static final int DUPLICATE_PARENT_STATE = 0x00400000;
875
876 /**
877 * The scrollbar style to display the scrollbars inside the content area,
878 * without increasing the padding. The scrollbars will be overlaid with
879 * translucency on the view's content.
880 */
881 public static final int SCROLLBARS_INSIDE_OVERLAY = 0;
882
883 /**
884 * The scrollbar style to display the scrollbars inside the padded area,
885 * increasing the padding of the view. The scrollbars will not overlap the
886 * content area of the view.
887 */
888 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000;
889
890 /**
891 * The scrollbar style to display the scrollbars at the edge of the view,
892 * without increasing the padding. The scrollbars will be overlaid with
893 * translucency.
894 */
895 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000;
896
897 /**
898 * The scrollbar style to display the scrollbars at the edge of the view,
899 * increasing the padding of the view. The scrollbars will only overlap the
900 * background, if any.
901 */
902 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000;
903
904 /**
905 * Mask to check if the scrollbar style is overlay or inset.
906 * {@hide}
907 */
908 static final int SCROLLBARS_INSET_MASK = 0x01000000;
909
910 /**
911 * Mask to check if the scrollbar style is inside or outside.
912 * {@hide}
913 */
914 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000;
915
916 /**
917 * Mask for scrollbar style.
918 * {@hide}
919 */
920 static final int SCROLLBARS_STYLE_MASK = 0x03000000;
921
922 /**
923 * View flag indicating that the screen should remain on while the
924 * window containing this view is visible to the user. This effectively
925 * takes care of automatically setting the WindowManager's
926 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}.
927 */
928 public static final int KEEP_SCREEN_ON = 0x04000000;
929
930 /**
931 * View flag indicating whether this view should have sound effects enabled
932 * for events such as clicking and touching.
933 */
934 public static final int SOUND_EFFECTS_ENABLED = 0x08000000;
935
936 /**
937 * View flag indicating whether this view should have haptic feedback
938 * enabled for events such as long presses.
939 */
940 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000;
941
942 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700943 * <p>Indicates that the view hierarchy should stop saving state when
944 * it reaches this view. If state saving is initiated immediately at
945 * the view, it will be allowed.
946 * {@hide}
947 */
948 static final int PARENT_SAVE_DISABLED = 0x20000000;
949
950 /**
951 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p>
952 * {@hide}
953 */
954 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000;
955
956 /**
Cibu Johny7632cb92010-02-22 13:01:02 -0800957 * Horizontal direction of this view is from Left to Right.
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700958 * Use with {@link #setLayoutDirection}.
Cibu Johny7632cb92010-02-22 13:01:02 -0800959 * {@hide}
960 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700961 public static final int LAYOUT_DIRECTION_LTR = 0x00000000;
Cibu Johny7632cb92010-02-22 13:01:02 -0800962
963 /**
964 * Horizontal direction of this view is from Right to Left.
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700965 * Use with {@link #setLayoutDirection}.
Cibu Johny7632cb92010-02-22 13:01:02 -0800966 * {@hide}
967 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700968 public static final int LAYOUT_DIRECTION_RTL = 0x40000000;
Cibu Johny7632cb92010-02-22 13:01:02 -0800969
970 /**
971 * Horizontal direction of this view is inherited from its parent.
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700972 * Use with {@link #setLayoutDirection}.
Cibu Johny7632cb92010-02-22 13:01:02 -0800973 * {@hide}
974 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700975 public static final int LAYOUT_DIRECTION_INHERIT = 0x80000000;
Cibu Johny7632cb92010-02-22 13:01:02 -0800976
977 /**
978 * Horizontal direction of this view is from deduced from the default language
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700979 * script for the locale. Use with {@link #setLayoutDirection}.
Cibu Johny7632cb92010-02-22 13:01:02 -0800980 * {@hide}
981 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700982 public static final int LAYOUT_DIRECTION_LOCALE = 0xC0000000;
Cibu Johny7632cb92010-02-22 13:01:02 -0800983
984 /**
985 * Mask for use with setFlags indicating bits used for horizontalDirection.
986 * {@hide}
987 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700988 static final int LAYOUT_DIRECTION_MASK = 0xC0000000;
Cibu Johny7632cb92010-02-22 13:01:02 -0800989
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -0700990 /*
991 * Array of horizontal direction flags for mapping attribute "horizontalDirection" to correct
992 * flag value.
993 * {@hide}
994 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700995 private static final int[] LAYOUT_DIRECTION_FLAGS = {LAYOUT_DIRECTION_LTR,
996 LAYOUT_DIRECTION_RTL, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE};
Cibu Johny7632cb92010-02-22 13:01:02 -0800997
998 /**
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -0700999 * Default horizontalDirection.
1000 * {@hide}
1001 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07001002 private static final int LAYOUT_DIRECTION_DEFAULT = LAYOUT_DIRECTION_INHERIT;
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07001003
1004 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07001005 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
1006 * should add all focusable Views regardless if they are focusable in touch mode.
1007 */
1008 public static final int FOCUSABLES_ALL = 0x00000000;
1009
1010 /**
1011 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
1012 * should add only Views focusable in touch mode.
1013 */
1014 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001;
1015
1016 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001017 * Use with {@link #focusSearch(int)}. Move focus to the previous selectable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001018 * item.
1019 */
1020 public static final int FOCUS_BACKWARD = 0x00000001;
1021
1022 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001023 * Use with {@link #focusSearch(int)}. Move focus to the next selectable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001024 * item.
1025 */
1026 public static final int FOCUS_FORWARD = 0x00000002;
1027
1028 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001029 * Use with {@link #focusSearch(int)}. Move focus to the left.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001030 */
1031 public static final int FOCUS_LEFT = 0x00000011;
1032
1033 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001034 * Use with {@link #focusSearch(int)}. Move focus up.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001035 */
1036 public static final int FOCUS_UP = 0x00000021;
1037
1038 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001039 * Use with {@link #focusSearch(int)}. Move focus to the right.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001040 */
1041 public static final int FOCUS_RIGHT = 0x00000042;
1042
1043 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001044 * Use with {@link #focusSearch(int)}. Move focus down.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001045 */
1046 public static final int FOCUS_DOWN = 0x00000082;
1047
1048 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08001049 * Bits of {@link #getMeasuredWidthAndState()} and
1050 * {@link #getMeasuredWidthAndState()} that provide the actual measured size.
1051 */
1052 public static final int MEASURED_SIZE_MASK = 0x00ffffff;
1053
1054 /**
1055 * Bits of {@link #getMeasuredWidthAndState()} and
1056 * {@link #getMeasuredWidthAndState()} that provide the additional state bits.
1057 */
1058 public static final int MEASURED_STATE_MASK = 0xff000000;
1059
1060 /**
1061 * Bit shift of {@link #MEASURED_STATE_MASK} to get to the height bits
1062 * for functions that combine both width and height into a single int,
1063 * such as {@link #getMeasuredState()} and the childState argument of
1064 * {@link #resolveSizeAndState(int, int, int)}.
1065 */
1066 public static final int MEASURED_HEIGHT_STATE_SHIFT = 16;
1067
1068 /**
1069 * Bit of {@link #getMeasuredWidthAndState()} and
1070 * {@link #getMeasuredWidthAndState()} that indicates the measured size
1071 * is smaller that the space the view would like to have.
1072 */
1073 public static final int MEASURED_STATE_TOO_SMALL = 0x01000000;
1074
1075 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001076 * Base View state sets
1077 */
1078 // Singles
1079 /**
1080 * Indicates the view has no states set. States are used with
1081 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1082 * view depending on its state.
1083 *
1084 * @see android.graphics.drawable.Drawable
1085 * @see #getDrawableState()
1086 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001087 protected static final int[] EMPTY_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001088 /**
1089 * Indicates the view is enabled. States are used with
1090 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1091 * view depending on its state.
1092 *
1093 * @see android.graphics.drawable.Drawable
1094 * @see #getDrawableState()
1095 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001096 protected static final int[] ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001097 /**
1098 * Indicates the view is focused. States are used with
1099 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1100 * view depending on its state.
1101 *
1102 * @see android.graphics.drawable.Drawable
1103 * @see #getDrawableState()
1104 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001105 protected static final int[] FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001106 /**
1107 * Indicates the view is selected. States are used with
1108 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1109 * view depending on its state.
1110 *
1111 * @see android.graphics.drawable.Drawable
1112 * @see #getDrawableState()
1113 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001114 protected static final int[] SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001115 /**
1116 * Indicates the view is pressed. States are used with
1117 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1118 * view depending on its state.
1119 *
1120 * @see android.graphics.drawable.Drawable
1121 * @see #getDrawableState()
1122 * @hide
1123 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001124 protected static final int[] PRESSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001125 /**
1126 * Indicates the view's window has focus. States are used with
1127 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1128 * view depending on its state.
1129 *
1130 * @see android.graphics.drawable.Drawable
1131 * @see #getDrawableState()
1132 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001133 protected static final int[] WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001134 // Doubles
1135 /**
1136 * Indicates the view is enabled and has the focus.
1137 *
1138 * @see #ENABLED_STATE_SET
1139 * @see #FOCUSED_STATE_SET
1140 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001141 protected static final int[] ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001142 /**
1143 * Indicates the view is enabled and selected.
1144 *
1145 * @see #ENABLED_STATE_SET
1146 * @see #SELECTED_STATE_SET
1147 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001148 protected static final int[] ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001149 /**
1150 * Indicates the view is enabled and that its window has focus.
1151 *
1152 * @see #ENABLED_STATE_SET
1153 * @see #WINDOW_FOCUSED_STATE_SET
1154 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001155 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001156 /**
1157 * Indicates the view is focused and selected.
1158 *
1159 * @see #FOCUSED_STATE_SET
1160 * @see #SELECTED_STATE_SET
1161 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001162 protected static final int[] FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001163 /**
1164 * Indicates the view has the focus and that its window has the focus.
1165 *
1166 * @see #FOCUSED_STATE_SET
1167 * @see #WINDOW_FOCUSED_STATE_SET
1168 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001169 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001170 /**
1171 * Indicates the view is selected and that its window has the focus.
1172 *
1173 * @see #SELECTED_STATE_SET
1174 * @see #WINDOW_FOCUSED_STATE_SET
1175 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001176 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001177 // Triples
1178 /**
1179 * Indicates the view is enabled, focused and selected.
1180 *
1181 * @see #ENABLED_STATE_SET
1182 * @see #FOCUSED_STATE_SET
1183 * @see #SELECTED_STATE_SET
1184 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001185 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001186 /**
1187 * Indicates the view is enabled, focused and its window has the focus.
1188 *
1189 * @see #ENABLED_STATE_SET
1190 * @see #FOCUSED_STATE_SET
1191 * @see #WINDOW_FOCUSED_STATE_SET
1192 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001193 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001194 /**
1195 * Indicates the view is enabled, selected and its window has the focus.
1196 *
1197 * @see #ENABLED_STATE_SET
1198 * @see #SELECTED_STATE_SET
1199 * @see #WINDOW_FOCUSED_STATE_SET
1200 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001201 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001202 /**
1203 * Indicates the view is focused, selected and its window has the focus.
1204 *
1205 * @see #FOCUSED_STATE_SET
1206 * @see #SELECTED_STATE_SET
1207 * @see #WINDOW_FOCUSED_STATE_SET
1208 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001209 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001210 /**
1211 * Indicates the view is enabled, focused, selected and its window
1212 * has the focus.
1213 *
1214 * @see #ENABLED_STATE_SET
1215 * @see #FOCUSED_STATE_SET
1216 * @see #SELECTED_STATE_SET
1217 * @see #WINDOW_FOCUSED_STATE_SET
1218 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001219 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001220 /**
1221 * Indicates the view is pressed and its window has the focus.
1222 *
1223 * @see #PRESSED_STATE_SET
1224 * @see #WINDOW_FOCUSED_STATE_SET
1225 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001226 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001227 /**
1228 * Indicates the view is pressed and selected.
1229 *
1230 * @see #PRESSED_STATE_SET
1231 * @see #SELECTED_STATE_SET
1232 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001233 protected static final int[] PRESSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001234 /**
1235 * Indicates the view is pressed, selected and its window has the focus.
1236 *
1237 * @see #PRESSED_STATE_SET
1238 * @see #SELECTED_STATE_SET
1239 * @see #WINDOW_FOCUSED_STATE_SET
1240 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001241 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001242 /**
1243 * Indicates the view is pressed and focused.
1244 *
1245 * @see #PRESSED_STATE_SET
1246 * @see #FOCUSED_STATE_SET
1247 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001248 protected static final int[] PRESSED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001249 /**
1250 * Indicates the view is pressed, focused and its window has the focus.
1251 *
1252 * @see #PRESSED_STATE_SET
1253 * @see #FOCUSED_STATE_SET
1254 * @see #WINDOW_FOCUSED_STATE_SET
1255 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001256 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001257 /**
1258 * Indicates the view is pressed, focused and selected.
1259 *
1260 * @see #PRESSED_STATE_SET
1261 * @see #SELECTED_STATE_SET
1262 * @see #FOCUSED_STATE_SET
1263 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001264 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001265 /**
1266 * Indicates the view is pressed, focused, selected and its window has the focus.
1267 *
1268 * @see #PRESSED_STATE_SET
1269 * @see #FOCUSED_STATE_SET
1270 * @see #SELECTED_STATE_SET
1271 * @see #WINDOW_FOCUSED_STATE_SET
1272 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001273 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001274 /**
1275 * Indicates the view is pressed and enabled.
1276 *
1277 * @see #PRESSED_STATE_SET
1278 * @see #ENABLED_STATE_SET
1279 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001280 protected static final int[] PRESSED_ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001281 /**
1282 * Indicates the view is pressed, enabled and its window has the focus.
1283 *
1284 * @see #PRESSED_STATE_SET
1285 * @see #ENABLED_STATE_SET
1286 * @see #WINDOW_FOCUSED_STATE_SET
1287 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001288 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001289 /**
1290 * Indicates the view is pressed, enabled and selected.
1291 *
1292 * @see #PRESSED_STATE_SET
1293 * @see #ENABLED_STATE_SET
1294 * @see #SELECTED_STATE_SET
1295 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001296 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001297 /**
1298 * Indicates the view is pressed, enabled, selected and its window has the
1299 * focus.
1300 *
1301 * @see #PRESSED_STATE_SET
1302 * @see #ENABLED_STATE_SET
1303 * @see #SELECTED_STATE_SET
1304 * @see #WINDOW_FOCUSED_STATE_SET
1305 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001306 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001307 /**
1308 * Indicates the view is pressed, enabled and focused.
1309 *
1310 * @see #PRESSED_STATE_SET
1311 * @see #ENABLED_STATE_SET
1312 * @see #FOCUSED_STATE_SET
1313 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001314 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001315 /**
1316 * Indicates the view is pressed, enabled, focused and its window has the
1317 * focus.
1318 *
1319 * @see #PRESSED_STATE_SET
1320 * @see #ENABLED_STATE_SET
1321 * @see #FOCUSED_STATE_SET
1322 * @see #WINDOW_FOCUSED_STATE_SET
1323 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001324 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001325 /**
1326 * Indicates the view is pressed, enabled, focused and selected.
1327 *
1328 * @see #PRESSED_STATE_SET
1329 * @see #ENABLED_STATE_SET
1330 * @see #SELECTED_STATE_SET
1331 * @see #FOCUSED_STATE_SET
1332 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001333 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001334 /**
1335 * Indicates the view is pressed, enabled, focused, selected and its window
1336 * has the focus.
1337 *
1338 * @see #PRESSED_STATE_SET
1339 * @see #ENABLED_STATE_SET
1340 * @see #SELECTED_STATE_SET
1341 * @see #FOCUSED_STATE_SET
1342 * @see #WINDOW_FOCUSED_STATE_SET
1343 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001344 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001345
1346 /**
1347 * The order here is very important to {@link #getDrawableState()}
1348 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001349 private static final int[][] VIEW_STATE_SETS;
1350
Romain Guyb051e892010-09-28 19:09:36 -07001351 static final int VIEW_STATE_WINDOW_FOCUSED = 1;
1352 static final int VIEW_STATE_SELECTED = 1 << 1;
1353 static final int VIEW_STATE_FOCUSED = 1 << 2;
1354 static final int VIEW_STATE_ENABLED = 1 << 3;
1355 static final int VIEW_STATE_PRESSED = 1 << 4;
1356 static final int VIEW_STATE_ACTIVATED = 1 << 5;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001357 static final int VIEW_STATE_ACCELERATED = 1 << 6;
PY Laligandc33d8d49e2011-03-14 18:22:53 -07001358 static final int VIEW_STATE_HOVERED = 1 << 7;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001359 static final int VIEW_STATE_DRAG_CAN_ACCEPT = 1 << 8;
1360 static final int VIEW_STATE_DRAG_HOVERED = 1 << 9;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001361
1362 static final int[] VIEW_STATE_IDS = new int[] {
1363 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED,
1364 R.attr.state_selected, VIEW_STATE_SELECTED,
1365 R.attr.state_focused, VIEW_STATE_FOCUSED,
1366 R.attr.state_enabled, VIEW_STATE_ENABLED,
1367 R.attr.state_pressed, VIEW_STATE_PRESSED,
1368 R.attr.state_activated, VIEW_STATE_ACTIVATED,
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001369 R.attr.state_accelerated, VIEW_STATE_ACCELERATED,
PY Laligandc33d8d49e2011-03-14 18:22:53 -07001370 R.attr.state_hovered, VIEW_STATE_HOVERED,
Christopher Tate3d4bf172011-03-28 16:16:46 -07001371 R.attr.state_drag_can_accept, VIEW_STATE_DRAG_CAN_ACCEPT,
1372 R.attr.state_drag_hovered, VIEW_STATE_DRAG_HOVERED,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001373 };
1374
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001375 static {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001376 if ((VIEW_STATE_IDS.length/2) != R.styleable.ViewDrawableStates.length) {
1377 throw new IllegalStateException(
1378 "VIEW_STATE_IDs array length does not match ViewDrawableStates style array");
1379 }
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001380 int[] orderedIds = new int[VIEW_STATE_IDS.length];
Romain Guyb051e892010-09-28 19:09:36 -07001381 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001382 int viewState = R.styleable.ViewDrawableStates[i];
Romain Guyb051e892010-09-28 19:09:36 -07001383 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001384 if (VIEW_STATE_IDS[j] == viewState) {
Romain Guyb051e892010-09-28 19:09:36 -07001385 orderedIds[i * 2] = viewState;
1386 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1];
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001387 }
1388 }
1389 }
Romain Guyb051e892010-09-28 19:09:36 -07001390 final int NUM_BITS = VIEW_STATE_IDS.length / 2;
1391 VIEW_STATE_SETS = new int[1 << NUM_BITS][];
1392 for (int i = 0; i < VIEW_STATE_SETS.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001393 int numBits = Integer.bitCount(i);
1394 int[] set = new int[numBits];
1395 int pos = 0;
Romain Guyb051e892010-09-28 19:09:36 -07001396 for (int j = 0; j < orderedIds.length; j += 2) {
1397 if ((i & orderedIds[j+1]) != 0) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001398 set[pos++] = orderedIds[j];
1399 }
1400 }
1401 VIEW_STATE_SETS[i] = set;
1402 }
1403
1404 EMPTY_STATE_SET = VIEW_STATE_SETS[0];
1405 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED];
1406 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED];
1407 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1408 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED];
1409 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED];
1410 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1411 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED];
1412 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1413 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED];
1414 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1415 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1416 | VIEW_STATE_FOCUSED];
1417 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED];
1418 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1419 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED];
1420 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1421 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED];
1422 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1423 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1424 | VIEW_STATE_ENABLED];
1425 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1426 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED];
1427 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1428 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1429 | VIEW_STATE_ENABLED];
1430 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1431 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1432 | VIEW_STATE_ENABLED];
1433 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1434 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1435 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED];
1436
1437 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED];
1438 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1439 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED];
1440 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1441 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED];
1442 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1443 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1444 | VIEW_STATE_PRESSED];
1445 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1446 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1447 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1448 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1449 | VIEW_STATE_PRESSED];
1450 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1451 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1452 | VIEW_STATE_PRESSED];
1453 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1454 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1455 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1456 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[
1457 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1458 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1459 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED
1460 | VIEW_STATE_PRESSED];
1461 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1462 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED
1463 | VIEW_STATE_PRESSED];
1464 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1465 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1466 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1467 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1468 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED
1469 | VIEW_STATE_PRESSED];
1470 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1471 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1472 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1473 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1474 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1475 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1476 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1477 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1478 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED
1479 | VIEW_STATE_PRESSED];
1480 }
1481
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001482 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001483 * Temporary Rect currently for use in setBackground(). This will probably
1484 * be extended in the future to hold our own class with more than just
1485 * a Rect. :)
1486 */
1487 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>();
Romain Guyd90a3312009-05-06 14:54:28 -07001488
1489 /**
1490 * Map used to store views' tags.
1491 */
1492 private static WeakHashMap<View, SparseArray<Object>> sTags;
1493
1494 /**
1495 * Lock used to access sTags.
1496 */
1497 private static final Object sTagsLock = new Object();
1498
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001499 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07001500 * The next available accessiiblity id.
1501 */
1502 private static int sNextAccessibilityViewId;
1503
1504 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001505 * The animation currently associated with this view.
1506 * @hide
1507 */
1508 protected Animation mCurrentAnimation = null;
1509
1510 /**
1511 * Width as measured during measure pass.
1512 * {@hide}
1513 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001514 @ViewDebug.ExportedProperty(category = "measurement")
Romain Guy676b1732011-02-14 14:45:33 -08001515 int mMeasuredWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001516
1517 /**
1518 * Height as measured during measure pass.
1519 * {@hide}
1520 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001521 @ViewDebug.ExportedProperty(category = "measurement")
Romain Guy676b1732011-02-14 14:45:33 -08001522 int mMeasuredHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001523
1524 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001525 * Flag to indicate that this view was marked INVALIDATED, or had its display list
1526 * invalidated, prior to the current drawing iteration. If true, the view must re-draw
1527 * its display list. This flag, used only when hw accelerated, allows us to clear the
1528 * flag while retaining this information until it's needed (at getDisplayList() time and
1529 * in drawChild(), when we decide to draw a view's children's display lists into our own).
1530 *
1531 * {@hide}
1532 */
1533 boolean mRecreateDisplayList = false;
1534
1535 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001536 * The view's identifier.
1537 * {@hide}
1538 *
1539 * @see #setId(int)
1540 * @see #getId()
1541 */
1542 @ViewDebug.ExportedProperty(resolveId = true)
1543 int mID = NO_ID;
1544
1545 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07001546 * The stable ID of this view for accessibility porposes.
1547 */
1548 int mAccessibilityViewId = NO_ID;
1549
1550 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001551 * The view's tag.
1552 * {@hide}
1553 *
1554 * @see #setTag(Object)
1555 * @see #getTag()
1556 */
1557 protected Object mTag;
1558
1559 // for mPrivateFlags:
1560 /** {@hide} */
1561 static final int WANTS_FOCUS = 0x00000001;
1562 /** {@hide} */
1563 static final int FOCUSED = 0x00000002;
1564 /** {@hide} */
1565 static final int SELECTED = 0x00000004;
1566 /** {@hide} */
1567 static final int IS_ROOT_NAMESPACE = 0x00000008;
1568 /** {@hide} */
1569 static final int HAS_BOUNDS = 0x00000010;
1570 /** {@hide} */
1571 static final int DRAWN = 0x00000020;
1572 /**
1573 * When this flag is set, this view is running an animation on behalf of its
1574 * children and should therefore not cancel invalidate requests, even if they
1575 * lie outside of this view's bounds.
1576 *
1577 * {@hide}
1578 */
1579 static final int DRAW_ANIMATION = 0x00000040;
1580 /** {@hide} */
1581 static final int SKIP_DRAW = 0x00000080;
1582 /** {@hide} */
1583 static final int ONLY_DRAWS_BACKGROUND = 0x00000100;
1584 /** {@hide} */
1585 static final int REQUEST_TRANSPARENT_REGIONS = 0x00000200;
1586 /** {@hide} */
1587 static final int DRAWABLE_STATE_DIRTY = 0x00000400;
1588 /** {@hide} */
1589 static final int MEASURED_DIMENSION_SET = 0x00000800;
1590 /** {@hide} */
1591 static final int FORCE_LAYOUT = 0x00001000;
Konstantin Lopyrevc6dc4572010-08-06 15:01:52 -07001592 /** {@hide} */
1593 static final int LAYOUT_REQUIRED = 0x00002000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001594
1595 private static final int PRESSED = 0x00004000;
1596
1597 /** {@hide} */
1598 static final int DRAWING_CACHE_VALID = 0x00008000;
1599 /**
1600 * Flag used to indicate that this view should be drawn once more (and only once
1601 * more) after its animation has completed.
1602 * {@hide}
1603 */
1604 static final int ANIMATION_STARTED = 0x00010000;
1605
1606 private static final int SAVE_STATE_CALLED = 0x00020000;
1607
1608 /**
1609 * Indicates that the View returned true when onSetAlpha() was called and that
1610 * the alpha must be restored.
1611 * {@hide}
1612 */
1613 static final int ALPHA_SET = 0x00040000;
1614
1615 /**
1616 * Set by {@link #setScrollContainer(boolean)}.
1617 */
1618 static final int SCROLL_CONTAINER = 0x00080000;
1619
1620 /**
1621 * Set by {@link #setScrollContainer(boolean)}.
1622 */
1623 static final int SCROLL_CONTAINER_ADDED = 0x00100000;
1624
1625 /**
Romain Guy809a7f62009-05-14 15:44:42 -07001626 * View flag indicating whether this view was invalidated (fully or partially.)
1627 *
1628 * @hide
1629 */
1630 static final int DIRTY = 0x00200000;
1631
1632 /**
1633 * View flag indicating whether this view was invalidated by an opaque
1634 * invalidate request.
1635 *
1636 * @hide
1637 */
1638 static final int DIRTY_OPAQUE = 0x00400000;
1639
1640 /**
1641 * Mask for {@link #DIRTY} and {@link #DIRTY_OPAQUE}.
1642 *
1643 * @hide
1644 */
1645 static final int DIRTY_MASK = 0x00600000;
1646
1647 /**
Romain Guy8f1344f52009-05-15 16:03:59 -07001648 * Indicates whether the background is opaque.
1649 *
1650 * @hide
1651 */
1652 static final int OPAQUE_BACKGROUND = 0x00800000;
1653
1654 /**
1655 * Indicates whether the scrollbars are opaque.
1656 *
1657 * @hide
1658 */
1659 static final int OPAQUE_SCROLLBARS = 0x01000000;
1660
1661 /**
1662 * Indicates whether the view is opaque.
1663 *
1664 * @hide
1665 */
1666 static final int OPAQUE_MASK = 0x01800000;
Joe Malin32736f02011-01-19 16:14:20 -08001667
Adam Powelle14579b2009-12-16 18:39:52 -08001668 /**
1669 * Indicates a prepressed state;
1670 * the short time between ACTION_DOWN and recognizing
1671 * a 'real' press. Prepressed is used to recognize quick taps
1672 * even when they are shorter than ViewConfiguration.getTapTimeout().
Joe Malin32736f02011-01-19 16:14:20 -08001673 *
Adam Powelle14579b2009-12-16 18:39:52 -08001674 * @hide
1675 */
1676 private static final int PREPRESSED = 0x02000000;
Joe Malin32736f02011-01-19 16:14:20 -08001677
Adam Powellc9fbaab2010-02-16 17:16:19 -08001678 /**
Romain Guy8afa5152010-02-26 11:56:30 -08001679 * Indicates whether the view is temporarily detached.
1680 *
1681 * @hide
1682 */
1683 static final int CANCEL_NEXT_UP_EVENT = 0x04000000;
Joe Malin32736f02011-01-19 16:14:20 -08001684
Adam Powell8568c3a2010-04-19 14:26:11 -07001685 /**
1686 * Indicates that we should awaken scroll bars once attached
Joe Malin32736f02011-01-19 16:14:20 -08001687 *
Adam Powell8568c3a2010-04-19 14:26:11 -07001688 * @hide
1689 */
1690 private static final int AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000;
Romain Guy8f1344f52009-05-15 16:03:59 -07001691
1692 /**
Jeff Browna032cc02011-03-07 16:56:21 -08001693 * Indicates that the view has received HOVER_ENTER. Cleared on HOVER_EXIT.
1694 * @hide
1695 */
1696 private static final int HOVERED = 0x10000000;
1697
1698 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001699 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center
1700 * for transform operations
1701 *
1702 * @hide
1703 */
Adam Powellf37df072010-09-17 16:22:49 -07001704 private static final int PIVOT_EXPLICITLY_SET = 0x20000000;
Chet Haasefd2b0022010-08-06 13:08:56 -07001705
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001706 /** {@hide} */
Adam Powellf37df072010-09-17 16:22:49 -07001707 static final int ACTIVATED = 0x40000000;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001708
Chet Haasefd2b0022010-08-06 13:08:56 -07001709 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001710 * Indicates that this view was specifically invalidated, not just dirtied because some
1711 * child view was invalidated. The flag is used to determine when we need to recreate
1712 * a view's display list (as opposed to just returning a reference to its existing
1713 * display list).
1714 *
1715 * @hide
1716 */
1717 static final int INVALIDATED = 0x80000000;
1718
Christopher Tate3d4bf172011-03-28 16:16:46 -07001719 /* Masks for mPrivateFlags2 */
1720
1721 /**
1722 * Indicates that this view has reported that it can accept the current drag's content.
1723 * Cleared when the drag operation concludes.
1724 * @hide
1725 */
1726 static final int DRAG_CAN_ACCEPT = 0x00000001;
1727
1728 /**
1729 * Indicates that this view is currently directly under the drag location in a
1730 * drag-and-drop operation involving content that it can accept. Cleared when
1731 * the drag exits the view, or when the drag operation concludes.
1732 * @hide
1733 */
1734 static final int DRAG_HOVERED = 0x00000002;
1735
Cibu Johny86666632010-02-22 13:01:02 -08001736 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07001737 * Indicates whether the view layout direction has been resolved and drawn to the
1738 * right-to-left direction.
Cibu Johny86666632010-02-22 13:01:02 -08001739 *
1740 * @hide
1741 */
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07001742 static final int LAYOUT_DIRECTION_RESOLVED_RTL = 0x00000004;
1743
1744 /**
1745 * Indicates whether the view layout direction has been resolved.
1746 *
1747 * @hide
1748 */
1749 static final int LAYOUT_DIRECTION_RESOLVED = 0x00000008;
1750
Cibu Johny86666632010-02-22 13:01:02 -08001751
Christopher Tate3d4bf172011-03-28 16:16:46 -07001752 /* End of masks for mPrivateFlags2 */
1753
1754 static final int DRAG_MASK = DRAG_CAN_ACCEPT | DRAG_HOVERED;
1755
Chet Haasedaf98e92011-01-10 14:10:36 -08001756 /**
Adam Powell637d3372010-08-25 14:37:03 -07001757 * Always allow a user to over-scroll this view, provided it is a
1758 * view that can scroll.
1759 *
1760 * @see #getOverScrollMode()
1761 * @see #setOverScrollMode(int)
1762 */
1763 public static final int OVER_SCROLL_ALWAYS = 0;
1764
1765 /**
1766 * Allow a user to over-scroll this view only if the content is large
1767 * enough to meaningfully scroll, provided it is a view that can scroll.
1768 *
1769 * @see #getOverScrollMode()
1770 * @see #setOverScrollMode(int)
1771 */
1772 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1;
1773
1774 /**
1775 * Never allow a user to over-scroll this view.
1776 *
1777 * @see #getOverScrollMode()
1778 * @see #setOverScrollMode(int)
1779 */
1780 public static final int OVER_SCROLL_NEVER = 2;
1781
1782 /**
Joe Onorato664644d2011-01-23 17:53:23 -08001783 * View has requested the status bar to be visible (the default).
1784 *
Joe Malin32736f02011-01-19 16:14:20 -08001785 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08001786 */
1787 public static final int STATUS_BAR_VISIBLE = 0;
1788
1789 /**
Jeff Brown05dc66a2011-03-02 14:41:58 -08001790 * View has requested the status bar to be hidden.
Joe Onorato664644d2011-01-23 17:53:23 -08001791 *
Joe Malin32736f02011-01-19 16:14:20 -08001792 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08001793 */
1794 public static final int STATUS_BAR_HIDDEN = 0x00000001;
1795
1796 /**
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001797 * @hide
1798 *
1799 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1800 * out of the public fields to keep the undefined bits out of the developer's way.
1801 *
1802 * Flag to make the status bar not expandable. Unless you also
1803 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show.
1804 */
1805 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000;
1806
1807 /**
1808 * @hide
1809 *
1810 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1811 * out of the public fields to keep the undefined bits out of the developer's way.
1812 *
1813 * Flag to hide notification icons and scrolling ticker text.
1814 */
1815 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000;
1816
1817 /**
1818 * @hide
1819 *
1820 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1821 * out of the public fields to keep the undefined bits out of the developer's way.
1822 *
1823 * Flag to disable incoming notification alerts. This will not block
1824 * icons, but it will block sound, vibrating and other visual or aural notifications.
1825 */
1826 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000;
1827
1828 /**
1829 * @hide
1830 *
1831 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1832 * out of the public fields to keep the undefined bits out of the developer's way.
1833 *
1834 * Flag to hide only the scrolling ticker. Note that
1835 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies
1836 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}.
1837 */
1838 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000;
1839
1840 /**
1841 * @hide
1842 *
1843 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1844 * out of the public fields to keep the undefined bits out of the developer's way.
1845 *
1846 * Flag to hide the center system info area.
1847 */
1848 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000;
1849
1850 /**
1851 * @hide
1852 *
1853 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1854 * out of the public fields to keep the undefined bits out of the developer's way.
1855 *
1856 * Flag to hide only the navigation buttons. Don't use this
1857 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
Joe Onorato6478adc2011-01-27 21:15:01 -08001858 *
1859 * THIS DOES NOT DISABLE THE BACK BUTTON
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001860 */
1861 public static final int STATUS_BAR_DISABLE_NAVIGATION = 0x00200000;
1862
1863 /**
1864 * @hide
1865 *
1866 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1867 * out of the public fields to keep the undefined bits out of the developer's way.
1868 *
Joe Onorato6478adc2011-01-27 21:15:01 -08001869 * Flag to hide only the back button. Don't use this
1870 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
1871 */
1872 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000;
1873
1874 /**
1875 * @hide
1876 *
1877 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1878 * out of the public fields to keep the undefined bits out of the developer's way.
1879 *
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001880 * Flag to hide only the clock. You might use this if your activity has
1881 * its own clock making the status bar's clock redundant.
1882 */
Joe Onorato6478adc2011-01-27 21:15:01 -08001883 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000;
1884
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001885 /**
1886 * @hide
1887 */
1888 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = STATUS_BAR_HIDDEN;
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001889
1890 /**
Adam Powell637d3372010-08-25 14:37:03 -07001891 * Controls the over-scroll mode for this view.
1892 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)},
1893 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS},
1894 * and {@link #OVER_SCROLL_NEVER}.
1895 */
1896 private int mOverScrollMode;
1897
1898 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001899 * The parent this view is attached to.
1900 * {@hide}
1901 *
1902 * @see #getParent()
1903 */
1904 protected ViewParent mParent;
1905
1906 /**
1907 * {@hide}
1908 */
1909 AttachInfo mAttachInfo;
1910
1911 /**
1912 * {@hide}
1913 */
Romain Guy809a7f62009-05-14 15:44:42 -07001914 @ViewDebug.ExportedProperty(flagMapping = {
1915 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT,
1916 name = "FORCE_LAYOUT"),
1917 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED,
1918 name = "LAYOUT_REQUIRED"),
1919 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07001920 name = "DRAWING_CACHE_INVALID", outputIf = false),
Romain Guy809a7f62009-05-14 15:44:42 -07001921 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true),
1922 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false),
1923 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
1924 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY")
1925 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001926 int mPrivateFlags;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001927 int mPrivateFlags2;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001928
1929 /**
Joe Onorato664644d2011-01-23 17:53:23 -08001930 * This view's request for the visibility of the status bar.
1931 * @hide
1932 */
Joe Onoratoac0ee892011-01-30 15:38:30 -08001933 @ViewDebug.ExportedProperty()
Joe Onorato664644d2011-01-23 17:53:23 -08001934 int mSystemUiVisibility;
1935
1936 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001937 * Count of how many windows this view has been attached to.
1938 */
1939 int mWindowAttachCount;
1940
1941 /**
1942 * The layout parameters associated with this view and used by the parent
1943 * {@link android.view.ViewGroup} to determine how this view should be
1944 * laid out.
1945 * {@hide}
1946 */
1947 protected ViewGroup.LayoutParams mLayoutParams;
1948
1949 /**
1950 * The view flags hold various views states.
1951 * {@hide}
1952 */
1953 @ViewDebug.ExportedProperty
1954 int mViewFlags;
1955
1956 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07001957 * The transform matrix for the View. This transform is calculated internally
1958 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1959 * is used by default. Do *not* use this variable directly; instead call
1960 * getMatrix(), which will automatically recalculate the matrix if necessary
1961 * to get the correct matrix based on the latest rotation and scale properties.
1962 */
1963 private final Matrix mMatrix = new Matrix();
1964
1965 /**
1966 * The transform matrix for the View. This transform is calculated internally
1967 * based on the rotation, scaleX, and scaleY properties. The identity matrix
1968 * is used by default. Do *not* use this variable directly; instead call
Jeff Brown86671742010-09-30 20:00:15 -07001969 * getInverseMatrix(), which will automatically recalculate the matrix if necessary
Chet Haasec3aa3612010-06-17 08:50:37 -07001970 * to get the correct matrix based on the latest rotation and scale properties.
1971 */
1972 private Matrix mInverseMatrix;
1973
1974 /**
1975 * An internal variable that tracks whether we need to recalculate the
1976 * transform matrix, based on whether the rotation or scaleX/Y properties
1977 * have changed since the matrix was last calculated.
1978 */
Chet Haasea00f3862011-02-22 06:34:40 -08001979 boolean mMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07001980
1981 /**
1982 * An internal variable that tracks whether we need to recalculate the
1983 * transform matrix, based on whether the rotation or scaleX/Y properties
1984 * have changed since the matrix was last calculated.
1985 */
1986 private boolean mInverseMatrixDirty = true;
1987
1988 /**
1989 * A variable that tracks whether we need to recalculate the
1990 * transform matrix, based on whether the rotation or scaleX/Y properties
1991 * have changed since the matrix was last calculated. This variable
Jeff Brown86671742010-09-30 20:00:15 -07001992 * is only valid after a call to updateMatrix() or to a function that
1993 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix().
Chet Haasec3aa3612010-06-17 08:50:37 -07001994 */
Romain Guy33e72ae2010-07-17 12:40:29 -07001995 private boolean mMatrixIsIdentity = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07001996
1997 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001998 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set.
1999 */
2000 private Camera mCamera = null;
2001
2002 /**
2003 * This matrix is used when computing the matrix for 3D rotations.
2004 */
2005 private Matrix matrix3D = null;
2006
2007 /**
2008 * These prev values are used to recalculate a centered pivot point when necessary. The
2009 * pivot point is only used in matrix operations (when rotation, scale, or translation are
2010 * set), so thes values are only used then as well.
2011 */
2012 private int mPrevWidth = -1;
2013 private int mPrevHeight = -1;
2014
Joe Malin32736f02011-01-19 16:14:20 -08002015 private boolean mLastIsOpaque;
2016
Chet Haasefd2b0022010-08-06 13:08:56 -07002017 /**
2018 * Convenience value to check for float values that are close enough to zero to be considered
2019 * zero.
2020 */
Romain Guy2542d192010-08-18 11:47:12 -07002021 private static final float NONZERO_EPSILON = .001f;
Chet Haasefd2b0022010-08-06 13:08:56 -07002022
2023 /**
2024 * The degrees rotation around the vertical axis through the pivot point.
2025 */
2026 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002027 float mRotationY = 0f;
Chet Haasefd2b0022010-08-06 13:08:56 -07002028
2029 /**
2030 * The degrees rotation around the horizontal axis through the pivot point.
2031 */
2032 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002033 float mRotationX = 0f;
Chet Haasefd2b0022010-08-06 13:08:56 -07002034
2035 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07002036 * The degrees rotation around the pivot point.
2037 */
2038 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002039 float mRotation = 0f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002040
2041 /**
Chet Haasedf030d22010-07-30 17:22:38 -07002042 * The amount of translation of the object away from its left property (post-layout).
2043 */
2044 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002045 float mTranslationX = 0f;
Chet Haasedf030d22010-07-30 17:22:38 -07002046
2047 /**
2048 * The amount of translation of the object away from its top property (post-layout).
2049 */
2050 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002051 float mTranslationY = 0f;
Chet Haasedf030d22010-07-30 17:22:38 -07002052
2053 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07002054 * The amount of scale in the x direction around the pivot point. A
2055 * value of 1 means no scaling is applied.
2056 */
2057 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002058 float mScaleX = 1f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002059
2060 /**
2061 * The amount of scale in the y direction around the pivot point. A
2062 * value of 1 means no scaling is applied.
2063 */
2064 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002065 float mScaleY = 1f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002066
2067 /**
2068 * The amount of scale in the x direction around the pivot point. A
2069 * value of 1 means no scaling is applied.
2070 */
2071 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002072 float mPivotX = 0f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002073
2074 /**
2075 * The amount of scale in the y direction around the pivot point. A
2076 * value of 1 means no scaling is applied.
2077 */
2078 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002079 float mPivotY = 0f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002080
2081 /**
2082 * The opacity of the View. This is a value from 0 to 1, where 0 means
2083 * completely transparent and 1 means completely opaque.
2084 */
2085 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002086 float mAlpha = 1f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002087
2088 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002089 * The distance in pixels from the left edge of this view's parent
2090 * to the left edge of this view.
2091 * {@hide}
2092 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002093 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002094 protected int mLeft;
2095 /**
2096 * The distance in pixels from the left edge of this view's parent
2097 * to the right edge of this view.
2098 * {@hide}
2099 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002100 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002101 protected int mRight;
2102 /**
2103 * The distance in pixels from the top edge of this view's parent
2104 * to the top edge of this view.
2105 * {@hide}
2106 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002107 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002108 protected int mTop;
2109 /**
2110 * The distance in pixels from the top edge of this view's parent
2111 * to the bottom edge of this view.
2112 * {@hide}
2113 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002114 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002115 protected int mBottom;
2116
2117 /**
2118 * The offset, in pixels, by which the content of this view is scrolled
2119 * horizontally.
2120 * {@hide}
2121 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002122 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002123 protected int mScrollX;
2124 /**
2125 * The offset, in pixels, by which the content of this view is scrolled
2126 * vertically.
2127 * {@hide}
2128 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002129 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002130 protected int mScrollY;
2131
2132 /**
2133 * The left padding in pixels, that is the distance in pixels between the
2134 * left edge of this view and the left edge of its content.
2135 * {@hide}
2136 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002137 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002138 protected int mPaddingLeft;
2139 /**
2140 * The right padding in pixels, that is the distance in pixels between the
2141 * right edge of this view and the right edge of its content.
2142 * {@hide}
2143 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002144 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002145 protected int mPaddingRight;
2146 /**
2147 * The top padding in pixels, that is the distance in pixels between the
2148 * top edge of this view and the top edge of its content.
2149 * {@hide}
2150 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002151 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002152 protected int mPaddingTop;
2153 /**
2154 * The bottom padding in pixels, that is the distance in pixels between the
2155 * bottom edge of this view and the bottom edge of its content.
2156 * {@hide}
2157 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002158 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002159 protected int mPaddingBottom;
2160
2161 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002162 * Briefly describes the view and is primarily used for accessibility support.
2163 */
2164 private CharSequence mContentDescription;
2165
2166 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002167 * Cache the paddingRight set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002168 *
2169 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002170 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002171 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002172 protected int mUserPaddingRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002173
2174 /**
2175 * Cache the paddingBottom set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002176 *
2177 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002178 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002179 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002180 protected int mUserPaddingBottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002181
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002182 /**
Adam Powell20232d02010-12-08 21:08:53 -08002183 * Cache the paddingLeft set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002184 *
2185 * @hide
Adam Powell20232d02010-12-08 21:08:53 -08002186 */
2187 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002188 protected int mUserPaddingLeft;
Adam Powell20232d02010-12-08 21:08:53 -08002189
2190 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07002191 * Cache if the user padding is relative.
2192 *
2193 */
2194 @ViewDebug.ExportedProperty(category = "padding")
2195 boolean mUserPaddingRelative;
2196
2197 /**
2198 * Cache the paddingStart set by the user to append to the scrollbar's size.
2199 *
2200 */
2201 @ViewDebug.ExportedProperty(category = "padding")
2202 int mUserPaddingStart;
2203
2204 /**
2205 * Cache the paddingEnd set by the user to append to the scrollbar's size.
2206 *
2207 */
2208 @ViewDebug.ExportedProperty(category = "padding")
2209 int mUserPaddingEnd;
2210
2211 /**
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002212 * @hide
2213 */
2214 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
2215 /**
2216 * @hide
2217 */
2218 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002219
2220 private Resources mResources = null;
2221
2222 private Drawable mBGDrawable;
2223
2224 private int mBackgroundResource;
2225 private boolean mBackgroundSizeChanged;
2226
2227 /**
2228 * Listener used to dispatch focus change events.
2229 * This field should be made private, so it is hidden from the SDK.
2230 * {@hide}
2231 */
2232 protected OnFocusChangeListener mOnFocusChangeListener;
2233
2234 /**
Chet Haase21cd1382010-09-01 17:42:29 -07002235 * Listeners for layout change events.
2236 */
2237 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
2238
2239 /**
Adam Powell4afd62b2011-02-18 15:02:18 -08002240 * Listeners for attach events.
2241 */
2242 private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners;
2243
2244 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002245 * Listener used to dispatch click events.
2246 * This field should be made private, so it is hidden from the SDK.
2247 * {@hide}
2248 */
2249 protected OnClickListener mOnClickListener;
2250
2251 /**
2252 * Listener used to dispatch long click events.
2253 * This field should be made private, so it is hidden from the SDK.
2254 * {@hide}
2255 */
2256 protected OnLongClickListener mOnLongClickListener;
2257
2258 /**
2259 * Listener used to build the context menu.
2260 * This field should be made private, so it is hidden from the SDK.
2261 * {@hide}
2262 */
2263 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
2264
2265 private OnKeyListener mOnKeyListener;
2266
2267 private OnTouchListener mOnTouchListener;
2268
Jeff Brown10b62902011-06-20 16:40:37 -07002269 private OnHoverListener mOnHoverListener;
2270
Jeff Brown33bbfd22011-02-24 20:55:35 -08002271 private OnGenericMotionListener mOnGenericMotionListener;
2272
Chris Tate32affef2010-10-18 15:29:21 -07002273 private OnDragListener mOnDragListener;
2274
Joe Onorato664644d2011-01-23 17:53:23 -08002275 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener;
2276
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002277 /**
2278 * The application environment this view lives in.
2279 * This field should be made private, so it is hidden from the SDK.
2280 * {@hide}
2281 */
2282 protected Context mContext;
2283
2284 private ScrollabilityCache mScrollCache;
2285
2286 private int[] mDrawableState = null;
2287
Romain Guy0211a0a2011-02-14 16:34:59 -08002288 /**
2289 * Set to true when drawing cache is enabled and cannot be created.
2290 *
2291 * @hide
2292 */
2293 public boolean mCachingFailed;
2294
Romain Guy02890fd2010-08-06 17:58:44 -07002295 private Bitmap mDrawingCache;
2296 private Bitmap mUnscaledDrawingCache;
Romain Guyb051e892010-09-28 19:09:36 -07002297 private DisplayList mDisplayList;
Romain Guy6c319ca2011-01-11 14:29:25 -08002298 private HardwareLayer mHardwareLayer;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002299
2300 /**
2301 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
2302 * the user may specify which view to go to next.
2303 */
2304 private int mNextFocusLeftId = View.NO_ID;
2305
2306 /**
2307 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
2308 * the user may specify which view to go to next.
2309 */
2310 private int mNextFocusRightId = View.NO_ID;
2311
2312 /**
2313 * When this view has focus and the next focus is {@link #FOCUS_UP},
2314 * the user may specify which view to go to next.
2315 */
2316 private int mNextFocusUpId = View.NO_ID;
2317
2318 /**
2319 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
2320 * the user may specify which view to go to next.
2321 */
2322 private int mNextFocusDownId = View.NO_ID;
2323
Jeff Brown4e6319b2010-12-13 10:36:51 -08002324 /**
2325 * When this view has focus and the next focus is {@link #FOCUS_FORWARD},
2326 * the user may specify which view to go to next.
2327 */
2328 int mNextFocusForwardId = View.NO_ID;
2329
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002330 private CheckForLongPress mPendingCheckForLongPress;
Adam Powelle14579b2009-12-16 18:39:52 -08002331 private CheckForTap mPendingCheckForTap = null;
Adam Powella35d7682010-03-12 14:48:13 -08002332 private PerformClick mPerformClick;
Svetoslav Ganova0156172011-06-26 17:55:44 -07002333 private SendViewScrolledAccessibilityEvent mSendViewScrolledAccessibilityEvent;
Joe Malin32736f02011-01-19 16:14:20 -08002334
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002335 private UnsetPressedState mUnsetPressedState;
2336
2337 /**
2338 * Whether the long press's action has been invoked. The tap's action is invoked on the
2339 * up event while a long press is invoked as soon as the long press duration is reached, so
2340 * a long press could be performed before the tap is checked, in which case the tap's action
2341 * should not be invoked.
2342 */
2343 private boolean mHasPerformedLongPress;
2344
2345 /**
2346 * The minimum height of the view. We'll try our best to have the height
2347 * of this view to at least this amount.
2348 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002349 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002350 private int mMinHeight;
2351
2352 /**
2353 * The minimum width of the view. We'll try our best to have the width
2354 * of this view to at least this amount.
2355 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002356 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002357 private int mMinWidth;
2358
2359 /**
2360 * The delegate to handle touch events that are physically in this view
2361 * but should be handled by another view.
2362 */
2363 private TouchDelegate mTouchDelegate = null;
2364
2365 /**
2366 * Solid color to use as a background when creating the drawing cache. Enables
2367 * the cache to use 16 bit bitmaps instead of 32 bit.
2368 */
2369 private int mDrawingCacheBackgroundColor = 0;
2370
2371 /**
2372 * Special tree observer used when mAttachInfo is null.
2373 */
2374 private ViewTreeObserver mFloatingTreeObserver;
Joe Malin32736f02011-01-19 16:14:20 -08002375
Adam Powelle14579b2009-12-16 18:39:52 -08002376 /**
2377 * Cache the touch slop from the context that created the view.
2378 */
2379 private int mTouchSlop;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002380
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002381 /**
Chet Haasea00f3862011-02-22 06:34:40 -08002382 * Object that handles automatic animation of view properties.
2383 */
2384 private ViewPropertyAnimator mAnimator = null;
2385
2386 /**
Christopher Tate251602f2011-01-28 17:54:12 -08002387 * Flag indicating that a drag can cross window boundaries. When
2388 * {@link #startDrag(ClipData, DragShadowBuilder, Object, int)} is called
2389 * with this flag set, all visible applications will be able to participate
2390 * in the drag operation and receive the dragged content.
Christopher Tate7f9ff9d2011-02-14 17:31:13 -08002391 *
2392 * @hide
Christopher Tate02d2b3b2011-01-10 20:43:53 -08002393 */
2394 public static final int DRAG_FLAG_GLOBAL = 1;
2395
2396 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08002397 * Vertical scroll factor cached by {@link #getVerticalScrollFactor}.
2398 */
2399 private float mVerticalScrollFactor;
2400
2401 /**
Adam Powell20232d02010-12-08 21:08:53 -08002402 * Position of the vertical scroll bar.
2403 */
2404 private int mVerticalScrollbarPosition;
2405
2406 /**
2407 * Position the scroll bar at the default position as determined by the system.
2408 */
2409 public static final int SCROLLBAR_POSITION_DEFAULT = 0;
2410
2411 /**
2412 * Position the scroll bar along the left edge.
2413 */
2414 public static final int SCROLLBAR_POSITION_LEFT = 1;
2415
2416 /**
2417 * Position the scroll bar along the right edge.
2418 */
2419 public static final int SCROLLBAR_POSITION_RIGHT = 2;
2420
2421 /**
Romain Guy171c5922011-01-06 10:04:23 -08002422 * Indicates that the view does not have a layer.
Joe Malin32736f02011-01-19 16:14:20 -08002423 *
2424 * @see #getLayerType()
2425 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08002426 * @see #LAYER_TYPE_SOFTWARE
Joe Malin32736f02011-01-19 16:14:20 -08002427 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08002428 */
2429 public static final int LAYER_TYPE_NONE = 0;
2430
2431 /**
2432 * <p>Indicates that the view has a software layer. A software layer is backed
2433 * by a bitmap and causes the view to be rendered using Android's software
2434 * rendering pipeline, even if hardware acceleration is enabled.</p>
Joe Malin32736f02011-01-19 16:14:20 -08002435 *
Romain Guy171c5922011-01-06 10:04:23 -08002436 * <p>Software layers have various usages:</p>
2437 * <p>When the application is not using hardware acceleration, a software layer
2438 * is useful to apply a specific color filter and/or blending mode and/or
2439 * translucency to a view and all its children.</p>
2440 * <p>When the application is using hardware acceleration, a software layer
2441 * is useful to render drawing primitives not supported by the hardware
2442 * accelerated pipeline. It can also be used to cache a complex view tree
2443 * into a texture and reduce the complexity of drawing operations. For instance,
2444 * when animating a complex view tree with a translation, a software layer can
2445 * be used to render the view tree only once.</p>
2446 * <p>Software layers should be avoided when the affected view tree updates
2447 * often. Every update will require to re-render the software layer, which can
2448 * potentially be slow (particularly when hardware acceleration is turned on
2449 * since the layer will have to be uploaded into a hardware texture after every
2450 * update.)</p>
Joe Malin32736f02011-01-19 16:14:20 -08002451 *
2452 * @see #getLayerType()
2453 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08002454 * @see #LAYER_TYPE_NONE
Joe Malin32736f02011-01-19 16:14:20 -08002455 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08002456 */
2457 public static final int LAYER_TYPE_SOFTWARE = 1;
2458
2459 /**
2460 * <p>Indicates that the view has a hardware layer. A hardware layer is backed
2461 * by a hardware specific texture (generally Frame Buffer Objects or FBO on
2462 * OpenGL hardware) and causes the view to be rendered using Android's hardware
2463 * rendering pipeline, but only if hardware acceleration is turned on for the
2464 * view hierarchy. When hardware acceleration is turned off, hardware layers
2465 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p>
Joe Malin32736f02011-01-19 16:14:20 -08002466 *
Romain Guy171c5922011-01-06 10:04:23 -08002467 * <p>A hardware layer is useful to apply a specific color filter and/or
2468 * blending mode and/or translucency to a view and all its children.</p>
Romain Guy6c319ca2011-01-11 14:29:25 -08002469 * <p>A hardware layer can be used to cache a complex view tree into a
2470 * texture and reduce the complexity of drawing operations. For instance,
2471 * when animating a complex view tree with a translation, a hardware layer can
2472 * be used to render the view tree only once.</p>
Romain Guy171c5922011-01-06 10:04:23 -08002473 * <p>A hardware layer can also be used to increase the rendering quality when
2474 * rotation transformations are applied on a view. It can also be used to
2475 * prevent potential clipping issues when applying 3D transforms on a view.</p>
Joe Malin32736f02011-01-19 16:14:20 -08002476 *
2477 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -08002478 * @see #setLayerType(int, android.graphics.Paint)
2479 * @see #LAYER_TYPE_NONE
2480 * @see #LAYER_TYPE_SOFTWARE
2481 */
2482 public static final int LAYER_TYPE_HARDWARE = 2;
Joe Malin32736f02011-01-19 16:14:20 -08002483
Romain Guy3aaff3a2011-01-12 14:18:47 -08002484 @ViewDebug.ExportedProperty(category = "drawing", mapping = {
2485 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"),
2486 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"),
2487 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE")
2488 })
Romain Guy171c5922011-01-06 10:04:23 -08002489 int mLayerType = LAYER_TYPE_NONE;
2490 Paint mLayerPaint;
Romain Guy3a3133d2011-02-01 22:59:58 -08002491 Rect mLocalDirtyRect;
Romain Guy171c5922011-01-06 10:04:23 -08002492
2493 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07002494 * Set to true when the view is sending hover accessibility events because it
2495 * is the innermost hovered view.
2496 */
2497 private boolean mSendingHoverAccessibilityEvents;
2498
2499 /**
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002500 * Text direction is inherited thru {@link ViewGroup}
2501 * @hide
2502 */
2503 public static final int TEXT_DIRECTION_INHERIT = 0;
2504
2505 /**
2506 * Text direction is using "first strong algorithm". The first strong directional character
2507 * determines the paragraph direction. If there is no strong directional character, the
Doug Feltcb3791202011-07-07 11:57:48 -07002508 * paragraph direction is the view's resolved ayout direction.
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002509 *
2510 * @hide
2511 */
2512 public static final int TEXT_DIRECTION_FIRST_STRONG = 1;
2513
2514 /**
2515 * Text direction is using "any-RTL" algorithm. The paragraph direction is RTL if it contains
2516 * any strong RTL character, otherwise it is LTR if it contains any strong LTR characters.
Doug Feltcb3791202011-07-07 11:57:48 -07002517 * If there are neither, the paragraph direction is the view's resolved layout direction.
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002518 *
2519 * @hide
2520 */
2521 public static final int TEXT_DIRECTION_ANY_RTL = 2;
2522
2523 /**
Fabrice Di Meglio8f502652011-06-29 20:40:43 -07002524 * Text direction is the same as the one held by a 60% majority of the characters. If there is
2525 * no majority then the paragraph direction is the resolved layout direction of the View.
2526 *
2527 * @hide
2528 */
2529 public static final int TEXT_DIRECTION_CHAR_COUNT = 3;
2530
2531 /**
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002532 * Text direction is forced to LTR.
2533 *
2534 * @hide
2535 */
Fabrice Di Meglio8f502652011-06-29 20:40:43 -07002536 public static final int TEXT_DIRECTION_LTR = 4;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002537
2538 /**
2539 * Text direction is forced to RTL.
2540 *
2541 * @hide
2542 */
Fabrice Di Meglio8f502652011-06-29 20:40:43 -07002543 public static final int TEXT_DIRECTION_RTL = 5;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002544
2545 /**
2546 * Default text direction is inherited
2547 */
2548 protected static int DEFAULT_TEXT_DIRECTION = TEXT_DIRECTION_INHERIT;
2549
2550 /**
Fabrice Di Meglio8f502652011-06-29 20:40:43 -07002551 * Default threshold for "char count" heuristic.
2552 */
2553 protected static float DEFAULT_TEXT_DIRECTION_CHAR_COUNT_THRESHOLD = 0.6f;
2554
2555 /**
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002556 * The text direction that has been defined by {@link #setTextDirection(int)}.
2557 *
2558 * {@hide}
2559 */
2560 @ViewDebug.ExportedProperty(category = "text", mapping = {
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002561 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"),
2562 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"),
2563 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"),
Fabrice Di Meglio8f502652011-06-29 20:40:43 -07002564 @ViewDebug.IntToString(from = TEXT_DIRECTION_CHAR_COUNT, to = "CHAR_COUNT"),
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002565 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"),
2566 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL")
2567 })
Doug Feltcb3791202011-07-07 11:57:48 -07002568 private int mTextDirection = DEFAULT_TEXT_DIRECTION;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002569
2570 /**
Doug Feltcb3791202011-07-07 11:57:48 -07002571 * The resolved text direction. This needs resolution if the value is
2572 * TEXT_DIRECTION_INHERIT. The resolution matches mTextDirection if that is
2573 * not TEXT_DIRECTION_INHERIT, otherwise resolution proceeds up the parent
2574 * chain of the view.
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002575 *
2576 * {@hide}
2577 */
2578 @ViewDebug.ExportedProperty(category = "text", mapping = {
Doug Feltcb3791202011-07-07 11:57:48 -07002579 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"),
2580 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"),
2581 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"),
2582 @ViewDebug.IntToString(from = TEXT_DIRECTION_CHAR_COUNT, to = "CHAR_COUNT"),
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002583 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"),
2584 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL")
2585 })
Doug Feltcb3791202011-07-07 11:57:48 -07002586 private int mResolvedTextDirection = TEXT_DIRECTION_INHERIT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002587
2588 /**
Jeff Brown21bc5c92011-02-28 18:27:14 -08002589 * Consistency verifier for debugging purposes.
2590 * @hide
2591 */
2592 protected final InputEventConsistencyVerifier mInputEventConsistencyVerifier =
2593 InputEventConsistencyVerifier.isInstrumentationEnabled() ?
2594 new InputEventConsistencyVerifier(this, 0) : null;
2595
2596 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002597 * Simple constructor to use when creating a view from code.
2598 *
2599 * @param context The Context the view is running in, through which it can
2600 * access the current theme, resources, etc.
2601 */
2602 public View(Context context) {
2603 mContext = context;
2604 mResources = context != null ? context.getResources() : null;
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002605 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED | LAYOUT_DIRECTION_INHERIT;
Adam Powelle14579b2009-12-16 18:39:52 -08002606 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop();
Adam Powell637d3372010-08-25 14:37:03 -07002607 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS);
Fabrice Di Megliof9e36502011-06-21 18:41:48 -07002608 mUserPaddingStart = -1;
2609 mUserPaddingEnd = -1;
2610 mUserPaddingRelative = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002611 }
2612
2613 /**
2614 * Constructor that is called when inflating a view from XML. This is called
2615 * when a view is being constructed from an XML file, supplying attributes
2616 * that were specified in the XML file. This version uses a default style of
2617 * 0, so the only attribute values applied are those in the Context's Theme
2618 * and the given AttributeSet.
2619 *
2620 * <p>
2621 * The method onFinishInflate() will be called after all children have been
2622 * added.
2623 *
2624 * @param context The Context the view is running in, through which it can
2625 * access the current theme, resources, etc.
2626 * @param attrs The attributes of the XML tag that is inflating the view.
2627 * @see #View(Context, AttributeSet, int)
2628 */
2629 public View(Context context, AttributeSet attrs) {
2630 this(context, attrs, 0);
2631 }
2632
2633 /**
2634 * Perform inflation from XML and apply a class-specific base style. This
2635 * constructor of View allows subclasses to use their own base style when
2636 * they are inflating. For example, a Button class's constructor would call
2637 * this version of the super class constructor and supply
2638 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
2639 * the theme's button style to modify all of the base view attributes (in
2640 * particular its background) as well as the Button class's attributes.
2641 *
2642 * @param context The Context the view is running in, through which it can
2643 * access the current theme, resources, etc.
2644 * @param attrs The attributes of the XML tag that is inflating the view.
2645 * @param defStyle The default style to apply to this view. If 0, no style
2646 * will be applied (beyond what is included in the theme). This may
2647 * either be an attribute resource, whose value will be retrieved
2648 * from the current theme, or an explicit style resource.
2649 * @see #View(Context, AttributeSet)
2650 */
2651 public View(Context context, AttributeSet attrs, int defStyle) {
2652 this(context);
2653
2654 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
2655 defStyle, 0);
2656
2657 Drawable background = null;
2658
2659 int leftPadding = -1;
2660 int topPadding = -1;
2661 int rightPadding = -1;
2662 int bottomPadding = -1;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07002663 int startPadding = -1;
2664 int endPadding = -1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002665
2666 int padding = -1;
2667
2668 int viewFlagValues = 0;
2669 int viewFlagMasks = 0;
2670
2671 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07002672
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002673 int x = 0;
2674 int y = 0;
2675
Chet Haase73066682010-11-29 15:55:32 -08002676 float tx = 0;
2677 float ty = 0;
2678 float rotation = 0;
2679 float rotationX = 0;
2680 float rotationY = 0;
2681 float sx = 1f;
2682 float sy = 1f;
2683 boolean transformSet = false;
2684
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002685 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
2686
Adam Powell637d3372010-08-25 14:37:03 -07002687 int overScrollMode = mOverScrollMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002688 final int N = a.getIndexCount();
2689 for (int i = 0; i < N; i++) {
2690 int attr = a.getIndex(i);
2691 switch (attr) {
2692 case com.android.internal.R.styleable.View_background:
2693 background = a.getDrawable(attr);
2694 break;
2695 case com.android.internal.R.styleable.View_padding:
2696 padding = a.getDimensionPixelSize(attr, -1);
2697 break;
2698 case com.android.internal.R.styleable.View_paddingLeft:
2699 leftPadding = a.getDimensionPixelSize(attr, -1);
2700 break;
2701 case com.android.internal.R.styleable.View_paddingTop:
2702 topPadding = a.getDimensionPixelSize(attr, -1);
2703 break;
2704 case com.android.internal.R.styleable.View_paddingRight:
2705 rightPadding = a.getDimensionPixelSize(attr, -1);
2706 break;
2707 case com.android.internal.R.styleable.View_paddingBottom:
2708 bottomPadding = a.getDimensionPixelSize(attr, -1);
2709 break;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07002710 case com.android.internal.R.styleable.View_paddingStart:
2711 startPadding = a.getDimensionPixelSize(attr, -1);
2712 break;
2713 case com.android.internal.R.styleable.View_paddingEnd:
2714 endPadding = a.getDimensionPixelSize(attr, -1);
2715 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002716 case com.android.internal.R.styleable.View_scrollX:
2717 x = a.getDimensionPixelOffset(attr, 0);
2718 break;
2719 case com.android.internal.R.styleable.View_scrollY:
2720 y = a.getDimensionPixelOffset(attr, 0);
2721 break;
Chet Haase73066682010-11-29 15:55:32 -08002722 case com.android.internal.R.styleable.View_alpha:
2723 setAlpha(a.getFloat(attr, 1f));
2724 break;
2725 case com.android.internal.R.styleable.View_transformPivotX:
2726 setPivotX(a.getDimensionPixelOffset(attr, 0));
2727 break;
2728 case com.android.internal.R.styleable.View_transformPivotY:
2729 setPivotY(a.getDimensionPixelOffset(attr, 0));
2730 break;
2731 case com.android.internal.R.styleable.View_translationX:
2732 tx = a.getDimensionPixelOffset(attr, 0);
2733 transformSet = true;
2734 break;
2735 case com.android.internal.R.styleable.View_translationY:
2736 ty = a.getDimensionPixelOffset(attr, 0);
2737 transformSet = true;
2738 break;
2739 case com.android.internal.R.styleable.View_rotation:
2740 rotation = a.getFloat(attr, 0);
2741 transformSet = true;
2742 break;
2743 case com.android.internal.R.styleable.View_rotationX:
2744 rotationX = a.getFloat(attr, 0);
2745 transformSet = true;
2746 break;
2747 case com.android.internal.R.styleable.View_rotationY:
2748 rotationY = a.getFloat(attr, 0);
2749 transformSet = true;
2750 break;
2751 case com.android.internal.R.styleable.View_scaleX:
2752 sx = a.getFloat(attr, 1f);
2753 transformSet = true;
2754 break;
2755 case com.android.internal.R.styleable.View_scaleY:
2756 sy = a.getFloat(attr, 1f);
2757 transformSet = true;
2758 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002759 case com.android.internal.R.styleable.View_id:
2760 mID = a.getResourceId(attr, NO_ID);
2761 break;
2762 case com.android.internal.R.styleable.View_tag:
2763 mTag = a.getText(attr);
2764 break;
2765 case com.android.internal.R.styleable.View_fitsSystemWindows:
2766 if (a.getBoolean(attr, false)) {
2767 viewFlagValues |= FITS_SYSTEM_WINDOWS;
2768 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
2769 }
2770 break;
2771 case com.android.internal.R.styleable.View_focusable:
2772 if (a.getBoolean(attr, false)) {
2773 viewFlagValues |= FOCUSABLE;
2774 viewFlagMasks |= FOCUSABLE_MASK;
2775 }
2776 break;
2777 case com.android.internal.R.styleable.View_focusableInTouchMode:
2778 if (a.getBoolean(attr, false)) {
2779 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
2780 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
2781 }
2782 break;
2783 case com.android.internal.R.styleable.View_clickable:
2784 if (a.getBoolean(attr, false)) {
2785 viewFlagValues |= CLICKABLE;
2786 viewFlagMasks |= CLICKABLE;
2787 }
2788 break;
2789 case com.android.internal.R.styleable.View_longClickable:
2790 if (a.getBoolean(attr, false)) {
2791 viewFlagValues |= LONG_CLICKABLE;
2792 viewFlagMasks |= LONG_CLICKABLE;
2793 }
2794 break;
2795 case com.android.internal.R.styleable.View_saveEnabled:
2796 if (!a.getBoolean(attr, true)) {
2797 viewFlagValues |= SAVE_DISABLED;
2798 viewFlagMasks |= SAVE_DISABLED_MASK;
2799 }
2800 break;
2801 case com.android.internal.R.styleable.View_duplicateParentState:
2802 if (a.getBoolean(attr, false)) {
2803 viewFlagValues |= DUPLICATE_PARENT_STATE;
2804 viewFlagMasks |= DUPLICATE_PARENT_STATE;
2805 }
2806 break;
2807 case com.android.internal.R.styleable.View_visibility:
2808 final int visibility = a.getInt(attr, 0);
2809 if (visibility != 0) {
2810 viewFlagValues |= VISIBILITY_FLAGS[visibility];
2811 viewFlagMasks |= VISIBILITY_MASK;
2812 }
2813 break;
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002814 case com.android.internal.R.styleable.View_layoutDirection:
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07002815 // Clear any HORIZONTAL_DIRECTION flag already set
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002816 viewFlagValues &= ~LAYOUT_DIRECTION_MASK;
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07002817 // Set the HORIZONTAL_DIRECTION flags depending on the value of the attribute
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002818 final int layoutDirection = a.getInt(attr, -1);
2819 if (layoutDirection != -1) {
2820 viewFlagValues |= LAYOUT_DIRECTION_FLAGS[layoutDirection];
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07002821 } else {
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002822 // Set to default (LAYOUT_DIRECTION_INHERIT)
2823 viewFlagValues |= LAYOUT_DIRECTION_DEFAULT;
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07002824 }
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002825 viewFlagMasks |= LAYOUT_DIRECTION_MASK;
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07002826 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002827 case com.android.internal.R.styleable.View_drawingCacheQuality:
2828 final int cacheQuality = a.getInt(attr, 0);
2829 if (cacheQuality != 0) {
2830 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
2831 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
2832 }
2833 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07002834 case com.android.internal.R.styleable.View_contentDescription:
2835 mContentDescription = a.getString(attr);
2836 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002837 case com.android.internal.R.styleable.View_soundEffectsEnabled:
2838 if (!a.getBoolean(attr, true)) {
2839 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
2840 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
2841 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002842 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002843 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
2844 if (!a.getBoolean(attr, true)) {
2845 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
2846 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
2847 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002848 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002849 case R.styleable.View_scrollbars:
2850 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
2851 if (scrollbars != SCROLLBARS_NONE) {
2852 viewFlagValues |= scrollbars;
2853 viewFlagMasks |= SCROLLBARS_MASK;
2854 initializeScrollbars(a);
2855 }
2856 break;
2857 case R.styleable.View_fadingEdge:
2858 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
2859 if (fadingEdge != FADING_EDGE_NONE) {
2860 viewFlagValues |= fadingEdge;
2861 viewFlagMasks |= FADING_EDGE_MASK;
2862 initializeFadingEdge(a);
2863 }
2864 break;
2865 case R.styleable.View_scrollbarStyle:
2866 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
2867 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2868 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
2869 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
2870 }
2871 break;
2872 case R.styleable.View_isScrollContainer:
2873 setScrollContainer = true;
2874 if (a.getBoolean(attr, false)) {
2875 setScrollContainer(true);
2876 }
2877 break;
2878 case com.android.internal.R.styleable.View_keepScreenOn:
2879 if (a.getBoolean(attr, false)) {
2880 viewFlagValues |= KEEP_SCREEN_ON;
2881 viewFlagMasks |= KEEP_SCREEN_ON;
2882 }
2883 break;
Jeff Brown85a31762010-09-01 17:01:00 -07002884 case R.styleable.View_filterTouchesWhenObscured:
2885 if (a.getBoolean(attr, false)) {
2886 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED;
2887 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED;
2888 }
2889 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002890 case R.styleable.View_nextFocusLeft:
2891 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
2892 break;
2893 case R.styleable.View_nextFocusRight:
2894 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
2895 break;
2896 case R.styleable.View_nextFocusUp:
2897 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
2898 break;
2899 case R.styleable.View_nextFocusDown:
2900 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
2901 break;
Jeff Brown4e6319b2010-12-13 10:36:51 -08002902 case R.styleable.View_nextFocusForward:
2903 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID);
2904 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002905 case R.styleable.View_minWidth:
2906 mMinWidth = a.getDimensionPixelSize(attr, 0);
2907 break;
2908 case R.styleable.View_minHeight:
2909 mMinHeight = a.getDimensionPixelSize(attr, 0);
2910 break;
Romain Guy9a817362009-05-01 10:57:14 -07002911 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07002912 if (context.isRestricted()) {
Joe Malin32736f02011-01-19 16:14:20 -08002913 throw new IllegalStateException("The android:onClick attribute cannot "
Romain Guy870e09f2009-07-06 16:35:25 -07002914 + "be used within a restricted context");
2915 }
2916
Romain Guy9a817362009-05-01 10:57:14 -07002917 final String handlerName = a.getString(attr);
2918 if (handlerName != null) {
2919 setOnClickListener(new OnClickListener() {
2920 private Method mHandler;
2921
2922 public void onClick(View v) {
2923 if (mHandler == null) {
2924 try {
2925 mHandler = getContext().getClass().getMethod(handlerName,
2926 View.class);
2927 } catch (NoSuchMethodException e) {
Joe Onorato42e14d72010-03-11 14:51:17 -08002928 int id = getId();
2929 String idText = id == NO_ID ? "" : " with id '"
2930 + getContext().getResources().getResourceEntryName(
2931 id) + "'";
Romain Guy9a817362009-05-01 10:57:14 -07002932 throw new IllegalStateException("Could not find a method " +
Joe Onorato42e14d72010-03-11 14:51:17 -08002933 handlerName + "(View) in the activity "
2934 + getContext().getClass() + " for onClick handler"
2935 + " on view " + View.this.getClass() + idText, e);
Romain Guy9a817362009-05-01 10:57:14 -07002936 }
2937 }
2938
2939 try {
2940 mHandler.invoke(getContext(), View.this);
2941 } catch (IllegalAccessException e) {
2942 throw new IllegalStateException("Could not execute non "
2943 + "public method of the activity", e);
2944 } catch (InvocationTargetException e) {
2945 throw new IllegalStateException("Could not execute "
2946 + "method of the activity", e);
2947 }
2948 }
2949 });
2950 }
2951 break;
Adam Powell637d3372010-08-25 14:37:03 -07002952 case R.styleable.View_overScrollMode:
2953 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS);
2954 break;
Adam Powell20232d02010-12-08 21:08:53 -08002955 case R.styleable.View_verticalScrollbarPosition:
2956 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT);
2957 break;
Romain Guy171c5922011-01-06 10:04:23 -08002958 case R.styleable.View_layerType:
2959 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null);
2960 break;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002961 case R.styleable.View_textDirection:
2962 mTextDirection = a.getInt(attr, DEFAULT_TEXT_DIRECTION);
2963 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002964 }
2965 }
2966
Adam Powell637d3372010-08-25 14:37:03 -07002967 setOverScrollMode(overScrollMode);
2968
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002969 if (background != null) {
2970 setBackgroundDrawable(background);
2971 }
2972
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07002973 mUserPaddingRelative = (startPadding >= 0 || endPadding >= 0);
2974
Fabrice Di Megliof9e36502011-06-21 18:41:48 -07002975 // Cache user padding as we cannot fully resolve padding here (we dont have yet the resolved
2976 // layout direction). Those cached values will be used later during padding resolution.
2977 mUserPaddingStart = startPadding;
2978 mUserPaddingEnd = endPadding;
2979
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002980 if (padding >= 0) {
2981 leftPadding = padding;
2982 topPadding = padding;
2983 rightPadding = padding;
2984 bottomPadding = padding;
2985 }
2986
2987 // If the user specified the padding (either with android:padding or
2988 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
2989 // use the default padding or the padding from the background drawable
2990 // (stored at this point in mPadding*)
2991 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
2992 topPadding >= 0 ? topPadding : mPaddingTop,
2993 rightPadding >= 0 ? rightPadding : mPaddingRight,
2994 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
2995
2996 if (viewFlagMasks != 0) {
2997 setFlags(viewFlagValues, viewFlagMasks);
2998 }
2999
3000 // Needs to be called after mViewFlags is set
3001 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
3002 recomputePadding();
3003 }
3004
3005 if (x != 0 || y != 0) {
3006 scrollTo(x, y);
3007 }
3008
Chet Haase73066682010-11-29 15:55:32 -08003009 if (transformSet) {
3010 setTranslationX(tx);
3011 setTranslationY(ty);
3012 setRotation(rotation);
3013 setRotationX(rotationX);
3014 setRotationY(rotationY);
3015 setScaleX(sx);
3016 setScaleY(sy);
3017 }
3018
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003019 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
3020 setScrollContainer(true);
3021 }
Romain Guy8f1344f52009-05-15 16:03:59 -07003022
3023 computeOpaqueFlags();
3024
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003025 a.recycle();
3026 }
3027
3028 /**
3029 * Non-public constructor for use in testing
3030 */
3031 View() {
3032 }
3033
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003034 /**
3035 * <p>
3036 * Initializes the fading edges from a given set of styled attributes. This
3037 * method should be called by subclasses that need fading edges and when an
3038 * instance of these subclasses is created programmatically rather than
3039 * being inflated from XML. This method is automatically called when the XML
3040 * is inflated.
3041 * </p>
3042 *
3043 * @param a the styled attributes set to initialize the fading edges from
3044 */
3045 protected void initializeFadingEdge(TypedArray a) {
3046 initScrollCache();
3047
3048 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
3049 R.styleable.View_fadingEdgeLength,
3050 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
3051 }
3052
3053 /**
3054 * Returns the size of the vertical faded edges used to indicate that more
3055 * content in this view is visible.
3056 *
3057 * @return The size in pixels of the vertical faded edge or 0 if vertical
3058 * faded edges are not enabled for this view.
3059 * @attr ref android.R.styleable#View_fadingEdgeLength
3060 */
3061 public int getVerticalFadingEdgeLength() {
3062 if (isVerticalFadingEdgeEnabled()) {
3063 ScrollabilityCache cache = mScrollCache;
3064 if (cache != null) {
3065 return cache.fadingEdgeLength;
3066 }
3067 }
3068 return 0;
3069 }
3070
3071 /**
3072 * Set the size of the faded edge used to indicate that more content in this
3073 * view is available. Will not change whether the fading edge is enabled; use
Romain Guy5c22a8c2011-05-13 11:48:45 -07003074 * {@link #setVerticalFadingEdgeEnabled(boolean)} or
3075 * {@link #setHorizontalFadingEdgeEnabled(boolean)} to enable the fading edge
3076 * for the vertical or horizontal fading edges.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003077 *
3078 * @param length The size in pixels of the faded edge used to indicate that more
3079 * content in this view is visible.
3080 */
3081 public void setFadingEdgeLength(int length) {
3082 initScrollCache();
3083 mScrollCache.fadingEdgeLength = length;
3084 }
3085
3086 /**
3087 * Returns the size of the horizontal faded edges used to indicate that more
3088 * content in this view is visible.
3089 *
3090 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
3091 * faded edges are not enabled for this view.
3092 * @attr ref android.R.styleable#View_fadingEdgeLength
3093 */
3094 public int getHorizontalFadingEdgeLength() {
3095 if (isHorizontalFadingEdgeEnabled()) {
3096 ScrollabilityCache cache = mScrollCache;
3097 if (cache != null) {
3098 return cache.fadingEdgeLength;
3099 }
3100 }
3101 return 0;
3102 }
3103
3104 /**
3105 * Returns the width of the vertical scrollbar.
3106 *
3107 * @return The width in pixels of the vertical scrollbar or 0 if there
3108 * is no vertical scrollbar.
3109 */
3110 public int getVerticalScrollbarWidth() {
3111 ScrollabilityCache cache = mScrollCache;
3112 if (cache != null) {
3113 ScrollBarDrawable scrollBar = cache.scrollBar;
3114 if (scrollBar != null) {
3115 int size = scrollBar.getSize(true);
3116 if (size <= 0) {
3117 size = cache.scrollBarSize;
3118 }
3119 return size;
3120 }
3121 return 0;
3122 }
3123 return 0;
3124 }
3125
3126 /**
3127 * Returns the height of the horizontal scrollbar.
3128 *
3129 * @return The height in pixels of the horizontal scrollbar or 0 if
3130 * there is no horizontal scrollbar.
3131 */
3132 protected int getHorizontalScrollbarHeight() {
3133 ScrollabilityCache cache = mScrollCache;
3134 if (cache != null) {
3135 ScrollBarDrawable scrollBar = cache.scrollBar;
3136 if (scrollBar != null) {
3137 int size = scrollBar.getSize(false);
3138 if (size <= 0) {
3139 size = cache.scrollBarSize;
3140 }
3141 return size;
3142 }
3143 return 0;
3144 }
3145 return 0;
3146 }
3147
3148 /**
3149 * <p>
3150 * Initializes the scrollbars from a given set of styled attributes. This
3151 * method should be called by subclasses that need scrollbars and when an
3152 * instance of these subclasses is created programmatically rather than
3153 * being inflated from XML. This method is automatically called when the XML
3154 * is inflated.
3155 * </p>
3156 *
3157 * @param a the styled attributes set to initialize the scrollbars from
3158 */
3159 protected void initializeScrollbars(TypedArray a) {
3160 initScrollCache();
3161
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003162 final ScrollabilityCache scrollabilityCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08003163
Mike Cleronf116bf82009-09-27 19:14:12 -07003164 if (scrollabilityCache.scrollBar == null) {
3165 scrollabilityCache.scrollBar = new ScrollBarDrawable();
3166 }
Joe Malin32736f02011-01-19 16:14:20 -08003167
Romain Guy8bda2482010-03-02 11:42:11 -08003168 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003169
Mike Cleronf116bf82009-09-27 19:14:12 -07003170 if (!fadeScrollbars) {
3171 scrollabilityCache.state = ScrollabilityCache.ON;
3172 }
3173 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Joe Malin32736f02011-01-19 16:14:20 -08003174
3175
Mike Cleronf116bf82009-09-27 19:14:12 -07003176 scrollabilityCache.scrollBarFadeDuration = a.getInt(
3177 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
3178 .getScrollBarFadeDuration());
3179 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
3180 R.styleable.View_scrollbarDefaultDelayBeforeFade,
3181 ViewConfiguration.getScrollDefaultDelay());
3182
Joe Malin32736f02011-01-19 16:14:20 -08003183
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003184 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
3185 com.android.internal.R.styleable.View_scrollbarSize,
3186 ViewConfiguration.get(mContext).getScaledScrollBarSize());
3187
3188 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
3189 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
3190
3191 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
3192 if (thumb != null) {
3193 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
3194 }
3195
3196 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
3197 false);
3198 if (alwaysDraw) {
3199 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
3200 }
3201
3202 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
3203 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
3204
3205 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
3206 if (thumb != null) {
3207 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
3208 }
3209
3210 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
3211 false);
3212 if (alwaysDraw) {
3213 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
3214 }
3215
3216 // Re-apply user/background padding so that scrollbar(s) get added
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003217 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003218 }
3219
3220 /**
3221 * <p>
3222 * Initalizes the scrollability cache if necessary.
3223 * </p>
3224 */
3225 private void initScrollCache() {
3226 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07003227 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003228 }
3229 }
3230
3231 /**
Adam Powell20232d02010-12-08 21:08:53 -08003232 * Set the position of the vertical scroll bar. Should be one of
3233 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or
3234 * {@link #SCROLLBAR_POSITION_RIGHT}.
3235 *
3236 * @param position Where the vertical scroll bar should be positioned.
3237 */
3238 public void setVerticalScrollbarPosition(int position) {
3239 if (mVerticalScrollbarPosition != position) {
3240 mVerticalScrollbarPosition = position;
3241 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003242 resolvePadding();
Adam Powell20232d02010-12-08 21:08:53 -08003243 }
3244 }
3245
3246 /**
3247 * @return The position where the vertical scroll bar will show, if applicable.
3248 * @see #setVerticalScrollbarPosition(int)
3249 */
3250 public int getVerticalScrollbarPosition() {
3251 return mVerticalScrollbarPosition;
3252 }
3253
3254 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003255 * Register a callback to be invoked when focus of this view changed.
3256 *
3257 * @param l The callback that will run.
3258 */
3259 public void setOnFocusChangeListener(OnFocusChangeListener l) {
3260 mOnFocusChangeListener = l;
3261 }
3262
3263 /**
Chet Haase21cd1382010-09-01 17:42:29 -07003264 * Add a listener that will be called when the bounds of the view change due to
3265 * layout processing.
3266 *
3267 * @param listener The listener that will be called when layout bounds change.
3268 */
3269 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) {
3270 if (mOnLayoutChangeListeners == null) {
3271 mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>();
3272 }
3273 mOnLayoutChangeListeners.add(listener);
3274 }
3275
3276 /**
3277 * Remove a listener for layout changes.
3278 *
3279 * @param listener The listener for layout bounds change.
3280 */
3281 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) {
3282 if (mOnLayoutChangeListeners == null) {
3283 return;
3284 }
3285 mOnLayoutChangeListeners.remove(listener);
3286 }
3287
3288 /**
Adam Powell4afd62b2011-02-18 15:02:18 -08003289 * Add a listener for attach state changes.
3290 *
3291 * This listener will be called whenever this view is attached or detached
3292 * from a window. Remove the listener using
3293 * {@link #removeOnAttachStateChangeListener(OnAttachStateChangeListener)}.
3294 *
3295 * @param listener Listener to attach
3296 * @see #removeOnAttachStateChangeListener(OnAttachStateChangeListener)
3297 */
3298 public void addOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
3299 if (mOnAttachStateChangeListeners == null) {
3300 mOnAttachStateChangeListeners = new CopyOnWriteArrayList<OnAttachStateChangeListener>();
3301 }
3302 mOnAttachStateChangeListeners.add(listener);
3303 }
3304
3305 /**
3306 * Remove a listener for attach state changes. The listener will receive no further
3307 * notification of window attach/detach events.
3308 *
3309 * @param listener Listener to remove
3310 * @see #addOnAttachStateChangeListener(OnAttachStateChangeListener)
3311 */
3312 public void removeOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
3313 if (mOnAttachStateChangeListeners == null) {
3314 return;
3315 }
3316 mOnAttachStateChangeListeners.remove(listener);
3317 }
3318
3319 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003320 * Returns the focus-change callback registered for this view.
3321 *
3322 * @return The callback, or null if one is not registered.
3323 */
3324 public OnFocusChangeListener getOnFocusChangeListener() {
3325 return mOnFocusChangeListener;
3326 }
3327
3328 /**
3329 * Register a callback to be invoked when this view is clicked. If this view is not
3330 * clickable, it becomes clickable.
3331 *
3332 * @param l The callback that will run
3333 *
3334 * @see #setClickable(boolean)
3335 */
3336 public void setOnClickListener(OnClickListener l) {
3337 if (!isClickable()) {
3338 setClickable(true);
3339 }
3340 mOnClickListener = l;
3341 }
3342
3343 /**
3344 * Register a callback to be invoked when this view is clicked and held. If this view is not
3345 * long clickable, it becomes long clickable.
3346 *
3347 * @param l The callback that will run
3348 *
3349 * @see #setLongClickable(boolean)
3350 */
3351 public void setOnLongClickListener(OnLongClickListener l) {
3352 if (!isLongClickable()) {
3353 setLongClickable(true);
3354 }
3355 mOnLongClickListener = l;
3356 }
3357
3358 /**
3359 * Register a callback to be invoked when the context menu for this view is
3360 * being built. If this view is not long clickable, it becomes long clickable.
3361 *
3362 * @param l The callback that will run
3363 *
3364 */
3365 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
3366 if (!isLongClickable()) {
3367 setLongClickable(true);
3368 }
3369 mOnCreateContextMenuListener = l;
3370 }
3371
3372 /**
3373 * Call this view's OnClickListener, if it is defined.
3374 *
3375 * @return True there was an assigned OnClickListener that was called, false
3376 * otherwise is returned.
3377 */
3378 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003379 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
3380
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003381 if (mOnClickListener != null) {
3382 playSoundEffect(SoundEffectConstants.CLICK);
3383 mOnClickListener.onClick(this);
3384 return true;
3385 }
3386
3387 return false;
3388 }
3389
3390 /**
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003391 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the
3392 * OnLongClickListener did not consume the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003393 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003394 * @return True if one of the above receivers consumed the event, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003395 */
3396 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003397 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
3398
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003399 boolean handled = false;
3400 if (mOnLongClickListener != null) {
3401 handled = mOnLongClickListener.onLongClick(View.this);
3402 }
3403 if (!handled) {
3404 handled = showContextMenu();
3405 }
3406 if (handled) {
3407 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
3408 }
3409 return handled;
3410 }
3411
3412 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07003413 * Performs button-related actions during a touch down event.
3414 *
3415 * @param event The event.
3416 * @return True if the down was consumed.
3417 *
3418 * @hide
3419 */
3420 protected boolean performButtonActionOnTouchDown(MotionEvent event) {
3421 if ((event.getButtonState() & MotionEvent.BUTTON_SECONDARY) != 0) {
3422 if (showContextMenu(event.getX(), event.getY(), event.getMetaState())) {
3423 return true;
3424 }
3425 }
3426 return false;
3427 }
3428
3429 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003430 * Bring up the context menu for this view.
3431 *
3432 * @return Whether a context menu was displayed.
3433 */
3434 public boolean showContextMenu() {
3435 return getParent().showContextMenuForChild(this);
3436 }
3437
3438 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07003439 * Bring up the context menu for this view, referring to the item under the specified point.
3440 *
3441 * @param x The referenced x coordinate.
3442 * @param y The referenced y coordinate.
3443 * @param metaState The keyboard modifiers that were pressed.
3444 * @return Whether a context menu was displayed.
3445 *
3446 * @hide
3447 */
3448 public boolean showContextMenu(float x, float y, int metaState) {
3449 return showContextMenu();
3450 }
3451
3452 /**
Adam Powell6e346362010-07-23 10:18:23 -07003453 * Start an action mode.
3454 *
3455 * @param callback Callback that will control the lifecycle of the action mode
3456 * @return The new action mode if it is started, null otherwise
3457 *
3458 * @see ActionMode
3459 */
3460 public ActionMode startActionMode(ActionMode.Callback callback) {
3461 return getParent().startActionModeForChild(this, callback);
3462 }
3463
3464 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003465 * Register a callback to be invoked when a key is pressed in this view.
3466 * @param l the key listener to attach to this view
3467 */
3468 public void setOnKeyListener(OnKeyListener l) {
3469 mOnKeyListener = l;
3470 }
3471
3472 /**
3473 * Register a callback to be invoked when a touch event is sent to this view.
3474 * @param l the touch listener to attach to this view
3475 */
3476 public void setOnTouchListener(OnTouchListener l) {
3477 mOnTouchListener = l;
3478 }
3479
3480 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08003481 * Register a callback to be invoked when a generic motion event is sent to this view.
3482 * @param l the generic motion listener to attach to this view
3483 */
3484 public void setOnGenericMotionListener(OnGenericMotionListener l) {
3485 mOnGenericMotionListener = l;
3486 }
3487
3488 /**
Jeff Brown53ca3f12011-06-27 18:36:00 -07003489 * Register a callback to be invoked when a hover event is sent to this view.
3490 * @param l the hover listener to attach to this view
3491 */
3492 public void setOnHoverListener(OnHoverListener l) {
3493 mOnHoverListener = l;
3494 }
3495
3496 /**
Joe Malin32736f02011-01-19 16:14:20 -08003497 * Register a drag event listener callback object for this View. The parameter is
3498 * an implementation of {@link android.view.View.OnDragListener}. To send a drag event to a
3499 * View, the system calls the
3500 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent)} method.
3501 * @param l An implementation of {@link android.view.View.OnDragListener}.
Chris Tate32affef2010-10-18 15:29:21 -07003502 */
3503 public void setOnDragListener(OnDragListener l) {
3504 mOnDragListener = l;
3505 }
3506
3507 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07003508 * Give this view focus. This will cause
3509 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003510 *
3511 * Note: this does not check whether this {@link View} should get focus, it just
3512 * gives it focus no matter what. It should only be called internally by framework
3513 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
3514 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08003515 * @param direction values are {@link View#FOCUS_UP}, {@link View#FOCUS_DOWN},
3516 * {@link View#FOCUS_LEFT} or {@link View#FOCUS_RIGHT}. This is the direction which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003517 * focus moved when requestFocus() is called. It may not always
3518 * apply, in which case use the default View.FOCUS_DOWN.
3519 * @param previouslyFocusedRect The rectangle of the view that had focus
3520 * prior in this View's coordinate system.
3521 */
3522 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
3523 if (DBG) {
3524 System.out.println(this + " requestFocus()");
3525 }
3526
3527 if ((mPrivateFlags & FOCUSED) == 0) {
3528 mPrivateFlags |= FOCUSED;
3529
3530 if (mParent != null) {
3531 mParent.requestChildFocus(this, this);
3532 }
3533
3534 onFocusChanged(true, direction, previouslyFocusedRect);
3535 refreshDrawableState();
3536 }
3537 }
3538
3539 /**
3540 * Request that a rectangle of this view be visible on the screen,
3541 * scrolling if necessary just enough.
3542 *
3543 * <p>A View should call this if it maintains some notion of which part
3544 * of its content is interesting. For example, a text editing view
3545 * should call this when its cursor moves.
3546 *
3547 * @param rectangle The rectangle.
3548 * @return Whether any parent scrolled.
3549 */
3550 public boolean requestRectangleOnScreen(Rect rectangle) {
3551 return requestRectangleOnScreen(rectangle, false);
3552 }
3553
3554 /**
3555 * Request that a rectangle of this view be visible on the screen,
3556 * scrolling if necessary just enough.
3557 *
3558 * <p>A View should call this if it maintains some notion of which part
3559 * of its content is interesting. For example, a text editing view
3560 * should call this when its cursor moves.
3561 *
3562 * <p>When <code>immediate</code> is set to true, scrolling will not be
3563 * animated.
3564 *
3565 * @param rectangle The rectangle.
3566 * @param immediate True to forbid animated scrolling, false otherwise
3567 * @return Whether any parent scrolled.
3568 */
3569 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
3570 View child = this;
3571 ViewParent parent = mParent;
3572 boolean scrolled = false;
3573 while (parent != null) {
3574 scrolled |= parent.requestChildRectangleOnScreen(child,
3575 rectangle, immediate);
3576
3577 // offset rect so next call has the rectangle in the
3578 // coordinate system of its direct child.
3579 rectangle.offset(child.getLeft(), child.getTop());
3580 rectangle.offset(-child.getScrollX(), -child.getScrollY());
3581
3582 if (!(parent instanceof View)) {
3583 break;
3584 }
Romain Guy8506ab42009-06-11 17:35:47 -07003585
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003586 child = (View) parent;
3587 parent = child.getParent();
3588 }
3589 return scrolled;
3590 }
3591
3592 /**
3593 * Called when this view wants to give up focus. This will cause
Romain Guy5c22a8c2011-05-13 11:48:45 -07003594 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003595 */
3596 public void clearFocus() {
3597 if (DBG) {
3598 System.out.println(this + " clearFocus()");
3599 }
3600
3601 if ((mPrivateFlags & FOCUSED) != 0) {
3602 mPrivateFlags &= ~FOCUSED;
3603
3604 if (mParent != null) {
3605 mParent.clearChildFocus(this);
3606 }
3607
3608 onFocusChanged(false, 0, null);
3609 refreshDrawableState();
3610 }
3611 }
3612
3613 /**
3614 * Called to clear the focus of a view that is about to be removed.
3615 * Doesn't call clearChildFocus, which prevents this view from taking
3616 * focus again before it has been removed from the parent
3617 */
3618 void clearFocusForRemoval() {
3619 if ((mPrivateFlags & FOCUSED) != 0) {
3620 mPrivateFlags &= ~FOCUSED;
3621
3622 onFocusChanged(false, 0, null);
3623 refreshDrawableState();
3624 }
3625 }
3626
3627 /**
3628 * Called internally by the view system when a new view is getting focus.
3629 * This is what clears the old focus.
3630 */
3631 void unFocus() {
3632 if (DBG) {
3633 System.out.println(this + " unFocus()");
3634 }
3635
3636 if ((mPrivateFlags & FOCUSED) != 0) {
3637 mPrivateFlags &= ~FOCUSED;
3638
3639 onFocusChanged(false, 0, null);
3640 refreshDrawableState();
3641 }
3642 }
3643
3644 /**
3645 * Returns true if this view has focus iteself, or is the ancestor of the
3646 * view that has focus.
3647 *
3648 * @return True if this view has or contains focus, false otherwise.
3649 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003650 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003651 public boolean hasFocus() {
3652 return (mPrivateFlags & FOCUSED) != 0;
3653 }
3654
3655 /**
3656 * Returns true if this view is focusable or if it contains a reachable View
3657 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
3658 * is a View whose parents do not block descendants focus.
3659 *
3660 * Only {@link #VISIBLE} views are considered focusable.
3661 *
3662 * @return True if the view is focusable or if the view contains a focusable
3663 * View, false otherwise.
3664 *
3665 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
3666 */
3667 public boolean hasFocusable() {
3668 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
3669 }
3670
3671 /**
3672 * Called by the view system when the focus state of this view changes.
3673 * When the focus change event is caused by directional navigation, direction
3674 * and previouslyFocusedRect provide insight into where the focus is coming from.
3675 * When overriding, be sure to call up through to the super class so that
3676 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07003677 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003678 * @param gainFocus True if the View has focus; false otherwise.
3679 * @param direction The direction focus has moved when requestFocus()
3680 * is called to give this view focus. Values are
Jeff Brown4e6319b2010-12-13 10:36:51 -08003681 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT},
3682 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}.
3683 * It may not always apply, in which case use the default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003684 * @param previouslyFocusedRect The rectangle, in this view's coordinate
3685 * system, of the previously focused view. If applicable, this will be
3686 * passed in as finer grained information about where the focus is coming
3687 * from (in addition to direction). Will be <code>null</code> otherwise.
3688 */
3689 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07003690 if (gainFocus) {
3691 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
3692 }
3693
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003694 InputMethodManager imm = InputMethodManager.peekInstance();
3695 if (!gainFocus) {
3696 if (isPressed()) {
3697 setPressed(false);
3698 }
3699 if (imm != null && mAttachInfo != null
3700 && mAttachInfo.mHasWindowFocus) {
3701 imm.focusOut(this);
3702 }
Romain Guya2431d02009-04-30 16:30:00 -07003703 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003704 } else if (imm != null && mAttachInfo != null
3705 && mAttachInfo.mHasWindowFocus) {
3706 imm.focusIn(this);
3707 }
Romain Guy8506ab42009-06-11 17:35:47 -07003708
Romain Guy0fd89bf2011-01-26 15:41:30 -08003709 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003710 if (mOnFocusChangeListener != null) {
3711 mOnFocusChangeListener.onFocusChange(this, gainFocus);
3712 }
Joe Malin32736f02011-01-19 16:14:20 -08003713
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07003714 if (mAttachInfo != null) {
3715 mAttachInfo.mKeyDispatchState.reset(this);
3716 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003717 }
3718
3719 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07003720 * Sends an accessibility event of the given type. If accessiiblity is
3721 * not enabled this method has no effect. The default implementation calls
3722 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)} first
3723 * to populate information about the event source (this View), then calls
3724 * {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} to
3725 * populate the text content of the event source including its descendants,
3726 * and last calls
3727 * {@link ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)}
3728 * on its parent to resuest sending of the event to interested parties.
3729 *
3730 * @param eventType The type of the event to send.
3731 *
3732 * @see #onInitializeAccessibilityEvent(AccessibilityEvent)
3733 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
3734 * @see ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)
svetoslavganov75986cf2009-05-14 22:28:01 -07003735 */
3736 public void sendAccessibilityEvent(int eventType) {
3737 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
3738 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
3739 }
3740 }
3741
3742 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07003743 * This method behaves exactly as {@link #sendAccessibilityEvent(int)} but
3744 * takes as an argument an empty {@link AccessibilityEvent} and does not
3745 * perfrom a check whether accessibility is enabled.
3746 *
3747 * @param event The event to send.
3748 *
3749 * @see #sendAccessibilityEvent(int)
svetoslavganov75986cf2009-05-14 22:28:01 -07003750 */
3751 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
Svetoslav Ganov9cd1eca2011-01-13 14:24:02 -08003752 if (!isShown()) {
3753 return;
3754 }
Svetoslav Ganov30401322011-05-12 18:53:45 -07003755 onInitializeAccessibilityEvent(event);
svetoslavganov75986cf2009-05-14 22:28:01 -07003756 dispatchPopulateAccessibilityEvent(event);
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003757 // In the beginning we called #isShown(), so we know that getParent() is not null.
3758 getParent().requestSendAccessibilityEvent(this, event);
svetoslavganov75986cf2009-05-14 22:28:01 -07003759 }
3760
3761 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07003762 * Dispatches an {@link AccessibilityEvent} to the {@link View} first and then
3763 * to its children for adding their text content to the event. Note that the
3764 * event text is populated in a separate dispatch path since we add to the
3765 * event not only the text of the source but also the text of all its descendants.
3766 * </p>
3767 * A typical implementation will call
3768 * {@link #onPopulateAccessibilityEvent(AccessibilityEvent)} on the this view
3769 * and then call the {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
3770 * on each child. Override this method if custom population of the event text
3771 * content is required.
svetoslavganov75986cf2009-05-14 22:28:01 -07003772 *
3773 * @param event The event.
3774 *
3775 * @return True if the event population was completed.
3776 */
3777 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003778 onPopulateAccessibilityEvent(event);
svetoslavganov75986cf2009-05-14 22:28:01 -07003779 return false;
3780 }
3781
3782 /**
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003783 * Called from {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
Svetoslav Ganov30401322011-05-12 18:53:45 -07003784 * giving a chance to this View to populate the accessibility event with its
3785 * text content. While the implementation is free to modify other event
3786 * attributes this should be performed in
3787 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)}.
3788 * <p>
3789 * Example: Adding formatted date string to an accessibility event in addition
3790 * to the text added by the super implementation.
3791 * </p><p><pre><code>
Svetoslav Ganov30401322011-05-12 18:53:45 -07003792 * public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
3793 * super.onPopulateAccessibilityEvent(event);
3794 * final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY;
3795 * String selectedDateUtterance = DateUtils.formatDateTime(mContext,
3796 * mCurrentDate.getTimeInMillis(), flags);
3797 * event.getText().add(selectedDateUtterance);
3798 * }
3799 * </code></pre></p>
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003800 *
3801 * @param event The accessibility event which to populate.
Svetoslav Ganov30401322011-05-12 18:53:45 -07003802 *
3803 * @see #sendAccessibilityEvent(int)
3804 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003805 */
3806 public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003807 }
3808
3809 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07003810 * Initializes an {@link AccessibilityEvent} with information about the
3811 * the type of the event and this View which is the event source. In other
3812 * words, the source of an accessibility event is the view whose state
3813 * change triggered firing the event.
3814 * <p>
3815 * Example: Setting the password property of an event in addition
3816 * to properties set by the super implementation.
3817 * </p><p><pre><code>
Svetoslav Ganov30401322011-05-12 18:53:45 -07003818 * public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
3819 * super.onInitializeAccessibilityEvent(event);
3820 * event.setPassword(true);
3821 * }
3822 * </code></pre></p>
3823 * @param event The event to initialeze.
3824 *
3825 * @see #sendAccessibilityEvent(int)
3826 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
3827 */
3828 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07003829 event.setSource(this);
Svetoslav Ganov30401322011-05-12 18:53:45 -07003830 event.setClassName(getClass().getName());
3831 event.setPackageName(getContext().getPackageName());
3832 event.setEnabled(isEnabled());
3833 event.setContentDescription(mContentDescription);
3834
Svetoslav Ganova0156172011-06-26 17:55:44 -07003835 final int eventType = event.getEventType();
3836 switch (eventType) {
3837 case AccessibilityEvent.TYPE_VIEW_FOCUSED: {
3838 if (mAttachInfo != null) {
3839 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList;
3840 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD,
3841 FOCUSABLES_ALL);
3842 event.setItemCount(focusablesTempList.size());
3843 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
3844 focusablesTempList.clear();
3845 }
3846 } break;
3847 case AccessibilityEvent.TYPE_VIEW_SCROLLED: {
3848 event.setScrollX(mScrollX);
3849 event.setScrollY(mScrollY);
3850 event.setItemCount(getHeight());
3851 } break;
Svetoslav Ganov30401322011-05-12 18:53:45 -07003852 }
3853 }
3854
3855 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07003856 * Returns an {@link AccessibilityNodeInfo} representing this view from the
3857 * point of view of an {@link android.accessibilityservice.AccessibilityService}.
3858 * This method is responsible for obtaining an accessibility node info from a
3859 * pool of reusable instances and calling
3860 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on this view to
3861 * initialize the former.
3862 * <p>
3863 * Note: The client is responsible for recycling the obtained instance by calling
3864 * {@link AccessibilityNodeInfo#recycle()} to minimize object creation.
3865 * </p>
3866 * @return A populated {@link AccessibilityNodeInfo}.
3867 *
3868 * @see AccessibilityNodeInfo
3869 */
3870 public AccessibilityNodeInfo createAccessibilityNodeInfo() {
3871 AccessibilityNodeInfo info = AccessibilityNodeInfo.obtain(this);
3872 onInitializeAccessibilityNodeInfo(info);
3873 return info;
3874 }
3875
3876 /**
3877 * Initializes an {@link AccessibilityNodeInfo} with information about this view.
3878 * The base implementation sets:
3879 * <ul>
3880 * <li>{@link AccessibilityNodeInfo#setParent(View)},</li>
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07003881 * <li>{@link AccessibilityNodeInfo#setBoundsInParent(Rect)},</li>
3882 * <li>{@link AccessibilityNodeInfo#setBoundsInScreen(Rect)},</li>
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07003883 * <li>{@link AccessibilityNodeInfo#setPackageName(CharSequence)},</li>
3884 * <li>{@link AccessibilityNodeInfo#setClassName(CharSequence)},</li>
3885 * <li>{@link AccessibilityNodeInfo#setContentDescription(CharSequence)},</li>
3886 * <li>{@link AccessibilityNodeInfo#setEnabled(boolean)},</li>
3887 * <li>{@link AccessibilityNodeInfo#setClickable(boolean)},</li>
3888 * <li>{@link AccessibilityNodeInfo#setFocusable(boolean)},</li>
3889 * <li>{@link AccessibilityNodeInfo#setFocused(boolean)},</li>
3890 * <li>{@link AccessibilityNodeInfo#setLongClickable(boolean)},</li>
3891 * <li>{@link AccessibilityNodeInfo#setSelected(boolean)},</li>
3892 * </ul>
3893 * <p>
3894 * Subclasses should override this method, call the super implementation,
3895 * and set additional attributes.
3896 * </p>
3897 * @param info The instance to initialize.
3898 */
3899 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
3900 Rect bounds = mAttachInfo.mTmpInvalRect;
3901 getDrawingRect(bounds);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07003902 info.setBoundsInParent(bounds);
3903
3904 int[] locationOnScreen = mAttachInfo.mInvalidateChildLocation;
3905 getLocationOnScreen(locationOnScreen);
Alan Viverette326804f2011-07-22 16:20:41 -07003906 bounds.offsetTo(0, 0);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07003907 bounds.offset(locationOnScreen[0], locationOnScreen[1]);
3908 info.setBoundsInScreen(bounds);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07003909
3910 ViewParent parent = getParent();
3911 if (parent instanceof View) {
3912 View parentView = (View) parent;
3913 info.setParent(parentView);
3914 }
3915
3916 info.setPackageName(mContext.getPackageName());
3917 info.setClassName(getClass().getName());
3918 info.setContentDescription(getContentDescription());
3919
3920 info.setEnabled(isEnabled());
3921 info.setClickable(isClickable());
3922 info.setFocusable(isFocusable());
3923 info.setFocused(isFocused());
3924 info.setSelected(isSelected());
3925 info.setLongClickable(isLongClickable());
3926
3927 // TODO: These make sense only if we are in an AdapterView but all
3928 // views can be selected. Maybe from accessiiblity perspective
3929 // we should report as selectable view in an AdapterView.
3930 info.addAction(AccessibilityNodeInfo.ACTION_SELECT);
3931 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION);
3932
3933 if (isFocusable()) {
3934 if (isFocused()) {
3935 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS);
3936 } else {
3937 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS);
3938 }
3939 }
3940 }
3941
3942 /**
3943 * Gets the unique identifier of this view on the screen for accessibility purposes.
3944 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned.
3945 *
3946 * @return The view accessibility id.
3947 *
3948 * @hide
3949 */
3950 public int getAccessibilityViewId() {
3951 if (mAccessibilityViewId == NO_ID) {
3952 mAccessibilityViewId = sNextAccessibilityViewId++;
3953 }
3954 return mAccessibilityViewId;
3955 }
3956
3957 /**
3958 * Gets the unique identifier of the window in which this View reseides.
3959 *
3960 * @return The window accessibility id.
3961 *
3962 * @hide
3963 */
3964 public int getAccessibilityWindowId() {
3965 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId : NO_ID;
3966 }
3967
3968 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07003969 * Gets the {@link View} description. It briefly describes the view and is
3970 * primarily used for accessibility support. Set this property to enable
3971 * better accessibility support for your application. This is especially
3972 * true for views that do not have textual representation (For example,
3973 * ImageButton).
3974 *
3975 * @return The content descriptiopn.
3976 *
3977 * @attr ref android.R.styleable#View_contentDescription
3978 */
3979 public CharSequence getContentDescription() {
3980 return mContentDescription;
3981 }
3982
3983 /**
3984 * Sets the {@link View} description. It briefly describes the view and is
3985 * primarily used for accessibility support. Set this property to enable
3986 * better accessibility support for your application. This is especially
3987 * true for views that do not have textual representation (For example,
3988 * ImageButton).
3989 *
3990 * @param contentDescription The content description.
3991 *
3992 * @attr ref android.R.styleable#View_contentDescription
3993 */
3994 public void setContentDescription(CharSequence contentDescription) {
3995 mContentDescription = contentDescription;
3996 }
3997
3998 /**
Romain Guya2431d02009-04-30 16:30:00 -07003999 * Invoked whenever this view loses focus, either by losing window focus or by losing
4000 * focus within its window. This method can be used to clear any state tied to the
4001 * focus. For instance, if a button is held pressed with the trackball and the window
4002 * loses focus, this method can be used to cancel the press.
4003 *
4004 * Subclasses of View overriding this method should always call super.onFocusLost().
4005 *
4006 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07004007 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07004008 *
4009 * @hide pending API council approval
4010 */
4011 protected void onFocusLost() {
4012 resetPressedState();
4013 }
4014
4015 private void resetPressedState() {
4016 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4017 return;
4018 }
4019
4020 if (isPressed()) {
4021 setPressed(false);
4022
4023 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05004024 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004025 }
4026 }
4027 }
4028
4029 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004030 * Returns true if this view has focus
4031 *
4032 * @return True if this view has focus, false otherwise.
4033 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004034 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004035 public boolean isFocused() {
4036 return (mPrivateFlags & FOCUSED) != 0;
4037 }
4038
4039 /**
4040 * Find the view in the hierarchy rooted at this view that currently has
4041 * focus.
4042 *
4043 * @return The view that currently has focus, or null if no focused view can
4044 * be found.
4045 */
4046 public View findFocus() {
4047 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
4048 }
4049
4050 /**
4051 * Change whether this view is one of the set of scrollable containers in
4052 * its window. This will be used to determine whether the window can
4053 * resize or must pan when a soft input area is open -- scrollable
4054 * containers allow the window to use resize mode since the container
4055 * will appropriately shrink.
4056 */
4057 public void setScrollContainer(boolean isScrollContainer) {
4058 if (isScrollContainer) {
4059 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
4060 mAttachInfo.mScrollContainers.add(this);
4061 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
4062 }
4063 mPrivateFlags |= SCROLL_CONTAINER;
4064 } else {
4065 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
4066 mAttachInfo.mScrollContainers.remove(this);
4067 }
4068 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
4069 }
4070 }
4071
4072 /**
4073 * Returns the quality of the drawing cache.
4074 *
4075 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
4076 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
4077 *
4078 * @see #setDrawingCacheQuality(int)
4079 * @see #setDrawingCacheEnabled(boolean)
4080 * @see #isDrawingCacheEnabled()
4081 *
4082 * @attr ref android.R.styleable#View_drawingCacheQuality
4083 */
4084 public int getDrawingCacheQuality() {
4085 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
4086 }
4087
4088 /**
4089 * Set the drawing cache quality of this view. This value is used only when the
4090 * drawing cache is enabled
4091 *
4092 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
4093 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
4094 *
4095 * @see #getDrawingCacheQuality()
4096 * @see #setDrawingCacheEnabled(boolean)
4097 * @see #isDrawingCacheEnabled()
4098 *
4099 * @attr ref android.R.styleable#View_drawingCacheQuality
4100 */
4101 public void setDrawingCacheQuality(int quality) {
4102 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
4103 }
4104
4105 /**
4106 * Returns whether the screen should remain on, corresponding to the current
4107 * value of {@link #KEEP_SCREEN_ON}.
4108 *
4109 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
4110 *
4111 * @see #setKeepScreenOn(boolean)
4112 *
4113 * @attr ref android.R.styleable#View_keepScreenOn
4114 */
4115 public boolean getKeepScreenOn() {
4116 return (mViewFlags & KEEP_SCREEN_ON) != 0;
4117 }
4118
4119 /**
4120 * Controls whether the screen should remain on, modifying the
4121 * value of {@link #KEEP_SCREEN_ON}.
4122 *
4123 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
4124 *
4125 * @see #getKeepScreenOn()
4126 *
4127 * @attr ref android.R.styleable#View_keepScreenOn
4128 */
4129 public void setKeepScreenOn(boolean keepScreenOn) {
4130 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
4131 }
4132
4133 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004134 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
4135 * @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 -08004136 *
4137 * @attr ref android.R.styleable#View_nextFocusLeft
4138 */
4139 public int getNextFocusLeftId() {
4140 return mNextFocusLeftId;
4141 }
4142
4143 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004144 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
4145 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
4146 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004147 *
4148 * @attr ref android.R.styleable#View_nextFocusLeft
4149 */
4150 public void setNextFocusLeftId(int nextFocusLeftId) {
4151 mNextFocusLeftId = nextFocusLeftId;
4152 }
4153
4154 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004155 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
4156 * @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 -08004157 *
4158 * @attr ref android.R.styleable#View_nextFocusRight
4159 */
4160 public int getNextFocusRightId() {
4161 return mNextFocusRightId;
4162 }
4163
4164 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004165 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
4166 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
4167 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004168 *
4169 * @attr ref android.R.styleable#View_nextFocusRight
4170 */
4171 public void setNextFocusRightId(int nextFocusRightId) {
4172 mNextFocusRightId = nextFocusRightId;
4173 }
4174
4175 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004176 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
4177 * @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 -08004178 *
4179 * @attr ref android.R.styleable#View_nextFocusUp
4180 */
4181 public int getNextFocusUpId() {
4182 return mNextFocusUpId;
4183 }
4184
4185 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004186 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
4187 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
4188 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004189 *
4190 * @attr ref android.R.styleable#View_nextFocusUp
4191 */
4192 public void setNextFocusUpId(int nextFocusUpId) {
4193 mNextFocusUpId = nextFocusUpId;
4194 }
4195
4196 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004197 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
4198 * @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 -08004199 *
4200 * @attr ref android.R.styleable#View_nextFocusDown
4201 */
4202 public int getNextFocusDownId() {
4203 return mNextFocusDownId;
4204 }
4205
4206 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004207 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
4208 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
4209 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004210 *
4211 * @attr ref android.R.styleable#View_nextFocusDown
4212 */
4213 public void setNextFocusDownId(int nextFocusDownId) {
4214 mNextFocusDownId = nextFocusDownId;
4215 }
4216
4217 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004218 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
4219 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
4220 *
4221 * @attr ref android.R.styleable#View_nextFocusForward
4222 */
4223 public int getNextFocusForwardId() {
4224 return mNextFocusForwardId;
4225 }
4226
4227 /**
4228 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
4229 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
4230 * decide automatically.
4231 *
4232 * @attr ref android.R.styleable#View_nextFocusForward
4233 */
4234 public void setNextFocusForwardId(int nextFocusForwardId) {
4235 mNextFocusForwardId = nextFocusForwardId;
4236 }
4237
4238 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004239 * Returns the visibility of this view and all of its ancestors
4240 *
4241 * @return True if this view and all of its ancestors are {@link #VISIBLE}
4242 */
4243 public boolean isShown() {
4244 View current = this;
4245 //noinspection ConstantConditions
4246 do {
4247 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
4248 return false;
4249 }
4250 ViewParent parent = current.mParent;
4251 if (parent == null) {
4252 return false; // We are not attached to the view root
4253 }
4254 if (!(parent instanceof View)) {
4255 return true;
4256 }
4257 current = (View) parent;
4258 } while (current != null);
4259
4260 return false;
4261 }
4262
4263 /**
4264 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag
4265 * is set
4266 *
4267 * @param insets Insets for system windows
4268 *
4269 * @return True if this view applied the insets, false otherwise
4270 */
4271 protected boolean fitSystemWindows(Rect insets) {
4272 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
4273 mPaddingLeft = insets.left;
4274 mPaddingTop = insets.top;
4275 mPaddingRight = insets.right;
4276 mPaddingBottom = insets.bottom;
4277 requestLayout();
4278 return true;
4279 }
4280 return false;
4281 }
4282
4283 /**
Adam Powell0bd1d0a2011-07-22 19:35:06 -07004284 * Set whether or not this view should account for system screen decorations
4285 * such as the status bar and inset its content. This allows this view to be
4286 * positioned in absolute screen coordinates and remain visible to the user.
4287 *
4288 * <p>This should only be used by top-level window decor views.
4289 *
4290 * @param fitSystemWindows true to inset content for system screen decorations, false for
4291 * default behavior.
4292 *
4293 * @attr ref android.R.styleable#View_fitsSystemWindows
4294 */
4295 public void setFitsSystemWindows(boolean fitSystemWindows) {
4296 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS);
4297 }
4298
4299 /**
4300 * Check for the FITS_SYSTEM_WINDOWS flag. If this method returns true, this view
4301 * will account for system screen decorations such as the status bar and inset its
4302 * content. This allows the view to be positioned in absolute screen coordinates
4303 * and remain visible to the user.
4304 *
4305 * @return true if this view will adjust its content bounds for system screen decorations.
4306 *
4307 * @attr ref android.R.styleable#View_fitsSystemWindows
4308 */
4309 public boolean fitsSystemWindows() {
4310 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
4311 }
4312
4313 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004314 * Returns the visibility status for this view.
4315 *
4316 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
4317 * @attr ref android.R.styleable#View_visibility
4318 */
4319 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07004320 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
4321 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
4322 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004323 })
4324 public int getVisibility() {
4325 return mViewFlags & VISIBILITY_MASK;
4326 }
4327
4328 /**
4329 * Set the enabled state of this view.
4330 *
4331 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
4332 * @attr ref android.R.styleable#View_visibility
4333 */
4334 @RemotableViewMethod
4335 public void setVisibility(int visibility) {
4336 setFlags(visibility, VISIBILITY_MASK);
4337 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false);
4338 }
4339
4340 /**
4341 * Returns the enabled status for this view. The interpretation of the
4342 * enabled state varies by subclass.
4343 *
4344 * @return True if this view is enabled, false otherwise.
4345 */
4346 @ViewDebug.ExportedProperty
4347 public boolean isEnabled() {
4348 return (mViewFlags & ENABLED_MASK) == ENABLED;
4349 }
4350
4351 /**
4352 * Set the enabled state of this view. The interpretation of the enabled
4353 * state varies by subclass.
4354 *
4355 * @param enabled True if this view is enabled, false otherwise.
4356 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08004357 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004358 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07004359 if (enabled == isEnabled()) return;
4360
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004361 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
4362
4363 /*
4364 * The View most likely has to change its appearance, so refresh
4365 * the drawable state.
4366 */
4367 refreshDrawableState();
4368
4369 // Invalidate too, since the default behavior for views is to be
4370 // be drawn at 50% alpha rather than to change the drawable.
Romain Guy0fd89bf2011-01-26 15:41:30 -08004371 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004372 }
4373
4374 /**
4375 * Set whether this view can receive the focus.
4376 *
4377 * Setting this to false will also ensure that this view is not focusable
4378 * in touch mode.
4379 *
4380 * @param focusable If true, this view can receive the focus.
4381 *
4382 * @see #setFocusableInTouchMode(boolean)
4383 * @attr ref android.R.styleable#View_focusable
4384 */
4385 public void setFocusable(boolean focusable) {
4386 if (!focusable) {
4387 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
4388 }
4389 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
4390 }
4391
4392 /**
4393 * Set whether this view can receive focus while in touch mode.
4394 *
4395 * Setting this to true will also ensure that this view is focusable.
4396 *
4397 * @param focusableInTouchMode If true, this view can receive the focus while
4398 * in touch mode.
4399 *
4400 * @see #setFocusable(boolean)
4401 * @attr ref android.R.styleable#View_focusableInTouchMode
4402 */
4403 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
4404 // Focusable in touch mode should always be set before the focusable flag
4405 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
4406 // which, in touch mode, will not successfully request focus on this view
4407 // because the focusable in touch mode flag is not set
4408 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
4409 if (focusableInTouchMode) {
4410 setFlags(FOCUSABLE, FOCUSABLE_MASK);
4411 }
4412 }
4413
4414 /**
4415 * Set whether this view should have sound effects enabled for events such as
4416 * clicking and touching.
4417 *
4418 * <p>You may wish to disable sound effects for a view if you already play sounds,
4419 * for instance, a dial key that plays dtmf tones.
4420 *
4421 * @param soundEffectsEnabled whether sound effects are enabled for this view.
4422 * @see #isSoundEffectsEnabled()
4423 * @see #playSoundEffect(int)
4424 * @attr ref android.R.styleable#View_soundEffectsEnabled
4425 */
4426 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
4427 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
4428 }
4429
4430 /**
4431 * @return whether this view should have sound effects enabled for events such as
4432 * clicking and touching.
4433 *
4434 * @see #setSoundEffectsEnabled(boolean)
4435 * @see #playSoundEffect(int)
4436 * @attr ref android.R.styleable#View_soundEffectsEnabled
4437 */
4438 @ViewDebug.ExportedProperty
4439 public boolean isSoundEffectsEnabled() {
4440 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
4441 }
4442
4443 /**
4444 * Set whether this view should have haptic feedback for events such as
4445 * long presses.
4446 *
4447 * <p>You may wish to disable haptic feedback if your view already controls
4448 * its own haptic feedback.
4449 *
4450 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
4451 * @see #isHapticFeedbackEnabled()
4452 * @see #performHapticFeedback(int)
4453 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
4454 */
4455 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
4456 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
4457 }
4458
4459 /**
4460 * @return whether this view should have haptic feedback enabled for events
4461 * long presses.
4462 *
4463 * @see #setHapticFeedbackEnabled(boolean)
4464 * @see #performHapticFeedback(int)
4465 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
4466 */
4467 @ViewDebug.ExportedProperty
4468 public boolean isHapticFeedbackEnabled() {
4469 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
4470 }
4471
4472 /**
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004473 * Returns the layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08004474 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004475 * @return One of {@link #LAYOUT_DIRECTION_LTR},
4476 * {@link #LAYOUT_DIRECTION_RTL},
4477 * {@link #LAYOUT_DIRECTION_INHERIT} or
4478 * {@link #LAYOUT_DIRECTION_LOCALE}.
4479 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07004480 *
Cibu Johny7632cb92010-02-22 13:01:02 -08004481 * @hide
4482 */
Fabrice Di Megliobce84d22011-06-02 15:57:01 -07004483 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004484 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"),
4485 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"),
4486 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"),
4487 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE")
Cibu Johny7632cb92010-02-22 13:01:02 -08004488 })
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004489 public int getLayoutDirection() {
4490 return mViewFlags & LAYOUT_DIRECTION_MASK;
Cibu Johny7632cb92010-02-22 13:01:02 -08004491 }
4492
4493 /**
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07004494 * Set the layout direction for this view. This will propagate a reset of layout direction
4495 * resolution to the view's children and resolve layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08004496 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004497 * @param layoutDirection One of {@link #LAYOUT_DIRECTION_LTR},
4498 * {@link #LAYOUT_DIRECTION_RTL},
4499 * {@link #LAYOUT_DIRECTION_INHERIT} or
4500 * {@link #LAYOUT_DIRECTION_LOCALE}.
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07004501 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004502 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07004503 *
Cibu Johny7632cb92010-02-22 13:01:02 -08004504 * @hide
4505 */
4506 @RemotableViewMethod
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004507 public void setLayoutDirection(int layoutDirection) {
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07004508 if (getLayoutDirection() != layoutDirection) {
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07004509 resetResolvedLayoutDirection();
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07004510 // Setting the flag will also request a layout.
4511 setFlags(layoutDirection, LAYOUT_DIRECTION_MASK);
4512 }
Cibu Johny7632cb92010-02-22 13:01:02 -08004513 }
4514
4515 /**
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07004516 * Returns the resolved layout direction for this view.
4517 *
4518 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns
4519 * {@link #LAYOUT_DIRECTION_LTR} id the layout direction is not RTL.
4520 *
4521 * @hide
4522 */
4523 @ViewDebug.ExportedProperty(category = "layout", mapping = {
4524 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"),
4525 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL")
4526 })
4527 public int getResolvedLayoutDirection() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07004528 resolveLayoutDirectionIfNeeded();
4529 return ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED_RTL) == LAYOUT_DIRECTION_RESOLVED_RTL) ?
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07004530 LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR;
4531 }
4532
4533 /**
4534 * <p>Indicates whether or not this view's layout is right-to-left. This is resolved from
4535 * layout attribute and/or the inherited value from the parent.</p>
4536 *
4537 * @return true if the layout is right-to-left.
4538 *
4539 * @hide
4540 */
4541 @ViewDebug.ExportedProperty(category = "layout")
4542 public boolean isLayoutRtl() {
4543 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL);
4544 }
4545
4546 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004547 * If this view doesn't do any drawing on its own, set this flag to
4548 * allow further optimizations. By default, this flag is not set on
4549 * View, but could be set on some View subclasses such as ViewGroup.
4550 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07004551 * Typically, if you override {@link #onDraw(android.graphics.Canvas)}
4552 * you should clear this flag.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004553 *
4554 * @param willNotDraw whether or not this View draw on its own
4555 */
4556 public void setWillNotDraw(boolean willNotDraw) {
4557 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
4558 }
4559
4560 /**
4561 * Returns whether or not this View draws on its own.
4562 *
4563 * @return true if this view has nothing to draw, false otherwise
4564 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004565 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004566 public boolean willNotDraw() {
4567 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
4568 }
4569
4570 /**
4571 * When a View's drawing cache is enabled, drawing is redirected to an
4572 * offscreen bitmap. Some views, like an ImageView, must be able to
4573 * bypass this mechanism if they already draw a single bitmap, to avoid
4574 * unnecessary usage of the memory.
4575 *
4576 * @param willNotCacheDrawing true if this view does not cache its
4577 * drawing, false otherwise
4578 */
4579 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
4580 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
4581 }
4582
4583 /**
4584 * Returns whether or not this View can cache its drawing or not.
4585 *
4586 * @return true if this view does not cache its drawing, false otherwise
4587 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004588 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004589 public boolean willNotCacheDrawing() {
4590 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
4591 }
4592
4593 /**
4594 * Indicates whether this view reacts to click events or not.
4595 *
4596 * @return true if the view is clickable, false otherwise
4597 *
4598 * @see #setClickable(boolean)
4599 * @attr ref android.R.styleable#View_clickable
4600 */
4601 @ViewDebug.ExportedProperty
4602 public boolean isClickable() {
4603 return (mViewFlags & CLICKABLE) == CLICKABLE;
4604 }
4605
4606 /**
4607 * Enables or disables click events for this view. When a view
4608 * is clickable it will change its state to "pressed" on every click.
4609 * Subclasses should set the view clickable to visually react to
4610 * user's clicks.
4611 *
4612 * @param clickable true to make the view clickable, false otherwise
4613 *
4614 * @see #isClickable()
4615 * @attr ref android.R.styleable#View_clickable
4616 */
4617 public void setClickable(boolean clickable) {
4618 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
4619 }
4620
4621 /**
4622 * Indicates whether this view reacts to long click events or not.
4623 *
4624 * @return true if the view is long clickable, false otherwise
4625 *
4626 * @see #setLongClickable(boolean)
4627 * @attr ref android.R.styleable#View_longClickable
4628 */
4629 public boolean isLongClickable() {
4630 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
4631 }
4632
4633 /**
4634 * Enables or disables long click events for this view. When a view is long
4635 * clickable it reacts to the user holding down the button for a longer
4636 * duration than a tap. This event can either launch the listener or a
4637 * context menu.
4638 *
4639 * @param longClickable true to make the view long clickable, false otherwise
4640 * @see #isLongClickable()
4641 * @attr ref android.R.styleable#View_longClickable
4642 */
4643 public void setLongClickable(boolean longClickable) {
4644 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
4645 }
4646
4647 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07004648 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004649 *
4650 * @see #isClickable()
4651 * @see #setClickable(boolean)
4652 *
4653 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
4654 * the View's internal state from a previously set "pressed" state.
4655 */
4656 public void setPressed(boolean pressed) {
4657 if (pressed) {
4658 mPrivateFlags |= PRESSED;
4659 } else {
4660 mPrivateFlags &= ~PRESSED;
4661 }
4662 refreshDrawableState();
4663 dispatchSetPressed(pressed);
4664 }
4665
4666 /**
4667 * Dispatch setPressed to all of this View's children.
4668 *
4669 * @see #setPressed(boolean)
4670 *
4671 * @param pressed The new pressed state
4672 */
4673 protected void dispatchSetPressed(boolean pressed) {
4674 }
4675
4676 /**
4677 * Indicates whether the view is currently in pressed state. Unless
4678 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
4679 * the pressed state.
4680 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07004681 * @see #setPressed(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004682 * @see #isClickable()
4683 * @see #setClickable(boolean)
4684 *
4685 * @return true if the view is currently pressed, false otherwise
4686 */
4687 public boolean isPressed() {
4688 return (mPrivateFlags & PRESSED) == PRESSED;
4689 }
4690
4691 /**
4692 * Indicates whether this view will save its state (that is,
4693 * whether its {@link #onSaveInstanceState} method will be called).
4694 *
4695 * @return Returns true if the view state saving is enabled, else false.
4696 *
4697 * @see #setSaveEnabled(boolean)
4698 * @attr ref android.R.styleable#View_saveEnabled
4699 */
4700 public boolean isSaveEnabled() {
4701 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
4702 }
4703
4704 /**
4705 * Controls whether the saving of this view's state is
4706 * enabled (that is, whether its {@link #onSaveInstanceState} method
4707 * will be called). Note that even if freezing is enabled, the
Romain Guy5c22a8c2011-05-13 11:48:45 -07004708 * view still must have an id assigned to it (via {@link #setId(int)})
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004709 * for its state to be saved. This flag can only disable the
4710 * saving of this view; any child views may still have their state saved.
4711 *
4712 * @param enabled Set to false to <em>disable</em> state saving, or true
4713 * (the default) to allow it.
4714 *
4715 * @see #isSaveEnabled()
4716 * @see #setId(int)
4717 * @see #onSaveInstanceState()
4718 * @attr ref android.R.styleable#View_saveEnabled
4719 */
4720 public void setSaveEnabled(boolean enabled) {
4721 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
4722 }
4723
Jeff Brown85a31762010-09-01 17:01:00 -07004724 /**
4725 * Gets whether the framework should discard touches when the view's
4726 * window is obscured by another visible window.
4727 * Refer to the {@link View} security documentation for more details.
4728 *
4729 * @return True if touch filtering is enabled.
4730 *
4731 * @see #setFilterTouchesWhenObscured(boolean)
4732 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
4733 */
4734 @ViewDebug.ExportedProperty
4735 public boolean getFilterTouchesWhenObscured() {
4736 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
4737 }
4738
4739 /**
4740 * Sets whether the framework should discard touches when the view's
4741 * window is obscured by another visible window.
4742 * Refer to the {@link View} security documentation for more details.
4743 *
4744 * @param enabled True if touch filtering should be enabled.
4745 *
4746 * @see #getFilterTouchesWhenObscured
4747 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
4748 */
4749 public void setFilterTouchesWhenObscured(boolean enabled) {
4750 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
4751 FILTER_TOUCHES_WHEN_OBSCURED);
4752 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004753
4754 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004755 * Indicates whether the entire hierarchy under this view will save its
4756 * state when a state saving traversal occurs from its parent. The default
4757 * is true; if false, these views will not be saved unless
4758 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4759 *
4760 * @return Returns true if the view state saving from parent is enabled, else false.
4761 *
4762 * @see #setSaveFromParentEnabled(boolean)
4763 */
4764 public boolean isSaveFromParentEnabled() {
4765 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
4766 }
4767
4768 /**
4769 * Controls whether the entire hierarchy under this view will save its
4770 * state when a state saving traversal occurs from its parent. The default
4771 * is true; if false, these views will not be saved unless
4772 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4773 *
4774 * @param enabled Set to false to <em>disable</em> state saving, or true
4775 * (the default) to allow it.
4776 *
4777 * @see #isSaveFromParentEnabled()
4778 * @see #setId(int)
4779 * @see #onSaveInstanceState()
4780 */
4781 public void setSaveFromParentEnabled(boolean enabled) {
4782 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
4783 }
4784
4785
4786 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004787 * Returns whether this View is able to take focus.
4788 *
4789 * @return True if this view can take focus, or false otherwise.
4790 * @attr ref android.R.styleable#View_focusable
4791 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004792 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004793 public final boolean isFocusable() {
4794 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
4795 }
4796
4797 /**
4798 * When a view is focusable, it may not want to take focus when in touch mode.
4799 * For example, a button would like focus when the user is navigating via a D-pad
4800 * so that the user can click on it, but once the user starts touching the screen,
4801 * the button shouldn't take focus
4802 * @return Whether the view is focusable in touch mode.
4803 * @attr ref android.R.styleable#View_focusableInTouchMode
4804 */
4805 @ViewDebug.ExportedProperty
4806 public final boolean isFocusableInTouchMode() {
4807 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
4808 }
4809
4810 /**
4811 * Find the nearest view in the specified direction that can take focus.
4812 * This does not actually give focus to that view.
4813 *
4814 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4815 *
4816 * @return The nearest focusable in the specified direction, or null if none
4817 * can be found.
4818 */
4819 public View focusSearch(int direction) {
4820 if (mParent != null) {
4821 return mParent.focusSearch(this, direction);
4822 } else {
4823 return null;
4824 }
4825 }
4826
4827 /**
4828 * This method is the last chance for the focused view and its ancestors to
4829 * respond to an arrow key. This is called when the focused view did not
4830 * consume the key internally, nor could the view system find a new view in
4831 * the requested direction to give focus to.
4832 *
4833 * @param focused The currently focused view.
4834 * @param direction The direction focus wants to move. One of FOCUS_UP,
4835 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
4836 * @return True if the this view consumed this unhandled move.
4837 */
4838 public boolean dispatchUnhandledMove(View focused, int direction) {
4839 return false;
4840 }
4841
4842 /**
4843 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08004844 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004845 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08004846 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
4847 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004848 * @return The user specified next view, or null if there is none.
4849 */
4850 View findUserSetNextFocus(View root, int direction) {
4851 switch (direction) {
4852 case FOCUS_LEFT:
4853 if (mNextFocusLeftId == View.NO_ID) return null;
4854 return findViewShouldExist(root, mNextFocusLeftId);
4855 case FOCUS_RIGHT:
4856 if (mNextFocusRightId == View.NO_ID) return null;
4857 return findViewShouldExist(root, mNextFocusRightId);
4858 case FOCUS_UP:
4859 if (mNextFocusUpId == View.NO_ID) return null;
4860 return findViewShouldExist(root, mNextFocusUpId);
4861 case FOCUS_DOWN:
4862 if (mNextFocusDownId == View.NO_ID) return null;
4863 return findViewShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08004864 case FOCUS_FORWARD:
4865 if (mNextFocusForwardId == View.NO_ID) return null;
4866 return findViewShouldExist(root, mNextFocusForwardId);
4867 case FOCUS_BACKWARD: {
4868 final int id = mID;
4869 return root.findViewByPredicate(new Predicate<View>() {
4870 @Override
4871 public boolean apply(View t) {
4872 return t.mNextFocusForwardId == id;
4873 }
4874 });
4875 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004876 }
4877 return null;
4878 }
4879
4880 private static View findViewShouldExist(View root, int childViewId) {
4881 View result = root.findViewById(childViewId);
4882 if (result == null) {
4883 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
4884 + "by user for id " + childViewId);
4885 }
4886 return result;
4887 }
4888
4889 /**
4890 * Find and return all focusable views that are descendants of this view,
4891 * possibly including this view if it is focusable itself.
4892 *
4893 * @param direction The direction of the focus
4894 * @return A list of focusable views
4895 */
4896 public ArrayList<View> getFocusables(int direction) {
4897 ArrayList<View> result = new ArrayList<View>(24);
4898 addFocusables(result, direction);
4899 return result;
4900 }
4901
4902 /**
4903 * Add any focusable views that are descendants of this view (possibly
4904 * including this view if it is focusable itself) to views. If we are in touch mode,
4905 * only add views that are also focusable in touch mode.
4906 *
4907 * @param views Focusable views found so far
4908 * @param direction The direction of the focus
4909 */
4910 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004911 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
4912 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004913
svetoslavganov75986cf2009-05-14 22:28:01 -07004914 /**
4915 * Adds any focusable views that are descendants of this view (possibly
4916 * including this view if it is focusable itself) to views. This method
4917 * adds all focusable views regardless if we are in touch mode or
4918 * only views focusable in touch mode if we are in touch mode depending on
4919 * the focusable mode paramater.
4920 *
4921 * @param views Focusable views found so far or null if all we are interested is
4922 * the number of focusables.
4923 * @param direction The direction of the focus.
4924 * @param focusableMode The type of focusables to be added.
4925 *
4926 * @see #FOCUSABLES_ALL
4927 * @see #FOCUSABLES_TOUCH_MODE
4928 */
4929 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
4930 if (!isFocusable()) {
4931 return;
4932 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004933
svetoslavganov75986cf2009-05-14 22:28:01 -07004934 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE &&
4935 isInTouchMode() && !isFocusableInTouchMode()) {
4936 return;
4937 }
4938
4939 if (views != null) {
4940 views.add(this);
4941 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004942 }
4943
4944 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004945 * Finds the Views that contain given text. The containment is case insensitive.
4946 * As View's text is considered any text content that View renders.
4947 *
4948 * @param outViews The output list of matching Views.
4949 * @param text The text to match against.
4950 */
4951 public void findViewsWithText(ArrayList<View> outViews, CharSequence text) {
4952 }
4953
4954 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004955 * Find and return all touchable views that are descendants of this view,
4956 * possibly including this view if it is touchable itself.
4957 *
4958 * @return A list of touchable views
4959 */
4960 public ArrayList<View> getTouchables() {
4961 ArrayList<View> result = new ArrayList<View>();
4962 addTouchables(result);
4963 return result;
4964 }
4965
4966 /**
4967 * Add any touchable views that are descendants of this view (possibly
4968 * including this view if it is touchable itself) to views.
4969 *
4970 * @param views Touchable views found so far
4971 */
4972 public void addTouchables(ArrayList<View> views) {
4973 final int viewFlags = mViewFlags;
4974
4975 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
4976 && (viewFlags & ENABLED_MASK) == ENABLED) {
4977 views.add(this);
4978 }
4979 }
4980
4981 /**
4982 * Call this to try to give focus to a specific view or to one of its
4983 * descendants.
4984 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08004985 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
4986 * false), or if it is focusable and it is not focusable in touch mode
4987 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004988 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07004989 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004990 * have focus, and you want your parent to look for the next one.
4991 *
4992 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
4993 * {@link #FOCUS_DOWN} and <code>null</code>.
4994 *
4995 * @return Whether this view or one of its descendants actually took focus.
4996 */
4997 public final boolean requestFocus() {
4998 return requestFocus(View.FOCUS_DOWN);
4999 }
5000
5001
5002 /**
5003 * Call this to try to give focus to a specific view or to one of its
5004 * descendants and give it a hint about what direction focus is heading.
5005 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08005006 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
5007 * false), or if it is focusable and it is not focusable in touch mode
5008 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005009 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005010 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005011 * have focus, and you want your parent to look for the next one.
5012 *
5013 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
5014 * <code>null</code> set for the previously focused rectangle.
5015 *
5016 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
5017 * @return Whether this view or one of its descendants actually took focus.
5018 */
5019 public final boolean requestFocus(int direction) {
5020 return requestFocus(direction, null);
5021 }
5022
5023 /**
5024 * Call this to try to give focus to a specific view or to one of its descendants
5025 * and give it hints about the direction and a specific rectangle that the focus
5026 * is coming from. The rectangle can help give larger views a finer grained hint
5027 * about where focus is coming from, and therefore, where to show selection, or
5028 * forward focus change internally.
5029 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08005030 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
5031 * false), or if it is focusable and it is not focusable in touch mode
5032 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005033 *
5034 * A View will not take focus if it is not visible.
5035 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08005036 * A View will not take focus if one of its parents has
5037 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to
5038 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005039 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005040 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005041 * have focus, and you want your parent to look for the next one.
5042 *
5043 * You may wish to override this method if your custom {@link View} has an internal
5044 * {@link View} that it wishes to forward the request to.
5045 *
5046 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
5047 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
5048 * to give a finer grained hint about where focus is coming from. May be null
5049 * if there is no hint.
5050 * @return Whether this view or one of its descendants actually took focus.
5051 */
5052 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
5053 // need to be focusable
5054 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
5055 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
5056 return false;
5057 }
5058
5059 // need to be focusable in touch mode if in touch mode
5060 if (isInTouchMode() &&
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07005061 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
5062 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005063 }
5064
5065 // need to not have any parents blocking us
5066 if (hasAncestorThatBlocksDescendantFocus()) {
5067 return false;
5068 }
5069
5070 handleFocusGainInternal(direction, previouslyFocusedRect);
5071 return true;
5072 }
5073
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07005074 /** Gets the ViewAncestor, or null if not attached. */
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07005075 /*package*/ ViewRootImpl getViewRootImpl() {
Christopher Tate2c095f32010-10-04 14:13:40 -07005076 View root = getRootView();
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07005077 return root != null ? (ViewRootImpl)root.getParent() : null;
Christopher Tate2c095f32010-10-04 14:13:40 -07005078 }
5079
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005080 /**
5081 * Call this to try to give focus to a specific view or to one of its descendants. This is a
5082 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
5083 * touch mode to request focus when they are touched.
5084 *
5085 * @return Whether this view or one of its descendants actually took focus.
5086 *
5087 * @see #isInTouchMode()
5088 *
5089 */
5090 public final boolean requestFocusFromTouch() {
5091 // Leave touch mode if we need to
5092 if (isInTouchMode()) {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07005093 ViewRootImpl viewRoot = getViewRootImpl();
Christopher Tate2c095f32010-10-04 14:13:40 -07005094 if (viewRoot != null) {
5095 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005096 }
5097 }
5098 return requestFocus(View.FOCUS_DOWN);
5099 }
5100
5101 /**
5102 * @return Whether any ancestor of this view blocks descendant focus.
5103 */
5104 private boolean hasAncestorThatBlocksDescendantFocus() {
5105 ViewParent ancestor = mParent;
5106 while (ancestor instanceof ViewGroup) {
5107 final ViewGroup vgAncestor = (ViewGroup) ancestor;
5108 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
5109 return true;
5110 } else {
5111 ancestor = vgAncestor.getParent();
5112 }
5113 }
5114 return false;
5115 }
5116
5117 /**
Romain Guya440b002010-02-24 15:57:54 -08005118 * @hide
5119 */
5120 public void dispatchStartTemporaryDetach() {
5121 onStartTemporaryDetach();
5122 }
5123
5124 /**
5125 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005126 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
5127 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08005128 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005129 */
5130 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08005131 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08005132 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08005133 }
5134
5135 /**
5136 * @hide
5137 */
5138 public void dispatchFinishTemporaryDetach() {
5139 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005140 }
Romain Guy8506ab42009-06-11 17:35:47 -07005141
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005142 /**
5143 * Called after {@link #onStartTemporaryDetach} when the container is done
5144 * changing the view.
5145 */
5146 public void onFinishTemporaryDetach() {
5147 }
Romain Guy8506ab42009-06-11 17:35:47 -07005148
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005149 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07005150 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
5151 * for this view's window. Returns null if the view is not currently attached
5152 * to the window. Normally you will not need to use this directly, but
Romain Guy5c22a8c2011-05-13 11:48:45 -07005153 * just use the standard high-level event callbacks like
5154 * {@link #onKeyDown(int, KeyEvent)}.
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07005155 */
5156 public KeyEvent.DispatcherState getKeyDispatcherState() {
5157 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
5158 }
Joe Malin32736f02011-01-19 16:14:20 -08005159
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07005160 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005161 * Dispatch a key event before it is processed by any input method
5162 * associated with the view hierarchy. This can be used to intercept
5163 * key events in special situations before the IME consumes them; a
5164 * typical example would be handling the BACK key to update the application's
5165 * UI instead of allowing the IME to see it and close itself.
5166 *
5167 * @param event The key event to be dispatched.
5168 * @return True if the event was handled, false otherwise.
5169 */
5170 public boolean dispatchKeyEventPreIme(KeyEvent event) {
5171 return onKeyPreIme(event.getKeyCode(), event);
5172 }
5173
5174 /**
5175 * Dispatch a key event to the next view on the focus path. This path runs
5176 * from the top of the view tree down to the currently focused view. If this
5177 * view has focus, it will dispatch to itself. Otherwise it will dispatch
5178 * the next node down the focus path. This method also fires any key
5179 * listeners.
5180 *
5181 * @param event The key event to be dispatched.
5182 * @return True if the event was handled, false otherwise.
5183 */
5184 public boolean dispatchKeyEvent(KeyEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08005185 if (mInputEventConsistencyVerifier != null) {
5186 mInputEventConsistencyVerifier.onKeyEvent(event, 0);
5187 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005188
Jeff Brown21bc5c92011-02-28 18:27:14 -08005189 // Give any attached key listener a first crack at the event.
Romain Guyf607bdc2010-09-10 19:20:06 -07005190 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005191 if (mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
5192 && mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
5193 return true;
5194 }
5195
Jeff Brownbbdc50b2011-04-19 23:46:52 -07005196 if (event.dispatch(this, mAttachInfo != null
5197 ? mAttachInfo.mKeyDispatchState : null, this)) {
5198 return true;
5199 }
5200
5201 if (mInputEventConsistencyVerifier != null) {
5202 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
5203 }
5204 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005205 }
5206
5207 /**
5208 * Dispatches a key shortcut event.
5209 *
5210 * @param event The key event to be dispatched.
5211 * @return True if the event was handled by the view, false otherwise.
5212 */
5213 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
5214 return onKeyShortcut(event.getKeyCode(), event);
5215 }
5216
5217 /**
5218 * Pass the touch screen motion event down to the target view, or this
5219 * view if it is the target.
5220 *
5221 * @param event The motion event to be dispatched.
5222 * @return True if the event was handled by the view, false otherwise.
5223 */
5224 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08005225 if (mInputEventConsistencyVerifier != null) {
5226 mInputEventConsistencyVerifier.onTouchEvent(event, 0);
5227 }
5228
Jeff Brownbbdc50b2011-04-19 23:46:52 -07005229 if (onFilterTouchEventForSecurity(event)) {
5230 //noinspection SimplifiableIfStatement
5231 if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED &&
5232 mOnTouchListener.onTouch(this, event)) {
5233 return true;
5234 }
5235
5236 if (onTouchEvent(event)) {
5237 return true;
5238 }
Jeff Brown85a31762010-09-01 17:01:00 -07005239 }
5240
Jeff Brownbbdc50b2011-04-19 23:46:52 -07005241 if (mInputEventConsistencyVerifier != null) {
5242 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005243 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07005244 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005245 }
5246
5247 /**
Jeff Brown85a31762010-09-01 17:01:00 -07005248 * Filter the touch event to apply security policies.
5249 *
5250 * @param event The motion event to be filtered.
5251 * @return True if the event should be dispatched, false if the event should be dropped.
Joe Malin32736f02011-01-19 16:14:20 -08005252 *
Jeff Brown85a31762010-09-01 17:01:00 -07005253 * @see #getFilterTouchesWhenObscured
5254 */
5255 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07005256 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07005257 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
5258 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
5259 // Window is obscured, drop this touch.
5260 return false;
5261 }
5262 return true;
5263 }
5264
5265 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005266 * Pass a trackball motion event down to the focused view.
5267 *
5268 * @param event The motion event to be dispatched.
5269 * @return True if the event was handled by the view, false otherwise.
5270 */
5271 public boolean dispatchTrackballEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08005272 if (mInputEventConsistencyVerifier != null) {
5273 mInputEventConsistencyVerifier.onTrackballEvent(event, 0);
5274 }
5275
Romain Guy02ccac62011-06-24 13:20:23 -07005276 return onTrackballEvent(event);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005277 }
5278
5279 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08005280 * Dispatch a generic motion event.
5281 * <p>
5282 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
5283 * are delivered to the view under the pointer. All other generic motion events are
Jeff Browna032cc02011-03-07 16:56:21 -08005284 * delivered to the focused view. Hover events are handled specially and are delivered
Romain Guy5c22a8c2011-05-13 11:48:45 -07005285 * to {@link #onHoverEvent(MotionEvent)}.
Jeff Brown33bbfd22011-02-24 20:55:35 -08005286 * </p>
Jeff Browncb1404e2011-01-15 18:14:15 -08005287 *
5288 * @param event The motion event to be dispatched.
5289 * @return True if the event was handled by the view, false otherwise.
5290 */
5291 public boolean dispatchGenericMotionEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08005292 if (mInputEventConsistencyVerifier != null) {
5293 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0);
5294 }
5295
Jeff Browna032cc02011-03-07 16:56:21 -08005296 final int source = event.getSource();
5297 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) {
5298 final int action = event.getAction();
5299 if (action == MotionEvent.ACTION_HOVER_ENTER
5300 || action == MotionEvent.ACTION_HOVER_MOVE
5301 || action == MotionEvent.ACTION_HOVER_EXIT) {
5302 if (dispatchHoverEvent(event)) {
Jeff Brown10b62902011-06-20 16:40:37 -07005303 // For compatibility with existing applications that handled HOVER_MOVE
5304 // events in onGenericMotionEvent, dispatch the event there. The
5305 // onHoverEvent method did not exist at the time.
5306 if (action == MotionEvent.ACTION_HOVER_MOVE) {
5307 dispatchGenericMotionEventInternal(event);
5308 }
Jeff Browna032cc02011-03-07 16:56:21 -08005309 return true;
5310 }
5311 } else if (dispatchGenericPointerEvent(event)) {
5312 return true;
5313 }
5314 } else if (dispatchGenericFocusedEvent(event)) {
5315 return true;
5316 }
5317
Jeff Brown10b62902011-06-20 16:40:37 -07005318 if (dispatchGenericMotionEventInternal(event)) {
5319 return true;
5320 }
5321
5322 if (mInputEventConsistencyVerifier != null) {
5323 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
5324 }
5325 return false;
5326 }
5327
5328 private boolean dispatchGenericMotionEventInternal(MotionEvent event) {
Romain Guy7b5b6ab2011-03-14 18:05:08 -07005329 //noinspection SimplifiableIfStatement
Jeff Brown33bbfd22011-02-24 20:55:35 -08005330 if (mOnGenericMotionListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
5331 && mOnGenericMotionListener.onGenericMotion(this, event)) {
5332 return true;
5333 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07005334
5335 if (onGenericMotionEvent(event)) {
5336 return true;
5337 }
5338
5339 if (mInputEventConsistencyVerifier != null) {
5340 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
5341 }
5342 return false;
Jeff Browncb1404e2011-01-15 18:14:15 -08005343 }
5344
5345 /**
Jeff Browna032cc02011-03-07 16:56:21 -08005346 * Dispatch a hover event.
5347 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07005348 * Do not call this method directly.
5349 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08005350 * </p>
5351 *
5352 * @param event The motion event to be dispatched.
5353 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08005354 */
5355 protected boolean dispatchHoverEvent(MotionEvent event) {
Jeff Brown87b7f802011-06-21 18:35:45 -07005356 switch (event.getAction()) {
5357 case MotionEvent.ACTION_HOVER_ENTER:
5358 if (!hasHoveredChild() && !mSendingHoverAccessibilityEvents) {
5359 mSendingHoverAccessibilityEvents = true;
5360 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER);
5361 }
5362 break;
5363 case MotionEvent.ACTION_HOVER_EXIT:
5364 if (mSendingHoverAccessibilityEvents) {
5365 mSendingHoverAccessibilityEvents = false;
5366 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT);
5367 }
5368 break;
5369 }
5370
Romain Guy02ccac62011-06-24 13:20:23 -07005371 //noinspection SimplifiableIfStatement
Jeff Brown10b62902011-06-20 16:40:37 -07005372 if (mOnHoverListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
5373 && mOnHoverListener.onHover(this, event)) {
5374 return true;
5375 }
5376
Jeff Browna032cc02011-03-07 16:56:21 -08005377 return onHoverEvent(event);
5378 }
5379
5380 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07005381 * Returns true if the view has a child to which it has recently sent
5382 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and
5383 * it does not have a hovered child, then it must be the innermost hovered view.
5384 * @hide
5385 */
5386 protected boolean hasHoveredChild() {
5387 return false;
5388 }
5389
5390 /**
Jeff Browna032cc02011-03-07 16:56:21 -08005391 * Dispatch a generic motion event to the view under the first pointer.
5392 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07005393 * Do not call this method directly.
5394 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08005395 * </p>
5396 *
5397 * @param event The motion event to be dispatched.
5398 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08005399 */
5400 protected boolean dispatchGenericPointerEvent(MotionEvent event) {
5401 return false;
5402 }
5403
5404 /**
5405 * Dispatch a generic motion event to the currently focused view.
5406 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07005407 * Do not call this method directly.
5408 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08005409 * </p>
5410 *
5411 * @param event The motion event to be dispatched.
5412 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08005413 */
5414 protected boolean dispatchGenericFocusedEvent(MotionEvent event) {
5415 return false;
5416 }
5417
5418 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08005419 * Dispatch a pointer event.
5420 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07005421 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all
5422 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns
5423 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches
Jeff Brown33bbfd22011-02-24 20:55:35 -08005424 * and should not be expected to handle other pointing device features.
5425 * </p>
5426 *
5427 * @param event The motion event to be dispatched.
5428 * @return True if the event was handled by the view, false otherwise.
5429 * @hide
5430 */
5431 public final boolean dispatchPointerEvent(MotionEvent event) {
5432 if (event.isTouchEvent()) {
5433 return dispatchTouchEvent(event);
5434 } else {
5435 return dispatchGenericMotionEvent(event);
5436 }
5437 }
5438
5439 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005440 * Called when the window containing this view gains or loses window focus.
5441 * ViewGroups should override to route to their children.
5442 *
5443 * @param hasFocus True if the window containing this view now has focus,
5444 * false otherwise.
5445 */
5446 public void dispatchWindowFocusChanged(boolean hasFocus) {
5447 onWindowFocusChanged(hasFocus);
5448 }
5449
5450 /**
5451 * Called when the window containing this view gains or loses focus. Note
5452 * that this is separate from view focus: to receive key events, both
5453 * your view and its window must have focus. If a window is displayed
5454 * on top of yours that takes input focus, then your own window will lose
5455 * focus but the view focus will remain unchanged.
5456 *
5457 * @param hasWindowFocus True if the window containing this view now has
5458 * focus, false otherwise.
5459 */
5460 public void onWindowFocusChanged(boolean hasWindowFocus) {
5461 InputMethodManager imm = InputMethodManager.peekInstance();
5462 if (!hasWindowFocus) {
5463 if (isPressed()) {
5464 setPressed(false);
5465 }
5466 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
5467 imm.focusOut(this);
5468 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05005469 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08005470 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07005471 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005472 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
5473 imm.focusIn(this);
5474 }
5475 refreshDrawableState();
5476 }
5477
5478 /**
5479 * Returns true if this view is in a window that currently has window focus.
5480 * Note that this is not the same as the view itself having focus.
5481 *
5482 * @return True if this view is in a window that currently has window focus.
5483 */
5484 public boolean hasWindowFocus() {
5485 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
5486 }
5487
5488 /**
Adam Powell326d8082009-12-09 15:10:07 -08005489 * Dispatch a view visibility change down the view hierarchy.
5490 * ViewGroups should override to route to their children.
5491 * @param changedView The view whose visibility changed. Could be 'this' or
5492 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08005493 * @param visibility The new visibility of changedView: {@link #VISIBLE},
5494 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08005495 */
5496 protected void dispatchVisibilityChanged(View changedView, int visibility) {
5497 onVisibilityChanged(changedView, visibility);
5498 }
5499
5500 /**
5501 * Called when the visibility of the view or an ancestor of the view is changed.
5502 * @param changedView The view whose visibility changed. Could be 'this' or
5503 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08005504 * @param visibility The new visibility of changedView: {@link #VISIBLE},
5505 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08005506 */
5507 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07005508 if (visibility == VISIBLE) {
5509 if (mAttachInfo != null) {
5510 initialAwakenScrollBars();
5511 } else {
5512 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
5513 }
5514 }
Adam Powell326d8082009-12-09 15:10:07 -08005515 }
5516
5517 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08005518 * Dispatch a hint about whether this view is displayed. For instance, when
5519 * a View moves out of the screen, it might receives a display hint indicating
5520 * the view is not displayed. Applications should not <em>rely</em> on this hint
5521 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08005522 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08005523 * @param hint A hint about whether or not this view is displayed:
5524 * {@link #VISIBLE} or {@link #INVISIBLE}.
5525 */
5526 public void dispatchDisplayHint(int hint) {
5527 onDisplayHint(hint);
5528 }
5529
5530 /**
5531 * Gives this view a hint about whether is displayed or not. For instance, when
5532 * a View moves out of the screen, it might receives a display hint indicating
5533 * the view is not displayed. Applications should not <em>rely</em> on this hint
5534 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08005535 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08005536 * @param hint A hint about whether or not this view is displayed:
5537 * {@link #VISIBLE} or {@link #INVISIBLE}.
5538 */
5539 protected void onDisplayHint(int hint) {
5540 }
5541
5542 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005543 * Dispatch a window visibility change down the view hierarchy.
5544 * ViewGroups should override to route to their children.
5545 *
5546 * @param visibility The new visibility of the window.
5547 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005548 * @see #onWindowVisibilityChanged(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005549 */
5550 public void dispatchWindowVisibilityChanged(int visibility) {
5551 onWindowVisibilityChanged(visibility);
5552 }
5553
5554 /**
5555 * Called when the window containing has change its visibility
5556 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
5557 * that this tells you whether or not your window is being made visible
5558 * to the window manager; this does <em>not</em> tell you whether or not
5559 * your window is obscured by other windows on the screen, even if it
5560 * is itself visible.
5561 *
5562 * @param visibility The new visibility of the window.
5563 */
5564 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07005565 if (visibility == VISIBLE) {
5566 initialAwakenScrollBars();
5567 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005568 }
5569
5570 /**
5571 * Returns the current visibility of the window this view is attached to
5572 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
5573 *
5574 * @return Returns the current visibility of the view's window.
5575 */
5576 public int getWindowVisibility() {
5577 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
5578 }
5579
5580 /**
5581 * Retrieve the overall visible display size in which the window this view is
5582 * attached to has been positioned in. This takes into account screen
5583 * decorations above the window, for both cases where the window itself
5584 * is being position inside of them or the window is being placed under
5585 * then and covered insets are used for the window to position its content
5586 * inside. In effect, this tells you the available area where content can
5587 * be placed and remain visible to users.
5588 *
5589 * <p>This function requires an IPC back to the window manager to retrieve
5590 * the requested information, so should not be used in performance critical
5591 * code like drawing.
5592 *
5593 * @param outRect Filled in with the visible display frame. If the view
5594 * is not attached to a window, this is simply the raw display size.
5595 */
5596 public void getWindowVisibleDisplayFrame(Rect outRect) {
5597 if (mAttachInfo != null) {
5598 try {
5599 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
5600 } catch (RemoteException e) {
5601 return;
5602 }
5603 // XXX This is really broken, and probably all needs to be done
5604 // in the window manager, and we need to know more about whether
5605 // we want the area behind or in front of the IME.
5606 final Rect insets = mAttachInfo.mVisibleInsets;
5607 outRect.left += insets.left;
5608 outRect.top += insets.top;
5609 outRect.right -= insets.right;
5610 outRect.bottom -= insets.bottom;
5611 return;
5612 }
5613 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
Dianne Hackborn44bc17c2011-04-20 18:18:51 -07005614 d.getRectSize(outRect);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005615 }
5616
5617 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08005618 * Dispatch a notification about a resource configuration change down
5619 * the view hierarchy.
5620 * ViewGroups should override to route to their children.
5621 *
5622 * @param newConfig The new resource configuration.
5623 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005624 * @see #onConfigurationChanged(android.content.res.Configuration)
Dianne Hackborne36d6e22010-02-17 19:46:25 -08005625 */
5626 public void dispatchConfigurationChanged(Configuration newConfig) {
5627 onConfigurationChanged(newConfig);
5628 }
5629
5630 /**
5631 * Called when the current configuration of the resources being used
5632 * by the application have changed. You can use this to decide when
5633 * to reload resources that can changed based on orientation and other
5634 * configuration characterstics. You only need to use this if you are
5635 * not relying on the normal {@link android.app.Activity} mechanism of
5636 * recreating the activity instance upon a configuration change.
5637 *
5638 * @param newConfig The new resource configuration.
5639 */
5640 protected void onConfigurationChanged(Configuration newConfig) {
5641 }
5642
5643 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005644 * Private function to aggregate all per-view attributes in to the view
5645 * root.
5646 */
5647 void dispatchCollectViewAttributes(int visibility) {
5648 performCollectViewAttributes(visibility);
5649 }
5650
5651 void performCollectViewAttributes(int visibility) {
Romain Guyd30b36d2011-01-26 10:54:43 -08005652 if ((visibility & VISIBILITY_MASK) == VISIBLE && mAttachInfo != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08005653 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) {
5654 mAttachInfo.mKeepScreenOn = true;
5655 }
5656 mAttachInfo.mSystemUiVisibility |= mSystemUiVisibility;
5657 if (mOnSystemUiVisibilityChangeListener != null) {
5658 mAttachInfo.mHasSystemUiListeners = true;
5659 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005660 }
5661 }
5662
5663 void needGlobalAttributesUpdate(boolean force) {
Joe Onorato664644d2011-01-23 17:53:23 -08005664 final AttachInfo ai = mAttachInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005665 if (ai != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08005666 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0)
5667 || ai.mHasSystemUiListeners) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005668 ai.mRecomputeGlobalAttributes = true;
5669 }
5670 }
5671 }
5672
5673 /**
5674 * Returns whether the device is currently in touch mode. Touch mode is entered
5675 * once the user begins interacting with the device by touch, and affects various
5676 * things like whether focus is always visible to the user.
5677 *
5678 * @return Whether the device is in touch mode.
5679 */
5680 @ViewDebug.ExportedProperty
5681 public boolean isInTouchMode() {
5682 if (mAttachInfo != null) {
5683 return mAttachInfo.mInTouchMode;
5684 } else {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07005685 return ViewRootImpl.isInTouchMode();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005686 }
5687 }
5688
5689 /**
5690 * Returns the context the view is running in, through which it can
5691 * access the current theme, resources, etc.
5692 *
5693 * @return The view's Context.
5694 */
5695 @ViewDebug.CapturedViewProperty
5696 public final Context getContext() {
5697 return mContext;
5698 }
5699
5700 /**
5701 * Handle a key event before it is processed by any input method
5702 * associated with the view hierarchy. This can be used to intercept
5703 * key events in special situations before the IME consumes them; a
5704 * typical example would be handling the BACK key to update the application's
5705 * UI instead of allowing the IME to see it and close itself.
5706 *
5707 * @param keyCode The value in event.getKeyCode().
5708 * @param event Description of the key event.
5709 * @return If you handled the event, return true. If you want to allow the
5710 * event to be handled by the next receiver, return false.
5711 */
5712 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
5713 return false;
5714 }
5715
5716 /**
Jeff Brown995e7742010-12-22 16:59:36 -08005717 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
5718 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005719 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
5720 * is released, if the view is enabled and clickable.
5721 *
5722 * @param keyCode A key code that represents the button pressed, from
5723 * {@link android.view.KeyEvent}.
5724 * @param event The KeyEvent object that defines the button action.
5725 */
5726 public boolean onKeyDown(int keyCode, KeyEvent event) {
5727 boolean result = false;
5728
5729 switch (keyCode) {
5730 case KeyEvent.KEYCODE_DPAD_CENTER:
5731 case KeyEvent.KEYCODE_ENTER: {
5732 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
5733 return true;
5734 }
5735 // Long clickable items don't necessarily have to be clickable
5736 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
5737 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
5738 (event.getRepeatCount() == 0)) {
5739 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07005740 checkForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005741 return true;
5742 }
5743 break;
5744 }
5745 }
5746 return result;
5747 }
5748
5749 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07005750 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
5751 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
5752 * the event).
5753 */
5754 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
5755 return false;
5756 }
5757
5758 /**
Jeff Brown995e7742010-12-22 16:59:36 -08005759 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
5760 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005761 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
5762 * {@link KeyEvent#KEYCODE_ENTER} is released.
5763 *
5764 * @param keyCode A key code that represents the button pressed, from
5765 * {@link android.view.KeyEvent}.
5766 * @param event The KeyEvent object that defines the button action.
5767 */
5768 public boolean onKeyUp(int keyCode, KeyEvent event) {
5769 boolean result = false;
5770
5771 switch (keyCode) {
5772 case KeyEvent.KEYCODE_DPAD_CENTER:
5773 case KeyEvent.KEYCODE_ENTER: {
5774 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
5775 return true;
5776 }
5777 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
5778 setPressed(false);
5779
5780 if (!mHasPerformedLongPress) {
5781 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05005782 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005783
5784 result = performClick();
5785 }
5786 }
5787 break;
5788 }
5789 }
5790 return result;
5791 }
5792
5793 /**
5794 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
5795 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
5796 * the event).
5797 *
5798 * @param keyCode A key code that represents the button pressed, from
5799 * {@link android.view.KeyEvent}.
5800 * @param repeatCount The number of times the action was made.
5801 * @param event The KeyEvent object that defines the button action.
5802 */
5803 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
5804 return false;
5805 }
5806
5807 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08005808 * Called on the focused view when a key shortcut event is not handled.
5809 * Override this method to implement local key shortcuts for the View.
5810 * Key shortcuts can also be implemented by setting the
5811 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005812 *
5813 * @param keyCode The value in event.getKeyCode().
5814 * @param event Description of the key event.
5815 * @return If you handled the event, return true. If you want to allow the
5816 * event to be handled by the next receiver, return false.
5817 */
5818 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
5819 return false;
5820 }
5821
5822 /**
5823 * Check whether the called view is a text editor, in which case it
5824 * would make sense to automatically display a soft input window for
5825 * it. Subclasses should override this if they implement
5826 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005827 * a call on that method would return a non-null InputConnection, and
5828 * they are really a first-class editor that the user would normally
5829 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07005830 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005831 * <p>The default implementation always returns false. This does
5832 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
5833 * will not be called or the user can not otherwise perform edits on your
5834 * view; it is just a hint to the system that this is not the primary
5835 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07005836 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005837 * @return Returns true if this view is a text editor, else false.
5838 */
5839 public boolean onCheckIsTextEditor() {
5840 return false;
5841 }
Romain Guy8506ab42009-06-11 17:35:47 -07005842
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005843 /**
5844 * Create a new InputConnection for an InputMethod to interact
5845 * with the view. The default implementation returns null, since it doesn't
5846 * support input methods. You can override this to implement such support.
5847 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07005848 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005849 * <p>When implementing this, you probably also want to implement
5850 * {@link #onCheckIsTextEditor()} to indicate you will return a
5851 * non-null InputConnection.
5852 *
5853 * @param outAttrs Fill in with attribute information about the connection.
5854 */
5855 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
5856 return null;
5857 }
5858
5859 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005860 * Called by the {@link android.view.inputmethod.InputMethodManager}
5861 * when a view who is not the current
5862 * input connection target is trying to make a call on the manager. The
5863 * default implementation returns false; you can override this to return
5864 * true for certain views if you are performing InputConnection proxying
5865 * to them.
5866 * @param view The View that is making the InputMethodManager call.
5867 * @return Return true to allow the call, false to reject.
5868 */
5869 public boolean checkInputConnectionProxy(View view) {
5870 return false;
5871 }
Romain Guy8506ab42009-06-11 17:35:47 -07005872
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005873 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005874 * Show the context menu for this view. It is not safe to hold on to the
5875 * menu after returning from this method.
5876 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07005877 * You should normally not overload this method. Overload
5878 * {@link #onCreateContextMenu(ContextMenu)} or define an
5879 * {@link OnCreateContextMenuListener} to add items to the context menu.
5880 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005881 * @param menu The context menu to populate
5882 */
5883 public void createContextMenu(ContextMenu menu) {
5884 ContextMenuInfo menuInfo = getContextMenuInfo();
5885
5886 // Sets the current menu info so all items added to menu will have
5887 // my extra info set.
5888 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
5889
5890 onCreateContextMenu(menu);
5891 if (mOnCreateContextMenuListener != null) {
5892 mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
5893 }
5894
5895 // Clear the extra information so subsequent items that aren't mine don't
5896 // have my extra info.
5897 ((MenuBuilder)menu).setCurrentMenuInfo(null);
5898
5899 if (mParent != null) {
5900 mParent.createContextMenu(menu);
5901 }
5902 }
5903
5904 /**
5905 * Views should implement this if they have extra information to associate
5906 * with the context menu. The return result is supplied as a parameter to
5907 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
5908 * callback.
5909 *
5910 * @return Extra information about the item for which the context menu
5911 * should be shown. This information will vary across different
5912 * subclasses of View.
5913 */
5914 protected ContextMenuInfo getContextMenuInfo() {
5915 return null;
5916 }
5917
5918 /**
5919 * Views should implement this if the view itself is going to add items to
5920 * the context menu.
5921 *
5922 * @param menu the context menu to populate
5923 */
5924 protected void onCreateContextMenu(ContextMenu menu) {
5925 }
5926
5927 /**
5928 * Implement this method to handle trackball motion events. The
5929 * <em>relative</em> movement of the trackball since the last event
5930 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
5931 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
5932 * that a movement of 1 corresponds to the user pressing one DPAD key (so
5933 * they will often be fractional values, representing the more fine-grained
5934 * movement information available from a trackball).
5935 *
5936 * @param event The motion event.
5937 * @return True if the event was handled, false otherwise.
5938 */
5939 public boolean onTrackballEvent(MotionEvent event) {
5940 return false;
5941 }
5942
5943 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08005944 * Implement this method to handle generic motion events.
5945 * <p>
Jeff Brown33bbfd22011-02-24 20:55:35 -08005946 * Generic motion events describe joystick movements, mouse hovers, track pad
5947 * touches, scroll wheel movements and other input events. The
Jeff Browncb1404e2011-01-15 18:14:15 -08005948 * {@link MotionEvent#getSource() source} of the motion event specifies
5949 * the class of input that was received. Implementations of this method
5950 * must examine the bits in the source before processing the event.
5951 * The following code example shows how this is done.
Jeff Brown33bbfd22011-02-24 20:55:35 -08005952 * </p><p>
5953 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
5954 * are delivered to the view under the pointer. All other generic motion events are
5955 * delivered to the focused view.
Jeff Browncb1404e2011-01-15 18:14:15 -08005956 * </p>
5957 * <code>
5958 * public boolean onGenericMotionEvent(MotionEvent event) {
5959 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_JOYSTICK) != 0) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08005960 * if (event.getAction() == MotionEvent.ACTION_MOVE) {
5961 * // process the joystick movement...
5962 * return true;
5963 * }
5964 * }
5965 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_POINTER) != 0) {
5966 * switch (event.getAction()) {
5967 * case MotionEvent.ACTION_HOVER_MOVE:
5968 * // process the mouse hover movement...
5969 * return true;
5970 * case MotionEvent.ACTION_SCROLL:
5971 * // process the scroll wheel movement...
5972 * return true;
5973 * }
Jeff Browncb1404e2011-01-15 18:14:15 -08005974 * }
5975 * return super.onGenericMotionEvent(event);
5976 * }
5977 * </code>
5978 *
5979 * @param event The generic motion event being processed.
Jeff Browna032cc02011-03-07 16:56:21 -08005980 * @return True if the event was handled, false otherwise.
Jeff Browncb1404e2011-01-15 18:14:15 -08005981 */
5982 public boolean onGenericMotionEvent(MotionEvent event) {
5983 return false;
5984 }
5985
5986 /**
Jeff Browna032cc02011-03-07 16:56:21 -08005987 * Implement this method to handle hover events.
5988 * <p>
Jeff Brown10b62902011-06-20 16:40:37 -07005989 * This method is called whenever a pointer is hovering into, over, or out of the
5990 * bounds of a view and the view is not currently being touched.
5991 * Hover events are represented as pointer events with action
5992 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE},
5993 * or {@link MotionEvent#ACTION_HOVER_EXIT}.
5994 * </p>
5995 * <ul>
5996 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER}
5997 * when the pointer enters the bounds of the view.</li>
5998 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE}
5999 * when the pointer has already entered the bounds of the view and has moved.</li>
6000 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT}
6001 * when the pointer has exited the bounds of the view or when the pointer is
6002 * about to go down due to a button click, tap, or similar user action that
6003 * causes the view to be touched.</li>
6004 * </ul>
6005 * <p>
6006 * The view should implement this method to return true to indicate that it is
6007 * handling the hover event, such as by changing its drawable state.
Jeff Browna032cc02011-03-07 16:56:21 -08006008 * </p><p>
Jeff Brown10b62902011-06-20 16:40:37 -07006009 * The default implementation calls {@link #setHovered} to update the hovered state
6010 * of the view when a hover enter or hover exit event is received, if the view
6011 * is enabled and is clickable.
Jeff Browna032cc02011-03-07 16:56:21 -08006012 * </p>
6013 *
6014 * @param event The motion event that describes the hover.
Jeff Brown10b62902011-06-20 16:40:37 -07006015 * @return True if the view handled the hover event.
6016 *
6017 * @see #isHovered
6018 * @see #setHovered
6019 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08006020 */
6021 public boolean onHoverEvent(MotionEvent event) {
Jeff Brown87b7f802011-06-21 18:35:45 -07006022 if (isHoverable()) {
Jeff Brown10b62902011-06-20 16:40:37 -07006023 switch (event.getAction()) {
6024 case MotionEvent.ACTION_HOVER_ENTER:
6025 setHovered(true);
6026 break;
6027 case MotionEvent.ACTION_HOVER_EXIT:
6028 setHovered(false);
6029 break;
6030 }
6031 return true;
Jeff Browna032cc02011-03-07 16:56:21 -08006032 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07006033 return false;
Jeff Browna032cc02011-03-07 16:56:21 -08006034 }
6035
6036 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07006037 * Returns true if the view should handle {@link #onHoverEvent}
6038 * by calling {@link #setHovered} to change its hovered state.
6039 *
6040 * @return True if the view is hoverable.
6041 */
6042 private boolean isHoverable() {
6043 final int viewFlags = mViewFlags;
Romain Guy02ccac62011-06-24 13:20:23 -07006044 //noinspection SimplifiableIfStatement
Jeff Brown87b7f802011-06-21 18:35:45 -07006045 if ((viewFlags & ENABLED_MASK) == DISABLED) {
6046 return false;
6047 }
6048
6049 return (viewFlags & CLICKABLE) == CLICKABLE
6050 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
6051 }
6052
6053 /**
Jeff Browna032cc02011-03-07 16:56:21 -08006054 * Returns true if the view is currently hovered.
6055 *
6056 * @return True if the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07006057 *
6058 * @see #setHovered
6059 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08006060 */
Jeff Brown10b62902011-06-20 16:40:37 -07006061 @ViewDebug.ExportedProperty
Jeff Browna032cc02011-03-07 16:56:21 -08006062 public boolean isHovered() {
6063 return (mPrivateFlags & HOVERED) != 0;
6064 }
6065
6066 /**
6067 * Sets whether the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07006068 * <p>
6069 * Calling this method also changes the drawable state of the view. This
6070 * enables the view to react to hover by using different drawable resources
6071 * to change its appearance.
6072 * </p><p>
6073 * The {@link #onHoverChanged} method is called when the hovered state changes.
6074 * </p>
Jeff Browna032cc02011-03-07 16:56:21 -08006075 *
6076 * @param hovered True if the view is hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07006077 *
6078 * @see #isHovered
6079 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08006080 */
6081 public void setHovered(boolean hovered) {
6082 if (hovered) {
6083 if ((mPrivateFlags & HOVERED) == 0) {
6084 mPrivateFlags |= HOVERED;
6085 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07006086 onHoverChanged(true);
Jeff Browna032cc02011-03-07 16:56:21 -08006087 }
6088 } else {
6089 if ((mPrivateFlags & HOVERED) != 0) {
6090 mPrivateFlags &= ~HOVERED;
6091 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07006092 onHoverChanged(false);
Jeff Browna032cc02011-03-07 16:56:21 -08006093 }
6094 }
6095 }
6096
6097 /**
Jeff Brown10b62902011-06-20 16:40:37 -07006098 * Implement this method to handle hover state changes.
6099 * <p>
6100 * This method is called whenever the hover state changes as a result of a
6101 * call to {@link #setHovered}.
6102 * </p>
6103 *
6104 * @param hovered The current hover state, as returned by {@link #isHovered}.
6105 *
6106 * @see #isHovered
6107 * @see #setHovered
6108 */
6109 public void onHoverChanged(boolean hovered) {
Jeff Brown10b62902011-06-20 16:40:37 -07006110 }
6111
6112 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006113 * Implement this method to handle touch screen motion events.
6114 *
6115 * @param event The motion event.
6116 * @return True if the event was handled, false otherwise.
6117 */
6118 public boolean onTouchEvent(MotionEvent event) {
6119 final int viewFlags = mViewFlags;
6120
6121 if ((viewFlags & ENABLED_MASK) == DISABLED) {
Svetoslav Ganov77b80c02011-03-15 20:52:58 -07006122 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PRESSED) != 0) {
6123 mPrivateFlags &= ~PRESSED;
6124 refreshDrawableState();
6125 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006126 // A disabled view that is clickable still consumes the touch
6127 // events, it just doesn't respond to them.
6128 return (((viewFlags & CLICKABLE) == CLICKABLE ||
6129 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
6130 }
6131
6132 if (mTouchDelegate != null) {
6133 if (mTouchDelegate.onTouchEvent(event)) {
6134 return true;
6135 }
6136 }
6137
6138 if (((viewFlags & CLICKABLE) == CLICKABLE ||
6139 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
6140 switch (event.getAction()) {
6141 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08006142 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
6143 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006144 // take focus if we don't have it already and we should in
6145 // touch mode.
6146 boolean focusTaken = false;
6147 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
6148 focusTaken = requestFocus();
6149 }
6150
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08006151 if (prepressed) {
6152 // The button is being released before we actually
6153 // showed it as pressed. Make it show the pressed
6154 // state now (before scheduling the click) to ensure
6155 // the user sees it.
6156 mPrivateFlags |= PRESSED;
6157 refreshDrawableState();
6158 }
Joe Malin32736f02011-01-19 16:14:20 -08006159
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006160 if (!mHasPerformedLongPress) {
6161 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05006162 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006163
6164 // Only perform take click actions if we were in the pressed state
6165 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08006166 // Use a Runnable and post this rather than calling
6167 // performClick directly. This lets other visual state
6168 // of the view update before click actions start.
6169 if (mPerformClick == null) {
6170 mPerformClick = new PerformClick();
6171 }
6172 if (!post(mPerformClick)) {
6173 performClick();
6174 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006175 }
6176 }
6177
6178 if (mUnsetPressedState == null) {
6179 mUnsetPressedState = new UnsetPressedState();
6180 }
6181
Adam Powelle14579b2009-12-16 18:39:52 -08006182 if (prepressed) {
Adam Powelle14579b2009-12-16 18:39:52 -08006183 postDelayed(mUnsetPressedState,
6184 ViewConfiguration.getPressedStateDuration());
6185 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006186 // If the post failed, unpress right now
6187 mUnsetPressedState.run();
6188 }
Adam Powelle14579b2009-12-16 18:39:52 -08006189 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006190 }
6191 break;
6192
6193 case MotionEvent.ACTION_DOWN:
Adam Powell3b023392010-03-11 16:30:28 -08006194 mHasPerformedLongPress = false;
Patrick Dubroye0a799a2011-05-04 16:19:22 -07006195
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07006196 if (performButtonActionOnTouchDown(event)) {
6197 break;
6198 }
6199
Patrick Dubroye0a799a2011-05-04 16:19:22 -07006200 // Walk up the hierarchy to determine if we're inside a scrolling container.
6201 boolean isInScrollingContainer = false;
6202 ViewParent p = getParent();
6203 while (p != null && p instanceof ViewGroup) {
6204 if (((ViewGroup) p).shouldDelayChildPressedState()) {
6205 isInScrollingContainer = true;
6206 break;
6207 }
6208 p = p.getParent();
6209 }
6210
6211 // For views inside a scrolling container, delay the pressed feedback for
6212 // a short period in case this is a scroll.
6213 if (isInScrollingContainer) {
6214 mPrivateFlags |= PREPRESSED;
6215 if (mPendingCheckForTap == null) {
6216 mPendingCheckForTap = new CheckForTap();
6217 }
6218 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
6219 } else {
6220 // Not inside a scrolling container, so show the feedback right away
6221 mPrivateFlags |= PRESSED;
6222 refreshDrawableState();
6223 checkForLongClick(0);
6224 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006225 break;
6226
6227 case MotionEvent.ACTION_CANCEL:
6228 mPrivateFlags &= ~PRESSED;
6229 refreshDrawableState();
Adam Powelle14579b2009-12-16 18:39:52 -08006230 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006231 break;
6232
6233 case MotionEvent.ACTION_MOVE:
6234 final int x = (int) event.getX();
6235 final int y = (int) event.getY();
6236
6237 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07006238 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006239 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08006240 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006241 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08006242 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05006243 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006244
6245 // Need to switch from pressed to not pressed
6246 mPrivateFlags &= ~PRESSED;
6247 refreshDrawableState();
6248 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006249 }
6250 break;
6251 }
6252 return true;
6253 }
6254
6255 return false;
6256 }
6257
6258 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05006259 * Remove the longpress detection timer.
6260 */
6261 private void removeLongPressCallback() {
6262 if (mPendingCheckForLongPress != null) {
6263 removeCallbacks(mPendingCheckForLongPress);
6264 }
6265 }
Adam Powell3cb8b632011-01-21 15:34:14 -08006266
6267 /**
6268 * Remove the pending click action
6269 */
6270 private void removePerformClickCallback() {
6271 if (mPerformClick != null) {
6272 removeCallbacks(mPerformClick);
6273 }
6274 }
6275
Adam Powelle14579b2009-12-16 18:39:52 -08006276 /**
Romain Guya440b002010-02-24 15:57:54 -08006277 * Remove the prepress detection timer.
6278 */
6279 private void removeUnsetPressCallback() {
6280 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
6281 setPressed(false);
6282 removeCallbacks(mUnsetPressedState);
6283 }
6284 }
6285
6286 /**
Adam Powelle14579b2009-12-16 18:39:52 -08006287 * Remove the tap detection timer.
6288 */
6289 private void removeTapCallback() {
6290 if (mPendingCheckForTap != null) {
6291 mPrivateFlags &= ~PREPRESSED;
6292 removeCallbacks(mPendingCheckForTap);
6293 }
6294 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05006295
6296 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006297 * Cancels a pending long press. Your subclass can use this if you
6298 * want the context menu to come up if the user presses and holds
6299 * at the same place, but you don't want it to come up if they press
6300 * and then move around enough to cause scrolling.
6301 */
6302 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05006303 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08006304
6305 /*
6306 * The prepressed state handled by the tap callback is a display
6307 * construct, but the tap callback will post a long press callback
6308 * less its own timeout. Remove it here.
6309 */
6310 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006311 }
6312
6313 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -07006314 * Remove the pending callback for sending a
6315 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
6316 */
6317 private void removeSendViewScrolledAccessibilityEventCallback() {
6318 if (mSendViewScrolledAccessibilityEvent != null) {
6319 removeCallbacks(mSendViewScrolledAccessibilityEvent);
6320 }
6321 }
6322
6323 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006324 * Sets the TouchDelegate for this View.
6325 */
6326 public void setTouchDelegate(TouchDelegate delegate) {
6327 mTouchDelegate = delegate;
6328 }
6329
6330 /**
6331 * Gets the TouchDelegate for this View.
6332 */
6333 public TouchDelegate getTouchDelegate() {
6334 return mTouchDelegate;
6335 }
6336
6337 /**
6338 * Set flags controlling behavior of this view.
6339 *
6340 * @param flags Constant indicating the value which should be set
6341 * @param mask Constant indicating the bit range that should be changed
6342 */
6343 void setFlags(int flags, int mask) {
6344 int old = mViewFlags;
6345 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
6346
6347 int changed = mViewFlags ^ old;
6348 if (changed == 0) {
6349 return;
6350 }
6351 int privateFlags = mPrivateFlags;
6352
6353 /* Check if the FOCUSABLE bit has changed */
6354 if (((changed & FOCUSABLE_MASK) != 0) &&
6355 ((privateFlags & HAS_BOUNDS) !=0)) {
6356 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
6357 && ((privateFlags & FOCUSED) != 0)) {
6358 /* Give up focus if we are no longer focusable */
6359 clearFocus();
6360 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
6361 && ((privateFlags & FOCUSED) == 0)) {
6362 /*
6363 * Tell the view system that we are now available to take focus
6364 * if no one else already has it.
6365 */
6366 if (mParent != null) mParent.focusableViewAvailable(this);
6367 }
6368 }
6369
6370 if ((flags & VISIBILITY_MASK) == VISIBLE) {
6371 if ((changed & VISIBILITY_MASK) != 0) {
6372 /*
6373 * If this view is becoming visible, set the DRAWN flag so that
6374 * the next invalidate() will not be skipped.
6375 */
6376 mPrivateFlags |= DRAWN;
6377
6378 needGlobalAttributesUpdate(true);
6379
6380 // a view becoming visible is worth notifying the parent
6381 // about in case nothing has focus. even if this specific view
6382 // isn't focusable, it may contain something that is, so let
6383 // the root view try to give this focus if nothing else does.
6384 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
6385 mParent.focusableViewAvailable(this);
6386 }
6387 }
6388 }
6389
6390 /* Check if the GONE bit has changed */
6391 if ((changed & GONE) != 0) {
6392 needGlobalAttributesUpdate(false);
6393 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08006394 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006395
Romain Guyecd80ee2009-12-03 17:13:02 -08006396 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
6397 if (hasFocus()) clearFocus();
6398 destroyDrawingCache();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006399 }
6400 if (mAttachInfo != null) {
6401 mAttachInfo.mViewVisibilityChanged = true;
6402 }
6403 }
6404
6405 /* Check if the VISIBLE bit has changed */
6406 if ((changed & INVISIBLE) != 0) {
6407 needGlobalAttributesUpdate(false);
Chet Haasec8a9a702011-06-17 12:13:42 -07006408 /*
6409 * If this view is becoming invisible, set the DRAWN flag so that
6410 * the next invalidate() will not be skipped.
6411 */
6412 mPrivateFlags |= DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006413
6414 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
6415 // root view becoming invisible shouldn't clear focus
6416 if (getRootView() != this) {
6417 clearFocus();
6418 }
6419 }
6420 if (mAttachInfo != null) {
6421 mAttachInfo.mViewVisibilityChanged = true;
6422 }
6423 }
6424
Adam Powell326d8082009-12-09 15:10:07 -08006425 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07006426 if (mParent instanceof ViewGroup) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006427 ((ViewGroup) mParent).onChildVisibilityChanged(this, (flags & VISIBILITY_MASK));
6428 ((View) mParent).invalidate(true);
Chet Haase5e25c2c2010-09-16 11:15:56 -07006429 }
Adam Powell326d8082009-12-09 15:10:07 -08006430 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
6431 }
6432
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006433 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
6434 destroyDrawingCache();
6435 }
6436
6437 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
6438 destroyDrawingCache();
6439 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Romain Guy0fd89bf2011-01-26 15:41:30 -08006440 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006441 }
6442
6443 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
6444 destroyDrawingCache();
6445 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6446 }
6447
6448 if ((changed & DRAW_MASK) != 0) {
6449 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
6450 if (mBGDrawable != null) {
6451 mPrivateFlags &= ~SKIP_DRAW;
6452 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
6453 } else {
6454 mPrivateFlags |= SKIP_DRAW;
6455 }
6456 } else {
6457 mPrivateFlags &= ~SKIP_DRAW;
6458 }
6459 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08006460 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006461 }
6462
6463 if ((changed & KEEP_SCREEN_ON) != 0) {
Joe Onorato664644d2011-01-23 17:53:23 -08006464 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006465 mParent.recomputeViewAttributes(this);
6466 }
6467 }
Cibu Johny7632cb92010-02-22 13:01:02 -08006468
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07006469 if ((changed & LAYOUT_DIRECTION_MASK) != 0) {
Cibu Johny7632cb92010-02-22 13:01:02 -08006470 requestLayout();
6471 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006472 }
6473
6474 /**
6475 * Change the view's z order in the tree, so it's on top of other sibling
6476 * views
6477 */
6478 public void bringToFront() {
6479 if (mParent != null) {
6480 mParent.bringChildToFront(this);
6481 }
6482 }
6483
6484 /**
6485 * This is called in response to an internal scroll in this view (i.e., the
6486 * view scrolled its own contents). This is typically as a result of
6487 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
6488 * called.
6489 *
6490 * @param l Current horizontal scroll origin.
6491 * @param t Current vertical scroll origin.
6492 * @param oldl Previous horizontal scroll origin.
6493 * @param oldt Previous vertical scroll origin.
6494 */
6495 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Svetoslav Ganova0156172011-06-26 17:55:44 -07006496 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
6497 postSendViewScrolledAccessibilityEventCallback();
6498 }
6499
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006500 mBackgroundSizeChanged = true;
6501
6502 final AttachInfo ai = mAttachInfo;
6503 if (ai != null) {
6504 ai.mViewScrollChanged = true;
6505 }
6506 }
6507
6508 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006509 * Interface definition for a callback to be invoked when the layout bounds of a view
6510 * changes due to layout processing.
6511 */
6512 public interface OnLayoutChangeListener {
6513 /**
6514 * Called when the focus state of a view has changed.
6515 *
6516 * @param v The view whose state has changed.
6517 * @param left The new value of the view's left property.
6518 * @param top The new value of the view's top property.
6519 * @param right The new value of the view's right property.
6520 * @param bottom The new value of the view's bottom property.
6521 * @param oldLeft The previous value of the view's left property.
6522 * @param oldTop The previous value of the view's top property.
6523 * @param oldRight The previous value of the view's right property.
6524 * @param oldBottom The previous value of the view's bottom property.
6525 */
6526 void onLayoutChange(View v, int left, int top, int right, int bottom,
6527 int oldLeft, int oldTop, int oldRight, int oldBottom);
6528 }
6529
6530 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006531 * This is called during layout when the size of this view has changed. If
6532 * you were just added to the view hierarchy, you're called with the old
6533 * values of 0.
6534 *
6535 * @param w Current width of this view.
6536 * @param h Current height of this view.
6537 * @param oldw Old width of this view.
6538 * @param oldh Old height of this view.
6539 */
6540 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
6541 }
6542
6543 /**
6544 * Called by draw to draw the child views. This may be overridden
6545 * by derived classes to gain control just before its children are drawn
6546 * (but after its own view has been drawn).
6547 * @param canvas the canvas on which to draw the view
6548 */
6549 protected void dispatchDraw(Canvas canvas) {
6550 }
6551
6552 /**
6553 * Gets the parent of this view. Note that the parent is a
6554 * ViewParent and not necessarily a View.
6555 *
6556 * @return Parent of this view.
6557 */
6558 public final ViewParent getParent() {
6559 return mParent;
6560 }
6561
6562 /**
Chet Haasecca2c982011-05-20 14:34:18 -07006563 * Set the horizontal scrolled position of your view. This will cause a call to
6564 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6565 * invalidated.
6566 * @param value the x position to scroll to
6567 */
6568 public void setScrollX(int value) {
6569 scrollTo(value, mScrollY);
6570 }
6571
6572 /**
6573 * Set the vertical scrolled position of your view. This will cause a call to
6574 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6575 * invalidated.
6576 * @param value the y position to scroll to
6577 */
6578 public void setScrollY(int value) {
6579 scrollTo(mScrollX, value);
6580 }
6581
6582 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006583 * Return the scrolled left position of this view. This is the left edge of
6584 * the displayed part of your view. You do not need to draw any pixels
6585 * farther left, since those are outside of the frame of your view on
6586 * screen.
6587 *
6588 * @return The left edge of the displayed part of your view, in pixels.
6589 */
6590 public final int getScrollX() {
6591 return mScrollX;
6592 }
6593
6594 /**
6595 * Return the scrolled top position of this view. This is the top edge of
6596 * the displayed part of your view. You do not need to draw any pixels above
6597 * it, since those are outside of the frame of your view on screen.
6598 *
6599 * @return The top edge of the displayed part of your view, in pixels.
6600 */
6601 public final int getScrollY() {
6602 return mScrollY;
6603 }
6604
6605 /**
6606 * Return the width of the your view.
6607 *
6608 * @return The width of your view, in pixels.
6609 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07006610 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006611 public final int getWidth() {
6612 return mRight - mLeft;
6613 }
6614
6615 /**
6616 * Return the height of your view.
6617 *
6618 * @return The height of your view, in pixels.
6619 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07006620 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006621 public final int getHeight() {
6622 return mBottom - mTop;
6623 }
6624
6625 /**
6626 * Return the visible drawing bounds of your view. Fills in the output
6627 * rectangle with the values from getScrollX(), getScrollY(),
6628 * getWidth(), and getHeight().
6629 *
6630 * @param outRect The (scrolled) drawing bounds of the view.
6631 */
6632 public void getDrawingRect(Rect outRect) {
6633 outRect.left = mScrollX;
6634 outRect.top = mScrollY;
6635 outRect.right = mScrollX + (mRight - mLeft);
6636 outRect.bottom = mScrollY + (mBottom - mTop);
6637 }
6638
6639 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08006640 * Like {@link #getMeasuredWidthAndState()}, but only returns the
6641 * raw width component (that is the result is masked by
6642 * {@link #MEASURED_SIZE_MASK}).
6643 *
6644 * @return The raw measured width of this view.
6645 */
6646 public final int getMeasuredWidth() {
6647 return mMeasuredWidth & MEASURED_SIZE_MASK;
6648 }
6649
6650 /**
6651 * Return the full width measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07006652 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08006653 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006654 * This should be used during measurement and layout calculations only. Use
6655 * {@link #getWidth()} to see how wide a view is after layout.
6656 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08006657 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006658 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08006659 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006660 return mMeasuredWidth;
6661 }
6662
6663 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08006664 * Like {@link #getMeasuredHeightAndState()}, but only returns the
6665 * raw width component (that is the result is masked by
6666 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006667 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08006668 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006669 */
6670 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08006671 return mMeasuredHeight & MEASURED_SIZE_MASK;
6672 }
6673
6674 /**
6675 * Return the full height measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07006676 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08006677 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
6678 * This should be used during measurement and layout calculations only. Use
6679 * {@link #getHeight()} to see how wide a view is after layout.
6680 *
6681 * @return The measured width of this view as a bit mask.
6682 */
6683 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006684 return mMeasuredHeight;
6685 }
6686
6687 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08006688 * Return only the state bits of {@link #getMeasuredWidthAndState()}
6689 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
6690 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
6691 * and the height component is at the shifted bits
6692 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
6693 */
6694 public final int getMeasuredState() {
6695 return (mMeasuredWidth&MEASURED_STATE_MASK)
6696 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
6697 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
6698 }
6699
6700 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07006701 * The transform matrix of this view, which is calculated based on the current
6702 * roation, scale, and pivot properties.
6703 *
6704 * @see #getRotation()
6705 * @see #getScaleX()
6706 * @see #getScaleY()
6707 * @see #getPivotX()
6708 * @see #getPivotY()
6709 * @return The current transform matrix for the view
6710 */
6711 public Matrix getMatrix() {
Jeff Brown86671742010-09-30 20:00:15 -07006712 updateMatrix();
Romain Guy33e72ae2010-07-17 12:40:29 -07006713 return mMatrix;
6714 }
6715
6716 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07006717 * Utility function to determine if the value is far enough away from zero to be
6718 * considered non-zero.
6719 * @param value A floating point value to check for zero-ness
6720 * @return whether the passed-in value is far enough away from zero to be considered non-zero
6721 */
6722 private static boolean nonzero(float value) {
6723 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
6724 }
6725
6726 /**
Jeff Brown86671742010-09-30 20:00:15 -07006727 * Returns true if the transform matrix is the identity matrix.
6728 * Recomputes the matrix if necessary.
Joe Malin32736f02011-01-19 16:14:20 -08006729 *
Romain Guy33e72ae2010-07-17 12:40:29 -07006730 * @return True if the transform matrix is the identity matrix, false otherwise.
6731 */
Jeff Brown86671742010-09-30 20:00:15 -07006732 final boolean hasIdentityMatrix() {
6733 updateMatrix();
6734 return mMatrixIsIdentity;
6735 }
6736
6737 /**
6738 * Recomputes the transform matrix if necessary.
6739 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006740 private void updateMatrix() {
Chet Haasec3aa3612010-06-17 08:50:37 -07006741 if (mMatrixDirty) {
6742 // transform-related properties have changed since the last time someone
6743 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07006744
6745 // Figure out if we need to update the pivot point
6746 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006747 if ((mRight - mLeft) != mPrevWidth || (mBottom - mTop) != mPrevHeight) {
Chet Haasefd2b0022010-08-06 13:08:56 -07006748 mPrevWidth = mRight - mLeft;
6749 mPrevHeight = mBottom - mTop;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -08006750 mPivotX = mPrevWidth / 2f;
6751 mPivotY = mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07006752 }
6753 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006754 mMatrix.reset();
Chet Haase897247b2010-09-09 14:54:47 -07006755 if (!nonzero(mRotationX) && !nonzero(mRotationY)) {
6756 mMatrix.setTranslate(mTranslationX, mTranslationY);
6757 mMatrix.preRotate(mRotation, mPivotX, mPivotY);
6758 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
6759 } else {
Chet Haasefd2b0022010-08-06 13:08:56 -07006760 if (mCamera == null) {
6761 mCamera = new Camera();
6762 matrix3D = new Matrix();
6763 }
6764 mCamera.save();
Chet Haase897247b2010-09-09 14:54:47 -07006765 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
Romain Guy47b8ade2011-02-23 19:46:33 -08006766 mCamera.rotate(mRotationX, mRotationY, -mRotation);
Chet Haasefd2b0022010-08-06 13:08:56 -07006767 mCamera.getMatrix(matrix3D);
6768 matrix3D.preTranslate(-mPivotX, -mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07006769 matrix3D.postTranslate(mPivotX + mTranslationX, mPivotY + mTranslationY);
Chet Haasefd2b0022010-08-06 13:08:56 -07006770 mMatrix.postConcat(matrix3D);
6771 mCamera.restore();
6772 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006773 mMatrixDirty = false;
6774 mMatrixIsIdentity = mMatrix.isIdentity();
6775 mInverseMatrixDirty = true;
6776 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006777 }
6778
6779 /**
6780 * Utility method to retrieve the inverse of the current mMatrix property.
6781 * We cache the matrix to avoid recalculating it when transform properties
6782 * have not changed.
6783 *
6784 * @return The inverse of the current matrix of this view.
6785 */
Jeff Brown86671742010-09-30 20:00:15 -07006786 final Matrix getInverseMatrix() {
6787 updateMatrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07006788 if (mInverseMatrixDirty) {
6789 if (mInverseMatrix == null) {
6790 mInverseMatrix = new Matrix();
6791 }
6792 mMatrix.invert(mInverseMatrix);
6793 mInverseMatrixDirty = false;
6794 }
6795 return mInverseMatrix;
6796 }
6797
6798 /**
Romain Guya5364ee2011-02-24 14:46:04 -08006799 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which
6800 * views are drawn) from the camera to this view. The camera's distance
6801 * affects 3D transformations, for instance rotations around the X and Y
6802 * axis. If the rotationX or rotationY properties are changed and this view is
6803 * large (more than half the size of the screen), it is recommended to always
6804 * use a camera distance that's greater than the height (X axis rotation) or
6805 * the width (Y axis rotation) of this view.</p>
6806 *
6807 * <p>The distance of the camera from the view plane can have an affect on the
6808 * perspective distortion of the view when it is rotated around the x or y axis.
6809 * For example, a large distance will result in a large viewing angle, and there
6810 * will not be much perspective distortion of the view as it rotates. A short
6811 * distance may cause much more perspective distortion upon rotation, and can
6812 * also result in some drawing artifacts if the rotated view ends up partially
6813 * behind the camera (which is why the recommendation is to use a distance at
6814 * least as far as the size of the view, if the view is to be rotated.)</p>
6815 *
6816 * <p>The distance is expressed in "depth pixels." The default distance depends
6817 * on the screen density. For instance, on a medium density display, the
6818 * default distance is 1280. On a high density display, the default distance
6819 * is 1920.</p>
6820 *
6821 * <p>If you want to specify a distance that leads to visually consistent
6822 * results across various densities, use the following formula:</p>
6823 * <pre>
6824 * float scale = context.getResources().getDisplayMetrics().density;
6825 * view.setCameraDistance(distance * scale);
6826 * </pre>
6827 *
6828 * <p>The density scale factor of a high density display is 1.5,
6829 * and 1920 = 1280 * 1.5.</p>
6830 *
6831 * @param distance The distance in "depth pixels", if negative the opposite
6832 * value is used
6833 *
6834 * @see #setRotationX(float)
6835 * @see #setRotationY(float)
6836 */
6837 public void setCameraDistance(float distance) {
6838 invalidateParentCaches();
6839 invalidate(false);
6840
6841 final float dpi = mResources.getDisplayMetrics().densityDpi;
6842 if (mCamera == null) {
6843 mCamera = new Camera();
6844 matrix3D = new Matrix();
6845 }
6846
6847 mCamera.setLocation(0.0f, 0.0f, -Math.abs(distance) / dpi);
6848 mMatrixDirty = true;
6849
6850 invalidate(false);
6851 }
6852
6853 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07006854 * The degrees that the view is rotated around the pivot point.
6855 *
Romain Guya5364ee2011-02-24 14:46:04 -08006856 * @see #setRotation(float)
Chet Haasec3aa3612010-06-17 08:50:37 -07006857 * @see #getPivotX()
6858 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08006859 *
Chet Haasec3aa3612010-06-17 08:50:37 -07006860 * @return The degrees of rotation.
6861 */
6862 public float getRotation() {
6863 return mRotation;
6864 }
6865
6866 /**
Chet Haase897247b2010-09-09 14:54:47 -07006867 * Sets the degrees that the view is rotated around the pivot point. Increasing values
6868 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07006869 *
6870 * @param rotation The degrees of rotation.
Romain Guya5364ee2011-02-24 14:46:04 -08006871 *
6872 * @see #getRotation()
Chet Haasec3aa3612010-06-17 08:50:37 -07006873 * @see #getPivotX()
6874 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08006875 * @see #setRotationX(float)
6876 * @see #setRotationY(float)
Chet Haase73066682010-11-29 15:55:32 -08006877 *
6878 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07006879 */
6880 public void setRotation(float rotation) {
6881 if (mRotation != rotation) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006882 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07006883 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006884 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006885 mRotation = rotation;
6886 mMatrixDirty = true;
6887 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006888 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006889 }
6890 }
6891
6892 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07006893 * The degrees that the view is rotated around the vertical axis through the pivot point.
6894 *
6895 * @see #getPivotX()
6896 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08006897 * @see #setRotationY(float)
6898 *
Chet Haasefd2b0022010-08-06 13:08:56 -07006899 * @return The degrees of Y rotation.
6900 */
6901 public float getRotationY() {
6902 return mRotationY;
6903 }
6904
6905 /**
Chet Haase897247b2010-09-09 14:54:47 -07006906 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
6907 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
6908 * down the y axis.
Romain Guya5364ee2011-02-24 14:46:04 -08006909 *
6910 * When rotating large views, it is recommended to adjust the camera distance
6911 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07006912 *
6913 * @param rotationY The degrees of Y rotation.
Romain Guya5364ee2011-02-24 14:46:04 -08006914 *
6915 * @see #getRotationY()
Chet Haasefd2b0022010-08-06 13:08:56 -07006916 * @see #getPivotX()
6917 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08006918 * @see #setRotation(float)
6919 * @see #setRotationX(float)
6920 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08006921 *
6922 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07006923 */
6924 public void setRotationY(float rotationY) {
6925 if (mRotationY != rotationY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006926 invalidateParentCaches();
Chet Haasefd2b0022010-08-06 13:08:56 -07006927 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006928 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07006929 mRotationY = rotationY;
6930 mMatrixDirty = true;
6931 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006932 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07006933 }
6934 }
6935
6936 /**
6937 * The degrees that the view is rotated around the horizontal axis through the pivot point.
6938 *
6939 * @see #getPivotX()
6940 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08006941 * @see #setRotationX(float)
6942 *
Chet Haasefd2b0022010-08-06 13:08:56 -07006943 * @return The degrees of X rotation.
6944 */
6945 public float getRotationX() {
6946 return mRotationX;
6947 }
6948
6949 /**
Chet Haase897247b2010-09-09 14:54:47 -07006950 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
6951 * Increasing values result in clockwise rotation from the viewpoint of looking down the
6952 * x axis.
Romain Guya5364ee2011-02-24 14:46:04 -08006953 *
6954 * When rotating large views, it is recommended to adjust the camera distance
6955 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07006956 *
6957 * @param rotationX The degrees of X rotation.
Romain Guya5364ee2011-02-24 14:46:04 -08006958 *
6959 * @see #getRotationX()
Chet Haasefd2b0022010-08-06 13:08:56 -07006960 * @see #getPivotX()
6961 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08006962 * @see #setRotation(float)
6963 * @see #setRotationY(float)
6964 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08006965 *
6966 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07006967 */
6968 public void setRotationX(float rotationX) {
6969 if (mRotationX != rotationX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006970 invalidateParentCaches();
Chet Haasefd2b0022010-08-06 13:08:56 -07006971 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006972 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07006973 mRotationX = rotationX;
6974 mMatrixDirty = true;
6975 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006976 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07006977 }
6978 }
6979
6980 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07006981 * The amount that the view is scaled in x around the pivot point, as a proportion of
6982 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
6983 *
Joe Onorato93162322010-09-16 15:42:01 -04006984 * <p>By default, this is 1.0f.
6985 *
Chet Haasec3aa3612010-06-17 08:50:37 -07006986 * @see #getPivotX()
6987 * @see #getPivotY()
6988 * @return The scaling factor.
6989 */
6990 public float getScaleX() {
6991 return mScaleX;
6992 }
6993
6994 /**
6995 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
6996 * the view's unscaled width. A value of 1 means that no scaling is applied.
6997 *
6998 * @param scaleX The scaling factor.
6999 * @see #getPivotX()
7000 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08007001 *
7002 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07007003 */
7004 public void setScaleX(float scaleX) {
7005 if (mScaleX != scaleX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007006 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07007007 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007008 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007009 mScaleX = scaleX;
7010 mMatrixDirty = true;
7011 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007012 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007013 }
7014 }
7015
7016 /**
7017 * The amount that the view is scaled in y around the pivot point, as a proportion of
7018 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
7019 *
Joe Onorato93162322010-09-16 15:42:01 -04007020 * <p>By default, this is 1.0f.
7021 *
Chet Haasec3aa3612010-06-17 08:50:37 -07007022 * @see #getPivotX()
7023 * @see #getPivotY()
7024 * @return The scaling factor.
7025 */
7026 public float getScaleY() {
7027 return mScaleY;
7028 }
7029
7030 /**
7031 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
7032 * the view's unscaled width. A value of 1 means that no scaling is applied.
7033 *
7034 * @param scaleY The scaling factor.
7035 * @see #getPivotX()
7036 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08007037 *
7038 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07007039 */
7040 public void setScaleY(float scaleY) {
7041 if (mScaleY != scaleY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007042 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07007043 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007044 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007045 mScaleY = scaleY;
7046 mMatrixDirty = true;
7047 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007048 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007049 }
7050 }
7051
7052 /**
7053 * The x location of the point around which the view is {@link #setRotation(float) rotated}
7054 * and {@link #setScaleX(float) scaled}.
7055 *
7056 * @see #getRotation()
7057 * @see #getScaleX()
7058 * @see #getScaleY()
7059 * @see #getPivotY()
7060 * @return The x location of the pivot point.
7061 */
7062 public float getPivotX() {
7063 return mPivotX;
7064 }
7065
7066 /**
7067 * Sets the x location of the point around which the view is
7068 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07007069 * By default, the pivot point is centered on the object.
7070 * Setting this property disables this behavior and causes the view to use only the
7071 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07007072 *
7073 * @param pivotX The x location of the pivot point.
7074 * @see #getRotation()
7075 * @see #getScaleX()
7076 * @see #getScaleY()
7077 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08007078 *
7079 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07007080 */
7081 public void setPivotX(float pivotX) {
Chet Haasefd2b0022010-08-06 13:08:56 -07007082 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07007083 if (mPivotX != pivotX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007084 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07007085 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007086 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007087 mPivotX = pivotX;
7088 mMatrixDirty = true;
7089 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007090 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007091 }
7092 }
7093
7094 /**
7095 * The y location of the point around which the view is {@link #setRotation(float) rotated}
7096 * and {@link #setScaleY(float) scaled}.
7097 *
7098 * @see #getRotation()
7099 * @see #getScaleX()
7100 * @see #getScaleY()
7101 * @see #getPivotY()
7102 * @return The y location of the pivot point.
7103 */
7104 public float getPivotY() {
7105 return mPivotY;
7106 }
7107
7108 /**
7109 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07007110 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
7111 * Setting this property disables this behavior and causes the view to use only the
7112 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07007113 *
7114 * @param pivotY The y location of the pivot point.
7115 * @see #getRotation()
7116 * @see #getScaleX()
7117 * @see #getScaleY()
7118 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08007119 *
7120 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07007121 */
7122 public void setPivotY(float pivotY) {
Chet Haasefd2b0022010-08-06 13:08:56 -07007123 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07007124 if (mPivotY != pivotY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007125 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07007126 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007127 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007128 mPivotY = pivotY;
7129 mMatrixDirty = true;
7130 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007131 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007132 }
7133 }
7134
7135 /**
7136 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
7137 * completely transparent and 1 means the view is completely opaque.
7138 *
Joe Onorato93162322010-09-16 15:42:01 -04007139 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07007140 * @return The opacity of the view.
7141 */
7142 public float getAlpha() {
7143 return mAlpha;
7144 }
7145
7146 /**
Romain Guy171c5922011-01-06 10:04:23 -08007147 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
7148 * completely transparent and 1 means the view is completely opaque.</p>
Joe Malin32736f02011-01-19 16:14:20 -08007149 *
Romain Guy171c5922011-01-06 10:04:23 -08007150 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
7151 * responsible for applying the opacity itself. Otherwise, calling this method is
7152 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
Joe Malin32736f02011-01-19 16:14:20 -08007153 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07007154 *
7155 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08007156 *
Joe Malin32736f02011-01-19 16:14:20 -08007157 * @see #setLayerType(int, android.graphics.Paint)
7158 *
Chet Haase73066682010-11-29 15:55:32 -08007159 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07007160 */
7161 public void setAlpha(float alpha) {
7162 mAlpha = alpha;
Romain Guy0fd89bf2011-01-26 15:41:30 -08007163 invalidateParentCaches();
Chet Haaseed032702010-10-01 14:05:54 -07007164 if (onSetAlpha((int) (alpha * 255))) {
Romain Guya3496a92010-10-12 11:53:24 -07007165 mPrivateFlags |= ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07007166 // subclass is handling alpha - don't optimize rendering cache invalidation
Romain Guy0fd89bf2011-01-26 15:41:30 -08007167 invalidate(true);
Chet Haaseed032702010-10-01 14:05:54 -07007168 } else {
Romain Guya3496a92010-10-12 11:53:24 -07007169 mPrivateFlags &= ~ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07007170 invalidate(false);
7171 }
Chet Haasec3aa3612010-06-17 08:50:37 -07007172 }
7173
7174 /**
Chet Haasea00f3862011-02-22 06:34:40 -08007175 * Faster version of setAlpha() which performs the same steps except there are
7176 * no calls to invalidate(). The caller of this function should perform proper invalidation
7177 * on the parent and this object. The return value indicates whether the subclass handles
7178 * alpha (the return value for onSetAlpha()).
7179 *
7180 * @param alpha The new value for the alpha property
7181 * @return true if the View subclass handles alpha (the return value for onSetAlpha())
7182 */
7183 boolean setAlphaNoInvalidation(float alpha) {
7184 mAlpha = alpha;
7185 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255));
7186 if (subclassHandlesAlpha) {
7187 mPrivateFlags |= ALPHA_SET;
7188 } else {
7189 mPrivateFlags &= ~ALPHA_SET;
7190 }
7191 return subclassHandlesAlpha;
7192 }
7193
7194 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007195 * Top position of this view relative to its parent.
7196 *
7197 * @return The top of this view, in pixels.
7198 */
7199 @ViewDebug.CapturedViewProperty
7200 public final int getTop() {
7201 return mTop;
7202 }
7203
7204 /**
Chet Haase21cd1382010-09-01 17:42:29 -07007205 * Sets the top position of this view relative to its parent. This method is meant to be called
7206 * by the layout system and should not generally be called otherwise, because the property
7207 * may be changed at any time by the layout.
7208 *
7209 * @param top The top of this view, in pixels.
7210 */
7211 public final void setTop(int top) {
7212 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07007213 updateMatrix();
7214 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08007215 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07007216 int minTop;
7217 int yLoc;
7218 if (top < mTop) {
7219 minTop = top;
7220 yLoc = top - mTop;
7221 } else {
7222 minTop = mTop;
7223 yLoc = 0;
7224 }
Chet Haasee9140a72011-02-16 16:23:29 -08007225 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop);
Chet Haase21cd1382010-09-01 17:42:29 -07007226 }
7227 } else {
7228 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08007229 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007230 }
7231
Chet Haaseed032702010-10-01 14:05:54 -07007232 int width = mRight - mLeft;
7233 int oldHeight = mBottom - mTop;
7234
Chet Haase21cd1382010-09-01 17:42:29 -07007235 mTop = top;
7236
Chet Haaseed032702010-10-01 14:05:54 -07007237 onSizeChanged(width, mBottom - mTop, width, oldHeight);
7238
Chet Haase21cd1382010-09-01 17:42:29 -07007239 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08007240 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
7241 // A change in dimension means an auto-centered pivot point changes, too
7242 mMatrixDirty = true;
7243 }
Chet Haase21cd1382010-09-01 17:42:29 -07007244 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08007245 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007246 }
Chet Haase55dbb652010-12-21 20:15:08 -08007247 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08007248 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07007249 }
7250 }
7251
7252 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007253 * Bottom position of this view relative to its parent.
7254 *
7255 * @return The bottom of this view, in pixels.
7256 */
7257 @ViewDebug.CapturedViewProperty
7258 public final int getBottom() {
7259 return mBottom;
7260 }
7261
7262 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08007263 * True if this view has changed since the last time being drawn.
7264 *
7265 * @return The dirty state of this view.
7266 */
7267 public boolean isDirty() {
7268 return (mPrivateFlags & DIRTY_MASK) != 0;
7269 }
7270
7271 /**
Chet Haase21cd1382010-09-01 17:42:29 -07007272 * Sets the bottom position of this view relative to its parent. This method is meant to be
7273 * called by the layout system and should not generally be called otherwise, because the
7274 * property may be changed at any time by the layout.
7275 *
7276 * @param bottom The bottom of this view, in pixels.
7277 */
7278 public final void setBottom(int bottom) {
7279 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07007280 updateMatrix();
7281 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08007282 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07007283 int maxBottom;
7284 if (bottom < mBottom) {
7285 maxBottom = mBottom;
7286 } else {
7287 maxBottom = bottom;
7288 }
Chet Haasee9140a72011-02-16 16:23:29 -08007289 invalidate(0, 0, mRight - mLeft, maxBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07007290 }
7291 } else {
7292 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08007293 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007294 }
7295
Chet Haaseed032702010-10-01 14:05:54 -07007296 int width = mRight - mLeft;
7297 int oldHeight = mBottom - mTop;
7298
Chet Haase21cd1382010-09-01 17:42:29 -07007299 mBottom = bottom;
7300
Chet Haaseed032702010-10-01 14:05:54 -07007301 onSizeChanged(width, mBottom - mTop, width, oldHeight);
7302
Chet Haase21cd1382010-09-01 17:42:29 -07007303 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08007304 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
7305 // A change in dimension means an auto-centered pivot point changes, too
7306 mMatrixDirty = true;
7307 }
Chet Haase21cd1382010-09-01 17:42:29 -07007308 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08007309 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007310 }
Chet Haase55dbb652010-12-21 20:15:08 -08007311 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08007312 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07007313 }
7314 }
7315
7316 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007317 * Left position of this view relative to its parent.
7318 *
7319 * @return The left edge of this view, in pixels.
7320 */
7321 @ViewDebug.CapturedViewProperty
7322 public final int getLeft() {
7323 return mLeft;
7324 }
7325
7326 /**
Chet Haase21cd1382010-09-01 17:42:29 -07007327 * Sets the left position of this view relative to its parent. This method is meant to be called
7328 * by the layout system and should not generally be called otherwise, because the property
7329 * may be changed at any time by the layout.
7330 *
7331 * @param left The bottom of this view, in pixels.
7332 */
7333 public final void setLeft(int left) {
7334 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07007335 updateMatrix();
7336 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08007337 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07007338 int minLeft;
7339 int xLoc;
7340 if (left < mLeft) {
7341 minLeft = left;
7342 xLoc = left - mLeft;
7343 } else {
7344 minLeft = mLeft;
7345 xLoc = 0;
7346 }
Chet Haasee9140a72011-02-16 16:23:29 -08007347 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07007348 }
7349 } else {
7350 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08007351 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007352 }
7353
Chet Haaseed032702010-10-01 14:05:54 -07007354 int oldWidth = mRight - mLeft;
7355 int height = mBottom - mTop;
7356
Chet Haase21cd1382010-09-01 17:42:29 -07007357 mLeft = left;
7358
Chet Haaseed032702010-10-01 14:05:54 -07007359 onSizeChanged(mRight - mLeft, height, oldWidth, height);
7360
Chet Haase21cd1382010-09-01 17:42:29 -07007361 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08007362 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
7363 // A change in dimension means an auto-centered pivot point changes, too
7364 mMatrixDirty = true;
7365 }
Chet Haase21cd1382010-09-01 17:42:29 -07007366 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08007367 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007368 }
Chet Haase55dbb652010-12-21 20:15:08 -08007369 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08007370 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07007371 }
7372 }
7373
7374 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007375 * Right position of this view relative to its parent.
7376 *
7377 * @return The right edge of this view, in pixels.
7378 */
7379 @ViewDebug.CapturedViewProperty
7380 public final int getRight() {
7381 return mRight;
7382 }
7383
7384 /**
Chet Haase21cd1382010-09-01 17:42:29 -07007385 * Sets the right position of this view relative to its parent. This method is meant to be called
7386 * by the layout system and should not generally be called otherwise, because the property
7387 * may be changed at any time by the layout.
7388 *
7389 * @param right The bottom of this view, in pixels.
7390 */
7391 public final void setRight(int right) {
7392 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07007393 updateMatrix();
7394 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08007395 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07007396 int maxRight;
7397 if (right < mRight) {
7398 maxRight = mRight;
7399 } else {
7400 maxRight = right;
7401 }
Chet Haasee9140a72011-02-16 16:23:29 -08007402 invalidate(0, 0, maxRight - mLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07007403 }
7404 } else {
7405 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08007406 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007407 }
7408
Chet Haaseed032702010-10-01 14:05:54 -07007409 int oldWidth = mRight - mLeft;
7410 int height = mBottom - mTop;
7411
Chet Haase21cd1382010-09-01 17:42:29 -07007412 mRight = right;
7413
Chet Haaseed032702010-10-01 14:05:54 -07007414 onSizeChanged(mRight - mLeft, height, oldWidth, height);
7415
Chet Haase21cd1382010-09-01 17:42:29 -07007416 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08007417 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
7418 // A change in dimension means an auto-centered pivot point changes, too
7419 mMatrixDirty = true;
7420 }
Chet Haase21cd1382010-09-01 17:42:29 -07007421 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08007422 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007423 }
Chet Haase55dbb652010-12-21 20:15:08 -08007424 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08007425 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07007426 }
7427 }
7428
7429 /**
Chet Haasedf030d22010-07-30 17:22:38 -07007430 * The visual x position of this view, in pixels. This is equivalent to the
7431 * {@link #setTranslationX(float) translationX} property plus the current
Joe Malin32736f02011-01-19 16:14:20 -08007432 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07007433 *
Chet Haasedf030d22010-07-30 17:22:38 -07007434 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07007435 */
Chet Haasedf030d22010-07-30 17:22:38 -07007436 public float getX() {
7437 return mLeft + mTranslationX;
7438 }
Romain Guy33e72ae2010-07-17 12:40:29 -07007439
Chet Haasedf030d22010-07-30 17:22:38 -07007440 /**
7441 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
7442 * {@link #setTranslationX(float) translationX} property to be the difference between
7443 * the x value passed in and the current {@link #getLeft() left} property.
7444 *
7445 * @param x The visual x position of this view, in pixels.
7446 */
7447 public void setX(float x) {
7448 setTranslationX(x - mLeft);
7449 }
Romain Guy33e72ae2010-07-17 12:40:29 -07007450
Chet Haasedf030d22010-07-30 17:22:38 -07007451 /**
7452 * The visual y position of this view, in pixels. This is equivalent to the
7453 * {@link #setTranslationY(float) translationY} property plus the current
7454 * {@link #getTop() top} property.
7455 *
7456 * @return The visual y position of this view, in pixels.
7457 */
7458 public float getY() {
7459 return mTop + mTranslationY;
7460 }
7461
7462 /**
7463 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
7464 * {@link #setTranslationY(float) translationY} property to be the difference between
7465 * the y value passed in and the current {@link #getTop() top} property.
7466 *
7467 * @param y The visual y position of this view, in pixels.
7468 */
7469 public void setY(float y) {
7470 setTranslationY(y - mTop);
7471 }
7472
7473
7474 /**
7475 * The horizontal location of this view relative to its {@link #getLeft() left} position.
7476 * This position is post-layout, in addition to wherever the object's
7477 * layout placed it.
7478 *
7479 * @return The horizontal position of this view relative to its left position, in pixels.
7480 */
7481 public float getTranslationX() {
7482 return mTranslationX;
7483 }
7484
7485 /**
7486 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
7487 * This effectively positions the object post-layout, in addition to wherever the object's
7488 * layout placed it.
7489 *
7490 * @param translationX The horizontal position of this view relative to its left position,
7491 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08007492 *
7493 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07007494 */
7495 public void setTranslationX(float translationX) {
7496 if (mTranslationX != translationX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007497 invalidateParentCaches();
Chet Haasedf030d22010-07-30 17:22:38 -07007498 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007499 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07007500 mTranslationX = translationX;
7501 mMatrixDirty = true;
7502 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007503 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007504 }
7505 }
7506
7507 /**
Chet Haasedf030d22010-07-30 17:22:38 -07007508 * The horizontal location of this view relative to its {@link #getTop() top} position.
7509 * This position is post-layout, in addition to wherever the object's
7510 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07007511 *
Chet Haasedf030d22010-07-30 17:22:38 -07007512 * @return The vertical position of this view relative to its top position,
7513 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07007514 */
Chet Haasedf030d22010-07-30 17:22:38 -07007515 public float getTranslationY() {
7516 return mTranslationY;
Chet Haasec3aa3612010-06-17 08:50:37 -07007517 }
7518
7519 /**
Chet Haasedf030d22010-07-30 17:22:38 -07007520 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
7521 * This effectively positions the object post-layout, in addition to wherever the object's
7522 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07007523 *
Chet Haasedf030d22010-07-30 17:22:38 -07007524 * @param translationY The vertical position of this view relative to its top position,
7525 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08007526 *
7527 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07007528 */
Chet Haasedf030d22010-07-30 17:22:38 -07007529 public void setTranslationY(float translationY) {
7530 if (mTranslationY != translationY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007531 invalidateParentCaches();
Chet Haasedf030d22010-07-30 17:22:38 -07007532 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007533 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07007534 mTranslationY = translationY;
7535 mMatrixDirty = true;
7536 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007537 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07007538 }
Chet Haasec3aa3612010-06-17 08:50:37 -07007539 }
7540
7541 /**
Romain Guyda489792011-02-03 01:05:15 -08007542 * @hide
7543 */
Michael Jurkadece29f2011-02-03 01:41:49 -08007544 public void setFastTranslationX(float x) {
7545 mTranslationX = x;
7546 mMatrixDirty = true;
7547 }
7548
7549 /**
7550 * @hide
7551 */
7552 public void setFastTranslationY(float y) {
7553 mTranslationY = y;
7554 mMatrixDirty = true;
7555 }
7556
7557 /**
7558 * @hide
7559 */
Romain Guyda489792011-02-03 01:05:15 -08007560 public void setFastX(float x) {
7561 mTranslationX = x - mLeft;
7562 mMatrixDirty = true;
7563 }
7564
7565 /**
7566 * @hide
7567 */
7568 public void setFastY(float y) {
7569 mTranslationY = y - mTop;
7570 mMatrixDirty = true;
7571 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08007572
Romain Guyda489792011-02-03 01:05:15 -08007573 /**
7574 * @hide
7575 */
7576 public void setFastScaleX(float x) {
7577 mScaleX = x;
7578 mMatrixDirty = true;
7579 }
7580
7581 /**
7582 * @hide
7583 */
7584 public void setFastScaleY(float y) {
7585 mScaleY = y;
7586 mMatrixDirty = true;
7587 }
7588
7589 /**
7590 * @hide
7591 */
7592 public void setFastAlpha(float alpha) {
7593 mAlpha = alpha;
7594 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08007595
Romain Guyda489792011-02-03 01:05:15 -08007596 /**
7597 * @hide
7598 */
7599 public void setFastRotationY(float y) {
7600 mRotationY = y;
7601 mMatrixDirty = true;
7602 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08007603
Romain Guyda489792011-02-03 01:05:15 -08007604 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007605 * Hit rectangle in parent's coordinates
7606 *
7607 * @param outRect The hit rectangle of the view.
7608 */
7609 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07007610 updateMatrix();
7611 if (mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007612 outRect.set(mLeft, mTop, mRight, mBottom);
7613 } else {
7614 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Romain Guy33e72ae2010-07-17 12:40:29 -07007615 tmpRect.set(-mPivotX, -mPivotY, getWidth() - mPivotX, getHeight() - mPivotY);
Jeff Brown86671742010-09-30 20:00:15 -07007616 mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07007617 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
7618 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07007619 }
7620 }
7621
7622 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07007623 * Determines whether the given point, in local coordinates is inside the view.
7624 */
7625 /*package*/ final boolean pointInView(float localX, float localY) {
7626 return localX >= 0 && localX < (mRight - mLeft)
7627 && localY >= 0 && localY < (mBottom - mTop);
7628 }
7629
7630 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07007631 * Utility method to determine whether the given point, in local coordinates,
7632 * is inside the view, where the area of the view is expanded by the slop factor.
7633 * This method is called while processing touch-move events to determine if the event
7634 * is still within the view.
7635 */
7636 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07007637 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07007638 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007639 }
7640
7641 /**
7642 * When a view has focus and the user navigates away from it, the next view is searched for
7643 * starting from the rectangle filled in by this method.
7644 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07007645 * By default, the rectange is the {@link #getDrawingRect(android.graphics.Rect)})
7646 * of the view. However, if your view maintains some idea of internal selection,
7647 * such as a cursor, or a selected row or column, you should override this method and
7648 * fill in a more specific rectangle.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007649 *
7650 * @param r The rectangle to fill in, in this view's coordinates.
7651 */
7652 public void getFocusedRect(Rect r) {
7653 getDrawingRect(r);
7654 }
7655
7656 /**
7657 * If some part of this view is not clipped by any of its parents, then
7658 * return that area in r in global (root) coordinates. To convert r to local
7659 * coordinates, offset it by -globalOffset (e.g. r.offset(-globalOffset.x,
7660 * -globalOffset.y)) If the view is completely clipped or translated out,
7661 * return false.
7662 *
7663 * @param r If true is returned, r holds the global coordinates of the
7664 * visible portion of this view.
7665 * @param globalOffset If true is returned, globalOffset holds the dx,dy
7666 * between this view and its root. globalOffet may be null.
7667 * @return true if r is non-empty (i.e. part of the view is visible at the
7668 * root level.
7669 */
7670 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
7671 int width = mRight - mLeft;
7672 int height = mBottom - mTop;
7673 if (width > 0 && height > 0) {
7674 r.set(0, 0, width, height);
7675 if (globalOffset != null) {
7676 globalOffset.set(-mScrollX, -mScrollY);
7677 }
7678 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
7679 }
7680 return false;
7681 }
7682
7683 public final boolean getGlobalVisibleRect(Rect r) {
7684 return getGlobalVisibleRect(r, null);
7685 }
7686
7687 public final boolean getLocalVisibleRect(Rect r) {
7688 Point offset = new Point();
7689 if (getGlobalVisibleRect(r, offset)) {
7690 r.offset(-offset.x, -offset.y); // make r local
7691 return true;
7692 }
7693 return false;
7694 }
7695
7696 /**
7697 * Offset this view's vertical location by the specified number of pixels.
7698 *
7699 * @param offset the number of pixels to offset the view by
7700 */
7701 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007702 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07007703 updateMatrix();
7704 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007705 final ViewParent p = mParent;
7706 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007707 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07007708 int minTop;
7709 int maxBottom;
7710 int yLoc;
7711 if (offset < 0) {
7712 minTop = mTop + offset;
7713 maxBottom = mBottom;
7714 yLoc = offset;
7715 } else {
7716 minTop = mTop;
7717 maxBottom = mBottom + offset;
7718 yLoc = 0;
7719 }
7720 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
7721 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07007722 }
7723 } else {
Chet Haaseed032702010-10-01 14:05:54 -07007724 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007725 }
Romain Guy33e72ae2010-07-17 12:40:29 -07007726
Chet Haasec3aa3612010-06-17 08:50:37 -07007727 mTop += offset;
7728 mBottom += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07007729
Chet Haasec3aa3612010-06-17 08:50:37 -07007730 if (!mMatrixIsIdentity) {
7731 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007732 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007733 }
Chet Haase678e0ad2011-01-25 09:37:18 -08007734 invalidateParentIfNeeded();
Chet Haasec3aa3612010-06-17 08:50:37 -07007735 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007736 }
7737
7738 /**
7739 * Offset this view's horizontal location by the specified amount of pixels.
7740 *
7741 * @param offset the numer of pixels to offset the view by
7742 */
7743 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007744 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07007745 updateMatrix();
7746 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007747 final ViewParent p = mParent;
7748 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007749 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07007750 int minLeft;
7751 int maxRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07007752 if (offset < 0) {
7753 minLeft = mLeft + offset;
7754 maxRight = mRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07007755 } else {
7756 minLeft = mLeft;
7757 maxRight = mRight + offset;
Chet Haase8fbf8d22010-07-30 15:01:32 -07007758 }
Chet Haasec3aa3612010-06-17 08:50:37 -07007759 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
Chet Haase8fbf8d22010-07-30 15:01:32 -07007760 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07007761 }
7762 } else {
Chet Haaseed032702010-10-01 14:05:54 -07007763 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007764 }
Romain Guy33e72ae2010-07-17 12:40:29 -07007765
Chet Haasec3aa3612010-06-17 08:50:37 -07007766 mLeft += offset;
7767 mRight += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07007768
Chet Haasec3aa3612010-06-17 08:50:37 -07007769 if (!mMatrixIsIdentity) {
7770 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007771 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007772 }
Chet Haase678e0ad2011-01-25 09:37:18 -08007773 invalidateParentIfNeeded();
Chet Haasec3aa3612010-06-17 08:50:37 -07007774 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007775 }
7776
7777 /**
7778 * Get the LayoutParams associated with this view. All views should have
7779 * layout parameters. These supply parameters to the <i>parent</i> of this
7780 * view specifying how it should be arranged. There are many subclasses of
7781 * ViewGroup.LayoutParams, and these correspond to the different subclasses
7782 * of ViewGroup that are responsible for arranging their children.
Romain Guy01c174b2011-02-22 11:51:06 -08007783 *
7784 * This method may return null if this View is not attached to a parent
7785 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)}
7786 * was not invoked successfully. When a View is attached to a parent
7787 * ViewGroup, this method must not return null.
7788 *
7789 * @return The LayoutParams associated with this view, or null if no
7790 * parameters have been set yet
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007791 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07007792 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007793 public ViewGroup.LayoutParams getLayoutParams() {
7794 return mLayoutParams;
7795 }
7796
7797 /**
7798 * Set the layout parameters associated with this view. These supply
7799 * parameters to the <i>parent</i> of this view specifying how it should be
7800 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
7801 * correspond to the different subclasses of ViewGroup that are responsible
7802 * for arranging their children.
7803 *
Romain Guy01c174b2011-02-22 11:51:06 -08007804 * @param params The layout parameters for this view, cannot be null
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007805 */
7806 public void setLayoutParams(ViewGroup.LayoutParams params) {
7807 if (params == null) {
Romain Guy01c174b2011-02-22 11:51:06 -08007808 throw new NullPointerException("Layout parameters cannot be null");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007809 }
7810 mLayoutParams = params;
7811 requestLayout();
7812 }
7813
7814 /**
7815 * Set the scrolled position of your view. This will cause a call to
7816 * {@link #onScrollChanged(int, int, int, int)} and the view will be
7817 * invalidated.
7818 * @param x the x position to scroll to
7819 * @param y the y position to scroll to
7820 */
7821 public void scrollTo(int x, int y) {
7822 if (mScrollX != x || mScrollY != y) {
7823 int oldX = mScrollX;
7824 int oldY = mScrollY;
7825 mScrollX = x;
7826 mScrollY = y;
Romain Guy0fd89bf2011-01-26 15:41:30 -08007827 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007828 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07007829 if (!awakenScrollBars()) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007830 invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -07007831 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007832 }
7833 }
7834
7835 /**
7836 * Move the scrolled position of your view. This will cause a call to
7837 * {@link #onScrollChanged(int, int, int, int)} and the view will be
7838 * invalidated.
7839 * @param x the amount of pixels to scroll by horizontally
7840 * @param y the amount of pixels to scroll by vertically
7841 */
7842 public void scrollBy(int x, int y) {
7843 scrollTo(mScrollX + x, mScrollY + y);
7844 }
7845
7846 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07007847 * <p>Trigger the scrollbars to draw. When invoked this method starts an
7848 * animation to fade the scrollbars out after a default delay. If a subclass
7849 * provides animated scrolling, the start delay should equal the duration
7850 * of the scrolling animation.</p>
7851 *
7852 * <p>The animation starts only if at least one of the scrollbars is
7853 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
7854 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
7855 * this method returns true, and false otherwise. If the animation is
7856 * started, this method calls {@link #invalidate()}; in that case the
7857 * caller should not call {@link #invalidate()}.</p>
7858 *
7859 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07007860 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07007861 *
7862 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
7863 * and {@link #scrollTo(int, int)}.</p>
7864 *
7865 * @return true if the animation is played, false otherwise
7866 *
7867 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07007868 * @see #scrollBy(int, int)
7869 * @see #scrollTo(int, int)
7870 * @see #isHorizontalScrollBarEnabled()
7871 * @see #isVerticalScrollBarEnabled()
7872 * @see #setHorizontalScrollBarEnabled(boolean)
7873 * @see #setVerticalScrollBarEnabled(boolean)
7874 */
7875 protected boolean awakenScrollBars() {
7876 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07007877 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07007878 }
7879
7880 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07007881 * Trigger the scrollbars to draw.
7882 * This method differs from awakenScrollBars() only in its default duration.
7883 * initialAwakenScrollBars() will show the scroll bars for longer than
7884 * usual to give the user more of a chance to notice them.
7885 *
7886 * @return true if the animation is played, false otherwise.
7887 */
7888 private boolean initialAwakenScrollBars() {
7889 return mScrollCache != null &&
7890 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
7891 }
7892
7893 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07007894 * <p>
7895 * Trigger the scrollbars to draw. When invoked this method starts an
7896 * animation to fade the scrollbars out after a fixed delay. If a subclass
7897 * provides animated scrolling, the start delay should equal the duration of
7898 * the scrolling animation.
7899 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08007900 *
Mike Cleronf116bf82009-09-27 19:14:12 -07007901 * <p>
7902 * The animation starts only if at least one of the scrollbars is enabled,
7903 * as specified by {@link #isHorizontalScrollBarEnabled()} and
7904 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
7905 * this method returns true, and false otherwise. If the animation is
7906 * started, this method calls {@link #invalidate()}; in that case the caller
7907 * should not call {@link #invalidate()}.
7908 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08007909 *
Mike Cleronf116bf82009-09-27 19:14:12 -07007910 * <p>
7911 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07007912 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07007913 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08007914 *
Mike Cleronf116bf82009-09-27 19:14:12 -07007915 * @param startDelay the delay, in milliseconds, after which the animation
7916 * should start; when the delay is 0, the animation starts
7917 * immediately
7918 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08007919 *
Mike Cleronf116bf82009-09-27 19:14:12 -07007920 * @see #scrollBy(int, int)
7921 * @see #scrollTo(int, int)
7922 * @see #isHorizontalScrollBarEnabled()
7923 * @see #isVerticalScrollBarEnabled()
7924 * @see #setHorizontalScrollBarEnabled(boolean)
7925 * @see #setVerticalScrollBarEnabled(boolean)
7926 */
7927 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07007928 return awakenScrollBars(startDelay, true);
7929 }
Joe Malin32736f02011-01-19 16:14:20 -08007930
Mike Cleron290947b2009-09-29 18:34:32 -07007931 /**
7932 * <p>
7933 * Trigger the scrollbars to draw. When invoked this method starts an
7934 * animation to fade the scrollbars out after a fixed delay. If a subclass
7935 * provides animated scrolling, the start delay should equal the duration of
7936 * the scrolling animation.
7937 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08007938 *
Mike Cleron290947b2009-09-29 18:34:32 -07007939 * <p>
7940 * The animation starts only if at least one of the scrollbars is enabled,
7941 * as specified by {@link #isHorizontalScrollBarEnabled()} and
7942 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
7943 * this method returns true, and false otherwise. If the animation is
Joe Malin32736f02011-01-19 16:14:20 -08007944 * started, this method calls {@link #invalidate()} if the invalidate parameter
Mike Cleron290947b2009-09-29 18:34:32 -07007945 * is set to true; in that case the caller
7946 * should not call {@link #invalidate()}.
7947 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08007948 *
Mike Cleron290947b2009-09-29 18:34:32 -07007949 * <p>
7950 * This method should be invoked everytime a subclass directly updates the
7951 * scroll parameters.
7952 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08007953 *
Mike Cleron290947b2009-09-29 18:34:32 -07007954 * @param startDelay the delay, in milliseconds, after which the animation
7955 * should start; when the delay is 0, the animation starts
7956 * immediately
Joe Malin32736f02011-01-19 16:14:20 -08007957 *
Mike Cleron290947b2009-09-29 18:34:32 -07007958 * @param invalidate Wheter this method should call invalidate
Joe Malin32736f02011-01-19 16:14:20 -08007959 *
Mike Cleron290947b2009-09-29 18:34:32 -07007960 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08007961 *
Mike Cleron290947b2009-09-29 18:34:32 -07007962 * @see #scrollBy(int, int)
7963 * @see #scrollTo(int, int)
7964 * @see #isHorizontalScrollBarEnabled()
7965 * @see #isVerticalScrollBarEnabled()
7966 * @see #setHorizontalScrollBarEnabled(boolean)
7967 * @see #setVerticalScrollBarEnabled(boolean)
7968 */
7969 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07007970 final ScrollabilityCache scrollCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08007971
Mike Cleronf116bf82009-09-27 19:14:12 -07007972 if (scrollCache == null || !scrollCache.fadeScrollBars) {
7973 return false;
7974 }
7975
7976 if (scrollCache.scrollBar == null) {
7977 scrollCache.scrollBar = new ScrollBarDrawable();
7978 }
7979
7980 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
7981
Mike Cleron290947b2009-09-29 18:34:32 -07007982 if (invalidate) {
7983 // Invalidate to show the scrollbars
Romain Guy0fd89bf2011-01-26 15:41:30 -08007984 invalidate(true);
Mike Cleron290947b2009-09-29 18:34:32 -07007985 }
Mike Cleronf116bf82009-09-27 19:14:12 -07007986
7987 if (scrollCache.state == ScrollabilityCache.OFF) {
7988 // FIXME: this is copied from WindowManagerService.
7989 // We should get this value from the system when it
7990 // is possible to do so.
7991 final int KEY_REPEAT_FIRST_DELAY = 750;
7992 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
7993 }
7994
7995 // Tell mScrollCache when we should start fading. This may
7996 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07007997 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07007998 scrollCache.fadeStartTime = fadeStartTime;
7999 scrollCache.state = ScrollabilityCache.ON;
8000
8001 // Schedule our fader to run, unscheduling any old ones first
8002 if (mAttachInfo != null) {
8003 mAttachInfo.mHandler.removeCallbacks(scrollCache);
8004 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
8005 }
8006
8007 return true;
8008 }
8009
8010 return false;
8011 }
8012
8013 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008014 * Mark the the area defined by dirty as needing to be drawn. If the view is
Romain Guy5c22a8c2011-05-13 11:48:45 -07008015 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some point
8016 * in the future. This must be called from a UI thread. To call from a non-UI
8017 * thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008018 *
8019 * WARNING: This method is destructive to dirty.
8020 * @param dirty the rectangle representing the bounds of the dirty region
8021 */
8022 public void invalidate(Rect dirty) {
8023 if (ViewDebug.TRACE_HIERARCHY) {
8024 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
8025 }
8026
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008027 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08008028 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
8029 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008030 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08008031 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008032 final ViewParent p = mParent;
8033 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08008034 //noinspection PointlessBooleanExpression,ConstantConditions
8035 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
8036 if (p != null && ai != null && ai.mHardwareAccelerated) {
8037 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07008038 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08008039 p.invalidateChild(this, null);
8040 return;
8041 }
Romain Guyaf636eb2010-12-09 17:47:21 -08008042 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008043 if (p != null && ai != null) {
8044 final int scrollX = mScrollX;
8045 final int scrollY = mScrollY;
8046 final Rect r = ai.mTmpInvalRect;
8047 r.set(dirty.left - scrollX, dirty.top - scrollY,
8048 dirty.right - scrollX, dirty.bottom - scrollY);
8049 mParent.invalidateChild(this, r);
8050 }
8051 }
8052 }
8053
8054 /**
8055 * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
8056 * The coordinates of the dirty rect are relative to the view.
Romain Guy5c22a8c2011-05-13 11:48:45 -07008057 * If the view is visible, {@link #onDraw(android.graphics.Canvas)}
8058 * will be called at some point in the future. This must be called from
8059 * a UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008060 * @param l the left position of the dirty region
8061 * @param t the top position of the dirty region
8062 * @param r the right position of the dirty region
8063 * @param b the bottom position of the dirty region
8064 */
8065 public void invalidate(int l, int t, int r, int b) {
8066 if (ViewDebug.TRACE_HIERARCHY) {
8067 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
8068 }
8069
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008070 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08008071 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
8072 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008073 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08008074 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008075 final ViewParent p = mParent;
8076 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08008077 //noinspection PointlessBooleanExpression,ConstantConditions
8078 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
8079 if (p != null && ai != null && ai.mHardwareAccelerated) {
8080 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07008081 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08008082 p.invalidateChild(this, null);
8083 return;
8084 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08008085 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008086 if (p != null && ai != null && l < r && t < b) {
8087 final int scrollX = mScrollX;
8088 final int scrollY = mScrollY;
8089 final Rect tmpr = ai.mTmpInvalRect;
8090 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
8091 p.invalidateChild(this, tmpr);
8092 }
8093 }
8094 }
8095
8096 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07008097 * Invalidate the whole view. If the view is visible,
8098 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in
8099 * the future. This must be called from a UI thread. To call from a non-UI thread,
8100 * call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008101 */
8102 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -07008103 invalidate(true);
8104 }
Joe Malin32736f02011-01-19 16:14:20 -08008105
Chet Haaseed032702010-10-01 14:05:54 -07008106 /**
8107 * This is where the invalidate() work actually happens. A full invalidate()
8108 * causes the drawing cache to be invalidated, but this function can be called with
8109 * invalidateCache set to false to skip that invalidation step for cases that do not
8110 * need it (for example, a component that remains at the same dimensions with the same
8111 * content).
8112 *
8113 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
8114 * well. This is usually true for a full invalidate, but may be set to false if the
8115 * View's contents or dimensions have not changed.
8116 */
Romain Guy849d0a32011-02-01 17:20:48 -08008117 void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008118 if (ViewDebug.TRACE_HIERARCHY) {
8119 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
8120 }
8121
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008122 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Romain Guyc5d55862011-01-21 19:01:46 -08008123 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) ||
Romain Guy0fd89bf2011-01-26 15:41:30 -08008124 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) {
8125 mLastIsOpaque = isOpaque();
Chet Haaseed032702010-10-01 14:05:54 -07008126 mPrivateFlags &= ~DRAWN;
8127 if (invalidateCache) {
Chet Haasedaf98e92011-01-10 14:10:36 -08008128 mPrivateFlags |= INVALIDATED;
Chet Haaseed032702010-10-01 14:05:54 -07008129 mPrivateFlags &= ~DRAWING_CACHE_VALID;
8130 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008131 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -07008132 final ViewParent p = mParent;
Romain Guy7d7b5492011-01-24 16:33:45 -08008133 //noinspection PointlessBooleanExpression,ConstantConditions
8134 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
8135 if (p != null && ai != null && ai.mHardwareAccelerated) {
8136 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07008137 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08008138 p.invalidateChild(this, null);
8139 return;
8140 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08008141 }
Michael Jurkaebefea42010-11-15 16:04:01 -08008142
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008143 if (p != null && ai != null) {
8144 final Rect r = ai.mTmpInvalRect;
8145 r.set(0, 0, mRight - mLeft, mBottom - mTop);
8146 // Don't call invalidate -- we don't want to internally scroll
8147 // our own bounds
8148 p.invalidateChild(this, r);
8149 }
8150 }
8151 }
8152
8153 /**
Romain Guyda489792011-02-03 01:05:15 -08008154 * @hide
8155 */
8156 public void fastInvalidate() {
8157 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
8158 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
8159 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
8160 if (mParent instanceof View) {
8161 ((View) mParent).mPrivateFlags |= INVALIDATED;
8162 }
8163 mPrivateFlags &= ~DRAWN;
8164 mPrivateFlags |= INVALIDATED;
8165 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Michael Jurkad0872bd2011-03-24 15:44:19 -07008166 if (mParent != null && mAttachInfo != null) {
8167 if (mAttachInfo.mHardwareAccelerated) {
8168 mParent.invalidateChild(this, null);
8169 } else {
8170 final Rect r = mAttachInfo.mTmpInvalRect;
8171 r.set(0, 0, mRight - mLeft, mBottom - mTop);
8172 // Don't call invalidate -- we don't want to internally scroll
8173 // our own bounds
8174 mParent.invalidateChild(this, r);
8175 }
Romain Guyda489792011-02-03 01:05:15 -08008176 }
8177 }
8178 }
8179
8180 /**
Romain Guy0fd89bf2011-01-26 15:41:30 -08008181 * Used to indicate that the parent of this view should clear its caches. This functionality
Chet Haasedaf98e92011-01-10 14:10:36 -08008182 * is used to force the parent to rebuild its display list (when hardware-accelerated),
8183 * which is necessary when various parent-managed properties of the view change, such as
Romain Guy0fd89bf2011-01-26 15:41:30 -08008184 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only
8185 * clears the parent caches and does not causes an invalidate event.
Chet Haasedaf98e92011-01-10 14:10:36 -08008186 *
8187 * @hide
8188 */
Romain Guy0fd89bf2011-01-26 15:41:30 -08008189 protected void invalidateParentCaches() {
8190 if (mParent instanceof View) {
8191 ((View) mParent).mPrivateFlags |= INVALIDATED;
8192 }
8193 }
Joe Malin32736f02011-01-19 16:14:20 -08008194
Romain Guy0fd89bf2011-01-26 15:41:30 -08008195 /**
8196 * Used to indicate that the parent of this view should be invalidated. This functionality
8197 * is used to force the parent to rebuild its display list (when hardware-accelerated),
8198 * which is necessary when various parent-managed properties of the view change, such as
8199 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate
8200 * an invalidation event to the parent.
8201 *
8202 * @hide
8203 */
8204 protected void invalidateParentIfNeeded() {
Chet Haasedaf98e92011-01-10 14:10:36 -08008205 if (isHardwareAccelerated() && mParent instanceof View) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08008206 ((View) mParent).invalidate(true);
Chet Haasedaf98e92011-01-10 14:10:36 -08008207 }
8208 }
8209
8210 /**
Romain Guy24443ea2009-05-11 11:56:30 -07008211 * Indicates whether this View is opaque. An opaque View guarantees that it will
8212 * draw all the pixels overlapping its bounds using a fully opaque color.
8213 *
8214 * Subclasses of View should override this method whenever possible to indicate
8215 * whether an instance is opaque. Opaque Views are treated in a special way by
8216 * the View hierarchy, possibly allowing it to perform optimizations during
8217 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -07008218 *
Romain Guy24443ea2009-05-11 11:56:30 -07008219 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -07008220 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008221 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -07008222 public boolean isOpaque() {
Chet Haase70d4ba12010-10-06 09:46:45 -07008223 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK &&
8224 (mAlpha >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD);
Romain Guy8f1344f52009-05-15 16:03:59 -07008225 }
8226
Adam Powell20232d02010-12-08 21:08:53 -08008227 /**
8228 * @hide
8229 */
8230 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -07008231 // Opaque if:
8232 // - Has a background
8233 // - Background is opaque
8234 // - Doesn't have scrollbars or scrollbars are inside overlay
8235
8236 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) {
8237 mPrivateFlags |= OPAQUE_BACKGROUND;
8238 } else {
8239 mPrivateFlags &= ~OPAQUE_BACKGROUND;
8240 }
8241
8242 final int flags = mViewFlags;
8243 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
8244 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
8245 mPrivateFlags |= OPAQUE_SCROLLBARS;
8246 } else {
8247 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
8248 }
8249 }
8250
8251 /**
8252 * @hide
8253 */
8254 protected boolean hasOpaqueScrollbars() {
8255 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -07008256 }
8257
8258 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008259 * @return A handler associated with the thread running the View. This
8260 * handler can be used to pump events in the UI events queue.
8261 */
8262 public Handler getHandler() {
8263 if (mAttachInfo != null) {
8264 return mAttachInfo.mHandler;
8265 }
8266 return null;
8267 }
8268
8269 /**
8270 * Causes the Runnable to be added to the message queue.
8271 * The runnable will be run on the user interface thread.
8272 *
8273 * @param action The Runnable that will be executed.
8274 *
8275 * @return Returns true if the Runnable was successfully placed in to the
8276 * message queue. Returns false on failure, usually because the
8277 * looper processing the message queue is exiting.
8278 */
8279 public boolean post(Runnable action) {
8280 Handler handler;
Romain Guyc5a43a22011-03-24 13:28:56 -07008281 AttachInfo attachInfo = mAttachInfo;
8282 if (attachInfo != null) {
8283 handler = attachInfo.mHandler;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008284 } else {
8285 // Assume that post will succeed later
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07008286 ViewRootImpl.getRunQueue().post(action);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008287 return true;
8288 }
8289
8290 return handler.post(action);
8291 }
8292
8293 /**
8294 * Causes the Runnable to be added to the message queue, to be run
8295 * after the specified amount of time elapses.
8296 * The runnable will be run on the user interface thread.
8297 *
8298 * @param action The Runnable that will be executed.
8299 * @param delayMillis The delay (in milliseconds) until the Runnable
8300 * will be executed.
8301 *
8302 * @return true if the Runnable was successfully placed in to the
8303 * message queue. Returns false on failure, usually because the
8304 * looper processing the message queue is exiting. Note that a
8305 * result of true does not mean the Runnable will be processed --
8306 * if the looper is quit before the delivery time of the message
8307 * occurs then the message will be dropped.
8308 */
8309 public boolean postDelayed(Runnable action, long delayMillis) {
8310 Handler handler;
Romain Guyc5a43a22011-03-24 13:28:56 -07008311 AttachInfo attachInfo = mAttachInfo;
8312 if (attachInfo != null) {
8313 handler = attachInfo.mHandler;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008314 } else {
8315 // Assume that post will succeed later
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07008316 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008317 return true;
8318 }
8319
8320 return handler.postDelayed(action, delayMillis);
8321 }
8322
8323 /**
8324 * Removes the specified Runnable from the message queue.
8325 *
8326 * @param action The Runnable to remove from the message handling queue
8327 *
8328 * @return true if this view could ask the Handler to remove the Runnable,
8329 * false otherwise. When the returned value is true, the Runnable
8330 * may or may not have been actually removed from the message queue
8331 * (for instance, if the Runnable was not in the queue already.)
8332 */
8333 public boolean removeCallbacks(Runnable action) {
8334 Handler handler;
Romain Guyc5a43a22011-03-24 13:28:56 -07008335 AttachInfo attachInfo = mAttachInfo;
8336 if (attachInfo != null) {
8337 handler = attachInfo.mHandler;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008338 } else {
8339 // Assume that post will succeed later
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07008340 ViewRootImpl.getRunQueue().removeCallbacks(action);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008341 return true;
8342 }
8343
8344 handler.removeCallbacks(action);
8345 return true;
8346 }
8347
8348 /**
8349 * Cause an invalidate to happen on a subsequent cycle through the event loop.
8350 * Use this to invalidate the View from a non-UI thread.
8351 *
8352 * @see #invalidate()
8353 */
8354 public void postInvalidate() {
8355 postInvalidateDelayed(0);
8356 }
8357
8358 /**
8359 * Cause an invalidate of the specified area to happen on a subsequent cycle
8360 * through the event loop. Use this to invalidate the View from a non-UI thread.
8361 *
8362 * @param left The left coordinate of the rectangle to invalidate.
8363 * @param top The top coordinate of the rectangle to invalidate.
8364 * @param right The right coordinate of the rectangle to invalidate.
8365 * @param bottom The bottom coordinate of the rectangle to invalidate.
8366 *
8367 * @see #invalidate(int, int, int, int)
8368 * @see #invalidate(Rect)
8369 */
8370 public void postInvalidate(int left, int top, int right, int bottom) {
8371 postInvalidateDelayed(0, left, top, right, bottom);
8372 }
8373
8374 /**
8375 * Cause an invalidate to happen on a subsequent cycle through the event
8376 * loop. Waits for the specified amount of time.
8377 *
8378 * @param delayMilliseconds the duration in milliseconds to delay the
8379 * invalidation by
8380 */
8381 public void postInvalidateDelayed(long delayMilliseconds) {
8382 // We try only with the AttachInfo because there's no point in invalidating
8383 // if we are not attached to our window
Romain Guyc5a43a22011-03-24 13:28:56 -07008384 AttachInfo attachInfo = mAttachInfo;
8385 if (attachInfo != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008386 Message msg = Message.obtain();
8387 msg.what = AttachInfo.INVALIDATE_MSG;
8388 msg.obj = this;
Romain Guyc5a43a22011-03-24 13:28:56 -07008389 attachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008390 }
8391 }
8392
8393 /**
8394 * Cause an invalidate of the specified area to happen on a subsequent cycle
8395 * through the event loop. Waits for the specified amount of time.
8396 *
8397 * @param delayMilliseconds the duration in milliseconds to delay the
8398 * invalidation by
8399 * @param left The left coordinate of the rectangle to invalidate.
8400 * @param top The top coordinate of the rectangle to invalidate.
8401 * @param right The right coordinate of the rectangle to invalidate.
8402 * @param bottom The bottom coordinate of the rectangle to invalidate.
8403 */
8404 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
8405 int right, int bottom) {
8406
8407 // We try only with the AttachInfo because there's no point in invalidating
8408 // if we are not attached to our window
Romain Guyc5a43a22011-03-24 13:28:56 -07008409 AttachInfo attachInfo = mAttachInfo;
8410 if (attachInfo != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008411 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
8412 info.target = this;
8413 info.left = left;
8414 info.top = top;
8415 info.right = right;
8416 info.bottom = bottom;
8417
8418 final Message msg = Message.obtain();
8419 msg.what = AttachInfo.INVALIDATE_RECT_MSG;
8420 msg.obj = info;
Romain Guyc5a43a22011-03-24 13:28:56 -07008421 attachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008422 }
8423 }
8424
8425 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -07008426 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event.
8427 * This event is sent at most once every
8428 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}.
8429 */
8430 private void postSendViewScrolledAccessibilityEventCallback() {
8431 if (mSendViewScrolledAccessibilityEvent == null) {
8432 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent();
8433 }
8434 if (!mSendViewScrolledAccessibilityEvent.mIsPending) {
8435 mSendViewScrolledAccessibilityEvent.mIsPending = true;
8436 postDelayed(mSendViewScrolledAccessibilityEvent,
8437 ViewConfiguration.getSendRecurringAccessibilityEventsInterval());
8438 }
8439 }
8440
8441 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008442 * Called by a parent to request that a child update its values for mScrollX
8443 * and mScrollY if necessary. This will typically be done if the child is
8444 * animating a scroll using a {@link android.widget.Scroller Scroller}
8445 * object.
8446 */
8447 public void computeScroll() {
8448 }
8449
8450 /**
8451 * <p>Indicate whether the horizontal edges are faded when the view is
8452 * scrolled horizontally.</p>
8453 *
8454 * @return true if the horizontal edges should are faded on scroll, false
8455 * otherwise
8456 *
8457 * @see #setHorizontalFadingEdgeEnabled(boolean)
8458 * @attr ref android.R.styleable#View_fadingEdge
8459 */
8460 public boolean isHorizontalFadingEdgeEnabled() {
8461 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
8462 }
8463
8464 /**
8465 * <p>Define whether the horizontal edges should be faded when this view
8466 * is scrolled horizontally.</p>
8467 *
8468 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
8469 * be faded when the view is scrolled
8470 * horizontally
8471 *
8472 * @see #isHorizontalFadingEdgeEnabled()
8473 * @attr ref android.R.styleable#View_fadingEdge
8474 */
8475 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
8476 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
8477 if (horizontalFadingEdgeEnabled) {
8478 initScrollCache();
8479 }
8480
8481 mViewFlags ^= FADING_EDGE_HORIZONTAL;
8482 }
8483 }
8484
8485 /**
8486 * <p>Indicate whether the vertical edges are faded when the view is
8487 * scrolled horizontally.</p>
8488 *
8489 * @return true if the vertical edges should are faded on scroll, false
8490 * otherwise
8491 *
8492 * @see #setVerticalFadingEdgeEnabled(boolean)
8493 * @attr ref android.R.styleable#View_fadingEdge
8494 */
8495 public boolean isVerticalFadingEdgeEnabled() {
8496 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
8497 }
8498
8499 /**
8500 * <p>Define whether the vertical edges should be faded when this view
8501 * is scrolled vertically.</p>
8502 *
8503 * @param verticalFadingEdgeEnabled true if the vertical edges should
8504 * be faded when the view is scrolled
8505 * vertically
8506 *
8507 * @see #isVerticalFadingEdgeEnabled()
8508 * @attr ref android.R.styleable#View_fadingEdge
8509 */
8510 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
8511 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
8512 if (verticalFadingEdgeEnabled) {
8513 initScrollCache();
8514 }
8515
8516 mViewFlags ^= FADING_EDGE_VERTICAL;
8517 }
8518 }
8519
8520 /**
8521 * Returns the strength, or intensity, of the top faded edge. The strength is
8522 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
8523 * returns 0.0 or 1.0 but no value in between.
8524 *
8525 * Subclasses should override this method to provide a smoother fade transition
8526 * when scrolling occurs.
8527 *
8528 * @return the intensity of the top fade as a float between 0.0f and 1.0f
8529 */
8530 protected float getTopFadingEdgeStrength() {
8531 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
8532 }
8533
8534 /**
8535 * Returns the strength, or intensity, of the bottom faded edge. The strength is
8536 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
8537 * returns 0.0 or 1.0 but no value in between.
8538 *
8539 * Subclasses should override this method to provide a smoother fade transition
8540 * when scrolling occurs.
8541 *
8542 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
8543 */
8544 protected float getBottomFadingEdgeStrength() {
8545 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
8546 computeVerticalScrollRange() ? 1.0f : 0.0f;
8547 }
8548
8549 /**
8550 * Returns the strength, or intensity, of the left faded edge. The strength is
8551 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
8552 * returns 0.0 or 1.0 but no value in between.
8553 *
8554 * Subclasses should override this method to provide a smoother fade transition
8555 * when scrolling occurs.
8556 *
8557 * @return the intensity of the left fade as a float between 0.0f and 1.0f
8558 */
8559 protected float getLeftFadingEdgeStrength() {
8560 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
8561 }
8562
8563 /**
8564 * Returns the strength, or intensity, of the right faded edge. The strength is
8565 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
8566 * returns 0.0 or 1.0 but no value in between.
8567 *
8568 * Subclasses should override this method to provide a smoother fade transition
8569 * when scrolling occurs.
8570 *
8571 * @return the intensity of the right fade as a float between 0.0f and 1.0f
8572 */
8573 protected float getRightFadingEdgeStrength() {
8574 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
8575 computeHorizontalScrollRange() ? 1.0f : 0.0f;
8576 }
8577
8578 /**
8579 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
8580 * scrollbar is not drawn by default.</p>
8581 *
8582 * @return true if the horizontal scrollbar should be painted, false
8583 * otherwise
8584 *
8585 * @see #setHorizontalScrollBarEnabled(boolean)
8586 */
8587 public boolean isHorizontalScrollBarEnabled() {
8588 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
8589 }
8590
8591 /**
8592 * <p>Define whether the horizontal scrollbar should be drawn or not. The
8593 * scrollbar is not drawn by default.</p>
8594 *
8595 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
8596 * be painted
8597 *
8598 * @see #isHorizontalScrollBarEnabled()
8599 */
8600 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
8601 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
8602 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07008603 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07008604 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008605 }
8606 }
8607
8608 /**
8609 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
8610 * scrollbar is not drawn by default.</p>
8611 *
8612 * @return true if the vertical scrollbar should be painted, false
8613 * otherwise
8614 *
8615 * @see #setVerticalScrollBarEnabled(boolean)
8616 */
8617 public boolean isVerticalScrollBarEnabled() {
8618 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
8619 }
8620
8621 /**
8622 * <p>Define whether the vertical scrollbar should be drawn or not. The
8623 * scrollbar is not drawn by default.</p>
8624 *
8625 * @param verticalScrollBarEnabled true if the vertical scrollbar should
8626 * be painted
8627 *
8628 * @see #isVerticalScrollBarEnabled()
8629 */
8630 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
8631 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
8632 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07008633 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07008634 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008635 }
8636 }
8637
Adam Powell20232d02010-12-08 21:08:53 -08008638 /**
8639 * @hide
8640 */
8641 protected void recomputePadding() {
8642 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008643 }
Joe Malin32736f02011-01-19 16:14:20 -08008644
Mike Cleronfe81d382009-09-28 14:22:16 -07008645 /**
8646 * Define whether scrollbars will fade when the view is not scrolling.
Joe Malin32736f02011-01-19 16:14:20 -08008647 *
Mike Cleronfe81d382009-09-28 14:22:16 -07008648 * @param fadeScrollbars wheter to enable fading
Joe Malin32736f02011-01-19 16:14:20 -08008649 *
Mike Cleronfe81d382009-09-28 14:22:16 -07008650 */
8651 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
8652 initScrollCache();
8653 final ScrollabilityCache scrollabilityCache = mScrollCache;
8654 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -07008655 if (fadeScrollbars) {
8656 scrollabilityCache.state = ScrollabilityCache.OFF;
8657 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -07008658 scrollabilityCache.state = ScrollabilityCache.ON;
8659 }
8660 }
Joe Malin32736f02011-01-19 16:14:20 -08008661
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008662 /**
Joe Malin32736f02011-01-19 16:14:20 -08008663 *
Mike Cleron52f0a642009-09-28 18:21:37 -07008664 * Returns true if scrollbars will fade when this view is not scrolling
Joe Malin32736f02011-01-19 16:14:20 -08008665 *
Mike Cleron52f0a642009-09-28 18:21:37 -07008666 * @return true if scrollbar fading is enabled
8667 */
8668 public boolean isScrollbarFadingEnabled() {
Joe Malin32736f02011-01-19 16:14:20 -08008669 return mScrollCache != null && mScrollCache.fadeScrollBars;
Mike Cleron52f0a642009-09-28 18:21:37 -07008670 }
Joe Malin32736f02011-01-19 16:14:20 -08008671
Mike Cleron52f0a642009-09-28 18:21:37 -07008672 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008673 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
8674 * inset. When inset, they add to the padding of the view. And the scrollbars
8675 * can be drawn inside the padding area or on the edge of the view. For example,
8676 * if a view has a background drawable and you want to draw the scrollbars
8677 * inside the padding specified by the drawable, you can use
8678 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
8679 * appear at the edge of the view, ignoring the padding, then you can use
8680 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
8681 * @param style the style of the scrollbars. Should be one of
8682 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
8683 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
8684 * @see #SCROLLBARS_INSIDE_OVERLAY
8685 * @see #SCROLLBARS_INSIDE_INSET
8686 * @see #SCROLLBARS_OUTSIDE_OVERLAY
8687 * @see #SCROLLBARS_OUTSIDE_INSET
8688 */
8689 public void setScrollBarStyle(int style) {
8690 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
8691 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -07008692 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07008693 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008694 }
8695 }
8696
8697 /**
8698 * <p>Returns the current scrollbar style.</p>
8699 * @return the current scrollbar style
8700 * @see #SCROLLBARS_INSIDE_OVERLAY
8701 * @see #SCROLLBARS_INSIDE_INSET
8702 * @see #SCROLLBARS_OUTSIDE_OVERLAY
8703 * @see #SCROLLBARS_OUTSIDE_INSET
8704 */
8705 public int getScrollBarStyle() {
8706 return mViewFlags & SCROLLBARS_STYLE_MASK;
8707 }
8708
8709 /**
8710 * <p>Compute the horizontal range that the horizontal scrollbar
8711 * represents.</p>
8712 *
8713 * <p>The range is expressed in arbitrary units that must be the same as the
8714 * units used by {@link #computeHorizontalScrollExtent()} and
8715 * {@link #computeHorizontalScrollOffset()}.</p>
8716 *
8717 * <p>The default range is the drawing width of this view.</p>
8718 *
8719 * @return the total horizontal range represented by the horizontal
8720 * scrollbar
8721 *
8722 * @see #computeHorizontalScrollExtent()
8723 * @see #computeHorizontalScrollOffset()
8724 * @see android.widget.ScrollBarDrawable
8725 */
8726 protected int computeHorizontalScrollRange() {
8727 return getWidth();
8728 }
8729
8730 /**
8731 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
8732 * within the horizontal range. This value is used to compute the position
8733 * of the thumb within the scrollbar's track.</p>
8734 *
8735 * <p>The range is expressed in arbitrary units that must be the same as the
8736 * units used by {@link #computeHorizontalScrollRange()} and
8737 * {@link #computeHorizontalScrollExtent()}.</p>
8738 *
8739 * <p>The default offset is the scroll offset of this view.</p>
8740 *
8741 * @return the horizontal offset of the scrollbar's thumb
8742 *
8743 * @see #computeHorizontalScrollRange()
8744 * @see #computeHorizontalScrollExtent()
8745 * @see android.widget.ScrollBarDrawable
8746 */
8747 protected int computeHorizontalScrollOffset() {
8748 return mScrollX;
8749 }
8750
8751 /**
8752 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
8753 * within the horizontal range. This value is used to compute the length
8754 * of the thumb within the scrollbar's track.</p>
8755 *
8756 * <p>The range is expressed in arbitrary units that must be the same as the
8757 * units used by {@link #computeHorizontalScrollRange()} and
8758 * {@link #computeHorizontalScrollOffset()}.</p>
8759 *
8760 * <p>The default extent is the drawing width of this view.</p>
8761 *
8762 * @return the horizontal extent of the scrollbar's thumb
8763 *
8764 * @see #computeHorizontalScrollRange()
8765 * @see #computeHorizontalScrollOffset()
8766 * @see android.widget.ScrollBarDrawable
8767 */
8768 protected int computeHorizontalScrollExtent() {
8769 return getWidth();
8770 }
8771
8772 /**
8773 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
8774 *
8775 * <p>The range is expressed in arbitrary units that must be the same as the
8776 * units used by {@link #computeVerticalScrollExtent()} and
8777 * {@link #computeVerticalScrollOffset()}.</p>
8778 *
8779 * @return the total vertical range represented by the vertical scrollbar
8780 *
8781 * <p>The default range is the drawing height of this view.</p>
8782 *
8783 * @see #computeVerticalScrollExtent()
8784 * @see #computeVerticalScrollOffset()
8785 * @see android.widget.ScrollBarDrawable
8786 */
8787 protected int computeVerticalScrollRange() {
8788 return getHeight();
8789 }
8790
8791 /**
8792 * <p>Compute the vertical offset of the vertical scrollbar's thumb
8793 * within the horizontal range. This value is used to compute the position
8794 * of the thumb within the scrollbar's track.</p>
8795 *
8796 * <p>The range is expressed in arbitrary units that must be the same as the
8797 * units used by {@link #computeVerticalScrollRange()} and
8798 * {@link #computeVerticalScrollExtent()}.</p>
8799 *
8800 * <p>The default offset is the scroll offset of this view.</p>
8801 *
8802 * @return the vertical offset of the scrollbar's thumb
8803 *
8804 * @see #computeVerticalScrollRange()
8805 * @see #computeVerticalScrollExtent()
8806 * @see android.widget.ScrollBarDrawable
8807 */
8808 protected int computeVerticalScrollOffset() {
8809 return mScrollY;
8810 }
8811
8812 /**
8813 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
8814 * within the vertical range. This value is used to compute the length
8815 * of the thumb within the scrollbar's track.</p>
8816 *
8817 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -08008818 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008819 * {@link #computeVerticalScrollOffset()}.</p>
8820 *
8821 * <p>The default extent is the drawing height of this view.</p>
8822 *
8823 * @return the vertical extent of the scrollbar's thumb
8824 *
8825 * @see #computeVerticalScrollRange()
8826 * @see #computeVerticalScrollOffset()
8827 * @see android.widget.ScrollBarDrawable
8828 */
8829 protected int computeVerticalScrollExtent() {
8830 return getHeight();
8831 }
8832
8833 /**
Adam Powell69159442011-06-13 17:53:06 -07008834 * Check if this view can be scrolled horizontally in a certain direction.
8835 *
8836 * @param direction Negative to check scrolling left, positive to check scrolling right.
8837 * @return true if this view can be scrolled in the specified direction, false otherwise.
8838 */
8839 public boolean canScrollHorizontally(int direction) {
8840 final int offset = computeHorizontalScrollOffset();
8841 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent();
8842 if (range == 0) return false;
8843 if (direction < 0) {
8844 return offset > 0;
8845 } else {
8846 return offset < range - 1;
8847 }
8848 }
8849
8850 /**
8851 * Check if this view can be scrolled vertically in a certain direction.
8852 *
8853 * @param direction Negative to check scrolling up, positive to check scrolling down.
8854 * @return true if this view can be scrolled in the specified direction, false otherwise.
8855 */
8856 public boolean canScrollVertically(int direction) {
8857 final int offset = computeVerticalScrollOffset();
8858 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent();
8859 if (range == 0) return false;
8860 if (direction < 0) {
8861 return offset > 0;
8862 } else {
8863 return offset < range - 1;
8864 }
8865 }
8866
8867 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008868 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
8869 * scrollbars are painted only if they have been awakened first.</p>
8870 *
8871 * @param canvas the canvas on which to draw the scrollbars
Joe Malin32736f02011-01-19 16:14:20 -08008872 *
Mike Cleronf116bf82009-09-27 19:14:12 -07008873 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008874 */
Romain Guy1d5b3a62009-11-05 18:44:12 -08008875 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008876 // scrollbars are drawn only when the animation is running
8877 final ScrollabilityCache cache = mScrollCache;
8878 if (cache != null) {
Joe Malin32736f02011-01-19 16:14:20 -08008879
Mike Cleronf116bf82009-09-27 19:14:12 -07008880 int state = cache.state;
Joe Malin32736f02011-01-19 16:14:20 -08008881
Mike Cleronf116bf82009-09-27 19:14:12 -07008882 if (state == ScrollabilityCache.OFF) {
8883 return;
8884 }
Joe Malin32736f02011-01-19 16:14:20 -08008885
Mike Cleronf116bf82009-09-27 19:14:12 -07008886 boolean invalidate = false;
Joe Malin32736f02011-01-19 16:14:20 -08008887
Mike Cleronf116bf82009-09-27 19:14:12 -07008888 if (state == ScrollabilityCache.FADING) {
8889 // We're fading -- get our fade interpolation
8890 if (cache.interpolatorValues == null) {
8891 cache.interpolatorValues = new float[1];
8892 }
Joe Malin32736f02011-01-19 16:14:20 -08008893
Mike Cleronf116bf82009-09-27 19:14:12 -07008894 float[] values = cache.interpolatorValues;
Joe Malin32736f02011-01-19 16:14:20 -08008895
Mike Cleronf116bf82009-09-27 19:14:12 -07008896 // Stops the animation if we're done
8897 if (cache.scrollBarInterpolator.timeToValues(values) ==
8898 Interpolator.Result.FREEZE_END) {
8899 cache.state = ScrollabilityCache.OFF;
8900 } else {
8901 cache.scrollBar.setAlpha(Math.round(values[0]));
8902 }
Joe Malin32736f02011-01-19 16:14:20 -08008903
8904 // This will make the scroll bars inval themselves after
Mike Cleronf116bf82009-09-27 19:14:12 -07008905 // drawing. We only want this when we're fading so that
8906 // we prevent excessive redraws
8907 invalidate = true;
8908 } else {
8909 // We're just on -- but we may have been fading before so
8910 // reset alpha
8911 cache.scrollBar.setAlpha(255);
8912 }
8913
Joe Malin32736f02011-01-19 16:14:20 -08008914
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008915 final int viewFlags = mViewFlags;
8916
8917 final boolean drawHorizontalScrollBar =
8918 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
8919 final boolean drawVerticalScrollBar =
8920 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
8921 && !isVerticalScrollBarHidden();
8922
8923 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
8924 final int width = mRight - mLeft;
8925 final int height = mBottom - mTop;
8926
8927 final ScrollBarDrawable scrollBar = cache.scrollBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008928
Mike Reede8853fc2009-09-04 14:01:48 -04008929 final int scrollX = mScrollX;
8930 final int scrollY = mScrollY;
8931 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
8932
Mike Cleronf116bf82009-09-27 19:14:12 -07008933 int left, top, right, bottom;
Joe Malin32736f02011-01-19 16:14:20 -08008934
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008935 if (drawHorizontalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -08008936 int size = scrollBar.getSize(false);
8937 if (size <= 0) {
8938 size = cache.scrollBarSize;
8939 }
8940
Mike Cleronf116bf82009-09-27 19:14:12 -07008941 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -04008942 computeHorizontalScrollOffset(),
8943 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -04008944 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -07008945 getVerticalScrollbarWidth() : 0;
Joe Malin32736f02011-01-19 16:14:20 -08008946 top = scrollY + height - size - (mUserPaddingBottom & inside);
Mike Cleronf116bf82009-09-27 19:14:12 -07008947 left = scrollX + (mPaddingLeft & inside);
8948 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
8949 bottom = top + size;
8950 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
8951 if (invalidate) {
8952 invalidate(left, top, right, bottom);
8953 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008954 }
8955
8956 if (drawVerticalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -08008957 int size = scrollBar.getSize(true);
8958 if (size <= 0) {
8959 size = cache.scrollBarSize;
8960 }
8961
Mike Reede8853fc2009-09-04 14:01:48 -04008962 scrollBar.setParameters(computeVerticalScrollRange(),
8963 computeVerticalScrollOffset(),
8964 computeVerticalScrollExtent(), true);
Adam Powell20232d02010-12-08 21:08:53 -08008965 switch (mVerticalScrollbarPosition) {
8966 default:
8967 case SCROLLBAR_POSITION_DEFAULT:
8968 case SCROLLBAR_POSITION_RIGHT:
8969 left = scrollX + width - size - (mUserPaddingRight & inside);
8970 break;
8971 case SCROLLBAR_POSITION_LEFT:
8972 left = scrollX + (mUserPaddingLeft & inside);
8973 break;
8974 }
Mike Cleronf116bf82009-09-27 19:14:12 -07008975 top = scrollY + (mPaddingTop & inside);
8976 right = left + size;
8977 bottom = scrollY + height - (mUserPaddingBottom & inside);
8978 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
8979 if (invalidate) {
8980 invalidate(left, top, right, bottom);
8981 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008982 }
8983 }
8984 }
8985 }
Romain Guy8506ab42009-06-11 17:35:47 -07008986
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008987 /**
Romain Guy8506ab42009-06-11 17:35:47 -07008988 * 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 -08008989 * FastScroller is visible.
8990 * @return whether to temporarily hide the vertical scrollbar
8991 * @hide
8992 */
8993 protected boolean isVerticalScrollBarHidden() {
8994 return false;
8995 }
8996
8997 /**
8998 * <p>Draw the horizontal scrollbar if
8999 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
9000 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009001 * @param canvas the canvas on which to draw the scrollbar
9002 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009003 *
9004 * @see #isHorizontalScrollBarEnabled()
9005 * @see #computeHorizontalScrollRange()
9006 * @see #computeHorizontalScrollExtent()
9007 * @see #computeHorizontalScrollOffset()
9008 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -07009009 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -04009010 */
Romain Guy8fb95422010-08-17 18:38:51 -07009011 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
9012 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -04009013 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -04009014 scrollBar.draw(canvas);
9015 }
Mike Reede8853fc2009-09-04 14:01:48 -04009016
Mike Reed4d6fe5f2009-09-03 13:29:05 -04009017 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009018 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
9019 * returns true.</p>
9020 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009021 * @param canvas the canvas on which to draw the scrollbar
9022 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009023 *
9024 * @see #isVerticalScrollBarEnabled()
9025 * @see #computeVerticalScrollRange()
9026 * @see #computeVerticalScrollExtent()
9027 * @see #computeVerticalScrollOffset()
9028 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -04009029 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009030 */
Romain Guy8fb95422010-08-17 18:38:51 -07009031 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
9032 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -04009033 scrollBar.setBounds(l, t, r, b);
9034 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009035 }
9036
9037 /**
9038 * Implement this to do your drawing.
9039 *
9040 * @param canvas the canvas on which the background will be drawn
9041 */
9042 protected void onDraw(Canvas canvas) {
9043 }
9044
9045 /*
9046 * Caller is responsible for calling requestLayout if necessary.
9047 * (This allows addViewInLayout to not request a new layout.)
9048 */
9049 void assignParent(ViewParent parent) {
9050 if (mParent == null) {
9051 mParent = parent;
9052 } else if (parent == null) {
9053 mParent = null;
9054 } else {
9055 throw new RuntimeException("view " + this + " being added, but"
9056 + " it already has a parent");
9057 }
9058 }
9059
9060 /**
9061 * This is called when the view is attached to a window. At this point it
9062 * has a Surface and will start drawing. Note that this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -07009063 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)},
9064 * however it may be called any time before the first onDraw -- including
9065 * before or after {@link #onMeasure(int, int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009066 *
9067 * @see #onDetachedFromWindow()
9068 */
9069 protected void onAttachedToWindow() {
9070 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
9071 mParent.requestTransparentRegion(this);
9072 }
Adam Powell8568c3a2010-04-19 14:26:11 -07009073 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
9074 initialAwakenScrollBars();
9075 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
9076 }
Chet Haasea9b61ac2010-12-20 07:40:25 -08009077 jumpDrawablesToCurrentState();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009078 resolveLayoutDirectionIfNeeded();
9079 resolvePadding();
Fabrice Di Meglio22268862011-06-27 18:13:18 -07009080 resolveTextDirection();
Amith Yamasani4503c8d2011-06-17 12:36:14 -07009081 if (isFocused()) {
9082 InputMethodManager imm = InputMethodManager.peekInstance();
9083 imm.focusIn(this);
9084 }
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07009085 }
Cibu Johny86666632010-02-22 13:01:02 -08009086
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07009087 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009088 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing
9089 * that the parent directionality can and will be resolved before its children.
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07009090 */
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009091 private void resolveLayoutDirectionIfNeeded() {
9092 // Do not resolve if it is not needed
9093 if ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED) == LAYOUT_DIRECTION_RESOLVED) return;
9094
9095 // Clear any previous layout direction resolution
9096 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_RTL;
9097
9098 // Set resolved depending on layout direction
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07009099 switch (getLayoutDirection()) {
9100 case LAYOUT_DIRECTION_INHERIT:
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -07009101 // We cannot do the resolution if there is no parent
9102 if (mParent == null) return;
9103
Cibu Johny86666632010-02-22 13:01:02 -08009104 // If this is root view, no need to look at parent's layout dir.
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -07009105 if (mParent instanceof ViewGroup) {
9106 ViewGroup viewGroup = ((ViewGroup) mParent);
9107
9108 // Check if the parent view group can resolve
9109 if (! viewGroup.canResolveLayoutDirection()) {
9110 return;
9111 }
9112 if (viewGroup.getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
9113 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
9114 }
Cibu Johny86666632010-02-22 13:01:02 -08009115 }
9116 break;
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07009117 case LAYOUT_DIRECTION_RTL:
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009118 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
Cibu Johny86666632010-02-22 13:01:02 -08009119 break;
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -07009120 case LAYOUT_DIRECTION_LOCALE:
9121 if(isLayoutDirectionRtl(Locale.getDefault())) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009122 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -07009123 }
9124 break;
9125 default:
9126 // Nothing to do, LTR by default
9127 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009128
9129 // Set to resolved
9130 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED;
9131 }
9132
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -07009133 /**
9134 * @hide
9135 */
9136 protected void resolvePadding() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009137 // If the user specified the absolute padding (either with android:padding or
9138 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
9139 // use the default padding or the padding from the background drawable
9140 // (stored at this point in mPadding*)
9141 switch (getResolvedLayoutDirection()) {
9142 case LAYOUT_DIRECTION_RTL:
9143 // Start user padding override Right user padding. Otherwise, if Right user
9144 // padding is not defined, use the default Right padding. If Right user padding
9145 // is defined, just use it.
9146 if (mUserPaddingStart >= 0) {
9147 mUserPaddingRight = mUserPaddingStart;
9148 } else if (mUserPaddingRight < 0) {
9149 mUserPaddingRight = mPaddingRight;
9150 }
9151 if (mUserPaddingEnd >= 0) {
9152 mUserPaddingLeft = mUserPaddingEnd;
9153 } else if (mUserPaddingLeft < 0) {
9154 mUserPaddingLeft = mPaddingLeft;
9155 }
9156 break;
9157 case LAYOUT_DIRECTION_LTR:
9158 default:
9159 // Start user padding override Left user padding. Otherwise, if Left user
9160 // padding is not defined, use the default left padding. If Left user padding
9161 // is defined, just use it.
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -07009162 if (mUserPaddingStart >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009163 mUserPaddingLeft = mUserPaddingStart;
9164 } else if (mUserPaddingLeft < 0) {
9165 mUserPaddingLeft = mPaddingLeft;
9166 }
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -07009167 if (mUserPaddingEnd >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009168 mUserPaddingRight = mUserPaddingEnd;
9169 } else if (mUserPaddingRight < 0) {
9170 mUserPaddingRight = mPaddingRight;
9171 }
9172 }
9173
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009174 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom;
9175
9176 recomputePadding();
9177 }
9178
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -07009179 protected boolean canResolveLayoutDirection() {
9180 switch (getLayoutDirection()) {
9181 case LAYOUT_DIRECTION_INHERIT:
9182 return (mParent != null);
9183 default:
9184 return true;
9185 }
9186 }
9187
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009188 /**
Doug Feltc0ccf0c2011-06-23 16:13:18 -07009189 * Reset the resolved layout direction.
9190 *
9191 * Subclasses need to override this method to clear cached information that depends on the
9192 * resolved layout direction, or to inform child views that inherit their layout direction.
9193 * Overrides must also call the superclass implementation at the start of their implementation.
9194 *
9195 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009196 */
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07009197 protected void resetResolvedLayoutDirection() {
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07009198 // Reset the current View resolution
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009199 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED;
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -07009200 }
9201
9202 /**
9203 * Check if a Locale is corresponding to a RTL script.
9204 *
9205 * @param locale Locale to check
9206 * @return true if a Locale is corresponding to a RTL script.
9207 */
Fabrice Di Meglio22268862011-06-27 18:13:18 -07009208 protected static boolean isLayoutDirectionRtl(Locale locale) {
Fabrice Di Meglioa47f45e2011-06-15 14:22:12 -07009209 return (LocaleUtil.TEXT_LAYOUT_DIRECTION_RTL_DO_NOT_USE ==
9210 LocaleUtil.getLayoutDirectionFromLocale(locale));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009211 }
9212
9213 /**
9214 * This is called when the view is detached from a window. At this point it
9215 * no longer has a surface for drawing.
9216 *
9217 * @see #onAttachedToWindow()
9218 */
9219 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -08009220 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -08009221
Romain Guya440b002010-02-24 15:57:54 -08009222 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -05009223 removeLongPressCallback();
Adam Powell3cb8b632011-01-21 15:34:14 -08009224 removePerformClickCallback();
Svetoslav Ganova0156172011-06-26 17:55:44 -07009225 removeSendViewScrolledAccessibilityEventCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -08009226
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009227 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -08009228
Romain Guy6d7475d2011-07-27 16:28:21 -07009229 destroyLayer();
Romain Guy8dd5b1e2011-01-14 17:28:51 -08009230
Chet Haasedaf98e92011-01-10 14:10:36 -08009231 if (mDisplayList != null) {
9232 mDisplayList.invalidate();
9233 }
9234
Romain Guy8dd5b1e2011-01-14 17:28:51 -08009235 if (mAttachInfo != null) {
9236 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_MSG, this);
9237 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_RECT_MSG, this);
9238 }
9239
Patrick Dubroyec84c3a2011-01-13 17:55:37 -08009240 mCurrentAnimation = null;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07009241
9242 resetResolvedLayoutDirection();
9243 resetResolvedTextDirection();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009244 }
9245
9246 /**
9247 * @return The number of times this view has been attached to a window
9248 */
9249 protected int getWindowAttachCount() {
9250 return mWindowAttachCount;
9251 }
9252
9253 /**
9254 * Retrieve a unique token identifying the window this view is attached to.
9255 * @return Return the window's token for use in
9256 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
9257 */
9258 public IBinder getWindowToken() {
9259 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
9260 }
9261
9262 /**
9263 * Retrieve a unique token identifying the top-level "real" window of
9264 * the window that this view is attached to. That is, this is like
9265 * {@link #getWindowToken}, except if the window this view in is a panel
9266 * window (attached to another containing window), then the token of
9267 * the containing window is returned instead.
9268 *
9269 * @return Returns the associated window token, either
9270 * {@link #getWindowToken()} or the containing window's token.
9271 */
9272 public IBinder getApplicationWindowToken() {
9273 AttachInfo ai = mAttachInfo;
9274 if (ai != null) {
9275 IBinder appWindowToken = ai.mPanelParentWindowToken;
9276 if (appWindowToken == null) {
9277 appWindowToken = ai.mWindowToken;
9278 }
9279 return appWindowToken;
9280 }
9281 return null;
9282 }
9283
9284 /**
9285 * Retrieve private session object this view hierarchy is using to
9286 * communicate with the window manager.
9287 * @return the session object to communicate with the window manager
9288 */
9289 /*package*/ IWindowSession getWindowSession() {
9290 return mAttachInfo != null ? mAttachInfo.mSession : null;
9291 }
9292
9293 /**
9294 * @param info the {@link android.view.View.AttachInfo} to associated with
9295 * this view
9296 */
9297 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
9298 //System.out.println("Attached! " + this);
9299 mAttachInfo = info;
9300 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08009301 // We will need to evaluate the drawable state at least once.
9302 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009303 if (mFloatingTreeObserver != null) {
9304 info.mTreeObserver.merge(mFloatingTreeObserver);
9305 mFloatingTreeObserver = null;
9306 }
9307 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
9308 mAttachInfo.mScrollContainers.add(this);
9309 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
9310 }
9311 performCollectViewAttributes(visibility);
9312 onAttachedToWindow();
Adam Powell4afd62b2011-02-18 15:02:18 -08009313
9314 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
9315 mOnAttachStateChangeListeners;
9316 if (listeners != null && listeners.size() > 0) {
9317 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
9318 // perform the dispatching. The iterator is a safe guard against listeners that
9319 // could mutate the list by calling the various add/remove methods. This prevents
9320 // the array from being modified while we iterate it.
9321 for (OnAttachStateChangeListener listener : listeners) {
9322 listener.onViewAttachedToWindow(this);
9323 }
9324 }
9325
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009326 int vis = info.mWindowVisibility;
9327 if (vis != GONE) {
9328 onWindowVisibilityChanged(vis);
9329 }
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08009330 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) {
9331 // If nobody has evaluated the drawable state yet, then do it now.
9332 refreshDrawableState();
9333 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009334 }
9335
9336 void dispatchDetachedFromWindow() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009337 AttachInfo info = mAttachInfo;
9338 if (info != null) {
9339 int vis = info.mWindowVisibility;
9340 if (vis != GONE) {
9341 onWindowVisibilityChanged(GONE);
9342 }
9343 }
9344
9345 onDetachedFromWindow();
Romain Guy01d5edc2011-01-28 11:28:53 -08009346
Adam Powell4afd62b2011-02-18 15:02:18 -08009347 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
9348 mOnAttachStateChangeListeners;
9349 if (listeners != null && listeners.size() > 0) {
9350 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
9351 // perform the dispatching. The iterator is a safe guard against listeners that
9352 // could mutate the list by calling the various add/remove methods. This prevents
9353 // the array from being modified while we iterate it.
9354 for (OnAttachStateChangeListener listener : listeners) {
9355 listener.onViewDetachedFromWindow(this);
9356 }
9357 }
9358
Romain Guy01d5edc2011-01-28 11:28:53 -08009359 if ((mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009360 mAttachInfo.mScrollContainers.remove(this);
9361 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
9362 }
Romain Guy01d5edc2011-01-28 11:28:53 -08009363
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009364 mAttachInfo = null;
9365 }
9366
9367 /**
9368 * Store this view hierarchy's frozen state into the given container.
9369 *
9370 * @param container The SparseArray in which to save the view's state.
9371 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009372 * @see #restoreHierarchyState(android.util.SparseArray)
9373 * @see #dispatchSaveInstanceState(android.util.SparseArray)
9374 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009375 */
9376 public void saveHierarchyState(SparseArray<Parcelable> container) {
9377 dispatchSaveInstanceState(container);
9378 }
9379
9380 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07009381 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for
9382 * this view and its children. May be overridden to modify how freezing happens to a
9383 * view's children; for example, some views may want to not store state for their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009384 *
9385 * @param container The SparseArray in which to save the view's state.
9386 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009387 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
9388 * @see #saveHierarchyState(android.util.SparseArray)
9389 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009390 */
9391 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
9392 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
9393 mPrivateFlags &= ~SAVE_STATE_CALLED;
9394 Parcelable state = onSaveInstanceState();
9395 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
9396 throw new IllegalStateException(
9397 "Derived class did not call super.onSaveInstanceState()");
9398 }
9399 if (state != null) {
9400 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
9401 // + ": " + state);
9402 container.put(mID, state);
9403 }
9404 }
9405 }
9406
9407 /**
9408 * Hook allowing a view to generate a representation of its internal state
9409 * that can later be used to create a new instance with that same state.
9410 * This state should only contain information that is not persistent or can
9411 * not be reconstructed later. For example, you will never store your
9412 * current position on screen because that will be computed again when a
9413 * new instance of the view is placed in its view hierarchy.
9414 * <p>
9415 * Some examples of things you may store here: the current cursor position
9416 * in a text view (but usually not the text itself since that is stored in a
9417 * content provider or other persistent storage), the currently selected
9418 * item in a list view.
9419 *
9420 * @return Returns a Parcelable object containing the view's current dynamic
9421 * state, or null if there is nothing interesting to save. The
9422 * default implementation returns null.
Romain Guy5c22a8c2011-05-13 11:48:45 -07009423 * @see #onRestoreInstanceState(android.os.Parcelable)
9424 * @see #saveHierarchyState(android.util.SparseArray)
9425 * @see #dispatchSaveInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009426 * @see #setSaveEnabled(boolean)
9427 */
9428 protected Parcelable onSaveInstanceState() {
9429 mPrivateFlags |= SAVE_STATE_CALLED;
9430 return BaseSavedState.EMPTY_STATE;
9431 }
9432
9433 /**
9434 * Restore this view hierarchy's frozen state from the given container.
9435 *
9436 * @param container The SparseArray which holds previously frozen states.
9437 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009438 * @see #saveHierarchyState(android.util.SparseArray)
9439 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
9440 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009441 */
9442 public void restoreHierarchyState(SparseArray<Parcelable> container) {
9443 dispatchRestoreInstanceState(container);
9444 }
9445
9446 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07009447 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the
9448 * state for this view and its children. May be overridden to modify how restoring
9449 * happens to a view's children; for example, some views may want to not store state
9450 * for their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009451 *
9452 * @param container The SparseArray which holds previously saved state.
9453 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009454 * @see #dispatchSaveInstanceState(android.util.SparseArray)
9455 * @see #restoreHierarchyState(android.util.SparseArray)
9456 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009457 */
9458 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
9459 if (mID != NO_ID) {
9460 Parcelable state = container.get(mID);
9461 if (state != null) {
9462 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
9463 // + ": " + state);
9464 mPrivateFlags &= ~SAVE_STATE_CALLED;
9465 onRestoreInstanceState(state);
9466 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
9467 throw new IllegalStateException(
9468 "Derived class did not call super.onRestoreInstanceState()");
9469 }
9470 }
9471 }
9472 }
9473
9474 /**
9475 * Hook allowing a view to re-apply a representation of its internal state that had previously
9476 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
9477 * null state.
9478 *
9479 * @param state The frozen state that had previously been returned by
9480 * {@link #onSaveInstanceState}.
9481 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009482 * @see #onSaveInstanceState()
9483 * @see #restoreHierarchyState(android.util.SparseArray)
9484 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009485 */
9486 protected void onRestoreInstanceState(Parcelable state) {
9487 mPrivateFlags |= SAVE_STATE_CALLED;
9488 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -08009489 throw new IllegalArgumentException("Wrong state class, expecting View State but "
9490 + "received " + state.getClass().toString() + " instead. This usually happens "
Joe Malin32736f02011-01-19 16:14:20 -08009491 + "when two views of different type have the same id in the same hierarchy. "
9492 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
Romain Guy237c1ce2009-12-08 11:30:25 -08009493 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009494 }
9495 }
9496
9497 /**
9498 * <p>Return the time at which the drawing of the view hierarchy started.</p>
9499 *
9500 * @return the drawing start time in milliseconds
9501 */
9502 public long getDrawingTime() {
9503 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
9504 }
9505
9506 /**
9507 * <p>Enables or disables the duplication of the parent's state into this view. When
9508 * duplication is enabled, this view gets its drawable state from its parent rather
9509 * than from its own internal properties.</p>
9510 *
9511 * <p>Note: in the current implementation, setting this property to true after the
9512 * view was added to a ViewGroup might have no effect at all. This property should
9513 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
9514 *
9515 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
9516 * property is enabled, an exception will be thrown.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009517 *
Gilles Debunnefb817032011-01-13 13:52:49 -08009518 * <p>Note: if the child view uses and updates additionnal states which are unknown to the
9519 * parent, these states should not be affected by this method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009520 *
9521 * @param enabled True to enable duplication of the parent's drawable state, false
9522 * to disable it.
9523 *
9524 * @see #getDrawableState()
9525 * @see #isDuplicateParentStateEnabled()
9526 */
9527 public void setDuplicateParentStateEnabled(boolean enabled) {
9528 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
9529 }
9530
9531 /**
9532 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
9533 *
9534 * @return True if this view's drawable state is duplicated from the parent,
9535 * false otherwise
9536 *
9537 * @see #getDrawableState()
9538 * @see #setDuplicateParentStateEnabled(boolean)
9539 */
9540 public boolean isDuplicateParentStateEnabled() {
9541 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
9542 }
9543
9544 /**
Romain Guy171c5922011-01-06 10:04:23 -08009545 * <p>Specifies the type of layer backing this view. The layer can be
9546 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
9547 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009548 *
Romain Guy171c5922011-01-06 10:04:23 -08009549 * <p>A layer is associated with an optional {@link android.graphics.Paint}
9550 * instance that controls how the layer is composed on screen. The following
9551 * properties of the paint are taken into account when composing the layer:</p>
9552 * <ul>
9553 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
9554 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
9555 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
9556 * </ul>
Joe Malin32736f02011-01-19 16:14:20 -08009557 *
Romain Guy171c5922011-01-06 10:04:23 -08009558 * <p>If this view has an alpha value set to < 1.0 by calling
9559 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
9560 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
9561 * equivalent to setting a hardware layer on this view and providing a paint with
9562 * the desired alpha value.<p>
Joe Malin32736f02011-01-19 16:14:20 -08009563 *
Romain Guy171c5922011-01-06 10:04:23 -08009564 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
9565 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
9566 * for more information on when and how to use layers.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009567 *
Romain Guy171c5922011-01-06 10:04:23 -08009568 * @param layerType The ype of layer to use with this view, must be one of
9569 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
9570 * {@link #LAYER_TYPE_HARDWARE}
9571 * @param paint The paint used to compose the layer. This argument is optional
9572 * and can be null. It is ignored when the layer type is
9573 * {@link #LAYER_TYPE_NONE}
Joe Malin32736f02011-01-19 16:14:20 -08009574 *
9575 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -08009576 * @see #LAYER_TYPE_NONE
9577 * @see #LAYER_TYPE_SOFTWARE
9578 * @see #LAYER_TYPE_HARDWARE
Joe Malin32736f02011-01-19 16:14:20 -08009579 * @see #setAlpha(float)
9580 *
Romain Guy171c5922011-01-06 10:04:23 -08009581 * @attr ref android.R.styleable#View_layerType
9582 */
9583 public void setLayerType(int layerType, Paint paint) {
9584 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
Joe Malin32736f02011-01-19 16:14:20 -08009585 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
Romain Guy171c5922011-01-06 10:04:23 -08009586 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
9587 }
Chet Haasedaf98e92011-01-10 14:10:36 -08009588
Romain Guyd6cd5722011-01-17 14:42:41 -08009589 if (layerType == mLayerType) {
9590 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) {
9591 mLayerPaint = paint == null ? new Paint() : paint;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009592 invalidateParentCaches();
9593 invalidate(true);
Romain Guyd6cd5722011-01-17 14:42:41 -08009594 }
9595 return;
9596 }
Romain Guy171c5922011-01-06 10:04:23 -08009597
9598 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -08009599 switch (mLayerType) {
Chet Haase6f33e812011-05-17 12:42:19 -07009600 case LAYER_TYPE_HARDWARE:
Romain Guy6d7475d2011-07-27 16:28:21 -07009601 destroyLayer();
Chet Haase6f33e812011-05-17 12:42:19 -07009602 // fall through - unaccelerated views may use software layer mechanism instead
Romain Guy6c319ca2011-01-11 14:29:25 -08009603 case LAYER_TYPE_SOFTWARE:
Romain Guy6d7475d2011-07-27 16:28:21 -07009604 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -08009605 break;
Romain Guy6c319ca2011-01-11 14:29:25 -08009606 default:
9607 break;
Romain Guy171c5922011-01-06 10:04:23 -08009608 }
9609
9610 mLayerType = layerType;
Romain Guy3a3133d2011-02-01 22:59:58 -08009611 final boolean layerDisabled = mLayerType == LAYER_TYPE_NONE;
9612 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint);
9613 mLocalDirtyRect = layerDisabled ? null : new Rect();
Romain Guy171c5922011-01-06 10:04:23 -08009614
Romain Guy0fd89bf2011-01-26 15:41:30 -08009615 invalidateParentCaches();
9616 invalidate(true);
Romain Guy171c5922011-01-06 10:04:23 -08009617 }
9618
9619 /**
9620 * Indicates what type of layer is currently associated with this view. By default
9621 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
9622 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
9623 * for more information on the different types of layers.
Joe Malin32736f02011-01-19 16:14:20 -08009624 *
Romain Guy171c5922011-01-06 10:04:23 -08009625 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
9626 * {@link #LAYER_TYPE_HARDWARE}
Joe Malin32736f02011-01-19 16:14:20 -08009627 *
9628 * @see #setLayerType(int, android.graphics.Paint)
Romain Guyf1ae1062011-03-02 18:16:04 -08009629 * @see #buildLayer()
Romain Guy171c5922011-01-06 10:04:23 -08009630 * @see #LAYER_TYPE_NONE
9631 * @see #LAYER_TYPE_SOFTWARE
9632 * @see #LAYER_TYPE_HARDWARE
9633 */
9634 public int getLayerType() {
9635 return mLayerType;
9636 }
Joe Malin32736f02011-01-19 16:14:20 -08009637
Romain Guy6c319ca2011-01-11 14:29:25 -08009638 /**
Romain Guyf1ae1062011-03-02 18:16:04 -08009639 * Forces this view's layer to be created and this view to be rendered
9640 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE},
9641 * invoking this method will have no effect.
9642 *
9643 * This method can for instance be used to render a view into its layer before
9644 * starting an animation. If this view is complex, rendering into the layer
9645 * before starting the animation will avoid skipping frames.
9646 *
9647 * @throws IllegalStateException If this view is not attached to a window
9648 *
9649 * @see #setLayerType(int, android.graphics.Paint)
9650 */
9651 public void buildLayer() {
9652 if (mLayerType == LAYER_TYPE_NONE) return;
9653
9654 if (mAttachInfo == null) {
9655 throw new IllegalStateException("This view must be attached to a window first");
9656 }
9657
9658 switch (mLayerType) {
9659 case LAYER_TYPE_HARDWARE:
9660 getHardwareLayer();
9661 break;
9662 case LAYER_TYPE_SOFTWARE:
9663 buildDrawingCache(true);
9664 break;
9665 }
9666 }
9667
9668 /**
Romain Guy6c319ca2011-01-11 14:29:25 -08009669 * <p>Returns a hardware layer that can be used to draw this view again
9670 * without executing its draw method.</p>
9671 *
9672 * @return A HardwareLayer ready to render, or null if an error occurred.
9673 */
Romain Guy5e7f7662011-01-24 22:35:56 -08009674 HardwareLayer getHardwareLayer() {
Romain Guy6c319ca2011-01-11 14:29:25 -08009675 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null) {
9676 return null;
9677 }
9678
9679 final int width = mRight - mLeft;
9680 final int height = mBottom - mTop;
Joe Malin32736f02011-01-19 16:14:20 -08009681
Romain Guy6c319ca2011-01-11 14:29:25 -08009682 if (width == 0 || height == 0) {
9683 return null;
9684 }
9685
9686 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
9687 if (mHardwareLayer == null) {
9688 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
9689 width, height, isOpaque());
Romain Guy62687ec2011-02-02 15:44:19 -08009690 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -08009691 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
9692 mHardwareLayer.resize(width, height);
Romain Guy62687ec2011-02-02 15:44:19 -08009693 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -08009694 }
9695
Romain Guy59a12ca2011-06-09 17:48:21 -07009696 HardwareCanvas currentCanvas = mAttachInfo.mHardwareCanvas;
Romain Guy5e7f7662011-01-24 22:35:56 -08009697 final HardwareCanvas canvas = mHardwareLayer.start(currentCanvas);
9698 mAttachInfo.mHardwareCanvas = canvas;
Romain Guy6c319ca2011-01-11 14:29:25 -08009699 try {
9700 canvas.setViewport(width, height);
Romain Guy3a3133d2011-02-01 22:59:58 -08009701 canvas.onPreDraw(mLocalDirtyRect);
Romain Guy62687ec2011-02-02 15:44:19 -08009702 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -08009703
Chet Haase88172fe2011-03-07 17:36:33 -08009704 final int restoreCount = canvas.save();
9705
Romain Guy6c319ca2011-01-11 14:29:25 -08009706 computeScroll();
9707 canvas.translate(-mScrollX, -mScrollY);
9708
Romain Guy6c319ca2011-01-11 14:29:25 -08009709 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
Joe Malin32736f02011-01-19 16:14:20 -08009710
Romain Guy6c319ca2011-01-11 14:29:25 -08009711 // Fast path for layouts with no backgrounds
9712 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
9713 mPrivateFlags &= ~DIRTY_MASK;
9714 dispatchDraw(canvas);
9715 } else {
9716 draw(canvas);
9717 }
Joe Malin32736f02011-01-19 16:14:20 -08009718
Chet Haase88172fe2011-03-07 17:36:33 -08009719 canvas.restoreToCount(restoreCount);
Romain Guy6c319ca2011-01-11 14:29:25 -08009720 } finally {
9721 canvas.onPostDraw();
Romain Guy5e7f7662011-01-24 22:35:56 -08009722 mHardwareLayer.end(currentCanvas);
9723 mAttachInfo.mHardwareCanvas = currentCanvas;
Romain Guy6c319ca2011-01-11 14:29:25 -08009724 }
9725 }
9726
9727 return mHardwareLayer;
9728 }
Romain Guy171c5922011-01-06 10:04:23 -08009729
Romain Guy6d7475d2011-07-27 16:28:21 -07009730 void destroyLayer() {
9731 if (mHardwareLayer != null) {
9732 mHardwareLayer.destroy();
9733 mHardwareLayer = null;
9734 }
9735 }
9736
Romain Guy171c5922011-01-06 10:04:23 -08009737 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009738 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
9739 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
9740 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
9741 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
9742 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
9743 * null.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009744 *
Romain Guy171c5922011-01-06 10:04:23 -08009745 * <p>Enabling the drawing cache is similar to
9746 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
Chet Haasedaf98e92011-01-10 14:10:36 -08009747 * acceleration is turned off. When hardware acceleration is turned on, enabling the
9748 * drawing cache has no effect on rendering because the system uses a different mechanism
9749 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even
9750 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)}
9751 * for information on how to enable software and hardware layers.</p>
9752 *
9753 * <p>This API can be used to manually generate
9754 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling
9755 * {@link #getDrawingCache()}.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009756 *
9757 * @param enabled true to enable the drawing cache, false otherwise
9758 *
9759 * @see #isDrawingCacheEnabled()
9760 * @see #getDrawingCache()
9761 * @see #buildDrawingCache()
Joe Malin32736f02011-01-19 16:14:20 -08009762 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009763 */
9764 public void setDrawingCacheEnabled(boolean enabled) {
Romain Guy0211a0a2011-02-14 16:34:59 -08009765 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009766 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
9767 }
9768
9769 /**
9770 * <p>Indicates whether the drawing cache is enabled for this view.</p>
9771 *
9772 * @return true if the drawing cache is enabled
9773 *
9774 * @see #setDrawingCacheEnabled(boolean)
9775 * @see #getDrawingCache()
9776 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07009777 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009778 public boolean isDrawingCacheEnabled() {
9779 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
9780 }
9781
9782 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08009783 * Debugging utility which recursively outputs the dirty state of a view and its
9784 * descendants.
Joe Malin32736f02011-01-19 16:14:20 -08009785 *
Chet Haasedaf98e92011-01-10 14:10:36 -08009786 * @hide
9787 */
Romain Guy676b1732011-02-14 14:45:33 -08009788 @SuppressWarnings({"UnusedDeclaration"})
Chet Haasedaf98e92011-01-10 14:10:36 -08009789 public void outputDirtyFlags(String indent, boolean clear, int clearMask) {
9790 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) +
9791 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" +
9792 (mPrivateFlags & View.DRAWING_CACHE_VALID) +
9793 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")");
9794 if (clear) {
9795 mPrivateFlags &= clearMask;
9796 }
9797 if (this instanceof ViewGroup) {
9798 ViewGroup parent = (ViewGroup) this;
9799 final int count = parent.getChildCount();
9800 for (int i = 0; i < count; i++) {
Romain Guy7d7b5492011-01-24 16:33:45 -08009801 final View child = parent.getChildAt(i);
Chet Haasedaf98e92011-01-10 14:10:36 -08009802 child.outputDirtyFlags(indent + " ", clear, clearMask);
9803 }
9804 }
9805 }
9806
9807 /**
9808 * This method is used by ViewGroup to cause its children to restore or recreate their
9809 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need
9810 * to recreate its own display list, which would happen if it went through the normal
9811 * draw/dispatchDraw mechanisms.
9812 *
9813 * @hide
9814 */
9815 protected void dispatchGetDisplayList() {}
Chet Haasef4ac5472011-01-27 10:30:25 -08009816
9817 /**
9818 * A view that is not attached or hardware accelerated cannot create a display list.
9819 * This method checks these conditions and returns the appropriate result.
9820 *
9821 * @return true if view has the ability to create a display list, false otherwise.
9822 *
9823 * @hide
9824 */
9825 public boolean canHaveDisplayList() {
Romain Guy676b1732011-02-14 14:45:33 -08009826 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null);
Chet Haasef4ac5472011-01-27 10:30:25 -08009827 }
Joe Malin32736f02011-01-19 16:14:20 -08009828
Chet Haasedaf98e92011-01-10 14:10:36 -08009829 /**
Romain Guyb051e892010-09-28 19:09:36 -07009830 * <p>Returns a display list that can be used to draw this view again
9831 * without executing its draw method.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009832 *
Romain Guyb051e892010-09-28 19:09:36 -07009833 * @return A DisplayList ready to replay, or null if caching is not enabled.
Chet Haasedaf98e92011-01-10 14:10:36 -08009834 *
9835 * @hide
Romain Guyb051e892010-09-28 19:09:36 -07009836 */
Chet Haasedaf98e92011-01-10 14:10:36 -08009837 public DisplayList getDisplayList() {
Chet Haasef4ac5472011-01-27 10:30:25 -08009838 if (!canHaveDisplayList()) {
Romain Guyb051e892010-09-28 19:09:36 -07009839 return null;
9840 }
9841
Chet Haasedaf98e92011-01-10 14:10:36 -08009842 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 ||
9843 mDisplayList == null || !mDisplayList.isValid() ||
9844 mRecreateDisplayList)) {
9845 // Don't need to recreate the display list, just need to tell our
9846 // children to restore/recreate theirs
9847 if (mDisplayList != null && mDisplayList.isValid() &&
9848 !mRecreateDisplayList) {
9849 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
9850 mPrivateFlags &= ~DIRTY_MASK;
9851 dispatchGetDisplayList();
9852
9853 return mDisplayList;
9854 }
9855
9856 // If we got here, we're recreating it. Mark it as such to ensure that
9857 // we copy in child display lists into ours in drawChild()
9858 mRecreateDisplayList = true;
Chet Haase9e90a992011-01-04 16:23:21 -08009859 if (mDisplayList == null) {
Jeff Brown162a0212011-07-21 17:02:54 -07009860 mDisplayList = mAttachInfo.mHardwareRenderer.createDisplayList();
Chet Haasedaf98e92011-01-10 14:10:36 -08009861 // If we're creating a new display list, make sure our parent gets invalidated
9862 // since they will need to recreate their display list to account for this
9863 // new child display list.
Romain Guy0fd89bf2011-01-26 15:41:30 -08009864 invalidateParentCaches();
Chet Haase9e90a992011-01-04 16:23:21 -08009865 }
Romain Guyb051e892010-09-28 19:09:36 -07009866
9867 final HardwareCanvas canvas = mDisplayList.start();
9868 try {
9869 int width = mRight - mLeft;
9870 int height = mBottom - mTop;
9871
9872 canvas.setViewport(width, height);
Romain Guy7d7b5492011-01-24 16:33:45 -08009873 // The dirty rect should always be null for a display list
9874 canvas.onPreDraw(null);
Romain Guyb051e892010-09-28 19:09:36 -07009875
Chet Haase88172fe2011-03-07 17:36:33 -08009876 final int restoreCount = canvas.save();
9877
Chet Haasedaf98e92011-01-10 14:10:36 -08009878 computeScroll();
9879 canvas.translate(-mScrollX, -mScrollY);
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009880 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
Romain Guya9489272011-06-22 20:58:11 -07009881 mPrivateFlags &= ~DIRTY_MASK;
Joe Malin32736f02011-01-19 16:14:20 -08009882
Romain Guyb051e892010-09-28 19:09:36 -07009883 // Fast path for layouts with no backgrounds
9884 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
Romain Guyb051e892010-09-28 19:09:36 -07009885 dispatchDraw(canvas);
9886 } else {
9887 draw(canvas);
9888 }
Joe Malin32736f02011-01-19 16:14:20 -08009889
Chet Haase88172fe2011-03-07 17:36:33 -08009890 canvas.restoreToCount(restoreCount);
Romain Guyb051e892010-09-28 19:09:36 -07009891 } finally {
9892 canvas.onPostDraw();
9893
9894 mDisplayList.end();
Romain Guyb051e892010-09-28 19:09:36 -07009895 }
Chet Haase77785f92011-01-25 23:22:09 -08009896 } else {
9897 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
9898 mPrivateFlags &= ~DIRTY_MASK;
Romain Guyb051e892010-09-28 19:09:36 -07009899 }
9900
9901 return mDisplayList;
9902 }
9903
9904 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07009905 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009906 *
Romain Guyfbd8f692009-06-26 14:51:58 -07009907 * @return A non-scaled bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -08009908 *
Romain Guyfbd8f692009-06-26 14:51:58 -07009909 * @see #getDrawingCache(boolean)
9910 */
9911 public Bitmap getDrawingCache() {
9912 return getDrawingCache(false);
9913 }
9914
9915 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009916 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
9917 * is null when caching is disabled. If caching is enabled and the cache is not ready,
9918 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
9919 * draw from the cache when the cache is enabled. To benefit from the cache, you must
9920 * request the drawing cache by calling this method and draw it on screen if the
9921 * returned bitmap is not null.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009922 *
Romain Guyfbd8f692009-06-26 14:51:58 -07009923 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
9924 * this method will create a bitmap of the same size as this view. Because this bitmap
9925 * will be drawn scaled by the parent ViewGroup, the result on screen might show
9926 * scaling artifacts. To avoid such artifacts, you should call this method by setting
9927 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
9928 * size than the view. This implies that your application must be able to handle this
9929 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009930 *
Romain Guyfbd8f692009-06-26 14:51:58 -07009931 * @param autoScale Indicates whether the generated bitmap should be scaled based on
9932 * the current density of the screen when the application is in compatibility
9933 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009934 *
Romain Guyfbd8f692009-06-26 14:51:58 -07009935 * @return A bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -08009936 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009937 * @see #setDrawingCacheEnabled(boolean)
9938 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -07009939 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009940 * @see #destroyDrawingCache()
9941 */
Romain Guyfbd8f692009-06-26 14:51:58 -07009942 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009943 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
9944 return null;
9945 }
9946 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -07009947 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009948 }
Romain Guy02890fd2010-08-06 17:58:44 -07009949 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009950 }
9951
9952 /**
9953 * <p>Frees the resources used by the drawing cache. If you call
9954 * {@link #buildDrawingCache()} manually without calling
9955 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
9956 * should cleanup the cache with this method afterwards.</p>
9957 *
9958 * @see #setDrawingCacheEnabled(boolean)
9959 * @see #buildDrawingCache()
9960 * @see #getDrawingCache()
9961 */
9962 public void destroyDrawingCache() {
9963 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07009964 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009965 mDrawingCache = null;
9966 }
Romain Guyfbd8f692009-06-26 14:51:58 -07009967 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -07009968 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -07009969 mUnscaledDrawingCache = null;
9970 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009971 }
9972
9973 /**
9974 * Setting a solid background color for the drawing cache's bitmaps will improve
9975 * perfromance and memory usage. Note, though that this should only be used if this
9976 * view will always be drawn on top of a solid color.
9977 *
9978 * @param color The background color to use for the drawing cache's bitmap
9979 *
9980 * @see #setDrawingCacheEnabled(boolean)
9981 * @see #buildDrawingCache()
9982 * @see #getDrawingCache()
9983 */
9984 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -08009985 if (color != mDrawingCacheBackgroundColor) {
9986 mDrawingCacheBackgroundColor = color;
9987 mPrivateFlags &= ~DRAWING_CACHE_VALID;
9988 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009989 }
9990
9991 /**
9992 * @see #setDrawingCacheBackgroundColor(int)
9993 *
9994 * @return The background color to used for the drawing cache's bitmap
9995 */
9996 public int getDrawingCacheBackgroundColor() {
9997 return mDrawingCacheBackgroundColor;
9998 }
9999
10000 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070010001 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080010002 *
Romain Guyfbd8f692009-06-26 14:51:58 -070010003 * @see #buildDrawingCache(boolean)
10004 */
10005 public void buildDrawingCache() {
10006 buildDrawingCache(false);
10007 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -080010008
Romain Guyfbd8f692009-06-26 14:51:58 -070010009 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010010 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
10011 *
10012 * <p>If you call {@link #buildDrawingCache()} manually without calling
10013 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
10014 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Joe Malin32736f02011-01-19 16:14:20 -080010015 *
Romain Guyfbd8f692009-06-26 14:51:58 -070010016 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
10017 * this method will create a bitmap of the same size as this view. Because this bitmap
10018 * will be drawn scaled by the parent ViewGroup, the result on screen might show
10019 * scaling artifacts. To avoid such artifacts, you should call this method by setting
10020 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
10021 * size than the view. This implies that your application must be able to handle this
10022 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080010023 *
Romain Guy0d9275e2010-10-26 14:22:30 -070010024 * <p>You should avoid calling this method when hardware acceleration is enabled. If
10025 * you do not need the drawing cache bitmap, calling this method will increase memory
Joe Malin32736f02011-01-19 16:14:20 -080010026 * usage and cause the view to be rendered in software once, thus negatively impacting
Romain Guy0d9275e2010-10-26 14:22:30 -070010027 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010028 *
10029 * @see #getDrawingCache()
10030 * @see #destroyDrawingCache()
10031 */
Romain Guyfbd8f692009-06-26 14:51:58 -070010032 public void buildDrawingCache(boolean autoScale) {
10033 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -070010034 mDrawingCache == null : mUnscaledDrawingCache == null)) {
Romain Guy0211a0a2011-02-14 16:34:59 -080010035 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010036
10037 if (ViewDebug.TRACE_HIERARCHY) {
10038 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
10039 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010040
Romain Guy8506ab42009-06-11 17:35:47 -070010041 int width = mRight - mLeft;
10042 int height = mBottom - mTop;
10043
10044 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -070010045 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -070010046
Romain Guye1123222009-06-29 14:24:56 -070010047 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070010048 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
10049 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -070010050 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010051
10052 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -070010053 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -080010054 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010055
10056 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -070010057 // Projected bitmap size in bytes
Adam Powell26153a32010-11-08 15:22:27 -080010058 (width * height * (opaque && !use32BitCache ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010059 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
10060 destroyDrawingCache();
Romain Guy0211a0a2011-02-14 16:34:59 -080010061 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010062 return;
10063 }
10064
10065 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -070010066 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010067
10068 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010069 Bitmap.Config quality;
10070 if (!opaque) {
Romain Guy676b1732011-02-14 14:45:33 -080010071 // Never pick ARGB_4444 because it looks awful
10072 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010073 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
10074 case DRAWING_CACHE_QUALITY_AUTO:
10075 quality = Bitmap.Config.ARGB_8888;
10076 break;
10077 case DRAWING_CACHE_QUALITY_LOW:
Romain Guy676b1732011-02-14 14:45:33 -080010078 quality = Bitmap.Config.ARGB_8888;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010079 break;
10080 case DRAWING_CACHE_QUALITY_HIGH:
10081 quality = Bitmap.Config.ARGB_8888;
10082 break;
10083 default:
10084 quality = Bitmap.Config.ARGB_8888;
10085 break;
10086 }
10087 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -070010088 // Optimization for translucent windows
10089 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -080010090 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010091 }
10092
10093 // Try to cleanup memory
10094 if (bitmap != null) bitmap.recycle();
10095
10096 try {
10097 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -070010098 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -070010099 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -070010100 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070010101 } else {
Romain Guy02890fd2010-08-06 17:58:44 -070010102 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070010103 }
Adam Powell26153a32010-11-08 15:22:27 -080010104 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010105 } catch (OutOfMemoryError e) {
10106 // If there is not enough memory to create the bitmap cache, just
10107 // ignore the issue as bitmap caches are not required to draw the
10108 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -070010109 if (autoScale) {
10110 mDrawingCache = null;
10111 } else {
10112 mUnscaledDrawingCache = null;
10113 }
Romain Guy0211a0a2011-02-14 16:34:59 -080010114 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010115 return;
10116 }
10117
10118 clear = drawingCacheBackgroundColor != 0;
10119 }
10120
10121 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010122 if (attachInfo != null) {
10123 canvas = attachInfo.mCanvas;
10124 if (canvas == null) {
10125 canvas = new Canvas();
10126 }
10127 canvas.setBitmap(bitmap);
10128 // Temporarily clobber the cached Canvas in case one of our children
10129 // is also using a drawing cache. Without this, the children would
10130 // steal the canvas by attaching their own bitmap to it and bad, bad
10131 // thing would happen (invisible views, corrupted drawings, etc.)
10132 attachInfo.mCanvas = null;
10133 } else {
10134 // This case should hopefully never or seldom happen
10135 canvas = new Canvas(bitmap);
10136 }
10137
10138 if (clear) {
10139 bitmap.eraseColor(drawingCacheBackgroundColor);
10140 }
10141
10142 computeScroll();
10143 final int restoreCount = canvas.save();
Joe Malin32736f02011-01-19 16:14:20 -080010144
Romain Guye1123222009-06-29 14:24:56 -070010145 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070010146 final float scale = attachInfo.mApplicationScale;
10147 canvas.scale(scale, scale);
10148 }
Joe Malin32736f02011-01-19 16:14:20 -080010149
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010150 canvas.translate(-mScrollX, -mScrollY);
10151
Romain Guy5bcdff42009-05-14 21:27:18 -070010152 mPrivateFlags |= DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -080010153 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
10154 mLayerType != LAYER_TYPE_NONE) {
Romain Guy0d9275e2010-10-26 14:22:30 -070010155 mPrivateFlags |= DRAWING_CACHE_VALID;
10156 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010157
10158 // Fast path for layouts with no backgrounds
10159 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
10160 if (ViewDebug.TRACE_HIERARCHY) {
10161 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
10162 }
Romain Guy5bcdff42009-05-14 21:27:18 -070010163 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010164 dispatchDraw(canvas);
10165 } else {
10166 draw(canvas);
10167 }
10168
10169 canvas.restoreToCount(restoreCount);
10170
10171 if (attachInfo != null) {
10172 // Restore the cached Canvas for our siblings
10173 attachInfo.mCanvas = canvas;
10174 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010175 }
10176 }
10177
10178 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010179 * Create a snapshot of the view into a bitmap. We should probably make
10180 * some form of this public, but should think about the API.
10181 */
Romain Guy223ff5c2010-03-02 17:07:47 -080010182 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -070010183 int width = mRight - mLeft;
10184 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010185
Dianne Hackborn8cae1242009-09-10 14:32:16 -070010186 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -070010187 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -070010188 width = (int) ((width * scale) + 0.5f);
10189 height = (int) ((height * scale) + 0.5f);
Joe Malin32736f02011-01-19 16:14:20 -080010190
Romain Guy8c11e312009-09-14 15:15:30 -070010191 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010192 if (bitmap == null) {
10193 throw new OutOfMemoryError();
10194 }
10195
Dianne Hackborn8cae1242009-09-10 14:32:16 -070010196 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Joe Malin32736f02011-01-19 16:14:20 -080010197
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010198 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010199 if (attachInfo != null) {
10200 canvas = attachInfo.mCanvas;
10201 if (canvas == null) {
10202 canvas = new Canvas();
10203 }
10204 canvas.setBitmap(bitmap);
10205 // Temporarily clobber the cached Canvas in case one of our children
10206 // is also using a drawing cache. Without this, the children would
10207 // steal the canvas by attaching their own bitmap to it and bad, bad
10208 // things would happen (invisible views, corrupted drawings, etc.)
10209 attachInfo.mCanvas = null;
10210 } else {
10211 // This case should hopefully never or seldom happen
10212 canvas = new Canvas(bitmap);
10213 }
10214
Romain Guy5bcdff42009-05-14 21:27:18 -070010215 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010216 bitmap.eraseColor(backgroundColor);
10217 }
10218
10219 computeScroll();
10220 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -070010221 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010222 canvas.translate(-mScrollX, -mScrollY);
10223
Romain Guy5bcdff42009-05-14 21:27:18 -070010224 // Temporarily remove the dirty mask
10225 int flags = mPrivateFlags;
10226 mPrivateFlags &= ~DIRTY_MASK;
10227
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010228 // Fast path for layouts with no backgrounds
10229 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
10230 dispatchDraw(canvas);
10231 } else {
10232 draw(canvas);
10233 }
10234
Romain Guy5bcdff42009-05-14 21:27:18 -070010235 mPrivateFlags = flags;
10236
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010237 canvas.restoreToCount(restoreCount);
10238
10239 if (attachInfo != null) {
10240 // Restore the cached Canvas for our siblings
10241 attachInfo.mCanvas = canvas;
10242 }
Romain Guy8506ab42009-06-11 17:35:47 -070010243
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010244 return bitmap;
10245 }
10246
10247 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010248 * Indicates whether this View is currently in edit mode. A View is usually
10249 * in edit mode when displayed within a developer tool. For instance, if
10250 * this View is being drawn by a visual user interface builder, this method
10251 * should return true.
10252 *
10253 * Subclasses should check the return value of this method to provide
10254 * different behaviors if their normal behavior might interfere with the
10255 * host environment. For instance: the class spawns a thread in its
10256 * constructor, the drawing code relies on device-specific features, etc.
10257 *
10258 * This method is usually checked in the drawing code of custom widgets.
10259 *
10260 * @return True if this View is in edit mode, false otherwise.
10261 */
10262 public boolean isInEditMode() {
10263 return false;
10264 }
10265
10266 /**
10267 * If the View draws content inside its padding and enables fading edges,
10268 * it needs to support padding offsets. Padding offsets are added to the
10269 * fading edges to extend the length of the fade so that it covers pixels
10270 * drawn inside the padding.
10271 *
10272 * Subclasses of this class should override this method if they need
10273 * to draw content inside the padding.
10274 *
10275 * @return True if padding offset must be applied, false otherwise.
10276 *
10277 * @see #getLeftPaddingOffset()
10278 * @see #getRightPaddingOffset()
10279 * @see #getTopPaddingOffset()
10280 * @see #getBottomPaddingOffset()
10281 *
10282 * @since CURRENT
10283 */
10284 protected boolean isPaddingOffsetRequired() {
10285 return false;
10286 }
10287
10288 /**
10289 * Amount by which to extend the left fading region. Called only when
10290 * {@link #isPaddingOffsetRequired()} returns true.
10291 *
10292 * @return The left padding offset in pixels.
10293 *
10294 * @see #isPaddingOffsetRequired()
10295 *
10296 * @since CURRENT
10297 */
10298 protected int getLeftPaddingOffset() {
10299 return 0;
10300 }
10301
10302 /**
10303 * Amount by which to extend the right fading region. Called only when
10304 * {@link #isPaddingOffsetRequired()} returns true.
10305 *
10306 * @return The right padding offset in pixels.
10307 *
10308 * @see #isPaddingOffsetRequired()
10309 *
10310 * @since CURRENT
10311 */
10312 protected int getRightPaddingOffset() {
10313 return 0;
10314 }
10315
10316 /**
10317 * Amount by which to extend the top fading region. Called only when
10318 * {@link #isPaddingOffsetRequired()} returns true.
10319 *
10320 * @return The top padding offset in pixels.
10321 *
10322 * @see #isPaddingOffsetRequired()
10323 *
10324 * @since CURRENT
10325 */
10326 protected int getTopPaddingOffset() {
10327 return 0;
10328 }
10329
10330 /**
10331 * Amount by which to extend the bottom fading region. Called only when
10332 * {@link #isPaddingOffsetRequired()} returns true.
10333 *
10334 * @return The bottom padding offset in pixels.
10335 *
10336 * @see #isPaddingOffsetRequired()
10337 *
10338 * @since CURRENT
10339 */
10340 protected int getBottomPaddingOffset() {
10341 return 0;
10342 }
10343
10344 /**
Romain Guyf2fc4602011-07-19 15:20:03 -070010345 * @hide
10346 * @param offsetRequired
10347 */
10348 protected int getFadeTop(boolean offsetRequired) {
10349 int top = mPaddingTop;
10350 if (offsetRequired) top += getTopPaddingOffset();
10351 return top;
10352 }
10353
10354 /**
10355 * @hide
10356 * @param offsetRequired
10357 */
10358 protected int getFadeHeight(boolean offsetRequired) {
10359 int padding = mPaddingTop;
10360 if (offsetRequired) padding += getTopPaddingOffset();
10361 return mBottom - mTop - mPaddingBottom - padding;
10362 }
10363
10364 /**
Romain Guy2bffd262010-09-12 17:40:02 -070010365 * <p>Indicates whether this view is attached to an hardware accelerated
10366 * window or not.</p>
Joe Malin32736f02011-01-19 16:14:20 -080010367 *
Romain Guy2bffd262010-09-12 17:40:02 -070010368 * <p>Even if this method returns true, it does not mean that every call
10369 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
10370 * accelerated {@link android.graphics.Canvas}. For instance, if this view
10371 * is drawn onto an offscren {@link android.graphics.Bitmap} and its
10372 * window is hardware accelerated,
10373 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
10374 * return false, and this method will return true.</p>
Joe Malin32736f02011-01-19 16:14:20 -080010375 *
Romain Guy2bffd262010-09-12 17:40:02 -070010376 * @return True if the view is attached to a window and the window is
10377 * hardware accelerated; false in any other case.
10378 */
10379 public boolean isHardwareAccelerated() {
10380 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
10381 }
Joe Malin32736f02011-01-19 16:14:20 -080010382
Romain Guy2bffd262010-09-12 17:40:02 -070010383 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010384 * Manually render this view (and all of its children) to the given Canvas.
10385 * The view must have already done a full layout before this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070010386 * called. When implementing a view, implement
10387 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method.
10388 * If you do need to override this method, call the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010389 *
10390 * @param canvas The Canvas to which the View is rendered.
10391 */
10392 public void draw(Canvas canvas) {
10393 if (ViewDebug.TRACE_HIERARCHY) {
10394 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
10395 }
10396
Romain Guy5bcdff42009-05-14 21:27:18 -070010397 final int privateFlags = mPrivateFlags;
10398 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
10399 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
10400 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -070010401
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010402 /*
10403 * Draw traversal performs several drawing steps which must be executed
10404 * in the appropriate order:
10405 *
10406 * 1. Draw the background
10407 * 2. If necessary, save the canvas' layers to prepare for fading
10408 * 3. Draw view's content
10409 * 4. Draw children
10410 * 5. If necessary, draw the fading edges and restore layers
10411 * 6. Draw decorations (scrollbars for instance)
10412 */
10413
10414 // Step 1, draw the background, if needed
10415 int saveCount;
10416
Romain Guy24443ea2009-05-11 11:56:30 -070010417 if (!dirtyOpaque) {
10418 final Drawable background = mBGDrawable;
10419 if (background != null) {
10420 final int scrollX = mScrollX;
10421 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010422
Romain Guy24443ea2009-05-11 11:56:30 -070010423 if (mBackgroundSizeChanged) {
10424 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
10425 mBackgroundSizeChanged = false;
10426 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010427
Romain Guy24443ea2009-05-11 11:56:30 -070010428 if ((scrollX | scrollY) == 0) {
10429 background.draw(canvas);
10430 } else {
10431 canvas.translate(scrollX, scrollY);
10432 background.draw(canvas);
10433 canvas.translate(-scrollX, -scrollY);
10434 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010435 }
10436 }
10437
10438 // skip step 2 & 5 if possible (common case)
10439 final int viewFlags = mViewFlags;
10440 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
10441 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
10442 if (!verticalEdges && !horizontalEdges) {
10443 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070010444 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010445
10446 // Step 4, draw the children
10447 dispatchDraw(canvas);
10448
10449 // Step 6, draw decorations (scrollbars)
10450 onDrawScrollBars(canvas);
10451
10452 // we're done...
10453 return;
10454 }
10455
10456 /*
10457 * Here we do the full fledged routine...
10458 * (this is an uncommon case where speed matters less,
10459 * this is why we repeat some of the tests that have been
10460 * done above)
10461 */
10462
10463 boolean drawTop = false;
10464 boolean drawBottom = false;
10465 boolean drawLeft = false;
10466 boolean drawRight = false;
10467
10468 float topFadeStrength = 0.0f;
10469 float bottomFadeStrength = 0.0f;
10470 float leftFadeStrength = 0.0f;
10471 float rightFadeStrength = 0.0f;
10472
10473 // Step 2, save the canvas' layers
10474 int paddingLeft = mPaddingLeft;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010475
10476 final boolean offsetRequired = isPaddingOffsetRequired();
10477 if (offsetRequired) {
10478 paddingLeft += getLeftPaddingOffset();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010479 }
10480
10481 int left = mScrollX + paddingLeft;
10482 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
Romain Guyf2fc4602011-07-19 15:20:03 -070010483 int top = mScrollY + getFadeTop(offsetRequired);
10484 int bottom = top + getFadeHeight(offsetRequired);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010485
10486 if (offsetRequired) {
10487 right += getRightPaddingOffset();
10488 bottom += getBottomPaddingOffset();
10489 }
10490
10491 final ScrollabilityCache scrollabilityCache = mScrollCache;
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010492 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
10493 int length = (int) fadeHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010494
10495 // clip the fade length if top and bottom fades overlap
10496 // overlapping fades produce odd-looking artifacts
10497 if (verticalEdges && (top + length > bottom - length)) {
10498 length = (bottom - top) / 2;
10499 }
10500
10501 // also clip horizontal fades if necessary
10502 if (horizontalEdges && (left + length > right - length)) {
10503 length = (right - left) / 2;
10504 }
10505
10506 if (verticalEdges) {
10507 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010508 drawTop = topFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010509 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010510 drawBottom = bottomFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010511 }
10512
10513 if (horizontalEdges) {
10514 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010515 drawLeft = leftFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010516 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010517 drawRight = rightFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010518 }
10519
10520 saveCount = canvas.getSaveCount();
10521
10522 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -070010523 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010524 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
10525
10526 if (drawTop) {
10527 canvas.saveLayer(left, top, right, top + length, null, flags);
10528 }
10529
10530 if (drawBottom) {
10531 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
10532 }
10533
10534 if (drawLeft) {
10535 canvas.saveLayer(left, top, left + length, bottom, null, flags);
10536 }
10537
10538 if (drawRight) {
10539 canvas.saveLayer(right - length, top, right, bottom, null, flags);
10540 }
10541 } else {
10542 scrollabilityCache.setFadeColor(solidColor);
10543 }
10544
10545 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070010546 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010547
10548 // Step 4, draw the children
10549 dispatchDraw(canvas);
10550
10551 // Step 5, draw the fade effect and restore layers
10552 final Paint p = scrollabilityCache.paint;
10553 final Matrix matrix = scrollabilityCache.matrix;
10554 final Shader fade = scrollabilityCache.shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010555
10556 if (drawTop) {
10557 matrix.setScale(1, fadeHeight * topFadeStrength);
10558 matrix.postTranslate(left, top);
10559 fade.setLocalMatrix(matrix);
10560 canvas.drawRect(left, top, right, top + length, p);
10561 }
10562
10563 if (drawBottom) {
10564 matrix.setScale(1, fadeHeight * bottomFadeStrength);
10565 matrix.postRotate(180);
10566 matrix.postTranslate(left, bottom);
10567 fade.setLocalMatrix(matrix);
10568 canvas.drawRect(left, bottom - length, right, bottom, p);
10569 }
10570
10571 if (drawLeft) {
10572 matrix.setScale(1, fadeHeight * leftFadeStrength);
10573 matrix.postRotate(-90);
10574 matrix.postTranslate(left, top);
10575 fade.setLocalMatrix(matrix);
10576 canvas.drawRect(left, top, left + length, bottom, p);
10577 }
10578
10579 if (drawRight) {
10580 matrix.setScale(1, fadeHeight * rightFadeStrength);
10581 matrix.postRotate(90);
10582 matrix.postTranslate(right, top);
10583 fade.setLocalMatrix(matrix);
10584 canvas.drawRect(right - length, top, right, bottom, p);
10585 }
10586
10587 canvas.restoreToCount(saveCount);
10588
10589 // Step 6, draw decorations (scrollbars)
10590 onDrawScrollBars(canvas);
10591 }
10592
10593 /**
10594 * Override this if your view is known to always be drawn on top of a solid color background,
10595 * and needs to draw fading edges. Returning a non-zero color enables the view system to
10596 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
10597 * should be set to 0xFF.
10598 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070010599 * @see #setVerticalFadingEdgeEnabled(boolean)
10600 * @see #setHorizontalFadingEdgeEnabled(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010601 *
10602 * @return The known solid color background for this view, or 0 if the color may vary
10603 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010604 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010605 public int getSolidColor() {
10606 return 0;
10607 }
10608
10609 /**
10610 * Build a human readable string representation of the specified view flags.
10611 *
10612 * @param flags the view flags to convert to a string
10613 * @return a String representing the supplied flags
10614 */
10615 private static String printFlags(int flags) {
10616 String output = "";
10617 int numFlags = 0;
10618 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
10619 output += "TAKES_FOCUS";
10620 numFlags++;
10621 }
10622
10623 switch (flags & VISIBILITY_MASK) {
10624 case INVISIBLE:
10625 if (numFlags > 0) {
10626 output += " ";
10627 }
10628 output += "INVISIBLE";
10629 // USELESS HERE numFlags++;
10630 break;
10631 case GONE:
10632 if (numFlags > 0) {
10633 output += " ";
10634 }
10635 output += "GONE";
10636 // USELESS HERE numFlags++;
10637 break;
10638 default:
10639 break;
10640 }
10641 return output;
10642 }
10643
10644 /**
10645 * Build a human readable string representation of the specified private
10646 * view flags.
10647 *
10648 * @param privateFlags the private view flags to convert to a string
10649 * @return a String representing the supplied flags
10650 */
10651 private static String printPrivateFlags(int privateFlags) {
10652 String output = "";
10653 int numFlags = 0;
10654
10655 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
10656 output += "WANTS_FOCUS";
10657 numFlags++;
10658 }
10659
10660 if ((privateFlags & FOCUSED) == FOCUSED) {
10661 if (numFlags > 0) {
10662 output += " ";
10663 }
10664 output += "FOCUSED";
10665 numFlags++;
10666 }
10667
10668 if ((privateFlags & SELECTED) == SELECTED) {
10669 if (numFlags > 0) {
10670 output += " ";
10671 }
10672 output += "SELECTED";
10673 numFlags++;
10674 }
10675
10676 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
10677 if (numFlags > 0) {
10678 output += " ";
10679 }
10680 output += "IS_ROOT_NAMESPACE";
10681 numFlags++;
10682 }
10683
10684 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
10685 if (numFlags > 0) {
10686 output += " ";
10687 }
10688 output += "HAS_BOUNDS";
10689 numFlags++;
10690 }
10691
10692 if ((privateFlags & DRAWN) == DRAWN) {
10693 if (numFlags > 0) {
10694 output += " ";
10695 }
10696 output += "DRAWN";
10697 // USELESS HERE numFlags++;
10698 }
10699 return output;
10700 }
10701
10702 /**
10703 * <p>Indicates whether or not this view's layout will be requested during
10704 * the next hierarchy layout pass.</p>
10705 *
10706 * @return true if the layout will be forced during next layout pass
10707 */
10708 public boolean isLayoutRequested() {
10709 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
10710 }
10711
10712 /**
10713 * Assign a size and position to a view and all of its
10714 * descendants
10715 *
10716 * <p>This is the second phase of the layout mechanism.
10717 * (The first is measuring). In this phase, each parent calls
10718 * layout on all of its children to position them.
10719 * This is typically done using the child measurements
Chet Haase9c087442011-01-12 16:20:16 -080010720 * that were stored in the measure pass().</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010721 *
Chet Haase9c087442011-01-12 16:20:16 -080010722 * <p>Derived classes should not override this method.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010723 * Derived classes with children should override
10724 * onLayout. In that method, they should
Chet Haase9c087442011-01-12 16:20:16 -080010725 * call layout on each of their children.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010726 *
10727 * @param l Left position, relative to parent
10728 * @param t Top position, relative to parent
10729 * @param r Right position, relative to parent
10730 * @param b Bottom position, relative to parent
10731 */
Romain Guy5429e1d2010-09-07 12:38:00 -070010732 @SuppressWarnings({"unchecked"})
Chet Haase9c087442011-01-12 16:20:16 -080010733 public void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -070010734 int oldL = mLeft;
10735 int oldT = mTop;
10736 int oldB = mBottom;
10737 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010738 boolean changed = setFrame(l, t, r, b);
10739 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
10740 if (ViewDebug.TRACE_HIERARCHY) {
10741 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
10742 }
10743
10744 onLayout(changed, l, t, r, b);
10745 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -070010746
10747 if (mOnLayoutChangeListeners != null) {
10748 ArrayList<OnLayoutChangeListener> listenersCopy =
10749 (ArrayList<OnLayoutChangeListener>) mOnLayoutChangeListeners.clone();
10750 int numListeners = listenersCopy.size();
10751 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -070010752 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -070010753 }
10754 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010755 }
10756 mPrivateFlags &= ~FORCE_LAYOUT;
10757 }
10758
10759 /**
10760 * Called from layout when this view should
10761 * assign a size and position to each of its children.
10762 *
10763 * Derived classes with children should override
10764 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -070010765 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010766 * @param changed This is a new size or position for this view
10767 * @param left Left position, relative to parent
10768 * @param top Top position, relative to parent
10769 * @param right Right position, relative to parent
10770 * @param bottom Bottom position, relative to parent
10771 */
10772 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
10773 }
10774
10775 /**
10776 * Assign a size and position to this view.
10777 *
10778 * This is called from layout.
10779 *
10780 * @param left Left position, relative to parent
10781 * @param top Top position, relative to parent
10782 * @param right Right position, relative to parent
10783 * @param bottom Bottom position, relative to parent
10784 * @return true if the new size and position are different than the
10785 * previous ones
10786 * {@hide}
10787 */
10788 protected boolean setFrame(int left, int top, int right, int bottom) {
10789 boolean changed = false;
10790
10791 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -070010792 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010793 + right + "," + bottom + ")");
10794 }
10795
10796 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
10797 changed = true;
10798
10799 // Remember our drawn bit
10800 int drawn = mPrivateFlags & DRAWN;
10801
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010802 int oldWidth = mRight - mLeft;
10803 int oldHeight = mBottom - mTop;
Chet Haase75755e22011-07-18 17:48:25 -070010804 int newWidth = right - left;
10805 int newHeight = bottom - top;
10806 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight);
10807
10808 // Invalidate our old position
10809 invalidate(sizeChanged);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010810
10811 mLeft = left;
10812 mTop = top;
10813 mRight = right;
10814 mBottom = bottom;
10815
10816 mPrivateFlags |= HAS_BOUNDS;
10817
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010818
Chet Haase75755e22011-07-18 17:48:25 -070010819 if (sizeChanged) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -080010820 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
10821 // A change in dimension means an auto-centered pivot point changes, too
10822 mMatrixDirty = true;
10823 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010824 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
10825 }
10826
10827 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
10828 // If we are visible, force the DRAWN bit to on so that
10829 // this invalidate will go through (at least to our parent).
10830 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -080010831 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010832 // the DRAWN bit.
10833 mPrivateFlags |= DRAWN;
Chet Haase75755e22011-07-18 17:48:25 -070010834 invalidate(sizeChanged);
Chet Haasef28595e2011-01-31 18:52:12 -080010835 // parent display list may need to be recreated based on a change in the bounds
10836 // of any child
10837 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010838 }
10839
10840 // Reset drawn bit to original value (invalidate turns it off)
10841 mPrivateFlags |= drawn;
10842
10843 mBackgroundSizeChanged = true;
10844 }
10845 return changed;
10846 }
10847
10848 /**
10849 * Finalize inflating a view from XML. This is called as the last phase
10850 * of inflation, after all child views have been added.
10851 *
10852 * <p>Even if the subclass overrides onFinishInflate, they should always be
10853 * sure to call the super method, so that we get called.
10854 */
10855 protected void onFinishInflate() {
10856 }
10857
10858 /**
10859 * Returns the resources associated with this view.
10860 *
10861 * @return Resources object.
10862 */
10863 public Resources getResources() {
10864 return mResources;
10865 }
10866
10867 /**
10868 * Invalidates the specified Drawable.
10869 *
10870 * @param drawable the drawable to invalidate
10871 */
10872 public void invalidateDrawable(Drawable drawable) {
10873 if (verifyDrawable(drawable)) {
10874 final Rect dirty = drawable.getBounds();
10875 final int scrollX = mScrollX;
10876 final int scrollY = mScrollY;
10877
10878 invalidate(dirty.left + scrollX, dirty.top + scrollY,
10879 dirty.right + scrollX, dirty.bottom + scrollY);
10880 }
10881 }
10882
10883 /**
10884 * Schedules an action on a drawable to occur at a specified time.
10885 *
10886 * @param who the recipient of the action
10887 * @param what the action to run on the drawable
10888 * @param when the time at which the action must occur. Uses the
10889 * {@link SystemClock#uptimeMillis} timebase.
10890 */
10891 public void scheduleDrawable(Drawable who, Runnable what, long when) {
10892 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
10893 mAttachInfo.mHandler.postAtTime(what, who, when);
10894 }
10895 }
10896
10897 /**
10898 * Cancels a scheduled action on a drawable.
10899 *
10900 * @param who the recipient of the action
10901 * @param what the action to cancel
10902 */
10903 public void unscheduleDrawable(Drawable who, Runnable what) {
10904 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
10905 mAttachInfo.mHandler.removeCallbacks(what, who);
10906 }
10907 }
10908
10909 /**
10910 * Unschedule any events associated with the given Drawable. This can be
10911 * used when selecting a new Drawable into a view, so that the previous
10912 * one is completely unscheduled.
10913 *
10914 * @param who The Drawable to unschedule.
10915 *
10916 * @see #drawableStateChanged
10917 */
10918 public void unscheduleDrawable(Drawable who) {
10919 if (mAttachInfo != null) {
10920 mAttachInfo.mHandler.removeCallbacksAndMessages(who);
10921 }
10922 }
10923
Fabrice Di Meglioc0053222011-06-13 12:16:51 -070010924 /**
10925 * Return the layout direction of a given Drawable.
10926 *
10927 * @param who the Drawable to query
10928 *
10929 * @hide
10930 */
10931 public int getResolvedLayoutDirection(Drawable who) {
10932 return (who == mBGDrawable) ? getResolvedLayoutDirection() : LAYOUT_DIRECTION_DEFAULT;
Fabrice Di Meglio6a036402011-05-23 14:43:23 -070010933 }
10934
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010935 /**
10936 * If your view subclass is displaying its own Drawable objects, it should
10937 * override this function and return true for any Drawable it is
10938 * displaying. This allows animations for those drawables to be
10939 * scheduled.
10940 *
10941 * <p>Be sure to call through to the super class when overriding this
10942 * function.
10943 *
10944 * @param who The Drawable to verify. Return true if it is one you are
10945 * displaying, else return the result of calling through to the
10946 * super class.
10947 *
10948 * @return boolean If true than the Drawable is being displayed in the
10949 * view; else false and it is not allowed to animate.
10950 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070010951 * @see #unscheduleDrawable(android.graphics.drawable.Drawable)
10952 * @see #drawableStateChanged()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010953 */
10954 protected boolean verifyDrawable(Drawable who) {
10955 return who == mBGDrawable;
10956 }
10957
10958 /**
10959 * This function is called whenever the state of the view changes in such
10960 * a way that it impacts the state of drawables being shown.
10961 *
10962 * <p>Be sure to call through to the superclass when overriding this
10963 * function.
10964 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070010965 * @see Drawable#setState(int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010966 */
10967 protected void drawableStateChanged() {
10968 Drawable d = mBGDrawable;
10969 if (d != null && d.isStateful()) {
10970 d.setState(getDrawableState());
10971 }
10972 }
10973
10974 /**
10975 * Call this to force a view to update its drawable state. This will cause
10976 * drawableStateChanged to be called on this view. Views that are interested
10977 * in the new state should call getDrawableState.
10978 *
10979 * @see #drawableStateChanged
10980 * @see #getDrawableState
10981 */
10982 public void refreshDrawableState() {
10983 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
10984 drawableStateChanged();
10985
10986 ViewParent parent = mParent;
10987 if (parent != null) {
10988 parent.childDrawableStateChanged(this);
10989 }
10990 }
10991
10992 /**
10993 * Return an array of resource IDs of the drawable states representing the
10994 * current state of the view.
10995 *
10996 * @return The current drawable state
10997 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070010998 * @see Drawable#setState(int[])
10999 * @see #drawableStateChanged()
11000 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011001 */
11002 public final int[] getDrawableState() {
11003 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
11004 return mDrawableState;
11005 } else {
11006 mDrawableState = onCreateDrawableState(0);
11007 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
11008 return mDrawableState;
11009 }
11010 }
11011
11012 /**
11013 * Generate the new {@link android.graphics.drawable.Drawable} state for
11014 * this view. This is called by the view
11015 * system when the cached Drawable state is determined to be invalid. To
11016 * retrieve the current state, you should use {@link #getDrawableState}.
11017 *
11018 * @param extraSpace if non-zero, this is the number of extra entries you
11019 * would like in the returned array in which you can place your own
11020 * states.
11021 *
11022 * @return Returns an array holding the current {@link Drawable} state of
11023 * the view.
11024 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070011025 * @see #mergeDrawableStates(int[], int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011026 */
11027 protected int[] onCreateDrawableState(int extraSpace) {
11028 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
11029 mParent instanceof View) {
11030 return ((View) mParent).onCreateDrawableState(extraSpace);
11031 }
11032
11033 int[] drawableState;
11034
11035 int privateFlags = mPrivateFlags;
11036
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011037 int viewStateIndex = 0;
11038 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
11039 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
11040 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -070011041 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011042 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
11043 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Adam Powell5a7e94e2011-04-25 15:30:43 -070011044 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested &&
11045 HardwareRenderer.isAvailable()) {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011046 // This is set if HW acceleration is requested, even if the current
11047 // process doesn't allow it. This is just to allow app preview
11048 // windows to better match their app.
11049 viewStateIndex |= VIEW_STATE_ACCELERATED;
11050 }
PY Laligandc33d8d49e2011-03-14 18:22:53 -070011051 if ((privateFlags & HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011052
Christopher Tate3d4bf172011-03-28 16:16:46 -070011053 final int privateFlags2 = mPrivateFlags2;
11054 if ((privateFlags2 & DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT;
11055 if ((privateFlags2 & DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED;
11056
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011057 drawableState = VIEW_STATE_SETS[viewStateIndex];
11058
11059 //noinspection ConstantIfStatement
11060 if (false) {
11061 Log.i("View", "drawableStateIndex=" + viewStateIndex);
11062 Log.i("View", toString()
11063 + " pressed=" + ((privateFlags & PRESSED) != 0)
11064 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
11065 + " fo=" + hasFocus()
11066 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011067 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011068 + ": " + Arrays.toString(drawableState));
11069 }
11070
11071 if (extraSpace == 0) {
11072 return drawableState;
11073 }
11074
11075 final int[] fullState;
11076 if (drawableState != null) {
11077 fullState = new int[drawableState.length + extraSpace];
11078 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
11079 } else {
11080 fullState = new int[extraSpace];
11081 }
11082
11083 return fullState;
11084 }
11085
11086 /**
11087 * Merge your own state values in <var>additionalState</var> into the base
11088 * state values <var>baseState</var> that were returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070011089 * {@link #onCreateDrawableState(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011090 *
11091 * @param baseState The base state values returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070011092 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011093 * own additional state values.
11094 *
11095 * @param additionalState The additional state values you would like
11096 * added to <var>baseState</var>; this array is not modified.
11097 *
11098 * @return As a convenience, the <var>baseState</var> array you originally
11099 * passed into the function is returned.
11100 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070011101 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011102 */
11103 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
11104 final int N = baseState.length;
11105 int i = N - 1;
11106 while (i >= 0 && baseState[i] == 0) {
11107 i--;
11108 }
11109 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
11110 return baseState;
11111 }
11112
11113 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -070011114 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
11115 * on all Drawable objects associated with this view.
11116 */
11117 public void jumpDrawablesToCurrentState() {
11118 if (mBGDrawable != null) {
11119 mBGDrawable.jumpToCurrentState();
11120 }
11121 }
11122
11123 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011124 * Sets the background color for this view.
11125 * @param color the color of the background
11126 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000011127 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011128 public void setBackgroundColor(int color) {
Chet Haase70d4ba12010-10-06 09:46:45 -070011129 if (mBGDrawable instanceof ColorDrawable) {
11130 ((ColorDrawable) mBGDrawable).setColor(color);
11131 } else {
11132 setBackgroundDrawable(new ColorDrawable(color));
11133 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011134 }
11135
11136 /**
11137 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -070011138 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011139 * @param resid The identifier of the resource.
11140 * @attr ref android.R.styleable#View_background
11141 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000011142 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011143 public void setBackgroundResource(int resid) {
11144 if (resid != 0 && resid == mBackgroundResource) {
11145 return;
11146 }
11147
11148 Drawable d= null;
11149 if (resid != 0) {
11150 d = mResources.getDrawable(resid);
11151 }
11152 setBackgroundDrawable(d);
11153
11154 mBackgroundResource = resid;
11155 }
11156
11157 /**
11158 * Set the background to a given Drawable, or remove the background. If the
11159 * background has padding, this View's padding is set to the background's
11160 * padding. However, when a background is removed, this View's padding isn't
11161 * touched. If setting the padding is desired, please use
11162 * {@link #setPadding(int, int, int, int)}.
11163 *
11164 * @param d The Drawable to use as the background, or null to remove the
11165 * background
11166 */
11167 public void setBackgroundDrawable(Drawable d) {
Adam Powell4d36ec12011-07-17 16:44:16 -070011168 if (d == mBGDrawable) {
11169 return;
11170 }
11171
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011172 boolean requestLayout = false;
11173
11174 mBackgroundResource = 0;
11175
11176 /*
11177 * Regardless of whether we're setting a new background or not, we want
11178 * to clear the previous drawable.
11179 */
11180 if (mBGDrawable != null) {
11181 mBGDrawable.setCallback(null);
11182 unscheduleDrawable(mBGDrawable);
11183 }
11184
11185 if (d != null) {
11186 Rect padding = sThreadLocal.get();
11187 if (padding == null) {
11188 padding = new Rect();
11189 sThreadLocal.set(padding);
11190 }
11191 if (d.getPadding(padding)) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011192 switch (d.getResolvedLayoutDirectionSelf()) {
11193 case LAYOUT_DIRECTION_RTL:
11194 setPadding(padding.right, padding.top, padding.left, padding.bottom);
11195 break;
11196 case LAYOUT_DIRECTION_LTR:
11197 default:
11198 setPadding(padding.left, padding.top, padding.right, padding.bottom);
11199 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011200 }
11201
11202 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
11203 // if it has a different minimum size, we should layout again
11204 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() ||
11205 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) {
11206 requestLayout = true;
11207 }
11208
11209 d.setCallback(this);
11210 if (d.isStateful()) {
11211 d.setState(getDrawableState());
11212 }
11213 d.setVisible(getVisibility() == VISIBLE, false);
11214 mBGDrawable = d;
11215
11216 if ((mPrivateFlags & SKIP_DRAW) != 0) {
11217 mPrivateFlags &= ~SKIP_DRAW;
11218 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
11219 requestLayout = true;
11220 }
11221 } else {
11222 /* Remove the background */
11223 mBGDrawable = null;
11224
11225 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
11226 /*
11227 * This view ONLY drew the background before and we're removing
11228 * the background, so now it won't draw anything
11229 * (hence we SKIP_DRAW)
11230 */
11231 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
11232 mPrivateFlags |= SKIP_DRAW;
11233 }
11234
11235 /*
11236 * When the background is set, we try to apply its padding to this
11237 * View. When the background is removed, we don't touch this View's
11238 * padding. This is noted in the Javadocs. Hence, we don't need to
11239 * requestLayout(), the invalidate() below is sufficient.
11240 */
11241
11242 // The old background's minimum size could have affected this
11243 // View's layout, so let's requestLayout
11244 requestLayout = true;
11245 }
11246
Romain Guy8f1344f52009-05-15 16:03:59 -070011247 computeOpaqueFlags();
11248
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011249 if (requestLayout) {
11250 requestLayout();
11251 }
11252
11253 mBackgroundSizeChanged = true;
Romain Guy0fd89bf2011-01-26 15:41:30 -080011254 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011255 }
11256
11257 /**
11258 * Gets the background drawable
11259 * @return The drawable used as the background for this view, if any.
11260 */
11261 public Drawable getBackground() {
11262 return mBGDrawable;
11263 }
11264
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011265 /**
11266 * Sets the padding. The view may add on the space required to display
11267 * the scrollbars, depending on the style and visibility of the scrollbars.
11268 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
11269 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
11270 * from the values set in this call.
11271 *
11272 * @attr ref android.R.styleable#View_padding
11273 * @attr ref android.R.styleable#View_paddingBottom
11274 * @attr ref android.R.styleable#View_paddingLeft
11275 * @attr ref android.R.styleable#View_paddingRight
11276 * @attr ref android.R.styleable#View_paddingTop
11277 * @param left the left padding in pixels
11278 * @param top the top padding in pixels
11279 * @param right the right padding in pixels
11280 * @param bottom the bottom padding in pixels
11281 */
11282 public void setPadding(int left, int top, int right, int bottom) {
11283 boolean changed = false;
11284
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011285 mUserPaddingRelative = false;
11286
Adam Powell20232d02010-12-08 21:08:53 -080011287 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011288 mUserPaddingRight = right;
11289 mUserPaddingBottom = bottom;
11290
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011291 final int viewFlags = mViewFlags;
Romain Guy8506ab42009-06-11 17:35:47 -070011292
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011293 // Common case is there are no scroll bars.
11294 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011295 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -080011296 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011297 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -080011298 switch (mVerticalScrollbarPosition) {
11299 case SCROLLBAR_POSITION_DEFAULT:
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011300 if (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
11301 left += offset;
11302 } else {
11303 right += offset;
11304 }
11305 break;
Adam Powell20232d02010-12-08 21:08:53 -080011306 case SCROLLBAR_POSITION_RIGHT:
11307 right += offset;
11308 break;
11309 case SCROLLBAR_POSITION_LEFT:
11310 left += offset;
11311 break;
11312 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011313 }
Adam Powell20232d02010-12-08 21:08:53 -080011314 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011315 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
11316 ? 0 : getHorizontalScrollbarHeight();
11317 }
11318 }
Romain Guy8506ab42009-06-11 17:35:47 -070011319
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011320 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011321 changed = true;
11322 mPaddingLeft = left;
11323 }
11324 if (mPaddingTop != top) {
11325 changed = true;
11326 mPaddingTop = top;
11327 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011328 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011329 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011330 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011331 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011332 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011333 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011334 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011335 }
11336
11337 if (changed) {
11338 requestLayout();
11339 }
11340 }
11341
11342 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011343 * Sets the relative padding. The view may add on the space required to display
11344 * the scrollbars, depending on the style and visibility of the scrollbars.
11345 * So the values returned from {@link #getPaddingStart}, {@link #getPaddingTop},
11346 * {@link #getPaddingEnd} and {@link #getPaddingBottom} may be different
11347 * from the values set in this call.
11348 *
11349 * @attr ref android.R.styleable#View_padding
11350 * @attr ref android.R.styleable#View_paddingBottom
11351 * @attr ref android.R.styleable#View_paddingStart
11352 * @attr ref android.R.styleable#View_paddingEnd
11353 * @attr ref android.R.styleable#View_paddingTop
11354 * @param start the start padding in pixels
11355 * @param top the top padding in pixels
11356 * @param end the end padding in pixels
11357 * @param bottom the bottom padding in pixels
11358 *
11359 * @hide
11360 */
11361 public void setPaddingRelative(int start, int top, int end, int bottom) {
11362 mUserPaddingRelative = true;
Fabrice Di Megliof9e36502011-06-21 18:41:48 -070011363
11364 mUserPaddingStart = start;
11365 mUserPaddingEnd = end;
11366
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011367 switch(getResolvedLayoutDirection()) {
11368 case LAYOUT_DIRECTION_RTL:
11369 setPadding(end, top, start, bottom);
11370 break;
11371 case LAYOUT_DIRECTION_LTR:
11372 default:
11373 setPadding(start, top, end, bottom);
11374 }
11375 }
11376
11377 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011378 * Returns the top padding of this view.
11379 *
11380 * @return the top padding in pixels
11381 */
11382 public int getPaddingTop() {
11383 return mPaddingTop;
11384 }
11385
11386 /**
11387 * Returns the bottom padding of this view. If there are inset and enabled
11388 * scrollbars, this value may include the space required to display the
11389 * scrollbars as well.
11390 *
11391 * @return the bottom padding in pixels
11392 */
11393 public int getPaddingBottom() {
11394 return mPaddingBottom;
11395 }
11396
11397 /**
11398 * Returns the left padding of this view. If there are inset and enabled
11399 * scrollbars, this value may include the space required to display the
11400 * scrollbars as well.
11401 *
11402 * @return the left padding in pixels
11403 */
11404 public int getPaddingLeft() {
11405 return mPaddingLeft;
11406 }
11407
11408 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011409 * Returns the start padding of this view. If there are inset and enabled
11410 * scrollbars, this value may include the space required to display the
11411 * scrollbars as well.
11412 *
11413 * @return the start padding in pixels
11414 *
11415 * @hide
11416 */
11417 public int getPaddingStart() {
11418 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
11419 mPaddingRight : mPaddingLeft;
11420 }
11421
11422 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011423 * Returns the right padding of this view. If there are inset and enabled
11424 * scrollbars, this value may include the space required to display the
11425 * scrollbars as well.
11426 *
11427 * @return the right padding in pixels
11428 */
11429 public int getPaddingRight() {
11430 return mPaddingRight;
11431 }
11432
11433 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011434 * Returns the end padding of this view. If there are inset and enabled
11435 * scrollbars, this value may include the space required to display the
11436 * scrollbars as well.
11437 *
11438 * @return the end padding in pixels
11439 *
11440 * @hide
11441 */
11442 public int getPaddingEnd() {
11443 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
11444 mPaddingLeft : mPaddingRight;
11445 }
11446
11447 /**
11448 * Return if the padding as been set thru relative values
11449 * {@link #setPaddingRelative(int, int, int, int)} or thru
11450 * @attr ref android.R.styleable#View_paddingStart or
11451 * @attr ref android.R.styleable#View_paddingEnd
11452 *
11453 * @return true if the padding is relative or false if it is not.
11454 *
11455 * @hide
11456 */
11457 public boolean isPaddingRelative() {
11458 return mUserPaddingRelative;
11459 }
11460
11461 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011462 * Changes the selection state of this view. A view can be selected or not.
11463 * Note that selection is not the same as focus. Views are typically
11464 * selected in the context of an AdapterView like ListView or GridView;
11465 * the selected view is the view that is highlighted.
11466 *
11467 * @param selected true if the view must be selected, false otherwise
11468 */
11469 public void setSelected(boolean selected) {
11470 if (((mPrivateFlags & SELECTED) != 0) != selected) {
11471 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -070011472 if (!selected) resetPressedState();
Romain Guy0fd89bf2011-01-26 15:41:30 -080011473 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011474 refreshDrawableState();
11475 dispatchSetSelected(selected);
11476 }
11477 }
11478
11479 /**
11480 * Dispatch setSelected to all of this View's children.
11481 *
11482 * @see #setSelected(boolean)
11483 *
11484 * @param selected The new selected state
11485 */
11486 protected void dispatchSetSelected(boolean selected) {
11487 }
11488
11489 /**
11490 * Indicates the selection state of this view.
11491 *
11492 * @return true if the view is selected, false otherwise
11493 */
11494 @ViewDebug.ExportedProperty
11495 public boolean isSelected() {
11496 return (mPrivateFlags & SELECTED) != 0;
11497 }
11498
11499 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011500 * Changes the activated state of this view. A view can be activated or not.
11501 * Note that activation is not the same as selection. Selection is
11502 * a transient property, representing the view (hierarchy) the user is
11503 * currently interacting with. Activation is a longer-term state that the
11504 * user can move views in and out of. For example, in a list view with
11505 * single or multiple selection enabled, the views in the current selection
11506 * set are activated. (Um, yeah, we are deeply sorry about the terminology
11507 * here.) The activated state is propagated down to children of the view it
11508 * is set on.
11509 *
11510 * @param activated true if the view must be activated, false otherwise
11511 */
11512 public void setActivated(boolean activated) {
11513 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
11514 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
Romain Guy0fd89bf2011-01-26 15:41:30 -080011515 invalidate(true);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011516 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -070011517 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011518 }
11519 }
11520
11521 /**
11522 * Dispatch setActivated to all of this View's children.
11523 *
11524 * @see #setActivated(boolean)
11525 *
11526 * @param activated The new activated state
11527 */
11528 protected void dispatchSetActivated(boolean activated) {
11529 }
11530
11531 /**
11532 * Indicates the activation state of this view.
11533 *
11534 * @return true if the view is activated, false otherwise
11535 */
11536 @ViewDebug.ExportedProperty
11537 public boolean isActivated() {
11538 return (mPrivateFlags & ACTIVATED) != 0;
11539 }
11540
11541 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011542 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
11543 * observer can be used to get notifications when global events, like
11544 * layout, happen.
11545 *
11546 * The returned ViewTreeObserver observer is not guaranteed to remain
11547 * valid for the lifetime of this View. If the caller of this method keeps
11548 * a long-lived reference to ViewTreeObserver, it should always check for
11549 * the return value of {@link ViewTreeObserver#isAlive()}.
11550 *
11551 * @return The ViewTreeObserver for this view's hierarchy.
11552 */
11553 public ViewTreeObserver getViewTreeObserver() {
11554 if (mAttachInfo != null) {
11555 return mAttachInfo.mTreeObserver;
11556 }
11557 if (mFloatingTreeObserver == null) {
11558 mFloatingTreeObserver = new ViewTreeObserver();
11559 }
11560 return mFloatingTreeObserver;
11561 }
11562
11563 /**
11564 * <p>Finds the topmost view in the current view hierarchy.</p>
11565 *
11566 * @return the topmost view containing this view
11567 */
11568 public View getRootView() {
11569 if (mAttachInfo != null) {
11570 final View v = mAttachInfo.mRootView;
11571 if (v != null) {
11572 return v;
11573 }
11574 }
Romain Guy8506ab42009-06-11 17:35:47 -070011575
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011576 View parent = this;
11577
11578 while (parent.mParent != null && parent.mParent instanceof View) {
11579 parent = (View) parent.mParent;
11580 }
11581
11582 return parent;
11583 }
11584
11585 /**
11586 * <p>Computes the coordinates of this view on the screen. The argument
11587 * must be an array of two integers. After the method returns, the array
11588 * contains the x and y location in that order.</p>
11589 *
11590 * @param location an array of two integers in which to hold the coordinates
11591 */
11592 public void getLocationOnScreen(int[] location) {
11593 getLocationInWindow(location);
11594
11595 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -070011596 if (info != null) {
11597 location[0] += info.mWindowLeft;
11598 location[1] += info.mWindowTop;
11599 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011600 }
11601
11602 /**
11603 * <p>Computes the coordinates of this view in its window. The argument
11604 * must be an array of two integers. After the method returns, the array
11605 * contains the x and y location in that order.</p>
11606 *
11607 * @param location an array of two integers in which to hold the coordinates
11608 */
11609 public void getLocationInWindow(int[] location) {
11610 if (location == null || location.length < 2) {
11611 throw new IllegalArgumentException("location must be an array of "
11612 + "two integers");
11613 }
11614
Michael Jurka4d2bd4c2010-11-30 18:15:11 -080011615 location[0] = mLeft + (int) (mTranslationX + 0.5f);
11616 location[1] = mTop + (int) (mTranslationY + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011617
11618 ViewParent viewParent = mParent;
11619 while (viewParent instanceof View) {
11620 final View view = (View)viewParent;
Michael Jurka4d2bd4c2010-11-30 18:15:11 -080011621 location[0] += view.mLeft + (int) (view.mTranslationX + 0.5f) - view.mScrollX;
11622 location[1] += view.mTop + (int) (view.mTranslationY + 0.5f) - view.mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011623 viewParent = view.mParent;
11624 }
Romain Guy8506ab42009-06-11 17:35:47 -070011625
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070011626 if (viewParent instanceof ViewRootImpl) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011627 // *cough*
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070011628 final ViewRootImpl vr = (ViewRootImpl)viewParent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011629 location[1] -= vr.mCurScrollY;
11630 }
11631 }
11632
11633 /**
11634 * {@hide}
11635 * @param id the id of the view to be found
11636 * @return the view of the specified id, null if cannot be found
11637 */
11638 protected View findViewTraversal(int id) {
11639 if (id == mID) {
11640 return this;
11641 }
11642 return null;
11643 }
11644
11645 /**
11646 * {@hide}
11647 * @param tag the tag of the view to be found
11648 * @return the view of specified tag, null if cannot be found
11649 */
11650 protected View findViewWithTagTraversal(Object tag) {
11651 if (tag != null && tag.equals(mTag)) {
11652 return this;
11653 }
11654 return null;
11655 }
11656
11657 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080011658 * {@hide}
11659 * @param predicate The predicate to evaluate.
11660 * @return The first view that matches the predicate or null.
11661 */
11662 protected View findViewByPredicateTraversal(Predicate<View> predicate) {
11663 if (predicate.apply(this)) {
11664 return this;
11665 }
11666 return null;
11667 }
11668
11669 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011670 * Look for a child view with the given id. If this view has the given
11671 * id, return this view.
11672 *
11673 * @param id The id to search for.
11674 * @return The view that has the given id in the hierarchy or null
11675 */
11676 public final View findViewById(int id) {
11677 if (id < 0) {
11678 return null;
11679 }
11680 return findViewTraversal(id);
11681 }
11682
11683 /**
11684 * Look for a child view with the given tag. If this view has the given
11685 * tag, return this view.
11686 *
11687 * @param tag The tag to search for, using "tag.equals(getTag())".
11688 * @return The View that has the given tag in the hierarchy or null
11689 */
11690 public final View findViewWithTag(Object tag) {
11691 if (tag == null) {
11692 return null;
11693 }
11694 return findViewWithTagTraversal(tag);
11695 }
11696
11697 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080011698 * {@hide}
11699 * Look for a child view that matches the specified predicate.
11700 * If this view matches the predicate, return this view.
11701 *
11702 * @param predicate The predicate to evaluate.
11703 * @return The first view that matches the predicate or null.
11704 */
11705 public final View findViewByPredicate(Predicate<View> predicate) {
11706 return findViewByPredicateTraversal(predicate);
11707 }
11708
11709 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011710 * Sets the identifier for this view. The identifier does not have to be
11711 * unique in this view's hierarchy. The identifier should be a positive
11712 * number.
11713 *
11714 * @see #NO_ID
Romain Guy5c22a8c2011-05-13 11:48:45 -070011715 * @see #getId()
11716 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011717 *
11718 * @param id a number used to identify the view
11719 *
11720 * @attr ref android.R.styleable#View_id
11721 */
11722 public void setId(int id) {
11723 mID = id;
11724 }
11725
11726 /**
11727 * {@hide}
11728 *
11729 * @param isRoot true if the view belongs to the root namespace, false
11730 * otherwise
11731 */
11732 public void setIsRootNamespace(boolean isRoot) {
11733 if (isRoot) {
11734 mPrivateFlags |= IS_ROOT_NAMESPACE;
11735 } else {
11736 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
11737 }
11738 }
11739
11740 /**
11741 * {@hide}
11742 *
11743 * @return true if the view belongs to the root namespace, false otherwise
11744 */
11745 public boolean isRootNamespace() {
11746 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
11747 }
11748
11749 /**
11750 * Returns this view's identifier.
11751 *
11752 * @return a positive integer used to identify the view or {@link #NO_ID}
11753 * if the view has no ID
11754 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070011755 * @see #setId(int)
11756 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011757 * @attr ref android.R.styleable#View_id
11758 */
11759 @ViewDebug.CapturedViewProperty
11760 public int getId() {
11761 return mID;
11762 }
11763
11764 /**
11765 * Returns this view's tag.
11766 *
11767 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -070011768 *
11769 * @see #setTag(Object)
11770 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011771 */
11772 @ViewDebug.ExportedProperty
11773 public Object getTag() {
11774 return mTag;
11775 }
11776
11777 /**
11778 * Sets the tag associated with this view. A tag can be used to mark
11779 * a view in its hierarchy and does not have to be unique within the
11780 * hierarchy. Tags can also be used to store data within a view without
11781 * resorting to another data structure.
11782 *
11783 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -070011784 *
11785 * @see #getTag()
11786 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011787 */
11788 public void setTag(final Object tag) {
11789 mTag = tag;
11790 }
11791
11792 /**
Romain Guyd90a3312009-05-06 14:54:28 -070011793 * Returns the tag associated with this view and the specified key.
11794 *
11795 * @param key The key identifying the tag
11796 *
11797 * @return the Object stored in this view as a tag
11798 *
11799 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -070011800 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -070011801 */
11802 public Object getTag(int key) {
11803 SparseArray<Object> tags = null;
11804 synchronized (sTagsLock) {
11805 if (sTags != null) {
11806 tags = sTags.get(this);
11807 }
11808 }
11809
11810 if (tags != null) return tags.get(key);
11811 return null;
11812 }
11813
11814 /**
11815 * Sets a tag associated with this view and a key. A tag can be used
11816 * to mark a view in its hierarchy and does not have to be unique within
11817 * the hierarchy. Tags can also be used to store data within a view
11818 * without resorting to another data structure.
11819 *
11820 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -070011821 * application to ensure it is unique (see the <a
11822 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
11823 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -070011824 * the Android framework or not associated with any package will cause
11825 * an {@link IllegalArgumentException} to be thrown.
11826 *
11827 * @param key The key identifying the tag
11828 * @param tag An Object to tag the view with
11829 *
11830 * @throws IllegalArgumentException If they specified key is not valid
11831 *
11832 * @see #setTag(Object)
11833 * @see #getTag(int)
11834 */
11835 public void setTag(int key, final Object tag) {
11836 // If the package id is 0x00 or 0x01, it's either an undefined package
11837 // or a framework id
11838 if ((key >>> 24) < 2) {
11839 throw new IllegalArgumentException("The key must be an application-specific "
11840 + "resource id.");
11841 }
11842
11843 setTagInternal(this, key, tag);
11844 }
11845
11846 /**
11847 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
11848 * framework id.
11849 *
11850 * @hide
11851 */
11852 public void setTagInternal(int key, Object tag) {
11853 if ((key >>> 24) != 0x1) {
11854 throw new IllegalArgumentException("The key must be a framework-specific "
11855 + "resource id.");
11856 }
11857
Romain Guy8506ab42009-06-11 17:35:47 -070011858 setTagInternal(this, key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070011859 }
11860
11861 private static void setTagInternal(View view, int key, Object tag) {
11862 SparseArray<Object> tags = null;
11863 synchronized (sTagsLock) {
11864 if (sTags == null) {
11865 sTags = new WeakHashMap<View, SparseArray<Object>>();
11866 } else {
11867 tags = sTags.get(view);
11868 }
11869 }
11870
11871 if (tags == null) {
11872 tags = new SparseArray<Object>(2);
11873 synchronized (sTagsLock) {
11874 sTags.put(view, tags);
11875 }
11876 }
11877
11878 tags.put(key, tag);
11879 }
11880
11881 /**
Romain Guy13922e02009-05-12 17:56:14 -070011882 * @param consistency The type of consistency. See ViewDebug for more information.
11883 *
11884 * @hide
11885 */
11886 protected boolean dispatchConsistencyCheck(int consistency) {
11887 return onConsistencyCheck(consistency);
11888 }
11889
11890 /**
11891 * Method that subclasses should implement to check their consistency. The type of
11892 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -070011893 *
Romain Guy13922e02009-05-12 17:56:14 -070011894 * @param consistency The type of consistency. See ViewDebug for more information.
11895 *
11896 * @throws IllegalStateException if the view is in an inconsistent state.
11897 *
11898 * @hide
11899 */
11900 protected boolean onConsistencyCheck(int consistency) {
11901 boolean result = true;
11902
11903 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
11904 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
11905
11906 if (checkLayout) {
11907 if (getParent() == null) {
11908 result = false;
11909 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
11910 "View " + this + " does not have a parent.");
11911 }
11912
11913 if (mAttachInfo == null) {
11914 result = false;
11915 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
11916 "View " + this + " is not attached to a window.");
11917 }
11918 }
11919
11920 if (checkDrawing) {
11921 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
11922 // from their draw() method
11923
11924 if ((mPrivateFlags & DRAWN) != DRAWN &&
11925 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
11926 result = false;
11927 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
11928 "View " + this + " was invalidated but its drawing cache is valid.");
11929 }
11930 }
11931
11932 return result;
11933 }
11934
11935 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011936 * Prints information about this view in the log output, with the tag
11937 * {@link #VIEW_LOG_TAG}.
11938 *
11939 * @hide
11940 */
11941 public void debug() {
11942 debug(0);
11943 }
11944
11945 /**
11946 * Prints information about this view in the log output, with the tag
11947 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
11948 * indentation defined by the <code>depth</code>.
11949 *
11950 * @param depth the indentation level
11951 *
11952 * @hide
11953 */
11954 protected void debug(int depth) {
11955 String output = debugIndent(depth - 1);
11956
11957 output += "+ " + this;
11958 int id = getId();
11959 if (id != -1) {
11960 output += " (id=" + id + ")";
11961 }
11962 Object tag = getTag();
11963 if (tag != null) {
11964 output += " (tag=" + tag + ")";
11965 }
11966 Log.d(VIEW_LOG_TAG, output);
11967
11968 if ((mPrivateFlags & FOCUSED) != 0) {
11969 output = debugIndent(depth) + " FOCUSED";
11970 Log.d(VIEW_LOG_TAG, output);
11971 }
11972
11973 output = debugIndent(depth);
11974 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
11975 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
11976 + "} ";
11977 Log.d(VIEW_LOG_TAG, output);
11978
11979 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
11980 || mPaddingBottom != 0) {
11981 output = debugIndent(depth);
11982 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
11983 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
11984 Log.d(VIEW_LOG_TAG, output);
11985 }
11986
11987 output = debugIndent(depth);
11988 output += "mMeasureWidth=" + mMeasuredWidth +
11989 " mMeasureHeight=" + mMeasuredHeight;
11990 Log.d(VIEW_LOG_TAG, output);
11991
11992 output = debugIndent(depth);
11993 if (mLayoutParams == null) {
11994 output += "BAD! no layout params";
11995 } else {
11996 output = mLayoutParams.debug(output);
11997 }
11998 Log.d(VIEW_LOG_TAG, output);
11999
12000 output = debugIndent(depth);
12001 output += "flags={";
12002 output += View.printFlags(mViewFlags);
12003 output += "}";
12004 Log.d(VIEW_LOG_TAG, output);
12005
12006 output = debugIndent(depth);
12007 output += "privateFlags={";
12008 output += View.printPrivateFlags(mPrivateFlags);
12009 output += "}";
12010 Log.d(VIEW_LOG_TAG, output);
12011 }
12012
12013 /**
12014 * Creates an string of whitespaces used for indentation.
12015 *
12016 * @param depth the indentation level
12017 * @return a String containing (depth * 2 + 3) * 2 white spaces
12018 *
12019 * @hide
12020 */
12021 protected static String debugIndent(int depth) {
12022 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
12023 for (int i = 0; i < (depth * 2) + 3; i++) {
12024 spaces.append(' ').append(' ');
12025 }
12026 return spaces.toString();
12027 }
12028
12029 /**
12030 * <p>Return the offset of the widget's text baseline from the widget's top
12031 * boundary. If this widget does not support baseline alignment, this
12032 * method returns -1. </p>
12033 *
12034 * @return the offset of the baseline within the widget's bounds or -1
12035 * if baseline alignment is not supported
12036 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070012037 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012038 public int getBaseline() {
12039 return -1;
12040 }
12041
12042 /**
12043 * Call this when something has changed which has invalidated the
12044 * layout of this view. This will schedule a layout pass of the view
12045 * tree.
12046 */
12047 public void requestLayout() {
12048 if (ViewDebug.TRACE_HIERARCHY) {
12049 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
12050 }
12051
12052 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080012053 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012054
Fabrice Di Megliod794aca2011-07-22 18:19:36 -070012055 if (mParent != null) {
12056 if (mLayoutParams != null) {
12057 mLayoutParams.resolveWithDirection(getResolvedLayoutDirection());
12058 }
12059 if (!mParent.isLayoutRequested()) {
12060 mParent.requestLayout();
12061 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012062 }
12063 }
12064
12065 /**
12066 * Forces this view to be laid out during the next layout pass.
12067 * This method does not call requestLayout() or forceLayout()
12068 * on the parent.
12069 */
12070 public void forceLayout() {
12071 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080012072 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012073 }
12074
12075 /**
12076 * <p>
12077 * This is called to find out how big a view should be. The parent
12078 * supplies constraint information in the width and height parameters.
12079 * </p>
12080 *
12081 * <p>
12082 * The actual mesurement work of a view is performed in
12083 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
12084 * {@link #onMeasure(int, int)} can and must be overriden by subclasses.
12085 * </p>
12086 *
12087 *
12088 * @param widthMeasureSpec Horizontal space requirements as imposed by the
12089 * parent
12090 * @param heightMeasureSpec Vertical space requirements as imposed by the
12091 * parent
12092 *
12093 * @see #onMeasure(int, int)
12094 */
12095 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
12096 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
12097 widthMeasureSpec != mOldWidthMeasureSpec ||
12098 heightMeasureSpec != mOldHeightMeasureSpec) {
12099
12100 // first clears the measured dimension flag
12101 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
12102
12103 if (ViewDebug.TRACE_HIERARCHY) {
12104 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
12105 }
12106
12107 // measure ourselves, this should set the measured dimension flag back
12108 onMeasure(widthMeasureSpec, heightMeasureSpec);
12109
12110 // flag not set, setMeasuredDimension() was not invoked, we raise
12111 // an exception to warn the developer
12112 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
12113 throw new IllegalStateException("onMeasure() did not set the"
12114 + " measured dimension by calling"
12115 + " setMeasuredDimension()");
12116 }
12117
12118 mPrivateFlags |= LAYOUT_REQUIRED;
12119 }
12120
12121 mOldWidthMeasureSpec = widthMeasureSpec;
12122 mOldHeightMeasureSpec = heightMeasureSpec;
12123 }
12124
12125 /**
12126 * <p>
12127 * Measure the view and its content to determine the measured width and the
12128 * measured height. This method is invoked by {@link #measure(int, int)} and
12129 * should be overriden by subclasses to provide accurate and efficient
12130 * measurement of their contents.
12131 * </p>
12132 *
12133 * <p>
12134 * <strong>CONTRACT:</strong> When overriding this method, you
12135 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
12136 * measured width and height of this view. Failure to do so will trigger an
12137 * <code>IllegalStateException</code>, thrown by
12138 * {@link #measure(int, int)}. Calling the superclass'
12139 * {@link #onMeasure(int, int)} is a valid use.
12140 * </p>
12141 *
12142 * <p>
12143 * The base class implementation of measure defaults to the background size,
12144 * unless a larger size is allowed by the MeasureSpec. Subclasses should
12145 * override {@link #onMeasure(int, int)} to provide better measurements of
12146 * their content.
12147 * </p>
12148 *
12149 * <p>
12150 * If this method is overridden, it is the subclass's responsibility to make
12151 * sure the measured height and width are at least the view's minimum height
12152 * and width ({@link #getSuggestedMinimumHeight()} and
12153 * {@link #getSuggestedMinimumWidth()}).
12154 * </p>
12155 *
12156 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
12157 * The requirements are encoded with
12158 * {@link android.view.View.MeasureSpec}.
12159 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
12160 * The requirements are encoded with
12161 * {@link android.view.View.MeasureSpec}.
12162 *
12163 * @see #getMeasuredWidth()
12164 * @see #getMeasuredHeight()
12165 * @see #setMeasuredDimension(int, int)
12166 * @see #getSuggestedMinimumHeight()
12167 * @see #getSuggestedMinimumWidth()
12168 * @see android.view.View.MeasureSpec#getMode(int)
12169 * @see android.view.View.MeasureSpec#getSize(int)
12170 */
12171 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
12172 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
12173 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
12174 }
12175
12176 /**
12177 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
12178 * measured width and measured height. Failing to do so will trigger an
12179 * exception at measurement time.</p>
12180 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080012181 * @param measuredWidth The measured width of this view. May be a complex
12182 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
12183 * {@link #MEASURED_STATE_TOO_SMALL}.
12184 * @param measuredHeight The measured height of this view. May be a complex
12185 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
12186 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012187 */
12188 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
12189 mMeasuredWidth = measuredWidth;
12190 mMeasuredHeight = measuredHeight;
12191
12192 mPrivateFlags |= MEASURED_DIMENSION_SET;
12193 }
12194
12195 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080012196 * Merge two states as returned by {@link #getMeasuredState()}.
12197 * @param curState The current state as returned from a view or the result
12198 * of combining multiple views.
12199 * @param newState The new view state to combine.
12200 * @return Returns a new integer reflecting the combination of the two
12201 * states.
12202 */
12203 public static int combineMeasuredStates(int curState, int newState) {
12204 return curState | newState;
12205 }
12206
12207 /**
12208 * Version of {@link #resolveSizeAndState(int, int, int)}
12209 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
12210 */
12211 public static int resolveSize(int size, int measureSpec) {
12212 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
12213 }
12214
12215 /**
12216 * Utility to reconcile a desired size and state, with constraints imposed
12217 * by a MeasureSpec. Will take the desired size, unless a different size
12218 * is imposed by the constraints. The returned value is a compound integer,
12219 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
12220 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
12221 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012222 *
12223 * @param size How big the view wants to be
12224 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080012225 * @return Size information bit mask as defined by
12226 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012227 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080012228 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012229 int result = size;
12230 int specMode = MeasureSpec.getMode(measureSpec);
12231 int specSize = MeasureSpec.getSize(measureSpec);
12232 switch (specMode) {
12233 case MeasureSpec.UNSPECIFIED:
12234 result = size;
12235 break;
12236 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080012237 if (specSize < size) {
12238 result = specSize | MEASURED_STATE_TOO_SMALL;
12239 } else {
12240 result = size;
12241 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012242 break;
12243 case MeasureSpec.EXACTLY:
12244 result = specSize;
12245 break;
12246 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080012247 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012248 }
12249
12250 /**
12251 * Utility to return a default size. Uses the supplied size if the
Romain Guy98029c82011-06-17 15:47:07 -070012252 * MeasureSpec imposed no constraints. Will get larger if allowed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012253 * by the MeasureSpec.
12254 *
12255 * @param size Default size for this view
12256 * @param measureSpec Constraints imposed by the parent
12257 * @return The size this view should be.
12258 */
12259 public static int getDefaultSize(int size, int measureSpec) {
12260 int result = size;
12261 int specMode = MeasureSpec.getMode(measureSpec);
Romain Guy98029c82011-06-17 15:47:07 -070012262 int specSize = MeasureSpec.getSize(measureSpec);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012263
12264 switch (specMode) {
12265 case MeasureSpec.UNSPECIFIED:
12266 result = size;
12267 break;
12268 case MeasureSpec.AT_MOST:
12269 case MeasureSpec.EXACTLY:
12270 result = specSize;
12271 break;
12272 }
12273 return result;
12274 }
12275
12276 /**
12277 * Returns the suggested minimum height that the view should use. This
12278 * returns the maximum of the view's minimum height
12279 * and the background's minimum height
12280 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
12281 * <p>
12282 * When being used in {@link #onMeasure(int, int)}, the caller should still
12283 * ensure the returned height is within the requirements of the parent.
12284 *
12285 * @return The suggested minimum height of the view.
12286 */
12287 protected int getSuggestedMinimumHeight() {
12288 int suggestedMinHeight = mMinHeight;
12289
12290 if (mBGDrawable != null) {
12291 final int bgMinHeight = mBGDrawable.getMinimumHeight();
12292 if (suggestedMinHeight < bgMinHeight) {
12293 suggestedMinHeight = bgMinHeight;
12294 }
12295 }
12296
12297 return suggestedMinHeight;
12298 }
12299
12300 /**
12301 * Returns the suggested minimum width that the view should use. This
12302 * returns the maximum of the view's minimum width)
12303 * and the background's minimum width
12304 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
12305 * <p>
12306 * When being used in {@link #onMeasure(int, int)}, the caller should still
12307 * ensure the returned width is within the requirements of the parent.
12308 *
12309 * @return The suggested minimum width of the view.
12310 */
12311 protected int getSuggestedMinimumWidth() {
12312 int suggestedMinWidth = mMinWidth;
12313
12314 if (mBGDrawable != null) {
12315 final int bgMinWidth = mBGDrawable.getMinimumWidth();
12316 if (suggestedMinWidth < bgMinWidth) {
12317 suggestedMinWidth = bgMinWidth;
12318 }
12319 }
12320
12321 return suggestedMinWidth;
12322 }
12323
12324 /**
12325 * Sets the minimum height of the view. It is not guaranteed the view will
12326 * be able to achieve this minimum height (for example, if its parent layout
12327 * constrains it with less available height).
12328 *
12329 * @param minHeight The minimum height the view will try to be.
12330 */
12331 public void setMinimumHeight(int minHeight) {
12332 mMinHeight = minHeight;
12333 }
12334
12335 /**
12336 * Sets the minimum width of the view. It is not guaranteed the view will
12337 * be able to achieve this minimum width (for example, if its parent layout
12338 * constrains it with less available width).
12339 *
12340 * @param minWidth The minimum width the view will try to be.
12341 */
12342 public void setMinimumWidth(int minWidth) {
12343 mMinWidth = minWidth;
12344 }
12345
12346 /**
12347 * Get the animation currently associated with this view.
12348 *
12349 * @return The animation that is currently playing or
12350 * scheduled to play for this view.
12351 */
12352 public Animation getAnimation() {
12353 return mCurrentAnimation;
12354 }
12355
12356 /**
12357 * Start the specified animation now.
12358 *
12359 * @param animation the animation to start now
12360 */
12361 public void startAnimation(Animation animation) {
12362 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
12363 setAnimation(animation);
Romain Guy0fd89bf2011-01-26 15:41:30 -080012364 invalidateParentCaches();
12365 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012366 }
12367
12368 /**
12369 * Cancels any animations for this view.
12370 */
12371 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080012372 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080012373 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080012374 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012375 mCurrentAnimation = null;
Romain Guy0fd89bf2011-01-26 15:41:30 -080012376 invalidateParentIfNeeded();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012377 }
12378
12379 /**
12380 * Sets the next animation to play for this view.
12381 * If you want the animation to play immediately, use
12382 * startAnimation. This method provides allows fine-grained
12383 * control over the start time and invalidation, but you
12384 * must make sure that 1) the animation has a start time set, and
12385 * 2) the view will be invalidated when the animation is supposed to
12386 * start.
12387 *
12388 * @param animation The next animation, or null.
12389 */
12390 public void setAnimation(Animation animation) {
12391 mCurrentAnimation = animation;
12392 if (animation != null) {
12393 animation.reset();
12394 }
12395 }
12396
12397 /**
12398 * Invoked by a parent ViewGroup to notify the start of the animation
12399 * currently associated with this view. If you override this method,
12400 * always call super.onAnimationStart();
12401 *
12402 * @see #setAnimation(android.view.animation.Animation)
12403 * @see #getAnimation()
12404 */
12405 protected void onAnimationStart() {
12406 mPrivateFlags |= ANIMATION_STARTED;
12407 }
12408
12409 /**
12410 * Invoked by a parent ViewGroup to notify the end of the animation
12411 * currently associated with this view. If you override this method,
12412 * always call super.onAnimationEnd();
12413 *
12414 * @see #setAnimation(android.view.animation.Animation)
12415 * @see #getAnimation()
12416 */
12417 protected void onAnimationEnd() {
12418 mPrivateFlags &= ~ANIMATION_STARTED;
12419 }
12420
12421 /**
12422 * Invoked if there is a Transform that involves alpha. Subclass that can
12423 * draw themselves with the specified alpha should return true, and then
12424 * respect that alpha when their onDraw() is called. If this returns false
12425 * then the view may be redirected to draw into an offscreen buffer to
12426 * fulfill the request, which will look fine, but may be slower than if the
12427 * subclass handles it internally. The default implementation returns false.
12428 *
12429 * @param alpha The alpha (0..255) to apply to the view's drawing
12430 * @return true if the view can draw with the specified alpha.
12431 */
12432 protected boolean onSetAlpha(int alpha) {
12433 return false;
12434 }
12435
12436 /**
12437 * This is used by the RootView to perform an optimization when
12438 * the view hierarchy contains one or several SurfaceView.
12439 * SurfaceView is always considered transparent, but its children are not,
12440 * therefore all View objects remove themselves from the global transparent
12441 * region (passed as a parameter to this function).
12442 *
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070012443 * @param region The transparent region for this ViewAncestor (window).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012444 *
12445 * @return Returns true if the effective visibility of the view at this
12446 * point is opaque, regardless of the transparent region; returns false
12447 * if it is possible for underlying windows to be seen behind the view.
12448 *
12449 * {@hide}
12450 */
12451 public boolean gatherTransparentRegion(Region region) {
12452 final AttachInfo attachInfo = mAttachInfo;
12453 if (region != null && attachInfo != null) {
12454 final int pflags = mPrivateFlags;
12455 if ((pflags & SKIP_DRAW) == 0) {
12456 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
12457 // remove it from the transparent region.
12458 final int[] location = attachInfo.mTransparentLocation;
12459 getLocationInWindow(location);
12460 region.op(location[0], location[1], location[0] + mRight - mLeft,
12461 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
12462 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) {
12463 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
12464 // exists, so we remove the background drawable's non-transparent
12465 // parts from this transparent region.
12466 applyDrawableToTransparentRegion(mBGDrawable, region);
12467 }
12468 }
12469 return true;
12470 }
12471
12472 /**
12473 * Play a sound effect for this view.
12474 *
12475 * <p>The framework will play sound effects for some built in actions, such as
12476 * clicking, but you may wish to play these effects in your widget,
12477 * for instance, for internal navigation.
12478 *
12479 * <p>The sound effect will only be played if sound effects are enabled by the user, and
12480 * {@link #isSoundEffectsEnabled()} is true.
12481 *
12482 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
12483 */
12484 public void playSoundEffect(int soundConstant) {
12485 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
12486 return;
12487 }
12488 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
12489 }
12490
12491 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070012492 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070012493 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070012494 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012495 *
12496 * <p>The framework will provide haptic feedback for some built in actions,
12497 * such as long presses, but you may wish to provide feedback for your
12498 * own widget.
12499 *
12500 * <p>The feedback will only be performed if
12501 * {@link #isHapticFeedbackEnabled()} is true.
12502 *
12503 * @param feedbackConstant One of the constants defined in
12504 * {@link HapticFeedbackConstants}
12505 */
12506 public boolean performHapticFeedback(int feedbackConstant) {
12507 return performHapticFeedback(feedbackConstant, 0);
12508 }
12509
12510 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070012511 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070012512 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070012513 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012514 *
12515 * @param feedbackConstant One of the constants defined in
12516 * {@link HapticFeedbackConstants}
12517 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
12518 */
12519 public boolean performHapticFeedback(int feedbackConstant, int flags) {
12520 if (mAttachInfo == null) {
12521 return false;
12522 }
Romain Guyf607bdc2010-09-10 19:20:06 -070012523 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070012524 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012525 && !isHapticFeedbackEnabled()) {
12526 return false;
12527 }
Romain Guy812ccbe2010-06-01 14:07:24 -070012528 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
12529 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012530 }
12531
12532 /**
Joe Onorato664644d2011-01-23 17:53:23 -080012533 * Request that the visibility of the status bar be changed.
Scott Mainec6331b2011-05-24 16:55:56 -070012534 * @param visibility Either {@link #STATUS_BAR_VISIBLE} or {@link #STATUS_BAR_HIDDEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080012535 */
12536 public void setSystemUiVisibility(int visibility) {
12537 if (visibility != mSystemUiVisibility) {
12538 mSystemUiVisibility = visibility;
12539 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
12540 mParent.recomputeViewAttributes(this);
12541 }
12542 }
12543 }
12544
12545 /**
12546 * Returns the status bar visibility that this view has requested.
Scott Mainec6331b2011-05-24 16:55:56 -070012547 * @return Either {@link #STATUS_BAR_VISIBLE} or {@link #STATUS_BAR_HIDDEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080012548 */
Joe Onoratoe595cad2011-01-24 09:22:12 -080012549 public int getSystemUiVisibility() {
Joe Onorato664644d2011-01-23 17:53:23 -080012550 return mSystemUiVisibility;
12551 }
12552
Scott Mainec6331b2011-05-24 16:55:56 -070012553 /**
12554 * Set a listener to receive callbacks when the visibility of the system bar changes.
12555 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks.
12556 */
Joe Onorato664644d2011-01-23 17:53:23 -080012557 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) {
12558 mOnSystemUiVisibilityChangeListener = l;
12559 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
12560 mParent.recomputeViewAttributes(this);
12561 }
12562 }
12563
12564 /**
12565 */
12566 public void dispatchSystemUiVisibilityChanged(int visibility) {
12567 if (mOnSystemUiVisibilityChangeListener != null) {
Joe Onorato7bb8eeb2011-01-27 16:00:58 -080012568 mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange(
Joe Onorato6ab77bd2011-01-31 11:21:10 -080012569 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK);
Joe Onorato664644d2011-01-23 17:53:23 -080012570 }
12571 }
12572
12573 /**
Joe Malin32736f02011-01-19 16:14:20 -080012574 * Creates an image that the system displays during the drag and drop
12575 * operation. This is called a &quot;drag shadow&quot;. The default implementation
12576 * for a DragShadowBuilder based on a View returns an image that has exactly the same
12577 * appearance as the given View. The default also positions the center of the drag shadow
12578 * directly under the touch point. If no View is provided (the constructor with no parameters
12579 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and
12580 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the
12581 * default is an invisible drag shadow.
12582 * <p>
12583 * You are not required to use the View you provide to the constructor as the basis of the
12584 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw
12585 * anything you want as the drag shadow.
12586 * </p>
12587 * <p>
12588 * You pass a DragShadowBuilder object to the system when you start the drag. The system
12589 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the
12590 * size and position of the drag shadow. It uses this data to construct a
12591 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()}
12592 * so that your application can draw the shadow image in the Canvas.
12593 * </p>
Christopher Tate2c095f32010-10-04 14:13:40 -070012594 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012595 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070012596 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070012597
12598 /**
Joe Malin32736f02011-01-19 16:14:20 -080012599 * Constructs a shadow image builder based on a View. By default, the resulting drag
12600 * shadow will have the same appearance and dimensions as the View, with the touch point
12601 * over the center of the View.
12602 * @param view A View. Any View in scope can be used.
Christopher Tate2c095f32010-10-04 14:13:40 -070012603 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012604 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070012605 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070012606 }
12607
Christopher Tate17ed60c2011-01-18 12:50:26 -080012608 /**
12609 * Construct a shadow builder object with no associated View. This
12610 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)}
12611 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order
12612 * to supply the drag shadow's dimensions and appearance without
Joe Malin32736f02011-01-19 16:14:20 -080012613 * reference to any View object. If they are not overridden, then the result is an
12614 * invisible drag shadow.
Christopher Tate17ed60c2011-01-18 12:50:26 -080012615 */
12616 public DragShadowBuilder() {
12617 mView = new WeakReference<View>(null);
12618 }
12619
12620 /**
12621 * Returns the View object that had been passed to the
12622 * {@link #View.DragShadowBuilder(View)}
12623 * constructor. If that View parameter was {@code null} or if the
12624 * {@link #View.DragShadowBuilder()}
12625 * constructor was used to instantiate the builder object, this method will return
12626 * null.
12627 *
12628 * @return The View object associate with this builder object.
12629 */
Romain Guy5c22a8c2011-05-13 11:48:45 -070012630 @SuppressWarnings({"JavadocReference"})
Chris Tate6b391282010-10-14 15:48:59 -070012631 final public View getView() {
12632 return mView.get();
12633 }
12634
Christopher Tate2c095f32010-10-04 14:13:40 -070012635 /**
Joe Malin32736f02011-01-19 16:14:20 -080012636 * Provides the metrics for the shadow image. These include the dimensions of
12637 * the shadow image, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070012638 * be centered under the touch location while dragging.
12639 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012640 * The default implementation sets the dimensions of the shadow to be the
Joe Malin32736f02011-01-19 16:14:20 -080012641 * same as the dimensions of the View itself and centers the shadow under
12642 * the touch point.
12643 * </p>
Christopher Tate2c095f32010-10-04 14:13:40 -070012644 *
Joe Malin32736f02011-01-19 16:14:20 -080012645 * @param shadowSize A {@link android.graphics.Point} containing the width and height
12646 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the
12647 * desired width and must set {@link android.graphics.Point#y} to the desired height of the
12648 * image.
12649 *
12650 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the
12651 * shadow image that should be underneath the touch point during the drag and drop
12652 * operation. Your application must set {@link android.graphics.Point#x} to the
12653 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position.
Christopher Tate2c095f32010-10-04 14:13:40 -070012654 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012655 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070012656 final View view = mView.get();
12657 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012658 shadowSize.set(view.getWidth(), view.getHeight());
12659 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070012660 } else {
12661 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
12662 }
Christopher Tate2c095f32010-10-04 14:13:40 -070012663 }
12664
12665 /**
Joe Malin32736f02011-01-19 16:14:20 -080012666 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object
12667 * based on the dimensions it received from the
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012668 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate2c095f32010-10-04 14:13:40 -070012669 *
Joe Malin32736f02011-01-19 16:14:20 -080012670 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image.
Christopher Tate2c095f32010-10-04 14:13:40 -070012671 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012672 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070012673 final View view = mView.get();
12674 if (view != null) {
12675 view.draw(canvas);
12676 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012677 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070012678 }
Christopher Tate2c095f32010-10-04 14:13:40 -070012679 }
12680 }
12681
12682 /**
Joe Malin32736f02011-01-19 16:14:20 -080012683 * Starts a drag and drop operation. When your application calls this method, it passes a
12684 * {@link android.view.View.DragShadowBuilder} object to the system. The
12685 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)}
12686 * to get metrics for the drag shadow, and then calls the object's
12687 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself.
12688 * <p>
12689 * Once the system has the drag shadow, it begins the drag and drop operation by sending
12690 * drag events to all the View objects in your application that are currently visible. It does
12691 * this either by calling the View object's drag listener (an implementation of
12692 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the
12693 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method.
12694 * Both are passed a {@link android.view.DragEvent} object that has a
12695 * {@link android.view.DragEvent#getAction()} value of
12696 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}.
12697 * </p>
12698 * <p>
12699 * Your application can invoke startDrag() on any attached View object. The View object does not
12700 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to
12701 * be related to the View the user selected for dragging.
12702 * </p>
12703 * @param data A {@link android.content.ClipData} object pointing to the data to be
12704 * transferred by the drag and drop operation.
12705 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the
12706 * drag shadow.
12707 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and
12708 * drop operation. This Object is put into every DragEvent object sent by the system during the
12709 * current drag.
12710 * <p>
12711 * myLocalState is a lightweight mechanism for the sending information from the dragged View
12712 * to the target Views. For example, it can contain flags that differentiate between a
12713 * a copy operation and a move operation.
12714 * </p>
12715 * @param flags Flags that control the drag and drop operation. No flags are currently defined,
12716 * so the parameter should be set to 0.
12717 * @return {@code true} if the method completes successfully, or
12718 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to
12719 * do a drag, and so no drag operation is in progress.
Christopher Tatea53146c2010-09-07 11:57:52 -070012720 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012721 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080012722 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070012723 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080012724 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070012725 }
12726 boolean okay = false;
12727
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012728 Point shadowSize = new Point();
12729 Point shadowTouchPoint = new Point();
12730 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070012731
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012732 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
12733 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
12734 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070012735 }
Christopher Tatea53146c2010-09-07 11:57:52 -070012736
Chris Tatea32dcf72010-10-14 12:13:50 -070012737 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012738 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
12739 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070012740 }
Christopher Tatea53146c2010-09-07 11:57:52 -070012741 Surface surface = new Surface();
12742 try {
12743 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080012744 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070012745 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070012746 + " surface=" + surface);
12747 if (token != null) {
12748 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070012749 try {
Chris Tate6b391282010-10-14 15:48:59 -070012750 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012751 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070012752 } finally {
12753 surface.unlockCanvasAndPost(canvas);
12754 }
Christopher Tatea53146c2010-09-07 11:57:52 -070012755
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070012756 final ViewRootImpl root = getViewRootImpl();
Christopher Tate407b4e92010-11-30 17:14:08 -080012757
12758 // Cache the local state object for delivery with DragEvents
12759 root.setLocalDragState(myLocalState);
12760
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012761 // repurpose 'shadowSize' for the last touch point
12762 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070012763
Christopher Tatea53146c2010-09-07 11:57:52 -070012764 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012765 shadowSize.x, shadowSize.y,
12766 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070012767 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tatea53146c2010-09-07 11:57:52 -070012768 }
12769 } catch (Exception e) {
12770 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
12771 surface.destroy();
12772 }
12773
12774 return okay;
12775 }
12776
Christopher Tatea53146c2010-09-07 11:57:52 -070012777 /**
Joe Malin32736f02011-01-19 16:14:20 -080012778 * Handles drag events sent by the system following a call to
12779 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}.
12780 *<p>
12781 * When the system calls this method, it passes a
12782 * {@link android.view.DragEvent} object. A call to
12783 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined
12784 * in DragEvent. The method uses these to determine what is happening in the drag and drop
12785 * operation.
12786 * @param event The {@link android.view.DragEvent} sent by the system.
12787 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined
12788 * in DragEvent, indicating the type of drag event represented by this object.
12789 * @return {@code true} if the method was successful, otherwise {@code false}.
12790 * <p>
12791 * The method should return {@code true} in response to an action type of
12792 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current
12793 * operation.
12794 * </p>
12795 * <p>
12796 * The method should also return {@code true} in response to an action type of
12797 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or
12798 * {@code false} if it didn't.
12799 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070012800 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070012801 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070012802 return false;
12803 }
12804
12805 /**
Joe Malin32736f02011-01-19 16:14:20 -080012806 * Detects if this View is enabled and has a drag event listener.
12807 * If both are true, then it calls the drag event listener with the
12808 * {@link android.view.DragEvent} it received. If the drag event listener returns
12809 * {@code true}, then dispatchDragEvent() returns {@code true}.
12810 * <p>
12811 * For all other cases, the method calls the
12812 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler
12813 * method and returns its result.
12814 * </p>
12815 * <p>
12816 * This ensures that a drag event is always consumed, even if the View does not have a drag
12817 * event listener. However, if the View has a listener and the listener returns true, then
12818 * onDragEvent() is not called.
12819 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070012820 */
12821 public boolean dispatchDragEvent(DragEvent event) {
Romain Guy676b1732011-02-14 14:45:33 -080012822 //noinspection SimplifiableIfStatement
Chris Tate32affef2010-10-18 15:29:21 -070012823 if (mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
12824 && mOnDragListener.onDrag(this, event)) {
12825 return true;
12826 }
Christopher Tatea53146c2010-09-07 11:57:52 -070012827 return onDragEvent(event);
12828 }
12829
Christopher Tate3d4bf172011-03-28 16:16:46 -070012830 boolean canAcceptDrag() {
12831 return (mPrivateFlags2 & DRAG_CAN_ACCEPT) != 0;
12832 }
12833
Christopher Tatea53146c2010-09-07 11:57:52 -070012834 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070012835 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
12836 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070012837 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070012838 */
12839 public void onCloseSystemDialogs(String reason) {
12840 }
Joe Malin32736f02011-01-19 16:14:20 -080012841
Dianne Hackbornffa42482009-09-23 22:20:11 -070012842 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012843 * Given a Drawable whose bounds have been set to draw into this view,
Romain Guy5c22a8c2011-05-13 11:48:45 -070012844 * update a Region being computed for
12845 * {@link #gatherTransparentRegion(android.graphics.Region)} so
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012846 * that any non-transparent parts of the Drawable are removed from the
12847 * given transparent region.
12848 *
12849 * @param dr The Drawable whose transparency is to be applied to the region.
12850 * @param region A Region holding the current transparency information,
12851 * where any parts of the region that are set are considered to be
12852 * transparent. On return, this region will be modified to have the
12853 * transparency information reduced by the corresponding parts of the
12854 * Drawable that are not transparent.
12855 * {@hide}
12856 */
12857 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
12858 if (DBG) {
12859 Log.i("View", "Getting transparent region for: " + this);
12860 }
12861 final Region r = dr.getTransparentRegion();
12862 final Rect db = dr.getBounds();
12863 final AttachInfo attachInfo = mAttachInfo;
12864 if (r != null && attachInfo != null) {
12865 final int w = getRight()-getLeft();
12866 final int h = getBottom()-getTop();
12867 if (db.left > 0) {
12868 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
12869 r.op(0, 0, db.left, h, Region.Op.UNION);
12870 }
12871 if (db.right < w) {
12872 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
12873 r.op(db.right, 0, w, h, Region.Op.UNION);
12874 }
12875 if (db.top > 0) {
12876 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
12877 r.op(0, 0, w, db.top, Region.Op.UNION);
12878 }
12879 if (db.bottom < h) {
12880 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
12881 r.op(0, db.bottom, w, h, Region.Op.UNION);
12882 }
12883 final int[] location = attachInfo.mTransparentLocation;
12884 getLocationInWindow(location);
12885 r.translate(location[0], location[1]);
12886 region.op(r, Region.Op.INTERSECT);
12887 } else {
12888 region.op(db, Region.Op.DIFFERENCE);
12889 }
12890 }
12891
Patrick Dubroye0a799a2011-05-04 16:19:22 -070012892 private void checkForLongClick(int delayOffset) {
12893 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
12894 mHasPerformedLongPress = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012895
Patrick Dubroye0a799a2011-05-04 16:19:22 -070012896 if (mPendingCheckForLongPress == null) {
12897 mPendingCheckForLongPress = new CheckForLongPress();
12898 }
12899 mPendingCheckForLongPress.rememberWindowAttachCount();
12900 postDelayed(mPendingCheckForLongPress,
12901 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012902 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012903 }
12904
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012905 /**
12906 * Inflate a view from an XML resource. This convenience method wraps the {@link
12907 * LayoutInflater} class, which provides a full range of options for view inflation.
12908 *
12909 * @param context The Context object for your activity or application.
12910 * @param resource The resource ID to inflate
12911 * @param root A view group that will be the parent. Used to properly inflate the
12912 * layout_* parameters.
12913 * @see LayoutInflater
12914 */
12915 public static View inflate(Context context, int resource, ViewGroup root) {
12916 LayoutInflater factory = LayoutInflater.from(context);
12917 return factory.inflate(resource, root);
12918 }
Romain Guy33e72ae2010-07-17 12:40:29 -070012919
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012920 /**
Adam Powell637d3372010-08-25 14:37:03 -070012921 * Scroll the view with standard behavior for scrolling beyond the normal
12922 * content boundaries. Views that call this method should override
12923 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
12924 * results of an over-scroll operation.
12925 *
12926 * Views can use this method to handle any touch or fling-based scrolling.
12927 *
12928 * @param deltaX Change in X in pixels
12929 * @param deltaY Change in Y in pixels
12930 * @param scrollX Current X scroll value in pixels before applying deltaX
12931 * @param scrollY Current Y scroll value in pixels before applying deltaY
12932 * @param scrollRangeX Maximum content scroll range along the X axis
12933 * @param scrollRangeY Maximum content scroll range along the Y axis
12934 * @param maxOverScrollX Number of pixels to overscroll by in either direction
12935 * along the X axis.
12936 * @param maxOverScrollY Number of pixels to overscroll by in either direction
12937 * along the Y axis.
12938 * @param isTouchEvent true if this scroll operation is the result of a touch event.
12939 * @return true if scrolling was clamped to an over-scroll boundary along either
12940 * axis, false otherwise.
12941 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070012942 @SuppressWarnings({"UnusedParameters"})
Adam Powell637d3372010-08-25 14:37:03 -070012943 protected boolean overScrollBy(int deltaX, int deltaY,
12944 int scrollX, int scrollY,
12945 int scrollRangeX, int scrollRangeY,
12946 int maxOverScrollX, int maxOverScrollY,
12947 boolean isTouchEvent) {
12948 final int overScrollMode = mOverScrollMode;
12949 final boolean canScrollHorizontal =
12950 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
12951 final boolean canScrollVertical =
12952 computeVerticalScrollRange() > computeVerticalScrollExtent();
12953 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
12954 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
12955 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
12956 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
12957
12958 int newScrollX = scrollX + deltaX;
12959 if (!overScrollHorizontal) {
12960 maxOverScrollX = 0;
12961 }
12962
12963 int newScrollY = scrollY + deltaY;
12964 if (!overScrollVertical) {
12965 maxOverScrollY = 0;
12966 }
12967
12968 // Clamp values if at the limits and record
12969 final int left = -maxOverScrollX;
12970 final int right = maxOverScrollX + scrollRangeX;
12971 final int top = -maxOverScrollY;
12972 final int bottom = maxOverScrollY + scrollRangeY;
12973
12974 boolean clampedX = false;
12975 if (newScrollX > right) {
12976 newScrollX = right;
12977 clampedX = true;
12978 } else if (newScrollX < left) {
12979 newScrollX = left;
12980 clampedX = true;
12981 }
12982
12983 boolean clampedY = false;
12984 if (newScrollY > bottom) {
12985 newScrollY = bottom;
12986 clampedY = true;
12987 } else if (newScrollY < top) {
12988 newScrollY = top;
12989 clampedY = true;
12990 }
12991
12992 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
12993
12994 return clampedX || clampedY;
12995 }
12996
12997 /**
12998 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
12999 * respond to the results of an over-scroll operation.
13000 *
13001 * @param scrollX New X scroll value in pixels
13002 * @param scrollY New Y scroll value in pixels
13003 * @param clampedX True if scrollX was clamped to an over-scroll boundary
13004 * @param clampedY True if scrollY was clamped to an over-scroll boundary
13005 */
13006 protected void onOverScrolled(int scrollX, int scrollY,
13007 boolean clampedX, boolean clampedY) {
13008 // Intentionally empty.
13009 }
13010
13011 /**
13012 * Returns the over-scroll mode for this view. The result will be
13013 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
13014 * (allow over-scrolling only if the view content is larger than the container),
13015 * or {@link #OVER_SCROLL_NEVER}.
13016 *
13017 * @return This view's over-scroll mode.
13018 */
13019 public int getOverScrollMode() {
13020 return mOverScrollMode;
13021 }
13022
13023 /**
13024 * Set the over-scroll mode for this view. Valid over-scroll modes are
13025 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
13026 * (allow over-scrolling only if the view content is larger than the container),
13027 * or {@link #OVER_SCROLL_NEVER}.
13028 *
13029 * Setting the over-scroll mode of a view will have an effect only if the
13030 * view is capable of scrolling.
13031 *
13032 * @param overScrollMode The new over-scroll mode for this view.
13033 */
13034 public void setOverScrollMode(int overScrollMode) {
13035 if (overScrollMode != OVER_SCROLL_ALWAYS &&
13036 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
13037 overScrollMode != OVER_SCROLL_NEVER) {
13038 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
13039 }
13040 mOverScrollMode = overScrollMode;
13041 }
13042
13043 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080013044 * Gets a scale factor that determines the distance the view should scroll
13045 * vertically in response to {@link MotionEvent#ACTION_SCROLL}.
13046 * @return The vertical scroll scale factor.
13047 * @hide
13048 */
13049 protected float getVerticalScrollFactor() {
13050 if (mVerticalScrollFactor == 0) {
13051 TypedValue outValue = new TypedValue();
13052 if (!mContext.getTheme().resolveAttribute(
13053 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) {
13054 throw new IllegalStateException(
13055 "Expected theme to define listPreferredItemHeight.");
13056 }
13057 mVerticalScrollFactor = outValue.getDimension(
13058 mContext.getResources().getDisplayMetrics());
13059 }
13060 return mVerticalScrollFactor;
13061 }
13062
13063 /**
13064 * Gets a scale factor that determines the distance the view should scroll
13065 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}.
13066 * @return The horizontal scroll scale factor.
13067 * @hide
13068 */
13069 protected float getHorizontalScrollFactor() {
13070 // TODO: Should use something else.
13071 return getVerticalScrollFactor();
13072 }
13073
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013074 /**
13075 * Return the value specifying the text direction or policy that was set with
13076 * {@link #setTextDirection(int)}.
13077 *
13078 * @return the defined text direction. It can be one of:
13079 *
13080 * {@link #TEXT_DIRECTION_INHERIT},
13081 * {@link #TEXT_DIRECTION_FIRST_STRONG}
13082 * {@link #TEXT_DIRECTION_ANY_RTL},
Fabrice Di Meglio8f502652011-06-29 20:40:43 -070013083 * {@link #TEXT_DIRECTION_CHAR_COUNT},
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013084 * {@link #TEXT_DIRECTION_LTR},
13085 * {@link #TEXT_DIRECTION_RTL},
13086 *
13087 * @hide
13088 */
13089 public int getTextDirection() {
13090 return mTextDirection;
13091 }
13092
13093 /**
13094 * Set the text direction.
13095 *
13096 * @param textDirection the direction to set. Should be one of:
13097 *
13098 * {@link #TEXT_DIRECTION_INHERIT},
13099 * {@link #TEXT_DIRECTION_FIRST_STRONG}
13100 * {@link #TEXT_DIRECTION_ANY_RTL},
Fabrice Di Meglio8f502652011-06-29 20:40:43 -070013101 * {@link #TEXT_DIRECTION_CHAR_COUNT},
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013102 * {@link #TEXT_DIRECTION_LTR},
13103 * {@link #TEXT_DIRECTION_RTL},
13104 *
13105 * @hide
13106 */
13107 public void setTextDirection(int textDirection) {
13108 if (textDirection != mTextDirection) {
13109 mTextDirection = textDirection;
13110 resetResolvedTextDirection();
13111 requestLayout();
13112 }
13113 }
13114
13115 /**
13116 * Return the resolved text direction.
13117 *
13118 * @return the resolved text direction. Return one of:
13119 *
Doug Feltcb3791202011-07-07 11:57:48 -070013120 * {@link #TEXT_DIRECTION_FIRST_STRONG}
13121 * {@link #TEXT_DIRECTION_ANY_RTL},
13122 * {@link #TEXT_DIRECTION_CHAR_COUNT},
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013123 * {@link #TEXT_DIRECTION_LTR},
13124 * {@link #TEXT_DIRECTION_RTL},
13125 *
13126 * @hide
13127 */
13128 public int getResolvedTextDirection() {
Doug Feltcb3791202011-07-07 11:57:48 -070013129 if (mResolvedTextDirection == TEXT_DIRECTION_INHERIT) {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013130 resolveTextDirection();
13131 }
13132 return mResolvedTextDirection;
13133 }
13134
13135 /**
Doug Feltcb3791202011-07-07 11:57:48 -070013136 * Resolve the text direction.
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013137 */
13138 protected void resolveTextDirection() {
Doug Feltcb3791202011-07-07 11:57:48 -070013139 if (mTextDirection != TEXT_DIRECTION_INHERIT) {
13140 mResolvedTextDirection = mTextDirection;
13141 return;
13142 }
13143 if (mParent != null && mParent instanceof ViewGroup) {
13144 mResolvedTextDirection = ((ViewGroup) mParent).getResolvedTextDirection();
13145 return;
13146 }
13147 mResolvedTextDirection = TEXT_DIRECTION_FIRST_STRONG;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013148 }
13149
13150 /**
Doug Feltcb3791202011-07-07 11:57:48 -070013151 * Reset resolved text direction. Will be resolved during a call to getResolvedTextDirection().
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013152 */
13153 protected void resetResolvedTextDirection() {
Doug Feltcb3791202011-07-07 11:57:48 -070013154 mResolvedTextDirection = TEXT_DIRECTION_INHERIT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013155 }
13156
Chet Haaseb39f0512011-05-24 14:36:40 -070013157 //
13158 // Properties
13159 //
13160 /**
13161 * A Property wrapper around the <code>alpha</code> functionality handled by the
13162 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods.
13163 */
Romain Guy02ccac62011-06-24 13:20:23 -070013164 public static Property<View, Float> ALPHA = new FloatProperty<View>("alpha") {
Chet Haaseb39f0512011-05-24 14:36:40 -070013165 @Override
13166 public void setValue(View object, float value) {
13167 object.setAlpha(value);
13168 }
13169
13170 @Override
13171 public Float get(View object) {
13172 return object.getAlpha();
13173 }
13174 };
13175
13176 /**
13177 * A Property wrapper around the <code>translationX</code> functionality handled by the
13178 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods.
13179 */
13180 public static Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") {
13181 @Override
13182 public void setValue(View object, float value) {
13183 object.setTranslationX(value);
13184 }
13185
13186 @Override
13187 public Float get(View object) {
13188 return object.getTranslationX();
13189 }
13190 };
13191
13192 /**
13193 * A Property wrapper around the <code>translationY</code> functionality handled by the
13194 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods.
13195 */
13196 public static Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") {
13197 @Override
13198 public void setValue(View object, float value) {
13199 object.setTranslationY(value);
13200 }
13201
13202 @Override
13203 public Float get(View object) {
13204 return object.getTranslationY();
13205 }
13206 };
13207
13208 /**
13209 * A Property wrapper around the <code>x</code> functionality handled by the
13210 * {@link View#setX(float)} and {@link View#getX()} methods.
13211 */
13212 public static Property<View, Float> X = new FloatProperty<View>("x") {
13213 @Override
13214 public void setValue(View object, float value) {
13215 object.setX(value);
13216 }
13217
13218 @Override
13219 public Float get(View object) {
13220 return object.getX();
13221 }
13222 };
13223
13224 /**
13225 * A Property wrapper around the <code>y</code> functionality handled by the
13226 * {@link View#setY(float)} and {@link View#getY()} methods.
13227 */
13228 public static Property<View, Float> Y = new FloatProperty<View>("y") {
13229 @Override
13230 public void setValue(View object, float value) {
13231 object.setY(value);
13232 }
13233
13234 @Override
13235 public Float get(View object) {
13236 return object.getY();
13237 }
13238 };
13239
13240 /**
13241 * A Property wrapper around the <code>rotation</code> functionality handled by the
13242 * {@link View#setRotation(float)} and {@link View#getRotation()} methods.
13243 */
13244 public static Property<View, Float> ROTATION = new FloatProperty<View>("rotation") {
13245 @Override
13246 public void setValue(View object, float value) {
13247 object.setRotation(value);
13248 }
13249
13250 @Override
13251 public Float get(View object) {
13252 return object.getRotation();
13253 }
13254 };
13255
13256 /**
13257 * A Property wrapper around the <code>rotationX</code> functionality handled by the
13258 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods.
13259 */
13260 public static Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") {
13261 @Override
13262 public void setValue(View object, float value) {
13263 object.setRotationX(value);
13264 }
13265
13266 @Override
13267 public Float get(View object) {
13268 return object.getRotationX();
13269 }
13270 };
13271
13272 /**
13273 * A Property wrapper around the <code>rotationY</code> functionality handled by the
13274 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods.
13275 */
13276 public static Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") {
13277 @Override
13278 public void setValue(View object, float value) {
13279 object.setRotationY(value);
13280 }
13281
13282 @Override
13283 public Float get(View object) {
13284 return object.getRotationY();
13285 }
13286 };
13287
13288 /**
13289 * A Property wrapper around the <code>scaleX</code> functionality handled by the
13290 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods.
13291 */
13292 public static Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") {
13293 @Override
13294 public void setValue(View object, float value) {
13295 object.setScaleX(value);
13296 }
13297
13298 @Override
13299 public Float get(View object) {
13300 return object.getScaleX();
13301 }
13302 };
13303
13304 /**
13305 * A Property wrapper around the <code>scaleY</code> functionality handled by the
13306 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods.
13307 */
13308 public static Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") {
13309 @Override
13310 public void setValue(View object, float value) {
13311 object.setScaleY(value);
13312 }
13313
13314 @Override
13315 public Float get(View object) {
13316 return object.getScaleY();
13317 }
13318 };
13319
Jeff Brown33bbfd22011-02-24 20:55:35 -080013320 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013321 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
13322 * Each MeasureSpec represents a requirement for either the width or the height.
13323 * A MeasureSpec is comprised of a size and a mode. There are three possible
13324 * modes:
13325 * <dl>
13326 * <dt>UNSPECIFIED</dt>
13327 * <dd>
13328 * The parent has not imposed any constraint on the child. It can be whatever size
13329 * it wants.
13330 * </dd>
13331 *
13332 * <dt>EXACTLY</dt>
13333 * <dd>
13334 * The parent has determined an exact size for the child. The child is going to be
13335 * given those bounds regardless of how big it wants to be.
13336 * </dd>
13337 *
13338 * <dt>AT_MOST</dt>
13339 * <dd>
13340 * The child can be as large as it wants up to the specified size.
13341 * </dd>
13342 * </dl>
13343 *
13344 * MeasureSpecs are implemented as ints to reduce object allocation. This class
13345 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
13346 */
13347 public static class MeasureSpec {
13348 private static final int MODE_SHIFT = 30;
13349 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
13350
13351 /**
13352 * Measure specification mode: The parent has not imposed any constraint
13353 * on the child. It can be whatever size it wants.
13354 */
13355 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
13356
13357 /**
13358 * Measure specification mode: The parent has determined an exact size
13359 * for the child. The child is going to be given those bounds regardless
13360 * of how big it wants to be.
13361 */
13362 public static final int EXACTLY = 1 << MODE_SHIFT;
13363
13364 /**
13365 * Measure specification mode: The child can be as large as it wants up
13366 * to the specified size.
13367 */
13368 public static final int AT_MOST = 2 << MODE_SHIFT;
13369
13370 /**
13371 * Creates a measure specification based on the supplied size and mode.
13372 *
13373 * The mode must always be one of the following:
13374 * <ul>
13375 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
13376 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
13377 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
13378 * </ul>
13379 *
13380 * @param size the size of the measure specification
13381 * @param mode the mode of the measure specification
13382 * @return the measure specification based on size and mode
13383 */
13384 public static int makeMeasureSpec(int size, int mode) {
13385 return size + mode;
13386 }
13387
13388 /**
13389 * Extracts the mode from the supplied measure specification.
13390 *
13391 * @param measureSpec the measure specification to extract the mode from
13392 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
13393 * {@link android.view.View.MeasureSpec#AT_MOST} or
13394 * {@link android.view.View.MeasureSpec#EXACTLY}
13395 */
13396 public static int getMode(int measureSpec) {
13397 return (measureSpec & MODE_MASK);
13398 }
13399
13400 /**
13401 * Extracts the size from the supplied measure specification.
13402 *
13403 * @param measureSpec the measure specification to extract the size from
13404 * @return the size in pixels defined in the supplied measure specification
13405 */
13406 public static int getSize(int measureSpec) {
13407 return (measureSpec & ~MODE_MASK);
13408 }
13409
13410 /**
13411 * Returns a String representation of the specified measure
13412 * specification.
13413 *
13414 * @param measureSpec the measure specification to convert to a String
13415 * @return a String with the following format: "MeasureSpec: MODE SIZE"
13416 */
13417 public static String toString(int measureSpec) {
13418 int mode = getMode(measureSpec);
13419 int size = getSize(measureSpec);
13420
13421 StringBuilder sb = new StringBuilder("MeasureSpec: ");
13422
13423 if (mode == UNSPECIFIED)
13424 sb.append("UNSPECIFIED ");
13425 else if (mode == EXACTLY)
13426 sb.append("EXACTLY ");
13427 else if (mode == AT_MOST)
13428 sb.append("AT_MOST ");
13429 else
13430 sb.append(mode).append(" ");
13431
13432 sb.append(size);
13433 return sb.toString();
13434 }
13435 }
13436
13437 class CheckForLongPress implements Runnable {
13438
13439 private int mOriginalWindowAttachCount;
13440
13441 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070013442 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013443 && mOriginalWindowAttachCount == mWindowAttachCount) {
13444 if (performLongClick()) {
13445 mHasPerformedLongPress = true;
13446 }
13447 }
13448 }
13449
13450 public void rememberWindowAttachCount() {
13451 mOriginalWindowAttachCount = mWindowAttachCount;
13452 }
13453 }
Joe Malin32736f02011-01-19 16:14:20 -080013454
Adam Powelle14579b2009-12-16 18:39:52 -080013455 private final class CheckForTap implements Runnable {
13456 public void run() {
13457 mPrivateFlags &= ~PREPRESSED;
13458 mPrivateFlags |= PRESSED;
13459 refreshDrawableState();
Patrick Dubroye0a799a2011-05-04 16:19:22 -070013460 checkForLongClick(ViewConfiguration.getTapTimeout());
Adam Powelle14579b2009-12-16 18:39:52 -080013461 }
13462 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013463
Adam Powella35d7682010-03-12 14:48:13 -080013464 private final class PerformClick implements Runnable {
13465 public void run() {
13466 performClick();
13467 }
13468 }
13469
Dianne Hackborn63042d62011-01-26 18:56:29 -080013470 /** @hide */
13471 public void hackTurnOffWindowResizeAnim(boolean off) {
13472 mAttachInfo.mTurnOffWindowResizeAnim = off;
13473 }
Joe Malin32736f02011-01-19 16:14:20 -080013474
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013475 /**
Chet Haasea00f3862011-02-22 06:34:40 -080013476 * This method returns a ViewPropertyAnimator object, which can be used to animate
13477 * specific properties on this View.
13478 *
13479 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View.
13480 */
13481 public ViewPropertyAnimator animate() {
13482 if (mAnimator == null) {
13483 mAnimator = new ViewPropertyAnimator(this);
13484 }
13485 return mAnimator;
13486 }
13487
13488 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013489 * Interface definition for a callback to be invoked when a key event is
13490 * dispatched to this view. The callback will be invoked before the key
13491 * event is given to the view.
13492 */
13493 public interface OnKeyListener {
13494 /**
13495 * Called when a key is dispatched to a view. This allows listeners to
13496 * get a chance to respond before the target view.
13497 *
13498 * @param v The view the key has been dispatched to.
13499 * @param keyCode The code for the physical key that was pressed
13500 * @param event The KeyEvent object containing full information about
13501 * the event.
13502 * @return True if the listener has consumed the event, false otherwise.
13503 */
13504 boolean onKey(View v, int keyCode, KeyEvent event);
13505 }
13506
13507 /**
13508 * Interface definition for a callback to be invoked when a touch event is
13509 * dispatched to this view. The callback will be invoked before the touch
13510 * event is given to the view.
13511 */
13512 public interface OnTouchListener {
13513 /**
13514 * Called when a touch event is dispatched to a view. This allows listeners to
13515 * get a chance to respond before the target view.
13516 *
13517 * @param v The view the touch event has been dispatched to.
13518 * @param event The MotionEvent object containing full information about
13519 * the event.
13520 * @return True if the listener has consumed the event, false otherwise.
13521 */
13522 boolean onTouch(View v, MotionEvent event);
13523 }
13524
13525 /**
Jeff Brown10b62902011-06-20 16:40:37 -070013526 * Interface definition for a callback to be invoked when a hover event is
13527 * dispatched to this view. The callback will be invoked before the hover
13528 * event is given to the view.
13529 */
13530 public interface OnHoverListener {
13531 /**
13532 * Called when a hover event is dispatched to a view. This allows listeners to
13533 * get a chance to respond before the target view.
13534 *
13535 * @param v The view the hover event has been dispatched to.
13536 * @param event The MotionEvent object containing full information about
13537 * the event.
13538 * @return True if the listener has consumed the event, false otherwise.
13539 */
13540 boolean onHover(View v, MotionEvent event);
13541 }
13542
13543 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080013544 * Interface definition for a callback to be invoked when a generic motion event is
13545 * dispatched to this view. The callback will be invoked before the generic motion
13546 * event is given to the view.
13547 */
13548 public interface OnGenericMotionListener {
13549 /**
13550 * Called when a generic motion event is dispatched to a view. This allows listeners to
13551 * get a chance to respond before the target view.
13552 *
13553 * @param v The view the generic motion event has been dispatched to.
13554 * @param event The MotionEvent object containing full information about
13555 * the event.
13556 * @return True if the listener has consumed the event, false otherwise.
13557 */
13558 boolean onGenericMotion(View v, MotionEvent event);
13559 }
13560
13561 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013562 * Interface definition for a callback to be invoked when a view has been clicked and held.
13563 */
13564 public interface OnLongClickListener {
13565 /**
13566 * Called when a view has been clicked and held.
13567 *
13568 * @param v The view that was clicked and held.
13569 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080013570 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013571 */
13572 boolean onLongClick(View v);
13573 }
13574
13575 /**
Chris Tate32affef2010-10-18 15:29:21 -070013576 * Interface definition for a callback to be invoked when a drag is being dispatched
13577 * to this view. The callback will be invoked before the hosting view's own
13578 * onDrag(event) method. If the listener wants to fall back to the hosting view's
13579 * onDrag(event) behavior, it should return 'false' from this callback.
13580 */
13581 public interface OnDragListener {
13582 /**
13583 * Called when a drag event is dispatched to a view. This allows listeners
13584 * to get a chance to override base View behavior.
13585 *
Joe Malin32736f02011-01-19 16:14:20 -080013586 * @param v The View that received the drag event.
13587 * @param event The {@link android.view.DragEvent} object for the drag event.
13588 * @return {@code true} if the drag event was handled successfully, or {@code false}
13589 * if the drag event was not handled. Note that {@code false} will trigger the View
13590 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler.
Chris Tate32affef2010-10-18 15:29:21 -070013591 */
13592 boolean onDrag(View v, DragEvent event);
13593 }
13594
13595 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013596 * Interface definition for a callback to be invoked when the focus state of
13597 * a view changed.
13598 */
13599 public interface OnFocusChangeListener {
13600 /**
13601 * Called when the focus state of a view has changed.
13602 *
13603 * @param v The view whose state has changed.
13604 * @param hasFocus The new focus state of v.
13605 */
13606 void onFocusChange(View v, boolean hasFocus);
13607 }
13608
13609 /**
13610 * Interface definition for a callback to be invoked when a view is clicked.
13611 */
13612 public interface OnClickListener {
13613 /**
13614 * Called when a view has been clicked.
13615 *
13616 * @param v The view that was clicked.
13617 */
13618 void onClick(View v);
13619 }
13620
13621 /**
13622 * Interface definition for a callback to be invoked when the context menu
13623 * for this view is being built.
13624 */
13625 public interface OnCreateContextMenuListener {
13626 /**
13627 * Called when the context menu for this view is being built. It is not
13628 * safe to hold onto the menu after this method returns.
13629 *
13630 * @param menu The context menu that is being built
13631 * @param v The view for which the context menu is being built
13632 * @param menuInfo Extra information about the item for which the
13633 * context menu should be shown. This information will vary
13634 * depending on the class of v.
13635 */
13636 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
13637 }
13638
Joe Onorato664644d2011-01-23 17:53:23 -080013639 /**
13640 * Interface definition for a callback to be invoked when the status bar changes
13641 * visibility.
13642 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070013643 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener)
Joe Onorato664644d2011-01-23 17:53:23 -080013644 */
13645 public interface OnSystemUiVisibilityChangeListener {
13646 /**
13647 * Called when the status bar changes visibility because of a call to
Romain Guy5c22a8c2011-05-13 11:48:45 -070013648 * {@link View#setSystemUiVisibility(int)}.
Joe Onorato664644d2011-01-23 17:53:23 -080013649 *
13650 * @param visibility {@link #STATUS_BAR_VISIBLE} or {@link #STATUS_BAR_HIDDEN}.
13651 */
13652 public void onSystemUiVisibilityChange(int visibility);
13653 }
13654
Adam Powell4afd62b2011-02-18 15:02:18 -080013655 /**
13656 * Interface definition for a callback to be invoked when this view is attached
13657 * or detached from its window.
13658 */
13659 public interface OnAttachStateChangeListener {
13660 /**
13661 * Called when the view is attached to a window.
13662 * @param v The view that was attached
13663 */
13664 public void onViewAttachedToWindow(View v);
13665 /**
13666 * Called when the view is detached from a window.
13667 * @param v The view that was detached
13668 */
13669 public void onViewDetachedFromWindow(View v);
13670 }
13671
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013672 private final class UnsetPressedState implements Runnable {
13673 public void run() {
13674 setPressed(false);
13675 }
13676 }
13677
13678 /**
13679 * Base class for derived classes that want to save and restore their own
13680 * state in {@link android.view.View#onSaveInstanceState()}.
13681 */
13682 public static class BaseSavedState extends AbsSavedState {
13683 /**
13684 * Constructor used when reading from a parcel. Reads the state of the superclass.
13685 *
13686 * @param source
13687 */
13688 public BaseSavedState(Parcel source) {
13689 super(source);
13690 }
13691
13692 /**
13693 * Constructor called by derived classes when creating their SavedState objects
13694 *
13695 * @param superState The state of the superclass of this view
13696 */
13697 public BaseSavedState(Parcelable superState) {
13698 super(superState);
13699 }
13700
13701 public static final Parcelable.Creator<BaseSavedState> CREATOR =
13702 new Parcelable.Creator<BaseSavedState>() {
13703 public BaseSavedState createFromParcel(Parcel in) {
13704 return new BaseSavedState(in);
13705 }
13706
13707 public BaseSavedState[] newArray(int size) {
13708 return new BaseSavedState[size];
13709 }
13710 };
13711 }
13712
13713 /**
13714 * A set of information given to a view when it is attached to its parent
13715 * window.
13716 */
13717 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013718 interface Callbacks {
13719 void playSoundEffect(int effectId);
13720 boolean performHapticFeedback(int effectId, boolean always);
13721 }
13722
13723 /**
13724 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
13725 * to a Handler. This class contains the target (View) to invalidate and
13726 * the coordinates of the dirty rectangle.
13727 *
13728 * For performance purposes, this class also implements a pool of up to
13729 * POOL_LIMIT objects that get reused. This reduces memory allocations
13730 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013731 */
Romain Guyd928d682009-03-31 17:52:16 -070013732 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013733 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070013734 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
13735 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070013736 public InvalidateInfo newInstance() {
13737 return new InvalidateInfo();
13738 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013739
Romain Guyd928d682009-03-31 17:52:16 -070013740 public void onAcquired(InvalidateInfo element) {
13741 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013742
Romain Guyd928d682009-03-31 17:52:16 -070013743 public void onReleased(InvalidateInfo element) {
13744 }
13745 }, POOL_LIMIT)
13746 );
13747
13748 private InvalidateInfo mNext;
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070013749 private boolean mIsPooled;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013750
13751 View target;
13752
13753 int left;
13754 int top;
13755 int right;
13756 int bottom;
13757
Romain Guyd928d682009-03-31 17:52:16 -070013758 public void setNextPoolable(InvalidateInfo element) {
13759 mNext = element;
13760 }
13761
13762 public InvalidateInfo getNextPoolable() {
13763 return mNext;
13764 }
13765
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013766 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070013767 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013768 }
13769
13770 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070013771 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013772 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070013773
13774 public boolean isPooled() {
13775 return mIsPooled;
13776 }
13777
13778 public void setPooled(boolean isPooled) {
13779 mIsPooled = isPooled;
13780 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013781 }
13782
13783 final IWindowSession mSession;
13784
13785 final IWindow mWindow;
13786
13787 final IBinder mWindowToken;
13788
13789 final Callbacks mRootCallbacks;
13790
Romain Guy59a12ca2011-06-09 17:48:21 -070013791 HardwareCanvas mHardwareCanvas;
Chet Haasedaf98e92011-01-10 14:10:36 -080013792
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013793 /**
13794 * The top view of the hierarchy.
13795 */
13796 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070013797
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013798 IBinder mPanelParentWindowToken;
13799 Surface mSurface;
13800
Romain Guyb051e892010-09-28 19:09:36 -070013801 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080013802 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070013803 HardwareRenderer mHardwareRenderer;
Joe Malin32736f02011-01-19 16:14:20 -080013804
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013805 /**
Romain Guy8506ab42009-06-11 17:35:47 -070013806 * Scale factor used by the compatibility mode
13807 */
13808 float mApplicationScale;
13809
13810 /**
13811 * Indicates whether the application is in compatibility mode
13812 */
13813 boolean mScalingRequired;
13814
13815 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070013816 * If set, ViewAncestor doesn't use its lame animation for when the window resizes.
Dianne Hackborn63042d62011-01-26 18:56:29 -080013817 */
13818 boolean mTurnOffWindowResizeAnim;
Joe Malin32736f02011-01-19 16:14:20 -080013819
Dianne Hackborn63042d62011-01-26 18:56:29 -080013820 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013821 * Left position of this view's window
13822 */
13823 int mWindowLeft;
13824
13825 /**
13826 * Top position of this view's window
13827 */
13828 int mWindowTop;
13829
13830 /**
Adam Powell26153a32010-11-08 15:22:27 -080013831 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070013832 */
Adam Powell26153a32010-11-08 15:22:27 -080013833 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070013834
13835 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013836 * For windows that are full-screen but using insets to layout inside
13837 * of the screen decorations, these are the current insets for the
13838 * content of the window.
13839 */
13840 final Rect mContentInsets = new Rect();
13841
13842 /**
13843 * For windows that are full-screen but using insets to layout inside
13844 * of the screen decorations, these are the current insets for the
13845 * actual visible parts of the window.
13846 */
13847 final Rect mVisibleInsets = new Rect();
13848
13849 /**
13850 * The internal insets given by this window. This value is
13851 * supplied by the client (through
13852 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
13853 * be given to the window manager when changed to be used in laying
13854 * out windows behind it.
13855 */
13856 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
13857 = new ViewTreeObserver.InternalInsetsInfo();
13858
13859 /**
13860 * All views in the window's hierarchy that serve as scroll containers,
13861 * used to determine if the window can be resized or must be panned
13862 * to adjust for a soft input area.
13863 */
13864 final ArrayList<View> mScrollContainers = new ArrayList<View>();
13865
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070013866 final KeyEvent.DispatcherState mKeyDispatchState
13867 = new KeyEvent.DispatcherState();
13868
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013869 /**
13870 * Indicates whether the view's window currently has the focus.
13871 */
13872 boolean mHasWindowFocus;
13873
13874 /**
13875 * The current visibility of the window.
13876 */
13877 int mWindowVisibility;
13878
13879 /**
13880 * Indicates the time at which drawing started to occur.
13881 */
13882 long mDrawingTime;
13883
13884 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070013885 * Indicates whether or not ignoring the DIRTY_MASK flags.
13886 */
13887 boolean mIgnoreDirtyState;
13888
13889 /**
Romain Guy02ccac62011-06-24 13:20:23 -070013890 * This flag tracks when the mIgnoreDirtyState flag is set during draw(),
13891 * to avoid clearing that flag prematurely.
13892 */
13893 boolean mSetIgnoreDirtyState = false;
13894
13895 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013896 * Indicates whether the view's window is currently in touch mode.
13897 */
13898 boolean mInTouchMode;
13899
13900 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070013901 * Indicates that ViewAncestor should trigger a global layout change
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013902 * the next time it performs a traversal
13903 */
13904 boolean mRecomputeGlobalAttributes;
13905
13906 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013907 * Set during a traveral if any views want to keep the screen on.
13908 */
13909 boolean mKeepScreenOn;
13910
13911 /**
Joe Onorato664644d2011-01-23 17:53:23 -080013912 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility().
13913 */
13914 int mSystemUiVisibility;
13915
13916 /**
13917 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener
13918 * attached.
13919 */
13920 boolean mHasSystemUiListeners;
13921
13922 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013923 * Set if the visibility of any views has changed.
13924 */
13925 boolean mViewVisibilityChanged;
13926
13927 /**
13928 * Set to true if a view has been scrolled.
13929 */
13930 boolean mViewScrollChanged;
13931
13932 /**
13933 * Global to the view hierarchy used as a temporary for dealing with
13934 * x/y points in the transparent region computations.
13935 */
13936 final int[] mTransparentLocation = new int[2];
13937
13938 /**
13939 * Global to the view hierarchy used as a temporary for dealing with
13940 * x/y points in the ViewGroup.invalidateChild implementation.
13941 */
13942 final int[] mInvalidateChildLocation = new int[2];
13943
Chet Haasec3aa3612010-06-17 08:50:37 -070013944
13945 /**
13946 * Global to the view hierarchy used as a temporary for dealing with
13947 * x/y location when view is transformed.
13948 */
13949 final float[] mTmpTransformLocation = new float[2];
13950
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013951 /**
13952 * The view tree observer used to dispatch global events like
13953 * layout, pre-draw, touch mode change, etc.
13954 */
13955 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
13956
13957 /**
13958 * A Canvas used by the view hierarchy to perform bitmap caching.
13959 */
13960 Canvas mCanvas;
13961
13962 /**
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070013963 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013964 * handler can be used to pump events in the UI events queue.
13965 */
13966 final Handler mHandler;
13967
13968 /**
13969 * Identifier for messages requesting the view to be invalidated.
13970 * Such messages should be sent to {@link #mHandler}.
13971 */
13972 static final int INVALIDATE_MSG = 0x1;
13973
13974 /**
13975 * Identifier for messages requesting the view to invalidate a region.
13976 * Such messages should be sent to {@link #mHandler}.
13977 */
13978 static final int INVALIDATE_RECT_MSG = 0x2;
13979
13980 /**
13981 * Temporary for use in computing invalidate rectangles while
13982 * calling up the hierarchy.
13983 */
13984 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070013985
13986 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070013987 * Temporary for use in computing hit areas with transformed views
13988 */
13989 final RectF mTmpTransformRect = new RectF();
13990
13991 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070013992 * Temporary list for use in collecting focusable descendents of a view.
13993 */
13994 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24);
13995
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013996 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070013997 * The id of the window for accessibility purposes.
13998 */
13999 int mAccessibilityWindowId = View.NO_ID;
14000
14001 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014002 * Creates a new set of attachment information with the specified
14003 * events handler and thread.
14004 *
14005 * @param handler the events handler the view must use
14006 */
14007 AttachInfo(IWindowSession session, IWindow window,
14008 Handler handler, Callbacks effectPlayer) {
14009 mSession = session;
14010 mWindow = window;
14011 mWindowToken = window.asBinder();
14012 mHandler = handler;
14013 mRootCallbacks = effectPlayer;
14014 }
14015 }
14016
14017 /**
14018 * <p>ScrollabilityCache holds various fields used by a View when scrolling
14019 * is supported. This avoids keeping too many unused fields in most
14020 * instances of View.</p>
14021 */
Mike Cleronf116bf82009-09-27 19:14:12 -070014022 private static class ScrollabilityCache implements Runnable {
Joe Malin32736f02011-01-19 16:14:20 -080014023
Mike Cleronf116bf82009-09-27 19:14:12 -070014024 /**
14025 * Scrollbars are not visible
14026 */
14027 public static final int OFF = 0;
14028
14029 /**
14030 * Scrollbars are visible
14031 */
14032 public static final int ON = 1;
14033
14034 /**
14035 * Scrollbars are fading away
14036 */
14037 public static final int FADING = 2;
14038
14039 public boolean fadeScrollBars;
Joe Malin32736f02011-01-19 16:14:20 -080014040
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014041 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070014042 public int scrollBarDefaultDelayBeforeFade;
14043 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014044
14045 public int scrollBarSize;
14046 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070014047 public float[] interpolatorValues;
14048 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014049
14050 public final Paint paint;
14051 public final Matrix matrix;
14052 public Shader shader;
14053
Mike Cleronf116bf82009-09-27 19:14:12 -070014054 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
14055
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080014056 private static final float[] OPAQUE = { 255 };
14057 private static final float[] TRANSPARENT = { 0.0f };
Joe Malin32736f02011-01-19 16:14:20 -080014058
Mike Cleronf116bf82009-09-27 19:14:12 -070014059 /**
14060 * When fading should start. This time moves into the future every time
14061 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
14062 */
14063 public long fadeStartTime;
14064
14065
14066 /**
14067 * The current state of the scrollbars: ON, OFF, or FADING
14068 */
14069 public int state = OFF;
14070
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014071 private int mLastColor;
14072
Mike Cleronf116bf82009-09-27 19:14:12 -070014073 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014074 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
14075 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070014076 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
14077 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014078
14079 paint = new Paint();
14080 matrix = new Matrix();
14081 // use use a height of 1, and then wack the matrix each time we
14082 // actually use it.
14083 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070014084
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014085 paint.setShader(shader);
14086 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070014087 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014088 }
Romain Guy8506ab42009-06-11 17:35:47 -070014089
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014090 public void setFadeColor(int color) {
14091 if (color != 0 && color != mLastColor) {
14092 mLastColor = color;
14093 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070014094
Romain Guye55e1a72009-08-27 10:42:26 -070014095 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
14096 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070014097
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014098 paint.setShader(shader);
14099 // Restore the default transfer mode (src_over)
14100 paint.setXfermode(null);
14101 }
14102 }
Joe Malin32736f02011-01-19 16:14:20 -080014103
Mike Cleronf116bf82009-09-27 19:14:12 -070014104 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070014105 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070014106 if (now >= fadeStartTime) {
14107
14108 // the animation fades the scrollbars out by changing
14109 // the opacity (alpha) from fully opaque to fully
14110 // transparent
14111 int nextFrame = (int) now;
14112 int framesCount = 0;
14113
14114 Interpolator interpolator = scrollBarInterpolator;
14115
14116 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080014117 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070014118
14119 // End transparent
14120 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080014121 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070014122
14123 state = FADING;
14124
14125 // Kick off the fade animation
Romain Guy0fd89bf2011-01-26 15:41:30 -080014126 host.invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -070014127 }
14128 }
Svetoslav Ganova0156172011-06-26 17:55:44 -070014129 }
Mike Cleronf116bf82009-09-27 19:14:12 -070014130
Svetoslav Ganova0156172011-06-26 17:55:44 -070014131 /**
14132 * Resuable callback for sending
14133 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
14134 */
14135 private class SendViewScrolledAccessibilityEvent implements Runnable {
14136 public volatile boolean mIsPending;
14137
14138 public void run() {
14139 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED);
14140 mIsPending = false;
14141 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014142 }
14143}