blob: 5b77cf7cb025b1c698e5baf0b3e747c25eaa4114 [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 /**
Scott Main812634c22011-07-27 13:22:35 -0700675 * This view is visible.
676 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code
677 * android:visibility}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800678 */
679 public static final int VISIBLE = 0x00000000;
680
681 /**
682 * This view is invisible, but it still takes up space for layout purposes.
Scott Main812634c22011-07-27 13:22:35 -0700683 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code
684 * android:visibility}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800685 */
686 public static final int INVISIBLE = 0x00000004;
687
688 /**
689 * This view is invisible, and it doesn't take any space for layout
Scott Main812634c22011-07-27 13:22:35 -0700690 * purposes. Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code
691 * android:visibility}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800692 */
693 public static final int GONE = 0x00000008;
694
695 /**
696 * Mask for use with setFlags indicating bits used for visibility.
697 * {@hide}
698 */
699 static final int VISIBILITY_MASK = 0x0000000C;
700
701 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE};
702
703 /**
704 * This view is enabled. Intrepretation varies by subclass.
705 * Use with ENABLED_MASK when calling setFlags.
706 * {@hide}
707 */
708 static final int ENABLED = 0x00000000;
709
710 /**
711 * This view is disabled. Intrepretation varies by subclass.
712 * Use with ENABLED_MASK when calling setFlags.
713 * {@hide}
714 */
715 static final int DISABLED = 0x00000020;
716
717 /**
718 * Mask for use with setFlags indicating bits used for indicating whether
719 * this view is enabled
720 * {@hide}
721 */
722 static final int ENABLED_MASK = 0x00000020;
723
724 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -0700725 * This view won't draw. {@link #onDraw(android.graphics.Canvas)} won't be
726 * called and further optimizations will be performed. It is okay to have
727 * this flag set and a background. Use with DRAW_MASK when calling setFlags.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800728 * {@hide}
729 */
730 static final int WILL_NOT_DRAW = 0x00000080;
731
732 /**
733 * Mask for use with setFlags indicating bits used for indicating whether
734 * this view is will draw
735 * {@hide}
736 */
737 static final int DRAW_MASK = 0x00000080;
738
739 /**
740 * <p>This view doesn't show scrollbars.</p>
741 * {@hide}
742 */
743 static final int SCROLLBARS_NONE = 0x00000000;
744
745 /**
746 * <p>This view shows horizontal scrollbars.</p>
747 * {@hide}
748 */
749 static final int SCROLLBARS_HORIZONTAL = 0x00000100;
750
751 /**
752 * <p>This view shows vertical scrollbars.</p>
753 * {@hide}
754 */
755 static final int SCROLLBARS_VERTICAL = 0x00000200;
756
757 /**
758 * <p>Mask for use with setFlags indicating bits used for indicating which
759 * scrollbars are enabled.</p>
760 * {@hide}
761 */
762 static final int SCROLLBARS_MASK = 0x00000300;
763
Jeff Brown85a31762010-09-01 17:01:00 -0700764 /**
765 * Indicates that the view should filter touches when its window is obscured.
766 * Refer to the class comments for more information about this security feature.
767 * {@hide}
768 */
769 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400;
770
771 // note flag value 0x00000800 is now available for next flags...
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800772
773 /**
774 * <p>This view doesn't show fading edges.</p>
775 * {@hide}
776 */
777 static final int FADING_EDGE_NONE = 0x00000000;
778
779 /**
780 * <p>This view shows horizontal fading edges.</p>
781 * {@hide}
782 */
783 static final int FADING_EDGE_HORIZONTAL = 0x00001000;
784
785 /**
786 * <p>This view shows vertical fading edges.</p>
787 * {@hide}
788 */
789 static final int FADING_EDGE_VERTICAL = 0x00002000;
790
791 /**
792 * <p>Mask for use with setFlags indicating bits used for indicating which
793 * fading edges are enabled.</p>
794 * {@hide}
795 */
796 static final int FADING_EDGE_MASK = 0x00003000;
797
798 /**
799 * <p>Indicates this view can be clicked. When clickable, a View reacts
800 * to clicks by notifying the OnClickListener.<p>
801 * {@hide}
802 */
803 static final int CLICKABLE = 0x00004000;
804
805 /**
806 * <p>Indicates this view is caching its drawing into a bitmap.</p>
807 * {@hide}
808 */
809 static final int DRAWING_CACHE_ENABLED = 0x00008000;
810
811 /**
812 * <p>Indicates that no icicle should be saved for this view.<p>
813 * {@hide}
814 */
815 static final int SAVE_DISABLED = 0x000010000;
816
817 /**
818 * <p>Mask for use with setFlags indicating bits used for the saveEnabled
819 * property.</p>
820 * {@hide}
821 */
822 static final int SAVE_DISABLED_MASK = 0x000010000;
823
824 /**
825 * <p>Indicates that no drawing cache should ever be created for this view.<p>
826 * {@hide}
827 */
828 static final int WILL_NOT_CACHE_DRAWING = 0x000020000;
829
830 /**
831 * <p>Indicates this view can take / keep focus when int touch mode.</p>
832 * {@hide}
833 */
834 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000;
835
836 /**
837 * <p>Enables low quality mode for the drawing cache.</p>
838 */
839 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000;
840
841 /**
842 * <p>Enables high quality mode for the drawing cache.</p>
843 */
844 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000;
845
846 /**
847 * <p>Enables automatic quality mode for the drawing cache.</p>
848 */
849 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000;
850
851 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = {
852 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH
853 };
854
855 /**
856 * <p>Mask for use with setFlags indicating bits used for the cache
857 * quality property.</p>
858 * {@hide}
859 */
860 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000;
861
862 /**
863 * <p>
864 * Indicates this view can be long clicked. When long clickable, a View
865 * reacts to long clicks by notifying the OnLongClickListener or showing a
866 * context menu.
867 * </p>
868 * {@hide}
869 */
870 static final int LONG_CLICKABLE = 0x00200000;
871
872 /**
873 * <p>Indicates that this view gets its drawable states from its direct parent
874 * and ignores its original internal states.</p>
875 *
876 * @hide
877 */
878 static final int DUPLICATE_PARENT_STATE = 0x00400000;
879
880 /**
881 * The scrollbar style to display the scrollbars inside the content area,
882 * without increasing the padding. The scrollbars will be overlaid with
883 * translucency on the view's content.
884 */
885 public static final int SCROLLBARS_INSIDE_OVERLAY = 0;
886
887 /**
888 * The scrollbar style to display the scrollbars inside the padded area,
889 * increasing the padding of the view. The scrollbars will not overlap the
890 * content area of the view.
891 */
892 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000;
893
894 /**
895 * The scrollbar style to display the scrollbars at the edge of the view,
896 * without increasing the padding. The scrollbars will be overlaid with
897 * translucency.
898 */
899 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000;
900
901 /**
902 * The scrollbar style to display the scrollbars at the edge of the view,
903 * increasing the padding of the view. The scrollbars will only overlap the
904 * background, if any.
905 */
906 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000;
907
908 /**
909 * Mask to check if the scrollbar style is overlay or inset.
910 * {@hide}
911 */
912 static final int SCROLLBARS_INSET_MASK = 0x01000000;
913
914 /**
915 * Mask to check if the scrollbar style is inside or outside.
916 * {@hide}
917 */
918 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000;
919
920 /**
921 * Mask for scrollbar style.
922 * {@hide}
923 */
924 static final int SCROLLBARS_STYLE_MASK = 0x03000000;
925
926 /**
927 * View flag indicating that the screen should remain on while the
928 * window containing this view is visible to the user. This effectively
929 * takes care of automatically setting the WindowManager's
930 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}.
931 */
932 public static final int KEEP_SCREEN_ON = 0x04000000;
933
934 /**
935 * View flag indicating whether this view should have sound effects enabled
936 * for events such as clicking and touching.
937 */
938 public static final int SOUND_EFFECTS_ENABLED = 0x08000000;
939
940 /**
941 * View flag indicating whether this view should have haptic feedback
942 * enabled for events such as long presses.
943 */
944 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000;
945
946 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700947 * <p>Indicates that the view hierarchy should stop saving state when
948 * it reaches this view. If state saving is initiated immediately at
949 * the view, it will be allowed.
950 * {@hide}
951 */
952 static final int PARENT_SAVE_DISABLED = 0x20000000;
953
954 /**
955 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p>
956 * {@hide}
957 */
958 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000;
959
960 /**
Cibu Johny7632cb92010-02-22 13:01:02 -0800961 * Horizontal direction of this view is from Left to Right.
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700962 * Use with {@link #setLayoutDirection}.
Cibu Johny7632cb92010-02-22 13:01:02 -0800963 * {@hide}
964 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700965 public static final int LAYOUT_DIRECTION_LTR = 0x00000000;
Cibu Johny7632cb92010-02-22 13:01:02 -0800966
967 /**
968 * Horizontal direction of this view is from Right to Left.
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700969 * Use with {@link #setLayoutDirection}.
Cibu Johny7632cb92010-02-22 13:01:02 -0800970 * {@hide}
971 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700972 public static final int LAYOUT_DIRECTION_RTL = 0x40000000;
Cibu Johny7632cb92010-02-22 13:01:02 -0800973
974 /**
975 * Horizontal direction of this view is inherited from its parent.
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700976 * Use with {@link #setLayoutDirection}.
Cibu Johny7632cb92010-02-22 13:01:02 -0800977 * {@hide}
978 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700979 public static final int LAYOUT_DIRECTION_INHERIT = 0x80000000;
Cibu Johny7632cb92010-02-22 13:01:02 -0800980
981 /**
982 * Horizontal direction of this view is from deduced from the default language
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700983 * script for the locale. Use with {@link #setLayoutDirection}.
Cibu Johny7632cb92010-02-22 13:01:02 -0800984 * {@hide}
985 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700986 public static final int LAYOUT_DIRECTION_LOCALE = 0xC0000000;
Cibu Johny7632cb92010-02-22 13:01:02 -0800987
988 /**
989 * Mask for use with setFlags indicating bits used for horizontalDirection.
990 * {@hide}
991 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700992 static final int LAYOUT_DIRECTION_MASK = 0xC0000000;
Cibu Johny7632cb92010-02-22 13:01:02 -0800993
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -0700994 /*
995 * Array of horizontal direction flags for mapping attribute "horizontalDirection" to correct
996 * flag value.
997 * {@hide}
998 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -0700999 private static final int[] LAYOUT_DIRECTION_FLAGS = {LAYOUT_DIRECTION_LTR,
1000 LAYOUT_DIRECTION_RTL, LAYOUT_DIRECTION_INHERIT, LAYOUT_DIRECTION_LOCALE};
Cibu Johny7632cb92010-02-22 13:01:02 -08001001
1002 /**
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07001003 * Default horizontalDirection.
1004 * {@hide}
1005 */
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07001006 private static final int LAYOUT_DIRECTION_DEFAULT = LAYOUT_DIRECTION_INHERIT;
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07001007
1008 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07001009 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
1010 * should add all focusable Views regardless if they are focusable in touch mode.
1011 */
1012 public static final int FOCUSABLES_ALL = 0x00000000;
1013
1014 /**
1015 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
1016 * should add only Views focusable in touch mode.
1017 */
1018 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001;
1019
1020 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001021 * Use with {@link #focusSearch(int)}. Move focus to the previous selectable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001022 * item.
1023 */
1024 public static final int FOCUS_BACKWARD = 0x00000001;
1025
1026 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001027 * Use with {@link #focusSearch(int)}. Move focus to the next selectable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001028 * item.
1029 */
1030 public static final int FOCUS_FORWARD = 0x00000002;
1031
1032 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001033 * Use with {@link #focusSearch(int)}. Move focus to the left.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001034 */
1035 public static final int FOCUS_LEFT = 0x00000011;
1036
1037 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001038 * Use with {@link #focusSearch(int)}. Move focus up.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001039 */
1040 public static final int FOCUS_UP = 0x00000021;
1041
1042 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001043 * Use with {@link #focusSearch(int)}. Move focus to the right.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001044 */
1045 public static final int FOCUS_RIGHT = 0x00000042;
1046
1047 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001048 * Use with {@link #focusSearch(int)}. Move focus down.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001049 */
1050 public static final int FOCUS_DOWN = 0x00000082;
1051
1052 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08001053 * Bits of {@link #getMeasuredWidthAndState()} and
1054 * {@link #getMeasuredWidthAndState()} that provide the actual measured size.
1055 */
1056 public static final int MEASURED_SIZE_MASK = 0x00ffffff;
1057
1058 /**
1059 * Bits of {@link #getMeasuredWidthAndState()} and
1060 * {@link #getMeasuredWidthAndState()} that provide the additional state bits.
1061 */
1062 public static final int MEASURED_STATE_MASK = 0xff000000;
1063
1064 /**
1065 * Bit shift of {@link #MEASURED_STATE_MASK} to get to the height bits
1066 * for functions that combine both width and height into a single int,
1067 * such as {@link #getMeasuredState()} and the childState argument of
1068 * {@link #resolveSizeAndState(int, int, int)}.
1069 */
1070 public static final int MEASURED_HEIGHT_STATE_SHIFT = 16;
1071
1072 /**
1073 * Bit of {@link #getMeasuredWidthAndState()} and
1074 * {@link #getMeasuredWidthAndState()} that indicates the measured size
1075 * is smaller that the space the view would like to have.
1076 */
1077 public static final int MEASURED_STATE_TOO_SMALL = 0x01000000;
1078
1079 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001080 * Base View state sets
1081 */
1082 // Singles
1083 /**
1084 * Indicates the view has no states set. States are used with
1085 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1086 * view depending on its state.
1087 *
1088 * @see android.graphics.drawable.Drawable
1089 * @see #getDrawableState()
1090 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001091 protected static final int[] EMPTY_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001092 /**
1093 * Indicates the view is enabled. States are used with
1094 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1095 * view depending on its state.
1096 *
1097 * @see android.graphics.drawable.Drawable
1098 * @see #getDrawableState()
1099 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001100 protected static final int[] ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001101 /**
1102 * Indicates the view is focused. States are used with
1103 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1104 * view depending on its state.
1105 *
1106 * @see android.graphics.drawable.Drawable
1107 * @see #getDrawableState()
1108 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001109 protected static final int[] FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001110 /**
1111 * Indicates the view is selected. States are used with
1112 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1113 * view depending on its state.
1114 *
1115 * @see android.graphics.drawable.Drawable
1116 * @see #getDrawableState()
1117 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001118 protected static final int[] SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001119 /**
1120 * Indicates the view is pressed. States are used with
1121 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1122 * view depending on its state.
1123 *
1124 * @see android.graphics.drawable.Drawable
1125 * @see #getDrawableState()
1126 * @hide
1127 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001128 protected static final int[] PRESSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001129 /**
1130 * Indicates the view's window has focus. States are used with
1131 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1132 * view depending on its state.
1133 *
1134 * @see android.graphics.drawable.Drawable
1135 * @see #getDrawableState()
1136 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001137 protected static final int[] WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001138 // Doubles
1139 /**
1140 * Indicates the view is enabled and has the focus.
1141 *
1142 * @see #ENABLED_STATE_SET
1143 * @see #FOCUSED_STATE_SET
1144 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001145 protected static final int[] ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001146 /**
1147 * Indicates the view is enabled and selected.
1148 *
1149 * @see #ENABLED_STATE_SET
1150 * @see #SELECTED_STATE_SET
1151 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001152 protected static final int[] ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001153 /**
1154 * Indicates the view is enabled and that its window has focus.
1155 *
1156 * @see #ENABLED_STATE_SET
1157 * @see #WINDOW_FOCUSED_STATE_SET
1158 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001159 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001160 /**
1161 * Indicates the view is focused and selected.
1162 *
1163 * @see #FOCUSED_STATE_SET
1164 * @see #SELECTED_STATE_SET
1165 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001166 protected static final int[] FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001167 /**
1168 * Indicates the view has the focus and that its window has the focus.
1169 *
1170 * @see #FOCUSED_STATE_SET
1171 * @see #WINDOW_FOCUSED_STATE_SET
1172 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001173 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001174 /**
1175 * Indicates the view is selected and that its window has the focus.
1176 *
1177 * @see #SELECTED_STATE_SET
1178 * @see #WINDOW_FOCUSED_STATE_SET
1179 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001180 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001181 // Triples
1182 /**
1183 * Indicates the view is enabled, focused and selected.
1184 *
1185 * @see #ENABLED_STATE_SET
1186 * @see #FOCUSED_STATE_SET
1187 * @see #SELECTED_STATE_SET
1188 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001189 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001190 /**
1191 * Indicates the view is enabled, focused and its window has the focus.
1192 *
1193 * @see #ENABLED_STATE_SET
1194 * @see #FOCUSED_STATE_SET
1195 * @see #WINDOW_FOCUSED_STATE_SET
1196 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001197 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001198 /**
1199 * Indicates the view is enabled, selected and its window has the focus.
1200 *
1201 * @see #ENABLED_STATE_SET
1202 * @see #SELECTED_STATE_SET
1203 * @see #WINDOW_FOCUSED_STATE_SET
1204 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001205 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001206 /**
1207 * Indicates the view is focused, selected and its window has the focus.
1208 *
1209 * @see #FOCUSED_STATE_SET
1210 * @see #SELECTED_STATE_SET
1211 * @see #WINDOW_FOCUSED_STATE_SET
1212 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001213 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001214 /**
1215 * Indicates the view is enabled, focused, selected and its window
1216 * has the focus.
1217 *
1218 * @see #ENABLED_STATE_SET
1219 * @see #FOCUSED_STATE_SET
1220 * @see #SELECTED_STATE_SET
1221 * @see #WINDOW_FOCUSED_STATE_SET
1222 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001223 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001224 /**
1225 * Indicates the view is pressed and its window has the focus.
1226 *
1227 * @see #PRESSED_STATE_SET
1228 * @see #WINDOW_FOCUSED_STATE_SET
1229 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001230 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001231 /**
1232 * Indicates the view is pressed and selected.
1233 *
1234 * @see #PRESSED_STATE_SET
1235 * @see #SELECTED_STATE_SET
1236 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001237 protected static final int[] PRESSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001238 /**
1239 * Indicates the view is pressed, selected and its window has the focus.
1240 *
1241 * @see #PRESSED_STATE_SET
1242 * @see #SELECTED_STATE_SET
1243 * @see #WINDOW_FOCUSED_STATE_SET
1244 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001245 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001246 /**
1247 * Indicates the view is pressed and focused.
1248 *
1249 * @see #PRESSED_STATE_SET
1250 * @see #FOCUSED_STATE_SET
1251 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001252 protected static final int[] PRESSED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001253 /**
1254 * Indicates the view is pressed, focused and its window has the focus.
1255 *
1256 * @see #PRESSED_STATE_SET
1257 * @see #FOCUSED_STATE_SET
1258 * @see #WINDOW_FOCUSED_STATE_SET
1259 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001260 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001261 /**
1262 * Indicates the view is pressed, focused and selected.
1263 *
1264 * @see #PRESSED_STATE_SET
1265 * @see #SELECTED_STATE_SET
1266 * @see #FOCUSED_STATE_SET
1267 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001268 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001269 /**
1270 * Indicates the view is pressed, focused, selected and its window has the focus.
1271 *
1272 * @see #PRESSED_STATE_SET
1273 * @see #FOCUSED_STATE_SET
1274 * @see #SELECTED_STATE_SET
1275 * @see #WINDOW_FOCUSED_STATE_SET
1276 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001277 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001278 /**
1279 * Indicates the view is pressed and enabled.
1280 *
1281 * @see #PRESSED_STATE_SET
1282 * @see #ENABLED_STATE_SET
1283 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001284 protected static final int[] PRESSED_ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001285 /**
1286 * Indicates the view is pressed, enabled and its window has the focus.
1287 *
1288 * @see #PRESSED_STATE_SET
1289 * @see #ENABLED_STATE_SET
1290 * @see #WINDOW_FOCUSED_STATE_SET
1291 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001292 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001293 /**
1294 * Indicates the view is pressed, enabled and selected.
1295 *
1296 * @see #PRESSED_STATE_SET
1297 * @see #ENABLED_STATE_SET
1298 * @see #SELECTED_STATE_SET
1299 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001300 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001301 /**
1302 * Indicates the view is pressed, enabled, selected and its window has the
1303 * focus.
1304 *
1305 * @see #PRESSED_STATE_SET
1306 * @see #ENABLED_STATE_SET
1307 * @see #SELECTED_STATE_SET
1308 * @see #WINDOW_FOCUSED_STATE_SET
1309 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001310 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001311 /**
1312 * Indicates the view is pressed, enabled and focused.
1313 *
1314 * @see #PRESSED_STATE_SET
1315 * @see #ENABLED_STATE_SET
1316 * @see #FOCUSED_STATE_SET
1317 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001318 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001319 /**
1320 * Indicates the view is pressed, enabled, focused and its window has the
1321 * focus.
1322 *
1323 * @see #PRESSED_STATE_SET
1324 * @see #ENABLED_STATE_SET
1325 * @see #FOCUSED_STATE_SET
1326 * @see #WINDOW_FOCUSED_STATE_SET
1327 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001328 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001329 /**
1330 * Indicates the view is pressed, enabled, focused and selected.
1331 *
1332 * @see #PRESSED_STATE_SET
1333 * @see #ENABLED_STATE_SET
1334 * @see #SELECTED_STATE_SET
1335 * @see #FOCUSED_STATE_SET
1336 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001337 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001338 /**
1339 * Indicates the view is pressed, enabled, focused, selected and its window
1340 * has the focus.
1341 *
1342 * @see #PRESSED_STATE_SET
1343 * @see #ENABLED_STATE_SET
1344 * @see #SELECTED_STATE_SET
1345 * @see #FOCUSED_STATE_SET
1346 * @see #WINDOW_FOCUSED_STATE_SET
1347 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001348 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001349
1350 /**
1351 * The order here is very important to {@link #getDrawableState()}
1352 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001353 private static final int[][] VIEW_STATE_SETS;
1354
Romain Guyb051e892010-09-28 19:09:36 -07001355 static final int VIEW_STATE_WINDOW_FOCUSED = 1;
1356 static final int VIEW_STATE_SELECTED = 1 << 1;
1357 static final int VIEW_STATE_FOCUSED = 1 << 2;
1358 static final int VIEW_STATE_ENABLED = 1 << 3;
1359 static final int VIEW_STATE_PRESSED = 1 << 4;
1360 static final int VIEW_STATE_ACTIVATED = 1 << 5;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001361 static final int VIEW_STATE_ACCELERATED = 1 << 6;
PY Laligandc33d8d49e2011-03-14 18:22:53 -07001362 static final int VIEW_STATE_HOVERED = 1 << 7;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001363 static final int VIEW_STATE_DRAG_CAN_ACCEPT = 1 << 8;
1364 static final int VIEW_STATE_DRAG_HOVERED = 1 << 9;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001365
1366 static final int[] VIEW_STATE_IDS = new int[] {
1367 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED,
1368 R.attr.state_selected, VIEW_STATE_SELECTED,
1369 R.attr.state_focused, VIEW_STATE_FOCUSED,
1370 R.attr.state_enabled, VIEW_STATE_ENABLED,
1371 R.attr.state_pressed, VIEW_STATE_PRESSED,
1372 R.attr.state_activated, VIEW_STATE_ACTIVATED,
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001373 R.attr.state_accelerated, VIEW_STATE_ACCELERATED,
PY Laligandc33d8d49e2011-03-14 18:22:53 -07001374 R.attr.state_hovered, VIEW_STATE_HOVERED,
Christopher Tate3d4bf172011-03-28 16:16:46 -07001375 R.attr.state_drag_can_accept, VIEW_STATE_DRAG_CAN_ACCEPT,
1376 R.attr.state_drag_hovered, VIEW_STATE_DRAG_HOVERED,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001377 };
1378
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001379 static {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001380 if ((VIEW_STATE_IDS.length/2) != R.styleable.ViewDrawableStates.length) {
1381 throw new IllegalStateException(
1382 "VIEW_STATE_IDs array length does not match ViewDrawableStates style array");
1383 }
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001384 int[] orderedIds = new int[VIEW_STATE_IDS.length];
Romain Guyb051e892010-09-28 19:09:36 -07001385 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001386 int viewState = R.styleable.ViewDrawableStates[i];
Romain Guyb051e892010-09-28 19:09:36 -07001387 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001388 if (VIEW_STATE_IDS[j] == viewState) {
Romain Guyb051e892010-09-28 19:09:36 -07001389 orderedIds[i * 2] = viewState;
1390 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1];
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001391 }
1392 }
1393 }
Romain Guyb051e892010-09-28 19:09:36 -07001394 final int NUM_BITS = VIEW_STATE_IDS.length / 2;
1395 VIEW_STATE_SETS = new int[1 << NUM_BITS][];
1396 for (int i = 0; i < VIEW_STATE_SETS.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001397 int numBits = Integer.bitCount(i);
1398 int[] set = new int[numBits];
1399 int pos = 0;
Romain Guyb051e892010-09-28 19:09:36 -07001400 for (int j = 0; j < orderedIds.length; j += 2) {
1401 if ((i & orderedIds[j+1]) != 0) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001402 set[pos++] = orderedIds[j];
1403 }
1404 }
1405 VIEW_STATE_SETS[i] = set;
1406 }
1407
1408 EMPTY_STATE_SET = VIEW_STATE_SETS[0];
1409 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED];
1410 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED];
1411 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1412 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED];
1413 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED];
1414 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1415 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED];
1416 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1417 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED];
1418 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1419 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1420 | VIEW_STATE_FOCUSED];
1421 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED];
1422 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1423 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED];
1424 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1425 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED];
1426 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1427 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1428 | VIEW_STATE_ENABLED];
1429 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1430 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED];
1431 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1432 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1433 | VIEW_STATE_ENABLED];
1434 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1435 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1436 | VIEW_STATE_ENABLED];
1437 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1438 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1439 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED];
1440
1441 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED];
1442 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1443 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED];
1444 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1445 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED];
1446 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1447 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1448 | VIEW_STATE_PRESSED];
1449 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1450 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1451 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1452 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1453 | VIEW_STATE_PRESSED];
1454 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1455 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1456 | VIEW_STATE_PRESSED];
1457 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1458 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1459 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1460 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[
1461 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1462 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1463 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED
1464 | VIEW_STATE_PRESSED];
1465 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1466 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED
1467 | VIEW_STATE_PRESSED];
1468 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1469 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1470 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1471 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1472 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED
1473 | VIEW_STATE_PRESSED];
1474 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1475 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1476 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1477 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1478 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1479 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1480 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1481 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1482 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED
1483 | VIEW_STATE_PRESSED];
1484 }
1485
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001486 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001487 * Temporary Rect currently for use in setBackground(). This will probably
1488 * be extended in the future to hold our own class with more than just
1489 * a Rect. :)
1490 */
1491 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>();
Romain Guyd90a3312009-05-06 14:54:28 -07001492
1493 /**
1494 * Map used to store views' tags.
1495 */
1496 private static WeakHashMap<View, SparseArray<Object>> sTags;
1497
1498 /**
1499 * Lock used to access sTags.
1500 */
1501 private static final Object sTagsLock = new Object();
1502
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001503 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07001504 * The next available accessiiblity id.
1505 */
1506 private static int sNextAccessibilityViewId;
1507
1508 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001509 * The animation currently associated with this view.
1510 * @hide
1511 */
1512 protected Animation mCurrentAnimation = null;
1513
1514 /**
1515 * Width as measured during measure pass.
1516 * {@hide}
1517 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001518 @ViewDebug.ExportedProperty(category = "measurement")
Romain Guy676b1732011-02-14 14:45:33 -08001519 int mMeasuredWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001520
1521 /**
1522 * Height as measured during measure pass.
1523 * {@hide}
1524 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001525 @ViewDebug.ExportedProperty(category = "measurement")
Romain Guy676b1732011-02-14 14:45:33 -08001526 int mMeasuredHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001527
1528 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001529 * Flag to indicate that this view was marked INVALIDATED, or had its display list
1530 * invalidated, prior to the current drawing iteration. If true, the view must re-draw
1531 * its display list. This flag, used only when hw accelerated, allows us to clear the
1532 * flag while retaining this information until it's needed (at getDisplayList() time and
1533 * in drawChild(), when we decide to draw a view's children's display lists into our own).
1534 *
1535 * {@hide}
1536 */
1537 boolean mRecreateDisplayList = false;
1538
1539 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001540 * The view's identifier.
1541 * {@hide}
1542 *
1543 * @see #setId(int)
1544 * @see #getId()
1545 */
1546 @ViewDebug.ExportedProperty(resolveId = true)
1547 int mID = NO_ID;
1548
1549 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07001550 * The stable ID of this view for accessibility porposes.
1551 */
1552 int mAccessibilityViewId = NO_ID;
1553
1554 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001555 * The view's tag.
1556 * {@hide}
1557 *
1558 * @see #setTag(Object)
1559 * @see #getTag()
1560 */
1561 protected Object mTag;
1562
1563 // for mPrivateFlags:
1564 /** {@hide} */
1565 static final int WANTS_FOCUS = 0x00000001;
1566 /** {@hide} */
1567 static final int FOCUSED = 0x00000002;
1568 /** {@hide} */
1569 static final int SELECTED = 0x00000004;
1570 /** {@hide} */
1571 static final int IS_ROOT_NAMESPACE = 0x00000008;
1572 /** {@hide} */
1573 static final int HAS_BOUNDS = 0x00000010;
1574 /** {@hide} */
1575 static final int DRAWN = 0x00000020;
1576 /**
1577 * When this flag is set, this view is running an animation on behalf of its
1578 * children and should therefore not cancel invalidate requests, even if they
1579 * lie outside of this view's bounds.
1580 *
1581 * {@hide}
1582 */
1583 static final int DRAW_ANIMATION = 0x00000040;
1584 /** {@hide} */
1585 static final int SKIP_DRAW = 0x00000080;
1586 /** {@hide} */
1587 static final int ONLY_DRAWS_BACKGROUND = 0x00000100;
1588 /** {@hide} */
1589 static final int REQUEST_TRANSPARENT_REGIONS = 0x00000200;
1590 /** {@hide} */
1591 static final int DRAWABLE_STATE_DIRTY = 0x00000400;
1592 /** {@hide} */
1593 static final int MEASURED_DIMENSION_SET = 0x00000800;
1594 /** {@hide} */
1595 static final int FORCE_LAYOUT = 0x00001000;
Konstantin Lopyrevc6dc4572010-08-06 15:01:52 -07001596 /** {@hide} */
1597 static final int LAYOUT_REQUIRED = 0x00002000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001598
1599 private static final int PRESSED = 0x00004000;
1600
1601 /** {@hide} */
1602 static final int DRAWING_CACHE_VALID = 0x00008000;
1603 /**
1604 * Flag used to indicate that this view should be drawn once more (and only once
1605 * more) after its animation has completed.
1606 * {@hide}
1607 */
1608 static final int ANIMATION_STARTED = 0x00010000;
1609
1610 private static final int SAVE_STATE_CALLED = 0x00020000;
1611
1612 /**
1613 * Indicates that the View returned true when onSetAlpha() was called and that
1614 * the alpha must be restored.
1615 * {@hide}
1616 */
1617 static final int ALPHA_SET = 0x00040000;
1618
1619 /**
1620 * Set by {@link #setScrollContainer(boolean)}.
1621 */
1622 static final int SCROLL_CONTAINER = 0x00080000;
1623
1624 /**
1625 * Set by {@link #setScrollContainer(boolean)}.
1626 */
1627 static final int SCROLL_CONTAINER_ADDED = 0x00100000;
1628
1629 /**
Romain Guy809a7f62009-05-14 15:44:42 -07001630 * View flag indicating whether this view was invalidated (fully or partially.)
1631 *
1632 * @hide
1633 */
1634 static final int DIRTY = 0x00200000;
1635
1636 /**
1637 * View flag indicating whether this view was invalidated by an opaque
1638 * invalidate request.
1639 *
1640 * @hide
1641 */
1642 static final int DIRTY_OPAQUE = 0x00400000;
1643
1644 /**
1645 * Mask for {@link #DIRTY} and {@link #DIRTY_OPAQUE}.
1646 *
1647 * @hide
1648 */
1649 static final int DIRTY_MASK = 0x00600000;
1650
1651 /**
Romain Guy8f1344f52009-05-15 16:03:59 -07001652 * Indicates whether the background is opaque.
1653 *
1654 * @hide
1655 */
1656 static final int OPAQUE_BACKGROUND = 0x00800000;
1657
1658 /**
1659 * Indicates whether the scrollbars are opaque.
1660 *
1661 * @hide
1662 */
1663 static final int OPAQUE_SCROLLBARS = 0x01000000;
1664
1665 /**
1666 * Indicates whether the view is opaque.
1667 *
1668 * @hide
1669 */
1670 static final int OPAQUE_MASK = 0x01800000;
Joe Malin32736f02011-01-19 16:14:20 -08001671
Adam Powelle14579b2009-12-16 18:39:52 -08001672 /**
1673 * Indicates a prepressed state;
1674 * the short time between ACTION_DOWN and recognizing
1675 * a 'real' press. Prepressed is used to recognize quick taps
1676 * even when they are shorter than ViewConfiguration.getTapTimeout().
Joe Malin32736f02011-01-19 16:14:20 -08001677 *
Adam Powelle14579b2009-12-16 18:39:52 -08001678 * @hide
1679 */
1680 private static final int PREPRESSED = 0x02000000;
Joe Malin32736f02011-01-19 16:14:20 -08001681
Adam Powellc9fbaab2010-02-16 17:16:19 -08001682 /**
Romain Guy8afa5152010-02-26 11:56:30 -08001683 * Indicates whether the view is temporarily detached.
1684 *
1685 * @hide
1686 */
1687 static final int CANCEL_NEXT_UP_EVENT = 0x04000000;
Joe Malin32736f02011-01-19 16:14:20 -08001688
Adam Powell8568c3a2010-04-19 14:26:11 -07001689 /**
1690 * Indicates that we should awaken scroll bars once attached
Joe Malin32736f02011-01-19 16:14:20 -08001691 *
Adam Powell8568c3a2010-04-19 14:26:11 -07001692 * @hide
1693 */
1694 private static final int AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000;
Romain Guy8f1344f52009-05-15 16:03:59 -07001695
1696 /**
Jeff Browna032cc02011-03-07 16:56:21 -08001697 * Indicates that the view has received HOVER_ENTER. Cleared on HOVER_EXIT.
1698 * @hide
1699 */
1700 private static final int HOVERED = 0x10000000;
1701
1702 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001703 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center
1704 * for transform operations
1705 *
1706 * @hide
1707 */
Adam Powellf37df072010-09-17 16:22:49 -07001708 private static final int PIVOT_EXPLICITLY_SET = 0x20000000;
Chet Haasefd2b0022010-08-06 13:08:56 -07001709
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001710 /** {@hide} */
Adam Powellf37df072010-09-17 16:22:49 -07001711 static final int ACTIVATED = 0x40000000;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001712
Chet Haasefd2b0022010-08-06 13:08:56 -07001713 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001714 * Indicates that this view was specifically invalidated, not just dirtied because some
1715 * child view was invalidated. The flag is used to determine when we need to recreate
1716 * a view's display list (as opposed to just returning a reference to its existing
1717 * display list).
1718 *
1719 * @hide
1720 */
1721 static final int INVALIDATED = 0x80000000;
1722
Christopher Tate3d4bf172011-03-28 16:16:46 -07001723 /* Masks for mPrivateFlags2 */
1724
1725 /**
1726 * Indicates that this view has reported that it can accept the current drag's content.
1727 * Cleared when the drag operation concludes.
1728 * @hide
1729 */
1730 static final int DRAG_CAN_ACCEPT = 0x00000001;
1731
1732 /**
1733 * Indicates that this view is currently directly under the drag location in a
1734 * drag-and-drop operation involving content that it can accept. Cleared when
1735 * the drag exits the view, or when the drag operation concludes.
1736 * @hide
1737 */
1738 static final int DRAG_HOVERED = 0x00000002;
1739
Cibu Johny86666632010-02-22 13:01:02 -08001740 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07001741 * Indicates whether the view layout direction has been resolved and drawn to the
1742 * right-to-left direction.
Cibu Johny86666632010-02-22 13:01:02 -08001743 *
1744 * @hide
1745 */
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07001746 static final int LAYOUT_DIRECTION_RESOLVED_RTL = 0x00000004;
1747
1748 /**
1749 * Indicates whether the view layout direction has been resolved.
1750 *
1751 * @hide
1752 */
1753 static final int LAYOUT_DIRECTION_RESOLVED = 0x00000008;
1754
Cibu Johny86666632010-02-22 13:01:02 -08001755
Christopher Tate3d4bf172011-03-28 16:16:46 -07001756 /* End of masks for mPrivateFlags2 */
1757
1758 static final int DRAG_MASK = DRAG_CAN_ACCEPT | DRAG_HOVERED;
1759
Chet Haasedaf98e92011-01-10 14:10:36 -08001760 /**
Adam Powell637d3372010-08-25 14:37:03 -07001761 * Always allow a user to over-scroll this view, provided it is a
1762 * view that can scroll.
1763 *
1764 * @see #getOverScrollMode()
1765 * @see #setOverScrollMode(int)
1766 */
1767 public static final int OVER_SCROLL_ALWAYS = 0;
1768
1769 /**
1770 * Allow a user to over-scroll this view only if the content is large
1771 * enough to meaningfully scroll, provided it is a view that can scroll.
1772 *
1773 * @see #getOverScrollMode()
1774 * @see #setOverScrollMode(int)
1775 */
1776 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1;
1777
1778 /**
1779 * Never allow a user to over-scroll this view.
1780 *
1781 * @see #getOverScrollMode()
1782 * @see #setOverScrollMode(int)
1783 */
1784 public static final int OVER_SCROLL_NEVER = 2;
1785
1786 /**
Daniel Sandler60ee2562011-07-22 12:34:33 -04001787 * View has requested the system UI (status bar) to be visible (the default).
Joe Onorato664644d2011-01-23 17:53:23 -08001788 *
Joe Malin32736f02011-01-19 16:14:20 -08001789 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08001790 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04001791 public static final int SYSTEM_UI_FLAG_VISIBLE = 0;
Joe Onorato664644d2011-01-23 17:53:23 -08001792
1793 /**
Daniel Sandler60ee2562011-07-22 12:34:33 -04001794 * View has requested the system UI to enter an unobtrusive "low profile" mode.
1795 *
1796 * This is for use in games, book readers, video players, or any other "immersive" application
1797 * where the usual system chrome is deemed too distracting.
1798 *
1799 * In low profile mode, the status bar and/or navigation icons may dim.
Joe Onorato664644d2011-01-23 17:53:23 -08001800 *
Joe Malin32736f02011-01-19 16:14:20 -08001801 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08001802 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04001803 public static final int SYSTEM_UI_FLAG_LOW_PROFILE = 0x00000001;
1804
1805 /**
1806 * View has requested that the system navigation be temporarily hidden.
1807 *
1808 * This is an even less obtrusive state than that called for by
1809 * {@link #SYSTEM_UI_FLAG_LOW_PROFILE}; on devices that draw essential navigation controls
1810 * (Home, Back, and the like) on screen, <code>SYSTEM_UI_FLAG_HIDE_NAVIGATION</code> will cause
1811 * those to disappear. This is useful (in conjunction with the
1812 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN FLAG_FULLSCREEN} and
1813 * {@link android.view.WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN FLAG_LAYOUT_IN_SCREEN}
1814 * window flags) for displaying content using every last pixel on the display.
1815 *
1816 * There is a limitation: because navigation controls are so important, the least user
1817 * interaction will cause them to reappear immediately.
1818 *
1819 * @see #setSystemUiVisibility(int)
1820 */
1821 public static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 0x00000002;
1822
1823 /**
1824 * @deprecated Use {@link #SYSTEM_UI_FLAG_LOW_PROFILE} instead.
1825 */
1826 public static final int STATUS_BAR_HIDDEN = SYSTEM_UI_FLAG_LOW_PROFILE;
1827
1828 /**
1829 * @deprecated Use {@link #SYSTEM_UI_FLAG_VISIBLE} instead.
1830 */
1831 public static final int STATUS_BAR_VISIBLE = SYSTEM_UI_FLAG_VISIBLE;
Joe Onorato664644d2011-01-23 17:53:23 -08001832
1833 /**
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001834 * @hide
1835 *
1836 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1837 * out of the public fields to keep the undefined bits out of the developer's way.
1838 *
1839 * Flag to make the status bar not expandable. Unless you also
1840 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show.
1841 */
1842 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000;
1843
1844 /**
1845 * @hide
1846 *
1847 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1848 * out of the public fields to keep the undefined bits out of the developer's way.
1849 *
1850 * Flag to hide notification icons and scrolling ticker text.
1851 */
1852 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000;
1853
1854 /**
1855 * @hide
1856 *
1857 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1858 * out of the public fields to keep the undefined bits out of the developer's way.
1859 *
1860 * Flag to disable incoming notification alerts. This will not block
1861 * icons, but it will block sound, vibrating and other visual or aural notifications.
1862 */
1863 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000;
1864
1865 /**
1866 * @hide
1867 *
1868 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1869 * out of the public fields to keep the undefined bits out of the developer's way.
1870 *
1871 * Flag to hide only the scrolling ticker. Note that
1872 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies
1873 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}.
1874 */
1875 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000;
1876
1877 /**
1878 * @hide
1879 *
1880 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1881 * out of the public fields to keep the undefined bits out of the developer's way.
1882 *
1883 * Flag to hide the center system info area.
1884 */
1885 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000;
1886
1887 /**
1888 * @hide
1889 *
1890 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1891 * out of the public fields to keep the undefined bits out of the developer's way.
1892 *
1893 * Flag to hide only the navigation buttons. Don't use this
1894 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
Joe Onorato6478adc2011-01-27 21:15:01 -08001895 *
1896 * THIS DOES NOT DISABLE THE BACK BUTTON
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001897 */
1898 public static final int STATUS_BAR_DISABLE_NAVIGATION = 0x00200000;
1899
1900 /**
1901 * @hide
1902 *
1903 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1904 * out of the public fields to keep the undefined bits out of the developer's way.
1905 *
Joe Onorato6478adc2011-01-27 21:15:01 -08001906 * Flag to hide only the back button. Don't use this
1907 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
1908 */
1909 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000;
1910
1911 /**
1912 * @hide
1913 *
1914 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
1915 * out of the public fields to keep the undefined bits out of the developer's way.
1916 *
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001917 * Flag to hide only the clock. You might use this if your activity has
1918 * its own clock making the status bar's clock redundant.
1919 */
Joe Onorato6478adc2011-01-27 21:15:01 -08001920 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000;
1921
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001922 /**
1923 * @hide
1924 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04001925 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = 0x0000FFFF;
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08001926
1927 /**
Adam Powell637d3372010-08-25 14:37:03 -07001928 * Controls the over-scroll mode for this view.
1929 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)},
1930 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS},
1931 * and {@link #OVER_SCROLL_NEVER}.
1932 */
1933 private int mOverScrollMode;
1934
1935 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001936 * The parent this view is attached to.
1937 * {@hide}
1938 *
1939 * @see #getParent()
1940 */
1941 protected ViewParent mParent;
1942
1943 /**
1944 * {@hide}
1945 */
1946 AttachInfo mAttachInfo;
1947
1948 /**
1949 * {@hide}
1950 */
Romain Guy809a7f62009-05-14 15:44:42 -07001951 @ViewDebug.ExportedProperty(flagMapping = {
1952 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT,
1953 name = "FORCE_LAYOUT"),
1954 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED,
1955 name = "LAYOUT_REQUIRED"),
1956 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07001957 name = "DRAWING_CACHE_INVALID", outputIf = false),
Romain Guy809a7f62009-05-14 15:44:42 -07001958 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true),
1959 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false),
1960 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
1961 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY")
1962 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001963 int mPrivateFlags;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001964 int mPrivateFlags2;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001965
1966 /**
Joe Onorato664644d2011-01-23 17:53:23 -08001967 * This view's request for the visibility of the status bar.
1968 * @hide
1969 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04001970 @ViewDebug.ExportedProperty(flagMapping = {
1971 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_LOW_PROFILE,
1972 equals = SYSTEM_UI_FLAG_LOW_PROFILE,
1973 name = "SYSTEM_UI_FLAG_LOW_PROFILE", outputIf = true),
1974 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_HIDE_NAVIGATION,
1975 equals = SYSTEM_UI_FLAG_HIDE_NAVIGATION,
1976 name = "SYSTEM_UI_FLAG_HIDE_NAVIGATION", outputIf = true),
1977 @ViewDebug.FlagToString(mask = PUBLIC_STATUS_BAR_VISIBILITY_MASK,
1978 equals = SYSTEM_UI_FLAG_VISIBLE,
1979 name = "SYSTEM_UI_FLAG_VISIBLE", outputIf = true)
1980 })
Joe Onorato664644d2011-01-23 17:53:23 -08001981 int mSystemUiVisibility;
1982
1983 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001984 * Count of how many windows this view has been attached to.
1985 */
1986 int mWindowAttachCount;
1987
1988 /**
1989 * The layout parameters associated with this view and used by the parent
1990 * {@link android.view.ViewGroup} to determine how this view should be
1991 * laid out.
1992 * {@hide}
1993 */
1994 protected ViewGroup.LayoutParams mLayoutParams;
1995
1996 /**
1997 * The view flags hold various views states.
1998 * {@hide}
1999 */
2000 @ViewDebug.ExportedProperty
2001 int mViewFlags;
2002
2003 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07002004 * The transform matrix for the View. This transform is calculated internally
2005 * based on the rotation, scaleX, and scaleY properties. The identity matrix
2006 * is used by default. Do *not* use this variable directly; instead call
2007 * getMatrix(), which will automatically recalculate the matrix if necessary
2008 * to get the correct matrix based on the latest rotation and scale properties.
2009 */
2010 private final Matrix mMatrix = new Matrix();
2011
2012 /**
2013 * The transform matrix for the View. This transform is calculated internally
2014 * based on the rotation, scaleX, and scaleY properties. The identity matrix
2015 * is used by default. Do *not* use this variable directly; instead call
Jeff Brown86671742010-09-30 20:00:15 -07002016 * getInverseMatrix(), which will automatically recalculate the matrix if necessary
Chet Haasec3aa3612010-06-17 08:50:37 -07002017 * to get the correct matrix based on the latest rotation and scale properties.
2018 */
2019 private Matrix mInverseMatrix;
2020
2021 /**
2022 * An internal variable that tracks whether we need to recalculate the
2023 * transform matrix, based on whether the rotation or scaleX/Y properties
2024 * have changed since the matrix was last calculated.
2025 */
Chet Haasea00f3862011-02-22 06:34:40 -08002026 boolean mMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07002027
2028 /**
2029 * An internal variable that tracks whether we need to recalculate the
2030 * transform matrix, based on whether the rotation or scaleX/Y properties
2031 * have changed since the matrix was last calculated.
2032 */
2033 private boolean mInverseMatrixDirty = true;
2034
2035 /**
2036 * A variable that tracks whether we need to recalculate the
2037 * transform matrix, based on whether the rotation or scaleX/Y properties
2038 * have changed since the matrix was last calculated. This variable
Jeff Brown86671742010-09-30 20:00:15 -07002039 * is only valid after a call to updateMatrix() or to a function that
2040 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix().
Chet Haasec3aa3612010-06-17 08:50:37 -07002041 */
Romain Guy33e72ae2010-07-17 12:40:29 -07002042 private boolean mMatrixIsIdentity = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07002043
2044 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07002045 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set.
2046 */
2047 private Camera mCamera = null;
2048
2049 /**
2050 * This matrix is used when computing the matrix for 3D rotations.
2051 */
2052 private Matrix matrix3D = null;
2053
2054 /**
2055 * These prev values are used to recalculate a centered pivot point when necessary. The
2056 * pivot point is only used in matrix operations (when rotation, scale, or translation are
2057 * set), so thes values are only used then as well.
2058 */
2059 private int mPrevWidth = -1;
2060 private int mPrevHeight = -1;
2061
Joe Malin32736f02011-01-19 16:14:20 -08002062 private boolean mLastIsOpaque;
2063
Chet Haasefd2b0022010-08-06 13:08:56 -07002064 /**
2065 * Convenience value to check for float values that are close enough to zero to be considered
2066 * zero.
2067 */
Romain Guy2542d192010-08-18 11:47:12 -07002068 private static final float NONZERO_EPSILON = .001f;
Chet Haasefd2b0022010-08-06 13:08:56 -07002069
2070 /**
2071 * The degrees rotation around the vertical axis through the pivot point.
2072 */
2073 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002074 float mRotationY = 0f;
Chet Haasefd2b0022010-08-06 13:08:56 -07002075
2076 /**
2077 * The degrees rotation around the horizontal axis through the pivot point.
2078 */
2079 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002080 float mRotationX = 0f;
Chet Haasefd2b0022010-08-06 13:08:56 -07002081
2082 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07002083 * The degrees rotation around the pivot point.
2084 */
2085 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002086 float mRotation = 0f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002087
2088 /**
Chet Haasedf030d22010-07-30 17:22:38 -07002089 * The amount of translation of the object away from its left property (post-layout).
2090 */
2091 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002092 float mTranslationX = 0f;
Chet Haasedf030d22010-07-30 17:22:38 -07002093
2094 /**
2095 * The amount of translation of the object away from its top property (post-layout).
2096 */
2097 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002098 float mTranslationY = 0f;
Chet Haasedf030d22010-07-30 17:22:38 -07002099
2100 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07002101 * The amount of scale in the x direction around the pivot point. A
2102 * value of 1 means no scaling is applied.
2103 */
2104 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002105 float mScaleX = 1f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002106
2107 /**
2108 * The amount of scale in the y direction around the pivot point. A
2109 * value of 1 means no scaling is applied.
2110 */
2111 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002112 float mScaleY = 1f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002113
2114 /**
2115 * The amount of scale in the x direction around the pivot point. A
2116 * value of 1 means no scaling is applied.
2117 */
2118 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002119 float mPivotX = 0f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002120
2121 /**
2122 * The amount of scale in the y direction around the pivot point. A
2123 * value of 1 means no scaling is applied.
2124 */
2125 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002126 float mPivotY = 0f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002127
2128 /**
2129 * The opacity of the View. This is a value from 0 to 1, where 0 means
2130 * completely transparent and 1 means completely opaque.
2131 */
2132 @ViewDebug.ExportedProperty
Chet Haasea00f3862011-02-22 06:34:40 -08002133 float mAlpha = 1f;
Chet Haasec3aa3612010-06-17 08:50:37 -07002134
2135 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002136 * The distance in pixels from the left edge of this view's parent
2137 * to the left edge of this view.
2138 * {@hide}
2139 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002140 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002141 protected int mLeft;
2142 /**
2143 * The distance in pixels from the left edge of this view's parent
2144 * to the right edge of this view.
2145 * {@hide}
2146 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002147 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002148 protected int mRight;
2149 /**
2150 * The distance in pixels from the top edge of this view's parent
2151 * to the top edge of this view.
2152 * {@hide}
2153 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002154 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002155 protected int mTop;
2156 /**
2157 * The distance in pixels from the top edge of this view's parent
2158 * to the bottom edge of this view.
2159 * {@hide}
2160 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002161 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002162 protected int mBottom;
2163
2164 /**
2165 * The offset, in pixels, by which the content of this view is scrolled
2166 * horizontally.
2167 * {@hide}
2168 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002169 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002170 protected int mScrollX;
2171 /**
2172 * The offset, in pixels, by which the content of this view is scrolled
2173 * vertically.
2174 * {@hide}
2175 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002176 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002177 protected int mScrollY;
2178
2179 /**
2180 * The left padding in pixels, that is the distance in pixels between the
2181 * left edge of this view and the left edge of its content.
2182 * {@hide}
2183 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002184 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002185 protected int mPaddingLeft;
2186 /**
2187 * The right padding in pixels, that is the distance in pixels between the
2188 * right edge of this view and the right edge of its content.
2189 * {@hide}
2190 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002191 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002192 protected int mPaddingRight;
2193 /**
2194 * The top padding in pixels, that is the distance in pixels between the
2195 * top edge of this view and the top edge of its content.
2196 * {@hide}
2197 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002198 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002199 protected int mPaddingTop;
2200 /**
2201 * The bottom padding in pixels, that is the distance in pixels between the
2202 * bottom edge of this view and the bottom edge of its content.
2203 * {@hide}
2204 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002205 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002206 protected int mPaddingBottom;
2207
2208 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002209 * Briefly describes the view and is primarily used for accessibility support.
2210 */
2211 private CharSequence mContentDescription;
2212
2213 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002214 * Cache the paddingRight set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002215 *
2216 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002217 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002218 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002219 protected int mUserPaddingRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002220
2221 /**
2222 * Cache the paddingBottom set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002223 *
2224 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002225 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002226 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002227 protected int mUserPaddingBottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002228
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002229 /**
Adam Powell20232d02010-12-08 21:08:53 -08002230 * Cache the paddingLeft set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002231 *
2232 * @hide
Adam Powell20232d02010-12-08 21:08:53 -08002233 */
2234 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002235 protected int mUserPaddingLeft;
Adam Powell20232d02010-12-08 21:08:53 -08002236
2237 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07002238 * Cache if the user padding is relative.
2239 *
2240 */
2241 @ViewDebug.ExportedProperty(category = "padding")
2242 boolean mUserPaddingRelative;
2243
2244 /**
2245 * Cache the paddingStart set by the user to append to the scrollbar's size.
2246 *
2247 */
2248 @ViewDebug.ExportedProperty(category = "padding")
2249 int mUserPaddingStart;
2250
2251 /**
2252 * Cache the paddingEnd set by the user to append to the scrollbar's size.
2253 *
2254 */
2255 @ViewDebug.ExportedProperty(category = "padding")
2256 int mUserPaddingEnd;
2257
2258 /**
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002259 * @hide
2260 */
2261 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
2262 /**
2263 * @hide
2264 */
2265 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002266
2267 private Resources mResources = null;
2268
2269 private Drawable mBGDrawable;
2270
2271 private int mBackgroundResource;
2272 private boolean mBackgroundSizeChanged;
2273
2274 /**
2275 * Listener used to dispatch focus change events.
2276 * This field should be made private, so it is hidden from the SDK.
2277 * {@hide}
2278 */
2279 protected OnFocusChangeListener mOnFocusChangeListener;
2280
2281 /**
Chet Haase21cd1382010-09-01 17:42:29 -07002282 * Listeners for layout change events.
2283 */
2284 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
2285
2286 /**
Adam Powell4afd62b2011-02-18 15:02:18 -08002287 * Listeners for attach events.
2288 */
2289 private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners;
2290
2291 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002292 * Listener used to dispatch click events.
2293 * This field should be made private, so it is hidden from the SDK.
2294 * {@hide}
2295 */
2296 protected OnClickListener mOnClickListener;
2297
2298 /**
2299 * Listener used to dispatch long click events.
2300 * This field should be made private, so it is hidden from the SDK.
2301 * {@hide}
2302 */
2303 protected OnLongClickListener mOnLongClickListener;
2304
2305 /**
2306 * Listener used to build the context menu.
2307 * This field should be made private, so it is hidden from the SDK.
2308 * {@hide}
2309 */
2310 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
2311
2312 private OnKeyListener mOnKeyListener;
2313
2314 private OnTouchListener mOnTouchListener;
2315
Jeff Brown10b62902011-06-20 16:40:37 -07002316 private OnHoverListener mOnHoverListener;
2317
Jeff Brown33bbfd22011-02-24 20:55:35 -08002318 private OnGenericMotionListener mOnGenericMotionListener;
2319
Chris Tate32affef2010-10-18 15:29:21 -07002320 private OnDragListener mOnDragListener;
2321
Joe Onorato664644d2011-01-23 17:53:23 -08002322 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener;
2323
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002324 /**
2325 * The application environment this view lives in.
2326 * This field should be made private, so it is hidden from the SDK.
2327 * {@hide}
2328 */
2329 protected Context mContext;
2330
2331 private ScrollabilityCache mScrollCache;
2332
2333 private int[] mDrawableState = null;
2334
Romain Guy0211a0a2011-02-14 16:34:59 -08002335 /**
2336 * Set to true when drawing cache is enabled and cannot be created.
2337 *
2338 * @hide
2339 */
2340 public boolean mCachingFailed;
2341
Romain Guy02890fd2010-08-06 17:58:44 -07002342 private Bitmap mDrawingCache;
2343 private Bitmap mUnscaledDrawingCache;
Romain Guy6c319ca2011-01-11 14:29:25 -08002344 private HardwareLayer mHardwareLayer;
Romain Guy65b345f2011-07-27 18:51:50 -07002345 DisplayList mDisplayList;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002346
2347 /**
2348 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
2349 * the user may specify which view to go to next.
2350 */
2351 private int mNextFocusLeftId = View.NO_ID;
2352
2353 /**
2354 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
2355 * the user may specify which view to go to next.
2356 */
2357 private int mNextFocusRightId = View.NO_ID;
2358
2359 /**
2360 * When this view has focus and the next focus is {@link #FOCUS_UP},
2361 * the user may specify which view to go to next.
2362 */
2363 private int mNextFocusUpId = View.NO_ID;
2364
2365 /**
2366 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
2367 * the user may specify which view to go to next.
2368 */
2369 private int mNextFocusDownId = View.NO_ID;
2370
Jeff Brown4e6319b2010-12-13 10:36:51 -08002371 /**
2372 * When this view has focus and the next focus is {@link #FOCUS_FORWARD},
2373 * the user may specify which view to go to next.
2374 */
2375 int mNextFocusForwardId = View.NO_ID;
2376
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002377 private CheckForLongPress mPendingCheckForLongPress;
Adam Powelle14579b2009-12-16 18:39:52 -08002378 private CheckForTap mPendingCheckForTap = null;
Adam Powella35d7682010-03-12 14:48:13 -08002379 private PerformClick mPerformClick;
Svetoslav Ganova0156172011-06-26 17:55:44 -07002380 private SendViewScrolledAccessibilityEvent mSendViewScrolledAccessibilityEvent;
Joe Malin32736f02011-01-19 16:14:20 -08002381
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002382 private UnsetPressedState mUnsetPressedState;
2383
2384 /**
2385 * Whether the long press's action has been invoked. The tap's action is invoked on the
2386 * up event while a long press is invoked as soon as the long press duration is reached, so
2387 * a long press could be performed before the tap is checked, in which case the tap's action
2388 * should not be invoked.
2389 */
2390 private boolean mHasPerformedLongPress;
2391
2392 /**
2393 * The minimum height of the view. We'll try our best to have the height
2394 * of this view to at least this amount.
2395 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002396 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002397 private int mMinHeight;
2398
2399 /**
2400 * The minimum width of the view. We'll try our best to have the width
2401 * of this view to at least this amount.
2402 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002403 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002404 private int mMinWidth;
2405
2406 /**
2407 * The delegate to handle touch events that are physically in this view
2408 * but should be handled by another view.
2409 */
2410 private TouchDelegate mTouchDelegate = null;
2411
2412 /**
2413 * Solid color to use as a background when creating the drawing cache. Enables
2414 * the cache to use 16 bit bitmaps instead of 32 bit.
2415 */
2416 private int mDrawingCacheBackgroundColor = 0;
2417
2418 /**
2419 * Special tree observer used when mAttachInfo is null.
2420 */
2421 private ViewTreeObserver mFloatingTreeObserver;
Joe Malin32736f02011-01-19 16:14:20 -08002422
Adam Powelle14579b2009-12-16 18:39:52 -08002423 /**
2424 * Cache the touch slop from the context that created the view.
2425 */
2426 private int mTouchSlop;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002427
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002428 /**
Chet Haasea00f3862011-02-22 06:34:40 -08002429 * Object that handles automatic animation of view properties.
2430 */
2431 private ViewPropertyAnimator mAnimator = null;
2432
2433 /**
Christopher Tate251602f2011-01-28 17:54:12 -08002434 * Flag indicating that a drag can cross window boundaries. When
2435 * {@link #startDrag(ClipData, DragShadowBuilder, Object, int)} is called
2436 * with this flag set, all visible applications will be able to participate
2437 * in the drag operation and receive the dragged content.
Christopher Tate7f9ff9d2011-02-14 17:31:13 -08002438 *
2439 * @hide
Christopher Tate02d2b3b2011-01-10 20:43:53 -08002440 */
2441 public static final int DRAG_FLAG_GLOBAL = 1;
2442
2443 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08002444 * Vertical scroll factor cached by {@link #getVerticalScrollFactor}.
2445 */
2446 private float mVerticalScrollFactor;
2447
2448 /**
Adam Powell20232d02010-12-08 21:08:53 -08002449 * Position of the vertical scroll bar.
2450 */
2451 private int mVerticalScrollbarPosition;
2452
2453 /**
2454 * Position the scroll bar at the default position as determined by the system.
2455 */
2456 public static final int SCROLLBAR_POSITION_DEFAULT = 0;
2457
2458 /**
2459 * Position the scroll bar along the left edge.
2460 */
2461 public static final int SCROLLBAR_POSITION_LEFT = 1;
2462
2463 /**
2464 * Position the scroll bar along the right edge.
2465 */
2466 public static final int SCROLLBAR_POSITION_RIGHT = 2;
2467
2468 /**
Romain Guy171c5922011-01-06 10:04:23 -08002469 * Indicates that the view does not have a layer.
Joe Malin32736f02011-01-19 16:14:20 -08002470 *
2471 * @see #getLayerType()
2472 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08002473 * @see #LAYER_TYPE_SOFTWARE
Joe Malin32736f02011-01-19 16:14:20 -08002474 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08002475 */
2476 public static final int LAYER_TYPE_NONE = 0;
2477
2478 /**
2479 * <p>Indicates that the view has a software layer. A software layer is backed
2480 * by a bitmap and causes the view to be rendered using Android's software
2481 * rendering pipeline, even if hardware acceleration is enabled.</p>
Joe Malin32736f02011-01-19 16:14:20 -08002482 *
Romain Guy171c5922011-01-06 10:04:23 -08002483 * <p>Software layers have various usages:</p>
2484 * <p>When the application is not using hardware acceleration, a software layer
2485 * is useful to apply a specific color filter and/or blending mode and/or
2486 * translucency to a view and all its children.</p>
2487 * <p>When the application is using hardware acceleration, a software layer
2488 * is useful to render drawing primitives not supported by the hardware
2489 * accelerated pipeline. It can also be used to cache a complex view tree
2490 * into a texture and reduce the complexity of drawing operations. For instance,
2491 * when animating a complex view tree with a translation, a software layer can
2492 * be used to render the view tree only once.</p>
2493 * <p>Software layers should be avoided when the affected view tree updates
2494 * often. Every update will require to re-render the software layer, which can
2495 * potentially be slow (particularly when hardware acceleration is turned on
2496 * since the layer will have to be uploaded into a hardware texture after every
2497 * update.)</p>
Joe Malin32736f02011-01-19 16:14:20 -08002498 *
2499 * @see #getLayerType()
2500 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08002501 * @see #LAYER_TYPE_NONE
Joe Malin32736f02011-01-19 16:14:20 -08002502 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08002503 */
2504 public static final int LAYER_TYPE_SOFTWARE = 1;
2505
2506 /**
2507 * <p>Indicates that the view has a hardware layer. A hardware layer is backed
2508 * by a hardware specific texture (generally Frame Buffer Objects or FBO on
2509 * OpenGL hardware) and causes the view to be rendered using Android's hardware
2510 * rendering pipeline, but only if hardware acceleration is turned on for the
2511 * view hierarchy. When hardware acceleration is turned off, hardware layers
2512 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p>
Joe Malin32736f02011-01-19 16:14:20 -08002513 *
Romain Guy171c5922011-01-06 10:04:23 -08002514 * <p>A hardware layer is useful to apply a specific color filter and/or
2515 * blending mode and/or translucency to a view and all its children.</p>
Romain Guy6c319ca2011-01-11 14:29:25 -08002516 * <p>A hardware layer can be used to cache a complex view tree into a
2517 * texture and reduce the complexity of drawing operations. For instance,
2518 * when animating a complex view tree with a translation, a hardware layer can
2519 * be used to render the view tree only once.</p>
Romain Guy171c5922011-01-06 10:04:23 -08002520 * <p>A hardware layer can also be used to increase the rendering quality when
2521 * rotation transformations are applied on a view. It can also be used to
2522 * prevent potential clipping issues when applying 3D transforms on a view.</p>
Joe Malin32736f02011-01-19 16:14:20 -08002523 *
2524 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -08002525 * @see #setLayerType(int, android.graphics.Paint)
2526 * @see #LAYER_TYPE_NONE
2527 * @see #LAYER_TYPE_SOFTWARE
2528 */
2529 public static final int LAYER_TYPE_HARDWARE = 2;
Joe Malin32736f02011-01-19 16:14:20 -08002530
Romain Guy3aaff3a2011-01-12 14:18:47 -08002531 @ViewDebug.ExportedProperty(category = "drawing", mapping = {
2532 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"),
2533 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"),
2534 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE")
2535 })
Romain Guy171c5922011-01-06 10:04:23 -08002536 int mLayerType = LAYER_TYPE_NONE;
2537 Paint mLayerPaint;
Romain Guy3a3133d2011-02-01 22:59:58 -08002538 Rect mLocalDirtyRect;
Romain Guy171c5922011-01-06 10:04:23 -08002539
2540 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07002541 * Set to true when the view is sending hover accessibility events because it
2542 * is the innermost hovered view.
2543 */
2544 private boolean mSendingHoverAccessibilityEvents;
2545
2546 /**
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002547 * Text direction is inherited thru {@link ViewGroup}
2548 * @hide
2549 */
2550 public static final int TEXT_DIRECTION_INHERIT = 0;
2551
2552 /**
2553 * Text direction is using "first strong algorithm". The first strong directional character
2554 * determines the paragraph direction. If there is no strong directional character, the
Doug Feltcb3791202011-07-07 11:57:48 -07002555 * paragraph direction is the view's resolved ayout direction.
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002556 *
2557 * @hide
2558 */
2559 public static final int TEXT_DIRECTION_FIRST_STRONG = 1;
2560
2561 /**
2562 * Text direction is using "any-RTL" algorithm. The paragraph direction is RTL if it contains
2563 * any strong RTL character, otherwise it is LTR if it contains any strong LTR characters.
Doug Feltcb3791202011-07-07 11:57:48 -07002564 * If there are neither, the paragraph direction is the view's resolved layout direction.
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002565 *
2566 * @hide
2567 */
2568 public static final int TEXT_DIRECTION_ANY_RTL = 2;
2569
2570 /**
Fabrice Di Meglio8f502652011-06-29 20:40:43 -07002571 * Text direction is the same as the one held by a 60% majority of the characters. If there is
2572 * no majority then the paragraph direction is the resolved layout direction of the View.
2573 *
2574 * @hide
2575 */
2576 public static final int TEXT_DIRECTION_CHAR_COUNT = 3;
2577
2578 /**
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002579 * Text direction is forced to LTR.
2580 *
2581 * @hide
2582 */
Fabrice Di Meglio8f502652011-06-29 20:40:43 -07002583 public static final int TEXT_DIRECTION_LTR = 4;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002584
2585 /**
2586 * Text direction is forced to RTL.
2587 *
2588 * @hide
2589 */
Fabrice Di Meglio8f502652011-06-29 20:40:43 -07002590 public static final int TEXT_DIRECTION_RTL = 5;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002591
2592 /**
2593 * Default text direction is inherited
2594 */
2595 protected static int DEFAULT_TEXT_DIRECTION = TEXT_DIRECTION_INHERIT;
2596
2597 /**
Fabrice Di Meglio8f502652011-06-29 20:40:43 -07002598 * Default threshold for "char count" heuristic.
2599 */
2600 protected static float DEFAULT_TEXT_DIRECTION_CHAR_COUNT_THRESHOLD = 0.6f;
2601
2602 /**
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002603 * The text direction that has been defined by {@link #setTextDirection(int)}.
2604 *
2605 * {@hide}
2606 */
2607 @ViewDebug.ExportedProperty(category = "text", mapping = {
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002608 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"),
2609 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"),
2610 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"),
Fabrice Di Meglio8f502652011-06-29 20:40:43 -07002611 @ViewDebug.IntToString(from = TEXT_DIRECTION_CHAR_COUNT, to = "CHAR_COUNT"),
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002612 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"),
2613 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL")
2614 })
Doug Feltcb3791202011-07-07 11:57:48 -07002615 private int mTextDirection = DEFAULT_TEXT_DIRECTION;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002616
2617 /**
Doug Feltcb3791202011-07-07 11:57:48 -07002618 * The resolved text direction. This needs resolution if the value is
2619 * TEXT_DIRECTION_INHERIT. The resolution matches mTextDirection if that is
2620 * not TEXT_DIRECTION_INHERIT, otherwise resolution proceeds up the parent
2621 * chain of the view.
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002622 *
2623 * {@hide}
2624 */
2625 @ViewDebug.ExportedProperty(category = "text", mapping = {
Doug Feltcb3791202011-07-07 11:57:48 -07002626 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"),
2627 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"),
2628 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"),
2629 @ViewDebug.IntToString(from = TEXT_DIRECTION_CHAR_COUNT, to = "CHAR_COUNT"),
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002630 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"),
2631 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL")
2632 })
Doug Feltcb3791202011-07-07 11:57:48 -07002633 private int mResolvedTextDirection = TEXT_DIRECTION_INHERIT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07002634
2635 /**
Jeff Brown21bc5c92011-02-28 18:27:14 -08002636 * Consistency verifier for debugging purposes.
2637 * @hide
2638 */
2639 protected final InputEventConsistencyVerifier mInputEventConsistencyVerifier =
2640 InputEventConsistencyVerifier.isInstrumentationEnabled() ?
2641 new InputEventConsistencyVerifier(this, 0) : null;
2642
2643 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002644 * Simple constructor to use when creating a view from code.
2645 *
2646 * @param context The Context the view is running in, through which it can
2647 * access the current theme, resources, etc.
2648 */
2649 public View(Context context) {
2650 mContext = context;
2651 mResources = context != null ? context.getResources() : null;
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002652 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED | LAYOUT_DIRECTION_INHERIT;
Adam Powelle14579b2009-12-16 18:39:52 -08002653 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop();
Adam Powell637d3372010-08-25 14:37:03 -07002654 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS);
Fabrice Di Megliof9e36502011-06-21 18:41:48 -07002655 mUserPaddingStart = -1;
2656 mUserPaddingEnd = -1;
2657 mUserPaddingRelative = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002658 }
2659
2660 /**
2661 * Constructor that is called when inflating a view from XML. This is called
2662 * when a view is being constructed from an XML file, supplying attributes
2663 * that were specified in the XML file. This version uses a default style of
2664 * 0, so the only attribute values applied are those in the Context's Theme
2665 * and the given AttributeSet.
2666 *
2667 * <p>
2668 * The method onFinishInflate() will be called after all children have been
2669 * added.
2670 *
2671 * @param context The Context the view is running in, through which it can
2672 * access the current theme, resources, etc.
2673 * @param attrs The attributes of the XML tag that is inflating the view.
2674 * @see #View(Context, AttributeSet, int)
2675 */
2676 public View(Context context, AttributeSet attrs) {
2677 this(context, attrs, 0);
2678 }
2679
2680 /**
2681 * Perform inflation from XML and apply a class-specific base style. This
2682 * constructor of View allows subclasses to use their own base style when
2683 * they are inflating. For example, a Button class's constructor would call
2684 * this version of the super class constructor and supply
2685 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
2686 * the theme's button style to modify all of the base view attributes (in
2687 * particular its background) as well as the Button class's attributes.
2688 *
2689 * @param context The Context the view is running in, through which it can
2690 * access the current theme, resources, etc.
2691 * @param attrs The attributes of the XML tag that is inflating the view.
2692 * @param defStyle The default style to apply to this view. If 0, no style
2693 * will be applied (beyond what is included in the theme). This may
2694 * either be an attribute resource, whose value will be retrieved
2695 * from the current theme, or an explicit style resource.
2696 * @see #View(Context, AttributeSet)
2697 */
2698 public View(Context context, AttributeSet attrs, int defStyle) {
2699 this(context);
2700
2701 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
2702 defStyle, 0);
2703
2704 Drawable background = null;
2705
2706 int leftPadding = -1;
2707 int topPadding = -1;
2708 int rightPadding = -1;
2709 int bottomPadding = -1;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07002710 int startPadding = -1;
2711 int endPadding = -1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002712
2713 int padding = -1;
2714
2715 int viewFlagValues = 0;
2716 int viewFlagMasks = 0;
2717
2718 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07002719
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002720 int x = 0;
2721 int y = 0;
2722
Chet Haase73066682010-11-29 15:55:32 -08002723 float tx = 0;
2724 float ty = 0;
2725 float rotation = 0;
2726 float rotationX = 0;
2727 float rotationY = 0;
2728 float sx = 1f;
2729 float sy = 1f;
2730 boolean transformSet = false;
2731
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002732 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
2733
Adam Powell637d3372010-08-25 14:37:03 -07002734 int overScrollMode = mOverScrollMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002735 final int N = a.getIndexCount();
2736 for (int i = 0; i < N; i++) {
2737 int attr = a.getIndex(i);
2738 switch (attr) {
2739 case com.android.internal.R.styleable.View_background:
2740 background = a.getDrawable(attr);
2741 break;
2742 case com.android.internal.R.styleable.View_padding:
2743 padding = a.getDimensionPixelSize(attr, -1);
2744 break;
2745 case com.android.internal.R.styleable.View_paddingLeft:
2746 leftPadding = a.getDimensionPixelSize(attr, -1);
2747 break;
2748 case com.android.internal.R.styleable.View_paddingTop:
2749 topPadding = a.getDimensionPixelSize(attr, -1);
2750 break;
2751 case com.android.internal.R.styleable.View_paddingRight:
2752 rightPadding = a.getDimensionPixelSize(attr, -1);
2753 break;
2754 case com.android.internal.R.styleable.View_paddingBottom:
2755 bottomPadding = a.getDimensionPixelSize(attr, -1);
2756 break;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07002757 case com.android.internal.R.styleable.View_paddingStart:
2758 startPadding = a.getDimensionPixelSize(attr, -1);
2759 break;
2760 case com.android.internal.R.styleable.View_paddingEnd:
2761 endPadding = a.getDimensionPixelSize(attr, -1);
2762 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002763 case com.android.internal.R.styleable.View_scrollX:
2764 x = a.getDimensionPixelOffset(attr, 0);
2765 break;
2766 case com.android.internal.R.styleable.View_scrollY:
2767 y = a.getDimensionPixelOffset(attr, 0);
2768 break;
Chet Haase73066682010-11-29 15:55:32 -08002769 case com.android.internal.R.styleable.View_alpha:
2770 setAlpha(a.getFloat(attr, 1f));
2771 break;
2772 case com.android.internal.R.styleable.View_transformPivotX:
2773 setPivotX(a.getDimensionPixelOffset(attr, 0));
2774 break;
2775 case com.android.internal.R.styleable.View_transformPivotY:
2776 setPivotY(a.getDimensionPixelOffset(attr, 0));
2777 break;
2778 case com.android.internal.R.styleable.View_translationX:
2779 tx = a.getDimensionPixelOffset(attr, 0);
2780 transformSet = true;
2781 break;
2782 case com.android.internal.R.styleable.View_translationY:
2783 ty = a.getDimensionPixelOffset(attr, 0);
2784 transformSet = true;
2785 break;
2786 case com.android.internal.R.styleable.View_rotation:
2787 rotation = a.getFloat(attr, 0);
2788 transformSet = true;
2789 break;
2790 case com.android.internal.R.styleable.View_rotationX:
2791 rotationX = a.getFloat(attr, 0);
2792 transformSet = true;
2793 break;
2794 case com.android.internal.R.styleable.View_rotationY:
2795 rotationY = a.getFloat(attr, 0);
2796 transformSet = true;
2797 break;
2798 case com.android.internal.R.styleable.View_scaleX:
2799 sx = a.getFloat(attr, 1f);
2800 transformSet = true;
2801 break;
2802 case com.android.internal.R.styleable.View_scaleY:
2803 sy = a.getFloat(attr, 1f);
2804 transformSet = true;
2805 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002806 case com.android.internal.R.styleable.View_id:
2807 mID = a.getResourceId(attr, NO_ID);
2808 break;
2809 case com.android.internal.R.styleable.View_tag:
2810 mTag = a.getText(attr);
2811 break;
2812 case com.android.internal.R.styleable.View_fitsSystemWindows:
2813 if (a.getBoolean(attr, false)) {
2814 viewFlagValues |= FITS_SYSTEM_WINDOWS;
2815 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
2816 }
2817 break;
2818 case com.android.internal.R.styleable.View_focusable:
2819 if (a.getBoolean(attr, false)) {
2820 viewFlagValues |= FOCUSABLE;
2821 viewFlagMasks |= FOCUSABLE_MASK;
2822 }
2823 break;
2824 case com.android.internal.R.styleable.View_focusableInTouchMode:
2825 if (a.getBoolean(attr, false)) {
2826 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
2827 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
2828 }
2829 break;
2830 case com.android.internal.R.styleable.View_clickable:
2831 if (a.getBoolean(attr, false)) {
2832 viewFlagValues |= CLICKABLE;
2833 viewFlagMasks |= CLICKABLE;
2834 }
2835 break;
2836 case com.android.internal.R.styleable.View_longClickable:
2837 if (a.getBoolean(attr, false)) {
2838 viewFlagValues |= LONG_CLICKABLE;
2839 viewFlagMasks |= LONG_CLICKABLE;
2840 }
2841 break;
2842 case com.android.internal.R.styleable.View_saveEnabled:
2843 if (!a.getBoolean(attr, true)) {
2844 viewFlagValues |= SAVE_DISABLED;
2845 viewFlagMasks |= SAVE_DISABLED_MASK;
2846 }
2847 break;
2848 case com.android.internal.R.styleable.View_duplicateParentState:
2849 if (a.getBoolean(attr, false)) {
2850 viewFlagValues |= DUPLICATE_PARENT_STATE;
2851 viewFlagMasks |= DUPLICATE_PARENT_STATE;
2852 }
2853 break;
2854 case com.android.internal.R.styleable.View_visibility:
2855 final int visibility = a.getInt(attr, 0);
2856 if (visibility != 0) {
2857 viewFlagValues |= VISIBILITY_FLAGS[visibility];
2858 viewFlagMasks |= VISIBILITY_MASK;
2859 }
2860 break;
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002861 case com.android.internal.R.styleable.View_layoutDirection:
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07002862 // Clear any HORIZONTAL_DIRECTION flag already set
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002863 viewFlagValues &= ~LAYOUT_DIRECTION_MASK;
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07002864 // Set the HORIZONTAL_DIRECTION flags depending on the value of the attribute
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002865 final int layoutDirection = a.getInt(attr, -1);
2866 if (layoutDirection != -1) {
2867 viewFlagValues |= LAYOUT_DIRECTION_FLAGS[layoutDirection];
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07002868 } else {
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002869 // Set to default (LAYOUT_DIRECTION_INHERIT)
2870 viewFlagValues |= LAYOUT_DIRECTION_DEFAULT;
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07002871 }
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07002872 viewFlagMasks |= LAYOUT_DIRECTION_MASK;
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07002873 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002874 case com.android.internal.R.styleable.View_drawingCacheQuality:
2875 final int cacheQuality = a.getInt(attr, 0);
2876 if (cacheQuality != 0) {
2877 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
2878 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
2879 }
2880 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07002881 case com.android.internal.R.styleable.View_contentDescription:
2882 mContentDescription = a.getString(attr);
2883 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002884 case com.android.internal.R.styleable.View_soundEffectsEnabled:
2885 if (!a.getBoolean(attr, true)) {
2886 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
2887 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
2888 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002889 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002890 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
2891 if (!a.getBoolean(attr, true)) {
2892 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
2893 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
2894 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07002895 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002896 case R.styleable.View_scrollbars:
2897 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
2898 if (scrollbars != SCROLLBARS_NONE) {
2899 viewFlagValues |= scrollbars;
2900 viewFlagMasks |= SCROLLBARS_MASK;
2901 initializeScrollbars(a);
2902 }
2903 break;
2904 case R.styleable.View_fadingEdge:
2905 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
2906 if (fadingEdge != FADING_EDGE_NONE) {
2907 viewFlagValues |= fadingEdge;
2908 viewFlagMasks |= FADING_EDGE_MASK;
2909 initializeFadingEdge(a);
2910 }
2911 break;
2912 case R.styleable.View_scrollbarStyle:
2913 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
2914 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
2915 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
2916 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
2917 }
2918 break;
2919 case R.styleable.View_isScrollContainer:
2920 setScrollContainer = true;
2921 if (a.getBoolean(attr, false)) {
2922 setScrollContainer(true);
2923 }
2924 break;
2925 case com.android.internal.R.styleable.View_keepScreenOn:
2926 if (a.getBoolean(attr, false)) {
2927 viewFlagValues |= KEEP_SCREEN_ON;
2928 viewFlagMasks |= KEEP_SCREEN_ON;
2929 }
2930 break;
Jeff Brown85a31762010-09-01 17:01:00 -07002931 case R.styleable.View_filterTouchesWhenObscured:
2932 if (a.getBoolean(attr, false)) {
2933 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED;
2934 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED;
2935 }
2936 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002937 case R.styleable.View_nextFocusLeft:
2938 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
2939 break;
2940 case R.styleable.View_nextFocusRight:
2941 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
2942 break;
2943 case R.styleable.View_nextFocusUp:
2944 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
2945 break;
2946 case R.styleable.View_nextFocusDown:
2947 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
2948 break;
Jeff Brown4e6319b2010-12-13 10:36:51 -08002949 case R.styleable.View_nextFocusForward:
2950 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID);
2951 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002952 case R.styleable.View_minWidth:
2953 mMinWidth = a.getDimensionPixelSize(attr, 0);
2954 break;
2955 case R.styleable.View_minHeight:
2956 mMinHeight = a.getDimensionPixelSize(attr, 0);
2957 break;
Romain Guy9a817362009-05-01 10:57:14 -07002958 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07002959 if (context.isRestricted()) {
Joe Malin32736f02011-01-19 16:14:20 -08002960 throw new IllegalStateException("The android:onClick attribute cannot "
Romain Guy870e09f2009-07-06 16:35:25 -07002961 + "be used within a restricted context");
2962 }
2963
Romain Guy9a817362009-05-01 10:57:14 -07002964 final String handlerName = a.getString(attr);
2965 if (handlerName != null) {
2966 setOnClickListener(new OnClickListener() {
2967 private Method mHandler;
2968
2969 public void onClick(View v) {
2970 if (mHandler == null) {
2971 try {
2972 mHandler = getContext().getClass().getMethod(handlerName,
2973 View.class);
2974 } catch (NoSuchMethodException e) {
Joe Onorato42e14d72010-03-11 14:51:17 -08002975 int id = getId();
2976 String idText = id == NO_ID ? "" : " with id '"
2977 + getContext().getResources().getResourceEntryName(
2978 id) + "'";
Romain Guy9a817362009-05-01 10:57:14 -07002979 throw new IllegalStateException("Could not find a method " +
Joe Onorato42e14d72010-03-11 14:51:17 -08002980 handlerName + "(View) in the activity "
2981 + getContext().getClass() + " for onClick handler"
2982 + " on view " + View.this.getClass() + idText, e);
Romain Guy9a817362009-05-01 10:57:14 -07002983 }
2984 }
2985
2986 try {
2987 mHandler.invoke(getContext(), View.this);
2988 } catch (IllegalAccessException e) {
2989 throw new IllegalStateException("Could not execute non "
2990 + "public method of the activity", e);
2991 } catch (InvocationTargetException e) {
2992 throw new IllegalStateException("Could not execute "
2993 + "method of the activity", e);
2994 }
2995 }
2996 });
2997 }
2998 break;
Adam Powell637d3372010-08-25 14:37:03 -07002999 case R.styleable.View_overScrollMode:
3000 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS);
3001 break;
Adam Powell20232d02010-12-08 21:08:53 -08003002 case R.styleable.View_verticalScrollbarPosition:
3003 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT);
3004 break;
Romain Guy171c5922011-01-06 10:04:23 -08003005 case R.styleable.View_layerType:
3006 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null);
3007 break;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07003008 case R.styleable.View_textDirection:
3009 mTextDirection = a.getInt(attr, DEFAULT_TEXT_DIRECTION);
3010 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003011 }
3012 }
3013
Adam Powell637d3372010-08-25 14:37:03 -07003014 setOverScrollMode(overScrollMode);
3015
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003016 if (background != null) {
3017 setBackgroundDrawable(background);
3018 }
3019
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003020 mUserPaddingRelative = (startPadding >= 0 || endPadding >= 0);
3021
Fabrice Di Megliof9e36502011-06-21 18:41:48 -07003022 // Cache user padding as we cannot fully resolve padding here (we dont have yet the resolved
3023 // layout direction). Those cached values will be used later during padding resolution.
3024 mUserPaddingStart = startPadding;
3025 mUserPaddingEnd = endPadding;
3026
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003027 if (padding >= 0) {
3028 leftPadding = padding;
3029 topPadding = padding;
3030 rightPadding = padding;
3031 bottomPadding = padding;
3032 }
3033
3034 // If the user specified the padding (either with android:padding or
3035 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
3036 // use the default padding or the padding from the background drawable
3037 // (stored at this point in mPadding*)
3038 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
3039 topPadding >= 0 ? topPadding : mPaddingTop,
3040 rightPadding >= 0 ? rightPadding : mPaddingRight,
3041 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
3042
3043 if (viewFlagMasks != 0) {
3044 setFlags(viewFlagValues, viewFlagMasks);
3045 }
3046
3047 // Needs to be called after mViewFlags is set
3048 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
3049 recomputePadding();
3050 }
3051
3052 if (x != 0 || y != 0) {
3053 scrollTo(x, y);
3054 }
3055
Chet Haase73066682010-11-29 15:55:32 -08003056 if (transformSet) {
3057 setTranslationX(tx);
3058 setTranslationY(ty);
3059 setRotation(rotation);
3060 setRotationX(rotationX);
3061 setRotationY(rotationY);
3062 setScaleX(sx);
3063 setScaleY(sy);
3064 }
3065
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003066 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
3067 setScrollContainer(true);
3068 }
Romain Guy8f1344f52009-05-15 16:03:59 -07003069
3070 computeOpaqueFlags();
3071
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003072 a.recycle();
3073 }
3074
3075 /**
3076 * Non-public constructor for use in testing
3077 */
3078 View() {
3079 }
3080
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003081 /**
3082 * <p>
3083 * Initializes the fading edges from a given set of styled attributes. This
3084 * method should be called by subclasses that need fading edges and when an
3085 * instance of these subclasses is created programmatically rather than
3086 * being inflated from XML. This method is automatically called when the XML
3087 * is inflated.
3088 * </p>
3089 *
3090 * @param a the styled attributes set to initialize the fading edges from
3091 */
3092 protected void initializeFadingEdge(TypedArray a) {
3093 initScrollCache();
3094
3095 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
3096 R.styleable.View_fadingEdgeLength,
3097 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
3098 }
3099
3100 /**
3101 * Returns the size of the vertical faded edges used to indicate that more
3102 * content in this view is visible.
3103 *
3104 * @return The size in pixels of the vertical faded edge or 0 if vertical
3105 * faded edges are not enabled for this view.
3106 * @attr ref android.R.styleable#View_fadingEdgeLength
3107 */
3108 public int getVerticalFadingEdgeLength() {
3109 if (isVerticalFadingEdgeEnabled()) {
3110 ScrollabilityCache cache = mScrollCache;
3111 if (cache != null) {
3112 return cache.fadingEdgeLength;
3113 }
3114 }
3115 return 0;
3116 }
3117
3118 /**
3119 * Set the size of the faded edge used to indicate that more content in this
3120 * view is available. Will not change whether the fading edge is enabled; use
Romain Guy5c22a8c2011-05-13 11:48:45 -07003121 * {@link #setVerticalFadingEdgeEnabled(boolean)} or
3122 * {@link #setHorizontalFadingEdgeEnabled(boolean)} to enable the fading edge
3123 * for the vertical or horizontal fading edges.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003124 *
3125 * @param length The size in pixels of the faded edge used to indicate that more
3126 * content in this view is visible.
3127 */
3128 public void setFadingEdgeLength(int length) {
3129 initScrollCache();
3130 mScrollCache.fadingEdgeLength = length;
3131 }
3132
3133 /**
3134 * Returns the size of the horizontal faded edges used to indicate that more
3135 * content in this view is visible.
3136 *
3137 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
3138 * faded edges are not enabled for this view.
3139 * @attr ref android.R.styleable#View_fadingEdgeLength
3140 */
3141 public int getHorizontalFadingEdgeLength() {
3142 if (isHorizontalFadingEdgeEnabled()) {
3143 ScrollabilityCache cache = mScrollCache;
3144 if (cache != null) {
3145 return cache.fadingEdgeLength;
3146 }
3147 }
3148 return 0;
3149 }
3150
3151 /**
3152 * Returns the width of the vertical scrollbar.
3153 *
3154 * @return The width in pixels of the vertical scrollbar or 0 if there
3155 * is no vertical scrollbar.
3156 */
3157 public int getVerticalScrollbarWidth() {
3158 ScrollabilityCache cache = mScrollCache;
3159 if (cache != null) {
3160 ScrollBarDrawable scrollBar = cache.scrollBar;
3161 if (scrollBar != null) {
3162 int size = scrollBar.getSize(true);
3163 if (size <= 0) {
3164 size = cache.scrollBarSize;
3165 }
3166 return size;
3167 }
3168 return 0;
3169 }
3170 return 0;
3171 }
3172
3173 /**
3174 * Returns the height of the horizontal scrollbar.
3175 *
3176 * @return The height in pixels of the horizontal scrollbar or 0 if
3177 * there is no horizontal scrollbar.
3178 */
3179 protected int getHorizontalScrollbarHeight() {
3180 ScrollabilityCache cache = mScrollCache;
3181 if (cache != null) {
3182 ScrollBarDrawable scrollBar = cache.scrollBar;
3183 if (scrollBar != null) {
3184 int size = scrollBar.getSize(false);
3185 if (size <= 0) {
3186 size = cache.scrollBarSize;
3187 }
3188 return size;
3189 }
3190 return 0;
3191 }
3192 return 0;
3193 }
3194
3195 /**
3196 * <p>
3197 * Initializes the scrollbars from a given set of styled attributes. This
3198 * method should be called by subclasses that need scrollbars and when an
3199 * instance of these subclasses is created programmatically rather than
3200 * being inflated from XML. This method is automatically called when the XML
3201 * is inflated.
3202 * </p>
3203 *
3204 * @param a the styled attributes set to initialize the scrollbars from
3205 */
3206 protected void initializeScrollbars(TypedArray a) {
3207 initScrollCache();
3208
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003209 final ScrollabilityCache scrollabilityCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08003210
Mike Cleronf116bf82009-09-27 19:14:12 -07003211 if (scrollabilityCache.scrollBar == null) {
3212 scrollabilityCache.scrollBar = new ScrollBarDrawable();
3213 }
Joe Malin32736f02011-01-19 16:14:20 -08003214
Romain Guy8bda2482010-03-02 11:42:11 -08003215 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003216
Mike Cleronf116bf82009-09-27 19:14:12 -07003217 if (!fadeScrollbars) {
3218 scrollabilityCache.state = ScrollabilityCache.ON;
3219 }
3220 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Joe Malin32736f02011-01-19 16:14:20 -08003221
3222
Mike Cleronf116bf82009-09-27 19:14:12 -07003223 scrollabilityCache.scrollBarFadeDuration = a.getInt(
3224 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
3225 .getScrollBarFadeDuration());
3226 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
3227 R.styleable.View_scrollbarDefaultDelayBeforeFade,
3228 ViewConfiguration.getScrollDefaultDelay());
3229
Joe Malin32736f02011-01-19 16:14:20 -08003230
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003231 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
3232 com.android.internal.R.styleable.View_scrollbarSize,
3233 ViewConfiguration.get(mContext).getScaledScrollBarSize());
3234
3235 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
3236 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
3237
3238 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
3239 if (thumb != null) {
3240 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
3241 }
3242
3243 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
3244 false);
3245 if (alwaysDraw) {
3246 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
3247 }
3248
3249 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
3250 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
3251
3252 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
3253 if (thumb != null) {
3254 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
3255 }
3256
3257 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
3258 false);
3259 if (alwaysDraw) {
3260 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
3261 }
3262
3263 // Re-apply user/background padding so that scrollbar(s) get added
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003264 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003265 }
3266
3267 /**
3268 * <p>
3269 * Initalizes the scrollability cache if necessary.
3270 * </p>
3271 */
3272 private void initScrollCache() {
3273 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07003274 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003275 }
3276 }
3277
3278 /**
Adam Powell20232d02010-12-08 21:08:53 -08003279 * Set the position of the vertical scroll bar. Should be one of
3280 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or
3281 * {@link #SCROLLBAR_POSITION_RIGHT}.
3282 *
3283 * @param position Where the vertical scroll bar should be positioned.
3284 */
3285 public void setVerticalScrollbarPosition(int position) {
3286 if (mVerticalScrollbarPosition != position) {
3287 mVerticalScrollbarPosition = position;
3288 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003289 resolvePadding();
Adam Powell20232d02010-12-08 21:08:53 -08003290 }
3291 }
3292
3293 /**
3294 * @return The position where the vertical scroll bar will show, if applicable.
3295 * @see #setVerticalScrollbarPosition(int)
3296 */
3297 public int getVerticalScrollbarPosition() {
3298 return mVerticalScrollbarPosition;
3299 }
3300
3301 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003302 * Register a callback to be invoked when focus of this view changed.
3303 *
3304 * @param l The callback that will run.
3305 */
3306 public void setOnFocusChangeListener(OnFocusChangeListener l) {
3307 mOnFocusChangeListener = l;
3308 }
3309
3310 /**
Chet Haase21cd1382010-09-01 17:42:29 -07003311 * Add a listener that will be called when the bounds of the view change due to
3312 * layout processing.
3313 *
3314 * @param listener The listener that will be called when layout bounds change.
3315 */
3316 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) {
3317 if (mOnLayoutChangeListeners == null) {
3318 mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>();
3319 }
3320 mOnLayoutChangeListeners.add(listener);
3321 }
3322
3323 /**
3324 * Remove a listener for layout changes.
3325 *
3326 * @param listener The listener for layout bounds change.
3327 */
3328 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) {
3329 if (mOnLayoutChangeListeners == null) {
3330 return;
3331 }
3332 mOnLayoutChangeListeners.remove(listener);
3333 }
3334
3335 /**
Adam Powell4afd62b2011-02-18 15:02:18 -08003336 * Add a listener for attach state changes.
3337 *
3338 * This listener will be called whenever this view is attached or detached
3339 * from a window. Remove the listener using
3340 * {@link #removeOnAttachStateChangeListener(OnAttachStateChangeListener)}.
3341 *
3342 * @param listener Listener to attach
3343 * @see #removeOnAttachStateChangeListener(OnAttachStateChangeListener)
3344 */
3345 public void addOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
3346 if (mOnAttachStateChangeListeners == null) {
3347 mOnAttachStateChangeListeners = new CopyOnWriteArrayList<OnAttachStateChangeListener>();
3348 }
3349 mOnAttachStateChangeListeners.add(listener);
3350 }
3351
3352 /**
3353 * Remove a listener for attach state changes. The listener will receive no further
3354 * notification of window attach/detach events.
3355 *
3356 * @param listener Listener to remove
3357 * @see #addOnAttachStateChangeListener(OnAttachStateChangeListener)
3358 */
3359 public void removeOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
3360 if (mOnAttachStateChangeListeners == null) {
3361 return;
3362 }
3363 mOnAttachStateChangeListeners.remove(listener);
3364 }
3365
3366 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003367 * Returns the focus-change callback registered for this view.
3368 *
3369 * @return The callback, or null if one is not registered.
3370 */
3371 public OnFocusChangeListener getOnFocusChangeListener() {
3372 return mOnFocusChangeListener;
3373 }
3374
3375 /**
3376 * Register a callback to be invoked when this view is clicked. If this view is not
3377 * clickable, it becomes clickable.
3378 *
3379 * @param l The callback that will run
3380 *
3381 * @see #setClickable(boolean)
3382 */
3383 public void setOnClickListener(OnClickListener l) {
3384 if (!isClickable()) {
3385 setClickable(true);
3386 }
3387 mOnClickListener = l;
3388 }
3389
3390 /**
3391 * Register a callback to be invoked when this view is clicked and held. If this view is not
3392 * long clickable, it becomes long clickable.
3393 *
3394 * @param l The callback that will run
3395 *
3396 * @see #setLongClickable(boolean)
3397 */
3398 public void setOnLongClickListener(OnLongClickListener l) {
3399 if (!isLongClickable()) {
3400 setLongClickable(true);
3401 }
3402 mOnLongClickListener = l;
3403 }
3404
3405 /**
3406 * Register a callback to be invoked when the context menu for this view is
3407 * being built. If this view is not long clickable, it becomes long clickable.
3408 *
3409 * @param l The callback that will run
3410 *
3411 */
3412 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
3413 if (!isLongClickable()) {
3414 setLongClickable(true);
3415 }
3416 mOnCreateContextMenuListener = l;
3417 }
3418
3419 /**
3420 * Call this view's OnClickListener, if it is defined.
3421 *
3422 * @return True there was an assigned OnClickListener that was called, false
3423 * otherwise is returned.
3424 */
3425 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003426 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
3427
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003428 if (mOnClickListener != null) {
3429 playSoundEffect(SoundEffectConstants.CLICK);
3430 mOnClickListener.onClick(this);
3431 return true;
3432 }
3433
3434 return false;
3435 }
3436
3437 /**
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003438 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the
3439 * OnLongClickListener did not consume the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003440 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003441 * @return True if one of the above receivers consumed the event, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003442 */
3443 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003444 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
3445
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003446 boolean handled = false;
3447 if (mOnLongClickListener != null) {
3448 handled = mOnLongClickListener.onLongClick(View.this);
3449 }
3450 if (!handled) {
3451 handled = showContextMenu();
3452 }
3453 if (handled) {
3454 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
3455 }
3456 return handled;
3457 }
3458
3459 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07003460 * Performs button-related actions during a touch down event.
3461 *
3462 * @param event The event.
3463 * @return True if the down was consumed.
3464 *
3465 * @hide
3466 */
3467 protected boolean performButtonActionOnTouchDown(MotionEvent event) {
3468 if ((event.getButtonState() & MotionEvent.BUTTON_SECONDARY) != 0) {
3469 if (showContextMenu(event.getX(), event.getY(), event.getMetaState())) {
3470 return true;
3471 }
3472 }
3473 return false;
3474 }
3475
3476 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003477 * Bring up the context menu for this view.
3478 *
3479 * @return Whether a context menu was displayed.
3480 */
3481 public boolean showContextMenu() {
3482 return getParent().showContextMenuForChild(this);
3483 }
3484
3485 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07003486 * Bring up the context menu for this view, referring to the item under the specified point.
3487 *
3488 * @param x The referenced x coordinate.
3489 * @param y The referenced y coordinate.
3490 * @param metaState The keyboard modifiers that were pressed.
3491 * @return Whether a context menu was displayed.
3492 *
3493 * @hide
3494 */
3495 public boolean showContextMenu(float x, float y, int metaState) {
3496 return showContextMenu();
3497 }
3498
3499 /**
Adam Powell6e346362010-07-23 10:18:23 -07003500 * Start an action mode.
3501 *
3502 * @param callback Callback that will control the lifecycle of the action mode
3503 * @return The new action mode if it is started, null otherwise
3504 *
3505 * @see ActionMode
3506 */
3507 public ActionMode startActionMode(ActionMode.Callback callback) {
3508 return getParent().startActionModeForChild(this, callback);
3509 }
3510
3511 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003512 * Register a callback to be invoked when a key is pressed in this view.
3513 * @param l the key listener to attach to this view
3514 */
3515 public void setOnKeyListener(OnKeyListener l) {
3516 mOnKeyListener = l;
3517 }
3518
3519 /**
3520 * Register a callback to be invoked when a touch event is sent to this view.
3521 * @param l the touch listener to attach to this view
3522 */
3523 public void setOnTouchListener(OnTouchListener l) {
3524 mOnTouchListener = l;
3525 }
3526
3527 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08003528 * Register a callback to be invoked when a generic motion event is sent to this view.
3529 * @param l the generic motion listener to attach to this view
3530 */
3531 public void setOnGenericMotionListener(OnGenericMotionListener l) {
3532 mOnGenericMotionListener = l;
3533 }
3534
3535 /**
Jeff Brown53ca3f12011-06-27 18:36:00 -07003536 * Register a callback to be invoked when a hover event is sent to this view.
3537 * @param l the hover listener to attach to this view
3538 */
3539 public void setOnHoverListener(OnHoverListener l) {
3540 mOnHoverListener = l;
3541 }
3542
3543 /**
Joe Malin32736f02011-01-19 16:14:20 -08003544 * Register a drag event listener callback object for this View. The parameter is
3545 * an implementation of {@link android.view.View.OnDragListener}. To send a drag event to a
3546 * View, the system calls the
3547 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent)} method.
3548 * @param l An implementation of {@link android.view.View.OnDragListener}.
Chris Tate32affef2010-10-18 15:29:21 -07003549 */
3550 public void setOnDragListener(OnDragListener l) {
3551 mOnDragListener = l;
3552 }
3553
3554 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07003555 * Give this view focus. This will cause
3556 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003557 *
3558 * Note: this does not check whether this {@link View} should get focus, it just
3559 * gives it focus no matter what. It should only be called internally by framework
3560 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
3561 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08003562 * @param direction values are {@link View#FOCUS_UP}, {@link View#FOCUS_DOWN},
3563 * {@link View#FOCUS_LEFT} or {@link View#FOCUS_RIGHT}. This is the direction which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003564 * focus moved when requestFocus() is called. It may not always
3565 * apply, in which case use the default View.FOCUS_DOWN.
3566 * @param previouslyFocusedRect The rectangle of the view that had focus
3567 * prior in this View's coordinate system.
3568 */
3569 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
3570 if (DBG) {
3571 System.out.println(this + " requestFocus()");
3572 }
3573
3574 if ((mPrivateFlags & FOCUSED) == 0) {
3575 mPrivateFlags |= FOCUSED;
3576
3577 if (mParent != null) {
3578 mParent.requestChildFocus(this, this);
3579 }
3580
3581 onFocusChanged(true, direction, previouslyFocusedRect);
3582 refreshDrawableState();
3583 }
3584 }
3585
3586 /**
3587 * Request that a rectangle of this view be visible on the screen,
3588 * scrolling if necessary just enough.
3589 *
3590 * <p>A View should call this if it maintains some notion of which part
3591 * of its content is interesting. For example, a text editing view
3592 * should call this when its cursor moves.
3593 *
3594 * @param rectangle The rectangle.
3595 * @return Whether any parent scrolled.
3596 */
3597 public boolean requestRectangleOnScreen(Rect rectangle) {
3598 return requestRectangleOnScreen(rectangle, false);
3599 }
3600
3601 /**
3602 * Request that a rectangle of this view be visible on the screen,
3603 * scrolling if necessary just enough.
3604 *
3605 * <p>A View should call this if it maintains some notion of which part
3606 * of its content is interesting. For example, a text editing view
3607 * should call this when its cursor moves.
3608 *
3609 * <p>When <code>immediate</code> is set to true, scrolling will not be
3610 * animated.
3611 *
3612 * @param rectangle The rectangle.
3613 * @param immediate True to forbid animated scrolling, false otherwise
3614 * @return Whether any parent scrolled.
3615 */
3616 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
3617 View child = this;
3618 ViewParent parent = mParent;
3619 boolean scrolled = false;
3620 while (parent != null) {
3621 scrolled |= parent.requestChildRectangleOnScreen(child,
3622 rectangle, immediate);
3623
3624 // offset rect so next call has the rectangle in the
3625 // coordinate system of its direct child.
3626 rectangle.offset(child.getLeft(), child.getTop());
3627 rectangle.offset(-child.getScrollX(), -child.getScrollY());
3628
3629 if (!(parent instanceof View)) {
3630 break;
3631 }
Romain Guy8506ab42009-06-11 17:35:47 -07003632
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003633 child = (View) parent;
3634 parent = child.getParent();
3635 }
3636 return scrolled;
3637 }
3638
3639 /**
3640 * Called when this view wants to give up focus. This will cause
Romain Guy5c22a8c2011-05-13 11:48:45 -07003641 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003642 */
3643 public void clearFocus() {
3644 if (DBG) {
3645 System.out.println(this + " clearFocus()");
3646 }
3647
3648 if ((mPrivateFlags & FOCUSED) != 0) {
3649 mPrivateFlags &= ~FOCUSED;
3650
3651 if (mParent != null) {
3652 mParent.clearChildFocus(this);
3653 }
3654
3655 onFocusChanged(false, 0, null);
3656 refreshDrawableState();
3657 }
3658 }
3659
3660 /**
3661 * Called to clear the focus of a view that is about to be removed.
3662 * Doesn't call clearChildFocus, which prevents this view from taking
3663 * focus again before it has been removed from the parent
3664 */
3665 void clearFocusForRemoval() {
3666 if ((mPrivateFlags & FOCUSED) != 0) {
3667 mPrivateFlags &= ~FOCUSED;
3668
3669 onFocusChanged(false, 0, null);
3670 refreshDrawableState();
3671 }
3672 }
3673
3674 /**
3675 * Called internally by the view system when a new view is getting focus.
3676 * This is what clears the old focus.
3677 */
3678 void unFocus() {
3679 if (DBG) {
3680 System.out.println(this + " unFocus()");
3681 }
3682
3683 if ((mPrivateFlags & FOCUSED) != 0) {
3684 mPrivateFlags &= ~FOCUSED;
3685
3686 onFocusChanged(false, 0, null);
3687 refreshDrawableState();
3688 }
3689 }
3690
3691 /**
3692 * Returns true if this view has focus iteself, or is the ancestor of the
3693 * view that has focus.
3694 *
3695 * @return True if this view has or contains focus, false otherwise.
3696 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07003697 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003698 public boolean hasFocus() {
3699 return (mPrivateFlags & FOCUSED) != 0;
3700 }
3701
3702 /**
3703 * Returns true if this view is focusable or if it contains a reachable View
3704 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
3705 * is a View whose parents do not block descendants focus.
3706 *
3707 * Only {@link #VISIBLE} views are considered focusable.
3708 *
3709 * @return True if the view is focusable or if the view contains a focusable
3710 * View, false otherwise.
3711 *
3712 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
3713 */
3714 public boolean hasFocusable() {
3715 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
3716 }
3717
3718 /**
3719 * Called by the view system when the focus state of this view changes.
3720 * When the focus change event is caused by directional navigation, direction
3721 * and previouslyFocusedRect provide insight into where the focus is coming from.
3722 * When overriding, be sure to call up through to the super class so that
3723 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07003724 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003725 * @param gainFocus True if the View has focus; false otherwise.
3726 * @param direction The direction focus has moved when requestFocus()
3727 * is called to give this view focus. Values are
Jeff Brown4e6319b2010-12-13 10:36:51 -08003728 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT},
3729 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}.
3730 * It may not always apply, in which case use the default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003731 * @param previouslyFocusedRect The rectangle, in this view's coordinate
3732 * system, of the previously focused view. If applicable, this will be
3733 * passed in as finer grained information about where the focus is coming
3734 * from (in addition to direction). Will be <code>null</code> otherwise.
3735 */
3736 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07003737 if (gainFocus) {
3738 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
3739 }
3740
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003741 InputMethodManager imm = InputMethodManager.peekInstance();
3742 if (!gainFocus) {
3743 if (isPressed()) {
3744 setPressed(false);
3745 }
3746 if (imm != null && mAttachInfo != null
3747 && mAttachInfo.mHasWindowFocus) {
3748 imm.focusOut(this);
3749 }
Romain Guya2431d02009-04-30 16:30:00 -07003750 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003751 } else if (imm != null && mAttachInfo != null
3752 && mAttachInfo.mHasWindowFocus) {
3753 imm.focusIn(this);
3754 }
Romain Guy8506ab42009-06-11 17:35:47 -07003755
Romain Guy0fd89bf2011-01-26 15:41:30 -08003756 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003757 if (mOnFocusChangeListener != null) {
3758 mOnFocusChangeListener.onFocusChange(this, gainFocus);
3759 }
Joe Malin32736f02011-01-19 16:14:20 -08003760
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07003761 if (mAttachInfo != null) {
3762 mAttachInfo.mKeyDispatchState.reset(this);
3763 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003764 }
3765
3766 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07003767 * Sends an accessibility event of the given type. If accessiiblity is
3768 * not enabled this method has no effect. The default implementation calls
3769 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)} first
3770 * to populate information about the event source (this View), then calls
3771 * {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} to
3772 * populate the text content of the event source including its descendants,
3773 * and last calls
3774 * {@link ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)}
3775 * on its parent to resuest sending of the event to interested parties.
3776 *
3777 * @param eventType The type of the event to send.
3778 *
3779 * @see #onInitializeAccessibilityEvent(AccessibilityEvent)
3780 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
3781 * @see ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)
svetoslavganov75986cf2009-05-14 22:28:01 -07003782 */
3783 public void sendAccessibilityEvent(int eventType) {
3784 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
3785 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
3786 }
3787 }
3788
3789 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07003790 * This method behaves exactly as {@link #sendAccessibilityEvent(int)} but
3791 * takes as an argument an empty {@link AccessibilityEvent} and does not
3792 * perfrom a check whether accessibility is enabled.
3793 *
3794 * @param event The event to send.
3795 *
3796 * @see #sendAccessibilityEvent(int)
svetoslavganov75986cf2009-05-14 22:28:01 -07003797 */
3798 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
Svetoslav Ganov9cd1eca2011-01-13 14:24:02 -08003799 if (!isShown()) {
3800 return;
3801 }
Svetoslav Ganov30401322011-05-12 18:53:45 -07003802 onInitializeAccessibilityEvent(event);
svetoslavganov75986cf2009-05-14 22:28:01 -07003803 dispatchPopulateAccessibilityEvent(event);
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003804 // In the beginning we called #isShown(), so we know that getParent() is not null.
3805 getParent().requestSendAccessibilityEvent(this, event);
svetoslavganov75986cf2009-05-14 22:28:01 -07003806 }
3807
3808 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07003809 * Dispatches an {@link AccessibilityEvent} to the {@link View} first and then
3810 * to its children for adding their text content to the event. Note that the
3811 * event text is populated in a separate dispatch path since we add to the
3812 * event not only the text of the source but also the text of all its descendants.
3813 * </p>
3814 * A typical implementation will call
3815 * {@link #onPopulateAccessibilityEvent(AccessibilityEvent)} on the this view
3816 * and then call the {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
3817 * on each child. Override this method if custom population of the event text
3818 * content is required.
svetoslavganov75986cf2009-05-14 22:28:01 -07003819 *
3820 * @param event The event.
3821 *
3822 * @return True if the event population was completed.
3823 */
3824 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003825 onPopulateAccessibilityEvent(event);
svetoslavganov75986cf2009-05-14 22:28:01 -07003826 return false;
3827 }
3828
3829 /**
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003830 * Called from {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
Svetoslav Ganov30401322011-05-12 18:53:45 -07003831 * giving a chance to this View to populate the accessibility event with its
3832 * text content. While the implementation is free to modify other event
3833 * attributes this should be performed in
3834 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)}.
3835 * <p>
3836 * Example: Adding formatted date string to an accessibility event in addition
3837 * to the text added by the super implementation.
3838 * </p><p><pre><code>
Svetoslav Ganov30401322011-05-12 18:53:45 -07003839 * public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
3840 * super.onPopulateAccessibilityEvent(event);
3841 * final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY;
3842 * String selectedDateUtterance = DateUtils.formatDateTime(mContext,
3843 * mCurrentDate.getTimeInMillis(), flags);
3844 * event.getText().add(selectedDateUtterance);
3845 * }
3846 * </code></pre></p>
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003847 *
3848 * @param event The accessibility event which to populate.
Svetoslav Ganov30401322011-05-12 18:53:45 -07003849 *
3850 * @see #sendAccessibilityEvent(int)
3851 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003852 */
3853 public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov736c2752011-04-22 18:30:36 -07003854 }
3855
3856 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07003857 * Initializes an {@link AccessibilityEvent} with information about the
3858 * the type of the event and this View which is the event source. In other
3859 * words, the source of an accessibility event is the view whose state
3860 * change triggered firing the event.
3861 * <p>
3862 * Example: Setting the password property of an event in addition
3863 * to properties set by the super implementation.
3864 * </p><p><pre><code>
Svetoslav Ganov30401322011-05-12 18:53:45 -07003865 * public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
3866 * super.onInitializeAccessibilityEvent(event);
3867 * event.setPassword(true);
3868 * }
3869 * </code></pre></p>
3870 * @param event The event to initialeze.
3871 *
3872 * @see #sendAccessibilityEvent(int)
3873 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
3874 */
3875 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07003876 event.setSource(this);
Svetoslav Ganov30401322011-05-12 18:53:45 -07003877 event.setClassName(getClass().getName());
3878 event.setPackageName(getContext().getPackageName());
3879 event.setEnabled(isEnabled());
3880 event.setContentDescription(mContentDescription);
3881
Svetoslav Ganova0156172011-06-26 17:55:44 -07003882 final int eventType = event.getEventType();
3883 switch (eventType) {
3884 case AccessibilityEvent.TYPE_VIEW_FOCUSED: {
3885 if (mAttachInfo != null) {
3886 ArrayList<View> focusablesTempList = mAttachInfo.mFocusablesTempList;
3887 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD,
3888 FOCUSABLES_ALL);
3889 event.setItemCount(focusablesTempList.size());
3890 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
3891 focusablesTempList.clear();
3892 }
3893 } break;
3894 case AccessibilityEvent.TYPE_VIEW_SCROLLED: {
3895 event.setScrollX(mScrollX);
3896 event.setScrollY(mScrollY);
3897 event.setItemCount(getHeight());
3898 } break;
Svetoslav Ganov30401322011-05-12 18:53:45 -07003899 }
3900 }
3901
3902 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07003903 * Returns an {@link AccessibilityNodeInfo} representing this view from the
3904 * point of view of an {@link android.accessibilityservice.AccessibilityService}.
3905 * This method is responsible for obtaining an accessibility node info from a
3906 * pool of reusable instances and calling
3907 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on this view to
3908 * initialize the former.
3909 * <p>
3910 * Note: The client is responsible for recycling the obtained instance by calling
3911 * {@link AccessibilityNodeInfo#recycle()} to minimize object creation.
3912 * </p>
3913 * @return A populated {@link AccessibilityNodeInfo}.
3914 *
3915 * @see AccessibilityNodeInfo
3916 */
3917 public AccessibilityNodeInfo createAccessibilityNodeInfo() {
3918 AccessibilityNodeInfo info = AccessibilityNodeInfo.obtain(this);
3919 onInitializeAccessibilityNodeInfo(info);
3920 return info;
3921 }
3922
3923 /**
3924 * Initializes an {@link AccessibilityNodeInfo} with information about this view.
3925 * The base implementation sets:
3926 * <ul>
3927 * <li>{@link AccessibilityNodeInfo#setParent(View)},</li>
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07003928 * <li>{@link AccessibilityNodeInfo#setBoundsInParent(Rect)},</li>
3929 * <li>{@link AccessibilityNodeInfo#setBoundsInScreen(Rect)},</li>
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07003930 * <li>{@link AccessibilityNodeInfo#setPackageName(CharSequence)},</li>
3931 * <li>{@link AccessibilityNodeInfo#setClassName(CharSequence)},</li>
3932 * <li>{@link AccessibilityNodeInfo#setContentDescription(CharSequence)},</li>
3933 * <li>{@link AccessibilityNodeInfo#setEnabled(boolean)},</li>
3934 * <li>{@link AccessibilityNodeInfo#setClickable(boolean)},</li>
3935 * <li>{@link AccessibilityNodeInfo#setFocusable(boolean)},</li>
3936 * <li>{@link AccessibilityNodeInfo#setFocused(boolean)},</li>
3937 * <li>{@link AccessibilityNodeInfo#setLongClickable(boolean)},</li>
3938 * <li>{@link AccessibilityNodeInfo#setSelected(boolean)},</li>
3939 * </ul>
3940 * <p>
3941 * Subclasses should override this method, call the super implementation,
3942 * and set additional attributes.
3943 * </p>
3944 * @param info The instance to initialize.
3945 */
3946 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
3947 Rect bounds = mAttachInfo.mTmpInvalRect;
3948 getDrawingRect(bounds);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07003949 info.setBoundsInParent(bounds);
3950
3951 int[] locationOnScreen = mAttachInfo.mInvalidateChildLocation;
3952 getLocationOnScreen(locationOnScreen);
Alan Viverette326804f2011-07-22 16:20:41 -07003953 bounds.offsetTo(0, 0);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07003954 bounds.offset(locationOnScreen[0], locationOnScreen[1]);
3955 info.setBoundsInScreen(bounds);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07003956
3957 ViewParent parent = getParent();
3958 if (parent instanceof View) {
3959 View parentView = (View) parent;
3960 info.setParent(parentView);
3961 }
3962
3963 info.setPackageName(mContext.getPackageName());
3964 info.setClassName(getClass().getName());
3965 info.setContentDescription(getContentDescription());
3966
3967 info.setEnabled(isEnabled());
3968 info.setClickable(isClickable());
3969 info.setFocusable(isFocusable());
3970 info.setFocused(isFocused());
3971 info.setSelected(isSelected());
3972 info.setLongClickable(isLongClickable());
3973
3974 // TODO: These make sense only if we are in an AdapterView but all
3975 // views can be selected. Maybe from accessiiblity perspective
3976 // we should report as selectable view in an AdapterView.
3977 info.addAction(AccessibilityNodeInfo.ACTION_SELECT);
3978 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION);
3979
3980 if (isFocusable()) {
3981 if (isFocused()) {
3982 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS);
3983 } else {
3984 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS);
3985 }
3986 }
3987 }
3988
3989 /**
3990 * Gets the unique identifier of this view on the screen for accessibility purposes.
3991 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned.
3992 *
3993 * @return The view accessibility id.
3994 *
3995 * @hide
3996 */
3997 public int getAccessibilityViewId() {
3998 if (mAccessibilityViewId == NO_ID) {
3999 mAccessibilityViewId = sNextAccessibilityViewId++;
4000 }
4001 return mAccessibilityViewId;
4002 }
4003
4004 /**
4005 * Gets the unique identifier of the window in which this View reseides.
4006 *
4007 * @return The window accessibility id.
4008 *
4009 * @hide
4010 */
4011 public int getAccessibilityWindowId() {
4012 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId : NO_ID;
4013 }
4014
4015 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07004016 * Gets the {@link View} description. It briefly describes the view and is
4017 * primarily used for accessibility support. Set this property to enable
4018 * better accessibility support for your application. This is especially
4019 * true for views that do not have textual representation (For example,
4020 * ImageButton).
4021 *
4022 * @return The content descriptiopn.
4023 *
4024 * @attr ref android.R.styleable#View_contentDescription
4025 */
4026 public CharSequence getContentDescription() {
4027 return mContentDescription;
4028 }
4029
4030 /**
4031 * Sets the {@link View} description. It briefly describes the view and is
4032 * primarily used for accessibility support. Set this property to enable
4033 * better accessibility support for your application. This is especially
4034 * true for views that do not have textual representation (For example,
4035 * ImageButton).
4036 *
4037 * @param contentDescription The content description.
4038 *
4039 * @attr ref android.R.styleable#View_contentDescription
4040 */
4041 public void setContentDescription(CharSequence contentDescription) {
4042 mContentDescription = contentDescription;
4043 }
4044
4045 /**
Romain Guya2431d02009-04-30 16:30:00 -07004046 * Invoked whenever this view loses focus, either by losing window focus or by losing
4047 * focus within its window. This method can be used to clear any state tied to the
4048 * focus. For instance, if a button is held pressed with the trackball and the window
4049 * loses focus, this method can be used to cancel the press.
4050 *
4051 * Subclasses of View overriding this method should always call super.onFocusLost().
4052 *
4053 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07004054 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07004055 *
4056 * @hide pending API council approval
4057 */
4058 protected void onFocusLost() {
4059 resetPressedState();
4060 }
4061
4062 private void resetPressedState() {
4063 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4064 return;
4065 }
4066
4067 if (isPressed()) {
4068 setPressed(false);
4069
4070 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05004071 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004072 }
4073 }
4074 }
4075
4076 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004077 * Returns true if this view has focus
4078 *
4079 * @return True if this view has focus, false otherwise.
4080 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004081 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004082 public boolean isFocused() {
4083 return (mPrivateFlags & FOCUSED) != 0;
4084 }
4085
4086 /**
4087 * Find the view in the hierarchy rooted at this view that currently has
4088 * focus.
4089 *
4090 * @return The view that currently has focus, or null if no focused view can
4091 * be found.
4092 */
4093 public View findFocus() {
4094 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
4095 }
4096
4097 /**
4098 * Change whether this view is one of the set of scrollable containers in
4099 * its window. This will be used to determine whether the window can
4100 * resize or must pan when a soft input area is open -- scrollable
4101 * containers allow the window to use resize mode since the container
4102 * will appropriately shrink.
4103 */
4104 public void setScrollContainer(boolean isScrollContainer) {
4105 if (isScrollContainer) {
4106 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
4107 mAttachInfo.mScrollContainers.add(this);
4108 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
4109 }
4110 mPrivateFlags |= SCROLL_CONTAINER;
4111 } else {
4112 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
4113 mAttachInfo.mScrollContainers.remove(this);
4114 }
4115 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
4116 }
4117 }
4118
4119 /**
4120 * Returns the quality of the drawing cache.
4121 *
4122 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
4123 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
4124 *
4125 * @see #setDrawingCacheQuality(int)
4126 * @see #setDrawingCacheEnabled(boolean)
4127 * @see #isDrawingCacheEnabled()
4128 *
4129 * @attr ref android.R.styleable#View_drawingCacheQuality
4130 */
4131 public int getDrawingCacheQuality() {
4132 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
4133 }
4134
4135 /**
4136 * Set the drawing cache quality of this view. This value is used only when the
4137 * drawing cache is enabled
4138 *
4139 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
4140 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
4141 *
4142 * @see #getDrawingCacheQuality()
4143 * @see #setDrawingCacheEnabled(boolean)
4144 * @see #isDrawingCacheEnabled()
4145 *
4146 * @attr ref android.R.styleable#View_drawingCacheQuality
4147 */
4148 public void setDrawingCacheQuality(int quality) {
4149 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
4150 }
4151
4152 /**
4153 * Returns whether the screen should remain on, corresponding to the current
4154 * value of {@link #KEEP_SCREEN_ON}.
4155 *
4156 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
4157 *
4158 * @see #setKeepScreenOn(boolean)
4159 *
4160 * @attr ref android.R.styleable#View_keepScreenOn
4161 */
4162 public boolean getKeepScreenOn() {
4163 return (mViewFlags & KEEP_SCREEN_ON) != 0;
4164 }
4165
4166 /**
4167 * Controls whether the screen should remain on, modifying the
4168 * value of {@link #KEEP_SCREEN_ON}.
4169 *
4170 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
4171 *
4172 * @see #getKeepScreenOn()
4173 *
4174 * @attr ref android.R.styleable#View_keepScreenOn
4175 */
4176 public void setKeepScreenOn(boolean keepScreenOn) {
4177 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
4178 }
4179
4180 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004181 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
4182 * @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 -08004183 *
4184 * @attr ref android.R.styleable#View_nextFocusLeft
4185 */
4186 public int getNextFocusLeftId() {
4187 return mNextFocusLeftId;
4188 }
4189
4190 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004191 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
4192 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
4193 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004194 *
4195 * @attr ref android.R.styleable#View_nextFocusLeft
4196 */
4197 public void setNextFocusLeftId(int nextFocusLeftId) {
4198 mNextFocusLeftId = nextFocusLeftId;
4199 }
4200
4201 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004202 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
4203 * @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 -08004204 *
4205 * @attr ref android.R.styleable#View_nextFocusRight
4206 */
4207 public int getNextFocusRightId() {
4208 return mNextFocusRightId;
4209 }
4210
4211 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004212 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
4213 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
4214 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004215 *
4216 * @attr ref android.R.styleable#View_nextFocusRight
4217 */
4218 public void setNextFocusRightId(int nextFocusRightId) {
4219 mNextFocusRightId = nextFocusRightId;
4220 }
4221
4222 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004223 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
4224 * @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 -08004225 *
4226 * @attr ref android.R.styleable#View_nextFocusUp
4227 */
4228 public int getNextFocusUpId() {
4229 return mNextFocusUpId;
4230 }
4231
4232 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004233 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
4234 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
4235 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004236 *
4237 * @attr ref android.R.styleable#View_nextFocusUp
4238 */
4239 public void setNextFocusUpId(int nextFocusUpId) {
4240 mNextFocusUpId = nextFocusUpId;
4241 }
4242
4243 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004244 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
4245 * @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 -08004246 *
4247 * @attr ref android.R.styleable#View_nextFocusDown
4248 */
4249 public int getNextFocusDownId() {
4250 return mNextFocusDownId;
4251 }
4252
4253 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004254 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
4255 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
4256 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004257 *
4258 * @attr ref android.R.styleable#View_nextFocusDown
4259 */
4260 public void setNextFocusDownId(int nextFocusDownId) {
4261 mNextFocusDownId = nextFocusDownId;
4262 }
4263
4264 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08004265 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
4266 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
4267 *
4268 * @attr ref android.R.styleable#View_nextFocusForward
4269 */
4270 public int getNextFocusForwardId() {
4271 return mNextFocusForwardId;
4272 }
4273
4274 /**
4275 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
4276 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
4277 * decide automatically.
4278 *
4279 * @attr ref android.R.styleable#View_nextFocusForward
4280 */
4281 public void setNextFocusForwardId(int nextFocusForwardId) {
4282 mNextFocusForwardId = nextFocusForwardId;
4283 }
4284
4285 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004286 * Returns the visibility of this view and all of its ancestors
4287 *
4288 * @return True if this view and all of its ancestors are {@link #VISIBLE}
4289 */
4290 public boolean isShown() {
4291 View current = this;
4292 //noinspection ConstantConditions
4293 do {
4294 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
4295 return false;
4296 }
4297 ViewParent parent = current.mParent;
4298 if (parent == null) {
4299 return false; // We are not attached to the view root
4300 }
4301 if (!(parent instanceof View)) {
4302 return true;
4303 }
4304 current = (View) parent;
4305 } while (current != null);
4306
4307 return false;
4308 }
4309
4310 /**
4311 * Apply the insets for system windows to this view, if the FITS_SYSTEM_WINDOWS flag
4312 * is set
4313 *
4314 * @param insets Insets for system windows
4315 *
4316 * @return True if this view applied the insets, false otherwise
4317 */
4318 protected boolean fitSystemWindows(Rect insets) {
4319 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
4320 mPaddingLeft = insets.left;
4321 mPaddingTop = insets.top;
4322 mPaddingRight = insets.right;
4323 mPaddingBottom = insets.bottom;
4324 requestLayout();
4325 return true;
4326 }
4327 return false;
4328 }
4329
4330 /**
Adam Powell0bd1d0a2011-07-22 19:35:06 -07004331 * Set whether or not this view should account for system screen decorations
4332 * such as the status bar and inset its content. This allows this view to be
4333 * positioned in absolute screen coordinates and remain visible to the user.
4334 *
4335 * <p>This should only be used by top-level window decor views.
4336 *
4337 * @param fitSystemWindows true to inset content for system screen decorations, false for
4338 * default behavior.
4339 *
4340 * @attr ref android.R.styleable#View_fitsSystemWindows
4341 */
4342 public void setFitsSystemWindows(boolean fitSystemWindows) {
4343 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS);
4344 }
4345
4346 /**
4347 * Check for the FITS_SYSTEM_WINDOWS flag. If this method returns true, this view
4348 * will account for system screen decorations such as the status bar and inset its
4349 * content. This allows the view to be positioned in absolute screen coordinates
4350 * and remain visible to the user.
4351 *
4352 * @return true if this view will adjust its content bounds for system screen decorations.
4353 *
4354 * @attr ref android.R.styleable#View_fitsSystemWindows
4355 */
4356 public boolean fitsSystemWindows() {
4357 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
4358 }
4359
4360 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004361 * Returns the visibility status for this view.
4362 *
4363 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
4364 * @attr ref android.R.styleable#View_visibility
4365 */
4366 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07004367 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
4368 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
4369 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004370 })
4371 public int getVisibility() {
4372 return mViewFlags & VISIBILITY_MASK;
4373 }
4374
4375 /**
4376 * Set the enabled state of this view.
4377 *
4378 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
4379 * @attr ref android.R.styleable#View_visibility
4380 */
4381 @RemotableViewMethod
4382 public void setVisibility(int visibility) {
4383 setFlags(visibility, VISIBILITY_MASK);
4384 if (mBGDrawable != null) mBGDrawable.setVisible(visibility == VISIBLE, false);
4385 }
4386
4387 /**
4388 * Returns the enabled status for this view. The interpretation of the
4389 * enabled state varies by subclass.
4390 *
4391 * @return True if this view is enabled, false otherwise.
4392 */
4393 @ViewDebug.ExportedProperty
4394 public boolean isEnabled() {
4395 return (mViewFlags & ENABLED_MASK) == ENABLED;
4396 }
4397
4398 /**
4399 * Set the enabled state of this view. The interpretation of the enabled
4400 * state varies by subclass.
4401 *
4402 * @param enabled True if this view is enabled, false otherwise.
4403 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08004404 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004405 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07004406 if (enabled == isEnabled()) return;
4407
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004408 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
4409
4410 /*
4411 * The View most likely has to change its appearance, so refresh
4412 * the drawable state.
4413 */
4414 refreshDrawableState();
4415
4416 // Invalidate too, since the default behavior for views is to be
4417 // be drawn at 50% alpha rather than to change the drawable.
Romain Guy0fd89bf2011-01-26 15:41:30 -08004418 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004419 }
4420
4421 /**
4422 * Set whether this view can receive the focus.
4423 *
4424 * Setting this to false will also ensure that this view is not focusable
4425 * in touch mode.
4426 *
4427 * @param focusable If true, this view can receive the focus.
4428 *
4429 * @see #setFocusableInTouchMode(boolean)
4430 * @attr ref android.R.styleable#View_focusable
4431 */
4432 public void setFocusable(boolean focusable) {
4433 if (!focusable) {
4434 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
4435 }
4436 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
4437 }
4438
4439 /**
4440 * Set whether this view can receive focus while in touch mode.
4441 *
4442 * Setting this to true will also ensure that this view is focusable.
4443 *
4444 * @param focusableInTouchMode If true, this view can receive the focus while
4445 * in touch mode.
4446 *
4447 * @see #setFocusable(boolean)
4448 * @attr ref android.R.styleable#View_focusableInTouchMode
4449 */
4450 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
4451 // Focusable in touch mode should always be set before the focusable flag
4452 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
4453 // which, in touch mode, will not successfully request focus on this view
4454 // because the focusable in touch mode flag is not set
4455 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
4456 if (focusableInTouchMode) {
4457 setFlags(FOCUSABLE, FOCUSABLE_MASK);
4458 }
4459 }
4460
4461 /**
4462 * Set whether this view should have sound effects enabled for events such as
4463 * clicking and touching.
4464 *
4465 * <p>You may wish to disable sound effects for a view if you already play sounds,
4466 * for instance, a dial key that plays dtmf tones.
4467 *
4468 * @param soundEffectsEnabled whether sound effects are enabled for this view.
4469 * @see #isSoundEffectsEnabled()
4470 * @see #playSoundEffect(int)
4471 * @attr ref android.R.styleable#View_soundEffectsEnabled
4472 */
4473 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
4474 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
4475 }
4476
4477 /**
4478 * @return whether this view should have sound effects enabled for events such as
4479 * clicking and touching.
4480 *
4481 * @see #setSoundEffectsEnabled(boolean)
4482 * @see #playSoundEffect(int)
4483 * @attr ref android.R.styleable#View_soundEffectsEnabled
4484 */
4485 @ViewDebug.ExportedProperty
4486 public boolean isSoundEffectsEnabled() {
4487 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
4488 }
4489
4490 /**
4491 * Set whether this view should have haptic feedback for events such as
4492 * long presses.
4493 *
4494 * <p>You may wish to disable haptic feedback if your view already controls
4495 * its own haptic feedback.
4496 *
4497 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
4498 * @see #isHapticFeedbackEnabled()
4499 * @see #performHapticFeedback(int)
4500 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
4501 */
4502 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
4503 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
4504 }
4505
4506 /**
4507 * @return whether this view should have haptic feedback enabled for events
4508 * long presses.
4509 *
4510 * @see #setHapticFeedbackEnabled(boolean)
4511 * @see #performHapticFeedback(int)
4512 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
4513 */
4514 @ViewDebug.ExportedProperty
4515 public boolean isHapticFeedbackEnabled() {
4516 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
4517 }
4518
4519 /**
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004520 * Returns the layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08004521 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004522 * @return One of {@link #LAYOUT_DIRECTION_LTR},
4523 * {@link #LAYOUT_DIRECTION_RTL},
4524 * {@link #LAYOUT_DIRECTION_INHERIT} or
4525 * {@link #LAYOUT_DIRECTION_LOCALE}.
4526 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07004527 *
Cibu Johny7632cb92010-02-22 13:01:02 -08004528 * @hide
4529 */
Fabrice Di Megliobce84d22011-06-02 15:57:01 -07004530 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004531 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"),
4532 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"),
4533 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"),
4534 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE")
Cibu Johny7632cb92010-02-22 13:01:02 -08004535 })
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004536 public int getLayoutDirection() {
4537 return mViewFlags & LAYOUT_DIRECTION_MASK;
Cibu Johny7632cb92010-02-22 13:01:02 -08004538 }
4539
4540 /**
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07004541 * Set the layout direction for this view. This will propagate a reset of layout direction
4542 * resolution to the view's children and resolve layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08004543 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004544 * @param layoutDirection One of {@link #LAYOUT_DIRECTION_LTR},
4545 * {@link #LAYOUT_DIRECTION_RTL},
4546 * {@link #LAYOUT_DIRECTION_INHERIT} or
4547 * {@link #LAYOUT_DIRECTION_LOCALE}.
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07004548 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004549 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07004550 *
Cibu Johny7632cb92010-02-22 13:01:02 -08004551 * @hide
4552 */
4553 @RemotableViewMethod
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07004554 public void setLayoutDirection(int layoutDirection) {
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07004555 if (getLayoutDirection() != layoutDirection) {
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07004556 resetResolvedLayoutDirection();
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07004557 // Setting the flag will also request a layout.
4558 setFlags(layoutDirection, LAYOUT_DIRECTION_MASK);
4559 }
Cibu Johny7632cb92010-02-22 13:01:02 -08004560 }
4561
4562 /**
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07004563 * Returns the resolved layout direction for this view.
4564 *
4565 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns
4566 * {@link #LAYOUT_DIRECTION_LTR} id the layout direction is not RTL.
4567 *
4568 * @hide
4569 */
4570 @ViewDebug.ExportedProperty(category = "layout", mapping = {
4571 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"),
4572 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL")
4573 })
4574 public int getResolvedLayoutDirection() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07004575 resolveLayoutDirectionIfNeeded();
4576 return ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED_RTL) == LAYOUT_DIRECTION_RESOLVED_RTL) ?
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07004577 LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR;
4578 }
4579
4580 /**
4581 * <p>Indicates whether or not this view's layout is right-to-left. This is resolved from
4582 * layout attribute and/or the inherited value from the parent.</p>
4583 *
4584 * @return true if the layout is right-to-left.
4585 *
4586 * @hide
4587 */
4588 @ViewDebug.ExportedProperty(category = "layout")
4589 public boolean isLayoutRtl() {
4590 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL);
4591 }
4592
4593 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004594 * If this view doesn't do any drawing on its own, set this flag to
4595 * allow further optimizations. By default, this flag is not set on
4596 * View, but could be set on some View subclasses such as ViewGroup.
4597 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07004598 * Typically, if you override {@link #onDraw(android.graphics.Canvas)}
4599 * you should clear this flag.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004600 *
4601 * @param willNotDraw whether or not this View draw on its own
4602 */
4603 public void setWillNotDraw(boolean willNotDraw) {
4604 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
4605 }
4606
4607 /**
4608 * Returns whether or not this View draws on its own.
4609 *
4610 * @return true if this view has nothing to draw, false otherwise
4611 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004612 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004613 public boolean willNotDraw() {
4614 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
4615 }
4616
4617 /**
4618 * When a View's drawing cache is enabled, drawing is redirected to an
4619 * offscreen bitmap. Some views, like an ImageView, must be able to
4620 * bypass this mechanism if they already draw a single bitmap, to avoid
4621 * unnecessary usage of the memory.
4622 *
4623 * @param willNotCacheDrawing true if this view does not cache its
4624 * drawing, false otherwise
4625 */
4626 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
4627 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
4628 }
4629
4630 /**
4631 * Returns whether or not this View can cache its drawing or not.
4632 *
4633 * @return true if this view does not cache its drawing, false otherwise
4634 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004635 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004636 public boolean willNotCacheDrawing() {
4637 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
4638 }
4639
4640 /**
4641 * Indicates whether this view reacts to click events or not.
4642 *
4643 * @return true if the view is clickable, false otherwise
4644 *
4645 * @see #setClickable(boolean)
4646 * @attr ref android.R.styleable#View_clickable
4647 */
4648 @ViewDebug.ExportedProperty
4649 public boolean isClickable() {
4650 return (mViewFlags & CLICKABLE) == CLICKABLE;
4651 }
4652
4653 /**
4654 * Enables or disables click events for this view. When a view
4655 * is clickable it will change its state to "pressed" on every click.
4656 * Subclasses should set the view clickable to visually react to
4657 * user's clicks.
4658 *
4659 * @param clickable true to make the view clickable, false otherwise
4660 *
4661 * @see #isClickable()
4662 * @attr ref android.R.styleable#View_clickable
4663 */
4664 public void setClickable(boolean clickable) {
4665 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
4666 }
4667
4668 /**
4669 * Indicates whether this view reacts to long click events or not.
4670 *
4671 * @return true if the view is long clickable, false otherwise
4672 *
4673 * @see #setLongClickable(boolean)
4674 * @attr ref android.R.styleable#View_longClickable
4675 */
4676 public boolean isLongClickable() {
4677 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
4678 }
4679
4680 /**
4681 * Enables or disables long click events for this view. When a view is long
4682 * clickable it reacts to the user holding down the button for a longer
4683 * duration than a tap. This event can either launch the listener or a
4684 * context menu.
4685 *
4686 * @param longClickable true to make the view long clickable, false otherwise
4687 * @see #isLongClickable()
4688 * @attr ref android.R.styleable#View_longClickable
4689 */
4690 public void setLongClickable(boolean longClickable) {
4691 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
4692 }
4693
4694 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07004695 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004696 *
4697 * @see #isClickable()
4698 * @see #setClickable(boolean)
4699 *
4700 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
4701 * the View's internal state from a previously set "pressed" state.
4702 */
4703 public void setPressed(boolean pressed) {
4704 if (pressed) {
4705 mPrivateFlags |= PRESSED;
4706 } else {
4707 mPrivateFlags &= ~PRESSED;
4708 }
4709 refreshDrawableState();
4710 dispatchSetPressed(pressed);
4711 }
4712
4713 /**
4714 * Dispatch setPressed to all of this View's children.
4715 *
4716 * @see #setPressed(boolean)
4717 *
4718 * @param pressed The new pressed state
4719 */
4720 protected void dispatchSetPressed(boolean pressed) {
4721 }
4722
4723 /**
4724 * Indicates whether the view is currently in pressed state. Unless
4725 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
4726 * the pressed state.
4727 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07004728 * @see #setPressed(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004729 * @see #isClickable()
4730 * @see #setClickable(boolean)
4731 *
4732 * @return true if the view is currently pressed, false otherwise
4733 */
4734 public boolean isPressed() {
4735 return (mPrivateFlags & PRESSED) == PRESSED;
4736 }
4737
4738 /**
4739 * Indicates whether this view will save its state (that is,
4740 * whether its {@link #onSaveInstanceState} method will be called).
4741 *
4742 * @return Returns true if the view state saving is enabled, else false.
4743 *
4744 * @see #setSaveEnabled(boolean)
4745 * @attr ref android.R.styleable#View_saveEnabled
4746 */
4747 public boolean isSaveEnabled() {
4748 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
4749 }
4750
4751 /**
4752 * Controls whether the saving of this view's state is
4753 * enabled (that is, whether its {@link #onSaveInstanceState} method
4754 * will be called). Note that even if freezing is enabled, the
Romain Guy5c22a8c2011-05-13 11:48:45 -07004755 * view still must have an id assigned to it (via {@link #setId(int)})
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004756 * for its state to be saved. This flag can only disable the
4757 * saving of this view; any child views may still have their state saved.
4758 *
4759 * @param enabled Set to false to <em>disable</em> state saving, or true
4760 * (the default) to allow it.
4761 *
4762 * @see #isSaveEnabled()
4763 * @see #setId(int)
4764 * @see #onSaveInstanceState()
4765 * @attr ref android.R.styleable#View_saveEnabled
4766 */
4767 public void setSaveEnabled(boolean enabled) {
4768 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
4769 }
4770
Jeff Brown85a31762010-09-01 17:01:00 -07004771 /**
4772 * Gets whether the framework should discard touches when the view's
4773 * window is obscured by another visible window.
4774 * Refer to the {@link View} security documentation for more details.
4775 *
4776 * @return True if touch filtering is enabled.
4777 *
4778 * @see #setFilterTouchesWhenObscured(boolean)
4779 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
4780 */
4781 @ViewDebug.ExportedProperty
4782 public boolean getFilterTouchesWhenObscured() {
4783 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
4784 }
4785
4786 /**
4787 * Sets whether the framework should discard touches when the view's
4788 * window is obscured by another visible window.
4789 * Refer to the {@link View} security documentation for more details.
4790 *
4791 * @param enabled True if touch filtering should be enabled.
4792 *
4793 * @see #getFilterTouchesWhenObscured
4794 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
4795 */
4796 public void setFilterTouchesWhenObscured(boolean enabled) {
4797 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
4798 FILTER_TOUCHES_WHEN_OBSCURED);
4799 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004800
4801 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07004802 * Indicates whether the entire hierarchy under this view will save its
4803 * state when a state saving traversal occurs from its parent. The default
4804 * is true; if false, these views will not be saved unless
4805 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4806 *
4807 * @return Returns true if the view state saving from parent is enabled, else false.
4808 *
4809 * @see #setSaveFromParentEnabled(boolean)
4810 */
4811 public boolean isSaveFromParentEnabled() {
4812 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
4813 }
4814
4815 /**
4816 * Controls whether the entire hierarchy under this view will save its
4817 * state when a state saving traversal occurs from its parent. The default
4818 * is true; if false, these views will not be saved unless
4819 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
4820 *
4821 * @param enabled Set to false to <em>disable</em> state saving, or true
4822 * (the default) to allow it.
4823 *
4824 * @see #isSaveFromParentEnabled()
4825 * @see #setId(int)
4826 * @see #onSaveInstanceState()
4827 */
4828 public void setSaveFromParentEnabled(boolean enabled) {
4829 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
4830 }
4831
4832
4833 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004834 * Returns whether this View is able to take focus.
4835 *
4836 * @return True if this view can take focus, or false otherwise.
4837 * @attr ref android.R.styleable#View_focusable
4838 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004839 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004840 public final boolean isFocusable() {
4841 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
4842 }
4843
4844 /**
4845 * When a view is focusable, it may not want to take focus when in touch mode.
4846 * For example, a button would like focus when the user is navigating via a D-pad
4847 * so that the user can click on it, but once the user starts touching the screen,
4848 * the button shouldn't take focus
4849 * @return Whether the view is focusable in touch mode.
4850 * @attr ref android.R.styleable#View_focusableInTouchMode
4851 */
4852 @ViewDebug.ExportedProperty
4853 public final boolean isFocusableInTouchMode() {
4854 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
4855 }
4856
4857 /**
4858 * Find the nearest view in the specified direction that can take focus.
4859 * This does not actually give focus to that view.
4860 *
4861 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
4862 *
4863 * @return The nearest focusable in the specified direction, or null if none
4864 * can be found.
4865 */
4866 public View focusSearch(int direction) {
4867 if (mParent != null) {
4868 return mParent.focusSearch(this, direction);
4869 } else {
4870 return null;
4871 }
4872 }
4873
4874 /**
4875 * This method is the last chance for the focused view and its ancestors to
4876 * respond to an arrow key. This is called when the focused view did not
4877 * consume the key internally, nor could the view system find a new view in
4878 * the requested direction to give focus to.
4879 *
4880 * @param focused The currently focused view.
4881 * @param direction The direction focus wants to move. One of FOCUS_UP,
4882 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
4883 * @return True if the this view consumed this unhandled move.
4884 */
4885 public boolean dispatchUnhandledMove(View focused, int direction) {
4886 return false;
4887 }
4888
4889 /**
4890 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08004891 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004892 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08004893 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
4894 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004895 * @return The user specified next view, or null if there is none.
4896 */
4897 View findUserSetNextFocus(View root, int direction) {
4898 switch (direction) {
4899 case FOCUS_LEFT:
4900 if (mNextFocusLeftId == View.NO_ID) return null;
4901 return findViewShouldExist(root, mNextFocusLeftId);
4902 case FOCUS_RIGHT:
4903 if (mNextFocusRightId == View.NO_ID) return null;
4904 return findViewShouldExist(root, mNextFocusRightId);
4905 case FOCUS_UP:
4906 if (mNextFocusUpId == View.NO_ID) return null;
4907 return findViewShouldExist(root, mNextFocusUpId);
4908 case FOCUS_DOWN:
4909 if (mNextFocusDownId == View.NO_ID) return null;
4910 return findViewShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08004911 case FOCUS_FORWARD:
4912 if (mNextFocusForwardId == View.NO_ID) return null;
4913 return findViewShouldExist(root, mNextFocusForwardId);
4914 case FOCUS_BACKWARD: {
4915 final int id = mID;
4916 return root.findViewByPredicate(new Predicate<View>() {
4917 @Override
4918 public boolean apply(View t) {
4919 return t.mNextFocusForwardId == id;
4920 }
4921 });
4922 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004923 }
4924 return null;
4925 }
4926
4927 private static View findViewShouldExist(View root, int childViewId) {
4928 View result = root.findViewById(childViewId);
4929 if (result == null) {
4930 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
4931 + "by user for id " + childViewId);
4932 }
4933 return result;
4934 }
4935
4936 /**
4937 * Find and return all focusable views that are descendants of this view,
4938 * possibly including this view if it is focusable itself.
4939 *
4940 * @param direction The direction of the focus
4941 * @return A list of focusable views
4942 */
4943 public ArrayList<View> getFocusables(int direction) {
4944 ArrayList<View> result = new ArrayList<View>(24);
4945 addFocusables(result, direction);
4946 return result;
4947 }
4948
4949 /**
4950 * Add any focusable views that are descendants of this view (possibly
4951 * including this view if it is focusable itself) to views. If we are in touch mode,
4952 * only add views that are also focusable in touch mode.
4953 *
4954 * @param views Focusable views found so far
4955 * @param direction The direction of the focus
4956 */
4957 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004958 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
4959 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004960
svetoslavganov75986cf2009-05-14 22:28:01 -07004961 /**
4962 * Adds any focusable views that are descendants of this view (possibly
4963 * including this view if it is focusable itself) to views. This method
4964 * adds all focusable views regardless if we are in touch mode or
4965 * only views focusable in touch mode if we are in touch mode depending on
4966 * the focusable mode paramater.
4967 *
4968 * @param views Focusable views found so far or null if all we are interested is
4969 * the number of focusables.
4970 * @param direction The direction of the focus.
4971 * @param focusableMode The type of focusables to be added.
4972 *
4973 * @see #FOCUSABLES_ALL
4974 * @see #FOCUSABLES_TOUCH_MODE
4975 */
4976 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
4977 if (!isFocusable()) {
4978 return;
4979 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004980
svetoslavganov75986cf2009-05-14 22:28:01 -07004981 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE &&
4982 isInTouchMode() && !isFocusableInTouchMode()) {
4983 return;
4984 }
4985
4986 if (views != null) {
4987 views.add(this);
4988 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004989 }
4990
4991 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004992 * Finds the Views that contain given text. The containment is case insensitive.
4993 * As View's text is considered any text content that View renders.
4994 *
4995 * @param outViews The output list of matching Views.
4996 * @param text The text to match against.
4997 */
4998 public void findViewsWithText(ArrayList<View> outViews, CharSequence text) {
4999 }
5000
5001 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005002 * Find and return all touchable views that are descendants of this view,
5003 * possibly including this view if it is touchable itself.
5004 *
5005 * @return A list of touchable views
5006 */
5007 public ArrayList<View> getTouchables() {
5008 ArrayList<View> result = new ArrayList<View>();
5009 addTouchables(result);
5010 return result;
5011 }
5012
5013 /**
5014 * Add any touchable views that are descendants of this view (possibly
5015 * including this view if it is touchable itself) to views.
5016 *
5017 * @param views Touchable views found so far
5018 */
5019 public void addTouchables(ArrayList<View> views) {
5020 final int viewFlags = mViewFlags;
5021
5022 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
5023 && (viewFlags & ENABLED_MASK) == ENABLED) {
5024 views.add(this);
5025 }
5026 }
5027
5028 /**
5029 * Call this to try to give focus to a specific view or to one of its
5030 * descendants.
5031 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08005032 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
5033 * false), or if it is focusable and it is not focusable in touch mode
5034 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005035 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005036 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005037 * have focus, and you want your parent to look for the next one.
5038 *
5039 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
5040 * {@link #FOCUS_DOWN} and <code>null</code>.
5041 *
5042 * @return Whether this view or one of its descendants actually took focus.
5043 */
5044 public final boolean requestFocus() {
5045 return requestFocus(View.FOCUS_DOWN);
5046 }
5047
5048
5049 /**
5050 * Call this to try to give focus to a specific view or to one of its
5051 * descendants and give it a hint about what direction focus is heading.
5052 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08005053 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
5054 * false), or if it is focusable and it is not focusable in touch mode
5055 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005056 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005057 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005058 * have focus, and you want your parent to look for the next one.
5059 *
5060 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
5061 * <code>null</code> set for the previously focused rectangle.
5062 *
5063 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
5064 * @return Whether this view or one of its descendants actually took focus.
5065 */
5066 public final boolean requestFocus(int direction) {
5067 return requestFocus(direction, null);
5068 }
5069
5070 /**
5071 * Call this to try to give focus to a specific view or to one of its descendants
5072 * and give it hints about the direction and a specific rectangle that the focus
5073 * is coming from. The rectangle can help give larger views a finer grained hint
5074 * about where focus is coming from, and therefore, where to show selection, or
5075 * forward focus change internally.
5076 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08005077 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
5078 * false), or if it is focusable and it is not focusable in touch mode
5079 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005080 *
5081 * A View will not take focus if it is not visible.
5082 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08005083 * A View will not take focus if one of its parents has
5084 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to
5085 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005086 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005087 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005088 * have focus, and you want your parent to look for the next one.
5089 *
5090 * You may wish to override this method if your custom {@link View} has an internal
5091 * {@link View} that it wishes to forward the request to.
5092 *
5093 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
5094 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
5095 * to give a finer grained hint about where focus is coming from. May be null
5096 * if there is no hint.
5097 * @return Whether this view or one of its descendants actually took focus.
5098 */
5099 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
5100 // need to be focusable
5101 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
5102 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
5103 return false;
5104 }
5105
5106 // need to be focusable in touch mode if in touch mode
5107 if (isInTouchMode() &&
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07005108 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
5109 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005110 }
5111
5112 // need to not have any parents blocking us
5113 if (hasAncestorThatBlocksDescendantFocus()) {
5114 return false;
5115 }
5116
5117 handleFocusGainInternal(direction, previouslyFocusedRect);
5118 return true;
5119 }
5120
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07005121 /** Gets the ViewAncestor, or null if not attached. */
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07005122 /*package*/ ViewRootImpl getViewRootImpl() {
Christopher Tate2c095f32010-10-04 14:13:40 -07005123 View root = getRootView();
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07005124 return root != null ? (ViewRootImpl)root.getParent() : null;
Christopher Tate2c095f32010-10-04 14:13:40 -07005125 }
5126
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005127 /**
5128 * Call this to try to give focus to a specific view or to one of its descendants. This is a
5129 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
5130 * touch mode to request focus when they are touched.
5131 *
5132 * @return Whether this view or one of its descendants actually took focus.
5133 *
5134 * @see #isInTouchMode()
5135 *
5136 */
5137 public final boolean requestFocusFromTouch() {
5138 // Leave touch mode if we need to
5139 if (isInTouchMode()) {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07005140 ViewRootImpl viewRoot = getViewRootImpl();
Christopher Tate2c095f32010-10-04 14:13:40 -07005141 if (viewRoot != null) {
5142 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005143 }
5144 }
5145 return requestFocus(View.FOCUS_DOWN);
5146 }
5147
5148 /**
5149 * @return Whether any ancestor of this view blocks descendant focus.
5150 */
5151 private boolean hasAncestorThatBlocksDescendantFocus() {
5152 ViewParent ancestor = mParent;
5153 while (ancestor instanceof ViewGroup) {
5154 final ViewGroup vgAncestor = (ViewGroup) ancestor;
5155 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
5156 return true;
5157 } else {
5158 ancestor = vgAncestor.getParent();
5159 }
5160 }
5161 return false;
5162 }
5163
5164 /**
Romain Guya440b002010-02-24 15:57:54 -08005165 * @hide
5166 */
5167 public void dispatchStartTemporaryDetach() {
5168 onStartTemporaryDetach();
5169 }
5170
5171 /**
5172 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005173 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
5174 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08005175 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005176 */
5177 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08005178 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08005179 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08005180 }
5181
5182 /**
5183 * @hide
5184 */
5185 public void dispatchFinishTemporaryDetach() {
5186 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005187 }
Romain Guy8506ab42009-06-11 17:35:47 -07005188
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005189 /**
5190 * Called after {@link #onStartTemporaryDetach} when the container is done
5191 * changing the view.
5192 */
5193 public void onFinishTemporaryDetach() {
5194 }
Romain Guy8506ab42009-06-11 17:35:47 -07005195
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005196 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07005197 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
5198 * for this view's window. Returns null if the view is not currently attached
5199 * to the window. Normally you will not need to use this directly, but
Romain Guy5c22a8c2011-05-13 11:48:45 -07005200 * just use the standard high-level event callbacks like
5201 * {@link #onKeyDown(int, KeyEvent)}.
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07005202 */
5203 public KeyEvent.DispatcherState getKeyDispatcherState() {
5204 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
5205 }
Joe Malin32736f02011-01-19 16:14:20 -08005206
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07005207 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005208 * Dispatch a key event before it is processed by any input method
5209 * associated with the view hierarchy. This can be used to intercept
5210 * key events in special situations before the IME consumes them; a
5211 * typical example would be handling the BACK key to update the application's
5212 * UI instead of allowing the IME to see it and close itself.
5213 *
5214 * @param event The key event to be dispatched.
5215 * @return True if the event was handled, false otherwise.
5216 */
5217 public boolean dispatchKeyEventPreIme(KeyEvent event) {
5218 return onKeyPreIme(event.getKeyCode(), event);
5219 }
5220
5221 /**
5222 * Dispatch a key event to the next view on the focus path. This path runs
5223 * from the top of the view tree down to the currently focused view. If this
5224 * view has focus, it will dispatch to itself. Otherwise it will dispatch
5225 * the next node down the focus path. This method also fires any key
5226 * listeners.
5227 *
5228 * @param event The key event to be dispatched.
5229 * @return True if the event was handled, false otherwise.
5230 */
5231 public boolean dispatchKeyEvent(KeyEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08005232 if (mInputEventConsistencyVerifier != null) {
5233 mInputEventConsistencyVerifier.onKeyEvent(event, 0);
5234 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005235
Jeff Brown21bc5c92011-02-28 18:27:14 -08005236 // Give any attached key listener a first crack at the event.
Romain Guyf607bdc2010-09-10 19:20:06 -07005237 //noinspection SimplifiableIfStatement
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005238 if (mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
5239 && mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
5240 return true;
5241 }
5242
Jeff Brownbbdc50b2011-04-19 23:46:52 -07005243 if (event.dispatch(this, mAttachInfo != null
5244 ? mAttachInfo.mKeyDispatchState : null, this)) {
5245 return true;
5246 }
5247
5248 if (mInputEventConsistencyVerifier != null) {
5249 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
5250 }
5251 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005252 }
5253
5254 /**
5255 * Dispatches a key shortcut event.
5256 *
5257 * @param event The key event to be dispatched.
5258 * @return True if the event was handled by the view, false otherwise.
5259 */
5260 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
5261 return onKeyShortcut(event.getKeyCode(), event);
5262 }
5263
5264 /**
5265 * Pass the touch screen motion event down to the target view, or this
5266 * view if it is the target.
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 dispatchTouchEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08005272 if (mInputEventConsistencyVerifier != null) {
5273 mInputEventConsistencyVerifier.onTouchEvent(event, 0);
5274 }
5275
Jeff Brownbbdc50b2011-04-19 23:46:52 -07005276 if (onFilterTouchEventForSecurity(event)) {
5277 //noinspection SimplifiableIfStatement
5278 if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED &&
5279 mOnTouchListener.onTouch(this, event)) {
5280 return true;
5281 }
5282
5283 if (onTouchEvent(event)) {
5284 return true;
5285 }
Jeff Brown85a31762010-09-01 17:01:00 -07005286 }
5287
Jeff Brownbbdc50b2011-04-19 23:46:52 -07005288 if (mInputEventConsistencyVerifier != null) {
5289 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005290 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07005291 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005292 }
5293
5294 /**
Jeff Brown85a31762010-09-01 17:01:00 -07005295 * Filter the touch event to apply security policies.
5296 *
5297 * @param event The motion event to be filtered.
5298 * @return True if the event should be dispatched, false if the event should be dropped.
Joe Malin32736f02011-01-19 16:14:20 -08005299 *
Jeff Brown85a31762010-09-01 17:01:00 -07005300 * @see #getFilterTouchesWhenObscured
5301 */
5302 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07005303 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07005304 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
5305 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
5306 // Window is obscured, drop this touch.
5307 return false;
5308 }
5309 return true;
5310 }
5311
5312 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005313 * Pass a trackball motion event down to the focused view.
5314 *
5315 * @param event The motion event to be dispatched.
5316 * @return True if the event was handled by the view, false otherwise.
5317 */
5318 public boolean dispatchTrackballEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08005319 if (mInputEventConsistencyVerifier != null) {
5320 mInputEventConsistencyVerifier.onTrackballEvent(event, 0);
5321 }
5322
Romain Guy02ccac62011-06-24 13:20:23 -07005323 return onTrackballEvent(event);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005324 }
5325
5326 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08005327 * Dispatch a generic motion event.
5328 * <p>
5329 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
5330 * are delivered to the view under the pointer. All other generic motion events are
Jeff Browna032cc02011-03-07 16:56:21 -08005331 * delivered to the focused view. Hover events are handled specially and are delivered
Romain Guy5c22a8c2011-05-13 11:48:45 -07005332 * to {@link #onHoverEvent(MotionEvent)}.
Jeff Brown33bbfd22011-02-24 20:55:35 -08005333 * </p>
Jeff Browncb1404e2011-01-15 18:14:15 -08005334 *
5335 * @param event The motion event to be dispatched.
5336 * @return True if the event was handled by the view, false otherwise.
5337 */
5338 public boolean dispatchGenericMotionEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08005339 if (mInputEventConsistencyVerifier != null) {
5340 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0);
5341 }
5342
Jeff Browna032cc02011-03-07 16:56:21 -08005343 final int source = event.getSource();
5344 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) {
5345 final int action = event.getAction();
5346 if (action == MotionEvent.ACTION_HOVER_ENTER
5347 || action == MotionEvent.ACTION_HOVER_MOVE
5348 || action == MotionEvent.ACTION_HOVER_EXIT) {
5349 if (dispatchHoverEvent(event)) {
5350 return true;
5351 }
5352 } else if (dispatchGenericPointerEvent(event)) {
5353 return true;
5354 }
5355 } else if (dispatchGenericFocusedEvent(event)) {
5356 return true;
5357 }
5358
Jeff Brown10b62902011-06-20 16:40:37 -07005359 if (dispatchGenericMotionEventInternal(event)) {
5360 return true;
5361 }
5362
5363 if (mInputEventConsistencyVerifier != null) {
5364 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
5365 }
5366 return false;
5367 }
5368
5369 private boolean dispatchGenericMotionEventInternal(MotionEvent event) {
Romain Guy7b5b6ab2011-03-14 18:05:08 -07005370 //noinspection SimplifiableIfStatement
Jeff Brown33bbfd22011-02-24 20:55:35 -08005371 if (mOnGenericMotionListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
5372 && mOnGenericMotionListener.onGenericMotion(this, event)) {
5373 return true;
5374 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07005375
5376 if (onGenericMotionEvent(event)) {
5377 return true;
5378 }
5379
5380 if (mInputEventConsistencyVerifier != null) {
5381 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
5382 }
5383 return false;
Jeff Browncb1404e2011-01-15 18:14:15 -08005384 }
5385
5386 /**
Jeff Browna032cc02011-03-07 16:56:21 -08005387 * Dispatch a hover event.
5388 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07005389 * Do not call this method directly.
5390 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08005391 * </p>
5392 *
5393 * @param event The motion event to be dispatched.
5394 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08005395 */
5396 protected boolean dispatchHoverEvent(MotionEvent event) {
Romain Guy02ccac62011-06-24 13:20:23 -07005397 //noinspection SimplifiableIfStatement
Jeff Brown10b62902011-06-20 16:40:37 -07005398 if (mOnHoverListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
5399 && mOnHoverListener.onHover(this, event)) {
5400 return true;
5401 }
5402
Jeff Browna032cc02011-03-07 16:56:21 -08005403 return onHoverEvent(event);
5404 }
5405
5406 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07005407 * Returns true if the view has a child to which it has recently sent
5408 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and
5409 * it does not have a hovered child, then it must be the innermost hovered view.
5410 * @hide
5411 */
5412 protected boolean hasHoveredChild() {
5413 return false;
5414 }
5415
5416 /**
Jeff Browna032cc02011-03-07 16:56:21 -08005417 * Dispatch a generic motion event to the view under the first pointer.
5418 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07005419 * Do not call this method directly.
5420 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08005421 * </p>
5422 *
5423 * @param event The motion event to be dispatched.
5424 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08005425 */
5426 protected boolean dispatchGenericPointerEvent(MotionEvent event) {
5427 return false;
5428 }
5429
5430 /**
5431 * Dispatch a generic motion event to the currently focused view.
5432 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07005433 * Do not call this method directly.
5434 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08005435 * </p>
5436 *
5437 * @param event The motion event to be dispatched.
5438 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08005439 */
5440 protected boolean dispatchGenericFocusedEvent(MotionEvent event) {
5441 return false;
5442 }
5443
5444 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08005445 * Dispatch a pointer event.
5446 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07005447 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all
5448 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns
5449 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches
Jeff Brown33bbfd22011-02-24 20:55:35 -08005450 * and should not be expected to handle other pointing device features.
5451 * </p>
5452 *
5453 * @param event The motion event to be dispatched.
5454 * @return True if the event was handled by the view, false otherwise.
5455 * @hide
5456 */
5457 public final boolean dispatchPointerEvent(MotionEvent event) {
5458 if (event.isTouchEvent()) {
5459 return dispatchTouchEvent(event);
5460 } else {
5461 return dispatchGenericMotionEvent(event);
5462 }
5463 }
5464
5465 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005466 * Called when the window containing this view gains or loses window focus.
5467 * ViewGroups should override to route to their children.
5468 *
5469 * @param hasFocus True if the window containing this view now has focus,
5470 * false otherwise.
5471 */
5472 public void dispatchWindowFocusChanged(boolean hasFocus) {
5473 onWindowFocusChanged(hasFocus);
5474 }
5475
5476 /**
5477 * Called when the window containing this view gains or loses focus. Note
5478 * that this is separate from view focus: to receive key events, both
5479 * your view and its window must have focus. If a window is displayed
5480 * on top of yours that takes input focus, then your own window will lose
5481 * focus but the view focus will remain unchanged.
5482 *
5483 * @param hasWindowFocus True if the window containing this view now has
5484 * focus, false otherwise.
5485 */
5486 public void onWindowFocusChanged(boolean hasWindowFocus) {
5487 InputMethodManager imm = InputMethodManager.peekInstance();
5488 if (!hasWindowFocus) {
5489 if (isPressed()) {
5490 setPressed(false);
5491 }
5492 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
5493 imm.focusOut(this);
5494 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05005495 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08005496 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07005497 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005498 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
5499 imm.focusIn(this);
5500 }
5501 refreshDrawableState();
5502 }
5503
5504 /**
5505 * Returns true if this view is in a window that currently has window focus.
5506 * Note that this is not the same as the view itself having focus.
5507 *
5508 * @return True if this view is in a window that currently has window focus.
5509 */
5510 public boolean hasWindowFocus() {
5511 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
5512 }
5513
5514 /**
Adam Powell326d8082009-12-09 15:10:07 -08005515 * Dispatch a view visibility change down the view hierarchy.
5516 * ViewGroups should override to route to their children.
5517 * @param changedView The view whose visibility changed. Could be 'this' or
5518 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08005519 * @param visibility The new visibility of changedView: {@link #VISIBLE},
5520 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08005521 */
5522 protected void dispatchVisibilityChanged(View changedView, int visibility) {
5523 onVisibilityChanged(changedView, visibility);
5524 }
5525
5526 /**
5527 * Called when the visibility of the view or an ancestor of the view is changed.
5528 * @param changedView The view whose visibility changed. Could be 'this' or
5529 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08005530 * @param visibility The new visibility of changedView: {@link #VISIBLE},
5531 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08005532 */
5533 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07005534 if (visibility == VISIBLE) {
5535 if (mAttachInfo != null) {
5536 initialAwakenScrollBars();
5537 } else {
5538 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
5539 }
5540 }
Adam Powell326d8082009-12-09 15:10:07 -08005541 }
5542
5543 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08005544 * Dispatch a hint about whether this view is displayed. For instance, when
5545 * a View moves out of the screen, it might receives a display hint indicating
5546 * the view is not displayed. Applications should not <em>rely</em> on this hint
5547 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08005548 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08005549 * @param hint A hint about whether or not this view is displayed:
5550 * {@link #VISIBLE} or {@link #INVISIBLE}.
5551 */
5552 public void dispatchDisplayHint(int hint) {
5553 onDisplayHint(hint);
5554 }
5555
5556 /**
5557 * Gives this view a hint about whether is displayed or not. For instance, when
5558 * a View moves out of the screen, it might receives a display hint indicating
5559 * the view is not displayed. Applications should not <em>rely</em> on this hint
5560 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08005561 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08005562 * @param hint A hint about whether or not this view is displayed:
5563 * {@link #VISIBLE} or {@link #INVISIBLE}.
5564 */
5565 protected void onDisplayHint(int hint) {
5566 }
5567
5568 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005569 * Dispatch a window visibility change down the view hierarchy.
5570 * ViewGroups should override to route to their children.
5571 *
5572 * @param visibility The new visibility of the window.
5573 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005574 * @see #onWindowVisibilityChanged(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005575 */
5576 public void dispatchWindowVisibilityChanged(int visibility) {
5577 onWindowVisibilityChanged(visibility);
5578 }
5579
5580 /**
5581 * Called when the window containing has change its visibility
5582 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
5583 * that this tells you whether or not your window is being made visible
5584 * to the window manager; this does <em>not</em> tell you whether or not
5585 * your window is obscured by other windows on the screen, even if it
5586 * is itself visible.
5587 *
5588 * @param visibility The new visibility of the window.
5589 */
5590 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07005591 if (visibility == VISIBLE) {
5592 initialAwakenScrollBars();
5593 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005594 }
5595
5596 /**
5597 * Returns the current visibility of the window this view is attached to
5598 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
5599 *
5600 * @return Returns the current visibility of the view's window.
5601 */
5602 public int getWindowVisibility() {
5603 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
5604 }
5605
5606 /**
5607 * Retrieve the overall visible display size in which the window this view is
5608 * attached to has been positioned in. This takes into account screen
5609 * decorations above the window, for both cases where the window itself
5610 * is being position inside of them or the window is being placed under
5611 * then and covered insets are used for the window to position its content
5612 * inside. In effect, this tells you the available area where content can
5613 * be placed and remain visible to users.
5614 *
5615 * <p>This function requires an IPC back to the window manager to retrieve
5616 * the requested information, so should not be used in performance critical
5617 * code like drawing.
5618 *
5619 * @param outRect Filled in with the visible display frame. If the view
5620 * is not attached to a window, this is simply the raw display size.
5621 */
5622 public void getWindowVisibleDisplayFrame(Rect outRect) {
5623 if (mAttachInfo != null) {
5624 try {
5625 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
5626 } catch (RemoteException e) {
5627 return;
5628 }
5629 // XXX This is really broken, and probably all needs to be done
5630 // in the window manager, and we need to know more about whether
5631 // we want the area behind or in front of the IME.
5632 final Rect insets = mAttachInfo.mVisibleInsets;
5633 outRect.left += insets.left;
5634 outRect.top += insets.top;
5635 outRect.right -= insets.right;
5636 outRect.bottom -= insets.bottom;
5637 return;
5638 }
5639 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
Dianne Hackborn44bc17c2011-04-20 18:18:51 -07005640 d.getRectSize(outRect);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005641 }
5642
5643 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08005644 * Dispatch a notification about a resource configuration change down
5645 * the view hierarchy.
5646 * ViewGroups should override to route to their children.
5647 *
5648 * @param newConfig The new resource configuration.
5649 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005650 * @see #onConfigurationChanged(android.content.res.Configuration)
Dianne Hackborne36d6e22010-02-17 19:46:25 -08005651 */
5652 public void dispatchConfigurationChanged(Configuration newConfig) {
5653 onConfigurationChanged(newConfig);
5654 }
5655
5656 /**
5657 * Called when the current configuration of the resources being used
5658 * by the application have changed. You can use this to decide when
5659 * to reload resources that can changed based on orientation and other
5660 * configuration characterstics. You only need to use this if you are
5661 * not relying on the normal {@link android.app.Activity} mechanism of
5662 * recreating the activity instance upon a configuration change.
5663 *
5664 * @param newConfig The new resource configuration.
5665 */
5666 protected void onConfigurationChanged(Configuration newConfig) {
5667 }
5668
5669 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005670 * Private function to aggregate all per-view attributes in to the view
5671 * root.
5672 */
5673 void dispatchCollectViewAttributes(int visibility) {
5674 performCollectViewAttributes(visibility);
5675 }
5676
5677 void performCollectViewAttributes(int visibility) {
Romain Guyd30b36d2011-01-26 10:54:43 -08005678 if ((visibility & VISIBILITY_MASK) == VISIBLE && mAttachInfo != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08005679 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) {
5680 mAttachInfo.mKeepScreenOn = true;
5681 }
5682 mAttachInfo.mSystemUiVisibility |= mSystemUiVisibility;
5683 if (mOnSystemUiVisibilityChangeListener != null) {
5684 mAttachInfo.mHasSystemUiListeners = true;
5685 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005686 }
5687 }
5688
5689 void needGlobalAttributesUpdate(boolean force) {
Joe Onorato664644d2011-01-23 17:53:23 -08005690 final AttachInfo ai = mAttachInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005691 if (ai != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08005692 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0)
5693 || ai.mHasSystemUiListeners) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005694 ai.mRecomputeGlobalAttributes = true;
5695 }
5696 }
5697 }
5698
5699 /**
5700 * Returns whether the device is currently in touch mode. Touch mode is entered
5701 * once the user begins interacting with the device by touch, and affects various
5702 * things like whether focus is always visible to the user.
5703 *
5704 * @return Whether the device is in touch mode.
5705 */
5706 @ViewDebug.ExportedProperty
5707 public boolean isInTouchMode() {
5708 if (mAttachInfo != null) {
5709 return mAttachInfo.mInTouchMode;
5710 } else {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07005711 return ViewRootImpl.isInTouchMode();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005712 }
5713 }
5714
5715 /**
5716 * Returns the context the view is running in, through which it can
5717 * access the current theme, resources, etc.
5718 *
5719 * @return The view's Context.
5720 */
5721 @ViewDebug.CapturedViewProperty
5722 public final Context getContext() {
5723 return mContext;
5724 }
5725
5726 /**
5727 * Handle a key event before it is processed by any input method
5728 * associated with the view hierarchy. This can be used to intercept
5729 * key events in special situations before the IME consumes them; a
5730 * typical example would be handling the BACK key to update the application's
5731 * UI instead of allowing the IME to see it and close itself.
5732 *
5733 * @param keyCode The value in event.getKeyCode().
5734 * @param event Description of the key event.
5735 * @return If you handled the event, return true. If you want to allow the
5736 * event to be handled by the next receiver, return false.
5737 */
5738 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
5739 return false;
5740 }
5741
5742 /**
Jeff Brown995e7742010-12-22 16:59:36 -08005743 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
5744 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005745 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
5746 * is released, if the view is enabled and clickable.
5747 *
5748 * @param keyCode A key code that represents the button pressed, from
5749 * {@link android.view.KeyEvent}.
5750 * @param event The KeyEvent object that defines the button action.
5751 */
5752 public boolean onKeyDown(int keyCode, KeyEvent event) {
5753 boolean result = false;
5754
5755 switch (keyCode) {
5756 case KeyEvent.KEYCODE_DPAD_CENTER:
5757 case KeyEvent.KEYCODE_ENTER: {
5758 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
5759 return true;
5760 }
5761 // Long clickable items don't necessarily have to be clickable
5762 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
5763 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
5764 (event.getRepeatCount() == 0)) {
5765 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07005766 checkForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005767 return true;
5768 }
5769 break;
5770 }
5771 }
5772 return result;
5773 }
5774
5775 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07005776 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
5777 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
5778 * the event).
5779 */
5780 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
5781 return false;
5782 }
5783
5784 /**
Jeff Brown995e7742010-12-22 16:59:36 -08005785 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
5786 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005787 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
5788 * {@link KeyEvent#KEYCODE_ENTER} is released.
5789 *
5790 * @param keyCode A key code that represents the button pressed, from
5791 * {@link android.view.KeyEvent}.
5792 * @param event The KeyEvent object that defines the button action.
5793 */
5794 public boolean onKeyUp(int keyCode, KeyEvent event) {
5795 boolean result = false;
5796
5797 switch (keyCode) {
5798 case KeyEvent.KEYCODE_DPAD_CENTER:
5799 case KeyEvent.KEYCODE_ENTER: {
5800 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
5801 return true;
5802 }
5803 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
5804 setPressed(false);
5805
5806 if (!mHasPerformedLongPress) {
5807 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05005808 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005809
5810 result = performClick();
5811 }
5812 }
5813 break;
5814 }
5815 }
5816 return result;
5817 }
5818
5819 /**
5820 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
5821 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
5822 * the event).
5823 *
5824 * @param keyCode A key code that represents the button pressed, from
5825 * {@link android.view.KeyEvent}.
5826 * @param repeatCount The number of times the action was made.
5827 * @param event The KeyEvent object that defines the button action.
5828 */
5829 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
5830 return false;
5831 }
5832
5833 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08005834 * Called on the focused view when a key shortcut event is not handled.
5835 * Override this method to implement local key shortcuts for the View.
5836 * Key shortcuts can also be implemented by setting the
5837 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005838 *
5839 * @param keyCode The value in event.getKeyCode().
5840 * @param event Description of the key event.
5841 * @return If you handled the event, return true. If you want to allow the
5842 * event to be handled by the next receiver, return false.
5843 */
5844 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
5845 return false;
5846 }
5847
5848 /**
5849 * Check whether the called view is a text editor, in which case it
5850 * would make sense to automatically display a soft input window for
5851 * it. Subclasses should override this if they implement
5852 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005853 * a call on that method would return a non-null InputConnection, and
5854 * they are really a first-class editor that the user would normally
5855 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07005856 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005857 * <p>The default implementation always returns false. This does
5858 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
5859 * will not be called or the user can not otherwise perform edits on your
5860 * view; it is just a hint to the system that this is not the primary
5861 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07005862 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005863 * @return Returns true if this view is a text editor, else false.
5864 */
5865 public boolean onCheckIsTextEditor() {
5866 return false;
5867 }
Romain Guy8506ab42009-06-11 17:35:47 -07005868
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005869 /**
5870 * Create a new InputConnection for an InputMethod to interact
5871 * with the view. The default implementation returns null, since it doesn't
5872 * support input methods. You can override this to implement such support.
5873 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07005874 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005875 * <p>When implementing this, you probably also want to implement
5876 * {@link #onCheckIsTextEditor()} to indicate you will return a
5877 * non-null InputConnection.
5878 *
5879 * @param outAttrs Fill in with attribute information about the connection.
5880 */
5881 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
5882 return null;
5883 }
5884
5885 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005886 * Called by the {@link android.view.inputmethod.InputMethodManager}
5887 * when a view who is not the current
5888 * input connection target is trying to make a call on the manager. The
5889 * default implementation returns false; you can override this to return
5890 * true for certain views if you are performing InputConnection proxying
5891 * to them.
5892 * @param view The View that is making the InputMethodManager call.
5893 * @return Return true to allow the call, false to reject.
5894 */
5895 public boolean checkInputConnectionProxy(View view) {
5896 return false;
5897 }
Romain Guy8506ab42009-06-11 17:35:47 -07005898
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07005899 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005900 * Show the context menu for this view. It is not safe to hold on to the
5901 * menu after returning from this method.
5902 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07005903 * You should normally not overload this method. Overload
5904 * {@link #onCreateContextMenu(ContextMenu)} or define an
5905 * {@link OnCreateContextMenuListener} to add items to the context menu.
5906 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005907 * @param menu The context menu to populate
5908 */
5909 public void createContextMenu(ContextMenu menu) {
5910 ContextMenuInfo menuInfo = getContextMenuInfo();
5911
5912 // Sets the current menu info so all items added to menu will have
5913 // my extra info set.
5914 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
5915
5916 onCreateContextMenu(menu);
5917 if (mOnCreateContextMenuListener != null) {
5918 mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
5919 }
5920
5921 // Clear the extra information so subsequent items that aren't mine don't
5922 // have my extra info.
5923 ((MenuBuilder)menu).setCurrentMenuInfo(null);
5924
5925 if (mParent != null) {
5926 mParent.createContextMenu(menu);
5927 }
5928 }
5929
5930 /**
5931 * Views should implement this if they have extra information to associate
5932 * with the context menu. The return result is supplied as a parameter to
5933 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
5934 * callback.
5935 *
5936 * @return Extra information about the item for which the context menu
5937 * should be shown. This information will vary across different
5938 * subclasses of View.
5939 */
5940 protected ContextMenuInfo getContextMenuInfo() {
5941 return null;
5942 }
5943
5944 /**
5945 * Views should implement this if the view itself is going to add items to
5946 * the context menu.
5947 *
5948 * @param menu the context menu to populate
5949 */
5950 protected void onCreateContextMenu(ContextMenu menu) {
5951 }
5952
5953 /**
5954 * Implement this method to handle trackball motion events. The
5955 * <em>relative</em> movement of the trackball since the last event
5956 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
5957 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
5958 * that a movement of 1 corresponds to the user pressing one DPAD key (so
5959 * they will often be fractional values, representing the more fine-grained
5960 * movement information available from a trackball).
5961 *
5962 * @param event The motion event.
5963 * @return True if the event was handled, false otherwise.
5964 */
5965 public boolean onTrackballEvent(MotionEvent event) {
5966 return false;
5967 }
5968
5969 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08005970 * Implement this method to handle generic motion events.
5971 * <p>
Jeff Brown33bbfd22011-02-24 20:55:35 -08005972 * Generic motion events describe joystick movements, mouse hovers, track pad
5973 * touches, scroll wheel movements and other input events. The
Jeff Browncb1404e2011-01-15 18:14:15 -08005974 * {@link MotionEvent#getSource() source} of the motion event specifies
5975 * the class of input that was received. Implementations of this method
5976 * must examine the bits in the source before processing the event.
5977 * The following code example shows how this is done.
Jeff Brown33bbfd22011-02-24 20:55:35 -08005978 * </p><p>
5979 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
5980 * are delivered to the view under the pointer. All other generic motion events are
5981 * delivered to the focused view.
Jeff Browncb1404e2011-01-15 18:14:15 -08005982 * </p>
5983 * <code>
5984 * public boolean onGenericMotionEvent(MotionEvent event) {
5985 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_JOYSTICK) != 0) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08005986 * if (event.getAction() == MotionEvent.ACTION_MOVE) {
5987 * // process the joystick movement...
5988 * return true;
5989 * }
5990 * }
5991 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_POINTER) != 0) {
5992 * switch (event.getAction()) {
5993 * case MotionEvent.ACTION_HOVER_MOVE:
5994 * // process the mouse hover movement...
5995 * return true;
5996 * case MotionEvent.ACTION_SCROLL:
5997 * // process the scroll wheel movement...
5998 * return true;
5999 * }
Jeff Browncb1404e2011-01-15 18:14:15 -08006000 * }
6001 * return super.onGenericMotionEvent(event);
6002 * }
6003 * </code>
6004 *
6005 * @param event The generic motion event being processed.
Jeff Browna032cc02011-03-07 16:56:21 -08006006 * @return True if the event was handled, false otherwise.
Jeff Browncb1404e2011-01-15 18:14:15 -08006007 */
6008 public boolean onGenericMotionEvent(MotionEvent event) {
6009 return false;
6010 }
6011
6012 /**
Jeff Browna032cc02011-03-07 16:56:21 -08006013 * Implement this method to handle hover events.
6014 * <p>
Jeff Brown10b62902011-06-20 16:40:37 -07006015 * This method is called whenever a pointer is hovering into, over, or out of the
6016 * bounds of a view and the view is not currently being touched.
6017 * Hover events are represented as pointer events with action
6018 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE},
6019 * or {@link MotionEvent#ACTION_HOVER_EXIT}.
6020 * </p>
6021 * <ul>
6022 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER}
6023 * when the pointer enters the bounds of the view.</li>
6024 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE}
6025 * when the pointer has already entered the bounds of the view and has moved.</li>
6026 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT}
6027 * when the pointer has exited the bounds of the view or when the pointer is
6028 * about to go down due to a button click, tap, or similar user action that
6029 * causes the view to be touched.</li>
6030 * </ul>
6031 * <p>
6032 * The view should implement this method to return true to indicate that it is
6033 * handling the hover event, such as by changing its drawable state.
Jeff Browna032cc02011-03-07 16:56:21 -08006034 * </p><p>
Jeff Brown10b62902011-06-20 16:40:37 -07006035 * The default implementation calls {@link #setHovered} to update the hovered state
6036 * of the view when a hover enter or hover exit event is received, if the view
Jeff Browna1b24182011-07-28 13:38:24 -07006037 * is enabled and is clickable. The default implementation also sends hover
6038 * accessibility events.
Jeff Browna032cc02011-03-07 16:56:21 -08006039 * </p>
6040 *
6041 * @param event The motion event that describes the hover.
Jeff Brown10b62902011-06-20 16:40:37 -07006042 * @return True if the view handled the hover event.
6043 *
6044 * @see #isHovered
6045 * @see #setHovered
6046 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08006047 */
6048 public boolean onHoverEvent(MotionEvent event) {
Jeff Browna1b24182011-07-28 13:38:24 -07006049 switch (event.getAction()) {
6050 case MotionEvent.ACTION_HOVER_ENTER:
6051 if (!hasHoveredChild() && !mSendingHoverAccessibilityEvents) {
6052 mSendingHoverAccessibilityEvents = true;
6053 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER);
6054 }
6055 break;
6056 case MotionEvent.ACTION_HOVER_EXIT:
6057 if (mSendingHoverAccessibilityEvents) {
6058 mSendingHoverAccessibilityEvents = false;
6059 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT);
6060 }
6061 break;
6062 }
6063
Jeff Brown87b7f802011-06-21 18:35:45 -07006064 if (isHoverable()) {
Jeff Brown10b62902011-06-20 16:40:37 -07006065 switch (event.getAction()) {
6066 case MotionEvent.ACTION_HOVER_ENTER:
6067 setHovered(true);
6068 break;
6069 case MotionEvent.ACTION_HOVER_EXIT:
6070 setHovered(false);
6071 break;
6072 }
Jeff Browna1b24182011-07-28 13:38:24 -07006073
6074 // Dispatch the event to onGenericMotionEvent before returning true.
6075 // This is to provide compatibility with existing applications that
6076 // handled HOVER_MOVE events in onGenericMotionEvent and that would
6077 // break because of the new default handling for hoverable views
6078 // in onHoverEvent.
6079 // Note that onGenericMotionEvent will be called by default when
6080 // onHoverEvent returns false (refer to dispatchGenericMotionEvent).
6081 dispatchGenericMotionEventInternal(event);
Jeff Brown10b62902011-06-20 16:40:37 -07006082 return true;
Jeff Browna032cc02011-03-07 16:56:21 -08006083 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07006084 return false;
Jeff Browna032cc02011-03-07 16:56:21 -08006085 }
6086
6087 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07006088 * Returns true if the view should handle {@link #onHoverEvent}
6089 * by calling {@link #setHovered} to change its hovered state.
6090 *
6091 * @return True if the view is hoverable.
6092 */
6093 private boolean isHoverable() {
6094 final int viewFlags = mViewFlags;
Romain Guy02ccac62011-06-24 13:20:23 -07006095 //noinspection SimplifiableIfStatement
Jeff Brown87b7f802011-06-21 18:35:45 -07006096 if ((viewFlags & ENABLED_MASK) == DISABLED) {
6097 return false;
6098 }
6099
6100 return (viewFlags & CLICKABLE) == CLICKABLE
6101 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
6102 }
6103
6104 /**
Jeff Browna032cc02011-03-07 16:56:21 -08006105 * Returns true if the view is currently hovered.
6106 *
6107 * @return True if the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07006108 *
6109 * @see #setHovered
6110 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08006111 */
Jeff Brown10b62902011-06-20 16:40:37 -07006112 @ViewDebug.ExportedProperty
Jeff Browna032cc02011-03-07 16:56:21 -08006113 public boolean isHovered() {
6114 return (mPrivateFlags & HOVERED) != 0;
6115 }
6116
6117 /**
6118 * Sets whether the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07006119 * <p>
6120 * Calling this method also changes the drawable state of the view. This
6121 * enables the view to react to hover by using different drawable resources
6122 * to change its appearance.
6123 * </p><p>
6124 * The {@link #onHoverChanged} method is called when the hovered state changes.
6125 * </p>
Jeff Browna032cc02011-03-07 16:56:21 -08006126 *
6127 * @param hovered True if the view is hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07006128 *
6129 * @see #isHovered
6130 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08006131 */
6132 public void setHovered(boolean hovered) {
6133 if (hovered) {
6134 if ((mPrivateFlags & HOVERED) == 0) {
6135 mPrivateFlags |= HOVERED;
6136 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07006137 onHoverChanged(true);
Jeff Browna032cc02011-03-07 16:56:21 -08006138 }
6139 } else {
6140 if ((mPrivateFlags & HOVERED) != 0) {
6141 mPrivateFlags &= ~HOVERED;
6142 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07006143 onHoverChanged(false);
Jeff Browna032cc02011-03-07 16:56:21 -08006144 }
6145 }
6146 }
6147
6148 /**
Jeff Brown10b62902011-06-20 16:40:37 -07006149 * Implement this method to handle hover state changes.
6150 * <p>
6151 * This method is called whenever the hover state changes as a result of a
6152 * call to {@link #setHovered}.
6153 * </p>
6154 *
6155 * @param hovered The current hover state, as returned by {@link #isHovered}.
6156 *
6157 * @see #isHovered
6158 * @see #setHovered
6159 */
6160 public void onHoverChanged(boolean hovered) {
Jeff Brown10b62902011-06-20 16:40:37 -07006161 }
6162
6163 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006164 * Implement this method to handle touch screen motion events.
6165 *
6166 * @param event The motion event.
6167 * @return True if the event was handled, false otherwise.
6168 */
6169 public boolean onTouchEvent(MotionEvent event) {
6170 final int viewFlags = mViewFlags;
6171
6172 if ((viewFlags & ENABLED_MASK) == DISABLED) {
Svetoslav Ganov77b80c02011-03-15 20:52:58 -07006173 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PRESSED) != 0) {
6174 mPrivateFlags &= ~PRESSED;
6175 refreshDrawableState();
6176 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006177 // A disabled view that is clickable still consumes the touch
6178 // events, it just doesn't respond to them.
6179 return (((viewFlags & CLICKABLE) == CLICKABLE ||
6180 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
6181 }
6182
6183 if (mTouchDelegate != null) {
6184 if (mTouchDelegate.onTouchEvent(event)) {
6185 return true;
6186 }
6187 }
6188
6189 if (((viewFlags & CLICKABLE) == CLICKABLE ||
6190 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
6191 switch (event.getAction()) {
6192 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08006193 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
6194 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006195 // take focus if we don't have it already and we should in
6196 // touch mode.
6197 boolean focusTaken = false;
6198 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
6199 focusTaken = requestFocus();
6200 }
6201
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08006202 if (prepressed) {
6203 // The button is being released before we actually
6204 // showed it as pressed. Make it show the pressed
6205 // state now (before scheduling the click) to ensure
6206 // the user sees it.
6207 mPrivateFlags |= PRESSED;
6208 refreshDrawableState();
6209 }
Joe Malin32736f02011-01-19 16:14:20 -08006210
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006211 if (!mHasPerformedLongPress) {
6212 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05006213 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006214
6215 // Only perform take click actions if we were in the pressed state
6216 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08006217 // Use a Runnable and post this rather than calling
6218 // performClick directly. This lets other visual state
6219 // of the view update before click actions start.
6220 if (mPerformClick == null) {
6221 mPerformClick = new PerformClick();
6222 }
6223 if (!post(mPerformClick)) {
6224 performClick();
6225 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006226 }
6227 }
6228
6229 if (mUnsetPressedState == null) {
6230 mUnsetPressedState = new UnsetPressedState();
6231 }
6232
Adam Powelle14579b2009-12-16 18:39:52 -08006233 if (prepressed) {
Adam Powelle14579b2009-12-16 18:39:52 -08006234 postDelayed(mUnsetPressedState,
6235 ViewConfiguration.getPressedStateDuration());
6236 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006237 // If the post failed, unpress right now
6238 mUnsetPressedState.run();
6239 }
Adam Powelle14579b2009-12-16 18:39:52 -08006240 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006241 }
6242 break;
6243
6244 case MotionEvent.ACTION_DOWN:
Adam Powell3b023392010-03-11 16:30:28 -08006245 mHasPerformedLongPress = false;
Patrick Dubroye0a799a2011-05-04 16:19:22 -07006246
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07006247 if (performButtonActionOnTouchDown(event)) {
6248 break;
6249 }
6250
Patrick Dubroye0a799a2011-05-04 16:19:22 -07006251 // Walk up the hierarchy to determine if we're inside a scrolling container.
6252 boolean isInScrollingContainer = false;
6253 ViewParent p = getParent();
6254 while (p != null && p instanceof ViewGroup) {
6255 if (((ViewGroup) p).shouldDelayChildPressedState()) {
6256 isInScrollingContainer = true;
6257 break;
6258 }
6259 p = p.getParent();
6260 }
6261
6262 // For views inside a scrolling container, delay the pressed feedback for
6263 // a short period in case this is a scroll.
6264 if (isInScrollingContainer) {
6265 mPrivateFlags |= PREPRESSED;
6266 if (mPendingCheckForTap == null) {
6267 mPendingCheckForTap = new CheckForTap();
6268 }
6269 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
6270 } else {
6271 // Not inside a scrolling container, so show the feedback right away
6272 mPrivateFlags |= PRESSED;
6273 refreshDrawableState();
6274 checkForLongClick(0);
6275 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006276 break;
6277
6278 case MotionEvent.ACTION_CANCEL:
6279 mPrivateFlags &= ~PRESSED;
6280 refreshDrawableState();
Adam Powelle14579b2009-12-16 18:39:52 -08006281 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006282 break;
6283
6284 case MotionEvent.ACTION_MOVE:
6285 final int x = (int) event.getX();
6286 final int y = (int) event.getY();
6287
6288 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07006289 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006290 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08006291 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006292 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08006293 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05006294 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006295
6296 // Need to switch from pressed to not pressed
6297 mPrivateFlags &= ~PRESSED;
6298 refreshDrawableState();
6299 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006300 }
6301 break;
6302 }
6303 return true;
6304 }
6305
6306 return false;
6307 }
6308
6309 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05006310 * Remove the longpress detection timer.
6311 */
6312 private void removeLongPressCallback() {
6313 if (mPendingCheckForLongPress != null) {
6314 removeCallbacks(mPendingCheckForLongPress);
6315 }
6316 }
Adam Powell3cb8b632011-01-21 15:34:14 -08006317
6318 /**
6319 * Remove the pending click action
6320 */
6321 private void removePerformClickCallback() {
6322 if (mPerformClick != null) {
6323 removeCallbacks(mPerformClick);
6324 }
6325 }
6326
Adam Powelle14579b2009-12-16 18:39:52 -08006327 /**
Romain Guya440b002010-02-24 15:57:54 -08006328 * Remove the prepress detection timer.
6329 */
6330 private void removeUnsetPressCallback() {
6331 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
6332 setPressed(false);
6333 removeCallbacks(mUnsetPressedState);
6334 }
6335 }
6336
6337 /**
Adam Powelle14579b2009-12-16 18:39:52 -08006338 * Remove the tap detection timer.
6339 */
6340 private void removeTapCallback() {
6341 if (mPendingCheckForTap != null) {
6342 mPrivateFlags &= ~PREPRESSED;
6343 removeCallbacks(mPendingCheckForTap);
6344 }
6345 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05006346
6347 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006348 * Cancels a pending long press. Your subclass can use this if you
6349 * want the context menu to come up if the user presses and holds
6350 * at the same place, but you don't want it to come up if they press
6351 * and then move around enough to cause scrolling.
6352 */
6353 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05006354 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08006355
6356 /*
6357 * The prepressed state handled by the tap callback is a display
6358 * construct, but the tap callback will post a long press callback
6359 * less its own timeout. Remove it here.
6360 */
6361 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006362 }
6363
6364 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -07006365 * Remove the pending callback for sending a
6366 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
6367 */
6368 private void removeSendViewScrolledAccessibilityEventCallback() {
6369 if (mSendViewScrolledAccessibilityEvent != null) {
6370 removeCallbacks(mSendViewScrolledAccessibilityEvent);
6371 }
6372 }
6373
6374 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006375 * Sets the TouchDelegate for this View.
6376 */
6377 public void setTouchDelegate(TouchDelegate delegate) {
6378 mTouchDelegate = delegate;
6379 }
6380
6381 /**
6382 * Gets the TouchDelegate for this View.
6383 */
6384 public TouchDelegate getTouchDelegate() {
6385 return mTouchDelegate;
6386 }
6387
6388 /**
6389 * Set flags controlling behavior of this view.
6390 *
6391 * @param flags Constant indicating the value which should be set
6392 * @param mask Constant indicating the bit range that should be changed
6393 */
6394 void setFlags(int flags, int mask) {
6395 int old = mViewFlags;
6396 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
6397
6398 int changed = mViewFlags ^ old;
6399 if (changed == 0) {
6400 return;
6401 }
6402 int privateFlags = mPrivateFlags;
6403
6404 /* Check if the FOCUSABLE bit has changed */
6405 if (((changed & FOCUSABLE_MASK) != 0) &&
6406 ((privateFlags & HAS_BOUNDS) !=0)) {
6407 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
6408 && ((privateFlags & FOCUSED) != 0)) {
6409 /* Give up focus if we are no longer focusable */
6410 clearFocus();
6411 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
6412 && ((privateFlags & FOCUSED) == 0)) {
6413 /*
6414 * Tell the view system that we are now available to take focus
6415 * if no one else already has it.
6416 */
6417 if (mParent != null) mParent.focusableViewAvailable(this);
6418 }
6419 }
6420
6421 if ((flags & VISIBILITY_MASK) == VISIBLE) {
6422 if ((changed & VISIBILITY_MASK) != 0) {
6423 /*
6424 * If this view is becoming visible, set the DRAWN flag so that
6425 * the next invalidate() will not be skipped.
6426 */
6427 mPrivateFlags |= DRAWN;
6428
6429 needGlobalAttributesUpdate(true);
6430
6431 // a view becoming visible is worth notifying the parent
6432 // about in case nothing has focus. even if this specific view
6433 // isn't focusable, it may contain something that is, so let
6434 // the root view try to give this focus if nothing else does.
6435 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
6436 mParent.focusableViewAvailable(this);
6437 }
6438 }
6439 }
6440
6441 /* Check if the GONE bit has changed */
6442 if ((changed & GONE) != 0) {
6443 needGlobalAttributesUpdate(false);
6444 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08006445 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006446
Romain Guyecd80ee2009-12-03 17:13:02 -08006447 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
6448 if (hasFocus()) clearFocus();
6449 destroyDrawingCache();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006450 }
6451 if (mAttachInfo != null) {
6452 mAttachInfo.mViewVisibilityChanged = true;
6453 }
6454 }
6455
6456 /* Check if the VISIBLE bit has changed */
6457 if ((changed & INVISIBLE) != 0) {
6458 needGlobalAttributesUpdate(false);
Chet Haasec8a9a702011-06-17 12:13:42 -07006459 /*
6460 * If this view is becoming invisible, set the DRAWN flag so that
6461 * the next invalidate() will not be skipped.
6462 */
6463 mPrivateFlags |= DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006464
6465 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
6466 // root view becoming invisible shouldn't clear focus
6467 if (getRootView() != this) {
6468 clearFocus();
6469 }
6470 }
6471 if (mAttachInfo != null) {
6472 mAttachInfo.mViewVisibilityChanged = true;
6473 }
6474 }
6475
Adam Powell326d8082009-12-09 15:10:07 -08006476 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07006477 if (mParent instanceof ViewGroup) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006478 ((ViewGroup) mParent).onChildVisibilityChanged(this, (flags & VISIBILITY_MASK));
6479 ((View) mParent).invalidate(true);
Chet Haase5e25c2c2010-09-16 11:15:56 -07006480 }
Adam Powell326d8082009-12-09 15:10:07 -08006481 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
6482 }
6483
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006484 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
6485 destroyDrawingCache();
6486 }
6487
6488 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
6489 destroyDrawingCache();
6490 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Romain Guy0fd89bf2011-01-26 15:41:30 -08006491 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006492 }
6493
6494 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
6495 destroyDrawingCache();
6496 mPrivateFlags &= ~DRAWING_CACHE_VALID;
6497 }
6498
6499 if ((changed & DRAW_MASK) != 0) {
6500 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
6501 if (mBGDrawable != null) {
6502 mPrivateFlags &= ~SKIP_DRAW;
6503 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
6504 } else {
6505 mPrivateFlags |= SKIP_DRAW;
6506 }
6507 } else {
6508 mPrivateFlags &= ~SKIP_DRAW;
6509 }
6510 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08006511 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006512 }
6513
6514 if ((changed & KEEP_SCREEN_ON) != 0) {
Joe Onorato664644d2011-01-23 17:53:23 -08006515 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006516 mParent.recomputeViewAttributes(this);
6517 }
6518 }
Cibu Johny7632cb92010-02-22 13:01:02 -08006519
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07006520 if ((changed & LAYOUT_DIRECTION_MASK) != 0) {
Cibu Johny7632cb92010-02-22 13:01:02 -08006521 requestLayout();
6522 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006523 }
6524
6525 /**
6526 * Change the view's z order in the tree, so it's on top of other sibling
6527 * views
6528 */
6529 public void bringToFront() {
6530 if (mParent != null) {
6531 mParent.bringChildToFront(this);
6532 }
6533 }
6534
6535 /**
6536 * This is called in response to an internal scroll in this view (i.e., the
6537 * view scrolled its own contents). This is typically as a result of
6538 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
6539 * called.
6540 *
6541 * @param l Current horizontal scroll origin.
6542 * @param t Current vertical scroll origin.
6543 * @param oldl Previous horizontal scroll origin.
6544 * @param oldt Previous vertical scroll origin.
6545 */
6546 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Svetoslav Ganova0156172011-06-26 17:55:44 -07006547 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
6548 postSendViewScrolledAccessibilityEventCallback();
6549 }
6550
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006551 mBackgroundSizeChanged = true;
6552
6553 final AttachInfo ai = mAttachInfo;
6554 if (ai != null) {
6555 ai.mViewScrollChanged = true;
6556 }
6557 }
6558
6559 /**
Chet Haase21cd1382010-09-01 17:42:29 -07006560 * Interface definition for a callback to be invoked when the layout bounds of a view
6561 * changes due to layout processing.
6562 */
6563 public interface OnLayoutChangeListener {
6564 /**
6565 * Called when the focus state of a view has changed.
6566 *
6567 * @param v The view whose state has changed.
6568 * @param left The new value of the view's left property.
6569 * @param top The new value of the view's top property.
6570 * @param right The new value of the view's right property.
6571 * @param bottom The new value of the view's bottom property.
6572 * @param oldLeft The previous value of the view's left property.
6573 * @param oldTop The previous value of the view's top property.
6574 * @param oldRight The previous value of the view's right property.
6575 * @param oldBottom The previous value of the view's bottom property.
6576 */
6577 void onLayoutChange(View v, int left, int top, int right, int bottom,
6578 int oldLeft, int oldTop, int oldRight, int oldBottom);
6579 }
6580
6581 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006582 * This is called during layout when the size of this view has changed. If
6583 * you were just added to the view hierarchy, you're called with the old
6584 * values of 0.
6585 *
6586 * @param w Current width of this view.
6587 * @param h Current height of this view.
6588 * @param oldw Old width of this view.
6589 * @param oldh Old height of this view.
6590 */
6591 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
6592 }
6593
6594 /**
6595 * Called by draw to draw the child views. This may be overridden
6596 * by derived classes to gain control just before its children are drawn
6597 * (but after its own view has been drawn).
6598 * @param canvas the canvas on which to draw the view
6599 */
6600 protected void dispatchDraw(Canvas canvas) {
6601 }
6602
6603 /**
6604 * Gets the parent of this view. Note that the parent is a
6605 * ViewParent and not necessarily a View.
6606 *
6607 * @return Parent of this view.
6608 */
6609 public final ViewParent getParent() {
6610 return mParent;
6611 }
6612
6613 /**
Chet Haasecca2c982011-05-20 14:34:18 -07006614 * Set the horizontal scrolled position of your view. This will cause a call to
6615 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6616 * invalidated.
6617 * @param value the x position to scroll to
6618 */
6619 public void setScrollX(int value) {
6620 scrollTo(value, mScrollY);
6621 }
6622
6623 /**
6624 * Set the vertical scrolled position of your view. This will cause a call to
6625 * {@link #onScrollChanged(int, int, int, int)} and the view will be
6626 * invalidated.
6627 * @param value the y position to scroll to
6628 */
6629 public void setScrollY(int value) {
6630 scrollTo(mScrollX, value);
6631 }
6632
6633 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006634 * Return the scrolled left position of this view. This is the left edge of
6635 * the displayed part of your view. You do not need to draw any pixels
6636 * farther left, since those are outside of the frame of your view on
6637 * screen.
6638 *
6639 * @return The left edge of the displayed part of your view, in pixels.
6640 */
6641 public final int getScrollX() {
6642 return mScrollX;
6643 }
6644
6645 /**
6646 * Return the scrolled top position of this view. This is the top edge of
6647 * the displayed part of your view. You do not need to draw any pixels above
6648 * it, since those are outside of the frame of your view on screen.
6649 *
6650 * @return The top edge of the displayed part of your view, in pixels.
6651 */
6652 public final int getScrollY() {
6653 return mScrollY;
6654 }
6655
6656 /**
6657 * Return the width of the your view.
6658 *
6659 * @return The width of your view, in pixels.
6660 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07006661 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006662 public final int getWidth() {
6663 return mRight - mLeft;
6664 }
6665
6666 /**
6667 * Return the height of your view.
6668 *
6669 * @return The height of your view, in pixels.
6670 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07006671 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006672 public final int getHeight() {
6673 return mBottom - mTop;
6674 }
6675
6676 /**
6677 * Return the visible drawing bounds of your view. Fills in the output
6678 * rectangle with the values from getScrollX(), getScrollY(),
6679 * getWidth(), and getHeight().
6680 *
6681 * @param outRect The (scrolled) drawing bounds of the view.
6682 */
6683 public void getDrawingRect(Rect outRect) {
6684 outRect.left = mScrollX;
6685 outRect.top = mScrollY;
6686 outRect.right = mScrollX + (mRight - mLeft);
6687 outRect.bottom = mScrollY + (mBottom - mTop);
6688 }
6689
6690 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08006691 * Like {@link #getMeasuredWidthAndState()}, but only returns the
6692 * raw width component (that is the result is masked by
6693 * {@link #MEASURED_SIZE_MASK}).
6694 *
6695 * @return The raw measured width of this view.
6696 */
6697 public final int getMeasuredWidth() {
6698 return mMeasuredWidth & MEASURED_SIZE_MASK;
6699 }
6700
6701 /**
6702 * Return the full width measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07006703 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08006704 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006705 * This should be used during measurement and layout calculations only. Use
6706 * {@link #getWidth()} to see how wide a view is after layout.
6707 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08006708 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006709 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08006710 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006711 return mMeasuredWidth;
6712 }
6713
6714 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08006715 * Like {@link #getMeasuredHeightAndState()}, but only returns the
6716 * raw width component (that is the result is masked by
6717 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006718 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08006719 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006720 */
6721 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08006722 return mMeasuredHeight & MEASURED_SIZE_MASK;
6723 }
6724
6725 /**
6726 * Return the full height measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07006727 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08006728 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
6729 * This should be used during measurement and layout calculations only. Use
6730 * {@link #getHeight()} to see how wide a view is after layout.
6731 *
6732 * @return The measured width of this view as a bit mask.
6733 */
6734 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006735 return mMeasuredHeight;
6736 }
6737
6738 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08006739 * Return only the state bits of {@link #getMeasuredWidthAndState()}
6740 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
6741 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
6742 * and the height component is at the shifted bits
6743 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
6744 */
6745 public final int getMeasuredState() {
6746 return (mMeasuredWidth&MEASURED_STATE_MASK)
6747 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
6748 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
6749 }
6750
6751 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07006752 * The transform matrix of this view, which is calculated based on the current
6753 * roation, scale, and pivot properties.
6754 *
6755 * @see #getRotation()
6756 * @see #getScaleX()
6757 * @see #getScaleY()
6758 * @see #getPivotX()
6759 * @see #getPivotY()
6760 * @return The current transform matrix for the view
6761 */
6762 public Matrix getMatrix() {
Jeff Brown86671742010-09-30 20:00:15 -07006763 updateMatrix();
Romain Guy33e72ae2010-07-17 12:40:29 -07006764 return mMatrix;
6765 }
6766
6767 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07006768 * Utility function to determine if the value is far enough away from zero to be
6769 * considered non-zero.
6770 * @param value A floating point value to check for zero-ness
6771 * @return whether the passed-in value is far enough away from zero to be considered non-zero
6772 */
6773 private static boolean nonzero(float value) {
6774 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
6775 }
6776
6777 /**
Jeff Brown86671742010-09-30 20:00:15 -07006778 * Returns true if the transform matrix is the identity matrix.
6779 * Recomputes the matrix if necessary.
Joe Malin32736f02011-01-19 16:14:20 -08006780 *
Romain Guy33e72ae2010-07-17 12:40:29 -07006781 * @return True if the transform matrix is the identity matrix, false otherwise.
6782 */
Jeff Brown86671742010-09-30 20:00:15 -07006783 final boolean hasIdentityMatrix() {
6784 updateMatrix();
6785 return mMatrixIsIdentity;
6786 }
6787
6788 /**
6789 * Recomputes the transform matrix if necessary.
6790 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07006791 private void updateMatrix() {
Chet Haasec3aa3612010-06-17 08:50:37 -07006792 if (mMatrixDirty) {
6793 // transform-related properties have changed since the last time someone
6794 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07006795
6796 // Figure out if we need to update the pivot point
6797 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08006798 if ((mRight - mLeft) != mPrevWidth || (mBottom - mTop) != mPrevHeight) {
Chet Haasefd2b0022010-08-06 13:08:56 -07006799 mPrevWidth = mRight - mLeft;
6800 mPrevHeight = mBottom - mTop;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -08006801 mPivotX = mPrevWidth / 2f;
6802 mPivotY = mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07006803 }
6804 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006805 mMatrix.reset();
Chet Haase897247b2010-09-09 14:54:47 -07006806 if (!nonzero(mRotationX) && !nonzero(mRotationY)) {
6807 mMatrix.setTranslate(mTranslationX, mTranslationY);
6808 mMatrix.preRotate(mRotation, mPivotX, mPivotY);
6809 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
6810 } else {
Chet Haasefd2b0022010-08-06 13:08:56 -07006811 if (mCamera == null) {
6812 mCamera = new Camera();
6813 matrix3D = new Matrix();
6814 }
6815 mCamera.save();
Chet Haase897247b2010-09-09 14:54:47 -07006816 mMatrix.preScale(mScaleX, mScaleY, mPivotX, mPivotY);
Romain Guy47b8ade2011-02-23 19:46:33 -08006817 mCamera.rotate(mRotationX, mRotationY, -mRotation);
Chet Haasefd2b0022010-08-06 13:08:56 -07006818 mCamera.getMatrix(matrix3D);
6819 matrix3D.preTranslate(-mPivotX, -mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07006820 matrix3D.postTranslate(mPivotX + mTranslationX, mPivotY + mTranslationY);
Chet Haasefd2b0022010-08-06 13:08:56 -07006821 mMatrix.postConcat(matrix3D);
6822 mCamera.restore();
6823 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006824 mMatrixDirty = false;
6825 mMatrixIsIdentity = mMatrix.isIdentity();
6826 mInverseMatrixDirty = true;
6827 }
Chet Haasec3aa3612010-06-17 08:50:37 -07006828 }
6829
6830 /**
6831 * Utility method to retrieve the inverse of the current mMatrix property.
6832 * We cache the matrix to avoid recalculating it when transform properties
6833 * have not changed.
6834 *
6835 * @return The inverse of the current matrix of this view.
6836 */
Jeff Brown86671742010-09-30 20:00:15 -07006837 final Matrix getInverseMatrix() {
6838 updateMatrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07006839 if (mInverseMatrixDirty) {
6840 if (mInverseMatrix == null) {
6841 mInverseMatrix = new Matrix();
6842 }
6843 mMatrix.invert(mInverseMatrix);
6844 mInverseMatrixDirty = false;
6845 }
6846 return mInverseMatrix;
6847 }
6848
6849 /**
Romain Guya5364ee2011-02-24 14:46:04 -08006850 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which
6851 * views are drawn) from the camera to this view. The camera's distance
6852 * affects 3D transformations, for instance rotations around the X and Y
6853 * axis. If the rotationX or rotationY properties are changed and this view is
6854 * large (more than half the size of the screen), it is recommended to always
6855 * use a camera distance that's greater than the height (X axis rotation) or
6856 * the width (Y axis rotation) of this view.</p>
6857 *
6858 * <p>The distance of the camera from the view plane can have an affect on the
6859 * perspective distortion of the view when it is rotated around the x or y axis.
6860 * For example, a large distance will result in a large viewing angle, and there
6861 * will not be much perspective distortion of the view as it rotates. A short
6862 * distance may cause much more perspective distortion upon rotation, and can
6863 * also result in some drawing artifacts if the rotated view ends up partially
6864 * behind the camera (which is why the recommendation is to use a distance at
6865 * least as far as the size of the view, if the view is to be rotated.)</p>
6866 *
6867 * <p>The distance is expressed in "depth pixels." The default distance depends
6868 * on the screen density. For instance, on a medium density display, the
6869 * default distance is 1280. On a high density display, the default distance
6870 * is 1920.</p>
6871 *
6872 * <p>If you want to specify a distance that leads to visually consistent
6873 * results across various densities, use the following formula:</p>
6874 * <pre>
6875 * float scale = context.getResources().getDisplayMetrics().density;
6876 * view.setCameraDistance(distance * scale);
6877 * </pre>
6878 *
6879 * <p>The density scale factor of a high density display is 1.5,
6880 * and 1920 = 1280 * 1.5.</p>
6881 *
6882 * @param distance The distance in "depth pixels", if negative the opposite
6883 * value is used
6884 *
6885 * @see #setRotationX(float)
6886 * @see #setRotationY(float)
6887 */
6888 public void setCameraDistance(float distance) {
6889 invalidateParentCaches();
6890 invalidate(false);
6891
6892 final float dpi = mResources.getDisplayMetrics().densityDpi;
6893 if (mCamera == null) {
6894 mCamera = new Camera();
6895 matrix3D = new Matrix();
6896 }
6897
6898 mCamera.setLocation(0.0f, 0.0f, -Math.abs(distance) / dpi);
6899 mMatrixDirty = true;
6900
6901 invalidate(false);
6902 }
6903
6904 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07006905 * The degrees that the view is rotated around the pivot point.
6906 *
Romain Guya5364ee2011-02-24 14:46:04 -08006907 * @see #setRotation(float)
Chet Haasec3aa3612010-06-17 08:50:37 -07006908 * @see #getPivotX()
6909 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08006910 *
Chet Haasec3aa3612010-06-17 08:50:37 -07006911 * @return The degrees of rotation.
6912 */
6913 public float getRotation() {
6914 return mRotation;
6915 }
6916
6917 /**
Chet Haase897247b2010-09-09 14:54:47 -07006918 * Sets the degrees that the view is rotated around the pivot point. Increasing values
6919 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07006920 *
6921 * @param rotation The degrees of rotation.
Romain Guya5364ee2011-02-24 14:46:04 -08006922 *
6923 * @see #getRotation()
Chet Haasec3aa3612010-06-17 08:50:37 -07006924 * @see #getPivotX()
6925 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08006926 * @see #setRotationX(float)
6927 * @see #setRotationY(float)
Chet Haase73066682010-11-29 15:55:32 -08006928 *
6929 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07006930 */
6931 public void setRotation(float rotation) {
6932 if (mRotation != rotation) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006933 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07006934 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006935 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006936 mRotation = rotation;
6937 mMatrixDirty = true;
6938 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006939 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07006940 }
6941 }
6942
6943 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07006944 * The degrees that the view is rotated around the vertical axis through the pivot point.
6945 *
6946 * @see #getPivotX()
6947 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08006948 * @see #setRotationY(float)
6949 *
Chet Haasefd2b0022010-08-06 13:08:56 -07006950 * @return The degrees of Y rotation.
6951 */
6952 public float getRotationY() {
6953 return mRotationY;
6954 }
6955
6956 /**
Chet Haase897247b2010-09-09 14:54:47 -07006957 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
6958 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
6959 * down the y axis.
Romain Guya5364ee2011-02-24 14:46:04 -08006960 *
6961 * When rotating large views, it is recommended to adjust the camera distance
6962 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07006963 *
6964 * @param rotationY The degrees of Y rotation.
Romain Guya5364ee2011-02-24 14:46:04 -08006965 *
6966 * @see #getRotationY()
Chet Haasefd2b0022010-08-06 13:08:56 -07006967 * @see #getPivotX()
6968 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08006969 * @see #setRotation(float)
6970 * @see #setRotationX(float)
6971 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08006972 *
6973 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07006974 */
6975 public void setRotationY(float rotationY) {
6976 if (mRotationY != rotationY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08006977 invalidateParentCaches();
Chet Haasefd2b0022010-08-06 13:08:56 -07006978 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07006979 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07006980 mRotationY = rotationY;
6981 mMatrixDirty = true;
6982 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07006983 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07006984 }
6985 }
6986
6987 /**
6988 * The degrees that the view is rotated around the horizontal axis through the pivot point.
6989 *
6990 * @see #getPivotX()
6991 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08006992 * @see #setRotationX(float)
6993 *
Chet Haasefd2b0022010-08-06 13:08:56 -07006994 * @return The degrees of X rotation.
6995 */
6996 public float getRotationX() {
6997 return mRotationX;
6998 }
6999
7000 /**
Chet Haase897247b2010-09-09 14:54:47 -07007001 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
7002 * Increasing values result in clockwise rotation from the viewpoint of looking down the
7003 * x axis.
Romain Guya5364ee2011-02-24 14:46:04 -08007004 *
7005 * When rotating large views, it is recommended to adjust the camera distance
7006 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07007007 *
7008 * @param rotationX The degrees of X rotation.
Romain Guya5364ee2011-02-24 14:46:04 -08007009 *
7010 * @see #getRotationX()
Chet Haasefd2b0022010-08-06 13:08:56 -07007011 * @see #getPivotX()
7012 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08007013 * @see #setRotation(float)
7014 * @see #setRotationY(float)
7015 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08007016 *
7017 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07007018 */
7019 public void setRotationX(float rotationX) {
7020 if (mRotationX != rotationX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007021 invalidateParentCaches();
Chet Haasefd2b0022010-08-06 13:08:56 -07007022 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007023 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07007024 mRotationX = rotationX;
7025 mMatrixDirty = true;
7026 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007027 invalidate(false);
Chet Haasefd2b0022010-08-06 13:08:56 -07007028 }
7029 }
7030
7031 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07007032 * The amount that the view is scaled in x around the pivot point, as a proportion of
7033 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
7034 *
Joe Onorato93162322010-09-16 15:42:01 -04007035 * <p>By default, this is 1.0f.
7036 *
Chet Haasec3aa3612010-06-17 08:50:37 -07007037 * @see #getPivotX()
7038 * @see #getPivotY()
7039 * @return The scaling factor.
7040 */
7041 public float getScaleX() {
7042 return mScaleX;
7043 }
7044
7045 /**
7046 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
7047 * the view's unscaled width. A value of 1 means that no scaling is applied.
7048 *
7049 * @param scaleX The scaling factor.
7050 * @see #getPivotX()
7051 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08007052 *
7053 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07007054 */
7055 public void setScaleX(float scaleX) {
7056 if (mScaleX != scaleX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007057 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07007058 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007059 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007060 mScaleX = scaleX;
7061 mMatrixDirty = true;
7062 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007063 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007064 }
7065 }
7066
7067 /**
7068 * The amount that the view is scaled in y around the pivot point, as a proportion of
7069 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
7070 *
Joe Onorato93162322010-09-16 15:42:01 -04007071 * <p>By default, this is 1.0f.
7072 *
Chet Haasec3aa3612010-06-17 08:50:37 -07007073 * @see #getPivotX()
7074 * @see #getPivotY()
7075 * @return The scaling factor.
7076 */
7077 public float getScaleY() {
7078 return mScaleY;
7079 }
7080
7081 /**
7082 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
7083 * the view's unscaled width. A value of 1 means that no scaling is applied.
7084 *
7085 * @param scaleY The scaling factor.
7086 * @see #getPivotX()
7087 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08007088 *
7089 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07007090 */
7091 public void setScaleY(float scaleY) {
7092 if (mScaleY != scaleY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007093 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07007094 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007095 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007096 mScaleY = scaleY;
7097 mMatrixDirty = true;
7098 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007099 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007100 }
7101 }
7102
7103 /**
7104 * The x location of the point around which the view is {@link #setRotation(float) rotated}
7105 * and {@link #setScaleX(float) scaled}.
7106 *
7107 * @see #getRotation()
7108 * @see #getScaleX()
7109 * @see #getScaleY()
7110 * @see #getPivotY()
7111 * @return The x location of the pivot point.
7112 */
7113 public float getPivotX() {
7114 return mPivotX;
7115 }
7116
7117 /**
7118 * Sets the x location of the point around which the view is
7119 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07007120 * By default, the pivot point is centered on the object.
7121 * Setting this property disables this behavior and causes the view to use only the
7122 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07007123 *
7124 * @param pivotX The x location of the pivot point.
7125 * @see #getRotation()
7126 * @see #getScaleX()
7127 * @see #getScaleY()
7128 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08007129 *
7130 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07007131 */
7132 public void setPivotX(float pivotX) {
Chet Haasefd2b0022010-08-06 13:08:56 -07007133 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07007134 if (mPivotX != pivotX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007135 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07007136 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007137 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007138 mPivotX = pivotX;
7139 mMatrixDirty = true;
7140 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007141 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007142 }
7143 }
7144
7145 /**
7146 * The y location of the point around which the view is {@link #setRotation(float) rotated}
7147 * and {@link #setScaleY(float) scaled}.
7148 *
7149 * @see #getRotation()
7150 * @see #getScaleX()
7151 * @see #getScaleY()
7152 * @see #getPivotY()
7153 * @return The y location of the pivot point.
7154 */
7155 public float getPivotY() {
7156 return mPivotY;
7157 }
7158
7159 /**
7160 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07007161 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
7162 * Setting this property disables this behavior and causes the view to use only the
7163 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07007164 *
7165 * @param pivotY The y location of the pivot point.
7166 * @see #getRotation()
7167 * @see #getScaleX()
7168 * @see #getScaleY()
7169 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08007170 *
7171 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07007172 */
7173 public void setPivotY(float pivotY) {
Chet Haasefd2b0022010-08-06 13:08:56 -07007174 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Chet Haasec3aa3612010-06-17 08:50:37 -07007175 if (mPivotY != pivotY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007176 invalidateParentCaches();
Chet Haasec3aa3612010-06-17 08:50:37 -07007177 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007178 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007179 mPivotY = pivotY;
7180 mMatrixDirty = true;
7181 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007182 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007183 }
7184 }
7185
7186 /**
7187 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
7188 * completely transparent and 1 means the view is completely opaque.
7189 *
Joe Onorato93162322010-09-16 15:42:01 -04007190 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07007191 * @return The opacity of the view.
7192 */
7193 public float getAlpha() {
7194 return mAlpha;
7195 }
7196
7197 /**
Romain Guy171c5922011-01-06 10:04:23 -08007198 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
7199 * completely transparent and 1 means the view is completely opaque.</p>
Joe Malin32736f02011-01-19 16:14:20 -08007200 *
Romain Guy171c5922011-01-06 10:04:23 -08007201 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
7202 * responsible for applying the opacity itself. Otherwise, calling this method is
7203 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
Joe Malin32736f02011-01-19 16:14:20 -08007204 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07007205 *
7206 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08007207 *
Joe Malin32736f02011-01-19 16:14:20 -08007208 * @see #setLayerType(int, android.graphics.Paint)
7209 *
Chet Haase73066682010-11-29 15:55:32 -08007210 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07007211 */
7212 public void setAlpha(float alpha) {
7213 mAlpha = alpha;
Romain Guy0fd89bf2011-01-26 15:41:30 -08007214 invalidateParentCaches();
Chet Haaseed032702010-10-01 14:05:54 -07007215 if (onSetAlpha((int) (alpha * 255))) {
Romain Guya3496a92010-10-12 11:53:24 -07007216 mPrivateFlags |= ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07007217 // subclass is handling alpha - don't optimize rendering cache invalidation
Romain Guy0fd89bf2011-01-26 15:41:30 -08007218 invalidate(true);
Chet Haaseed032702010-10-01 14:05:54 -07007219 } else {
Romain Guya3496a92010-10-12 11:53:24 -07007220 mPrivateFlags &= ~ALPHA_SET;
Chet Haaseed032702010-10-01 14:05:54 -07007221 invalidate(false);
7222 }
Chet Haasec3aa3612010-06-17 08:50:37 -07007223 }
7224
7225 /**
Chet Haasea00f3862011-02-22 06:34:40 -08007226 * Faster version of setAlpha() which performs the same steps except there are
7227 * no calls to invalidate(). The caller of this function should perform proper invalidation
7228 * on the parent and this object. The return value indicates whether the subclass handles
7229 * alpha (the return value for onSetAlpha()).
7230 *
7231 * @param alpha The new value for the alpha property
7232 * @return true if the View subclass handles alpha (the return value for onSetAlpha())
7233 */
7234 boolean setAlphaNoInvalidation(float alpha) {
7235 mAlpha = alpha;
7236 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255));
7237 if (subclassHandlesAlpha) {
7238 mPrivateFlags |= ALPHA_SET;
7239 } else {
7240 mPrivateFlags &= ~ALPHA_SET;
7241 }
7242 return subclassHandlesAlpha;
7243 }
7244
7245 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007246 * Top position of this view relative to its parent.
7247 *
7248 * @return The top of this view, in pixels.
7249 */
7250 @ViewDebug.CapturedViewProperty
7251 public final int getTop() {
7252 return mTop;
7253 }
7254
7255 /**
Chet Haase21cd1382010-09-01 17:42:29 -07007256 * Sets the top position of this view relative to its parent. This method is meant to be called
7257 * by the layout system and should not generally be called otherwise, because the property
7258 * may be changed at any time by the layout.
7259 *
7260 * @param top The top of this view, in pixels.
7261 */
7262 public final void setTop(int top) {
7263 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07007264 updateMatrix();
7265 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08007266 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07007267 int minTop;
7268 int yLoc;
7269 if (top < mTop) {
7270 minTop = top;
7271 yLoc = top - mTop;
7272 } else {
7273 minTop = mTop;
7274 yLoc = 0;
7275 }
Chet Haasee9140a72011-02-16 16:23:29 -08007276 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop);
Chet Haase21cd1382010-09-01 17:42:29 -07007277 }
7278 } else {
7279 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08007280 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007281 }
7282
Chet Haaseed032702010-10-01 14:05:54 -07007283 int width = mRight - mLeft;
7284 int oldHeight = mBottom - mTop;
7285
Chet Haase21cd1382010-09-01 17:42:29 -07007286 mTop = top;
7287
Chet Haaseed032702010-10-01 14:05:54 -07007288 onSizeChanged(width, mBottom - mTop, width, oldHeight);
7289
Chet Haase21cd1382010-09-01 17:42:29 -07007290 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08007291 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
7292 // A change in dimension means an auto-centered pivot point changes, too
7293 mMatrixDirty = true;
7294 }
Chet Haase21cd1382010-09-01 17:42:29 -07007295 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08007296 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007297 }
Chet Haase55dbb652010-12-21 20:15:08 -08007298 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08007299 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07007300 }
7301 }
7302
7303 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007304 * Bottom position of this view relative to its parent.
7305 *
7306 * @return The bottom of this view, in pixels.
7307 */
7308 @ViewDebug.CapturedViewProperty
7309 public final int getBottom() {
7310 return mBottom;
7311 }
7312
7313 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08007314 * True if this view has changed since the last time being drawn.
7315 *
7316 * @return The dirty state of this view.
7317 */
7318 public boolean isDirty() {
7319 return (mPrivateFlags & DIRTY_MASK) != 0;
7320 }
7321
7322 /**
Chet Haase21cd1382010-09-01 17:42:29 -07007323 * Sets the bottom position of this view relative to its parent. This method is meant to be
7324 * called by the layout system and should not generally be called otherwise, because the
7325 * property may be changed at any time by the layout.
7326 *
7327 * @param bottom The bottom of this view, in pixels.
7328 */
7329 public final void setBottom(int bottom) {
7330 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07007331 updateMatrix();
7332 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08007333 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07007334 int maxBottom;
7335 if (bottom < mBottom) {
7336 maxBottom = mBottom;
7337 } else {
7338 maxBottom = bottom;
7339 }
Chet Haasee9140a72011-02-16 16:23:29 -08007340 invalidate(0, 0, mRight - mLeft, maxBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07007341 }
7342 } else {
7343 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08007344 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007345 }
7346
Chet Haaseed032702010-10-01 14:05:54 -07007347 int width = mRight - mLeft;
7348 int oldHeight = mBottom - mTop;
7349
Chet Haase21cd1382010-09-01 17:42:29 -07007350 mBottom = bottom;
7351
Chet Haaseed032702010-10-01 14:05:54 -07007352 onSizeChanged(width, mBottom - mTop, width, oldHeight);
7353
Chet Haase21cd1382010-09-01 17:42:29 -07007354 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08007355 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
7356 // A change in dimension means an auto-centered pivot point changes, too
7357 mMatrixDirty = true;
7358 }
Chet Haase21cd1382010-09-01 17:42:29 -07007359 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08007360 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007361 }
Chet Haase55dbb652010-12-21 20:15:08 -08007362 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08007363 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07007364 }
7365 }
7366
7367 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007368 * Left position of this view relative to its parent.
7369 *
7370 * @return The left edge of this view, in pixels.
7371 */
7372 @ViewDebug.CapturedViewProperty
7373 public final int getLeft() {
7374 return mLeft;
7375 }
7376
7377 /**
Chet Haase21cd1382010-09-01 17:42:29 -07007378 * Sets the left position of this view relative to its parent. This method is meant to be called
7379 * by the layout system and should not generally be called otherwise, because the property
7380 * may be changed at any time by the layout.
7381 *
7382 * @param left The bottom of this view, in pixels.
7383 */
7384 public final void setLeft(int left) {
7385 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07007386 updateMatrix();
7387 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08007388 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07007389 int minLeft;
7390 int xLoc;
7391 if (left < mLeft) {
7392 minLeft = left;
7393 xLoc = left - mLeft;
7394 } else {
7395 minLeft = mLeft;
7396 xLoc = 0;
7397 }
Chet Haasee9140a72011-02-16 16:23:29 -08007398 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07007399 }
7400 } else {
7401 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08007402 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007403 }
7404
Chet Haaseed032702010-10-01 14:05:54 -07007405 int oldWidth = mRight - mLeft;
7406 int height = mBottom - mTop;
7407
Chet Haase21cd1382010-09-01 17:42:29 -07007408 mLeft = left;
7409
Chet Haaseed032702010-10-01 14:05:54 -07007410 onSizeChanged(mRight - mLeft, height, oldWidth, height);
7411
Chet Haase21cd1382010-09-01 17:42:29 -07007412 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08007413 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
7414 // A change in dimension means an auto-centered pivot point changes, too
7415 mMatrixDirty = true;
7416 }
Chet Haase21cd1382010-09-01 17:42:29 -07007417 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08007418 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007419 }
Chet Haase55dbb652010-12-21 20:15:08 -08007420 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08007421 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07007422 }
7423 }
7424
7425 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007426 * Right position of this view relative to its parent.
7427 *
7428 * @return The right edge of this view, in pixels.
7429 */
7430 @ViewDebug.CapturedViewProperty
7431 public final int getRight() {
7432 return mRight;
7433 }
7434
7435 /**
Chet Haase21cd1382010-09-01 17:42:29 -07007436 * Sets the right position of this view relative to its parent. This method is meant to be called
7437 * by the layout system and should not generally be called otherwise, because the property
7438 * may be changed at any time by the layout.
7439 *
7440 * @param right The bottom of this view, in pixels.
7441 */
7442 public final void setRight(int right) {
7443 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07007444 updateMatrix();
7445 if (mMatrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08007446 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07007447 int maxRight;
7448 if (right < mRight) {
7449 maxRight = mRight;
7450 } else {
7451 maxRight = right;
7452 }
Chet Haasee9140a72011-02-16 16:23:29 -08007453 invalidate(0, 0, maxRight - mLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07007454 }
7455 } else {
7456 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08007457 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007458 }
7459
Chet Haaseed032702010-10-01 14:05:54 -07007460 int oldWidth = mRight - mLeft;
7461 int height = mBottom - mTop;
7462
Chet Haase21cd1382010-09-01 17:42:29 -07007463 mRight = right;
7464
Chet Haaseed032702010-10-01 14:05:54 -07007465 onSizeChanged(mRight - mLeft, height, oldWidth, height);
7466
Chet Haase21cd1382010-09-01 17:42:29 -07007467 if (!mMatrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08007468 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
7469 // A change in dimension means an auto-centered pivot point changes, too
7470 mMatrixDirty = true;
7471 }
Chet Haase21cd1382010-09-01 17:42:29 -07007472 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08007473 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07007474 }
Chet Haase55dbb652010-12-21 20:15:08 -08007475 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08007476 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07007477 }
7478 }
7479
7480 /**
Chet Haasedf030d22010-07-30 17:22:38 -07007481 * The visual x position of this view, in pixels. This is equivalent to the
7482 * {@link #setTranslationX(float) translationX} property plus the current
Joe Malin32736f02011-01-19 16:14:20 -08007483 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07007484 *
Chet Haasedf030d22010-07-30 17:22:38 -07007485 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07007486 */
Chet Haasedf030d22010-07-30 17:22:38 -07007487 public float getX() {
7488 return mLeft + mTranslationX;
7489 }
Romain Guy33e72ae2010-07-17 12:40:29 -07007490
Chet Haasedf030d22010-07-30 17:22:38 -07007491 /**
7492 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
7493 * {@link #setTranslationX(float) translationX} property to be the difference between
7494 * the x value passed in and the current {@link #getLeft() left} property.
7495 *
7496 * @param x The visual x position of this view, in pixels.
7497 */
7498 public void setX(float x) {
7499 setTranslationX(x - mLeft);
7500 }
Romain Guy33e72ae2010-07-17 12:40:29 -07007501
Chet Haasedf030d22010-07-30 17:22:38 -07007502 /**
7503 * The visual y position of this view, in pixels. This is equivalent to the
7504 * {@link #setTranslationY(float) translationY} property plus the current
7505 * {@link #getTop() top} property.
7506 *
7507 * @return The visual y position of this view, in pixels.
7508 */
7509 public float getY() {
7510 return mTop + mTranslationY;
7511 }
7512
7513 /**
7514 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
7515 * {@link #setTranslationY(float) translationY} property to be the difference between
7516 * the y value passed in and the current {@link #getTop() top} property.
7517 *
7518 * @param y The visual y position of this view, in pixels.
7519 */
7520 public void setY(float y) {
7521 setTranslationY(y - mTop);
7522 }
7523
7524
7525 /**
7526 * The horizontal location of this view relative to its {@link #getLeft() left} position.
7527 * This position is post-layout, in addition to wherever the object's
7528 * layout placed it.
7529 *
7530 * @return The horizontal position of this view relative to its left position, in pixels.
7531 */
7532 public float getTranslationX() {
7533 return mTranslationX;
7534 }
7535
7536 /**
7537 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
7538 * This effectively positions the object post-layout, in addition to wherever the object's
7539 * layout placed it.
7540 *
7541 * @param translationX The horizontal position of this view relative to its left position,
7542 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08007543 *
7544 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07007545 */
7546 public void setTranslationX(float translationX) {
7547 if (mTranslationX != translationX) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007548 invalidateParentCaches();
Chet Haasedf030d22010-07-30 17:22:38 -07007549 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007550 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07007551 mTranslationX = translationX;
7552 mMatrixDirty = true;
7553 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007554 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007555 }
7556 }
7557
7558 /**
Chet Haasedf030d22010-07-30 17:22:38 -07007559 * The horizontal location of this view relative to its {@link #getTop() top} position.
7560 * This position is post-layout, in addition to wherever the object's
7561 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07007562 *
Chet Haasedf030d22010-07-30 17:22:38 -07007563 * @return The vertical position of this view relative to its top position,
7564 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07007565 */
Chet Haasedf030d22010-07-30 17:22:38 -07007566 public float getTranslationY() {
7567 return mTranslationY;
Chet Haasec3aa3612010-06-17 08:50:37 -07007568 }
7569
7570 /**
Chet Haasedf030d22010-07-30 17:22:38 -07007571 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
7572 * This effectively positions the object post-layout, in addition to wherever the object's
7573 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07007574 *
Chet Haasedf030d22010-07-30 17:22:38 -07007575 * @param translationY The vertical position of this view relative to its top position,
7576 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08007577 *
7578 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07007579 */
Chet Haasedf030d22010-07-30 17:22:38 -07007580 public void setTranslationY(float translationY) {
7581 if (mTranslationY != translationY) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007582 invalidateParentCaches();
Chet Haasedf030d22010-07-30 17:22:38 -07007583 // Double-invalidation is necessary to capture view's old and new areas
Chet Haaseed032702010-10-01 14:05:54 -07007584 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07007585 mTranslationY = translationY;
7586 mMatrixDirty = true;
7587 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007588 invalidate(false);
Chet Haasedf030d22010-07-30 17:22:38 -07007589 }
Chet Haasec3aa3612010-06-17 08:50:37 -07007590 }
7591
7592 /**
Romain Guyda489792011-02-03 01:05:15 -08007593 * @hide
7594 */
Michael Jurkadece29f2011-02-03 01:41:49 -08007595 public void setFastTranslationX(float x) {
7596 mTranslationX = x;
7597 mMatrixDirty = true;
7598 }
7599
7600 /**
7601 * @hide
7602 */
7603 public void setFastTranslationY(float y) {
7604 mTranslationY = y;
7605 mMatrixDirty = true;
7606 }
7607
7608 /**
7609 * @hide
7610 */
Romain Guyda489792011-02-03 01:05:15 -08007611 public void setFastX(float x) {
7612 mTranslationX = x - mLeft;
7613 mMatrixDirty = true;
7614 }
7615
7616 /**
7617 * @hide
7618 */
7619 public void setFastY(float y) {
7620 mTranslationY = y - mTop;
7621 mMatrixDirty = true;
7622 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08007623
Romain Guyda489792011-02-03 01:05:15 -08007624 /**
7625 * @hide
7626 */
7627 public void setFastScaleX(float x) {
7628 mScaleX = x;
7629 mMatrixDirty = true;
7630 }
7631
7632 /**
7633 * @hide
7634 */
7635 public void setFastScaleY(float y) {
7636 mScaleY = y;
7637 mMatrixDirty = true;
7638 }
7639
7640 /**
7641 * @hide
7642 */
7643 public void setFastAlpha(float alpha) {
7644 mAlpha = alpha;
7645 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08007646
Romain Guyda489792011-02-03 01:05:15 -08007647 /**
7648 * @hide
7649 */
7650 public void setFastRotationY(float y) {
7651 mRotationY = y;
7652 mMatrixDirty = true;
7653 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08007654
Romain Guyda489792011-02-03 01:05:15 -08007655 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007656 * Hit rectangle in parent's coordinates
7657 *
7658 * @param outRect The hit rectangle of the view.
7659 */
7660 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07007661 updateMatrix();
7662 if (mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007663 outRect.set(mLeft, mTop, mRight, mBottom);
7664 } else {
7665 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Romain Guy33e72ae2010-07-17 12:40:29 -07007666 tmpRect.set(-mPivotX, -mPivotY, getWidth() - mPivotX, getHeight() - mPivotY);
Jeff Brown86671742010-09-30 20:00:15 -07007667 mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07007668 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
7669 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07007670 }
7671 }
7672
7673 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07007674 * Determines whether the given point, in local coordinates is inside the view.
7675 */
7676 /*package*/ final boolean pointInView(float localX, float localY) {
7677 return localX >= 0 && localX < (mRight - mLeft)
7678 && localY >= 0 && localY < (mBottom - mTop);
7679 }
7680
7681 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07007682 * Utility method to determine whether the given point, in local coordinates,
7683 * is inside the view, where the area of the view is expanded by the slop factor.
7684 * This method is called while processing touch-move events to determine if the event
7685 * is still within the view.
7686 */
7687 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07007688 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07007689 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007690 }
7691
7692 /**
7693 * When a view has focus and the user navigates away from it, the next view is searched for
7694 * starting from the rectangle filled in by this method.
7695 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07007696 * By default, the rectange is the {@link #getDrawingRect(android.graphics.Rect)})
7697 * of the view. However, if your view maintains some idea of internal selection,
7698 * such as a cursor, or a selected row or column, you should override this method and
7699 * fill in a more specific rectangle.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007700 *
7701 * @param r The rectangle to fill in, in this view's coordinates.
7702 */
7703 public void getFocusedRect(Rect r) {
7704 getDrawingRect(r);
7705 }
7706
7707 /**
7708 * If some part of this view is not clipped by any of its parents, then
7709 * return that area in r in global (root) coordinates. To convert r to local
7710 * coordinates, offset it by -globalOffset (e.g. r.offset(-globalOffset.x,
7711 * -globalOffset.y)) If the view is completely clipped or translated out,
7712 * return false.
7713 *
7714 * @param r If true is returned, r holds the global coordinates of the
7715 * visible portion of this view.
7716 * @param globalOffset If true is returned, globalOffset holds the dx,dy
7717 * between this view and its root. globalOffet may be null.
7718 * @return true if r is non-empty (i.e. part of the view is visible at the
7719 * root level.
7720 */
7721 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
7722 int width = mRight - mLeft;
7723 int height = mBottom - mTop;
7724 if (width > 0 && height > 0) {
7725 r.set(0, 0, width, height);
7726 if (globalOffset != null) {
7727 globalOffset.set(-mScrollX, -mScrollY);
7728 }
7729 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
7730 }
7731 return false;
7732 }
7733
7734 public final boolean getGlobalVisibleRect(Rect r) {
7735 return getGlobalVisibleRect(r, null);
7736 }
7737
7738 public final boolean getLocalVisibleRect(Rect r) {
7739 Point offset = new Point();
7740 if (getGlobalVisibleRect(r, offset)) {
7741 r.offset(-offset.x, -offset.y); // make r local
7742 return true;
7743 }
7744 return false;
7745 }
7746
7747 /**
7748 * Offset this view's vertical location by the specified number of pixels.
7749 *
7750 * @param offset the number of pixels to offset the view by
7751 */
7752 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007753 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07007754 updateMatrix();
7755 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007756 final ViewParent p = mParent;
7757 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007758 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07007759 int minTop;
7760 int maxBottom;
7761 int yLoc;
7762 if (offset < 0) {
7763 minTop = mTop + offset;
7764 maxBottom = mBottom;
7765 yLoc = offset;
7766 } else {
7767 minTop = mTop;
7768 maxBottom = mBottom + offset;
7769 yLoc = 0;
7770 }
7771 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
7772 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07007773 }
7774 } else {
Chet Haaseed032702010-10-01 14:05:54 -07007775 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007776 }
Romain Guy33e72ae2010-07-17 12:40:29 -07007777
Chet Haasec3aa3612010-06-17 08:50:37 -07007778 mTop += offset;
7779 mBottom += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07007780
Chet Haasec3aa3612010-06-17 08:50:37 -07007781 if (!mMatrixIsIdentity) {
7782 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007783 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007784 }
Chet Haase678e0ad2011-01-25 09:37:18 -08007785 invalidateParentIfNeeded();
Chet Haasec3aa3612010-06-17 08:50:37 -07007786 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007787 }
7788
7789 /**
7790 * Offset this view's horizontal location by the specified amount of pixels.
7791 *
7792 * @param offset the numer of pixels to offset the view by
7793 */
7794 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007795 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07007796 updateMatrix();
7797 if (mMatrixIsIdentity) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007798 final ViewParent p = mParent;
7799 if (p != null && mAttachInfo != null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07007800 final Rect r = mAttachInfo.mTmpInvalRect;
Chet Haase8fbf8d22010-07-30 15:01:32 -07007801 int minLeft;
7802 int maxRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07007803 if (offset < 0) {
7804 minLeft = mLeft + offset;
7805 maxRight = mRight;
Chet Haase8fbf8d22010-07-30 15:01:32 -07007806 } else {
7807 minLeft = mLeft;
7808 maxRight = mRight + offset;
Chet Haase8fbf8d22010-07-30 15:01:32 -07007809 }
Chet Haasec3aa3612010-06-17 08:50:37 -07007810 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
Chet Haase8fbf8d22010-07-30 15:01:32 -07007811 p.invalidateChild(this, r);
Chet Haasec3aa3612010-06-17 08:50:37 -07007812 }
7813 } else {
Chet Haaseed032702010-10-01 14:05:54 -07007814 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007815 }
Romain Guy33e72ae2010-07-17 12:40:29 -07007816
Chet Haasec3aa3612010-06-17 08:50:37 -07007817 mLeft += offset;
7818 mRight += offset;
Romain Guy33e72ae2010-07-17 12:40:29 -07007819
Chet Haasec3aa3612010-06-17 08:50:37 -07007820 if (!mMatrixIsIdentity) {
7821 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Chet Haaseed032702010-10-01 14:05:54 -07007822 invalidate(false);
Chet Haasec3aa3612010-06-17 08:50:37 -07007823 }
Chet Haase678e0ad2011-01-25 09:37:18 -08007824 invalidateParentIfNeeded();
Chet Haasec3aa3612010-06-17 08:50:37 -07007825 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007826 }
7827
7828 /**
7829 * Get the LayoutParams associated with this view. All views should have
7830 * layout parameters. These supply parameters to the <i>parent</i> of this
7831 * view specifying how it should be arranged. There are many subclasses of
7832 * ViewGroup.LayoutParams, and these correspond to the different subclasses
7833 * of ViewGroup that are responsible for arranging their children.
Romain Guy01c174b2011-02-22 11:51:06 -08007834 *
7835 * This method may return null if this View is not attached to a parent
7836 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)}
7837 * was not invoked successfully. When a View is attached to a parent
7838 * ViewGroup, this method must not return null.
7839 *
7840 * @return The LayoutParams associated with this view, or null if no
7841 * parameters have been set yet
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007842 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07007843 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007844 public ViewGroup.LayoutParams getLayoutParams() {
7845 return mLayoutParams;
7846 }
7847
7848 /**
7849 * Set the layout parameters associated with this view. These supply
7850 * parameters to the <i>parent</i> of this view specifying how it should be
7851 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
7852 * correspond to the different subclasses of ViewGroup that are responsible
7853 * for arranging their children.
7854 *
Romain Guy01c174b2011-02-22 11:51:06 -08007855 * @param params The layout parameters for this view, cannot be null
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007856 */
7857 public void setLayoutParams(ViewGroup.LayoutParams params) {
7858 if (params == null) {
Romain Guy01c174b2011-02-22 11:51:06 -08007859 throw new NullPointerException("Layout parameters cannot be null");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007860 }
7861 mLayoutParams = params;
7862 requestLayout();
7863 }
7864
7865 /**
7866 * Set the scrolled position of your view. This will cause a call to
7867 * {@link #onScrollChanged(int, int, int, int)} and the view will be
7868 * invalidated.
7869 * @param x the x position to scroll to
7870 * @param y the y position to scroll to
7871 */
7872 public void scrollTo(int x, int y) {
7873 if (mScrollX != x || mScrollY != y) {
7874 int oldX = mScrollX;
7875 int oldY = mScrollY;
7876 mScrollX = x;
7877 mScrollY = y;
Romain Guy0fd89bf2011-01-26 15:41:30 -08007878 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007879 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07007880 if (!awakenScrollBars()) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08007881 invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -07007882 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007883 }
7884 }
7885
7886 /**
7887 * Move the scrolled position of your view. This will cause a call to
7888 * {@link #onScrollChanged(int, int, int, int)} and the view will be
7889 * invalidated.
7890 * @param x the amount of pixels to scroll by horizontally
7891 * @param y the amount of pixels to scroll by vertically
7892 */
7893 public void scrollBy(int x, int y) {
7894 scrollTo(mScrollX + x, mScrollY + y);
7895 }
7896
7897 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07007898 * <p>Trigger the scrollbars to draw. When invoked this method starts an
7899 * animation to fade the scrollbars out after a default delay. If a subclass
7900 * provides animated scrolling, the start delay should equal the duration
7901 * of the scrolling animation.</p>
7902 *
7903 * <p>The animation starts only if at least one of the scrollbars is
7904 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
7905 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
7906 * this method returns true, and false otherwise. If the animation is
7907 * started, this method calls {@link #invalidate()}; in that case the
7908 * caller should not call {@link #invalidate()}.</p>
7909 *
7910 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07007911 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07007912 *
7913 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
7914 * and {@link #scrollTo(int, int)}.</p>
7915 *
7916 * @return true if the animation is played, false otherwise
7917 *
7918 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07007919 * @see #scrollBy(int, int)
7920 * @see #scrollTo(int, int)
7921 * @see #isHorizontalScrollBarEnabled()
7922 * @see #isVerticalScrollBarEnabled()
7923 * @see #setHorizontalScrollBarEnabled(boolean)
7924 * @see #setVerticalScrollBarEnabled(boolean)
7925 */
7926 protected boolean awakenScrollBars() {
7927 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07007928 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07007929 }
7930
7931 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07007932 * Trigger the scrollbars to draw.
7933 * This method differs from awakenScrollBars() only in its default duration.
7934 * initialAwakenScrollBars() will show the scroll bars for longer than
7935 * usual to give the user more of a chance to notice them.
7936 *
7937 * @return true if the animation is played, false otherwise.
7938 */
7939 private boolean initialAwakenScrollBars() {
7940 return mScrollCache != null &&
7941 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
7942 }
7943
7944 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07007945 * <p>
7946 * Trigger the scrollbars to draw. When invoked this method starts an
7947 * animation to fade the scrollbars out after a fixed delay. If a subclass
7948 * provides animated scrolling, the start delay should equal the duration of
7949 * the scrolling animation.
7950 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08007951 *
Mike Cleronf116bf82009-09-27 19:14:12 -07007952 * <p>
7953 * The animation starts only if at least one of the scrollbars is enabled,
7954 * as specified by {@link #isHorizontalScrollBarEnabled()} and
7955 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
7956 * this method returns true, and false otherwise. If the animation is
7957 * started, this method calls {@link #invalidate()}; in that case the caller
7958 * should not call {@link #invalidate()}.
7959 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08007960 *
Mike Cleronf116bf82009-09-27 19:14:12 -07007961 * <p>
7962 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07007963 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07007964 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08007965 *
Mike Cleronf116bf82009-09-27 19:14:12 -07007966 * @param startDelay the delay, in milliseconds, after which the animation
7967 * should start; when the delay is 0, the animation starts
7968 * immediately
7969 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08007970 *
Mike Cleronf116bf82009-09-27 19:14:12 -07007971 * @see #scrollBy(int, int)
7972 * @see #scrollTo(int, int)
7973 * @see #isHorizontalScrollBarEnabled()
7974 * @see #isVerticalScrollBarEnabled()
7975 * @see #setHorizontalScrollBarEnabled(boolean)
7976 * @see #setVerticalScrollBarEnabled(boolean)
7977 */
7978 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07007979 return awakenScrollBars(startDelay, true);
7980 }
Joe Malin32736f02011-01-19 16:14:20 -08007981
Mike Cleron290947b2009-09-29 18:34:32 -07007982 /**
7983 * <p>
7984 * Trigger the scrollbars to draw. When invoked this method starts an
7985 * animation to fade the scrollbars out after a fixed delay. If a subclass
7986 * provides animated scrolling, the start delay should equal the duration of
7987 * the scrolling animation.
7988 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08007989 *
Mike Cleron290947b2009-09-29 18:34:32 -07007990 * <p>
7991 * The animation starts only if at least one of the scrollbars is enabled,
7992 * as specified by {@link #isHorizontalScrollBarEnabled()} and
7993 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
7994 * this method returns true, and false otherwise. If the animation is
Joe Malin32736f02011-01-19 16:14:20 -08007995 * started, this method calls {@link #invalidate()} if the invalidate parameter
Mike Cleron290947b2009-09-29 18:34:32 -07007996 * is set to true; in that case the caller
7997 * should not call {@link #invalidate()}.
7998 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08007999 *
Mike Cleron290947b2009-09-29 18:34:32 -07008000 * <p>
8001 * This method should be invoked everytime a subclass directly updates the
8002 * scroll parameters.
8003 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08008004 *
Mike Cleron290947b2009-09-29 18:34:32 -07008005 * @param startDelay the delay, in milliseconds, after which the animation
8006 * should start; when the delay is 0, the animation starts
8007 * immediately
Joe Malin32736f02011-01-19 16:14:20 -08008008 *
Mike Cleron290947b2009-09-29 18:34:32 -07008009 * @param invalidate Wheter this method should call invalidate
Joe Malin32736f02011-01-19 16:14:20 -08008010 *
Mike Cleron290947b2009-09-29 18:34:32 -07008011 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08008012 *
Mike Cleron290947b2009-09-29 18:34:32 -07008013 * @see #scrollBy(int, int)
8014 * @see #scrollTo(int, int)
8015 * @see #isHorizontalScrollBarEnabled()
8016 * @see #isVerticalScrollBarEnabled()
8017 * @see #setHorizontalScrollBarEnabled(boolean)
8018 * @see #setVerticalScrollBarEnabled(boolean)
8019 */
8020 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07008021 final ScrollabilityCache scrollCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08008022
Mike Cleronf116bf82009-09-27 19:14:12 -07008023 if (scrollCache == null || !scrollCache.fadeScrollBars) {
8024 return false;
8025 }
8026
8027 if (scrollCache.scrollBar == null) {
8028 scrollCache.scrollBar = new ScrollBarDrawable();
8029 }
8030
8031 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
8032
Mike Cleron290947b2009-09-29 18:34:32 -07008033 if (invalidate) {
8034 // Invalidate to show the scrollbars
Romain Guy0fd89bf2011-01-26 15:41:30 -08008035 invalidate(true);
Mike Cleron290947b2009-09-29 18:34:32 -07008036 }
Mike Cleronf116bf82009-09-27 19:14:12 -07008037
8038 if (scrollCache.state == ScrollabilityCache.OFF) {
8039 // FIXME: this is copied from WindowManagerService.
8040 // We should get this value from the system when it
8041 // is possible to do so.
8042 final int KEY_REPEAT_FIRST_DELAY = 750;
8043 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
8044 }
8045
8046 // Tell mScrollCache when we should start fading. This may
8047 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07008048 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07008049 scrollCache.fadeStartTime = fadeStartTime;
8050 scrollCache.state = ScrollabilityCache.ON;
8051
8052 // Schedule our fader to run, unscheduling any old ones first
8053 if (mAttachInfo != null) {
8054 mAttachInfo.mHandler.removeCallbacks(scrollCache);
8055 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
8056 }
8057
8058 return true;
8059 }
8060
8061 return false;
8062 }
8063
8064 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008065 * Mark the the area defined by dirty as needing to be drawn. If the view is
Romain Guy5c22a8c2011-05-13 11:48:45 -07008066 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some point
8067 * in the future. This must be called from a UI thread. To call from a non-UI
8068 * thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008069 *
8070 * WARNING: This method is destructive to dirty.
8071 * @param dirty the rectangle representing the bounds of the dirty region
8072 */
8073 public void invalidate(Rect dirty) {
8074 if (ViewDebug.TRACE_HIERARCHY) {
8075 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
8076 }
8077
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008078 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08008079 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
8080 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008081 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08008082 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008083 final ViewParent p = mParent;
8084 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08008085 //noinspection PointlessBooleanExpression,ConstantConditions
8086 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
8087 if (p != null && ai != null && ai.mHardwareAccelerated) {
8088 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07008089 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08008090 p.invalidateChild(this, null);
8091 return;
8092 }
Romain Guyaf636eb2010-12-09 17:47:21 -08008093 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008094 if (p != null && ai != null) {
8095 final int scrollX = mScrollX;
8096 final int scrollY = mScrollY;
8097 final Rect r = ai.mTmpInvalRect;
8098 r.set(dirty.left - scrollX, dirty.top - scrollY,
8099 dirty.right - scrollX, dirty.bottom - scrollY);
8100 mParent.invalidateChild(this, r);
8101 }
8102 }
8103 }
8104
8105 /**
8106 * Mark the the area defined by the rect (l,t,r,b) as needing to be drawn.
8107 * The coordinates of the dirty rect are relative to the view.
Romain Guy5c22a8c2011-05-13 11:48:45 -07008108 * If the view is visible, {@link #onDraw(android.graphics.Canvas)}
8109 * will be called at some point in the future. This must be called from
8110 * a UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008111 * @param l the left position of the dirty region
8112 * @param t the top position of the dirty region
8113 * @param r the right position of the dirty region
8114 * @param b the bottom position of the dirty region
8115 */
8116 public void invalidate(int l, int t, int r, int b) {
8117 if (ViewDebug.TRACE_HIERARCHY) {
8118 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
8119 }
8120
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008121 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08008122 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
8123 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008124 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08008125 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008126 final ViewParent p = mParent;
8127 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08008128 //noinspection PointlessBooleanExpression,ConstantConditions
8129 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
8130 if (p != null && ai != null && ai.mHardwareAccelerated) {
8131 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07008132 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08008133 p.invalidateChild(this, null);
8134 return;
8135 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08008136 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008137 if (p != null && ai != null && l < r && t < b) {
8138 final int scrollX = mScrollX;
8139 final int scrollY = mScrollY;
8140 final Rect tmpr = ai.mTmpInvalRect;
8141 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
8142 p.invalidateChild(this, tmpr);
8143 }
8144 }
8145 }
8146
8147 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07008148 * Invalidate the whole view. If the view is visible,
8149 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in
8150 * the future. This must be called from a UI thread. To call from a non-UI thread,
8151 * call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008152 */
8153 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -07008154 invalidate(true);
8155 }
Joe Malin32736f02011-01-19 16:14:20 -08008156
Chet Haaseed032702010-10-01 14:05:54 -07008157 /**
8158 * This is where the invalidate() work actually happens. A full invalidate()
8159 * causes the drawing cache to be invalidated, but this function can be called with
8160 * invalidateCache set to false to skip that invalidation step for cases that do not
8161 * need it (for example, a component that remains at the same dimensions with the same
8162 * content).
8163 *
8164 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
8165 * well. This is usually true for a full invalidate, but may be set to false if the
8166 * View's contents or dimensions have not changed.
8167 */
Romain Guy849d0a32011-02-01 17:20:48 -08008168 void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008169 if (ViewDebug.TRACE_HIERARCHY) {
8170 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
8171 }
8172
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008173 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Romain Guyc5d55862011-01-21 19:01:46 -08008174 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) ||
Romain Guy0fd89bf2011-01-26 15:41:30 -08008175 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) {
8176 mLastIsOpaque = isOpaque();
Chet Haaseed032702010-10-01 14:05:54 -07008177 mPrivateFlags &= ~DRAWN;
8178 if (invalidateCache) {
Chet Haasedaf98e92011-01-10 14:10:36 -08008179 mPrivateFlags |= INVALIDATED;
Chet Haaseed032702010-10-01 14:05:54 -07008180 mPrivateFlags &= ~DRAWING_CACHE_VALID;
8181 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008182 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -07008183 final ViewParent p = mParent;
Romain Guy7d7b5492011-01-24 16:33:45 -08008184 //noinspection PointlessBooleanExpression,ConstantConditions
8185 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
8186 if (p != null && ai != null && ai.mHardwareAccelerated) {
8187 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07008188 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08008189 p.invalidateChild(this, null);
8190 return;
8191 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08008192 }
Michael Jurkaebefea42010-11-15 16:04:01 -08008193
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008194 if (p != null && ai != null) {
8195 final Rect r = ai.mTmpInvalRect;
8196 r.set(0, 0, mRight - mLeft, mBottom - mTop);
8197 // Don't call invalidate -- we don't want to internally scroll
8198 // our own bounds
8199 p.invalidateChild(this, r);
8200 }
8201 }
8202 }
8203
8204 /**
Romain Guyda489792011-02-03 01:05:15 -08008205 * @hide
8206 */
8207 public void fastInvalidate() {
8208 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
8209 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
8210 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
8211 if (mParent instanceof View) {
8212 ((View) mParent).mPrivateFlags |= INVALIDATED;
8213 }
8214 mPrivateFlags &= ~DRAWN;
8215 mPrivateFlags |= INVALIDATED;
8216 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Michael Jurkad0872bd2011-03-24 15:44:19 -07008217 if (mParent != null && mAttachInfo != null) {
8218 if (mAttachInfo.mHardwareAccelerated) {
8219 mParent.invalidateChild(this, null);
8220 } else {
8221 final Rect r = mAttachInfo.mTmpInvalRect;
8222 r.set(0, 0, mRight - mLeft, mBottom - mTop);
8223 // Don't call invalidate -- we don't want to internally scroll
8224 // our own bounds
8225 mParent.invalidateChild(this, r);
8226 }
Romain Guyda489792011-02-03 01:05:15 -08008227 }
8228 }
8229 }
8230
8231 /**
Romain Guy0fd89bf2011-01-26 15:41:30 -08008232 * Used to indicate that the parent of this view should clear its caches. This functionality
Chet Haasedaf98e92011-01-10 14:10:36 -08008233 * is used to force the parent to rebuild its display list (when hardware-accelerated),
8234 * which is necessary when various parent-managed properties of the view change, such as
Romain Guy0fd89bf2011-01-26 15:41:30 -08008235 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only
8236 * clears the parent caches and does not causes an invalidate event.
Chet Haasedaf98e92011-01-10 14:10:36 -08008237 *
8238 * @hide
8239 */
Romain Guy0fd89bf2011-01-26 15:41:30 -08008240 protected void invalidateParentCaches() {
8241 if (mParent instanceof View) {
8242 ((View) mParent).mPrivateFlags |= INVALIDATED;
8243 }
8244 }
Joe Malin32736f02011-01-19 16:14:20 -08008245
Romain Guy0fd89bf2011-01-26 15:41:30 -08008246 /**
8247 * Used to indicate that the parent of this view should be invalidated. This functionality
8248 * is used to force the parent to rebuild its display list (when hardware-accelerated),
8249 * which is necessary when various parent-managed properties of the view change, such as
8250 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate
8251 * an invalidation event to the parent.
8252 *
8253 * @hide
8254 */
8255 protected void invalidateParentIfNeeded() {
Chet Haasedaf98e92011-01-10 14:10:36 -08008256 if (isHardwareAccelerated() && mParent instanceof View) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08008257 ((View) mParent).invalidate(true);
Chet Haasedaf98e92011-01-10 14:10:36 -08008258 }
8259 }
8260
8261 /**
Romain Guy24443ea2009-05-11 11:56:30 -07008262 * Indicates whether this View is opaque. An opaque View guarantees that it will
8263 * draw all the pixels overlapping its bounds using a fully opaque color.
8264 *
8265 * Subclasses of View should override this method whenever possible to indicate
8266 * whether an instance is opaque. Opaque Views are treated in a special way by
8267 * the View hierarchy, possibly allowing it to perform optimizations during
8268 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -07008269 *
Romain Guy24443ea2009-05-11 11:56:30 -07008270 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -07008271 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008272 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -07008273 public boolean isOpaque() {
Chet Haase70d4ba12010-10-06 09:46:45 -07008274 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK &&
8275 (mAlpha >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD);
Romain Guy8f1344f52009-05-15 16:03:59 -07008276 }
8277
Adam Powell20232d02010-12-08 21:08:53 -08008278 /**
8279 * @hide
8280 */
8281 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -07008282 // Opaque if:
8283 // - Has a background
8284 // - Background is opaque
8285 // - Doesn't have scrollbars or scrollbars are inside overlay
8286
8287 if (mBGDrawable != null && mBGDrawable.getOpacity() == PixelFormat.OPAQUE) {
8288 mPrivateFlags |= OPAQUE_BACKGROUND;
8289 } else {
8290 mPrivateFlags &= ~OPAQUE_BACKGROUND;
8291 }
8292
8293 final int flags = mViewFlags;
8294 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
8295 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
8296 mPrivateFlags |= OPAQUE_SCROLLBARS;
8297 } else {
8298 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
8299 }
8300 }
8301
8302 /**
8303 * @hide
8304 */
8305 protected boolean hasOpaqueScrollbars() {
8306 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -07008307 }
8308
8309 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008310 * @return A handler associated with the thread running the View. This
8311 * handler can be used to pump events in the UI events queue.
8312 */
8313 public Handler getHandler() {
8314 if (mAttachInfo != null) {
8315 return mAttachInfo.mHandler;
8316 }
8317 return null;
8318 }
8319
8320 /**
Romain Guye63a4f32011-08-11 11:33:31 -07008321 * <p>Causes the Runnable to be added to the message queue.
8322 * The runnable will be run on the user interface thread.</p>
8323 *
8324 * <p>This method can be invoked from outside of the UI thread
8325 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008326 *
8327 * @param action The Runnable that will be executed.
8328 *
8329 * @return Returns true if the Runnable was successfully placed in to the
8330 * message queue. Returns false on failure, usually because the
8331 * looper processing the message queue is exiting.
8332 */
8333 public boolean post(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().post(action);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008341 return true;
8342 }
8343
8344 return handler.post(action);
8345 }
8346
8347 /**
Romain Guye63a4f32011-08-11 11:33:31 -07008348 * <p>Causes the Runnable to be added to the message queue, to be run
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008349 * after the specified amount of time elapses.
Romain Guye63a4f32011-08-11 11:33:31 -07008350 * The runnable will be run on the user interface thread.</p>
8351 *
8352 * <p>This method can be invoked from outside of the UI thread
8353 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008354 *
8355 * @param action The Runnable that will be executed.
8356 * @param delayMillis The delay (in milliseconds) until the Runnable
8357 * will be executed.
8358 *
8359 * @return true if the Runnable was successfully placed in to the
8360 * message queue. Returns false on failure, usually because the
8361 * looper processing the message queue is exiting. Note that a
8362 * result of true does not mean the Runnable will be processed --
8363 * if the looper is quit before the delivery time of the message
8364 * occurs then the message will be dropped.
8365 */
8366 public boolean postDelayed(Runnable action, long delayMillis) {
8367 Handler handler;
Romain Guyc5a43a22011-03-24 13:28:56 -07008368 AttachInfo attachInfo = mAttachInfo;
8369 if (attachInfo != null) {
8370 handler = attachInfo.mHandler;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008371 } else {
8372 // Assume that post will succeed later
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07008373 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008374 return true;
8375 }
8376
8377 return handler.postDelayed(action, delayMillis);
8378 }
8379
8380 /**
Romain Guye63a4f32011-08-11 11:33:31 -07008381 * <p>Removes the specified Runnable from the message queue.</p>
8382 *
8383 * <p>This method can be invoked from outside of the UI thread
8384 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008385 *
8386 * @param action The Runnable to remove from the message handling queue
8387 *
8388 * @return true if this view could ask the Handler to remove the Runnable,
8389 * false otherwise. When the returned value is true, the Runnable
8390 * may or may not have been actually removed from the message queue
8391 * (for instance, if the Runnable was not in the queue already.)
8392 */
8393 public boolean removeCallbacks(Runnable action) {
8394 Handler handler;
Romain Guyc5a43a22011-03-24 13:28:56 -07008395 AttachInfo attachInfo = mAttachInfo;
8396 if (attachInfo != null) {
8397 handler = attachInfo.mHandler;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008398 } else {
8399 // Assume that post will succeed later
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07008400 ViewRootImpl.getRunQueue().removeCallbacks(action);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008401 return true;
8402 }
8403
8404 handler.removeCallbacks(action);
8405 return true;
8406 }
8407
8408 /**
Romain Guye63a4f32011-08-11 11:33:31 -07008409 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop.
8410 * Use this to invalidate the View from a non-UI thread.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008411 *
Romain Guye63a4f32011-08-11 11:33:31 -07008412 * <p>This method can be invoked from outside of the UI thread
8413 * only when this View is attached to a window.</p>
8414 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008415 * @see #invalidate()
8416 */
8417 public void postInvalidate() {
8418 postInvalidateDelayed(0);
8419 }
8420
8421 /**
Romain Guye63a4f32011-08-11 11:33:31 -07008422 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
8423 * through the event loop. Use this to invalidate the View from a non-UI thread.</p>
8424 *
8425 * <p>This method can be invoked from outside of the UI thread
8426 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008427 *
8428 * @param left The left coordinate of the rectangle to invalidate.
8429 * @param top The top coordinate of the rectangle to invalidate.
8430 * @param right The right coordinate of the rectangle to invalidate.
8431 * @param bottom The bottom coordinate of the rectangle to invalidate.
8432 *
8433 * @see #invalidate(int, int, int, int)
8434 * @see #invalidate(Rect)
8435 */
8436 public void postInvalidate(int left, int top, int right, int bottom) {
8437 postInvalidateDelayed(0, left, top, right, bottom);
8438 }
8439
8440 /**
Romain Guye63a4f32011-08-11 11:33:31 -07008441 * <p>Cause an invalidate to happen on a subsequent cycle through the event
8442 * loop. Waits for the specified amount of time.</p>
8443 *
8444 * <p>This method can be invoked from outside of the UI thread
8445 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008446 *
8447 * @param delayMilliseconds the duration in milliseconds to delay the
8448 * invalidation by
8449 */
8450 public void postInvalidateDelayed(long delayMilliseconds) {
8451 // We try only with the AttachInfo because there's no point in invalidating
8452 // if we are not attached to our window
Romain Guyc5a43a22011-03-24 13:28:56 -07008453 AttachInfo attachInfo = mAttachInfo;
8454 if (attachInfo != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008455 Message msg = Message.obtain();
8456 msg.what = AttachInfo.INVALIDATE_MSG;
8457 msg.obj = this;
Romain Guyc5a43a22011-03-24 13:28:56 -07008458 attachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008459 }
8460 }
8461
8462 /**
Romain Guye63a4f32011-08-11 11:33:31 -07008463 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
8464 * through the event loop. Waits for the specified amount of time.</p>
8465 *
8466 * <p>This method can be invoked from outside of the UI thread
8467 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008468 *
8469 * @param delayMilliseconds the duration in milliseconds to delay the
8470 * invalidation by
8471 * @param left The left coordinate of the rectangle to invalidate.
8472 * @param top The top coordinate of the rectangle to invalidate.
8473 * @param right The right coordinate of the rectangle to invalidate.
8474 * @param bottom The bottom coordinate of the rectangle to invalidate.
8475 */
8476 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
8477 int right, int bottom) {
8478
8479 // We try only with the AttachInfo because there's no point in invalidating
8480 // if we are not attached to our window
Romain Guyc5a43a22011-03-24 13:28:56 -07008481 AttachInfo attachInfo = mAttachInfo;
8482 if (attachInfo != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008483 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
8484 info.target = this;
8485 info.left = left;
8486 info.top = top;
8487 info.right = right;
8488 info.bottom = bottom;
8489
8490 final Message msg = Message.obtain();
8491 msg.what = AttachInfo.INVALIDATE_RECT_MSG;
8492 msg.obj = info;
Romain Guyc5a43a22011-03-24 13:28:56 -07008493 attachInfo.mHandler.sendMessageDelayed(msg, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008494 }
8495 }
8496
8497 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -07008498 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event.
8499 * This event is sent at most once every
8500 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}.
8501 */
8502 private void postSendViewScrolledAccessibilityEventCallback() {
8503 if (mSendViewScrolledAccessibilityEvent == null) {
8504 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent();
8505 }
8506 if (!mSendViewScrolledAccessibilityEvent.mIsPending) {
8507 mSendViewScrolledAccessibilityEvent.mIsPending = true;
8508 postDelayed(mSendViewScrolledAccessibilityEvent,
8509 ViewConfiguration.getSendRecurringAccessibilityEventsInterval());
8510 }
8511 }
8512
8513 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008514 * Called by a parent to request that a child update its values for mScrollX
8515 * and mScrollY if necessary. This will typically be done if the child is
8516 * animating a scroll using a {@link android.widget.Scroller Scroller}
8517 * object.
8518 */
8519 public void computeScroll() {
8520 }
8521
8522 /**
8523 * <p>Indicate whether the horizontal edges are faded when the view is
8524 * scrolled horizontally.</p>
8525 *
8526 * @return true if the horizontal edges should are faded on scroll, false
8527 * otherwise
8528 *
8529 * @see #setHorizontalFadingEdgeEnabled(boolean)
8530 * @attr ref android.R.styleable#View_fadingEdge
8531 */
8532 public boolean isHorizontalFadingEdgeEnabled() {
8533 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
8534 }
8535
8536 /**
8537 * <p>Define whether the horizontal edges should be faded when this view
8538 * is scrolled horizontally.</p>
8539 *
8540 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
8541 * be faded when the view is scrolled
8542 * horizontally
8543 *
8544 * @see #isHorizontalFadingEdgeEnabled()
8545 * @attr ref android.R.styleable#View_fadingEdge
8546 */
8547 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
8548 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
8549 if (horizontalFadingEdgeEnabled) {
8550 initScrollCache();
8551 }
8552
8553 mViewFlags ^= FADING_EDGE_HORIZONTAL;
8554 }
8555 }
8556
8557 /**
8558 * <p>Indicate whether the vertical edges are faded when the view is
8559 * scrolled horizontally.</p>
8560 *
8561 * @return true if the vertical edges should are faded on scroll, false
8562 * otherwise
8563 *
8564 * @see #setVerticalFadingEdgeEnabled(boolean)
8565 * @attr ref android.R.styleable#View_fadingEdge
8566 */
8567 public boolean isVerticalFadingEdgeEnabled() {
8568 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
8569 }
8570
8571 /**
8572 * <p>Define whether the vertical edges should be faded when this view
8573 * is scrolled vertically.</p>
8574 *
8575 * @param verticalFadingEdgeEnabled true if the vertical edges should
8576 * be faded when the view is scrolled
8577 * vertically
8578 *
8579 * @see #isVerticalFadingEdgeEnabled()
8580 * @attr ref android.R.styleable#View_fadingEdge
8581 */
8582 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
8583 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
8584 if (verticalFadingEdgeEnabled) {
8585 initScrollCache();
8586 }
8587
8588 mViewFlags ^= FADING_EDGE_VERTICAL;
8589 }
8590 }
8591
8592 /**
8593 * Returns the strength, or intensity, of the top faded edge. The strength is
8594 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
8595 * returns 0.0 or 1.0 but no value in between.
8596 *
8597 * Subclasses should override this method to provide a smoother fade transition
8598 * when scrolling occurs.
8599 *
8600 * @return the intensity of the top fade as a float between 0.0f and 1.0f
8601 */
8602 protected float getTopFadingEdgeStrength() {
8603 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
8604 }
8605
8606 /**
8607 * Returns the strength, or intensity, of the bottom faded edge. The strength is
8608 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
8609 * returns 0.0 or 1.0 but no value in between.
8610 *
8611 * Subclasses should override this method to provide a smoother fade transition
8612 * when scrolling occurs.
8613 *
8614 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
8615 */
8616 protected float getBottomFadingEdgeStrength() {
8617 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
8618 computeVerticalScrollRange() ? 1.0f : 0.0f;
8619 }
8620
8621 /**
8622 * Returns the strength, or intensity, of the left faded edge. The strength is
8623 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
8624 * returns 0.0 or 1.0 but no value in between.
8625 *
8626 * Subclasses should override this method to provide a smoother fade transition
8627 * when scrolling occurs.
8628 *
8629 * @return the intensity of the left fade as a float between 0.0f and 1.0f
8630 */
8631 protected float getLeftFadingEdgeStrength() {
8632 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
8633 }
8634
8635 /**
8636 * Returns the strength, or intensity, of the right faded edge. The strength is
8637 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
8638 * returns 0.0 or 1.0 but no value in between.
8639 *
8640 * Subclasses should override this method to provide a smoother fade transition
8641 * when scrolling occurs.
8642 *
8643 * @return the intensity of the right fade as a float between 0.0f and 1.0f
8644 */
8645 protected float getRightFadingEdgeStrength() {
8646 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
8647 computeHorizontalScrollRange() ? 1.0f : 0.0f;
8648 }
8649
8650 /**
8651 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
8652 * scrollbar is not drawn by default.</p>
8653 *
8654 * @return true if the horizontal scrollbar should be painted, false
8655 * otherwise
8656 *
8657 * @see #setHorizontalScrollBarEnabled(boolean)
8658 */
8659 public boolean isHorizontalScrollBarEnabled() {
8660 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
8661 }
8662
8663 /**
8664 * <p>Define whether the horizontal scrollbar should be drawn or not. The
8665 * scrollbar is not drawn by default.</p>
8666 *
8667 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
8668 * be painted
8669 *
8670 * @see #isHorizontalScrollBarEnabled()
8671 */
8672 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
8673 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
8674 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07008675 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07008676 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008677 }
8678 }
8679
8680 /**
8681 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
8682 * scrollbar is not drawn by default.</p>
8683 *
8684 * @return true if the vertical scrollbar should be painted, false
8685 * otherwise
8686 *
8687 * @see #setVerticalScrollBarEnabled(boolean)
8688 */
8689 public boolean isVerticalScrollBarEnabled() {
8690 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
8691 }
8692
8693 /**
8694 * <p>Define whether the vertical scrollbar should be drawn or not. The
8695 * scrollbar is not drawn by default.</p>
8696 *
8697 * @param verticalScrollBarEnabled true if the vertical scrollbar should
8698 * be painted
8699 *
8700 * @see #isVerticalScrollBarEnabled()
8701 */
8702 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
8703 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
8704 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -07008705 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07008706 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008707 }
8708 }
8709
Adam Powell20232d02010-12-08 21:08:53 -08008710 /**
8711 * @hide
8712 */
8713 protected void recomputePadding() {
8714 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008715 }
Joe Malin32736f02011-01-19 16:14:20 -08008716
Mike Cleronfe81d382009-09-28 14:22:16 -07008717 /**
8718 * Define whether scrollbars will fade when the view is not scrolling.
Joe Malin32736f02011-01-19 16:14:20 -08008719 *
Mike Cleronfe81d382009-09-28 14:22:16 -07008720 * @param fadeScrollbars wheter to enable fading
Joe Malin32736f02011-01-19 16:14:20 -08008721 *
Mike Cleronfe81d382009-09-28 14:22:16 -07008722 */
8723 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
8724 initScrollCache();
8725 final ScrollabilityCache scrollabilityCache = mScrollCache;
8726 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -07008727 if (fadeScrollbars) {
8728 scrollabilityCache.state = ScrollabilityCache.OFF;
8729 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -07008730 scrollabilityCache.state = ScrollabilityCache.ON;
8731 }
8732 }
Joe Malin32736f02011-01-19 16:14:20 -08008733
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008734 /**
Joe Malin32736f02011-01-19 16:14:20 -08008735 *
Mike Cleron52f0a642009-09-28 18:21:37 -07008736 * Returns true if scrollbars will fade when this view is not scrolling
Joe Malin32736f02011-01-19 16:14:20 -08008737 *
Mike Cleron52f0a642009-09-28 18:21:37 -07008738 * @return true if scrollbar fading is enabled
8739 */
8740 public boolean isScrollbarFadingEnabled() {
Joe Malin32736f02011-01-19 16:14:20 -08008741 return mScrollCache != null && mScrollCache.fadeScrollBars;
Mike Cleron52f0a642009-09-28 18:21:37 -07008742 }
Joe Malin32736f02011-01-19 16:14:20 -08008743
Mike Cleron52f0a642009-09-28 18:21:37 -07008744 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008745 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
8746 * inset. When inset, they add to the padding of the view. And the scrollbars
8747 * can be drawn inside the padding area or on the edge of the view. For example,
8748 * if a view has a background drawable and you want to draw the scrollbars
8749 * inside the padding specified by the drawable, you can use
8750 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
8751 * appear at the edge of the view, ignoring the padding, then you can use
8752 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
8753 * @param style the style of the scrollbars. Should be one of
8754 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
8755 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
8756 * @see #SCROLLBARS_INSIDE_OVERLAY
8757 * @see #SCROLLBARS_INSIDE_INSET
8758 * @see #SCROLLBARS_OUTSIDE_OVERLAY
8759 * @see #SCROLLBARS_OUTSIDE_INSET
8760 */
8761 public void setScrollBarStyle(int style) {
8762 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
8763 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -07008764 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07008765 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008766 }
8767 }
8768
8769 /**
8770 * <p>Returns the current scrollbar style.</p>
8771 * @return the current scrollbar style
8772 * @see #SCROLLBARS_INSIDE_OVERLAY
8773 * @see #SCROLLBARS_INSIDE_INSET
8774 * @see #SCROLLBARS_OUTSIDE_OVERLAY
8775 * @see #SCROLLBARS_OUTSIDE_INSET
8776 */
8777 public int getScrollBarStyle() {
8778 return mViewFlags & SCROLLBARS_STYLE_MASK;
8779 }
8780
8781 /**
8782 * <p>Compute the horizontal range that the horizontal scrollbar
8783 * represents.</p>
8784 *
8785 * <p>The range is expressed in arbitrary units that must be the same as the
8786 * units used by {@link #computeHorizontalScrollExtent()} and
8787 * {@link #computeHorizontalScrollOffset()}.</p>
8788 *
8789 * <p>The default range is the drawing width of this view.</p>
8790 *
8791 * @return the total horizontal range represented by the horizontal
8792 * scrollbar
8793 *
8794 * @see #computeHorizontalScrollExtent()
8795 * @see #computeHorizontalScrollOffset()
8796 * @see android.widget.ScrollBarDrawable
8797 */
8798 protected int computeHorizontalScrollRange() {
8799 return getWidth();
8800 }
8801
8802 /**
8803 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
8804 * within the horizontal range. This value is used to compute the position
8805 * of the thumb within the scrollbar's track.</p>
8806 *
8807 * <p>The range is expressed in arbitrary units that must be the same as the
8808 * units used by {@link #computeHorizontalScrollRange()} and
8809 * {@link #computeHorizontalScrollExtent()}.</p>
8810 *
8811 * <p>The default offset is the scroll offset of this view.</p>
8812 *
8813 * @return the horizontal offset of the scrollbar's thumb
8814 *
8815 * @see #computeHorizontalScrollRange()
8816 * @see #computeHorizontalScrollExtent()
8817 * @see android.widget.ScrollBarDrawable
8818 */
8819 protected int computeHorizontalScrollOffset() {
8820 return mScrollX;
8821 }
8822
8823 /**
8824 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
8825 * within the horizontal range. This value is used to compute the length
8826 * of the thumb within the scrollbar's track.</p>
8827 *
8828 * <p>The range is expressed in arbitrary units that must be the same as the
8829 * units used by {@link #computeHorizontalScrollRange()} and
8830 * {@link #computeHorizontalScrollOffset()}.</p>
8831 *
8832 * <p>The default extent is the drawing width of this view.</p>
8833 *
8834 * @return the horizontal extent of the scrollbar's thumb
8835 *
8836 * @see #computeHorizontalScrollRange()
8837 * @see #computeHorizontalScrollOffset()
8838 * @see android.widget.ScrollBarDrawable
8839 */
8840 protected int computeHorizontalScrollExtent() {
8841 return getWidth();
8842 }
8843
8844 /**
8845 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
8846 *
8847 * <p>The range is expressed in arbitrary units that must be the same as the
8848 * units used by {@link #computeVerticalScrollExtent()} and
8849 * {@link #computeVerticalScrollOffset()}.</p>
8850 *
8851 * @return the total vertical range represented by the vertical scrollbar
8852 *
8853 * <p>The default range is the drawing height of this view.</p>
8854 *
8855 * @see #computeVerticalScrollExtent()
8856 * @see #computeVerticalScrollOffset()
8857 * @see android.widget.ScrollBarDrawable
8858 */
8859 protected int computeVerticalScrollRange() {
8860 return getHeight();
8861 }
8862
8863 /**
8864 * <p>Compute the vertical offset of the vertical scrollbar's thumb
8865 * within the horizontal range. This value is used to compute the position
8866 * of the thumb within the scrollbar's track.</p>
8867 *
8868 * <p>The range is expressed in arbitrary units that must be the same as the
8869 * units used by {@link #computeVerticalScrollRange()} and
8870 * {@link #computeVerticalScrollExtent()}.</p>
8871 *
8872 * <p>The default offset is the scroll offset of this view.</p>
8873 *
8874 * @return the vertical offset of the scrollbar's thumb
8875 *
8876 * @see #computeVerticalScrollRange()
8877 * @see #computeVerticalScrollExtent()
8878 * @see android.widget.ScrollBarDrawable
8879 */
8880 protected int computeVerticalScrollOffset() {
8881 return mScrollY;
8882 }
8883
8884 /**
8885 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
8886 * within the vertical range. This value is used to compute the length
8887 * of the thumb within the scrollbar's track.</p>
8888 *
8889 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -08008890 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008891 * {@link #computeVerticalScrollOffset()}.</p>
8892 *
8893 * <p>The default extent is the drawing height of this view.</p>
8894 *
8895 * @return the vertical extent of the scrollbar's thumb
8896 *
8897 * @see #computeVerticalScrollRange()
8898 * @see #computeVerticalScrollOffset()
8899 * @see android.widget.ScrollBarDrawable
8900 */
8901 protected int computeVerticalScrollExtent() {
8902 return getHeight();
8903 }
8904
8905 /**
Adam Powell69159442011-06-13 17:53:06 -07008906 * Check if this view can be scrolled horizontally in a certain direction.
8907 *
8908 * @param direction Negative to check scrolling left, positive to check scrolling right.
8909 * @return true if this view can be scrolled in the specified direction, false otherwise.
8910 */
8911 public boolean canScrollHorizontally(int direction) {
8912 final int offset = computeHorizontalScrollOffset();
8913 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent();
8914 if (range == 0) return false;
8915 if (direction < 0) {
8916 return offset > 0;
8917 } else {
8918 return offset < range - 1;
8919 }
8920 }
8921
8922 /**
8923 * Check if this view can be scrolled vertically in a certain direction.
8924 *
8925 * @param direction Negative to check scrolling up, positive to check scrolling down.
8926 * @return true if this view can be scrolled in the specified direction, false otherwise.
8927 */
8928 public boolean canScrollVertically(int direction) {
8929 final int offset = computeVerticalScrollOffset();
8930 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent();
8931 if (range == 0) return false;
8932 if (direction < 0) {
8933 return offset > 0;
8934 } else {
8935 return offset < range - 1;
8936 }
8937 }
8938
8939 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008940 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
8941 * scrollbars are painted only if they have been awakened first.</p>
8942 *
8943 * @param canvas the canvas on which to draw the scrollbars
Joe Malin32736f02011-01-19 16:14:20 -08008944 *
Mike Cleronf116bf82009-09-27 19:14:12 -07008945 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008946 */
Romain Guy1d5b3a62009-11-05 18:44:12 -08008947 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008948 // scrollbars are drawn only when the animation is running
8949 final ScrollabilityCache cache = mScrollCache;
8950 if (cache != null) {
Joe Malin32736f02011-01-19 16:14:20 -08008951
Mike Cleronf116bf82009-09-27 19:14:12 -07008952 int state = cache.state;
Joe Malin32736f02011-01-19 16:14:20 -08008953
Mike Cleronf116bf82009-09-27 19:14:12 -07008954 if (state == ScrollabilityCache.OFF) {
8955 return;
8956 }
Joe Malin32736f02011-01-19 16:14:20 -08008957
Mike Cleronf116bf82009-09-27 19:14:12 -07008958 boolean invalidate = false;
Joe Malin32736f02011-01-19 16:14:20 -08008959
Mike Cleronf116bf82009-09-27 19:14:12 -07008960 if (state == ScrollabilityCache.FADING) {
8961 // We're fading -- get our fade interpolation
8962 if (cache.interpolatorValues == null) {
8963 cache.interpolatorValues = new float[1];
8964 }
Joe Malin32736f02011-01-19 16:14:20 -08008965
Mike Cleronf116bf82009-09-27 19:14:12 -07008966 float[] values = cache.interpolatorValues;
Joe Malin32736f02011-01-19 16:14:20 -08008967
Mike Cleronf116bf82009-09-27 19:14:12 -07008968 // Stops the animation if we're done
8969 if (cache.scrollBarInterpolator.timeToValues(values) ==
8970 Interpolator.Result.FREEZE_END) {
8971 cache.state = ScrollabilityCache.OFF;
8972 } else {
8973 cache.scrollBar.setAlpha(Math.round(values[0]));
8974 }
Joe Malin32736f02011-01-19 16:14:20 -08008975
8976 // This will make the scroll bars inval themselves after
Mike Cleronf116bf82009-09-27 19:14:12 -07008977 // drawing. We only want this when we're fading so that
8978 // we prevent excessive redraws
8979 invalidate = true;
8980 } else {
8981 // We're just on -- but we may have been fading before so
8982 // reset alpha
8983 cache.scrollBar.setAlpha(255);
8984 }
8985
Joe Malin32736f02011-01-19 16:14:20 -08008986
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008987 final int viewFlags = mViewFlags;
8988
8989 final boolean drawHorizontalScrollBar =
8990 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
8991 final boolean drawVerticalScrollBar =
8992 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
8993 && !isVerticalScrollBarHidden();
8994
8995 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
8996 final int width = mRight - mLeft;
8997 final int height = mBottom - mTop;
8998
8999 final ScrollBarDrawable scrollBar = cache.scrollBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009000
Mike Reede8853fc2009-09-04 14:01:48 -04009001 final int scrollX = mScrollX;
9002 final int scrollY = mScrollY;
9003 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
9004
Mike Cleronf116bf82009-09-27 19:14:12 -07009005 int left, top, right, bottom;
Joe Malin32736f02011-01-19 16:14:20 -08009006
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009007 if (drawHorizontalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -08009008 int size = scrollBar.getSize(false);
9009 if (size <= 0) {
9010 size = cache.scrollBarSize;
9011 }
9012
Mike Cleronf116bf82009-09-27 19:14:12 -07009013 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -04009014 computeHorizontalScrollOffset(),
9015 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -04009016 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -07009017 getVerticalScrollbarWidth() : 0;
Joe Malin32736f02011-01-19 16:14:20 -08009018 top = scrollY + height - size - (mUserPaddingBottom & inside);
Mike Cleronf116bf82009-09-27 19:14:12 -07009019 left = scrollX + (mPaddingLeft & inside);
9020 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
9021 bottom = top + size;
9022 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
9023 if (invalidate) {
9024 invalidate(left, top, right, bottom);
9025 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009026 }
9027
9028 if (drawVerticalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -08009029 int size = scrollBar.getSize(true);
9030 if (size <= 0) {
9031 size = cache.scrollBarSize;
9032 }
9033
Mike Reede8853fc2009-09-04 14:01:48 -04009034 scrollBar.setParameters(computeVerticalScrollRange(),
9035 computeVerticalScrollOffset(),
9036 computeVerticalScrollExtent(), true);
Adam Powell20232d02010-12-08 21:08:53 -08009037 switch (mVerticalScrollbarPosition) {
9038 default:
9039 case SCROLLBAR_POSITION_DEFAULT:
9040 case SCROLLBAR_POSITION_RIGHT:
9041 left = scrollX + width - size - (mUserPaddingRight & inside);
9042 break;
9043 case SCROLLBAR_POSITION_LEFT:
9044 left = scrollX + (mUserPaddingLeft & inside);
9045 break;
9046 }
Mike Cleronf116bf82009-09-27 19:14:12 -07009047 top = scrollY + (mPaddingTop & inside);
9048 right = left + size;
9049 bottom = scrollY + height - (mUserPaddingBottom & inside);
9050 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
9051 if (invalidate) {
9052 invalidate(left, top, right, bottom);
9053 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009054 }
9055 }
9056 }
9057 }
Romain Guy8506ab42009-06-11 17:35:47 -07009058
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009059 /**
Romain Guy8506ab42009-06-11 17:35:47 -07009060 * 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 -08009061 * FastScroller is visible.
9062 * @return whether to temporarily hide the vertical scrollbar
9063 * @hide
9064 */
9065 protected boolean isVerticalScrollBarHidden() {
9066 return false;
9067 }
9068
9069 /**
9070 * <p>Draw the horizontal scrollbar if
9071 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
9072 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009073 * @param canvas the canvas on which to draw the scrollbar
9074 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009075 *
9076 * @see #isHorizontalScrollBarEnabled()
9077 * @see #computeHorizontalScrollRange()
9078 * @see #computeHorizontalScrollExtent()
9079 * @see #computeHorizontalScrollOffset()
9080 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -07009081 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -04009082 */
Romain Guy8fb95422010-08-17 18:38:51 -07009083 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
9084 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -04009085 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -04009086 scrollBar.draw(canvas);
9087 }
Mike Reede8853fc2009-09-04 14:01:48 -04009088
Mike Reed4d6fe5f2009-09-03 13:29:05 -04009089 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009090 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
9091 * returns true.</p>
9092 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009093 * @param canvas the canvas on which to draw the scrollbar
9094 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009095 *
9096 * @see #isVerticalScrollBarEnabled()
9097 * @see #computeVerticalScrollRange()
9098 * @see #computeVerticalScrollExtent()
9099 * @see #computeVerticalScrollOffset()
9100 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -04009101 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009102 */
Romain Guy8fb95422010-08-17 18:38:51 -07009103 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
9104 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -04009105 scrollBar.setBounds(l, t, r, b);
9106 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009107 }
9108
9109 /**
9110 * Implement this to do your drawing.
9111 *
9112 * @param canvas the canvas on which the background will be drawn
9113 */
9114 protected void onDraw(Canvas canvas) {
9115 }
9116
9117 /*
9118 * Caller is responsible for calling requestLayout if necessary.
9119 * (This allows addViewInLayout to not request a new layout.)
9120 */
9121 void assignParent(ViewParent parent) {
9122 if (mParent == null) {
9123 mParent = parent;
9124 } else if (parent == null) {
9125 mParent = null;
9126 } else {
9127 throw new RuntimeException("view " + this + " being added, but"
9128 + " it already has a parent");
9129 }
9130 }
9131
9132 /**
9133 * This is called when the view is attached to a window. At this point it
9134 * has a Surface and will start drawing. Note that this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -07009135 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)},
9136 * however it may be called any time before the first onDraw -- including
9137 * before or after {@link #onMeasure(int, int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009138 *
9139 * @see #onDetachedFromWindow()
9140 */
9141 protected void onAttachedToWindow() {
9142 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
9143 mParent.requestTransparentRegion(this);
9144 }
Adam Powell8568c3a2010-04-19 14:26:11 -07009145 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
9146 initialAwakenScrollBars();
9147 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
9148 }
Chet Haasea9b61ac2010-12-20 07:40:25 -08009149 jumpDrawablesToCurrentState();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009150 resolveLayoutDirectionIfNeeded();
9151 resolvePadding();
Fabrice Di Meglio22268862011-06-27 18:13:18 -07009152 resolveTextDirection();
Amith Yamasani4503c8d2011-06-17 12:36:14 -07009153 if (isFocused()) {
9154 InputMethodManager imm = InputMethodManager.peekInstance();
9155 imm.focusIn(this);
9156 }
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07009157 }
Cibu Johny86666632010-02-22 13:01:02 -08009158
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07009159 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009160 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing
9161 * that the parent directionality can and will be resolved before its children.
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07009162 */
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009163 private void resolveLayoutDirectionIfNeeded() {
9164 // Do not resolve if it is not needed
9165 if ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED) == LAYOUT_DIRECTION_RESOLVED) return;
9166
9167 // Clear any previous layout direction resolution
9168 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_RTL;
9169
9170 // Set resolved depending on layout direction
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07009171 switch (getLayoutDirection()) {
9172 case LAYOUT_DIRECTION_INHERIT:
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -07009173 // We cannot do the resolution if there is no parent
9174 if (mParent == null) return;
9175
Cibu Johny86666632010-02-22 13:01:02 -08009176 // If this is root view, no need to look at parent's layout dir.
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -07009177 if (mParent instanceof ViewGroup) {
9178 ViewGroup viewGroup = ((ViewGroup) mParent);
9179
9180 // Check if the parent view group can resolve
9181 if (! viewGroup.canResolveLayoutDirection()) {
9182 return;
9183 }
9184 if (viewGroup.getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
9185 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
9186 }
Cibu Johny86666632010-02-22 13:01:02 -08009187 }
9188 break;
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07009189 case LAYOUT_DIRECTION_RTL:
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009190 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
Cibu Johny86666632010-02-22 13:01:02 -08009191 break;
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -07009192 case LAYOUT_DIRECTION_LOCALE:
9193 if(isLayoutDirectionRtl(Locale.getDefault())) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009194 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -07009195 }
9196 break;
9197 default:
9198 // Nothing to do, LTR by default
9199 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009200
9201 // Set to resolved
9202 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED;
9203 }
9204
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -07009205 /**
9206 * @hide
9207 */
9208 protected void resolvePadding() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009209 // If the user specified the absolute padding (either with android:padding or
9210 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
9211 // use the default padding or the padding from the background drawable
9212 // (stored at this point in mPadding*)
9213 switch (getResolvedLayoutDirection()) {
9214 case LAYOUT_DIRECTION_RTL:
9215 // Start user padding override Right user padding. Otherwise, if Right user
9216 // padding is not defined, use the default Right padding. If Right user padding
9217 // is defined, just use it.
9218 if (mUserPaddingStart >= 0) {
9219 mUserPaddingRight = mUserPaddingStart;
9220 } else if (mUserPaddingRight < 0) {
9221 mUserPaddingRight = mPaddingRight;
9222 }
9223 if (mUserPaddingEnd >= 0) {
9224 mUserPaddingLeft = mUserPaddingEnd;
9225 } else if (mUserPaddingLeft < 0) {
9226 mUserPaddingLeft = mPaddingLeft;
9227 }
9228 break;
9229 case LAYOUT_DIRECTION_LTR:
9230 default:
9231 // Start user padding override Left user padding. Otherwise, if Left user
9232 // padding is not defined, use the default left padding. If Left user padding
9233 // is defined, just use it.
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -07009234 if (mUserPaddingStart >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009235 mUserPaddingLeft = mUserPaddingStart;
9236 } else if (mUserPaddingLeft < 0) {
9237 mUserPaddingLeft = mPaddingLeft;
9238 }
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -07009239 if (mUserPaddingEnd >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009240 mUserPaddingRight = mUserPaddingEnd;
9241 } else if (mUserPaddingRight < 0) {
9242 mUserPaddingRight = mPaddingRight;
9243 }
9244 }
9245
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009246 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom;
9247
9248 recomputePadding();
9249 }
9250
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -07009251 protected boolean canResolveLayoutDirection() {
9252 switch (getLayoutDirection()) {
9253 case LAYOUT_DIRECTION_INHERIT:
9254 return (mParent != null);
9255 default:
9256 return true;
9257 }
9258 }
9259
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009260 /**
Doug Feltc0ccf0c2011-06-23 16:13:18 -07009261 * Reset the resolved layout direction.
9262 *
9263 * Subclasses need to override this method to clear cached information that depends on the
9264 * resolved layout direction, or to inform child views that inherit their layout direction.
9265 * Overrides must also call the superclass implementation at the start of their implementation.
9266 *
9267 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009268 */
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07009269 protected void resetResolvedLayoutDirection() {
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07009270 // Reset the current View resolution
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07009271 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED;
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -07009272 }
9273
9274 /**
9275 * Check if a Locale is corresponding to a RTL script.
9276 *
9277 * @param locale Locale to check
9278 * @return true if a Locale is corresponding to a RTL script.
9279 */
Fabrice Di Meglio22268862011-06-27 18:13:18 -07009280 protected static boolean isLayoutDirectionRtl(Locale locale) {
Fabrice Di Meglioa47f45e2011-06-15 14:22:12 -07009281 return (LocaleUtil.TEXT_LAYOUT_DIRECTION_RTL_DO_NOT_USE ==
9282 LocaleUtil.getLayoutDirectionFromLocale(locale));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009283 }
9284
9285 /**
9286 * This is called when the view is detached from a window. At this point it
9287 * no longer has a surface for drawing.
9288 *
9289 * @see #onAttachedToWindow()
9290 */
9291 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -08009292 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -08009293
Romain Guya440b002010-02-24 15:57:54 -08009294 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -05009295 removeLongPressCallback();
Adam Powell3cb8b632011-01-21 15:34:14 -08009296 removePerformClickCallback();
Svetoslav Ganova0156172011-06-26 17:55:44 -07009297 removeSendViewScrolledAccessibilityEventCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -08009298
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009299 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -08009300
Romain Guy6d7475d2011-07-27 16:28:21 -07009301 destroyLayer();
Romain Guy8dd5b1e2011-01-14 17:28:51 -08009302
Chet Haasedaf98e92011-01-10 14:10:36 -08009303 if (mDisplayList != null) {
9304 mDisplayList.invalidate();
9305 }
9306
Romain Guy8dd5b1e2011-01-14 17:28:51 -08009307 if (mAttachInfo != null) {
9308 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_MSG, this);
9309 mAttachInfo.mHandler.removeMessages(AttachInfo.INVALIDATE_RECT_MSG, this);
9310 }
9311
Patrick Dubroyec84c3a2011-01-13 17:55:37 -08009312 mCurrentAnimation = null;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07009313
9314 resetResolvedLayoutDirection();
9315 resetResolvedTextDirection();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009316 }
9317
9318 /**
9319 * @return The number of times this view has been attached to a window
9320 */
9321 protected int getWindowAttachCount() {
9322 return mWindowAttachCount;
9323 }
9324
9325 /**
9326 * Retrieve a unique token identifying the window this view is attached to.
9327 * @return Return the window's token for use in
9328 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
9329 */
9330 public IBinder getWindowToken() {
9331 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
9332 }
9333
9334 /**
9335 * Retrieve a unique token identifying the top-level "real" window of
9336 * the window that this view is attached to. That is, this is like
9337 * {@link #getWindowToken}, except if the window this view in is a panel
9338 * window (attached to another containing window), then the token of
9339 * the containing window is returned instead.
9340 *
9341 * @return Returns the associated window token, either
9342 * {@link #getWindowToken()} or the containing window's token.
9343 */
9344 public IBinder getApplicationWindowToken() {
9345 AttachInfo ai = mAttachInfo;
9346 if (ai != null) {
9347 IBinder appWindowToken = ai.mPanelParentWindowToken;
9348 if (appWindowToken == null) {
9349 appWindowToken = ai.mWindowToken;
9350 }
9351 return appWindowToken;
9352 }
9353 return null;
9354 }
9355
9356 /**
9357 * Retrieve private session object this view hierarchy is using to
9358 * communicate with the window manager.
9359 * @return the session object to communicate with the window manager
9360 */
9361 /*package*/ IWindowSession getWindowSession() {
9362 return mAttachInfo != null ? mAttachInfo.mSession : null;
9363 }
9364
9365 /**
9366 * @param info the {@link android.view.View.AttachInfo} to associated with
9367 * this view
9368 */
9369 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
9370 //System.out.println("Attached! " + this);
9371 mAttachInfo = info;
9372 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08009373 // We will need to evaluate the drawable state at least once.
9374 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009375 if (mFloatingTreeObserver != null) {
9376 info.mTreeObserver.merge(mFloatingTreeObserver);
9377 mFloatingTreeObserver = null;
9378 }
9379 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
9380 mAttachInfo.mScrollContainers.add(this);
9381 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
9382 }
9383 performCollectViewAttributes(visibility);
9384 onAttachedToWindow();
Adam Powell4afd62b2011-02-18 15:02:18 -08009385
9386 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
9387 mOnAttachStateChangeListeners;
9388 if (listeners != null && listeners.size() > 0) {
9389 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
9390 // perform the dispatching. The iterator is a safe guard against listeners that
9391 // could mutate the list by calling the various add/remove methods. This prevents
9392 // the array from being modified while we iterate it.
9393 for (OnAttachStateChangeListener listener : listeners) {
9394 listener.onViewAttachedToWindow(this);
9395 }
9396 }
9397
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009398 int vis = info.mWindowVisibility;
9399 if (vis != GONE) {
9400 onWindowVisibilityChanged(vis);
9401 }
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08009402 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) {
9403 // If nobody has evaluated the drawable state yet, then do it now.
9404 refreshDrawableState();
9405 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009406 }
9407
9408 void dispatchDetachedFromWindow() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009409 AttachInfo info = mAttachInfo;
9410 if (info != null) {
9411 int vis = info.mWindowVisibility;
9412 if (vis != GONE) {
9413 onWindowVisibilityChanged(GONE);
9414 }
9415 }
9416
9417 onDetachedFromWindow();
Romain Guy01d5edc2011-01-28 11:28:53 -08009418
Adam Powell4afd62b2011-02-18 15:02:18 -08009419 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
9420 mOnAttachStateChangeListeners;
9421 if (listeners != null && listeners.size() > 0) {
9422 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
9423 // perform the dispatching. The iterator is a safe guard against listeners that
9424 // could mutate the list by calling the various add/remove methods. This prevents
9425 // the array from being modified while we iterate it.
9426 for (OnAttachStateChangeListener listener : listeners) {
9427 listener.onViewDetachedFromWindow(this);
9428 }
9429 }
9430
Romain Guy01d5edc2011-01-28 11:28:53 -08009431 if ((mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009432 mAttachInfo.mScrollContainers.remove(this);
9433 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
9434 }
Romain Guy01d5edc2011-01-28 11:28:53 -08009435
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009436 mAttachInfo = null;
9437 }
9438
9439 /**
9440 * Store this view hierarchy's frozen state into the given container.
9441 *
9442 * @param container The SparseArray in which to save the view's state.
9443 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009444 * @see #restoreHierarchyState(android.util.SparseArray)
9445 * @see #dispatchSaveInstanceState(android.util.SparseArray)
9446 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009447 */
9448 public void saveHierarchyState(SparseArray<Parcelable> container) {
9449 dispatchSaveInstanceState(container);
9450 }
9451
9452 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07009453 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for
9454 * this view and its children. May be overridden to modify how freezing happens to a
9455 * 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 -08009456 *
9457 * @param container The SparseArray in which to save the view's state.
9458 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009459 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
9460 * @see #saveHierarchyState(android.util.SparseArray)
9461 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009462 */
9463 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
9464 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
9465 mPrivateFlags &= ~SAVE_STATE_CALLED;
9466 Parcelable state = onSaveInstanceState();
9467 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
9468 throw new IllegalStateException(
9469 "Derived class did not call super.onSaveInstanceState()");
9470 }
9471 if (state != null) {
9472 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
9473 // + ": " + state);
9474 container.put(mID, state);
9475 }
9476 }
9477 }
9478
9479 /**
9480 * Hook allowing a view to generate a representation of its internal state
9481 * that can later be used to create a new instance with that same state.
9482 * This state should only contain information that is not persistent or can
9483 * not be reconstructed later. For example, you will never store your
9484 * current position on screen because that will be computed again when a
9485 * new instance of the view is placed in its view hierarchy.
9486 * <p>
9487 * Some examples of things you may store here: the current cursor position
9488 * in a text view (but usually not the text itself since that is stored in a
9489 * content provider or other persistent storage), the currently selected
9490 * item in a list view.
9491 *
9492 * @return Returns a Parcelable object containing the view's current dynamic
9493 * state, or null if there is nothing interesting to save. The
9494 * default implementation returns null.
Romain Guy5c22a8c2011-05-13 11:48:45 -07009495 * @see #onRestoreInstanceState(android.os.Parcelable)
9496 * @see #saveHierarchyState(android.util.SparseArray)
9497 * @see #dispatchSaveInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009498 * @see #setSaveEnabled(boolean)
9499 */
9500 protected Parcelable onSaveInstanceState() {
9501 mPrivateFlags |= SAVE_STATE_CALLED;
9502 return BaseSavedState.EMPTY_STATE;
9503 }
9504
9505 /**
9506 * Restore this view hierarchy's frozen state from the given container.
9507 *
9508 * @param container The SparseArray which holds previously frozen states.
9509 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009510 * @see #saveHierarchyState(android.util.SparseArray)
9511 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
9512 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009513 */
9514 public void restoreHierarchyState(SparseArray<Parcelable> container) {
9515 dispatchRestoreInstanceState(container);
9516 }
9517
9518 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07009519 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the
9520 * state for this view and its children. May be overridden to modify how restoring
9521 * happens to a view's children; for example, some views may want to not store state
9522 * for their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009523 *
9524 * @param container The SparseArray which holds previously saved state.
9525 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009526 * @see #dispatchSaveInstanceState(android.util.SparseArray)
9527 * @see #restoreHierarchyState(android.util.SparseArray)
9528 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009529 */
9530 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
9531 if (mID != NO_ID) {
9532 Parcelable state = container.get(mID);
9533 if (state != null) {
9534 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
9535 // + ": " + state);
9536 mPrivateFlags &= ~SAVE_STATE_CALLED;
9537 onRestoreInstanceState(state);
9538 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
9539 throw new IllegalStateException(
9540 "Derived class did not call super.onRestoreInstanceState()");
9541 }
9542 }
9543 }
9544 }
9545
9546 /**
9547 * Hook allowing a view to re-apply a representation of its internal state that had previously
9548 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
9549 * null state.
9550 *
9551 * @param state The frozen state that had previously been returned by
9552 * {@link #onSaveInstanceState}.
9553 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009554 * @see #onSaveInstanceState()
9555 * @see #restoreHierarchyState(android.util.SparseArray)
9556 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009557 */
9558 protected void onRestoreInstanceState(Parcelable state) {
9559 mPrivateFlags |= SAVE_STATE_CALLED;
9560 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -08009561 throw new IllegalArgumentException("Wrong state class, expecting View State but "
9562 + "received " + state.getClass().toString() + " instead. This usually happens "
Joe Malin32736f02011-01-19 16:14:20 -08009563 + "when two views of different type have the same id in the same hierarchy. "
9564 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
Romain Guy237c1ce2009-12-08 11:30:25 -08009565 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009566 }
9567 }
9568
9569 /**
9570 * <p>Return the time at which the drawing of the view hierarchy started.</p>
9571 *
9572 * @return the drawing start time in milliseconds
9573 */
9574 public long getDrawingTime() {
9575 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
9576 }
9577
9578 /**
9579 * <p>Enables or disables the duplication of the parent's state into this view. When
9580 * duplication is enabled, this view gets its drawable state from its parent rather
9581 * than from its own internal properties.</p>
9582 *
9583 * <p>Note: in the current implementation, setting this property to true after the
9584 * view was added to a ViewGroup might have no effect at all. This property should
9585 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
9586 *
9587 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
9588 * property is enabled, an exception will be thrown.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009589 *
Gilles Debunnefb817032011-01-13 13:52:49 -08009590 * <p>Note: if the child view uses and updates additionnal states which are unknown to the
9591 * parent, these states should not be affected by this method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009592 *
9593 * @param enabled True to enable duplication of the parent's drawable state, false
9594 * to disable it.
9595 *
9596 * @see #getDrawableState()
9597 * @see #isDuplicateParentStateEnabled()
9598 */
9599 public void setDuplicateParentStateEnabled(boolean enabled) {
9600 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
9601 }
9602
9603 /**
9604 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
9605 *
9606 * @return True if this view's drawable state is duplicated from the parent,
9607 * false otherwise
9608 *
9609 * @see #getDrawableState()
9610 * @see #setDuplicateParentStateEnabled(boolean)
9611 */
9612 public boolean isDuplicateParentStateEnabled() {
9613 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
9614 }
9615
9616 /**
Romain Guy171c5922011-01-06 10:04:23 -08009617 * <p>Specifies the type of layer backing this view. The layer can be
9618 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
9619 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009620 *
Romain Guy171c5922011-01-06 10:04:23 -08009621 * <p>A layer is associated with an optional {@link android.graphics.Paint}
9622 * instance that controls how the layer is composed on screen. The following
9623 * properties of the paint are taken into account when composing the layer:</p>
9624 * <ul>
9625 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
9626 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
9627 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
9628 * </ul>
Joe Malin32736f02011-01-19 16:14:20 -08009629 *
Romain Guy171c5922011-01-06 10:04:23 -08009630 * <p>If this view has an alpha value set to < 1.0 by calling
9631 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
9632 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
9633 * equivalent to setting a hardware layer on this view and providing a paint with
9634 * the desired alpha value.<p>
Joe Malin32736f02011-01-19 16:14:20 -08009635 *
Romain Guy171c5922011-01-06 10:04:23 -08009636 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
9637 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
9638 * for more information on when and how to use layers.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009639 *
Romain Guy171c5922011-01-06 10:04:23 -08009640 * @param layerType The ype of layer to use with this view, must be one of
9641 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
9642 * {@link #LAYER_TYPE_HARDWARE}
9643 * @param paint The paint used to compose the layer. This argument is optional
9644 * and can be null. It is ignored when the layer type is
9645 * {@link #LAYER_TYPE_NONE}
Joe Malin32736f02011-01-19 16:14:20 -08009646 *
9647 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -08009648 * @see #LAYER_TYPE_NONE
9649 * @see #LAYER_TYPE_SOFTWARE
9650 * @see #LAYER_TYPE_HARDWARE
Joe Malin32736f02011-01-19 16:14:20 -08009651 * @see #setAlpha(float)
9652 *
Romain Guy171c5922011-01-06 10:04:23 -08009653 * @attr ref android.R.styleable#View_layerType
9654 */
9655 public void setLayerType(int layerType, Paint paint) {
9656 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
Joe Malin32736f02011-01-19 16:14:20 -08009657 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
Romain Guy171c5922011-01-06 10:04:23 -08009658 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
9659 }
Chet Haasedaf98e92011-01-10 14:10:36 -08009660
Romain Guyd6cd5722011-01-17 14:42:41 -08009661 if (layerType == mLayerType) {
9662 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) {
9663 mLayerPaint = paint == null ? new Paint() : paint;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009664 invalidateParentCaches();
9665 invalidate(true);
Romain Guyd6cd5722011-01-17 14:42:41 -08009666 }
9667 return;
9668 }
Romain Guy171c5922011-01-06 10:04:23 -08009669
9670 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -08009671 switch (mLayerType) {
Chet Haase6f33e812011-05-17 12:42:19 -07009672 case LAYER_TYPE_HARDWARE:
Romain Guy6d7475d2011-07-27 16:28:21 -07009673 destroyLayer();
Chet Haase6f33e812011-05-17 12:42:19 -07009674 // fall through - unaccelerated views may use software layer mechanism instead
Romain Guy6c319ca2011-01-11 14:29:25 -08009675 case LAYER_TYPE_SOFTWARE:
Romain Guy6d7475d2011-07-27 16:28:21 -07009676 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -08009677 break;
Romain Guy6c319ca2011-01-11 14:29:25 -08009678 default:
9679 break;
Romain Guy171c5922011-01-06 10:04:23 -08009680 }
9681
9682 mLayerType = layerType;
Romain Guy3a3133d2011-02-01 22:59:58 -08009683 final boolean layerDisabled = mLayerType == LAYER_TYPE_NONE;
9684 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint);
9685 mLocalDirtyRect = layerDisabled ? null : new Rect();
Romain Guy171c5922011-01-06 10:04:23 -08009686
Romain Guy0fd89bf2011-01-26 15:41:30 -08009687 invalidateParentCaches();
9688 invalidate(true);
Romain Guy171c5922011-01-06 10:04:23 -08009689 }
9690
9691 /**
9692 * Indicates what type of layer is currently associated with this view. By default
9693 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
9694 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
9695 * for more information on the different types of layers.
Joe Malin32736f02011-01-19 16:14:20 -08009696 *
Romain Guy171c5922011-01-06 10:04:23 -08009697 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
9698 * {@link #LAYER_TYPE_HARDWARE}
Joe Malin32736f02011-01-19 16:14:20 -08009699 *
9700 * @see #setLayerType(int, android.graphics.Paint)
Romain Guyf1ae1062011-03-02 18:16:04 -08009701 * @see #buildLayer()
Romain Guy171c5922011-01-06 10:04:23 -08009702 * @see #LAYER_TYPE_NONE
9703 * @see #LAYER_TYPE_SOFTWARE
9704 * @see #LAYER_TYPE_HARDWARE
9705 */
9706 public int getLayerType() {
9707 return mLayerType;
9708 }
Joe Malin32736f02011-01-19 16:14:20 -08009709
Romain Guy6c319ca2011-01-11 14:29:25 -08009710 /**
Romain Guyf1ae1062011-03-02 18:16:04 -08009711 * Forces this view's layer to be created and this view to be rendered
9712 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE},
9713 * invoking this method will have no effect.
9714 *
9715 * This method can for instance be used to render a view into its layer before
9716 * starting an animation. If this view is complex, rendering into the layer
9717 * before starting the animation will avoid skipping frames.
9718 *
9719 * @throws IllegalStateException If this view is not attached to a window
9720 *
9721 * @see #setLayerType(int, android.graphics.Paint)
9722 */
9723 public void buildLayer() {
9724 if (mLayerType == LAYER_TYPE_NONE) return;
9725
9726 if (mAttachInfo == null) {
9727 throw new IllegalStateException("This view must be attached to a window first");
9728 }
9729
9730 switch (mLayerType) {
9731 case LAYER_TYPE_HARDWARE:
9732 getHardwareLayer();
9733 break;
9734 case LAYER_TYPE_SOFTWARE:
9735 buildDrawingCache(true);
9736 break;
9737 }
9738 }
9739
9740 /**
Romain Guy6c319ca2011-01-11 14:29:25 -08009741 * <p>Returns a hardware layer that can be used to draw this view again
9742 * without executing its draw method.</p>
9743 *
9744 * @return A HardwareLayer ready to render, or null if an error occurred.
9745 */
Romain Guy5e7f7662011-01-24 22:35:56 -08009746 HardwareLayer getHardwareLayer() {
Romain Guyea835032011-07-28 19:24:37 -07009747 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null ||
9748 !mAttachInfo.mHardwareRenderer.isEnabled()) {
Romain Guy6c319ca2011-01-11 14:29:25 -08009749 return null;
9750 }
9751
9752 final int width = mRight - mLeft;
9753 final int height = mBottom - mTop;
Joe Malin32736f02011-01-19 16:14:20 -08009754
Romain Guy6c319ca2011-01-11 14:29:25 -08009755 if (width == 0 || height == 0) {
9756 return null;
9757 }
9758
9759 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
9760 if (mHardwareLayer == null) {
9761 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
9762 width, height, isOpaque());
Romain Guy62687ec2011-02-02 15:44:19 -08009763 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -08009764 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
9765 mHardwareLayer.resize(width, height);
Romain Guy62687ec2011-02-02 15:44:19 -08009766 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -08009767 }
9768
Romain Guy59a12ca2011-06-09 17:48:21 -07009769 HardwareCanvas currentCanvas = mAttachInfo.mHardwareCanvas;
Romain Guy5e7f7662011-01-24 22:35:56 -08009770 final HardwareCanvas canvas = mHardwareLayer.start(currentCanvas);
9771 mAttachInfo.mHardwareCanvas = canvas;
Romain Guy6c319ca2011-01-11 14:29:25 -08009772 try {
9773 canvas.setViewport(width, height);
Romain Guy3a3133d2011-02-01 22:59:58 -08009774 canvas.onPreDraw(mLocalDirtyRect);
Romain Guy62687ec2011-02-02 15:44:19 -08009775 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -08009776
Chet Haase88172fe2011-03-07 17:36:33 -08009777 final int restoreCount = canvas.save();
9778
Romain Guy6c319ca2011-01-11 14:29:25 -08009779 computeScroll();
9780 canvas.translate(-mScrollX, -mScrollY);
9781
Romain Guy6c319ca2011-01-11 14:29:25 -08009782 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
Joe Malin32736f02011-01-19 16:14:20 -08009783
Romain Guy6c319ca2011-01-11 14:29:25 -08009784 // Fast path for layouts with no backgrounds
9785 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
9786 mPrivateFlags &= ~DIRTY_MASK;
9787 dispatchDraw(canvas);
9788 } else {
9789 draw(canvas);
9790 }
Joe Malin32736f02011-01-19 16:14:20 -08009791
Chet Haase88172fe2011-03-07 17:36:33 -08009792 canvas.restoreToCount(restoreCount);
Romain Guy6c319ca2011-01-11 14:29:25 -08009793 } finally {
9794 canvas.onPostDraw();
Romain Guy5e7f7662011-01-24 22:35:56 -08009795 mHardwareLayer.end(currentCanvas);
9796 mAttachInfo.mHardwareCanvas = currentCanvas;
Romain Guy6c319ca2011-01-11 14:29:25 -08009797 }
9798 }
9799
9800 return mHardwareLayer;
9801 }
Romain Guy171c5922011-01-06 10:04:23 -08009802
Romain Guy65b345f2011-07-27 18:51:50 -07009803 boolean destroyLayer() {
Romain Guy6d7475d2011-07-27 16:28:21 -07009804 if (mHardwareLayer != null) {
9805 mHardwareLayer.destroy();
9806 mHardwareLayer = null;
Romain Guy65b345f2011-07-27 18:51:50 -07009807 return true;
Romain Guy6d7475d2011-07-27 16:28:21 -07009808 }
Romain Guy65b345f2011-07-27 18:51:50 -07009809 return false;
Romain Guy6d7475d2011-07-27 16:28:21 -07009810 }
9811
Romain Guy171c5922011-01-06 10:04:23 -08009812 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009813 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
9814 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
9815 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
9816 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
9817 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
9818 * null.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009819 *
Romain Guy171c5922011-01-06 10:04:23 -08009820 * <p>Enabling the drawing cache is similar to
9821 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
Chet Haasedaf98e92011-01-10 14:10:36 -08009822 * acceleration is turned off. When hardware acceleration is turned on, enabling the
9823 * drawing cache has no effect on rendering because the system uses a different mechanism
9824 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even
9825 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)}
9826 * for information on how to enable software and hardware layers.</p>
9827 *
9828 * <p>This API can be used to manually generate
9829 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling
9830 * {@link #getDrawingCache()}.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009831 *
9832 * @param enabled true to enable the drawing cache, false otherwise
9833 *
9834 * @see #isDrawingCacheEnabled()
9835 * @see #getDrawingCache()
9836 * @see #buildDrawingCache()
Joe Malin32736f02011-01-19 16:14:20 -08009837 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009838 */
9839 public void setDrawingCacheEnabled(boolean enabled) {
Romain Guy0211a0a2011-02-14 16:34:59 -08009840 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009841 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
9842 }
9843
9844 /**
9845 * <p>Indicates whether the drawing cache is enabled for this view.</p>
9846 *
9847 * @return true if the drawing cache is enabled
9848 *
9849 * @see #setDrawingCacheEnabled(boolean)
9850 * @see #getDrawingCache()
9851 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07009852 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009853 public boolean isDrawingCacheEnabled() {
9854 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
9855 }
9856
9857 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08009858 * Debugging utility which recursively outputs the dirty state of a view and its
9859 * descendants.
Joe Malin32736f02011-01-19 16:14:20 -08009860 *
Chet Haasedaf98e92011-01-10 14:10:36 -08009861 * @hide
9862 */
Romain Guy676b1732011-02-14 14:45:33 -08009863 @SuppressWarnings({"UnusedDeclaration"})
Chet Haasedaf98e92011-01-10 14:10:36 -08009864 public void outputDirtyFlags(String indent, boolean clear, int clearMask) {
9865 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) +
9866 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" +
9867 (mPrivateFlags & View.DRAWING_CACHE_VALID) +
9868 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")");
9869 if (clear) {
9870 mPrivateFlags &= clearMask;
9871 }
9872 if (this instanceof ViewGroup) {
9873 ViewGroup parent = (ViewGroup) this;
9874 final int count = parent.getChildCount();
9875 for (int i = 0; i < count; i++) {
Romain Guy7d7b5492011-01-24 16:33:45 -08009876 final View child = parent.getChildAt(i);
Chet Haasedaf98e92011-01-10 14:10:36 -08009877 child.outputDirtyFlags(indent + " ", clear, clearMask);
9878 }
9879 }
9880 }
9881
9882 /**
9883 * This method is used by ViewGroup to cause its children to restore or recreate their
9884 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need
9885 * to recreate its own display list, which would happen if it went through the normal
9886 * draw/dispatchDraw mechanisms.
9887 *
9888 * @hide
9889 */
9890 protected void dispatchGetDisplayList() {}
Chet Haasef4ac5472011-01-27 10:30:25 -08009891
9892 /**
9893 * A view that is not attached or hardware accelerated cannot create a display list.
9894 * This method checks these conditions and returns the appropriate result.
9895 *
9896 * @return true if view has the ability to create a display list, false otherwise.
9897 *
9898 * @hide
9899 */
9900 public boolean canHaveDisplayList() {
Romain Guy676b1732011-02-14 14:45:33 -08009901 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null);
Chet Haasef4ac5472011-01-27 10:30:25 -08009902 }
Joe Malin32736f02011-01-19 16:14:20 -08009903
Chet Haasedaf98e92011-01-10 14:10:36 -08009904 /**
Romain Guyb051e892010-09-28 19:09:36 -07009905 * <p>Returns a display list that can be used to draw this view again
9906 * without executing its draw method.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009907 *
Romain Guyb051e892010-09-28 19:09:36 -07009908 * @return A DisplayList ready to replay, or null if caching is not enabled.
Chet Haasedaf98e92011-01-10 14:10:36 -08009909 *
9910 * @hide
Romain Guyb051e892010-09-28 19:09:36 -07009911 */
Chet Haasedaf98e92011-01-10 14:10:36 -08009912 public DisplayList getDisplayList() {
Chet Haasef4ac5472011-01-27 10:30:25 -08009913 if (!canHaveDisplayList()) {
Romain Guyb051e892010-09-28 19:09:36 -07009914 return null;
9915 }
9916
Chet Haasedaf98e92011-01-10 14:10:36 -08009917 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 ||
9918 mDisplayList == null || !mDisplayList.isValid() ||
9919 mRecreateDisplayList)) {
9920 // Don't need to recreate the display list, just need to tell our
9921 // children to restore/recreate theirs
9922 if (mDisplayList != null && mDisplayList.isValid() &&
9923 !mRecreateDisplayList) {
9924 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
9925 mPrivateFlags &= ~DIRTY_MASK;
9926 dispatchGetDisplayList();
9927
9928 return mDisplayList;
9929 }
9930
9931 // If we got here, we're recreating it. Mark it as such to ensure that
9932 // we copy in child display lists into ours in drawChild()
9933 mRecreateDisplayList = true;
Chet Haase9e90a992011-01-04 16:23:21 -08009934 if (mDisplayList == null) {
Jeff Brown162a0212011-07-21 17:02:54 -07009935 mDisplayList = mAttachInfo.mHardwareRenderer.createDisplayList();
Chet Haasedaf98e92011-01-10 14:10:36 -08009936 // If we're creating a new display list, make sure our parent gets invalidated
9937 // since they will need to recreate their display list to account for this
9938 // new child display list.
Romain Guy0fd89bf2011-01-26 15:41:30 -08009939 invalidateParentCaches();
Chet Haase9e90a992011-01-04 16:23:21 -08009940 }
Romain Guyb051e892010-09-28 19:09:36 -07009941
9942 final HardwareCanvas canvas = mDisplayList.start();
9943 try {
9944 int width = mRight - mLeft;
9945 int height = mBottom - mTop;
9946
9947 canvas.setViewport(width, height);
Romain Guy7d7b5492011-01-24 16:33:45 -08009948 // The dirty rect should always be null for a display list
9949 canvas.onPreDraw(null);
Romain Guyb051e892010-09-28 19:09:36 -07009950
Chet Haase88172fe2011-03-07 17:36:33 -08009951 final int restoreCount = canvas.save();
9952
Chet Haasedaf98e92011-01-10 14:10:36 -08009953 computeScroll();
9954 canvas.translate(-mScrollX, -mScrollY);
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009955 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
Romain Guya9489272011-06-22 20:58:11 -07009956 mPrivateFlags &= ~DIRTY_MASK;
Joe Malin32736f02011-01-19 16:14:20 -08009957
Romain Guyb051e892010-09-28 19:09:36 -07009958 // Fast path for layouts with no backgrounds
9959 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
Romain Guyb051e892010-09-28 19:09:36 -07009960 dispatchDraw(canvas);
9961 } else {
9962 draw(canvas);
9963 }
Joe Malin32736f02011-01-19 16:14:20 -08009964
Chet Haase88172fe2011-03-07 17:36:33 -08009965 canvas.restoreToCount(restoreCount);
Romain Guyb051e892010-09-28 19:09:36 -07009966 } finally {
9967 canvas.onPostDraw();
9968
9969 mDisplayList.end();
Romain Guyb051e892010-09-28 19:09:36 -07009970 }
Chet Haase77785f92011-01-25 23:22:09 -08009971 } else {
9972 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
9973 mPrivateFlags &= ~DIRTY_MASK;
Romain Guyb051e892010-09-28 19:09:36 -07009974 }
9975
9976 return mDisplayList;
9977 }
9978
9979 /**
Romain Guyfbd8f692009-06-26 14:51:58 -07009980 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009981 *
Romain Guyfbd8f692009-06-26 14:51:58 -07009982 * @return A non-scaled bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -08009983 *
Romain Guyfbd8f692009-06-26 14:51:58 -07009984 * @see #getDrawingCache(boolean)
9985 */
9986 public Bitmap getDrawingCache() {
9987 return getDrawingCache(false);
9988 }
9989
9990 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009991 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
9992 * is null when caching is disabled. If caching is enabled and the cache is not ready,
9993 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
9994 * draw from the cache when the cache is enabled. To benefit from the cache, you must
9995 * request the drawing cache by calling this method and draw it on screen if the
9996 * returned bitmap is not null.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009997 *
Romain Guyfbd8f692009-06-26 14:51:58 -07009998 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
9999 * this method will create a bitmap of the same size as this view. Because this bitmap
10000 * will be drawn scaled by the parent ViewGroup, the result on screen might show
10001 * scaling artifacts. To avoid such artifacts, you should call this method by setting
10002 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
10003 * size than the view. This implies that your application must be able to handle this
10004 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080010005 *
Romain Guyfbd8f692009-06-26 14:51:58 -070010006 * @param autoScale Indicates whether the generated bitmap should be scaled based on
10007 * the current density of the screen when the application is in compatibility
10008 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010009 *
Romain Guyfbd8f692009-06-26 14:51:58 -070010010 * @return A bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -080010011 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010012 * @see #setDrawingCacheEnabled(boolean)
10013 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -070010014 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010015 * @see #destroyDrawingCache()
10016 */
Romain Guyfbd8f692009-06-26 14:51:58 -070010017 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010018 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
10019 return null;
10020 }
10021 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -070010022 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010023 }
Romain Guy02890fd2010-08-06 17:58:44 -070010024 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010025 }
10026
10027 /**
10028 * <p>Frees the resources used by the drawing cache. If you call
10029 * {@link #buildDrawingCache()} manually without calling
10030 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
10031 * should cleanup the cache with this method afterwards.</p>
10032 *
10033 * @see #setDrawingCacheEnabled(boolean)
10034 * @see #buildDrawingCache()
10035 * @see #getDrawingCache()
10036 */
10037 public void destroyDrawingCache() {
10038 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070010039 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010040 mDrawingCache = null;
10041 }
Romain Guyfbd8f692009-06-26 14:51:58 -070010042 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070010043 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -070010044 mUnscaledDrawingCache = null;
10045 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010046 }
10047
10048 /**
10049 * Setting a solid background color for the drawing cache's bitmaps will improve
10050 * perfromance and memory usage. Note, though that this should only be used if this
10051 * view will always be drawn on top of a solid color.
10052 *
10053 * @param color The background color to use for the drawing cache's bitmap
10054 *
10055 * @see #setDrawingCacheEnabled(boolean)
10056 * @see #buildDrawingCache()
10057 * @see #getDrawingCache()
10058 */
10059 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -080010060 if (color != mDrawingCacheBackgroundColor) {
10061 mDrawingCacheBackgroundColor = color;
10062 mPrivateFlags &= ~DRAWING_CACHE_VALID;
10063 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010064 }
10065
10066 /**
10067 * @see #setDrawingCacheBackgroundColor(int)
10068 *
10069 * @return The background color to used for the drawing cache's bitmap
10070 */
10071 public int getDrawingCacheBackgroundColor() {
10072 return mDrawingCacheBackgroundColor;
10073 }
10074
10075 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070010076 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080010077 *
Romain Guyfbd8f692009-06-26 14:51:58 -070010078 * @see #buildDrawingCache(boolean)
10079 */
10080 public void buildDrawingCache() {
10081 buildDrawingCache(false);
10082 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -080010083
Romain Guyfbd8f692009-06-26 14:51:58 -070010084 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010085 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
10086 *
10087 * <p>If you call {@link #buildDrawingCache()} manually without calling
10088 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
10089 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Joe Malin32736f02011-01-19 16:14:20 -080010090 *
Romain Guyfbd8f692009-06-26 14:51:58 -070010091 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
10092 * this method will create a bitmap of the same size as this view. Because this bitmap
10093 * will be drawn scaled by the parent ViewGroup, the result on screen might show
10094 * scaling artifacts. To avoid such artifacts, you should call this method by setting
10095 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
10096 * size than the view. This implies that your application must be able to handle this
10097 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080010098 *
Romain Guy0d9275e2010-10-26 14:22:30 -070010099 * <p>You should avoid calling this method when hardware acceleration is enabled. If
10100 * you do not need the drawing cache bitmap, calling this method will increase memory
Joe Malin32736f02011-01-19 16:14:20 -080010101 * usage and cause the view to be rendered in software once, thus negatively impacting
Romain Guy0d9275e2010-10-26 14:22:30 -070010102 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010103 *
10104 * @see #getDrawingCache()
10105 * @see #destroyDrawingCache()
10106 */
Romain Guyfbd8f692009-06-26 14:51:58 -070010107 public void buildDrawingCache(boolean autoScale) {
10108 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -070010109 mDrawingCache == null : mUnscaledDrawingCache == null)) {
Romain Guy0211a0a2011-02-14 16:34:59 -080010110 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010111
10112 if (ViewDebug.TRACE_HIERARCHY) {
10113 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
10114 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010115
Romain Guy8506ab42009-06-11 17:35:47 -070010116 int width = mRight - mLeft;
10117 int height = mBottom - mTop;
10118
10119 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -070010120 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -070010121
Romain Guye1123222009-06-29 14:24:56 -070010122 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070010123 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
10124 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -070010125 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010126
10127 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -070010128 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -080010129 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010130
10131 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -070010132 // Projected bitmap size in bytes
Adam Powell26153a32010-11-08 15:22:27 -080010133 (width * height * (opaque && !use32BitCache ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010134 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
10135 destroyDrawingCache();
Romain Guy0211a0a2011-02-14 16:34:59 -080010136 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010137 return;
10138 }
10139
10140 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -070010141 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010142
10143 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010144 Bitmap.Config quality;
10145 if (!opaque) {
Romain Guy676b1732011-02-14 14:45:33 -080010146 // Never pick ARGB_4444 because it looks awful
10147 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010148 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
10149 case DRAWING_CACHE_QUALITY_AUTO:
10150 quality = Bitmap.Config.ARGB_8888;
10151 break;
10152 case DRAWING_CACHE_QUALITY_LOW:
Romain Guy676b1732011-02-14 14:45:33 -080010153 quality = Bitmap.Config.ARGB_8888;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010154 break;
10155 case DRAWING_CACHE_QUALITY_HIGH:
10156 quality = Bitmap.Config.ARGB_8888;
10157 break;
10158 default:
10159 quality = Bitmap.Config.ARGB_8888;
10160 break;
10161 }
10162 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -070010163 // Optimization for translucent windows
10164 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -080010165 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010166 }
10167
10168 // Try to cleanup memory
10169 if (bitmap != null) bitmap.recycle();
10170
10171 try {
10172 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -070010173 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -070010174 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -070010175 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070010176 } else {
Romain Guy02890fd2010-08-06 17:58:44 -070010177 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070010178 }
Adam Powell26153a32010-11-08 15:22:27 -080010179 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010180 } catch (OutOfMemoryError e) {
10181 // If there is not enough memory to create the bitmap cache, just
10182 // ignore the issue as bitmap caches are not required to draw the
10183 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -070010184 if (autoScale) {
10185 mDrawingCache = null;
10186 } else {
10187 mUnscaledDrawingCache = null;
10188 }
Romain Guy0211a0a2011-02-14 16:34:59 -080010189 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010190 return;
10191 }
10192
10193 clear = drawingCacheBackgroundColor != 0;
10194 }
10195
10196 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010197 if (attachInfo != null) {
10198 canvas = attachInfo.mCanvas;
10199 if (canvas == null) {
10200 canvas = new Canvas();
10201 }
10202 canvas.setBitmap(bitmap);
10203 // Temporarily clobber the cached Canvas in case one of our children
10204 // is also using a drawing cache. Without this, the children would
10205 // steal the canvas by attaching their own bitmap to it and bad, bad
10206 // thing would happen (invisible views, corrupted drawings, etc.)
10207 attachInfo.mCanvas = null;
10208 } else {
10209 // This case should hopefully never or seldom happen
10210 canvas = new Canvas(bitmap);
10211 }
10212
10213 if (clear) {
10214 bitmap.eraseColor(drawingCacheBackgroundColor);
10215 }
10216
10217 computeScroll();
10218 final int restoreCount = canvas.save();
Joe Malin32736f02011-01-19 16:14:20 -080010219
Romain Guye1123222009-06-29 14:24:56 -070010220 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070010221 final float scale = attachInfo.mApplicationScale;
10222 canvas.scale(scale, scale);
10223 }
Joe Malin32736f02011-01-19 16:14:20 -080010224
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010225 canvas.translate(-mScrollX, -mScrollY);
10226
Romain Guy5bcdff42009-05-14 21:27:18 -070010227 mPrivateFlags |= DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -080010228 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
10229 mLayerType != LAYER_TYPE_NONE) {
Romain Guy0d9275e2010-10-26 14:22:30 -070010230 mPrivateFlags |= DRAWING_CACHE_VALID;
10231 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010232
10233 // Fast path for layouts with no backgrounds
10234 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
10235 if (ViewDebug.TRACE_HIERARCHY) {
10236 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
10237 }
Romain Guy5bcdff42009-05-14 21:27:18 -070010238 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010239 dispatchDraw(canvas);
10240 } else {
10241 draw(canvas);
10242 }
10243
10244 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070010245 canvas.setBitmap(null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010246
10247 if (attachInfo != null) {
10248 // Restore the cached Canvas for our siblings
10249 attachInfo.mCanvas = canvas;
10250 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010251 }
10252 }
10253
10254 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010255 * Create a snapshot of the view into a bitmap. We should probably make
10256 * some form of this public, but should think about the API.
10257 */
Romain Guy223ff5c2010-03-02 17:07:47 -080010258 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -070010259 int width = mRight - mLeft;
10260 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010261
Dianne Hackborn8cae1242009-09-10 14:32:16 -070010262 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -070010263 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -070010264 width = (int) ((width * scale) + 0.5f);
10265 height = (int) ((height * scale) + 0.5f);
Joe Malin32736f02011-01-19 16:14:20 -080010266
Romain Guy8c11e312009-09-14 15:15:30 -070010267 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010268 if (bitmap == null) {
10269 throw new OutOfMemoryError();
10270 }
10271
Dianne Hackborn8cae1242009-09-10 14:32:16 -070010272 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Joe Malin32736f02011-01-19 16:14:20 -080010273
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010274 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010275 if (attachInfo != null) {
10276 canvas = attachInfo.mCanvas;
10277 if (canvas == null) {
10278 canvas = new Canvas();
10279 }
10280 canvas.setBitmap(bitmap);
10281 // Temporarily clobber the cached Canvas in case one of our children
10282 // is also using a drawing cache. Without this, the children would
10283 // steal the canvas by attaching their own bitmap to it and bad, bad
10284 // things would happen (invisible views, corrupted drawings, etc.)
10285 attachInfo.mCanvas = null;
10286 } else {
10287 // This case should hopefully never or seldom happen
10288 canvas = new Canvas(bitmap);
10289 }
10290
Romain Guy5bcdff42009-05-14 21:27:18 -070010291 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010292 bitmap.eraseColor(backgroundColor);
10293 }
10294
10295 computeScroll();
10296 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -070010297 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010298 canvas.translate(-mScrollX, -mScrollY);
10299
Romain Guy5bcdff42009-05-14 21:27:18 -070010300 // Temporarily remove the dirty mask
10301 int flags = mPrivateFlags;
10302 mPrivateFlags &= ~DIRTY_MASK;
10303
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010304 // Fast path for layouts with no backgrounds
10305 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
10306 dispatchDraw(canvas);
10307 } else {
10308 draw(canvas);
10309 }
10310
Romain Guy5bcdff42009-05-14 21:27:18 -070010311 mPrivateFlags = flags;
10312
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010313 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070010314 canvas.setBitmap(null);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010315
10316 if (attachInfo != null) {
10317 // Restore the cached Canvas for our siblings
10318 attachInfo.mCanvas = canvas;
10319 }
Romain Guy8506ab42009-06-11 17:35:47 -070010320
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070010321 return bitmap;
10322 }
10323
10324 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010325 * Indicates whether this View is currently in edit mode. A View is usually
10326 * in edit mode when displayed within a developer tool. For instance, if
10327 * this View is being drawn by a visual user interface builder, this method
10328 * should return true.
10329 *
10330 * Subclasses should check the return value of this method to provide
10331 * different behaviors if their normal behavior might interfere with the
10332 * host environment. For instance: the class spawns a thread in its
10333 * constructor, the drawing code relies on device-specific features, etc.
10334 *
10335 * This method is usually checked in the drawing code of custom widgets.
10336 *
10337 * @return True if this View is in edit mode, false otherwise.
10338 */
10339 public boolean isInEditMode() {
10340 return false;
10341 }
10342
10343 /**
10344 * If the View draws content inside its padding and enables fading edges,
10345 * it needs to support padding offsets. Padding offsets are added to the
10346 * fading edges to extend the length of the fade so that it covers pixels
10347 * drawn inside the padding.
10348 *
10349 * Subclasses of this class should override this method if they need
10350 * to draw content inside the padding.
10351 *
10352 * @return True if padding offset must be applied, false otherwise.
10353 *
10354 * @see #getLeftPaddingOffset()
10355 * @see #getRightPaddingOffset()
10356 * @see #getTopPaddingOffset()
10357 * @see #getBottomPaddingOffset()
10358 *
10359 * @since CURRENT
10360 */
10361 protected boolean isPaddingOffsetRequired() {
10362 return false;
10363 }
10364
10365 /**
10366 * Amount by which to extend the left fading region. Called only when
10367 * {@link #isPaddingOffsetRequired()} returns true.
10368 *
10369 * @return The left padding offset in pixels.
10370 *
10371 * @see #isPaddingOffsetRequired()
10372 *
10373 * @since CURRENT
10374 */
10375 protected int getLeftPaddingOffset() {
10376 return 0;
10377 }
10378
10379 /**
10380 * Amount by which to extend the right fading region. Called only when
10381 * {@link #isPaddingOffsetRequired()} returns true.
10382 *
10383 * @return The right padding offset in pixels.
10384 *
10385 * @see #isPaddingOffsetRequired()
10386 *
10387 * @since CURRENT
10388 */
10389 protected int getRightPaddingOffset() {
10390 return 0;
10391 }
10392
10393 /**
10394 * Amount by which to extend the top fading region. Called only when
10395 * {@link #isPaddingOffsetRequired()} returns true.
10396 *
10397 * @return The top padding offset in pixels.
10398 *
10399 * @see #isPaddingOffsetRequired()
10400 *
10401 * @since CURRENT
10402 */
10403 protected int getTopPaddingOffset() {
10404 return 0;
10405 }
10406
10407 /**
10408 * Amount by which to extend the bottom fading region. Called only when
10409 * {@link #isPaddingOffsetRequired()} returns true.
10410 *
10411 * @return The bottom padding offset in pixels.
10412 *
10413 * @see #isPaddingOffsetRequired()
10414 *
10415 * @since CURRENT
10416 */
10417 protected int getBottomPaddingOffset() {
10418 return 0;
10419 }
10420
10421 /**
Romain Guyf2fc4602011-07-19 15:20:03 -070010422 * @hide
10423 * @param offsetRequired
10424 */
10425 protected int getFadeTop(boolean offsetRequired) {
10426 int top = mPaddingTop;
10427 if (offsetRequired) top += getTopPaddingOffset();
10428 return top;
10429 }
10430
10431 /**
10432 * @hide
10433 * @param offsetRequired
10434 */
10435 protected int getFadeHeight(boolean offsetRequired) {
10436 int padding = mPaddingTop;
10437 if (offsetRequired) padding += getTopPaddingOffset();
10438 return mBottom - mTop - mPaddingBottom - padding;
10439 }
10440
10441 /**
Romain Guy2bffd262010-09-12 17:40:02 -070010442 * <p>Indicates whether this view is attached to an hardware accelerated
10443 * window or not.</p>
Joe Malin32736f02011-01-19 16:14:20 -080010444 *
Romain Guy2bffd262010-09-12 17:40:02 -070010445 * <p>Even if this method returns true, it does not mean that every call
10446 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
10447 * accelerated {@link android.graphics.Canvas}. For instance, if this view
10448 * is drawn onto an offscren {@link android.graphics.Bitmap} and its
10449 * window is hardware accelerated,
10450 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
10451 * return false, and this method will return true.</p>
Joe Malin32736f02011-01-19 16:14:20 -080010452 *
Romain Guy2bffd262010-09-12 17:40:02 -070010453 * @return True if the view is attached to a window and the window is
10454 * hardware accelerated; false in any other case.
10455 */
10456 public boolean isHardwareAccelerated() {
10457 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
10458 }
Joe Malin32736f02011-01-19 16:14:20 -080010459
Romain Guy2bffd262010-09-12 17:40:02 -070010460 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010461 * Manually render this view (and all of its children) to the given Canvas.
10462 * The view must have already done a full layout before this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070010463 * called. When implementing a view, implement
10464 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method.
10465 * If you do need to override this method, call the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010466 *
10467 * @param canvas The Canvas to which the View is rendered.
10468 */
10469 public void draw(Canvas canvas) {
10470 if (ViewDebug.TRACE_HIERARCHY) {
10471 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
10472 }
10473
Romain Guy5bcdff42009-05-14 21:27:18 -070010474 final int privateFlags = mPrivateFlags;
10475 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
10476 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
10477 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -070010478
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010479 /*
10480 * Draw traversal performs several drawing steps which must be executed
10481 * in the appropriate order:
10482 *
10483 * 1. Draw the background
10484 * 2. If necessary, save the canvas' layers to prepare for fading
10485 * 3. Draw view's content
10486 * 4. Draw children
10487 * 5. If necessary, draw the fading edges and restore layers
10488 * 6. Draw decorations (scrollbars for instance)
10489 */
10490
10491 // Step 1, draw the background, if needed
10492 int saveCount;
10493
Romain Guy24443ea2009-05-11 11:56:30 -070010494 if (!dirtyOpaque) {
10495 final Drawable background = mBGDrawable;
10496 if (background != null) {
10497 final int scrollX = mScrollX;
10498 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010499
Romain Guy24443ea2009-05-11 11:56:30 -070010500 if (mBackgroundSizeChanged) {
10501 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
10502 mBackgroundSizeChanged = false;
10503 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010504
Romain Guy24443ea2009-05-11 11:56:30 -070010505 if ((scrollX | scrollY) == 0) {
10506 background.draw(canvas);
10507 } else {
10508 canvas.translate(scrollX, scrollY);
10509 background.draw(canvas);
10510 canvas.translate(-scrollX, -scrollY);
10511 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010512 }
10513 }
10514
10515 // skip step 2 & 5 if possible (common case)
10516 final int viewFlags = mViewFlags;
10517 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
10518 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
10519 if (!verticalEdges && !horizontalEdges) {
10520 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070010521 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010522
10523 // Step 4, draw the children
10524 dispatchDraw(canvas);
10525
10526 // Step 6, draw decorations (scrollbars)
10527 onDrawScrollBars(canvas);
10528
10529 // we're done...
10530 return;
10531 }
10532
10533 /*
10534 * Here we do the full fledged routine...
10535 * (this is an uncommon case where speed matters less,
10536 * this is why we repeat some of the tests that have been
10537 * done above)
10538 */
10539
10540 boolean drawTop = false;
10541 boolean drawBottom = false;
10542 boolean drawLeft = false;
10543 boolean drawRight = false;
10544
10545 float topFadeStrength = 0.0f;
10546 float bottomFadeStrength = 0.0f;
10547 float leftFadeStrength = 0.0f;
10548 float rightFadeStrength = 0.0f;
10549
10550 // Step 2, save the canvas' layers
10551 int paddingLeft = mPaddingLeft;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010552
10553 final boolean offsetRequired = isPaddingOffsetRequired();
10554 if (offsetRequired) {
10555 paddingLeft += getLeftPaddingOffset();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010556 }
10557
10558 int left = mScrollX + paddingLeft;
10559 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
Romain Guyf2fc4602011-07-19 15:20:03 -070010560 int top = mScrollY + getFadeTop(offsetRequired);
10561 int bottom = top + getFadeHeight(offsetRequired);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010562
10563 if (offsetRequired) {
10564 right += getRightPaddingOffset();
10565 bottom += getBottomPaddingOffset();
10566 }
10567
10568 final ScrollabilityCache scrollabilityCache = mScrollCache;
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010569 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
10570 int length = (int) fadeHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010571
10572 // clip the fade length if top and bottom fades overlap
10573 // overlapping fades produce odd-looking artifacts
10574 if (verticalEdges && (top + length > bottom - length)) {
10575 length = (bottom - top) / 2;
10576 }
10577
10578 // also clip horizontal fades if necessary
10579 if (horizontalEdges && (left + length > right - length)) {
10580 length = (right - left) / 2;
10581 }
10582
10583 if (verticalEdges) {
10584 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010585 drawTop = topFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010586 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010587 drawBottom = bottomFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010588 }
10589
10590 if (horizontalEdges) {
10591 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010592 drawLeft = leftFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010593 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010594 drawRight = rightFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010595 }
10596
10597 saveCount = canvas.getSaveCount();
10598
10599 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -070010600 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010601 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
10602
10603 if (drawTop) {
10604 canvas.saveLayer(left, top, right, top + length, null, flags);
10605 }
10606
10607 if (drawBottom) {
10608 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
10609 }
10610
10611 if (drawLeft) {
10612 canvas.saveLayer(left, top, left + length, bottom, null, flags);
10613 }
10614
10615 if (drawRight) {
10616 canvas.saveLayer(right - length, top, right, bottom, null, flags);
10617 }
10618 } else {
10619 scrollabilityCache.setFadeColor(solidColor);
10620 }
10621
10622 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070010623 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010624
10625 // Step 4, draw the children
10626 dispatchDraw(canvas);
10627
10628 // Step 5, draw the fade effect and restore layers
10629 final Paint p = scrollabilityCache.paint;
10630 final Matrix matrix = scrollabilityCache.matrix;
10631 final Shader fade = scrollabilityCache.shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010632
10633 if (drawTop) {
10634 matrix.setScale(1, fadeHeight * topFadeStrength);
10635 matrix.postTranslate(left, top);
10636 fade.setLocalMatrix(matrix);
10637 canvas.drawRect(left, top, right, top + length, p);
10638 }
10639
10640 if (drawBottom) {
10641 matrix.setScale(1, fadeHeight * bottomFadeStrength);
10642 matrix.postRotate(180);
10643 matrix.postTranslate(left, bottom);
10644 fade.setLocalMatrix(matrix);
10645 canvas.drawRect(left, bottom - length, right, bottom, p);
10646 }
10647
10648 if (drawLeft) {
10649 matrix.setScale(1, fadeHeight * leftFadeStrength);
10650 matrix.postRotate(-90);
10651 matrix.postTranslate(left, top);
10652 fade.setLocalMatrix(matrix);
10653 canvas.drawRect(left, top, left + length, bottom, p);
10654 }
10655
10656 if (drawRight) {
10657 matrix.setScale(1, fadeHeight * rightFadeStrength);
10658 matrix.postRotate(90);
10659 matrix.postTranslate(right, top);
10660 fade.setLocalMatrix(matrix);
10661 canvas.drawRect(right - length, top, right, bottom, p);
10662 }
10663
10664 canvas.restoreToCount(saveCount);
10665
10666 // Step 6, draw decorations (scrollbars)
10667 onDrawScrollBars(canvas);
10668 }
10669
10670 /**
10671 * Override this if your view is known to always be drawn on top of a solid color background,
10672 * and needs to draw fading edges. Returning a non-zero color enables the view system to
10673 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
10674 * should be set to 0xFF.
10675 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070010676 * @see #setVerticalFadingEdgeEnabled(boolean)
10677 * @see #setHorizontalFadingEdgeEnabled(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010678 *
10679 * @return The known solid color background for this view, or 0 if the color may vary
10680 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070010681 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010682 public int getSolidColor() {
10683 return 0;
10684 }
10685
10686 /**
10687 * Build a human readable string representation of the specified view flags.
10688 *
10689 * @param flags the view flags to convert to a string
10690 * @return a String representing the supplied flags
10691 */
10692 private static String printFlags(int flags) {
10693 String output = "";
10694 int numFlags = 0;
10695 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
10696 output += "TAKES_FOCUS";
10697 numFlags++;
10698 }
10699
10700 switch (flags & VISIBILITY_MASK) {
10701 case INVISIBLE:
10702 if (numFlags > 0) {
10703 output += " ";
10704 }
10705 output += "INVISIBLE";
10706 // USELESS HERE numFlags++;
10707 break;
10708 case GONE:
10709 if (numFlags > 0) {
10710 output += " ";
10711 }
10712 output += "GONE";
10713 // USELESS HERE numFlags++;
10714 break;
10715 default:
10716 break;
10717 }
10718 return output;
10719 }
10720
10721 /**
10722 * Build a human readable string representation of the specified private
10723 * view flags.
10724 *
10725 * @param privateFlags the private view flags to convert to a string
10726 * @return a String representing the supplied flags
10727 */
10728 private static String printPrivateFlags(int privateFlags) {
10729 String output = "";
10730 int numFlags = 0;
10731
10732 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
10733 output += "WANTS_FOCUS";
10734 numFlags++;
10735 }
10736
10737 if ((privateFlags & FOCUSED) == FOCUSED) {
10738 if (numFlags > 0) {
10739 output += " ";
10740 }
10741 output += "FOCUSED";
10742 numFlags++;
10743 }
10744
10745 if ((privateFlags & SELECTED) == SELECTED) {
10746 if (numFlags > 0) {
10747 output += " ";
10748 }
10749 output += "SELECTED";
10750 numFlags++;
10751 }
10752
10753 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
10754 if (numFlags > 0) {
10755 output += " ";
10756 }
10757 output += "IS_ROOT_NAMESPACE";
10758 numFlags++;
10759 }
10760
10761 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
10762 if (numFlags > 0) {
10763 output += " ";
10764 }
10765 output += "HAS_BOUNDS";
10766 numFlags++;
10767 }
10768
10769 if ((privateFlags & DRAWN) == DRAWN) {
10770 if (numFlags > 0) {
10771 output += " ";
10772 }
10773 output += "DRAWN";
10774 // USELESS HERE numFlags++;
10775 }
10776 return output;
10777 }
10778
10779 /**
10780 * <p>Indicates whether or not this view's layout will be requested during
10781 * the next hierarchy layout pass.</p>
10782 *
10783 * @return true if the layout will be forced during next layout pass
10784 */
10785 public boolean isLayoutRequested() {
10786 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
10787 }
10788
10789 /**
10790 * Assign a size and position to a view and all of its
10791 * descendants
10792 *
10793 * <p>This is the second phase of the layout mechanism.
10794 * (The first is measuring). In this phase, each parent calls
10795 * layout on all of its children to position them.
10796 * This is typically done using the child measurements
Chet Haase9c087442011-01-12 16:20:16 -080010797 * that were stored in the measure pass().</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010798 *
Chet Haase9c087442011-01-12 16:20:16 -080010799 * <p>Derived classes should not override this method.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010800 * Derived classes with children should override
10801 * onLayout. In that method, they should
Chet Haase9c087442011-01-12 16:20:16 -080010802 * call layout on each of their children.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010803 *
10804 * @param l Left position, relative to parent
10805 * @param t Top position, relative to parent
10806 * @param r Right position, relative to parent
10807 * @param b Bottom position, relative to parent
10808 */
Romain Guy5429e1d2010-09-07 12:38:00 -070010809 @SuppressWarnings({"unchecked"})
Chet Haase9c087442011-01-12 16:20:16 -080010810 public void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -070010811 int oldL = mLeft;
10812 int oldT = mTop;
10813 int oldB = mBottom;
10814 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010815 boolean changed = setFrame(l, t, r, b);
10816 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
10817 if (ViewDebug.TRACE_HIERARCHY) {
10818 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
10819 }
10820
10821 onLayout(changed, l, t, r, b);
10822 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -070010823
10824 if (mOnLayoutChangeListeners != null) {
10825 ArrayList<OnLayoutChangeListener> listenersCopy =
10826 (ArrayList<OnLayoutChangeListener>) mOnLayoutChangeListeners.clone();
10827 int numListeners = listenersCopy.size();
10828 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -070010829 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -070010830 }
10831 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010832 }
10833 mPrivateFlags &= ~FORCE_LAYOUT;
10834 }
10835
10836 /**
10837 * Called from layout when this view should
10838 * assign a size and position to each of its children.
10839 *
10840 * Derived classes with children should override
10841 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -070010842 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010843 * @param changed This is a new size or position for this view
10844 * @param left Left position, relative to parent
10845 * @param top Top position, relative to parent
10846 * @param right Right position, relative to parent
10847 * @param bottom Bottom position, relative to parent
10848 */
10849 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
10850 }
10851
10852 /**
10853 * Assign a size and position to this view.
10854 *
10855 * This is called from layout.
10856 *
10857 * @param left Left position, relative to parent
10858 * @param top Top position, relative to parent
10859 * @param right Right position, relative to parent
10860 * @param bottom Bottom position, relative to parent
10861 * @return true if the new size and position are different than the
10862 * previous ones
10863 * {@hide}
10864 */
10865 protected boolean setFrame(int left, int top, int right, int bottom) {
10866 boolean changed = false;
10867
10868 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -070010869 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010870 + right + "," + bottom + ")");
10871 }
10872
10873 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
10874 changed = true;
10875
10876 // Remember our drawn bit
10877 int drawn = mPrivateFlags & DRAWN;
10878
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010879 int oldWidth = mRight - mLeft;
10880 int oldHeight = mBottom - mTop;
Chet Haase75755e22011-07-18 17:48:25 -070010881 int newWidth = right - left;
10882 int newHeight = bottom - top;
10883 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight);
10884
10885 // Invalidate our old position
10886 invalidate(sizeChanged);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010887
10888 mLeft = left;
10889 mTop = top;
10890 mRight = right;
10891 mBottom = bottom;
10892
10893 mPrivateFlags |= HAS_BOUNDS;
10894
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010895
Chet Haase75755e22011-07-18 17:48:25 -070010896 if (sizeChanged) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -080010897 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
10898 // A change in dimension means an auto-centered pivot point changes, too
10899 mMatrixDirty = true;
10900 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010901 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
10902 }
10903
10904 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
10905 // If we are visible, force the DRAWN bit to on so that
10906 // this invalidate will go through (at least to our parent).
10907 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -080010908 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010909 // the DRAWN bit.
10910 mPrivateFlags |= DRAWN;
Chet Haase75755e22011-07-18 17:48:25 -070010911 invalidate(sizeChanged);
Chet Haasef28595e2011-01-31 18:52:12 -080010912 // parent display list may need to be recreated based on a change in the bounds
10913 // of any child
10914 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010915 }
10916
10917 // Reset drawn bit to original value (invalidate turns it off)
10918 mPrivateFlags |= drawn;
10919
10920 mBackgroundSizeChanged = true;
10921 }
10922 return changed;
10923 }
10924
10925 /**
10926 * Finalize inflating a view from XML. This is called as the last phase
10927 * of inflation, after all child views have been added.
10928 *
10929 * <p>Even if the subclass overrides onFinishInflate, they should always be
10930 * sure to call the super method, so that we get called.
10931 */
10932 protected void onFinishInflate() {
10933 }
10934
10935 /**
10936 * Returns the resources associated with this view.
10937 *
10938 * @return Resources object.
10939 */
10940 public Resources getResources() {
10941 return mResources;
10942 }
10943
10944 /**
10945 * Invalidates the specified Drawable.
10946 *
10947 * @param drawable the drawable to invalidate
10948 */
10949 public void invalidateDrawable(Drawable drawable) {
10950 if (verifyDrawable(drawable)) {
10951 final Rect dirty = drawable.getBounds();
10952 final int scrollX = mScrollX;
10953 final int scrollY = mScrollY;
10954
10955 invalidate(dirty.left + scrollX, dirty.top + scrollY,
10956 dirty.right + scrollX, dirty.bottom + scrollY);
10957 }
10958 }
10959
10960 /**
10961 * Schedules an action on a drawable to occur at a specified time.
10962 *
10963 * @param who the recipient of the action
10964 * @param what the action to run on the drawable
10965 * @param when the time at which the action must occur. Uses the
10966 * {@link SystemClock#uptimeMillis} timebase.
10967 */
10968 public void scheduleDrawable(Drawable who, Runnable what, long when) {
10969 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
10970 mAttachInfo.mHandler.postAtTime(what, who, when);
10971 }
10972 }
10973
10974 /**
10975 * Cancels a scheduled action on a drawable.
10976 *
10977 * @param who the recipient of the action
10978 * @param what the action to cancel
10979 */
10980 public void unscheduleDrawable(Drawable who, Runnable what) {
10981 if (verifyDrawable(who) && what != null && mAttachInfo != null) {
10982 mAttachInfo.mHandler.removeCallbacks(what, who);
10983 }
10984 }
10985
10986 /**
10987 * Unschedule any events associated with the given Drawable. This can be
10988 * used when selecting a new Drawable into a view, so that the previous
10989 * one is completely unscheduled.
10990 *
10991 * @param who The Drawable to unschedule.
10992 *
10993 * @see #drawableStateChanged
10994 */
10995 public void unscheduleDrawable(Drawable who) {
10996 if (mAttachInfo != null) {
10997 mAttachInfo.mHandler.removeCallbacksAndMessages(who);
10998 }
10999 }
11000
Fabrice Di Meglioc0053222011-06-13 12:16:51 -070011001 /**
11002 * Return the layout direction of a given Drawable.
11003 *
11004 * @param who the Drawable to query
11005 *
11006 * @hide
11007 */
11008 public int getResolvedLayoutDirection(Drawable who) {
11009 return (who == mBGDrawable) ? getResolvedLayoutDirection() : LAYOUT_DIRECTION_DEFAULT;
Fabrice Di Meglio6a036402011-05-23 14:43:23 -070011010 }
11011
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011012 /**
11013 * If your view subclass is displaying its own Drawable objects, it should
11014 * override this function and return true for any Drawable it is
11015 * displaying. This allows animations for those drawables to be
11016 * scheduled.
11017 *
11018 * <p>Be sure to call through to the super class when overriding this
11019 * function.
11020 *
11021 * @param who The Drawable to verify. Return true if it is one you are
11022 * displaying, else return the result of calling through to the
11023 * super class.
11024 *
11025 * @return boolean If true than the Drawable is being displayed in the
11026 * view; else false and it is not allowed to animate.
11027 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070011028 * @see #unscheduleDrawable(android.graphics.drawable.Drawable)
11029 * @see #drawableStateChanged()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011030 */
11031 protected boolean verifyDrawable(Drawable who) {
11032 return who == mBGDrawable;
11033 }
11034
11035 /**
11036 * This function is called whenever the state of the view changes in such
11037 * a way that it impacts the state of drawables being shown.
11038 *
11039 * <p>Be sure to call through to the superclass when overriding this
11040 * function.
11041 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070011042 * @see Drawable#setState(int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011043 */
11044 protected void drawableStateChanged() {
11045 Drawable d = mBGDrawable;
11046 if (d != null && d.isStateful()) {
11047 d.setState(getDrawableState());
11048 }
11049 }
11050
11051 /**
11052 * Call this to force a view to update its drawable state. This will cause
11053 * drawableStateChanged to be called on this view. Views that are interested
11054 * in the new state should call getDrawableState.
11055 *
11056 * @see #drawableStateChanged
11057 * @see #getDrawableState
11058 */
11059 public void refreshDrawableState() {
11060 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
11061 drawableStateChanged();
11062
11063 ViewParent parent = mParent;
11064 if (parent != null) {
11065 parent.childDrawableStateChanged(this);
11066 }
11067 }
11068
11069 /**
11070 * Return an array of resource IDs of the drawable states representing the
11071 * current state of the view.
11072 *
11073 * @return The current drawable state
11074 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070011075 * @see Drawable#setState(int[])
11076 * @see #drawableStateChanged()
11077 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011078 */
11079 public final int[] getDrawableState() {
11080 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
11081 return mDrawableState;
11082 } else {
11083 mDrawableState = onCreateDrawableState(0);
11084 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
11085 return mDrawableState;
11086 }
11087 }
11088
11089 /**
11090 * Generate the new {@link android.graphics.drawable.Drawable} state for
11091 * this view. This is called by the view
11092 * system when the cached Drawable state is determined to be invalid. To
11093 * retrieve the current state, you should use {@link #getDrawableState}.
11094 *
11095 * @param extraSpace if non-zero, this is the number of extra entries you
11096 * would like in the returned array in which you can place your own
11097 * states.
11098 *
11099 * @return Returns an array holding the current {@link Drawable} state of
11100 * the view.
11101 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070011102 * @see #mergeDrawableStates(int[], int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011103 */
11104 protected int[] onCreateDrawableState(int extraSpace) {
11105 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
11106 mParent instanceof View) {
11107 return ((View) mParent).onCreateDrawableState(extraSpace);
11108 }
11109
11110 int[] drawableState;
11111
11112 int privateFlags = mPrivateFlags;
11113
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011114 int viewStateIndex = 0;
11115 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
11116 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
11117 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -070011118 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011119 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
11120 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Adam Powell5a7e94e2011-04-25 15:30:43 -070011121 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested &&
11122 HardwareRenderer.isAvailable()) {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011123 // This is set if HW acceleration is requested, even if the current
11124 // process doesn't allow it. This is just to allow app preview
11125 // windows to better match their app.
11126 viewStateIndex |= VIEW_STATE_ACCELERATED;
11127 }
PY Laligandc33d8d49e2011-03-14 18:22:53 -070011128 if ((privateFlags & HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011129
Christopher Tate3d4bf172011-03-28 16:16:46 -070011130 final int privateFlags2 = mPrivateFlags2;
11131 if ((privateFlags2 & DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT;
11132 if ((privateFlags2 & DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED;
11133
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011134 drawableState = VIEW_STATE_SETS[viewStateIndex];
11135
11136 //noinspection ConstantIfStatement
11137 if (false) {
11138 Log.i("View", "drawableStateIndex=" + viewStateIndex);
11139 Log.i("View", toString()
11140 + " pressed=" + ((privateFlags & PRESSED) != 0)
11141 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
11142 + " fo=" + hasFocus()
11143 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011144 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011145 + ": " + Arrays.toString(drawableState));
11146 }
11147
11148 if (extraSpace == 0) {
11149 return drawableState;
11150 }
11151
11152 final int[] fullState;
11153 if (drawableState != null) {
11154 fullState = new int[drawableState.length + extraSpace];
11155 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
11156 } else {
11157 fullState = new int[extraSpace];
11158 }
11159
11160 return fullState;
11161 }
11162
11163 /**
11164 * Merge your own state values in <var>additionalState</var> into the base
11165 * state values <var>baseState</var> that were returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070011166 * {@link #onCreateDrawableState(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011167 *
11168 * @param baseState The base state values returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070011169 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011170 * own additional state values.
11171 *
11172 * @param additionalState The additional state values you would like
11173 * added to <var>baseState</var>; this array is not modified.
11174 *
11175 * @return As a convenience, the <var>baseState</var> array you originally
11176 * passed into the function is returned.
11177 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070011178 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011179 */
11180 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
11181 final int N = baseState.length;
11182 int i = N - 1;
11183 while (i >= 0 && baseState[i] == 0) {
11184 i--;
11185 }
11186 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
11187 return baseState;
11188 }
11189
11190 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -070011191 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
11192 * on all Drawable objects associated with this view.
11193 */
11194 public void jumpDrawablesToCurrentState() {
11195 if (mBGDrawable != null) {
11196 mBGDrawable.jumpToCurrentState();
11197 }
11198 }
11199
11200 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011201 * Sets the background color for this view.
11202 * @param color the color of the background
11203 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000011204 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011205 public void setBackgroundColor(int color) {
Chet Haase70d4ba12010-10-06 09:46:45 -070011206 if (mBGDrawable instanceof ColorDrawable) {
11207 ((ColorDrawable) mBGDrawable).setColor(color);
11208 } else {
11209 setBackgroundDrawable(new ColorDrawable(color));
11210 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011211 }
11212
11213 /**
11214 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -070011215 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011216 * @param resid The identifier of the resource.
11217 * @attr ref android.R.styleable#View_background
11218 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000011219 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011220 public void setBackgroundResource(int resid) {
11221 if (resid != 0 && resid == mBackgroundResource) {
11222 return;
11223 }
11224
11225 Drawable d= null;
11226 if (resid != 0) {
11227 d = mResources.getDrawable(resid);
11228 }
11229 setBackgroundDrawable(d);
11230
11231 mBackgroundResource = resid;
11232 }
11233
11234 /**
11235 * Set the background to a given Drawable, or remove the background. If the
11236 * background has padding, this View's padding is set to the background's
11237 * padding. However, when a background is removed, this View's padding isn't
11238 * touched. If setting the padding is desired, please use
11239 * {@link #setPadding(int, int, int, int)}.
11240 *
11241 * @param d The Drawable to use as the background, or null to remove the
11242 * background
11243 */
11244 public void setBackgroundDrawable(Drawable d) {
Adam Powell4d36ec12011-07-17 16:44:16 -070011245 if (d == mBGDrawable) {
11246 return;
11247 }
11248
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011249 boolean requestLayout = false;
11250
11251 mBackgroundResource = 0;
11252
11253 /*
11254 * Regardless of whether we're setting a new background or not, we want
11255 * to clear the previous drawable.
11256 */
11257 if (mBGDrawable != null) {
11258 mBGDrawable.setCallback(null);
11259 unscheduleDrawable(mBGDrawable);
11260 }
11261
11262 if (d != null) {
11263 Rect padding = sThreadLocal.get();
11264 if (padding == null) {
11265 padding = new Rect();
11266 sThreadLocal.set(padding);
11267 }
11268 if (d.getPadding(padding)) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011269 switch (d.getResolvedLayoutDirectionSelf()) {
11270 case LAYOUT_DIRECTION_RTL:
11271 setPadding(padding.right, padding.top, padding.left, padding.bottom);
11272 break;
11273 case LAYOUT_DIRECTION_LTR:
11274 default:
11275 setPadding(padding.left, padding.top, padding.right, padding.bottom);
11276 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011277 }
11278
11279 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
11280 // if it has a different minimum size, we should layout again
11281 if (mBGDrawable == null || mBGDrawable.getMinimumHeight() != d.getMinimumHeight() ||
11282 mBGDrawable.getMinimumWidth() != d.getMinimumWidth()) {
11283 requestLayout = true;
11284 }
11285
11286 d.setCallback(this);
11287 if (d.isStateful()) {
11288 d.setState(getDrawableState());
11289 }
11290 d.setVisible(getVisibility() == VISIBLE, false);
11291 mBGDrawable = d;
11292
11293 if ((mPrivateFlags & SKIP_DRAW) != 0) {
11294 mPrivateFlags &= ~SKIP_DRAW;
11295 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
11296 requestLayout = true;
11297 }
11298 } else {
11299 /* Remove the background */
11300 mBGDrawable = null;
11301
11302 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
11303 /*
11304 * This view ONLY drew the background before and we're removing
11305 * the background, so now it won't draw anything
11306 * (hence we SKIP_DRAW)
11307 */
11308 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
11309 mPrivateFlags |= SKIP_DRAW;
11310 }
11311
11312 /*
11313 * When the background is set, we try to apply its padding to this
11314 * View. When the background is removed, we don't touch this View's
11315 * padding. This is noted in the Javadocs. Hence, we don't need to
11316 * requestLayout(), the invalidate() below is sufficient.
11317 */
11318
11319 // The old background's minimum size could have affected this
11320 // View's layout, so let's requestLayout
11321 requestLayout = true;
11322 }
11323
Romain Guy8f1344f52009-05-15 16:03:59 -070011324 computeOpaqueFlags();
11325
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011326 if (requestLayout) {
11327 requestLayout();
11328 }
11329
11330 mBackgroundSizeChanged = true;
Romain Guy0fd89bf2011-01-26 15:41:30 -080011331 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011332 }
11333
11334 /**
11335 * Gets the background drawable
11336 * @return The drawable used as the background for this view, if any.
11337 */
11338 public Drawable getBackground() {
11339 return mBGDrawable;
11340 }
11341
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011342 /**
11343 * Sets the 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 #getPaddingLeft}, {@link #getPaddingTop},
11346 * {@link #getPaddingRight} 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_paddingLeft
11352 * @attr ref android.R.styleable#View_paddingRight
11353 * @attr ref android.R.styleable#View_paddingTop
11354 * @param left the left padding in pixels
11355 * @param top the top padding in pixels
11356 * @param right the right padding in pixels
11357 * @param bottom the bottom padding in pixels
11358 */
11359 public void setPadding(int left, int top, int right, int bottom) {
11360 boolean changed = false;
11361
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011362 mUserPaddingRelative = false;
11363
Adam Powell20232d02010-12-08 21:08:53 -080011364 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011365 mUserPaddingRight = right;
11366 mUserPaddingBottom = bottom;
11367
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011368 final int viewFlags = mViewFlags;
Romain Guy8506ab42009-06-11 17:35:47 -070011369
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011370 // Common case is there are no scroll bars.
11371 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011372 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -080011373 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011374 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -080011375 switch (mVerticalScrollbarPosition) {
11376 case SCROLLBAR_POSITION_DEFAULT:
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011377 if (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
11378 left += offset;
11379 } else {
11380 right += offset;
11381 }
11382 break;
Adam Powell20232d02010-12-08 21:08:53 -080011383 case SCROLLBAR_POSITION_RIGHT:
11384 right += offset;
11385 break;
11386 case SCROLLBAR_POSITION_LEFT:
11387 left += offset;
11388 break;
11389 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011390 }
Adam Powell20232d02010-12-08 21:08:53 -080011391 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011392 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
11393 ? 0 : getHorizontalScrollbarHeight();
11394 }
11395 }
Romain Guy8506ab42009-06-11 17:35:47 -070011396
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011397 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011398 changed = true;
11399 mPaddingLeft = left;
11400 }
11401 if (mPaddingTop != top) {
11402 changed = true;
11403 mPaddingTop = top;
11404 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011405 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011406 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011407 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011408 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011409 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011410 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070011411 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011412 }
11413
11414 if (changed) {
11415 requestLayout();
11416 }
11417 }
11418
11419 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011420 * Sets the relative padding. The view may add on the space required to display
11421 * the scrollbars, depending on the style and visibility of the scrollbars.
11422 * So the values returned from {@link #getPaddingStart}, {@link #getPaddingTop},
11423 * {@link #getPaddingEnd} and {@link #getPaddingBottom} may be different
11424 * from the values set in this call.
11425 *
11426 * @attr ref android.R.styleable#View_padding
11427 * @attr ref android.R.styleable#View_paddingBottom
11428 * @attr ref android.R.styleable#View_paddingStart
11429 * @attr ref android.R.styleable#View_paddingEnd
11430 * @attr ref android.R.styleable#View_paddingTop
11431 * @param start the start padding in pixels
11432 * @param top the top padding in pixels
11433 * @param end the end padding in pixels
11434 * @param bottom the bottom padding in pixels
11435 *
11436 * @hide
11437 */
11438 public void setPaddingRelative(int start, int top, int end, int bottom) {
11439 mUserPaddingRelative = true;
Fabrice Di Megliof9e36502011-06-21 18:41:48 -070011440
11441 mUserPaddingStart = start;
11442 mUserPaddingEnd = end;
11443
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011444 switch(getResolvedLayoutDirection()) {
11445 case LAYOUT_DIRECTION_RTL:
11446 setPadding(end, top, start, bottom);
11447 break;
11448 case LAYOUT_DIRECTION_LTR:
11449 default:
11450 setPadding(start, top, end, bottom);
11451 }
11452 }
11453
11454 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011455 * Returns the top padding of this view.
11456 *
11457 * @return the top padding in pixels
11458 */
11459 public int getPaddingTop() {
11460 return mPaddingTop;
11461 }
11462
11463 /**
11464 * Returns the bottom padding of this view. If there are inset and enabled
11465 * scrollbars, this value may include the space required to display the
11466 * scrollbars as well.
11467 *
11468 * @return the bottom padding in pixels
11469 */
11470 public int getPaddingBottom() {
11471 return mPaddingBottom;
11472 }
11473
11474 /**
11475 * Returns the left padding of this view. If there are inset and enabled
11476 * scrollbars, this value may include the space required to display the
11477 * scrollbars as well.
11478 *
11479 * @return the left padding in pixels
11480 */
11481 public int getPaddingLeft() {
11482 return mPaddingLeft;
11483 }
11484
11485 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011486 * Returns the start padding of this view. If there are inset and enabled
11487 * scrollbars, this value may include the space required to display the
11488 * scrollbars as well.
11489 *
11490 * @return the start padding in pixels
11491 *
11492 * @hide
11493 */
11494 public int getPaddingStart() {
11495 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
11496 mPaddingRight : mPaddingLeft;
11497 }
11498
11499 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011500 * Returns the right padding of this view. If there are inset and enabled
11501 * scrollbars, this value may include the space required to display the
11502 * scrollbars as well.
11503 *
11504 * @return the right padding in pixels
11505 */
11506 public int getPaddingRight() {
11507 return mPaddingRight;
11508 }
11509
11510 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011511 * Returns the end padding of this view. If there are inset and enabled
11512 * scrollbars, this value may include the space required to display the
11513 * scrollbars as well.
11514 *
11515 * @return the end padding in pixels
11516 *
11517 * @hide
11518 */
11519 public int getPaddingEnd() {
11520 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
11521 mPaddingLeft : mPaddingRight;
11522 }
11523
11524 /**
11525 * Return if the padding as been set thru relative values
11526 * {@link #setPaddingRelative(int, int, int, int)} or thru
11527 * @attr ref android.R.styleable#View_paddingStart or
11528 * @attr ref android.R.styleable#View_paddingEnd
11529 *
11530 * @return true if the padding is relative or false if it is not.
11531 *
11532 * @hide
11533 */
11534 public boolean isPaddingRelative() {
11535 return mUserPaddingRelative;
11536 }
11537
11538 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011539 * Changes the selection state of this view. A view can be selected or not.
11540 * Note that selection is not the same as focus. Views are typically
11541 * selected in the context of an AdapterView like ListView or GridView;
11542 * the selected view is the view that is highlighted.
11543 *
11544 * @param selected true if the view must be selected, false otherwise
11545 */
11546 public void setSelected(boolean selected) {
11547 if (((mPrivateFlags & SELECTED) != 0) != selected) {
11548 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -070011549 if (!selected) resetPressedState();
Romain Guy0fd89bf2011-01-26 15:41:30 -080011550 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011551 refreshDrawableState();
11552 dispatchSetSelected(selected);
11553 }
11554 }
11555
11556 /**
11557 * Dispatch setSelected to all of this View's children.
11558 *
11559 * @see #setSelected(boolean)
11560 *
11561 * @param selected The new selected state
11562 */
11563 protected void dispatchSetSelected(boolean selected) {
11564 }
11565
11566 /**
11567 * Indicates the selection state of this view.
11568 *
11569 * @return true if the view is selected, false otherwise
11570 */
11571 @ViewDebug.ExportedProperty
11572 public boolean isSelected() {
11573 return (mPrivateFlags & SELECTED) != 0;
11574 }
11575
11576 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011577 * Changes the activated state of this view. A view can be activated or not.
11578 * Note that activation is not the same as selection. Selection is
11579 * a transient property, representing the view (hierarchy) the user is
11580 * currently interacting with. Activation is a longer-term state that the
11581 * user can move views in and out of. For example, in a list view with
11582 * single or multiple selection enabled, the views in the current selection
11583 * set are activated. (Um, yeah, we are deeply sorry about the terminology
11584 * here.) The activated state is propagated down to children of the view it
11585 * is set on.
11586 *
11587 * @param activated true if the view must be activated, false otherwise
11588 */
11589 public void setActivated(boolean activated) {
11590 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
11591 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
Romain Guy0fd89bf2011-01-26 15:41:30 -080011592 invalidate(true);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011593 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -070011594 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070011595 }
11596 }
11597
11598 /**
11599 * Dispatch setActivated to all of this View's children.
11600 *
11601 * @see #setActivated(boolean)
11602 *
11603 * @param activated The new activated state
11604 */
11605 protected void dispatchSetActivated(boolean activated) {
11606 }
11607
11608 /**
11609 * Indicates the activation state of this view.
11610 *
11611 * @return true if the view is activated, false otherwise
11612 */
11613 @ViewDebug.ExportedProperty
11614 public boolean isActivated() {
11615 return (mPrivateFlags & ACTIVATED) != 0;
11616 }
11617
11618 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011619 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
11620 * observer can be used to get notifications when global events, like
11621 * layout, happen.
11622 *
11623 * The returned ViewTreeObserver observer is not guaranteed to remain
11624 * valid for the lifetime of this View. If the caller of this method keeps
11625 * a long-lived reference to ViewTreeObserver, it should always check for
11626 * the return value of {@link ViewTreeObserver#isAlive()}.
11627 *
11628 * @return The ViewTreeObserver for this view's hierarchy.
11629 */
11630 public ViewTreeObserver getViewTreeObserver() {
11631 if (mAttachInfo != null) {
11632 return mAttachInfo.mTreeObserver;
11633 }
11634 if (mFloatingTreeObserver == null) {
11635 mFloatingTreeObserver = new ViewTreeObserver();
11636 }
11637 return mFloatingTreeObserver;
11638 }
11639
11640 /**
11641 * <p>Finds the topmost view in the current view hierarchy.</p>
11642 *
11643 * @return the topmost view containing this view
11644 */
11645 public View getRootView() {
11646 if (mAttachInfo != null) {
11647 final View v = mAttachInfo.mRootView;
11648 if (v != null) {
11649 return v;
11650 }
11651 }
Romain Guy8506ab42009-06-11 17:35:47 -070011652
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011653 View parent = this;
11654
11655 while (parent.mParent != null && parent.mParent instanceof View) {
11656 parent = (View) parent.mParent;
11657 }
11658
11659 return parent;
11660 }
11661
11662 /**
11663 * <p>Computes the coordinates of this view on the screen. The argument
11664 * must be an array of two integers. After the method returns, the array
11665 * contains the x and y location in that order.</p>
11666 *
11667 * @param location an array of two integers in which to hold the coordinates
11668 */
11669 public void getLocationOnScreen(int[] location) {
11670 getLocationInWindow(location);
11671
11672 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -070011673 if (info != null) {
11674 location[0] += info.mWindowLeft;
11675 location[1] += info.mWindowTop;
11676 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011677 }
11678
11679 /**
11680 * <p>Computes the coordinates of this view in its window. The argument
11681 * must be an array of two integers. After the method returns, the array
11682 * contains the x and y location in that order.</p>
11683 *
11684 * @param location an array of two integers in which to hold the coordinates
11685 */
11686 public void getLocationInWindow(int[] location) {
11687 if (location == null || location.length < 2) {
11688 throw new IllegalArgumentException("location must be an array of "
11689 + "two integers");
11690 }
11691
Michael Jurka4d2bd4c2010-11-30 18:15:11 -080011692 location[0] = mLeft + (int) (mTranslationX + 0.5f);
11693 location[1] = mTop + (int) (mTranslationY + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011694
11695 ViewParent viewParent = mParent;
11696 while (viewParent instanceof View) {
11697 final View view = (View)viewParent;
Michael Jurka4d2bd4c2010-11-30 18:15:11 -080011698 location[0] += view.mLeft + (int) (view.mTranslationX + 0.5f) - view.mScrollX;
11699 location[1] += view.mTop + (int) (view.mTranslationY + 0.5f) - view.mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011700 viewParent = view.mParent;
11701 }
Romain Guy8506ab42009-06-11 17:35:47 -070011702
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070011703 if (viewParent instanceof ViewRootImpl) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011704 // *cough*
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070011705 final ViewRootImpl vr = (ViewRootImpl)viewParent;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011706 location[1] -= vr.mCurScrollY;
11707 }
11708 }
11709
11710 /**
11711 * {@hide}
11712 * @param id the id of the view to be found
11713 * @return the view of the specified id, null if cannot be found
11714 */
11715 protected View findViewTraversal(int id) {
11716 if (id == mID) {
11717 return this;
11718 }
11719 return null;
11720 }
11721
11722 /**
11723 * {@hide}
11724 * @param tag the tag of the view to be found
11725 * @return the view of specified tag, null if cannot be found
11726 */
11727 protected View findViewWithTagTraversal(Object tag) {
11728 if (tag != null && tag.equals(mTag)) {
11729 return this;
11730 }
11731 return null;
11732 }
11733
11734 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080011735 * {@hide}
11736 * @param predicate The predicate to evaluate.
11737 * @return The first view that matches the predicate or null.
11738 */
11739 protected View findViewByPredicateTraversal(Predicate<View> predicate) {
11740 if (predicate.apply(this)) {
11741 return this;
11742 }
11743 return null;
11744 }
11745
11746 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011747 * Look for a child view with the given id. If this view has the given
11748 * id, return this view.
11749 *
11750 * @param id The id to search for.
11751 * @return The view that has the given id in the hierarchy or null
11752 */
11753 public final View findViewById(int id) {
11754 if (id < 0) {
11755 return null;
11756 }
11757 return findViewTraversal(id);
11758 }
11759
11760 /**
11761 * Look for a child view with the given tag. If this view has the given
11762 * tag, return this view.
11763 *
11764 * @param tag The tag to search for, using "tag.equals(getTag())".
11765 * @return The View that has the given tag in the hierarchy or null
11766 */
11767 public final View findViewWithTag(Object tag) {
11768 if (tag == null) {
11769 return null;
11770 }
11771 return findViewWithTagTraversal(tag);
11772 }
11773
11774 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080011775 * {@hide}
11776 * Look for a child view that matches the specified predicate.
11777 * If this view matches the predicate, return this view.
11778 *
11779 * @param predicate The predicate to evaluate.
11780 * @return The first view that matches the predicate or null.
11781 */
11782 public final View findViewByPredicate(Predicate<View> predicate) {
11783 return findViewByPredicateTraversal(predicate);
11784 }
11785
11786 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011787 * Sets the identifier for this view. The identifier does not have to be
11788 * unique in this view's hierarchy. The identifier should be a positive
11789 * number.
11790 *
11791 * @see #NO_ID
Romain Guy5c22a8c2011-05-13 11:48:45 -070011792 * @see #getId()
11793 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011794 *
11795 * @param id a number used to identify the view
11796 *
11797 * @attr ref android.R.styleable#View_id
11798 */
11799 public void setId(int id) {
11800 mID = id;
11801 }
11802
11803 /**
11804 * {@hide}
11805 *
11806 * @param isRoot true if the view belongs to the root namespace, false
11807 * otherwise
11808 */
11809 public void setIsRootNamespace(boolean isRoot) {
11810 if (isRoot) {
11811 mPrivateFlags |= IS_ROOT_NAMESPACE;
11812 } else {
11813 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
11814 }
11815 }
11816
11817 /**
11818 * {@hide}
11819 *
11820 * @return true if the view belongs to the root namespace, false otherwise
11821 */
11822 public boolean isRootNamespace() {
11823 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
11824 }
11825
11826 /**
11827 * Returns this view's identifier.
11828 *
11829 * @return a positive integer used to identify the view or {@link #NO_ID}
11830 * if the view has no ID
11831 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070011832 * @see #setId(int)
11833 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011834 * @attr ref android.R.styleable#View_id
11835 */
11836 @ViewDebug.CapturedViewProperty
11837 public int getId() {
11838 return mID;
11839 }
11840
11841 /**
11842 * Returns this view's tag.
11843 *
11844 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -070011845 *
11846 * @see #setTag(Object)
11847 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011848 */
11849 @ViewDebug.ExportedProperty
11850 public Object getTag() {
11851 return mTag;
11852 }
11853
11854 /**
11855 * Sets the tag associated with this view. A tag can be used to mark
11856 * a view in its hierarchy and does not have to be unique within the
11857 * hierarchy. Tags can also be used to store data within a view without
11858 * resorting to another data structure.
11859 *
11860 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -070011861 *
11862 * @see #getTag()
11863 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011864 */
11865 public void setTag(final Object tag) {
11866 mTag = tag;
11867 }
11868
11869 /**
Romain Guyd90a3312009-05-06 14:54:28 -070011870 * Returns the tag associated with this view and the specified key.
11871 *
11872 * @param key The key identifying the tag
11873 *
11874 * @return the Object stored in this view as a tag
11875 *
11876 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -070011877 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -070011878 */
11879 public Object getTag(int key) {
11880 SparseArray<Object> tags = null;
11881 synchronized (sTagsLock) {
11882 if (sTags != null) {
11883 tags = sTags.get(this);
11884 }
11885 }
11886
11887 if (tags != null) return tags.get(key);
11888 return null;
11889 }
11890
11891 /**
11892 * Sets a tag associated with this view and a key. A tag can be used
11893 * to mark a view in its hierarchy and does not have to be unique within
11894 * the hierarchy. Tags can also be used to store data within a view
11895 * without resorting to another data structure.
11896 *
11897 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -070011898 * application to ensure it is unique (see the <a
11899 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
11900 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -070011901 * the Android framework or not associated with any package will cause
11902 * an {@link IllegalArgumentException} to be thrown.
11903 *
11904 * @param key The key identifying the tag
11905 * @param tag An Object to tag the view with
11906 *
11907 * @throws IllegalArgumentException If they specified key is not valid
11908 *
11909 * @see #setTag(Object)
11910 * @see #getTag(int)
11911 */
11912 public void setTag(int key, final Object tag) {
11913 // If the package id is 0x00 or 0x01, it's either an undefined package
11914 // or a framework id
11915 if ((key >>> 24) < 2) {
11916 throw new IllegalArgumentException("The key must be an application-specific "
11917 + "resource id.");
11918 }
11919
11920 setTagInternal(this, key, tag);
11921 }
11922
11923 /**
11924 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
11925 * framework id.
11926 *
11927 * @hide
11928 */
11929 public void setTagInternal(int key, Object tag) {
11930 if ((key >>> 24) != 0x1) {
11931 throw new IllegalArgumentException("The key must be a framework-specific "
11932 + "resource id.");
11933 }
11934
Romain Guy8506ab42009-06-11 17:35:47 -070011935 setTagInternal(this, key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070011936 }
11937
11938 private static void setTagInternal(View view, int key, Object tag) {
11939 SparseArray<Object> tags = null;
11940 synchronized (sTagsLock) {
11941 if (sTags == null) {
11942 sTags = new WeakHashMap<View, SparseArray<Object>>();
11943 } else {
11944 tags = sTags.get(view);
11945 }
11946 }
11947
11948 if (tags == null) {
11949 tags = new SparseArray<Object>(2);
11950 synchronized (sTagsLock) {
11951 sTags.put(view, tags);
11952 }
11953 }
11954
11955 tags.put(key, tag);
11956 }
11957
11958 /**
Romain Guy13922e02009-05-12 17:56:14 -070011959 * @param consistency The type of consistency. See ViewDebug for more information.
11960 *
11961 * @hide
11962 */
11963 protected boolean dispatchConsistencyCheck(int consistency) {
11964 return onConsistencyCheck(consistency);
11965 }
11966
11967 /**
11968 * Method that subclasses should implement to check their consistency. The type of
11969 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -070011970 *
Romain Guy13922e02009-05-12 17:56:14 -070011971 * @param consistency The type of consistency. See ViewDebug for more information.
11972 *
11973 * @throws IllegalStateException if the view is in an inconsistent state.
11974 *
11975 * @hide
11976 */
11977 protected boolean onConsistencyCheck(int consistency) {
11978 boolean result = true;
11979
11980 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
11981 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
11982
11983 if (checkLayout) {
11984 if (getParent() == null) {
11985 result = false;
11986 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
11987 "View " + this + " does not have a parent.");
11988 }
11989
11990 if (mAttachInfo == null) {
11991 result = false;
11992 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
11993 "View " + this + " is not attached to a window.");
11994 }
11995 }
11996
11997 if (checkDrawing) {
11998 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
11999 // from their draw() method
12000
12001 if ((mPrivateFlags & DRAWN) != DRAWN &&
12002 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
12003 result = false;
12004 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
12005 "View " + this + " was invalidated but its drawing cache is valid.");
12006 }
12007 }
12008
12009 return result;
12010 }
12011
12012 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012013 * Prints information about this view in the log output, with the tag
12014 * {@link #VIEW_LOG_TAG}.
12015 *
12016 * @hide
12017 */
12018 public void debug() {
12019 debug(0);
12020 }
12021
12022 /**
12023 * Prints information about this view in the log output, with the tag
12024 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
12025 * indentation defined by the <code>depth</code>.
12026 *
12027 * @param depth the indentation level
12028 *
12029 * @hide
12030 */
12031 protected void debug(int depth) {
12032 String output = debugIndent(depth - 1);
12033
12034 output += "+ " + this;
12035 int id = getId();
12036 if (id != -1) {
12037 output += " (id=" + id + ")";
12038 }
12039 Object tag = getTag();
12040 if (tag != null) {
12041 output += " (tag=" + tag + ")";
12042 }
12043 Log.d(VIEW_LOG_TAG, output);
12044
12045 if ((mPrivateFlags & FOCUSED) != 0) {
12046 output = debugIndent(depth) + " FOCUSED";
12047 Log.d(VIEW_LOG_TAG, output);
12048 }
12049
12050 output = debugIndent(depth);
12051 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
12052 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
12053 + "} ";
12054 Log.d(VIEW_LOG_TAG, output);
12055
12056 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
12057 || mPaddingBottom != 0) {
12058 output = debugIndent(depth);
12059 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
12060 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
12061 Log.d(VIEW_LOG_TAG, output);
12062 }
12063
12064 output = debugIndent(depth);
12065 output += "mMeasureWidth=" + mMeasuredWidth +
12066 " mMeasureHeight=" + mMeasuredHeight;
12067 Log.d(VIEW_LOG_TAG, output);
12068
12069 output = debugIndent(depth);
12070 if (mLayoutParams == null) {
12071 output += "BAD! no layout params";
12072 } else {
12073 output = mLayoutParams.debug(output);
12074 }
12075 Log.d(VIEW_LOG_TAG, output);
12076
12077 output = debugIndent(depth);
12078 output += "flags={";
12079 output += View.printFlags(mViewFlags);
12080 output += "}";
12081 Log.d(VIEW_LOG_TAG, output);
12082
12083 output = debugIndent(depth);
12084 output += "privateFlags={";
12085 output += View.printPrivateFlags(mPrivateFlags);
12086 output += "}";
12087 Log.d(VIEW_LOG_TAG, output);
12088 }
12089
12090 /**
12091 * Creates an string of whitespaces used for indentation.
12092 *
12093 * @param depth the indentation level
12094 * @return a String containing (depth * 2 + 3) * 2 white spaces
12095 *
12096 * @hide
12097 */
12098 protected static String debugIndent(int depth) {
12099 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
12100 for (int i = 0; i < (depth * 2) + 3; i++) {
12101 spaces.append(' ').append(' ');
12102 }
12103 return spaces.toString();
12104 }
12105
12106 /**
12107 * <p>Return the offset of the widget's text baseline from the widget's top
12108 * boundary. If this widget does not support baseline alignment, this
12109 * method returns -1. </p>
12110 *
12111 * @return the offset of the baseline within the widget's bounds or -1
12112 * if baseline alignment is not supported
12113 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070012114 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012115 public int getBaseline() {
12116 return -1;
12117 }
12118
12119 /**
12120 * Call this when something has changed which has invalidated the
12121 * layout of this view. This will schedule a layout pass of the view
12122 * tree.
12123 */
12124 public void requestLayout() {
12125 if (ViewDebug.TRACE_HIERARCHY) {
12126 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
12127 }
12128
12129 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080012130 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012131
Fabrice Di Megliod794aca2011-07-22 18:19:36 -070012132 if (mParent != null) {
12133 if (mLayoutParams != null) {
12134 mLayoutParams.resolveWithDirection(getResolvedLayoutDirection());
12135 }
12136 if (!mParent.isLayoutRequested()) {
12137 mParent.requestLayout();
12138 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012139 }
12140 }
12141
12142 /**
12143 * Forces this view to be laid out during the next layout pass.
12144 * This method does not call requestLayout() or forceLayout()
12145 * on the parent.
12146 */
12147 public void forceLayout() {
12148 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080012149 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012150 }
12151
12152 /**
12153 * <p>
12154 * This is called to find out how big a view should be. The parent
12155 * supplies constraint information in the width and height parameters.
12156 * </p>
12157 *
12158 * <p>
12159 * The actual mesurement work of a view is performed in
12160 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
12161 * {@link #onMeasure(int, int)} can and must be overriden by subclasses.
12162 * </p>
12163 *
12164 *
12165 * @param widthMeasureSpec Horizontal space requirements as imposed by the
12166 * parent
12167 * @param heightMeasureSpec Vertical space requirements as imposed by the
12168 * parent
12169 *
12170 * @see #onMeasure(int, int)
12171 */
12172 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
12173 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
12174 widthMeasureSpec != mOldWidthMeasureSpec ||
12175 heightMeasureSpec != mOldHeightMeasureSpec) {
12176
12177 // first clears the measured dimension flag
12178 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
12179
12180 if (ViewDebug.TRACE_HIERARCHY) {
12181 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
12182 }
12183
12184 // measure ourselves, this should set the measured dimension flag back
12185 onMeasure(widthMeasureSpec, heightMeasureSpec);
12186
12187 // flag not set, setMeasuredDimension() was not invoked, we raise
12188 // an exception to warn the developer
12189 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
12190 throw new IllegalStateException("onMeasure() did not set the"
12191 + " measured dimension by calling"
12192 + " setMeasuredDimension()");
12193 }
12194
12195 mPrivateFlags |= LAYOUT_REQUIRED;
12196 }
12197
12198 mOldWidthMeasureSpec = widthMeasureSpec;
12199 mOldHeightMeasureSpec = heightMeasureSpec;
12200 }
12201
12202 /**
12203 * <p>
12204 * Measure the view and its content to determine the measured width and the
12205 * measured height. This method is invoked by {@link #measure(int, int)} and
12206 * should be overriden by subclasses to provide accurate and efficient
12207 * measurement of their contents.
12208 * </p>
12209 *
12210 * <p>
12211 * <strong>CONTRACT:</strong> When overriding this method, you
12212 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
12213 * measured width and height of this view. Failure to do so will trigger an
12214 * <code>IllegalStateException</code>, thrown by
12215 * {@link #measure(int, int)}. Calling the superclass'
12216 * {@link #onMeasure(int, int)} is a valid use.
12217 * </p>
12218 *
12219 * <p>
12220 * The base class implementation of measure defaults to the background size,
12221 * unless a larger size is allowed by the MeasureSpec. Subclasses should
12222 * override {@link #onMeasure(int, int)} to provide better measurements of
12223 * their content.
12224 * </p>
12225 *
12226 * <p>
12227 * If this method is overridden, it is the subclass's responsibility to make
12228 * sure the measured height and width are at least the view's minimum height
12229 * and width ({@link #getSuggestedMinimumHeight()} and
12230 * {@link #getSuggestedMinimumWidth()}).
12231 * </p>
12232 *
12233 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
12234 * The requirements are encoded with
12235 * {@link android.view.View.MeasureSpec}.
12236 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
12237 * The requirements are encoded with
12238 * {@link android.view.View.MeasureSpec}.
12239 *
12240 * @see #getMeasuredWidth()
12241 * @see #getMeasuredHeight()
12242 * @see #setMeasuredDimension(int, int)
12243 * @see #getSuggestedMinimumHeight()
12244 * @see #getSuggestedMinimumWidth()
12245 * @see android.view.View.MeasureSpec#getMode(int)
12246 * @see android.view.View.MeasureSpec#getSize(int)
12247 */
12248 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
12249 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
12250 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
12251 }
12252
12253 /**
12254 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
12255 * measured width and measured height. Failing to do so will trigger an
12256 * exception at measurement time.</p>
12257 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080012258 * @param measuredWidth The measured width of this view. May be a complex
12259 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
12260 * {@link #MEASURED_STATE_TOO_SMALL}.
12261 * @param measuredHeight The measured height of this view. May be a complex
12262 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
12263 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012264 */
12265 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
12266 mMeasuredWidth = measuredWidth;
12267 mMeasuredHeight = measuredHeight;
12268
12269 mPrivateFlags |= MEASURED_DIMENSION_SET;
12270 }
12271
12272 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080012273 * Merge two states as returned by {@link #getMeasuredState()}.
12274 * @param curState The current state as returned from a view or the result
12275 * of combining multiple views.
12276 * @param newState The new view state to combine.
12277 * @return Returns a new integer reflecting the combination of the two
12278 * states.
12279 */
12280 public static int combineMeasuredStates(int curState, int newState) {
12281 return curState | newState;
12282 }
12283
12284 /**
12285 * Version of {@link #resolveSizeAndState(int, int, int)}
12286 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
12287 */
12288 public static int resolveSize(int size, int measureSpec) {
12289 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
12290 }
12291
12292 /**
12293 * Utility to reconcile a desired size and state, with constraints imposed
12294 * by a MeasureSpec. Will take the desired size, unless a different size
12295 * is imposed by the constraints. The returned value is a compound integer,
12296 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
12297 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
12298 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012299 *
12300 * @param size How big the view wants to be
12301 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080012302 * @return Size information bit mask as defined by
12303 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012304 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080012305 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012306 int result = size;
12307 int specMode = MeasureSpec.getMode(measureSpec);
12308 int specSize = MeasureSpec.getSize(measureSpec);
12309 switch (specMode) {
12310 case MeasureSpec.UNSPECIFIED:
12311 result = size;
12312 break;
12313 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080012314 if (specSize < size) {
12315 result = specSize | MEASURED_STATE_TOO_SMALL;
12316 } else {
12317 result = size;
12318 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012319 break;
12320 case MeasureSpec.EXACTLY:
12321 result = specSize;
12322 break;
12323 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080012324 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012325 }
12326
12327 /**
12328 * Utility to return a default size. Uses the supplied size if the
Romain Guy98029c82011-06-17 15:47:07 -070012329 * MeasureSpec imposed no constraints. Will get larger if allowed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012330 * by the MeasureSpec.
12331 *
12332 * @param size Default size for this view
12333 * @param measureSpec Constraints imposed by the parent
12334 * @return The size this view should be.
12335 */
12336 public static int getDefaultSize(int size, int measureSpec) {
12337 int result = size;
12338 int specMode = MeasureSpec.getMode(measureSpec);
Romain Guy98029c82011-06-17 15:47:07 -070012339 int specSize = MeasureSpec.getSize(measureSpec);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012340
12341 switch (specMode) {
12342 case MeasureSpec.UNSPECIFIED:
12343 result = size;
12344 break;
12345 case MeasureSpec.AT_MOST:
12346 case MeasureSpec.EXACTLY:
12347 result = specSize;
12348 break;
12349 }
12350 return result;
12351 }
12352
12353 /**
12354 * Returns the suggested minimum height that the view should use. This
12355 * returns the maximum of the view's minimum height
12356 * and the background's minimum height
12357 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
12358 * <p>
12359 * When being used in {@link #onMeasure(int, int)}, the caller should still
12360 * ensure the returned height is within the requirements of the parent.
12361 *
12362 * @return The suggested minimum height of the view.
12363 */
12364 protected int getSuggestedMinimumHeight() {
12365 int suggestedMinHeight = mMinHeight;
12366
12367 if (mBGDrawable != null) {
12368 final int bgMinHeight = mBGDrawable.getMinimumHeight();
12369 if (suggestedMinHeight < bgMinHeight) {
12370 suggestedMinHeight = bgMinHeight;
12371 }
12372 }
12373
12374 return suggestedMinHeight;
12375 }
12376
12377 /**
12378 * Returns the suggested minimum width that the view should use. This
12379 * returns the maximum of the view's minimum width)
12380 * and the background's minimum width
12381 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
12382 * <p>
12383 * When being used in {@link #onMeasure(int, int)}, the caller should still
12384 * ensure the returned width is within the requirements of the parent.
12385 *
12386 * @return The suggested minimum width of the view.
12387 */
12388 protected int getSuggestedMinimumWidth() {
12389 int suggestedMinWidth = mMinWidth;
12390
12391 if (mBGDrawable != null) {
12392 final int bgMinWidth = mBGDrawable.getMinimumWidth();
12393 if (suggestedMinWidth < bgMinWidth) {
12394 suggestedMinWidth = bgMinWidth;
12395 }
12396 }
12397
12398 return suggestedMinWidth;
12399 }
12400
12401 /**
12402 * Sets the minimum height of the view. It is not guaranteed the view will
12403 * be able to achieve this minimum height (for example, if its parent layout
12404 * constrains it with less available height).
12405 *
12406 * @param minHeight The minimum height the view will try to be.
12407 */
12408 public void setMinimumHeight(int minHeight) {
12409 mMinHeight = minHeight;
12410 }
12411
12412 /**
12413 * Sets the minimum width of the view. It is not guaranteed the view will
12414 * be able to achieve this minimum width (for example, if its parent layout
12415 * constrains it with less available width).
12416 *
12417 * @param minWidth The minimum width the view will try to be.
12418 */
12419 public void setMinimumWidth(int minWidth) {
12420 mMinWidth = minWidth;
12421 }
12422
12423 /**
12424 * Get the animation currently associated with this view.
12425 *
12426 * @return The animation that is currently playing or
12427 * scheduled to play for this view.
12428 */
12429 public Animation getAnimation() {
12430 return mCurrentAnimation;
12431 }
12432
12433 /**
12434 * Start the specified animation now.
12435 *
12436 * @param animation the animation to start now
12437 */
12438 public void startAnimation(Animation animation) {
12439 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
12440 setAnimation(animation);
Romain Guy0fd89bf2011-01-26 15:41:30 -080012441 invalidateParentCaches();
12442 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012443 }
12444
12445 /**
12446 * Cancels any animations for this view.
12447 */
12448 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080012449 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080012450 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080012451 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012452 mCurrentAnimation = null;
Romain Guy0fd89bf2011-01-26 15:41:30 -080012453 invalidateParentIfNeeded();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012454 }
12455
12456 /**
12457 * Sets the next animation to play for this view.
12458 * If you want the animation to play immediately, use
12459 * startAnimation. This method provides allows fine-grained
12460 * control over the start time and invalidation, but you
12461 * must make sure that 1) the animation has a start time set, and
12462 * 2) the view will be invalidated when the animation is supposed to
12463 * start.
12464 *
12465 * @param animation The next animation, or null.
12466 */
12467 public void setAnimation(Animation animation) {
12468 mCurrentAnimation = animation;
12469 if (animation != null) {
12470 animation.reset();
12471 }
12472 }
12473
12474 /**
12475 * Invoked by a parent ViewGroup to notify the start of the animation
12476 * currently associated with this view. If you override this method,
12477 * always call super.onAnimationStart();
12478 *
12479 * @see #setAnimation(android.view.animation.Animation)
12480 * @see #getAnimation()
12481 */
12482 protected void onAnimationStart() {
12483 mPrivateFlags |= ANIMATION_STARTED;
12484 }
12485
12486 /**
12487 * Invoked by a parent ViewGroup to notify the end of the animation
12488 * currently associated with this view. If you override this method,
12489 * always call super.onAnimationEnd();
12490 *
12491 * @see #setAnimation(android.view.animation.Animation)
12492 * @see #getAnimation()
12493 */
12494 protected void onAnimationEnd() {
12495 mPrivateFlags &= ~ANIMATION_STARTED;
12496 }
12497
12498 /**
12499 * Invoked if there is a Transform that involves alpha. Subclass that can
12500 * draw themselves with the specified alpha should return true, and then
12501 * respect that alpha when their onDraw() is called. If this returns false
12502 * then the view may be redirected to draw into an offscreen buffer to
12503 * fulfill the request, which will look fine, but may be slower than if the
12504 * subclass handles it internally. The default implementation returns false.
12505 *
12506 * @param alpha The alpha (0..255) to apply to the view's drawing
12507 * @return true if the view can draw with the specified alpha.
12508 */
12509 protected boolean onSetAlpha(int alpha) {
12510 return false;
12511 }
12512
12513 /**
12514 * This is used by the RootView to perform an optimization when
12515 * the view hierarchy contains one or several SurfaceView.
12516 * SurfaceView is always considered transparent, but its children are not,
12517 * therefore all View objects remove themselves from the global transparent
12518 * region (passed as a parameter to this function).
12519 *
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070012520 * @param region The transparent region for this ViewAncestor (window).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012521 *
12522 * @return Returns true if the effective visibility of the view at this
12523 * point is opaque, regardless of the transparent region; returns false
12524 * if it is possible for underlying windows to be seen behind the view.
12525 *
12526 * {@hide}
12527 */
12528 public boolean gatherTransparentRegion(Region region) {
12529 final AttachInfo attachInfo = mAttachInfo;
12530 if (region != null && attachInfo != null) {
12531 final int pflags = mPrivateFlags;
12532 if ((pflags & SKIP_DRAW) == 0) {
12533 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
12534 // remove it from the transparent region.
12535 final int[] location = attachInfo.mTransparentLocation;
12536 getLocationInWindow(location);
12537 region.op(location[0], location[1], location[0] + mRight - mLeft,
12538 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
12539 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBGDrawable != null) {
12540 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
12541 // exists, so we remove the background drawable's non-transparent
12542 // parts from this transparent region.
12543 applyDrawableToTransparentRegion(mBGDrawable, region);
12544 }
12545 }
12546 return true;
12547 }
12548
12549 /**
12550 * Play a sound effect for this view.
12551 *
12552 * <p>The framework will play sound effects for some built in actions, such as
12553 * clicking, but you may wish to play these effects in your widget,
12554 * for instance, for internal navigation.
12555 *
12556 * <p>The sound effect will only be played if sound effects are enabled by the user, and
12557 * {@link #isSoundEffectsEnabled()} is true.
12558 *
12559 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
12560 */
12561 public void playSoundEffect(int soundConstant) {
12562 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
12563 return;
12564 }
12565 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
12566 }
12567
12568 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070012569 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070012570 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070012571 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012572 *
12573 * <p>The framework will provide haptic feedback for some built in actions,
12574 * such as long presses, but you may wish to provide feedback for your
12575 * own widget.
12576 *
12577 * <p>The feedback will only be performed if
12578 * {@link #isHapticFeedbackEnabled()} is true.
12579 *
12580 * @param feedbackConstant One of the constants defined in
12581 * {@link HapticFeedbackConstants}
12582 */
12583 public boolean performHapticFeedback(int feedbackConstant) {
12584 return performHapticFeedback(feedbackConstant, 0);
12585 }
12586
12587 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070012588 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070012589 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070012590 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012591 *
12592 * @param feedbackConstant One of the constants defined in
12593 * {@link HapticFeedbackConstants}
12594 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
12595 */
12596 public boolean performHapticFeedback(int feedbackConstant, int flags) {
12597 if (mAttachInfo == null) {
12598 return false;
12599 }
Romain Guyf607bdc2010-09-10 19:20:06 -070012600 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070012601 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012602 && !isHapticFeedbackEnabled()) {
12603 return false;
12604 }
Romain Guy812ccbe2010-06-01 14:07:24 -070012605 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
12606 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012607 }
12608
12609 /**
Joe Onorato664644d2011-01-23 17:53:23 -080012610 * Request that the visibility of the status bar be changed.
Daniel Sandler60ee2562011-07-22 12:34:33 -040012611 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE} or
12612 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}.
Joe Onorato664644d2011-01-23 17:53:23 -080012613 */
12614 public void setSystemUiVisibility(int visibility) {
12615 if (visibility != mSystemUiVisibility) {
12616 mSystemUiVisibility = visibility;
12617 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
12618 mParent.recomputeViewAttributes(this);
12619 }
12620 }
12621 }
12622
12623 /**
12624 * Returns the status bar visibility that this view has requested.
Daniel Sandler60ee2562011-07-22 12:34:33 -040012625 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE} or
12626 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}.
Joe Onorato664644d2011-01-23 17:53:23 -080012627 */
Joe Onoratoe595cad2011-01-24 09:22:12 -080012628 public int getSystemUiVisibility() {
Joe Onorato664644d2011-01-23 17:53:23 -080012629 return mSystemUiVisibility;
12630 }
12631
Scott Mainec6331b2011-05-24 16:55:56 -070012632 /**
12633 * Set a listener to receive callbacks when the visibility of the system bar changes.
12634 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks.
12635 */
Joe Onorato664644d2011-01-23 17:53:23 -080012636 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) {
12637 mOnSystemUiVisibilityChangeListener = l;
12638 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
12639 mParent.recomputeViewAttributes(this);
12640 }
12641 }
12642
12643 /**
12644 */
12645 public void dispatchSystemUiVisibilityChanged(int visibility) {
12646 if (mOnSystemUiVisibilityChangeListener != null) {
Joe Onorato7bb8eeb2011-01-27 16:00:58 -080012647 mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange(
Joe Onorato6ab77bd2011-01-31 11:21:10 -080012648 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK);
Joe Onorato664644d2011-01-23 17:53:23 -080012649 }
12650 }
12651
12652 /**
Joe Malin32736f02011-01-19 16:14:20 -080012653 * Creates an image that the system displays during the drag and drop
12654 * operation. This is called a &quot;drag shadow&quot;. The default implementation
12655 * for a DragShadowBuilder based on a View returns an image that has exactly the same
12656 * appearance as the given View. The default also positions the center of the drag shadow
12657 * directly under the touch point. If no View is provided (the constructor with no parameters
12658 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and
12659 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the
12660 * default is an invisible drag shadow.
12661 * <p>
12662 * You are not required to use the View you provide to the constructor as the basis of the
12663 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw
12664 * anything you want as the drag shadow.
12665 * </p>
12666 * <p>
12667 * You pass a DragShadowBuilder object to the system when you start the drag. The system
12668 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the
12669 * size and position of the drag shadow. It uses this data to construct a
12670 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()}
12671 * so that your application can draw the shadow image in the Canvas.
12672 * </p>
Christopher Tate2c095f32010-10-04 14:13:40 -070012673 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012674 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070012675 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070012676
12677 /**
Joe Malin32736f02011-01-19 16:14:20 -080012678 * Constructs a shadow image builder based on a View. By default, the resulting drag
12679 * shadow will have the same appearance and dimensions as the View, with the touch point
12680 * over the center of the View.
12681 * @param view A View. Any View in scope can be used.
Christopher Tate2c095f32010-10-04 14:13:40 -070012682 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012683 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070012684 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070012685 }
12686
Christopher Tate17ed60c2011-01-18 12:50:26 -080012687 /**
12688 * Construct a shadow builder object with no associated View. This
12689 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)}
12690 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order
12691 * to supply the drag shadow's dimensions and appearance without
Joe Malin32736f02011-01-19 16:14:20 -080012692 * reference to any View object. If they are not overridden, then the result is an
12693 * invisible drag shadow.
Christopher Tate17ed60c2011-01-18 12:50:26 -080012694 */
12695 public DragShadowBuilder() {
12696 mView = new WeakReference<View>(null);
12697 }
12698
12699 /**
12700 * Returns the View object that had been passed to the
12701 * {@link #View.DragShadowBuilder(View)}
12702 * constructor. If that View parameter was {@code null} or if the
12703 * {@link #View.DragShadowBuilder()}
12704 * constructor was used to instantiate the builder object, this method will return
12705 * null.
12706 *
12707 * @return The View object associate with this builder object.
12708 */
Romain Guy5c22a8c2011-05-13 11:48:45 -070012709 @SuppressWarnings({"JavadocReference"})
Chris Tate6b391282010-10-14 15:48:59 -070012710 final public View getView() {
12711 return mView.get();
12712 }
12713
Christopher Tate2c095f32010-10-04 14:13:40 -070012714 /**
Joe Malin32736f02011-01-19 16:14:20 -080012715 * Provides the metrics for the shadow image. These include the dimensions of
12716 * the shadow image, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070012717 * be centered under the touch location while dragging.
12718 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012719 * The default implementation sets the dimensions of the shadow to be the
Joe Malin32736f02011-01-19 16:14:20 -080012720 * same as the dimensions of the View itself and centers the shadow under
12721 * the touch point.
12722 * </p>
Christopher Tate2c095f32010-10-04 14:13:40 -070012723 *
Joe Malin32736f02011-01-19 16:14:20 -080012724 * @param shadowSize A {@link android.graphics.Point} containing the width and height
12725 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the
12726 * desired width and must set {@link android.graphics.Point#y} to the desired height of the
12727 * image.
12728 *
12729 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the
12730 * shadow image that should be underneath the touch point during the drag and drop
12731 * operation. Your application must set {@link android.graphics.Point#x} to the
12732 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position.
Christopher Tate2c095f32010-10-04 14:13:40 -070012733 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012734 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070012735 final View view = mView.get();
12736 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012737 shadowSize.set(view.getWidth(), view.getHeight());
12738 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070012739 } else {
12740 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
12741 }
Christopher Tate2c095f32010-10-04 14:13:40 -070012742 }
12743
12744 /**
Joe Malin32736f02011-01-19 16:14:20 -080012745 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object
12746 * based on the dimensions it received from the
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012747 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate2c095f32010-10-04 14:13:40 -070012748 *
Joe Malin32736f02011-01-19 16:14:20 -080012749 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image.
Christopher Tate2c095f32010-10-04 14:13:40 -070012750 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012751 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070012752 final View view = mView.get();
12753 if (view != null) {
12754 view.draw(canvas);
12755 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012756 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070012757 }
Christopher Tate2c095f32010-10-04 14:13:40 -070012758 }
12759 }
12760
12761 /**
Joe Malin32736f02011-01-19 16:14:20 -080012762 * Starts a drag and drop operation. When your application calls this method, it passes a
12763 * {@link android.view.View.DragShadowBuilder} object to the system. The
12764 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)}
12765 * to get metrics for the drag shadow, and then calls the object's
12766 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself.
12767 * <p>
12768 * Once the system has the drag shadow, it begins the drag and drop operation by sending
12769 * drag events to all the View objects in your application that are currently visible. It does
12770 * this either by calling the View object's drag listener (an implementation of
12771 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the
12772 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method.
12773 * Both are passed a {@link android.view.DragEvent} object that has a
12774 * {@link android.view.DragEvent#getAction()} value of
12775 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}.
12776 * </p>
12777 * <p>
12778 * Your application can invoke startDrag() on any attached View object. The View object does not
12779 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to
12780 * be related to the View the user selected for dragging.
12781 * </p>
12782 * @param data A {@link android.content.ClipData} object pointing to the data to be
12783 * transferred by the drag and drop operation.
12784 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the
12785 * drag shadow.
12786 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and
12787 * drop operation. This Object is put into every DragEvent object sent by the system during the
12788 * current drag.
12789 * <p>
12790 * myLocalState is a lightweight mechanism for the sending information from the dragged View
12791 * to the target Views. For example, it can contain flags that differentiate between a
12792 * a copy operation and a move operation.
12793 * </p>
12794 * @param flags Flags that control the drag and drop operation. No flags are currently defined,
12795 * so the parameter should be set to 0.
12796 * @return {@code true} if the method completes successfully, or
12797 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to
12798 * do a drag, and so no drag operation is in progress.
Christopher Tatea53146c2010-09-07 11:57:52 -070012799 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012800 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080012801 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070012802 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080012803 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070012804 }
12805 boolean okay = false;
12806
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012807 Point shadowSize = new Point();
12808 Point shadowTouchPoint = new Point();
12809 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070012810
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012811 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
12812 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
12813 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070012814 }
Christopher Tatea53146c2010-09-07 11:57:52 -070012815
Chris Tatea32dcf72010-10-14 12:13:50 -070012816 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012817 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
12818 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070012819 }
Christopher Tatea53146c2010-09-07 11:57:52 -070012820 Surface surface = new Surface();
12821 try {
12822 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080012823 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070012824 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070012825 + " surface=" + surface);
12826 if (token != null) {
12827 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070012828 try {
Chris Tate6b391282010-10-14 15:48:59 -070012829 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012830 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070012831 } finally {
12832 surface.unlockCanvasAndPost(canvas);
12833 }
Christopher Tatea53146c2010-09-07 11:57:52 -070012834
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070012835 final ViewRootImpl root = getViewRootImpl();
Christopher Tate407b4e92010-11-30 17:14:08 -080012836
12837 // Cache the local state object for delivery with DragEvents
12838 root.setLocalDragState(myLocalState);
12839
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012840 // repurpose 'shadowSize' for the last touch point
12841 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070012842
Christopher Tatea53146c2010-09-07 11:57:52 -070012843 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080012844 shadowSize.x, shadowSize.y,
12845 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070012846 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tatea53146c2010-09-07 11:57:52 -070012847 }
12848 } catch (Exception e) {
12849 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
12850 surface.destroy();
12851 }
12852
12853 return okay;
12854 }
12855
Christopher Tatea53146c2010-09-07 11:57:52 -070012856 /**
Joe Malin32736f02011-01-19 16:14:20 -080012857 * Handles drag events sent by the system following a call to
12858 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}.
12859 *<p>
12860 * When the system calls this method, it passes a
12861 * {@link android.view.DragEvent} object. A call to
12862 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined
12863 * in DragEvent. The method uses these to determine what is happening in the drag and drop
12864 * operation.
12865 * @param event The {@link android.view.DragEvent} sent by the system.
12866 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined
12867 * in DragEvent, indicating the type of drag event represented by this object.
12868 * @return {@code true} if the method was successful, otherwise {@code false}.
12869 * <p>
12870 * The method should return {@code true} in response to an action type of
12871 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current
12872 * operation.
12873 * </p>
12874 * <p>
12875 * The method should also return {@code true} in response to an action type of
12876 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or
12877 * {@code false} if it didn't.
12878 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070012879 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070012880 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070012881 return false;
12882 }
12883
12884 /**
Joe Malin32736f02011-01-19 16:14:20 -080012885 * Detects if this View is enabled and has a drag event listener.
12886 * If both are true, then it calls the drag event listener with the
12887 * {@link android.view.DragEvent} it received. If the drag event listener returns
12888 * {@code true}, then dispatchDragEvent() returns {@code true}.
12889 * <p>
12890 * For all other cases, the method calls the
12891 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler
12892 * method and returns its result.
12893 * </p>
12894 * <p>
12895 * This ensures that a drag event is always consumed, even if the View does not have a drag
12896 * event listener. However, if the View has a listener and the listener returns true, then
12897 * onDragEvent() is not called.
12898 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070012899 */
12900 public boolean dispatchDragEvent(DragEvent event) {
Romain Guy676b1732011-02-14 14:45:33 -080012901 //noinspection SimplifiableIfStatement
Chris Tate32affef2010-10-18 15:29:21 -070012902 if (mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
12903 && mOnDragListener.onDrag(this, event)) {
12904 return true;
12905 }
Christopher Tatea53146c2010-09-07 11:57:52 -070012906 return onDragEvent(event);
12907 }
12908
Christopher Tate3d4bf172011-03-28 16:16:46 -070012909 boolean canAcceptDrag() {
12910 return (mPrivateFlags2 & DRAG_CAN_ACCEPT) != 0;
12911 }
12912
Christopher Tatea53146c2010-09-07 11:57:52 -070012913 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070012914 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
12915 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070012916 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070012917 */
12918 public void onCloseSystemDialogs(String reason) {
12919 }
Joe Malin32736f02011-01-19 16:14:20 -080012920
Dianne Hackbornffa42482009-09-23 22:20:11 -070012921 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012922 * Given a Drawable whose bounds have been set to draw into this view,
Romain Guy5c22a8c2011-05-13 11:48:45 -070012923 * update a Region being computed for
12924 * {@link #gatherTransparentRegion(android.graphics.Region)} so
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012925 * that any non-transparent parts of the Drawable are removed from the
12926 * given transparent region.
12927 *
12928 * @param dr The Drawable whose transparency is to be applied to the region.
12929 * @param region A Region holding the current transparency information,
12930 * where any parts of the region that are set are considered to be
12931 * transparent. On return, this region will be modified to have the
12932 * transparency information reduced by the corresponding parts of the
12933 * Drawable that are not transparent.
12934 * {@hide}
12935 */
12936 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
12937 if (DBG) {
12938 Log.i("View", "Getting transparent region for: " + this);
12939 }
12940 final Region r = dr.getTransparentRegion();
12941 final Rect db = dr.getBounds();
12942 final AttachInfo attachInfo = mAttachInfo;
12943 if (r != null && attachInfo != null) {
12944 final int w = getRight()-getLeft();
12945 final int h = getBottom()-getTop();
12946 if (db.left > 0) {
12947 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
12948 r.op(0, 0, db.left, h, Region.Op.UNION);
12949 }
12950 if (db.right < w) {
12951 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
12952 r.op(db.right, 0, w, h, Region.Op.UNION);
12953 }
12954 if (db.top > 0) {
12955 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
12956 r.op(0, 0, w, db.top, Region.Op.UNION);
12957 }
12958 if (db.bottom < h) {
12959 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
12960 r.op(0, db.bottom, w, h, Region.Op.UNION);
12961 }
12962 final int[] location = attachInfo.mTransparentLocation;
12963 getLocationInWindow(location);
12964 r.translate(location[0], location[1]);
12965 region.op(r, Region.Op.INTERSECT);
12966 } else {
12967 region.op(db, Region.Op.DIFFERENCE);
12968 }
12969 }
12970
Patrick Dubroye0a799a2011-05-04 16:19:22 -070012971 private void checkForLongClick(int delayOffset) {
12972 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
12973 mHasPerformedLongPress = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012974
Patrick Dubroye0a799a2011-05-04 16:19:22 -070012975 if (mPendingCheckForLongPress == null) {
12976 mPendingCheckForLongPress = new CheckForLongPress();
12977 }
12978 mPendingCheckForLongPress.rememberWindowAttachCount();
12979 postDelayed(mPendingCheckForLongPress,
12980 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012981 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012982 }
12983
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012984 /**
12985 * Inflate a view from an XML resource. This convenience method wraps the {@link
12986 * LayoutInflater} class, which provides a full range of options for view inflation.
12987 *
12988 * @param context The Context object for your activity or application.
12989 * @param resource The resource ID to inflate
12990 * @param root A view group that will be the parent. Used to properly inflate the
12991 * layout_* parameters.
12992 * @see LayoutInflater
12993 */
12994 public static View inflate(Context context, int resource, ViewGroup root) {
12995 LayoutInflater factory = LayoutInflater.from(context);
12996 return factory.inflate(resource, root);
12997 }
Romain Guy33e72ae2010-07-17 12:40:29 -070012998
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012999 /**
Adam Powell637d3372010-08-25 14:37:03 -070013000 * Scroll the view with standard behavior for scrolling beyond the normal
13001 * content boundaries. Views that call this method should override
13002 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
13003 * results of an over-scroll operation.
13004 *
13005 * Views can use this method to handle any touch or fling-based scrolling.
13006 *
13007 * @param deltaX Change in X in pixels
13008 * @param deltaY Change in Y in pixels
13009 * @param scrollX Current X scroll value in pixels before applying deltaX
13010 * @param scrollY Current Y scroll value in pixels before applying deltaY
13011 * @param scrollRangeX Maximum content scroll range along the X axis
13012 * @param scrollRangeY Maximum content scroll range along the Y axis
13013 * @param maxOverScrollX Number of pixels to overscroll by in either direction
13014 * along the X axis.
13015 * @param maxOverScrollY Number of pixels to overscroll by in either direction
13016 * along the Y axis.
13017 * @param isTouchEvent true if this scroll operation is the result of a touch event.
13018 * @return true if scrolling was clamped to an over-scroll boundary along either
13019 * axis, false otherwise.
13020 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013021 @SuppressWarnings({"UnusedParameters"})
Adam Powell637d3372010-08-25 14:37:03 -070013022 protected boolean overScrollBy(int deltaX, int deltaY,
13023 int scrollX, int scrollY,
13024 int scrollRangeX, int scrollRangeY,
13025 int maxOverScrollX, int maxOverScrollY,
13026 boolean isTouchEvent) {
13027 final int overScrollMode = mOverScrollMode;
13028 final boolean canScrollHorizontal =
13029 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
13030 final boolean canScrollVertical =
13031 computeVerticalScrollRange() > computeVerticalScrollExtent();
13032 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
13033 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
13034 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
13035 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
13036
13037 int newScrollX = scrollX + deltaX;
13038 if (!overScrollHorizontal) {
13039 maxOverScrollX = 0;
13040 }
13041
13042 int newScrollY = scrollY + deltaY;
13043 if (!overScrollVertical) {
13044 maxOverScrollY = 0;
13045 }
13046
13047 // Clamp values if at the limits and record
13048 final int left = -maxOverScrollX;
13049 final int right = maxOverScrollX + scrollRangeX;
13050 final int top = -maxOverScrollY;
13051 final int bottom = maxOverScrollY + scrollRangeY;
13052
13053 boolean clampedX = false;
13054 if (newScrollX > right) {
13055 newScrollX = right;
13056 clampedX = true;
13057 } else if (newScrollX < left) {
13058 newScrollX = left;
13059 clampedX = true;
13060 }
13061
13062 boolean clampedY = false;
13063 if (newScrollY > bottom) {
13064 newScrollY = bottom;
13065 clampedY = true;
13066 } else if (newScrollY < top) {
13067 newScrollY = top;
13068 clampedY = true;
13069 }
13070
13071 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
13072
13073 return clampedX || clampedY;
13074 }
13075
13076 /**
13077 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
13078 * respond to the results of an over-scroll operation.
13079 *
13080 * @param scrollX New X scroll value in pixels
13081 * @param scrollY New Y scroll value in pixels
13082 * @param clampedX True if scrollX was clamped to an over-scroll boundary
13083 * @param clampedY True if scrollY was clamped to an over-scroll boundary
13084 */
13085 protected void onOverScrolled(int scrollX, int scrollY,
13086 boolean clampedX, boolean clampedY) {
13087 // Intentionally empty.
13088 }
13089
13090 /**
13091 * Returns the over-scroll mode for this view. The result will be
13092 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
13093 * (allow over-scrolling only if the view content is larger than the container),
13094 * or {@link #OVER_SCROLL_NEVER}.
13095 *
13096 * @return This view's over-scroll mode.
13097 */
13098 public int getOverScrollMode() {
13099 return mOverScrollMode;
13100 }
13101
13102 /**
13103 * Set the over-scroll mode for this view. Valid over-scroll modes are
13104 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
13105 * (allow over-scrolling only if the view content is larger than the container),
13106 * or {@link #OVER_SCROLL_NEVER}.
13107 *
13108 * Setting the over-scroll mode of a view will have an effect only if the
13109 * view is capable of scrolling.
13110 *
13111 * @param overScrollMode The new over-scroll mode for this view.
13112 */
13113 public void setOverScrollMode(int overScrollMode) {
13114 if (overScrollMode != OVER_SCROLL_ALWAYS &&
13115 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
13116 overScrollMode != OVER_SCROLL_NEVER) {
13117 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
13118 }
13119 mOverScrollMode = overScrollMode;
13120 }
13121
13122 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080013123 * Gets a scale factor that determines the distance the view should scroll
13124 * vertically in response to {@link MotionEvent#ACTION_SCROLL}.
13125 * @return The vertical scroll scale factor.
13126 * @hide
13127 */
13128 protected float getVerticalScrollFactor() {
13129 if (mVerticalScrollFactor == 0) {
13130 TypedValue outValue = new TypedValue();
13131 if (!mContext.getTheme().resolveAttribute(
13132 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) {
13133 throw new IllegalStateException(
13134 "Expected theme to define listPreferredItemHeight.");
13135 }
13136 mVerticalScrollFactor = outValue.getDimension(
13137 mContext.getResources().getDisplayMetrics());
13138 }
13139 return mVerticalScrollFactor;
13140 }
13141
13142 /**
13143 * Gets a scale factor that determines the distance the view should scroll
13144 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}.
13145 * @return The horizontal scroll scale factor.
13146 * @hide
13147 */
13148 protected float getHorizontalScrollFactor() {
13149 // TODO: Should use something else.
13150 return getVerticalScrollFactor();
13151 }
13152
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013153 /**
13154 * Return the value specifying the text direction or policy that was set with
13155 * {@link #setTextDirection(int)}.
13156 *
13157 * @return the defined text direction. It can be one of:
13158 *
13159 * {@link #TEXT_DIRECTION_INHERIT},
13160 * {@link #TEXT_DIRECTION_FIRST_STRONG}
13161 * {@link #TEXT_DIRECTION_ANY_RTL},
Fabrice Di Meglio8f502652011-06-29 20:40:43 -070013162 * {@link #TEXT_DIRECTION_CHAR_COUNT},
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013163 * {@link #TEXT_DIRECTION_LTR},
13164 * {@link #TEXT_DIRECTION_RTL},
13165 *
13166 * @hide
13167 */
13168 public int getTextDirection() {
13169 return mTextDirection;
13170 }
13171
13172 /**
13173 * Set the text direction.
13174 *
13175 * @param textDirection the direction to set. Should be one of:
13176 *
13177 * {@link #TEXT_DIRECTION_INHERIT},
13178 * {@link #TEXT_DIRECTION_FIRST_STRONG}
13179 * {@link #TEXT_DIRECTION_ANY_RTL},
Fabrice Di Meglio8f502652011-06-29 20:40:43 -070013180 * {@link #TEXT_DIRECTION_CHAR_COUNT},
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013181 * {@link #TEXT_DIRECTION_LTR},
13182 * {@link #TEXT_DIRECTION_RTL},
13183 *
13184 * @hide
13185 */
13186 public void setTextDirection(int textDirection) {
13187 if (textDirection != mTextDirection) {
13188 mTextDirection = textDirection;
13189 resetResolvedTextDirection();
13190 requestLayout();
13191 }
13192 }
13193
13194 /**
13195 * Return the resolved text direction.
13196 *
13197 * @return the resolved text direction. Return one of:
13198 *
Doug Feltcb3791202011-07-07 11:57:48 -070013199 * {@link #TEXT_DIRECTION_FIRST_STRONG}
13200 * {@link #TEXT_DIRECTION_ANY_RTL},
13201 * {@link #TEXT_DIRECTION_CHAR_COUNT},
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013202 * {@link #TEXT_DIRECTION_LTR},
13203 * {@link #TEXT_DIRECTION_RTL},
13204 *
13205 * @hide
13206 */
13207 public int getResolvedTextDirection() {
Doug Feltcb3791202011-07-07 11:57:48 -070013208 if (mResolvedTextDirection == TEXT_DIRECTION_INHERIT) {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013209 resolveTextDirection();
13210 }
13211 return mResolvedTextDirection;
13212 }
13213
13214 /**
Doug Feltcb3791202011-07-07 11:57:48 -070013215 * Resolve the text direction.
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013216 */
13217 protected void resolveTextDirection() {
Doug Feltcb3791202011-07-07 11:57:48 -070013218 if (mTextDirection != TEXT_DIRECTION_INHERIT) {
13219 mResolvedTextDirection = mTextDirection;
13220 return;
13221 }
13222 if (mParent != null && mParent instanceof ViewGroup) {
13223 mResolvedTextDirection = ((ViewGroup) mParent).getResolvedTextDirection();
13224 return;
13225 }
13226 mResolvedTextDirection = TEXT_DIRECTION_FIRST_STRONG;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013227 }
13228
13229 /**
Doug Feltcb3791202011-07-07 11:57:48 -070013230 * Reset resolved text direction. Will be resolved during a call to getResolvedTextDirection().
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013231 */
13232 protected void resetResolvedTextDirection() {
Doug Feltcb3791202011-07-07 11:57:48 -070013233 mResolvedTextDirection = TEXT_DIRECTION_INHERIT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070013234 }
13235
Chet Haaseb39f0512011-05-24 14:36:40 -070013236 //
13237 // Properties
13238 //
13239 /**
13240 * A Property wrapper around the <code>alpha</code> functionality handled by the
13241 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods.
13242 */
Romain Guy02ccac62011-06-24 13:20:23 -070013243 public static Property<View, Float> ALPHA = new FloatProperty<View>("alpha") {
Chet Haaseb39f0512011-05-24 14:36:40 -070013244 @Override
13245 public void setValue(View object, float value) {
13246 object.setAlpha(value);
13247 }
13248
13249 @Override
13250 public Float get(View object) {
13251 return object.getAlpha();
13252 }
13253 };
13254
13255 /**
13256 * A Property wrapper around the <code>translationX</code> functionality handled by the
13257 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods.
13258 */
13259 public static Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") {
13260 @Override
13261 public void setValue(View object, float value) {
13262 object.setTranslationX(value);
13263 }
13264
13265 @Override
13266 public Float get(View object) {
13267 return object.getTranslationX();
13268 }
13269 };
13270
13271 /**
13272 * A Property wrapper around the <code>translationY</code> functionality handled by the
13273 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods.
13274 */
13275 public static Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") {
13276 @Override
13277 public void setValue(View object, float value) {
13278 object.setTranslationY(value);
13279 }
13280
13281 @Override
13282 public Float get(View object) {
13283 return object.getTranslationY();
13284 }
13285 };
13286
13287 /**
13288 * A Property wrapper around the <code>x</code> functionality handled by the
13289 * {@link View#setX(float)} and {@link View#getX()} methods.
13290 */
13291 public static Property<View, Float> X = new FloatProperty<View>("x") {
13292 @Override
13293 public void setValue(View object, float value) {
13294 object.setX(value);
13295 }
13296
13297 @Override
13298 public Float get(View object) {
13299 return object.getX();
13300 }
13301 };
13302
13303 /**
13304 * A Property wrapper around the <code>y</code> functionality handled by the
13305 * {@link View#setY(float)} and {@link View#getY()} methods.
13306 */
13307 public static Property<View, Float> Y = new FloatProperty<View>("y") {
13308 @Override
13309 public void setValue(View object, float value) {
13310 object.setY(value);
13311 }
13312
13313 @Override
13314 public Float get(View object) {
13315 return object.getY();
13316 }
13317 };
13318
13319 /**
13320 * A Property wrapper around the <code>rotation</code> functionality handled by the
13321 * {@link View#setRotation(float)} and {@link View#getRotation()} methods.
13322 */
13323 public static Property<View, Float> ROTATION = new FloatProperty<View>("rotation") {
13324 @Override
13325 public void setValue(View object, float value) {
13326 object.setRotation(value);
13327 }
13328
13329 @Override
13330 public Float get(View object) {
13331 return object.getRotation();
13332 }
13333 };
13334
13335 /**
13336 * A Property wrapper around the <code>rotationX</code> functionality handled by the
13337 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods.
13338 */
13339 public static Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") {
13340 @Override
13341 public void setValue(View object, float value) {
13342 object.setRotationX(value);
13343 }
13344
13345 @Override
13346 public Float get(View object) {
13347 return object.getRotationX();
13348 }
13349 };
13350
13351 /**
13352 * A Property wrapper around the <code>rotationY</code> functionality handled by the
13353 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods.
13354 */
13355 public static Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") {
13356 @Override
13357 public void setValue(View object, float value) {
13358 object.setRotationY(value);
13359 }
13360
13361 @Override
13362 public Float get(View object) {
13363 return object.getRotationY();
13364 }
13365 };
13366
13367 /**
13368 * A Property wrapper around the <code>scaleX</code> functionality handled by the
13369 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods.
13370 */
13371 public static Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") {
13372 @Override
13373 public void setValue(View object, float value) {
13374 object.setScaleX(value);
13375 }
13376
13377 @Override
13378 public Float get(View object) {
13379 return object.getScaleX();
13380 }
13381 };
13382
13383 /**
13384 * A Property wrapper around the <code>scaleY</code> functionality handled by the
13385 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods.
13386 */
13387 public static Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") {
13388 @Override
13389 public void setValue(View object, float value) {
13390 object.setScaleY(value);
13391 }
13392
13393 @Override
13394 public Float get(View object) {
13395 return object.getScaleY();
13396 }
13397 };
13398
Jeff Brown33bbfd22011-02-24 20:55:35 -080013399 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013400 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
13401 * Each MeasureSpec represents a requirement for either the width or the height.
13402 * A MeasureSpec is comprised of a size and a mode. There are three possible
13403 * modes:
13404 * <dl>
13405 * <dt>UNSPECIFIED</dt>
13406 * <dd>
13407 * The parent has not imposed any constraint on the child. It can be whatever size
13408 * it wants.
13409 * </dd>
13410 *
13411 * <dt>EXACTLY</dt>
13412 * <dd>
13413 * The parent has determined an exact size for the child. The child is going to be
13414 * given those bounds regardless of how big it wants to be.
13415 * </dd>
13416 *
13417 * <dt>AT_MOST</dt>
13418 * <dd>
13419 * The child can be as large as it wants up to the specified size.
13420 * </dd>
13421 * </dl>
13422 *
13423 * MeasureSpecs are implemented as ints to reduce object allocation. This class
13424 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
13425 */
13426 public static class MeasureSpec {
13427 private static final int MODE_SHIFT = 30;
13428 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
13429
13430 /**
13431 * Measure specification mode: The parent has not imposed any constraint
13432 * on the child. It can be whatever size it wants.
13433 */
13434 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
13435
13436 /**
13437 * Measure specification mode: The parent has determined an exact size
13438 * for the child. The child is going to be given those bounds regardless
13439 * of how big it wants to be.
13440 */
13441 public static final int EXACTLY = 1 << MODE_SHIFT;
13442
13443 /**
13444 * Measure specification mode: The child can be as large as it wants up
13445 * to the specified size.
13446 */
13447 public static final int AT_MOST = 2 << MODE_SHIFT;
13448
13449 /**
13450 * Creates a measure specification based on the supplied size and mode.
13451 *
13452 * The mode must always be one of the following:
13453 * <ul>
13454 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
13455 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
13456 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
13457 * </ul>
13458 *
13459 * @param size the size of the measure specification
13460 * @param mode the mode of the measure specification
13461 * @return the measure specification based on size and mode
13462 */
13463 public static int makeMeasureSpec(int size, int mode) {
13464 return size + mode;
13465 }
13466
13467 /**
13468 * Extracts the mode from the supplied measure specification.
13469 *
13470 * @param measureSpec the measure specification to extract the mode from
13471 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
13472 * {@link android.view.View.MeasureSpec#AT_MOST} or
13473 * {@link android.view.View.MeasureSpec#EXACTLY}
13474 */
13475 public static int getMode(int measureSpec) {
13476 return (measureSpec & MODE_MASK);
13477 }
13478
13479 /**
13480 * Extracts the size from the supplied measure specification.
13481 *
13482 * @param measureSpec the measure specification to extract the size from
13483 * @return the size in pixels defined in the supplied measure specification
13484 */
13485 public static int getSize(int measureSpec) {
13486 return (measureSpec & ~MODE_MASK);
13487 }
13488
13489 /**
13490 * Returns a String representation of the specified measure
13491 * specification.
13492 *
13493 * @param measureSpec the measure specification to convert to a String
13494 * @return a String with the following format: "MeasureSpec: MODE SIZE"
13495 */
13496 public static String toString(int measureSpec) {
13497 int mode = getMode(measureSpec);
13498 int size = getSize(measureSpec);
13499
13500 StringBuilder sb = new StringBuilder("MeasureSpec: ");
13501
13502 if (mode == UNSPECIFIED)
13503 sb.append("UNSPECIFIED ");
13504 else if (mode == EXACTLY)
13505 sb.append("EXACTLY ");
13506 else if (mode == AT_MOST)
13507 sb.append("AT_MOST ");
13508 else
13509 sb.append(mode).append(" ");
13510
13511 sb.append(size);
13512 return sb.toString();
13513 }
13514 }
13515
13516 class CheckForLongPress implements Runnable {
13517
13518 private int mOriginalWindowAttachCount;
13519
13520 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070013521 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013522 && mOriginalWindowAttachCount == mWindowAttachCount) {
13523 if (performLongClick()) {
13524 mHasPerformedLongPress = true;
13525 }
13526 }
13527 }
13528
13529 public void rememberWindowAttachCount() {
13530 mOriginalWindowAttachCount = mWindowAttachCount;
13531 }
13532 }
Joe Malin32736f02011-01-19 16:14:20 -080013533
Adam Powelle14579b2009-12-16 18:39:52 -080013534 private final class CheckForTap implements Runnable {
13535 public void run() {
13536 mPrivateFlags &= ~PREPRESSED;
13537 mPrivateFlags |= PRESSED;
13538 refreshDrawableState();
Patrick Dubroye0a799a2011-05-04 16:19:22 -070013539 checkForLongClick(ViewConfiguration.getTapTimeout());
Adam Powelle14579b2009-12-16 18:39:52 -080013540 }
13541 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013542
Adam Powella35d7682010-03-12 14:48:13 -080013543 private final class PerformClick implements Runnable {
13544 public void run() {
13545 performClick();
13546 }
13547 }
13548
Dianne Hackborn63042d62011-01-26 18:56:29 -080013549 /** @hide */
13550 public void hackTurnOffWindowResizeAnim(boolean off) {
13551 mAttachInfo.mTurnOffWindowResizeAnim = off;
13552 }
Joe Malin32736f02011-01-19 16:14:20 -080013553
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013554 /**
Chet Haasea00f3862011-02-22 06:34:40 -080013555 * This method returns a ViewPropertyAnimator object, which can be used to animate
13556 * specific properties on this View.
13557 *
13558 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View.
13559 */
13560 public ViewPropertyAnimator animate() {
13561 if (mAnimator == null) {
13562 mAnimator = new ViewPropertyAnimator(this);
13563 }
13564 return mAnimator;
13565 }
13566
13567 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013568 * Interface definition for a callback to be invoked when a key event is
13569 * dispatched to this view. The callback will be invoked before the key
13570 * event is given to the view.
13571 */
13572 public interface OnKeyListener {
13573 /**
13574 * Called when a key is dispatched to a view. This allows listeners to
13575 * get a chance to respond before the target view.
13576 *
13577 * @param v The view the key has been dispatched to.
13578 * @param keyCode The code for the physical key that was pressed
13579 * @param event The KeyEvent object containing full information about
13580 * the event.
13581 * @return True if the listener has consumed the event, false otherwise.
13582 */
13583 boolean onKey(View v, int keyCode, KeyEvent event);
13584 }
13585
13586 /**
13587 * Interface definition for a callback to be invoked when a touch event is
13588 * dispatched to this view. The callback will be invoked before the touch
13589 * event is given to the view.
13590 */
13591 public interface OnTouchListener {
13592 /**
13593 * Called when a touch event is dispatched to a view. This allows listeners to
13594 * get a chance to respond before the target view.
13595 *
13596 * @param v The view the touch event has been dispatched to.
13597 * @param event The MotionEvent object containing full information about
13598 * the event.
13599 * @return True if the listener has consumed the event, false otherwise.
13600 */
13601 boolean onTouch(View v, MotionEvent event);
13602 }
13603
13604 /**
Jeff Brown10b62902011-06-20 16:40:37 -070013605 * Interface definition for a callback to be invoked when a hover event is
13606 * dispatched to this view. The callback will be invoked before the hover
13607 * event is given to the view.
13608 */
13609 public interface OnHoverListener {
13610 /**
13611 * Called when a hover event is dispatched to a view. This allows listeners to
13612 * get a chance to respond before the target view.
13613 *
13614 * @param v The view the hover event has been dispatched to.
13615 * @param event The MotionEvent object containing full information about
13616 * the event.
13617 * @return True if the listener has consumed the event, false otherwise.
13618 */
13619 boolean onHover(View v, MotionEvent event);
13620 }
13621
13622 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080013623 * Interface definition for a callback to be invoked when a generic motion event is
13624 * dispatched to this view. The callback will be invoked before the generic motion
13625 * event is given to the view.
13626 */
13627 public interface OnGenericMotionListener {
13628 /**
13629 * Called when a generic motion event is dispatched to a view. This allows listeners to
13630 * get a chance to respond before the target view.
13631 *
13632 * @param v The view the generic motion event has been dispatched to.
13633 * @param event The MotionEvent object containing full information about
13634 * the event.
13635 * @return True if the listener has consumed the event, false otherwise.
13636 */
13637 boolean onGenericMotion(View v, MotionEvent event);
13638 }
13639
13640 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013641 * Interface definition for a callback to be invoked when a view has been clicked and held.
13642 */
13643 public interface OnLongClickListener {
13644 /**
13645 * Called when a view has been clicked and held.
13646 *
13647 * @param v The view that was clicked and held.
13648 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080013649 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013650 */
13651 boolean onLongClick(View v);
13652 }
13653
13654 /**
Chris Tate32affef2010-10-18 15:29:21 -070013655 * Interface definition for a callback to be invoked when a drag is being dispatched
13656 * to this view. The callback will be invoked before the hosting view's own
13657 * onDrag(event) method. If the listener wants to fall back to the hosting view's
13658 * onDrag(event) behavior, it should return 'false' from this callback.
13659 */
13660 public interface OnDragListener {
13661 /**
13662 * Called when a drag event is dispatched to a view. This allows listeners
13663 * to get a chance to override base View behavior.
13664 *
Joe Malin32736f02011-01-19 16:14:20 -080013665 * @param v The View that received the drag event.
13666 * @param event The {@link android.view.DragEvent} object for the drag event.
13667 * @return {@code true} if the drag event was handled successfully, or {@code false}
13668 * if the drag event was not handled. Note that {@code false} will trigger the View
13669 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler.
Chris Tate32affef2010-10-18 15:29:21 -070013670 */
13671 boolean onDrag(View v, DragEvent event);
13672 }
13673
13674 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013675 * Interface definition for a callback to be invoked when the focus state of
13676 * a view changed.
13677 */
13678 public interface OnFocusChangeListener {
13679 /**
13680 * Called when the focus state of a view has changed.
13681 *
13682 * @param v The view whose state has changed.
13683 * @param hasFocus The new focus state of v.
13684 */
13685 void onFocusChange(View v, boolean hasFocus);
13686 }
13687
13688 /**
13689 * Interface definition for a callback to be invoked when a view is clicked.
13690 */
13691 public interface OnClickListener {
13692 /**
13693 * Called when a view has been clicked.
13694 *
13695 * @param v The view that was clicked.
13696 */
13697 void onClick(View v);
13698 }
13699
13700 /**
13701 * Interface definition for a callback to be invoked when the context menu
13702 * for this view is being built.
13703 */
13704 public interface OnCreateContextMenuListener {
13705 /**
13706 * Called when the context menu for this view is being built. It is not
13707 * safe to hold onto the menu after this method returns.
13708 *
13709 * @param menu The context menu that is being built
13710 * @param v The view for which the context menu is being built
13711 * @param menuInfo Extra information about the item for which the
13712 * context menu should be shown. This information will vary
13713 * depending on the class of v.
13714 */
13715 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
13716 }
13717
Joe Onorato664644d2011-01-23 17:53:23 -080013718 /**
13719 * Interface definition for a callback to be invoked when the status bar changes
13720 * visibility.
13721 *
Romain Guy5c22a8c2011-05-13 11:48:45 -070013722 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener)
Joe Onorato664644d2011-01-23 17:53:23 -080013723 */
13724 public interface OnSystemUiVisibilityChangeListener {
13725 /**
13726 * Called when the status bar changes visibility because of a call to
Romain Guy5c22a8c2011-05-13 11:48:45 -070013727 * {@link View#setSystemUiVisibility(int)}.
Joe Onorato664644d2011-01-23 17:53:23 -080013728 *
Daniel Sandler60ee2562011-07-22 12:34:33 -040013729 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE} or
13730 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}.
Joe Onorato664644d2011-01-23 17:53:23 -080013731 */
13732 public void onSystemUiVisibilityChange(int visibility);
13733 }
13734
Adam Powell4afd62b2011-02-18 15:02:18 -080013735 /**
13736 * Interface definition for a callback to be invoked when this view is attached
13737 * or detached from its window.
13738 */
13739 public interface OnAttachStateChangeListener {
13740 /**
13741 * Called when the view is attached to a window.
13742 * @param v The view that was attached
13743 */
13744 public void onViewAttachedToWindow(View v);
13745 /**
13746 * Called when the view is detached from a window.
13747 * @param v The view that was detached
13748 */
13749 public void onViewDetachedFromWindow(View v);
13750 }
13751
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013752 private final class UnsetPressedState implements Runnable {
13753 public void run() {
13754 setPressed(false);
13755 }
13756 }
13757
13758 /**
13759 * Base class for derived classes that want to save and restore their own
13760 * state in {@link android.view.View#onSaveInstanceState()}.
13761 */
13762 public static class BaseSavedState extends AbsSavedState {
13763 /**
13764 * Constructor used when reading from a parcel. Reads the state of the superclass.
13765 *
13766 * @param source
13767 */
13768 public BaseSavedState(Parcel source) {
13769 super(source);
13770 }
13771
13772 /**
13773 * Constructor called by derived classes when creating their SavedState objects
13774 *
13775 * @param superState The state of the superclass of this view
13776 */
13777 public BaseSavedState(Parcelable superState) {
13778 super(superState);
13779 }
13780
13781 public static final Parcelable.Creator<BaseSavedState> CREATOR =
13782 new Parcelable.Creator<BaseSavedState>() {
13783 public BaseSavedState createFromParcel(Parcel in) {
13784 return new BaseSavedState(in);
13785 }
13786
13787 public BaseSavedState[] newArray(int size) {
13788 return new BaseSavedState[size];
13789 }
13790 };
13791 }
13792
13793 /**
13794 * A set of information given to a view when it is attached to its parent
13795 * window.
13796 */
13797 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013798 interface Callbacks {
13799 void playSoundEffect(int effectId);
13800 boolean performHapticFeedback(int effectId, boolean always);
13801 }
13802
13803 /**
13804 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
13805 * to a Handler. This class contains the target (View) to invalidate and
13806 * the coordinates of the dirty rectangle.
13807 *
13808 * For performance purposes, this class also implements a pool of up to
13809 * POOL_LIMIT objects that get reused. This reduces memory allocations
13810 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013811 */
Romain Guyd928d682009-03-31 17:52:16 -070013812 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013813 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070013814 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
13815 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070013816 public InvalidateInfo newInstance() {
13817 return new InvalidateInfo();
13818 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013819
Romain Guyd928d682009-03-31 17:52:16 -070013820 public void onAcquired(InvalidateInfo element) {
13821 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013822
Romain Guyd928d682009-03-31 17:52:16 -070013823 public void onReleased(InvalidateInfo element) {
13824 }
13825 }, POOL_LIMIT)
13826 );
13827
13828 private InvalidateInfo mNext;
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070013829 private boolean mIsPooled;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013830
13831 View target;
13832
13833 int left;
13834 int top;
13835 int right;
13836 int bottom;
13837
Romain Guyd928d682009-03-31 17:52:16 -070013838 public void setNextPoolable(InvalidateInfo element) {
13839 mNext = element;
13840 }
13841
13842 public InvalidateInfo getNextPoolable() {
13843 return mNext;
13844 }
13845
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013846 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070013847 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013848 }
13849
13850 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070013851 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013852 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070013853
13854 public boolean isPooled() {
13855 return mIsPooled;
13856 }
13857
13858 public void setPooled(boolean isPooled) {
13859 mIsPooled = isPooled;
13860 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013861 }
13862
13863 final IWindowSession mSession;
13864
13865 final IWindow mWindow;
13866
13867 final IBinder mWindowToken;
13868
13869 final Callbacks mRootCallbacks;
13870
Romain Guy59a12ca2011-06-09 17:48:21 -070013871 HardwareCanvas mHardwareCanvas;
Chet Haasedaf98e92011-01-10 14:10:36 -080013872
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013873 /**
13874 * The top view of the hierarchy.
13875 */
13876 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070013877
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013878 IBinder mPanelParentWindowToken;
13879 Surface mSurface;
13880
Romain Guyb051e892010-09-28 19:09:36 -070013881 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080013882 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070013883 HardwareRenderer mHardwareRenderer;
Joe Malin32736f02011-01-19 16:14:20 -080013884
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013885 /**
Romain Guy8506ab42009-06-11 17:35:47 -070013886 * Scale factor used by the compatibility mode
13887 */
13888 float mApplicationScale;
13889
13890 /**
13891 * Indicates whether the application is in compatibility mode
13892 */
13893 boolean mScalingRequired;
13894
13895 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070013896 * If set, ViewAncestor doesn't use its lame animation for when the window resizes.
Dianne Hackborn63042d62011-01-26 18:56:29 -080013897 */
13898 boolean mTurnOffWindowResizeAnim;
Joe Malin32736f02011-01-19 16:14:20 -080013899
Dianne Hackborn63042d62011-01-26 18:56:29 -080013900 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013901 * Left position of this view's window
13902 */
13903 int mWindowLeft;
13904
13905 /**
13906 * Top position of this view's window
13907 */
13908 int mWindowTop;
13909
13910 /**
Adam Powell26153a32010-11-08 15:22:27 -080013911 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070013912 */
Adam Powell26153a32010-11-08 15:22:27 -080013913 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070013914
13915 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013916 * For windows that are full-screen but using insets to layout inside
13917 * of the screen decorations, these are the current insets for the
13918 * content of the window.
13919 */
13920 final Rect mContentInsets = new Rect();
13921
13922 /**
13923 * For windows that are full-screen but using insets to layout inside
13924 * of the screen decorations, these are the current insets for the
13925 * actual visible parts of the window.
13926 */
13927 final Rect mVisibleInsets = new Rect();
13928
13929 /**
13930 * The internal insets given by this window. This value is
13931 * supplied by the client (through
13932 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
13933 * be given to the window manager when changed to be used in laying
13934 * out windows behind it.
13935 */
13936 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
13937 = new ViewTreeObserver.InternalInsetsInfo();
13938
13939 /**
13940 * All views in the window's hierarchy that serve as scroll containers,
13941 * used to determine if the window can be resized or must be panned
13942 * to adjust for a soft input area.
13943 */
13944 final ArrayList<View> mScrollContainers = new ArrayList<View>();
13945
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070013946 final KeyEvent.DispatcherState mKeyDispatchState
13947 = new KeyEvent.DispatcherState();
13948
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013949 /**
13950 * Indicates whether the view's window currently has the focus.
13951 */
13952 boolean mHasWindowFocus;
13953
13954 /**
13955 * The current visibility of the window.
13956 */
13957 int mWindowVisibility;
13958
13959 /**
13960 * Indicates the time at which drawing started to occur.
13961 */
13962 long mDrawingTime;
13963
13964 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070013965 * Indicates whether or not ignoring the DIRTY_MASK flags.
13966 */
13967 boolean mIgnoreDirtyState;
13968
13969 /**
Romain Guy02ccac62011-06-24 13:20:23 -070013970 * This flag tracks when the mIgnoreDirtyState flag is set during draw(),
13971 * to avoid clearing that flag prematurely.
13972 */
13973 boolean mSetIgnoreDirtyState = false;
13974
13975 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013976 * Indicates whether the view's window is currently in touch mode.
13977 */
13978 boolean mInTouchMode;
13979
13980 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070013981 * Indicates that ViewAncestor should trigger a global layout change
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013982 * the next time it performs a traversal
13983 */
13984 boolean mRecomputeGlobalAttributes;
13985
13986 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013987 * Set during a traveral if any views want to keep the screen on.
13988 */
13989 boolean mKeepScreenOn;
13990
13991 /**
Joe Onorato664644d2011-01-23 17:53:23 -080013992 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility().
13993 */
13994 int mSystemUiVisibility;
13995
13996 /**
13997 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener
13998 * attached.
13999 */
14000 boolean mHasSystemUiListeners;
14001
14002 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014003 * Set if the visibility of any views has changed.
14004 */
14005 boolean mViewVisibilityChanged;
14006
14007 /**
14008 * Set to true if a view has been scrolled.
14009 */
14010 boolean mViewScrollChanged;
14011
14012 /**
14013 * Global to the view hierarchy used as a temporary for dealing with
14014 * x/y points in the transparent region computations.
14015 */
14016 final int[] mTransparentLocation = new int[2];
14017
14018 /**
14019 * Global to the view hierarchy used as a temporary for dealing with
14020 * x/y points in the ViewGroup.invalidateChild implementation.
14021 */
14022 final int[] mInvalidateChildLocation = new int[2];
14023
Chet Haasec3aa3612010-06-17 08:50:37 -070014024
14025 /**
14026 * Global to the view hierarchy used as a temporary for dealing with
14027 * x/y location when view is transformed.
14028 */
14029 final float[] mTmpTransformLocation = new float[2];
14030
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014031 /**
14032 * The view tree observer used to dispatch global events like
14033 * layout, pre-draw, touch mode change, etc.
14034 */
14035 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
14036
14037 /**
14038 * A Canvas used by the view hierarchy to perform bitmap caching.
14039 */
14040 Canvas mCanvas;
14041
14042 /**
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070014043 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014044 * handler can be used to pump events in the UI events queue.
14045 */
14046 final Handler mHandler;
14047
14048 /**
14049 * Identifier for messages requesting the view to be invalidated.
14050 * Such messages should be sent to {@link #mHandler}.
14051 */
14052 static final int INVALIDATE_MSG = 0x1;
14053
14054 /**
14055 * Identifier for messages requesting the view to invalidate a region.
14056 * Such messages should be sent to {@link #mHandler}.
14057 */
14058 static final int INVALIDATE_RECT_MSG = 0x2;
14059
14060 /**
14061 * Temporary for use in computing invalidate rectangles while
14062 * calling up the hierarchy.
14063 */
14064 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070014065
14066 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070014067 * Temporary for use in computing hit areas with transformed views
14068 */
14069 final RectF mTmpTransformRect = new RectF();
14070
14071 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070014072 * Temporary list for use in collecting focusable descendents of a view.
14073 */
14074 final ArrayList<View> mFocusablesTempList = new ArrayList<View>(24);
14075
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014076 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070014077 * The id of the window for accessibility purposes.
14078 */
14079 int mAccessibilityWindowId = View.NO_ID;
14080
14081 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014082 * Creates a new set of attachment information with the specified
14083 * events handler and thread.
14084 *
14085 * @param handler the events handler the view must use
14086 */
14087 AttachInfo(IWindowSession session, IWindow window,
14088 Handler handler, Callbacks effectPlayer) {
14089 mSession = session;
14090 mWindow = window;
14091 mWindowToken = window.asBinder();
14092 mHandler = handler;
14093 mRootCallbacks = effectPlayer;
14094 }
14095 }
14096
14097 /**
14098 * <p>ScrollabilityCache holds various fields used by a View when scrolling
14099 * is supported. This avoids keeping too many unused fields in most
14100 * instances of View.</p>
14101 */
Mike Cleronf116bf82009-09-27 19:14:12 -070014102 private static class ScrollabilityCache implements Runnable {
Joe Malin32736f02011-01-19 16:14:20 -080014103
Mike Cleronf116bf82009-09-27 19:14:12 -070014104 /**
14105 * Scrollbars are not visible
14106 */
14107 public static final int OFF = 0;
14108
14109 /**
14110 * Scrollbars are visible
14111 */
14112 public static final int ON = 1;
14113
14114 /**
14115 * Scrollbars are fading away
14116 */
14117 public static final int FADING = 2;
14118
14119 public boolean fadeScrollBars;
Joe Malin32736f02011-01-19 16:14:20 -080014120
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014121 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070014122 public int scrollBarDefaultDelayBeforeFade;
14123 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014124
14125 public int scrollBarSize;
14126 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070014127 public float[] interpolatorValues;
14128 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014129
14130 public final Paint paint;
14131 public final Matrix matrix;
14132 public Shader shader;
14133
Mike Cleronf116bf82009-09-27 19:14:12 -070014134 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
14135
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080014136 private static final float[] OPAQUE = { 255 };
14137 private static final float[] TRANSPARENT = { 0.0f };
Joe Malin32736f02011-01-19 16:14:20 -080014138
Mike Cleronf116bf82009-09-27 19:14:12 -070014139 /**
14140 * When fading should start. This time moves into the future every time
14141 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
14142 */
14143 public long fadeStartTime;
14144
14145
14146 /**
14147 * The current state of the scrollbars: ON, OFF, or FADING
14148 */
14149 public int state = OFF;
14150
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014151 private int mLastColor;
14152
Mike Cleronf116bf82009-09-27 19:14:12 -070014153 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014154 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
14155 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070014156 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
14157 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014158
14159 paint = new Paint();
14160 matrix = new Matrix();
14161 // use use a height of 1, and then wack the matrix each time we
14162 // actually use it.
14163 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070014164
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014165 paint.setShader(shader);
14166 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070014167 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014168 }
Romain Guy8506ab42009-06-11 17:35:47 -070014169
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014170 public void setFadeColor(int color) {
14171 if (color != 0 && color != mLastColor) {
14172 mLastColor = color;
14173 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070014174
Romain Guye55e1a72009-08-27 10:42:26 -070014175 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
14176 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070014177
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014178 paint.setShader(shader);
14179 // Restore the default transfer mode (src_over)
14180 paint.setXfermode(null);
14181 }
14182 }
Joe Malin32736f02011-01-19 16:14:20 -080014183
Mike Cleronf116bf82009-09-27 19:14:12 -070014184 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070014185 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070014186 if (now >= fadeStartTime) {
14187
14188 // the animation fades the scrollbars out by changing
14189 // the opacity (alpha) from fully opaque to fully
14190 // transparent
14191 int nextFrame = (int) now;
14192 int framesCount = 0;
14193
14194 Interpolator interpolator = scrollBarInterpolator;
14195
14196 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080014197 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070014198
14199 // End transparent
14200 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080014201 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070014202
14203 state = FADING;
14204
14205 // Kick off the fade animation
Romain Guy0fd89bf2011-01-26 15:41:30 -080014206 host.invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -070014207 }
14208 }
Svetoslav Ganova0156172011-06-26 17:55:44 -070014209 }
Mike Cleronf116bf82009-09-27 19:14:12 -070014210
Svetoslav Ganova0156172011-06-26 17:55:44 -070014211 /**
14212 * Resuable callback for sending
14213 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
14214 */
14215 private class SendViewScrolledAccessibilityEvent implements Runnable {
14216 public volatile boolean mIsPending;
14217
14218 public void run() {
14219 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED);
14220 mIsPending = false;
14221 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014222 }
14223}