blob: 0e8723f73e0aec977e35c1c0ecd92cb81465e2ed [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;
Philip Milne1557fd72012-04-04 23:41:34 -070027import android.graphics.Insets;
Mike Cleronf116bf82009-09-27 19:14:12 -070028import android.graphics.Interpolator;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080029import android.graphics.LinearGradient;
30import android.graphics.Matrix;
31import android.graphics.Paint;
32import android.graphics.PixelFormat;
svetoslavganov75986cf2009-05-14 22:28:01 -070033import android.graphics.Point;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080034import android.graphics.PorterDuff;
35import android.graphics.PorterDuffXfermode;
36import android.graphics.Rect;
Adam Powell6e346362010-07-23 10:18:23 -070037import android.graphics.RectF;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080038import android.graphics.Region;
39import android.graphics.Shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080040import android.graphics.drawable.ColorDrawable;
41import android.graphics.drawable.Drawable;
Svetoslav Ganovaa780c12012-04-19 23:01:39 -070042import android.os.Bundle;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080043import android.os.Handler;
44import android.os.IBinder;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080045import android.os.Parcel;
46import android.os.Parcelable;
47import android.os.RemoteException;
48import android.os.SystemClock;
Philip Milne10ca24a2012-04-23 15:38:27 -070049import android.os.SystemProperties;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080050import android.util.AttributeSet;
Doug Feltcb3791202011-07-07 11:57:48 -070051import android.util.FloatProperty;
52import android.util.LocaleUtil;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080053import android.util.Log;
Romain Guyd928d682009-03-31 17:52:16 -070054import android.util.Pool;
svetoslavganov75986cf2009-05-14 22:28:01 -070055import android.util.Poolable;
Romain Guyd928d682009-03-31 17:52:16 -070056import android.util.PoolableManager;
svetoslavganov75986cf2009-05-14 22:28:01 -070057import android.util.Pools;
Doug Feltcb3791202011-07-07 11:57:48 -070058import android.util.Property;
svetoslavganov75986cf2009-05-14 22:28:01 -070059import android.util.SparseArray;
Jeff Brown33bbfd22011-02-24 20:55:35 -080060import android.util.TypedValue;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080061import android.view.ContextMenu.ContextMenuInfo;
Svetoslav Ganov6d17a932012-04-27 19:30:38 -070062import android.view.AccessibilityIterators.TextSegmentIterator;
63import android.view.AccessibilityIterators.CharacterTextSegmentIterator;
64import android.view.AccessibilityIterators.WordTextSegmentIterator;
65import android.view.AccessibilityIterators.ParagraphTextSegmentIterator;
svetoslavganov75986cf2009-05-14 22:28:01 -070066import android.view.accessibility.AccessibilityEvent;
67import android.view.accessibility.AccessibilityEventSource;
68import android.view.accessibility.AccessibilityManager;
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070069import android.view.accessibility.AccessibilityNodeInfo;
Svetoslav Ganov02107852011-10-03 17:06:56 -070070import android.view.accessibility.AccessibilityNodeProvider;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080071import android.view.animation.Animation;
Mike Cleron3ecd58c2009-09-28 11:39:02 -070072import android.view.animation.AnimationUtils;
Chet Haase64a48c12012-02-13 16:33:29 -080073import android.view.animation.Transformation;
svetoslavganov75986cf2009-05-14 22:28:01 -070074import android.view.inputmethod.EditorInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080075import android.view.inputmethod.InputConnection;
76import android.view.inputmethod.InputMethodManager;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080077import android.widget.ScrollBarDrawable;
78
Romain Guy1ef3fdb2011-09-09 15:30:30 -070079import static android.os.Build.VERSION_CODES.*;
Philip Milne6c8ea062012-04-03 17:38:43 -070080import static java.lang.Math.max;
Romain Guy1ef3fdb2011-09-09 15:30:30 -070081
Doug Feltcb3791202011-07-07 11:57:48 -070082import com.android.internal.R;
83import com.android.internal.util.Predicate;
84import com.android.internal.view.menu.MenuBuilder;
85
Christopher Tatea0374192010-10-05 13:06:41 -070086import java.lang.ref.WeakReference;
svetoslavganov75986cf2009-05-14 22:28:01 -070087import java.lang.reflect.InvocationTargetException;
88import java.lang.reflect.Method;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080089import java.util.ArrayList;
90import java.util.Arrays;
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070091import java.util.Locale;
Adam Powell4afd62b2011-02-18 15:02:18 -080092import java.util.concurrent.CopyOnWriteArrayList;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080093
94/**
95 * <p>
96 * This class represents the basic building block for user interface components. A View
97 * occupies a rectangular area on the screen and is responsible for drawing and
98 * event handling. View is the base class for <em>widgets</em>, which are
Romain Guy8506ab42009-06-11 17:35:47 -070099 * used to create interactive UI components (buttons, text fields, etc.). The
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800100 * {@link android.view.ViewGroup} subclass is the base class for <em>layouts</em>, which
101 * are invisible containers that hold other Views (or other ViewGroups) and define
102 * their layout properties.
103 * </p>
104 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -0700105 * <div class="special reference">
106 * <h3>Developer Guides</h3>
107 * <p>For information about using this class to develop your application's user interface,
108 * read the <a href="{@docRoot}guide/topics/ui/index.html">User Interface</a> developer guide.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800109 * </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)}.
Philip Milne6c8ea062012-04-03 17:38:43 -0700136 * Other view subclasses offer more specialized listeners. For example, a Button
Romain Guy5c22a8c2011-05-13 11:48:45 -0700137 * 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
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -0700346 * {@link #setPadding(int, int, int, int)} method and queried by calling
347 * {@link #getPaddingLeft()}, {@link #getPaddingTop()}, {@link #getPaddingRight()},
348 * {@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
Joe Fernandez558459f2011-10-13 16:47:36 -0700429 * intersects the invalid region. Because the tree is traversed in-order,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800430 * 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 *
Chet Haasecb150fe2012-05-03 15:15:05 -0700542 * <a name="Properties"></a>
543 * <h3>Properties</h3>
544 * <p>
545 * The View class exposes an {@link #ALPHA} property, as well as several transform-related
546 * properties, such as {@link #TRANSLATION_X} and {@link #TRANSLATION_Y}. These properties are
547 * available both in the {@link Property} form as well as in similarly-named setter/getter
548 * methods (such as {@link #setAlpha(float)} for {@link #ALPHA}). These properties can
549 * be used to set persistent state associated with these rendering-related properties on the view.
550 * The properties and methods can also be used in conjunction with
551 * {@link android.animation.Animator Animator}-based animations, described more in the
552 * <a href="#Animation">Animation</a> section.
553 * </p>
554 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800555 * <a name="Animation"></a>
556 * <h3>Animation</h3>
557 * <p>
Chet Haasecb150fe2012-05-03 15:15:05 -0700558 * Starting with Android 3.0, the preferred way of animating views is to use the
559 * {@link android.animation} package APIs. These {@link android.animation.Animator Animator}-based
560 * classes change actual properties of the View object, such as {@link #setAlpha(float) alpha} and
561 * {@link #setTranslationX(float) translationX}. This behavior is contrasted to that of the pre-3.0
562 * {@link android.view.animation.Animation Animation}-based classes, which instead animate only
563 * how the view is drawn on the display. In particular, the {@link ViewPropertyAnimator} class
564 * makes animating these View properties particularly easy and efficient.
565 * </p>
566 * <p>
567 * Alternatively, you can use the pre-3.0 animation classes to animate how Views are rendered.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800568 * You can attach an {@link Animation} object to a view using
569 * {@link #setAnimation(Animation)} or
570 * {@link #startAnimation(Animation)}. The animation can alter the scale,
571 * rotation, translation and alpha of a view over time. If the animation is
572 * attached to a view that has children, the animation will affect the entire
573 * subtree rooted by that node. When an animation is started, the framework will
574 * take care of redrawing the appropriate views until the animation completes.
575 * </p>
576 *
Jeff Brown85a31762010-09-01 17:01:00 -0700577 * <a name="Security"></a>
578 * <h3>Security</h3>
579 * <p>
580 * Sometimes it is essential that an application be able to verify that an action
581 * is being performed with the full knowledge and consent of the user, such as
582 * granting a permission request, making a purchase or clicking on an advertisement.
583 * Unfortunately, a malicious application could try to spoof the user into
584 * performing these actions, unaware, by concealing the intended purpose of the view.
585 * As a remedy, the framework offers a touch filtering mechanism that can be used to
586 * improve the security of views that provide access to sensitive functionality.
587 * </p><p>
Romain Guy5c22a8c2011-05-13 11:48:45 -0700588 * To enable touch filtering, call {@link #setFilterTouchesWhenObscured(boolean)} or set the
Jeff Brown49ed71d2010-12-06 17:13:33 -0800589 * android:filterTouchesWhenObscured layout attribute to true. When enabled, the framework
Jeff Brown85a31762010-09-01 17:01:00 -0700590 * will discard touches that are received whenever the view's window is obscured by
591 * another visible window. As a result, the view will not receive touches whenever a
592 * toast, dialog or other window appears above the view's window.
593 * </p><p>
594 * For more fine-grained control over security, consider overriding the
Romain Guy5c22a8c2011-05-13 11:48:45 -0700595 * {@link #onFilterTouchEventForSecurity(MotionEvent)} method to implement your own
596 * security policy. See also {@link MotionEvent#FLAG_WINDOW_IS_OBSCURED}.
Jeff Brown85a31762010-09-01 17:01:00 -0700597 * </p>
598 *
Romain Guy171c5922011-01-06 10:04:23 -0800599 * @attr ref android.R.styleable#View_alpha
Romain Guyd6a463a2009-05-21 23:10:10 -0700600 * @attr ref android.R.styleable#View_background
601 * @attr ref android.R.styleable#View_clickable
602 * @attr ref android.R.styleable#View_contentDescription
603 * @attr ref android.R.styleable#View_drawingCacheQuality
604 * @attr ref android.R.styleable#View_duplicateParentState
605 * @attr ref android.R.styleable#View_id
Romain Guy1ef3fdb2011-09-09 15:30:30 -0700606 * @attr ref android.R.styleable#View_requiresFadingEdge
Philip Milne6c8ea062012-04-03 17:38:43 -0700607 * @attr ref android.R.styleable#View_fadeScrollbars
Romain Guyd6a463a2009-05-21 23:10:10 -0700608 * @attr ref android.R.styleable#View_fadingEdgeLength
Jeff Brown85a31762010-09-01 17:01:00 -0700609 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800610 * @attr ref android.R.styleable#View_fitsSystemWindows
Romain Guyd6a463a2009-05-21 23:10:10 -0700611 * @attr ref android.R.styleable#View_isScrollContainer
612 * @attr ref android.R.styleable#View_focusable
613 * @attr ref android.R.styleable#View_focusableInTouchMode
614 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
615 * @attr ref android.R.styleable#View_keepScreenOn
Romain Guy171c5922011-01-06 10:04:23 -0800616 * @attr ref android.R.styleable#View_layerType
Romain Guyd6a463a2009-05-21 23:10:10 -0700617 * @attr ref android.R.styleable#View_longClickable
618 * @attr ref android.R.styleable#View_minHeight
619 * @attr ref android.R.styleable#View_minWidth
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800620 * @attr ref android.R.styleable#View_nextFocusDown
621 * @attr ref android.R.styleable#View_nextFocusLeft
622 * @attr ref android.R.styleable#View_nextFocusRight
623 * @attr ref android.R.styleable#View_nextFocusUp
Romain Guyd6a463a2009-05-21 23:10:10 -0700624 * @attr ref android.R.styleable#View_onClick
625 * @attr ref android.R.styleable#View_padding
626 * @attr ref android.R.styleable#View_paddingBottom
627 * @attr ref android.R.styleable#View_paddingLeft
628 * @attr ref android.R.styleable#View_paddingRight
629 * @attr ref android.R.styleable#View_paddingTop
630 * @attr ref android.R.styleable#View_saveEnabled
Chet Haase73066682010-11-29 15:55:32 -0800631 * @attr ref android.R.styleable#View_rotation
632 * @attr ref android.R.styleable#View_rotationX
633 * @attr ref android.R.styleable#View_rotationY
634 * @attr ref android.R.styleable#View_scaleX
635 * @attr ref android.R.styleable#View_scaleY
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800636 * @attr ref android.R.styleable#View_scrollX
637 * @attr ref android.R.styleable#View_scrollY
Romain Guyd6a463a2009-05-21 23:10:10 -0700638 * @attr ref android.R.styleable#View_scrollbarSize
639 * @attr ref android.R.styleable#View_scrollbarStyle
640 * @attr ref android.R.styleable#View_scrollbars
Mike Cleronf116bf82009-09-27 19:14:12 -0700641 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
642 * @attr ref android.R.styleable#View_scrollbarFadeDuration
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800643 * @attr ref android.R.styleable#View_scrollbarTrackHorizontal
644 * @attr ref android.R.styleable#View_scrollbarThumbHorizontal
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800645 * @attr ref android.R.styleable#View_scrollbarThumbVertical
646 * @attr ref android.R.styleable#View_scrollbarTrackVertical
647 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawHorizontalTrack
648 * @attr ref android.R.styleable#View_scrollbarAlwaysDrawVerticalTrack
Romain Guyd6a463a2009-05-21 23:10:10 -0700649 * @attr ref android.R.styleable#View_soundEffectsEnabled
650 * @attr ref android.R.styleable#View_tag
Chet Haase73066682010-11-29 15:55:32 -0800651 * @attr ref android.R.styleable#View_transformPivotX
652 * @attr ref android.R.styleable#View_transformPivotY
653 * @attr ref android.R.styleable#View_translationX
654 * @attr ref android.R.styleable#View_translationY
Romain Guyd6a463a2009-05-21 23:10:10 -0700655 * @attr ref android.R.styleable#View_visibility
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800656 *
657 * @see android.view.ViewGroup
658 */
Adam Powell8fc54f92011-09-07 16:40:45 -0700659public class View implements Drawable.Callback, Drawable.Callback2, KeyEvent.Callback,
660 AccessibilityEventSource {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800661 private static final boolean DBG = false;
662
663 /**
664 * The logging tag used by this class with android.util.Log.
665 */
666 protected static final String VIEW_LOG_TAG = "View";
667
668 /**
Romain Guy4b8c4f82012-04-27 15:48:35 -0700669 * When set to true, apps will draw debugging information about their layouts.
670 *
671 * @hide
672 */
673 public static final String DEBUG_LAYOUT_PROPERTY = "debug.layout";
674
675 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800676 * Used to mark a View that has no ID.
677 */
678 public static final int NO_ID = -1;
679
680 /**
681 * This view does not want keystrokes. Use with TAKES_FOCUS_MASK when
682 * calling setFlags.
683 */
684 private static final int NOT_FOCUSABLE = 0x00000000;
685
686 /**
687 * This view wants keystrokes. Use with TAKES_FOCUS_MASK when calling
688 * setFlags.
689 */
690 private static final int FOCUSABLE = 0x00000001;
691
692 /**
693 * Mask for use with setFlags indicating bits used for focus.
694 */
695 private static final int FOCUSABLE_MASK = 0x00000001;
696
697 /**
698 * This view will adjust its padding to fit sytem windows (e.g. status bar)
699 */
700 private static final int FITS_SYSTEM_WINDOWS = 0x00000002;
701
702 /**
Scott Main812634c22011-07-27 13:22:35 -0700703 * This view is visible.
704 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code
705 * android:visibility}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800706 */
707 public static final int VISIBLE = 0x00000000;
708
709 /**
710 * This view is invisible, but it still takes up space for layout purposes.
Scott Main812634c22011-07-27 13:22:35 -0700711 * Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code
712 * android:visibility}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800713 */
714 public static final int INVISIBLE = 0x00000004;
715
716 /**
717 * This view is invisible, and it doesn't take any space for layout
Scott Main812634c22011-07-27 13:22:35 -0700718 * purposes. Use with {@link #setVisibility} and <a href="#attr_android:visibility">{@code
719 * android:visibility}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800720 */
721 public static final int GONE = 0x00000008;
722
723 /**
724 * Mask for use with setFlags indicating bits used for visibility.
725 * {@hide}
726 */
727 static final int VISIBILITY_MASK = 0x0000000C;
728
729 private static final int[] VISIBILITY_FLAGS = {VISIBLE, INVISIBLE, GONE};
730
731 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -0700732 * This view is enabled. Interpretation varies by subclass.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800733 * Use with ENABLED_MASK when calling setFlags.
734 * {@hide}
735 */
736 static final int ENABLED = 0x00000000;
737
738 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -0700739 * This view is disabled. Interpretation varies by subclass.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800740 * Use with ENABLED_MASK when calling setFlags.
741 * {@hide}
742 */
743 static final int DISABLED = 0x00000020;
744
745 /**
746 * Mask for use with setFlags indicating bits used for indicating whether
747 * this view is enabled
748 * {@hide}
749 */
750 static final int ENABLED_MASK = 0x00000020;
751
752 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -0700753 * This view won't draw. {@link #onDraw(android.graphics.Canvas)} won't be
754 * called and further optimizations will be performed. It is okay to have
755 * this flag set and a background. Use with DRAW_MASK when calling setFlags.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800756 * {@hide}
757 */
758 static final int WILL_NOT_DRAW = 0x00000080;
759
760 /**
761 * Mask for use with setFlags indicating bits used for indicating whether
762 * this view is will draw
763 * {@hide}
764 */
765 static final int DRAW_MASK = 0x00000080;
766
767 /**
768 * <p>This view doesn't show scrollbars.</p>
769 * {@hide}
770 */
771 static final int SCROLLBARS_NONE = 0x00000000;
772
773 /**
774 * <p>This view shows horizontal scrollbars.</p>
775 * {@hide}
776 */
777 static final int SCROLLBARS_HORIZONTAL = 0x00000100;
778
779 /**
780 * <p>This view shows vertical scrollbars.</p>
781 * {@hide}
782 */
783 static final int SCROLLBARS_VERTICAL = 0x00000200;
784
785 /**
786 * <p>Mask for use with setFlags indicating bits used for indicating which
787 * scrollbars are enabled.</p>
788 * {@hide}
789 */
790 static final int SCROLLBARS_MASK = 0x00000300;
791
Jeff Brown85a31762010-09-01 17:01:00 -0700792 /**
793 * Indicates that the view should filter touches when its window is obscured.
794 * Refer to the class comments for more information about this security feature.
795 * {@hide}
796 */
797 static final int FILTER_TOUCHES_WHEN_OBSCURED = 0x00000400;
798
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -0700799 /**
800 * Set for framework elements that use FITS_SYSTEM_WINDOWS, to indicate
801 * that they are optional and should be skipped if the window has
802 * requested system UI flags that ignore those insets for layout.
803 */
804 static final int OPTIONAL_FITS_SYSTEM_WINDOWS = 0x00000800;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800805
806 /**
807 * <p>This view doesn't show fading edges.</p>
808 * {@hide}
809 */
810 static final int FADING_EDGE_NONE = 0x00000000;
811
812 /**
813 * <p>This view shows horizontal fading edges.</p>
814 * {@hide}
815 */
816 static final int FADING_EDGE_HORIZONTAL = 0x00001000;
817
818 /**
819 * <p>This view shows vertical fading edges.</p>
820 * {@hide}
821 */
822 static final int FADING_EDGE_VERTICAL = 0x00002000;
823
824 /**
825 * <p>Mask for use with setFlags indicating bits used for indicating which
826 * fading edges are enabled.</p>
827 * {@hide}
828 */
829 static final int FADING_EDGE_MASK = 0x00003000;
830
831 /**
832 * <p>Indicates this view can be clicked. When clickable, a View reacts
833 * to clicks by notifying the OnClickListener.<p>
834 * {@hide}
835 */
836 static final int CLICKABLE = 0x00004000;
837
838 /**
839 * <p>Indicates this view is caching its drawing into a bitmap.</p>
840 * {@hide}
841 */
842 static final int DRAWING_CACHE_ENABLED = 0x00008000;
843
844 /**
845 * <p>Indicates that no icicle should be saved for this view.<p>
846 * {@hide}
847 */
848 static final int SAVE_DISABLED = 0x000010000;
849
850 /**
851 * <p>Mask for use with setFlags indicating bits used for the saveEnabled
852 * property.</p>
853 * {@hide}
854 */
855 static final int SAVE_DISABLED_MASK = 0x000010000;
856
857 /**
858 * <p>Indicates that no drawing cache should ever be created for this view.<p>
859 * {@hide}
860 */
861 static final int WILL_NOT_CACHE_DRAWING = 0x000020000;
862
863 /**
864 * <p>Indicates this view can take / keep focus when int touch mode.</p>
865 * {@hide}
866 */
867 static final int FOCUSABLE_IN_TOUCH_MODE = 0x00040000;
868
869 /**
870 * <p>Enables low quality mode for the drawing cache.</p>
871 */
872 public static final int DRAWING_CACHE_QUALITY_LOW = 0x00080000;
873
874 /**
875 * <p>Enables high quality mode for the drawing cache.</p>
876 */
877 public static final int DRAWING_CACHE_QUALITY_HIGH = 0x00100000;
878
879 /**
880 * <p>Enables automatic quality mode for the drawing cache.</p>
881 */
882 public static final int DRAWING_CACHE_QUALITY_AUTO = 0x00000000;
883
884 private static final int[] DRAWING_CACHE_QUALITY_FLAGS = {
885 DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_LOW, DRAWING_CACHE_QUALITY_HIGH
886 };
887
888 /**
889 * <p>Mask for use with setFlags indicating bits used for the cache
890 * quality property.</p>
891 * {@hide}
892 */
893 static final int DRAWING_CACHE_QUALITY_MASK = 0x00180000;
894
895 /**
896 * <p>
897 * Indicates this view can be long clicked. When long clickable, a View
898 * reacts to long clicks by notifying the OnLongClickListener or showing a
899 * context menu.
900 * </p>
901 * {@hide}
902 */
903 static final int LONG_CLICKABLE = 0x00200000;
904
905 /**
906 * <p>Indicates that this view gets its drawable states from its direct parent
907 * and ignores its original internal states.</p>
908 *
909 * @hide
910 */
911 static final int DUPLICATE_PARENT_STATE = 0x00400000;
912
913 /**
914 * The scrollbar style to display the scrollbars inside the content area,
915 * without increasing the padding. The scrollbars will be overlaid with
916 * translucency on the view's content.
917 */
918 public static final int SCROLLBARS_INSIDE_OVERLAY = 0;
919
920 /**
921 * The scrollbar style to display the scrollbars inside the padded area,
922 * increasing the padding of the view. The scrollbars will not overlap the
923 * content area of the view.
924 */
925 public static final int SCROLLBARS_INSIDE_INSET = 0x01000000;
926
927 /**
928 * The scrollbar style to display the scrollbars at the edge of the view,
929 * without increasing the padding. The scrollbars will be overlaid with
930 * translucency.
931 */
932 public static final int SCROLLBARS_OUTSIDE_OVERLAY = 0x02000000;
933
934 /**
935 * The scrollbar style to display the scrollbars at the edge of the view,
936 * increasing the padding of the view. The scrollbars will only overlap the
937 * background, if any.
938 */
939 public static final int SCROLLBARS_OUTSIDE_INSET = 0x03000000;
940
941 /**
942 * Mask to check if the scrollbar style is overlay or inset.
943 * {@hide}
944 */
945 static final int SCROLLBARS_INSET_MASK = 0x01000000;
946
947 /**
948 * Mask to check if the scrollbar style is inside or outside.
949 * {@hide}
950 */
951 static final int SCROLLBARS_OUTSIDE_MASK = 0x02000000;
952
953 /**
954 * Mask for scrollbar style.
955 * {@hide}
956 */
957 static final int SCROLLBARS_STYLE_MASK = 0x03000000;
958
959 /**
960 * View flag indicating that the screen should remain on while the
961 * window containing this view is visible to the user. This effectively
962 * takes care of automatically setting the WindowManager's
963 * {@link WindowManager.LayoutParams#FLAG_KEEP_SCREEN_ON}.
964 */
965 public static final int KEEP_SCREEN_ON = 0x04000000;
966
967 /**
968 * View flag indicating whether this view should have sound effects enabled
969 * for events such as clicking and touching.
970 */
971 public static final int SOUND_EFFECTS_ENABLED = 0x08000000;
972
973 /**
974 * View flag indicating whether this view should have haptic feedback
975 * enabled for events such as long presses.
976 */
977 public static final int HAPTIC_FEEDBACK_ENABLED = 0x10000000;
978
979 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -0700980 * <p>Indicates that the view hierarchy should stop saving state when
981 * it reaches this view. If state saving is initiated immediately at
982 * the view, it will be allowed.
983 * {@hide}
984 */
985 static final int PARENT_SAVE_DISABLED = 0x20000000;
986
987 /**
988 * <p>Mask for use with setFlags indicating bits used for PARENT_SAVE_DISABLED.</p>
989 * {@hide}
990 */
991 static final int PARENT_SAVE_DISABLED_MASK = 0x20000000;
992
993 /**
svetoslavganov75986cf2009-05-14 22:28:01 -0700994 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
995 * should add all focusable Views regardless if they are focusable in touch mode.
996 */
997 public static final int FOCUSABLES_ALL = 0x00000000;
998
999 /**
1000 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
1001 * should add only Views focusable in touch mode.
1002 */
1003 public static final int FOCUSABLES_TOUCH_MODE = 0x00000001;
1004
1005 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07001006 * View flag indicating whether {@link #addFocusables(ArrayList, int, int)}
1007 * should add only accessibility focusable Views.
1008 *
1009 * @hide
1010 */
1011 public static final int FOCUSABLES_ACCESSIBILITY = 0x00000002;
1012
1013 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001014 * Use with {@link #focusSearch(int)}. Move focus to the previous selectable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001015 * item.
1016 */
1017 public static final int FOCUS_BACKWARD = 0x00000001;
1018
1019 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001020 * Use with {@link #focusSearch(int)}. Move focus to the next selectable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001021 * item.
1022 */
1023 public static final int FOCUS_FORWARD = 0x00000002;
1024
1025 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001026 * Use with {@link #focusSearch(int)}. Move focus to the left.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001027 */
1028 public static final int FOCUS_LEFT = 0x00000011;
1029
1030 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001031 * Use with {@link #focusSearch(int)}. Move focus up.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001032 */
1033 public static final int FOCUS_UP = 0x00000021;
1034
1035 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001036 * Use with {@link #focusSearch(int)}. Move focus to the right.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001037 */
1038 public static final int FOCUS_RIGHT = 0x00000042;
1039
1040 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07001041 * Use with {@link #focusSearch(int)}. Move focus down.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001042 */
1043 public static final int FOCUS_DOWN = 0x00000082;
1044
Svetoslav Ganov42138042012-03-20 11:51:39 -07001045 // Accessibility focus directions.
1046
1047 /**
1048 * The accessibility focus which is the current user position when
1049 * interacting with the accessibility framework.
1050 */
1051 public static final int FOCUS_ACCESSIBILITY = 0x00001000;
1052
1053 /**
1054 * Use with {@link #focusSearch(int)}. Move acessibility focus left.
1055 */
1056 public static final int ACCESSIBILITY_FOCUS_LEFT = FOCUS_LEFT | FOCUS_ACCESSIBILITY;
1057
1058 /**
1059 * Use with {@link #focusSearch(int)}. Move acessibility focus up.
1060 */
1061 public static final int ACCESSIBILITY_FOCUS_UP = FOCUS_UP | FOCUS_ACCESSIBILITY;
1062
1063 /**
1064 * Use with {@link #focusSearch(int)}. Move acessibility focus right.
1065 */
1066 public static final int ACCESSIBILITY_FOCUS_RIGHT = FOCUS_RIGHT | FOCUS_ACCESSIBILITY;
1067
1068 /**
1069 * Use with {@link #focusSearch(int)}. Move acessibility focus down.
1070 */
1071 public static final int ACCESSIBILITY_FOCUS_DOWN = FOCUS_DOWN | FOCUS_ACCESSIBILITY;
1072
1073 /**
Svetoslav Ganovd6e716d2012-04-20 18:36:11 -07001074 * Use with {@link #focusSearch(int)}. Move acessibility focus forward.
Svetoslav Ganov42138042012-03-20 11:51:39 -07001075 */
1076 public static final int ACCESSIBILITY_FOCUS_FORWARD = FOCUS_FORWARD | FOCUS_ACCESSIBILITY;
1077
1078 /**
Svetoslav Ganovd6e716d2012-04-20 18:36:11 -07001079 * Use with {@link #focusSearch(int)}. Move acessibility focus backward.
Svetoslav Ganov42138042012-03-20 11:51:39 -07001080 */
1081 public static final int ACCESSIBILITY_FOCUS_BACKWARD = FOCUS_BACKWARD | FOCUS_ACCESSIBILITY;
1082
1083 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08001084 * Bits of {@link #getMeasuredWidthAndState()} and
1085 * {@link #getMeasuredWidthAndState()} that provide the actual measured size.
1086 */
1087 public static final int MEASURED_SIZE_MASK = 0x00ffffff;
1088
1089 /**
1090 * Bits of {@link #getMeasuredWidthAndState()} and
1091 * {@link #getMeasuredWidthAndState()} that provide the additional state bits.
1092 */
1093 public static final int MEASURED_STATE_MASK = 0xff000000;
1094
1095 /**
1096 * Bit shift of {@link #MEASURED_STATE_MASK} to get to the height bits
1097 * for functions that combine both width and height into a single int,
1098 * such as {@link #getMeasuredState()} and the childState argument of
1099 * {@link #resolveSizeAndState(int, int, int)}.
1100 */
1101 public static final int MEASURED_HEIGHT_STATE_SHIFT = 16;
1102
1103 /**
1104 * Bit of {@link #getMeasuredWidthAndState()} and
1105 * {@link #getMeasuredWidthAndState()} that indicates the measured size
1106 * is smaller that the space the view would like to have.
1107 */
1108 public static final int MEASURED_STATE_TOO_SMALL = 0x01000000;
1109
1110 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001111 * Base View state sets
1112 */
1113 // Singles
1114 /**
1115 * Indicates the view has no states set. States are used with
1116 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1117 * view depending on its state.
1118 *
1119 * @see android.graphics.drawable.Drawable
1120 * @see #getDrawableState()
1121 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001122 protected static final int[] EMPTY_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001123 /**
1124 * Indicates the view is enabled. States are used with
1125 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1126 * view depending on its state.
1127 *
1128 * @see android.graphics.drawable.Drawable
1129 * @see #getDrawableState()
1130 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001131 protected static final int[] ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001132 /**
1133 * Indicates the view is focused. States are used with
1134 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1135 * view depending on its state.
1136 *
1137 * @see android.graphics.drawable.Drawable
1138 * @see #getDrawableState()
1139 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001140 protected static final int[] FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001141 /**
1142 * Indicates the view is selected. States are used with
1143 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1144 * view depending on its state.
1145 *
1146 * @see android.graphics.drawable.Drawable
1147 * @see #getDrawableState()
1148 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001149 protected static final int[] SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001150 /**
1151 * Indicates the view is pressed. States are used with
1152 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1153 * view depending on its state.
1154 *
1155 * @see android.graphics.drawable.Drawable
1156 * @see #getDrawableState()
1157 * @hide
1158 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001159 protected static final int[] PRESSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001160 /**
1161 * Indicates the view's window has focus. States are used with
1162 * {@link android.graphics.drawable.Drawable} to change the drawing of the
1163 * view depending on its state.
1164 *
1165 * @see android.graphics.drawable.Drawable
1166 * @see #getDrawableState()
1167 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001168 protected static final int[] WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001169 // Doubles
1170 /**
1171 * Indicates the view is enabled and has the focus.
1172 *
1173 * @see #ENABLED_STATE_SET
1174 * @see #FOCUSED_STATE_SET
1175 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001176 protected static final int[] ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001177 /**
1178 * Indicates the view is enabled and selected.
1179 *
1180 * @see #ENABLED_STATE_SET
1181 * @see #SELECTED_STATE_SET
1182 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001183 protected static final int[] ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001184 /**
1185 * Indicates the view is enabled and that its window has focus.
1186 *
1187 * @see #ENABLED_STATE_SET
1188 * @see #WINDOW_FOCUSED_STATE_SET
1189 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001190 protected static final int[] ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001191 /**
1192 * Indicates the view is focused and selected.
1193 *
1194 * @see #FOCUSED_STATE_SET
1195 * @see #SELECTED_STATE_SET
1196 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001197 protected static final int[] FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001198 /**
1199 * Indicates the view has the focus and that its window has the focus.
1200 *
1201 * @see #FOCUSED_STATE_SET
1202 * @see #WINDOW_FOCUSED_STATE_SET
1203 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001204 protected static final int[] FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001205 /**
1206 * Indicates the view is selected and that its window has the focus.
1207 *
1208 * @see #SELECTED_STATE_SET
1209 * @see #WINDOW_FOCUSED_STATE_SET
1210 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001211 protected static final int[] SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001212 // Triples
1213 /**
1214 * Indicates the view is enabled, focused and selected.
1215 *
1216 * @see #ENABLED_STATE_SET
1217 * @see #FOCUSED_STATE_SET
1218 * @see #SELECTED_STATE_SET
1219 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001220 protected static final int[] ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001221 /**
1222 * Indicates the view is enabled, focused and its window has the focus.
1223 *
1224 * @see #ENABLED_STATE_SET
1225 * @see #FOCUSED_STATE_SET
1226 * @see #WINDOW_FOCUSED_STATE_SET
1227 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001228 protected static final int[] ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001229 /**
1230 * Indicates the view is enabled, selected and its window has the focus.
1231 *
1232 * @see #ENABLED_STATE_SET
1233 * @see #SELECTED_STATE_SET
1234 * @see #WINDOW_FOCUSED_STATE_SET
1235 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001236 protected static final int[] ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001237 /**
1238 * Indicates the view is focused, selected and its window has the focus.
1239 *
1240 * @see #FOCUSED_STATE_SET
1241 * @see #SELECTED_STATE_SET
1242 * @see #WINDOW_FOCUSED_STATE_SET
1243 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001244 protected static final int[] FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001245 /**
1246 * Indicates the view is enabled, focused, selected and its window
1247 * has the focus.
1248 *
1249 * @see #ENABLED_STATE_SET
1250 * @see #FOCUSED_STATE_SET
1251 * @see #SELECTED_STATE_SET
1252 * @see #WINDOW_FOCUSED_STATE_SET
1253 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001254 protected static final int[] ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001255 /**
1256 * Indicates the view is pressed and its window has the focus.
1257 *
1258 * @see #PRESSED_STATE_SET
1259 * @see #WINDOW_FOCUSED_STATE_SET
1260 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001261 protected static final int[] PRESSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001262 /**
1263 * Indicates the view is pressed and selected.
1264 *
1265 * @see #PRESSED_STATE_SET
1266 * @see #SELECTED_STATE_SET
1267 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001268 protected static final int[] PRESSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001269 /**
1270 * Indicates the view is pressed, selected and its window has the focus.
1271 *
1272 * @see #PRESSED_STATE_SET
1273 * @see #SELECTED_STATE_SET
1274 * @see #WINDOW_FOCUSED_STATE_SET
1275 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001276 protected static final int[] PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001277 /**
1278 * Indicates the view is pressed and focused.
1279 *
1280 * @see #PRESSED_STATE_SET
1281 * @see #FOCUSED_STATE_SET
1282 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001283 protected static final int[] PRESSED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001284 /**
1285 * Indicates the view is pressed, focused and its window has the focus.
1286 *
1287 * @see #PRESSED_STATE_SET
1288 * @see #FOCUSED_STATE_SET
1289 * @see #WINDOW_FOCUSED_STATE_SET
1290 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001291 protected static final int[] PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001292 /**
1293 * Indicates the view is pressed, focused and selected.
1294 *
1295 * @see #PRESSED_STATE_SET
1296 * @see #SELECTED_STATE_SET
1297 * @see #FOCUSED_STATE_SET
1298 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001299 protected static final int[] PRESSED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001300 /**
1301 * Indicates the view is pressed, focused, selected and its window has the focus.
1302 *
1303 * @see #PRESSED_STATE_SET
1304 * @see #FOCUSED_STATE_SET
1305 * @see #SELECTED_STATE_SET
1306 * @see #WINDOW_FOCUSED_STATE_SET
1307 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001308 protected static final int[] PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001309 /**
1310 * Indicates the view is pressed and enabled.
1311 *
1312 * @see #PRESSED_STATE_SET
1313 * @see #ENABLED_STATE_SET
1314 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001315 protected static final int[] PRESSED_ENABLED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001316 /**
1317 * Indicates the view is pressed, enabled and its window has the focus.
1318 *
1319 * @see #PRESSED_STATE_SET
1320 * @see #ENABLED_STATE_SET
1321 * @see #WINDOW_FOCUSED_STATE_SET
1322 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001323 protected static final int[] PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001324 /**
1325 * Indicates the view is pressed, enabled and selected.
1326 *
1327 * @see #PRESSED_STATE_SET
1328 * @see #ENABLED_STATE_SET
1329 * @see #SELECTED_STATE_SET
1330 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001331 protected static final int[] PRESSED_ENABLED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001332 /**
1333 * Indicates the view is pressed, enabled, selected and its window has the
1334 * focus.
1335 *
1336 * @see #PRESSED_STATE_SET
1337 * @see #ENABLED_STATE_SET
1338 * @see #SELECTED_STATE_SET
1339 * @see #WINDOW_FOCUSED_STATE_SET
1340 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001341 protected static final int[] PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001342 /**
1343 * Indicates the view is pressed, enabled and focused.
1344 *
1345 * @see #PRESSED_STATE_SET
1346 * @see #ENABLED_STATE_SET
1347 * @see #FOCUSED_STATE_SET
1348 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001349 protected static final int[] PRESSED_ENABLED_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001350 /**
1351 * Indicates the view is pressed, enabled, focused and its window has the
1352 * focus.
1353 *
1354 * @see #PRESSED_STATE_SET
1355 * @see #ENABLED_STATE_SET
1356 * @see #FOCUSED_STATE_SET
1357 * @see #WINDOW_FOCUSED_STATE_SET
1358 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001359 protected static final int[] PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001360 /**
1361 * Indicates the view is pressed, enabled, focused and selected.
1362 *
1363 * @see #PRESSED_STATE_SET
1364 * @see #ENABLED_STATE_SET
1365 * @see #SELECTED_STATE_SET
1366 * @see #FOCUSED_STATE_SET
1367 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001368 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001369 /**
1370 * Indicates the view is pressed, enabled, focused, selected and its window
1371 * has the focus.
1372 *
1373 * @see #PRESSED_STATE_SET
1374 * @see #ENABLED_STATE_SET
1375 * @see #SELECTED_STATE_SET
1376 * @see #FOCUSED_STATE_SET
1377 * @see #WINDOW_FOCUSED_STATE_SET
1378 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001379 protected static final int[] PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001380
1381 /**
1382 * The order here is very important to {@link #getDrawableState()}
1383 */
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001384 private static final int[][] VIEW_STATE_SETS;
1385
Romain Guyb051e892010-09-28 19:09:36 -07001386 static final int VIEW_STATE_WINDOW_FOCUSED = 1;
1387 static final int VIEW_STATE_SELECTED = 1 << 1;
1388 static final int VIEW_STATE_FOCUSED = 1 << 2;
1389 static final int VIEW_STATE_ENABLED = 1 << 3;
1390 static final int VIEW_STATE_PRESSED = 1 << 4;
1391 static final int VIEW_STATE_ACTIVATED = 1 << 5;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001392 static final int VIEW_STATE_ACCELERATED = 1 << 6;
PY Laligandc33d8d49e2011-03-14 18:22:53 -07001393 static final int VIEW_STATE_HOVERED = 1 << 7;
Christopher Tate3d4bf172011-03-28 16:16:46 -07001394 static final int VIEW_STATE_DRAG_CAN_ACCEPT = 1 << 8;
1395 static final int VIEW_STATE_DRAG_HOVERED = 1 << 9;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001396
1397 static final int[] VIEW_STATE_IDS = new int[] {
1398 R.attr.state_window_focused, VIEW_STATE_WINDOW_FOCUSED,
1399 R.attr.state_selected, VIEW_STATE_SELECTED,
1400 R.attr.state_focused, VIEW_STATE_FOCUSED,
1401 R.attr.state_enabled, VIEW_STATE_ENABLED,
1402 R.attr.state_pressed, VIEW_STATE_PRESSED,
1403 R.attr.state_activated, VIEW_STATE_ACTIVATED,
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001404 R.attr.state_accelerated, VIEW_STATE_ACCELERATED,
PY Laligandc33d8d49e2011-03-14 18:22:53 -07001405 R.attr.state_hovered, VIEW_STATE_HOVERED,
Christopher Tate3d4bf172011-03-28 16:16:46 -07001406 R.attr.state_drag_can_accept, VIEW_STATE_DRAG_CAN_ACCEPT,
Svetoslav Ganov42138042012-03-20 11:51:39 -07001407 R.attr.state_drag_hovered, VIEW_STATE_DRAG_HOVERED
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001408 };
1409
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001410 static {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -08001411 if ((VIEW_STATE_IDS.length/2) != R.styleable.ViewDrawableStates.length) {
1412 throw new IllegalStateException(
1413 "VIEW_STATE_IDs array length does not match ViewDrawableStates style array");
1414 }
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001415 int[] orderedIds = new int[VIEW_STATE_IDS.length];
Romain Guyb051e892010-09-28 19:09:36 -07001416 for (int i = 0; i < R.styleable.ViewDrawableStates.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001417 int viewState = R.styleable.ViewDrawableStates[i];
Romain Guyb051e892010-09-28 19:09:36 -07001418 for (int j = 0; j<VIEW_STATE_IDS.length; j += 2) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001419 if (VIEW_STATE_IDS[j] == viewState) {
Romain Guyb051e892010-09-28 19:09:36 -07001420 orderedIds[i * 2] = viewState;
1421 orderedIds[i * 2 + 1] = VIEW_STATE_IDS[j + 1];
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001422 }
1423 }
1424 }
Romain Guyb051e892010-09-28 19:09:36 -07001425 final int NUM_BITS = VIEW_STATE_IDS.length / 2;
1426 VIEW_STATE_SETS = new int[1 << NUM_BITS][];
1427 for (int i = 0; i < VIEW_STATE_SETS.length; i++) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001428 int numBits = Integer.bitCount(i);
1429 int[] set = new int[numBits];
1430 int pos = 0;
Romain Guyb051e892010-09-28 19:09:36 -07001431 for (int j = 0; j < orderedIds.length; j += 2) {
1432 if ((i & orderedIds[j+1]) != 0) {
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001433 set[pos++] = orderedIds[j];
1434 }
1435 }
1436 VIEW_STATE_SETS[i] = set;
1437 }
1438
1439 EMPTY_STATE_SET = VIEW_STATE_SETS[0];
1440 WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_WINDOW_FOCUSED];
1441 SELECTED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_SELECTED];
1442 SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1443 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED];
1444 FOCUSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_FOCUSED];
1445 FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1446 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED];
1447 FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1448 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED];
1449 FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1450 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1451 | VIEW_STATE_FOCUSED];
1452 ENABLED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_ENABLED];
1453 ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1454 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED];
1455 ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1456 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED];
1457 ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1458 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1459 | VIEW_STATE_ENABLED];
1460 ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1461 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED];
1462 ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1463 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1464 | VIEW_STATE_ENABLED];
1465 ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1466 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1467 | VIEW_STATE_ENABLED];
1468 ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1469 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1470 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED];
1471
1472 PRESSED_STATE_SET = VIEW_STATE_SETS[VIEW_STATE_PRESSED];
1473 PRESSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1474 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_PRESSED];
1475 PRESSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1476 VIEW_STATE_SELECTED | VIEW_STATE_PRESSED];
1477 PRESSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1478 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1479 | VIEW_STATE_PRESSED];
1480 PRESSED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1481 VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1482 PRESSED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1483 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1484 | VIEW_STATE_PRESSED];
1485 PRESSED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1486 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1487 | VIEW_STATE_PRESSED];
1488 PRESSED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1489 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1490 | VIEW_STATE_FOCUSED | VIEW_STATE_PRESSED];
1491 PRESSED_ENABLED_STATE_SET = VIEW_STATE_SETS[
1492 VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1493 PRESSED_ENABLED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1494 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_ENABLED
1495 | VIEW_STATE_PRESSED];
1496 PRESSED_ENABLED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1497 VIEW_STATE_SELECTED | VIEW_STATE_ENABLED
1498 | VIEW_STATE_PRESSED];
1499 PRESSED_ENABLED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1500 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1501 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1502 PRESSED_ENABLED_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1503 VIEW_STATE_FOCUSED | VIEW_STATE_ENABLED
1504 | VIEW_STATE_PRESSED];
1505 PRESSED_ENABLED_FOCUSED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1506 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_FOCUSED
1507 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1508 PRESSED_ENABLED_FOCUSED_SELECTED_STATE_SET = VIEW_STATE_SETS[
1509 VIEW_STATE_SELECTED | VIEW_STATE_FOCUSED
1510 | VIEW_STATE_ENABLED | VIEW_STATE_PRESSED];
1511 PRESSED_ENABLED_FOCUSED_SELECTED_WINDOW_FOCUSED_STATE_SET = VIEW_STATE_SETS[
1512 VIEW_STATE_WINDOW_FOCUSED | VIEW_STATE_SELECTED
1513 | VIEW_STATE_FOCUSED| VIEW_STATE_ENABLED
1514 | VIEW_STATE_PRESSED];
1515 }
1516
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001517 /**
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07001518 * Accessibility event types that are dispatched for text population.
1519 */
1520 private static final int POPULATING_ACCESSIBILITY_EVENT_TYPES =
1521 AccessibilityEvent.TYPE_VIEW_CLICKED
1522 | AccessibilityEvent.TYPE_VIEW_LONG_CLICKED
1523 | AccessibilityEvent.TYPE_VIEW_SELECTED
1524 | AccessibilityEvent.TYPE_VIEW_FOCUSED
1525 | AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED
1526 | AccessibilityEvent.TYPE_VIEW_HOVER_ENTER
Svetoslav Ganov9920f4f2011-10-07 18:39:11 -07001527 | AccessibilityEvent.TYPE_VIEW_HOVER_EXIT
Svetoslav Ganov84dd52e2011-11-18 10:24:00 -08001528 | AccessibilityEvent.TYPE_VIEW_TEXT_CHANGED
Svetoslav Ganov42138042012-03-20 11:51:39 -07001529 | AccessibilityEvent.TYPE_VIEW_TEXT_SELECTION_CHANGED
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07001530 | AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED
1531 | AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY;
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07001532
1533 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001534 * Temporary Rect currently for use in setBackground(). This will probably
1535 * be extended in the future to hold our own class with more than just
1536 * a Rect. :)
1537 */
1538 static final ThreadLocal<Rect> sThreadLocal = new ThreadLocal<Rect>();
Romain Guyd90a3312009-05-06 14:54:28 -07001539
1540 /**
1541 * Map used to store views' tags.
1542 */
Adam Powell7db82ac2011-09-22 19:44:04 -07001543 private SparseArray<Object> mKeyedTags;
Romain Guyd90a3312009-05-06 14:54:28 -07001544
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001545 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07001546 * The next available accessiiblity id.
1547 */
1548 private static int sNextAccessibilityViewId;
1549
1550 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001551 * The animation currently associated with this view.
1552 * @hide
1553 */
1554 protected Animation mCurrentAnimation = null;
1555
1556 /**
1557 * Width as measured during measure pass.
1558 * {@hide}
1559 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001560 @ViewDebug.ExportedProperty(category = "measurement")
Romain Guy676b1732011-02-14 14:45:33 -08001561 int mMeasuredWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001562
1563 /**
1564 * Height as measured during measure pass.
1565 * {@hide}
1566 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07001567 @ViewDebug.ExportedProperty(category = "measurement")
Romain Guy676b1732011-02-14 14:45:33 -08001568 int mMeasuredHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001569
1570 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001571 * Flag to indicate that this view was marked INVALIDATED, or had its display list
1572 * invalidated, prior to the current drawing iteration. If true, the view must re-draw
1573 * its display list. This flag, used only when hw accelerated, allows us to clear the
1574 * flag while retaining this information until it's needed (at getDisplayList() time and
1575 * in drawChild(), when we decide to draw a view's children's display lists into our own).
1576 *
1577 * {@hide}
1578 */
1579 boolean mRecreateDisplayList = false;
1580
1581 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001582 * The view's identifier.
1583 * {@hide}
1584 *
1585 * @see #setId(int)
1586 * @see #getId()
1587 */
1588 @ViewDebug.ExportedProperty(resolveId = true)
1589 int mID = NO_ID;
1590
1591 /**
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07001592 * The stable ID of this view for accessibility purposes.
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07001593 */
1594 int mAccessibilityViewId = NO_ID;
1595
1596 /**
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07001597 * @hide
1598 */
1599 private int mAccessibilityCursorPosition = -1;
1600
1601 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001602 * The view's tag.
1603 * {@hide}
1604 *
1605 * @see #setTag(Object)
1606 * @see #getTag()
1607 */
1608 protected Object mTag;
1609
1610 // for mPrivateFlags:
1611 /** {@hide} */
1612 static final int WANTS_FOCUS = 0x00000001;
1613 /** {@hide} */
1614 static final int FOCUSED = 0x00000002;
1615 /** {@hide} */
1616 static final int SELECTED = 0x00000004;
1617 /** {@hide} */
1618 static final int IS_ROOT_NAMESPACE = 0x00000008;
1619 /** {@hide} */
1620 static final int HAS_BOUNDS = 0x00000010;
1621 /** {@hide} */
1622 static final int DRAWN = 0x00000020;
1623 /**
1624 * When this flag is set, this view is running an animation on behalf of its
1625 * children and should therefore not cancel invalidate requests, even if they
1626 * lie outside of this view's bounds.
1627 *
1628 * {@hide}
1629 */
1630 static final int DRAW_ANIMATION = 0x00000040;
1631 /** {@hide} */
1632 static final int SKIP_DRAW = 0x00000080;
1633 /** {@hide} */
1634 static final int ONLY_DRAWS_BACKGROUND = 0x00000100;
1635 /** {@hide} */
1636 static final int REQUEST_TRANSPARENT_REGIONS = 0x00000200;
1637 /** {@hide} */
1638 static final int DRAWABLE_STATE_DIRTY = 0x00000400;
1639 /** {@hide} */
1640 static final int MEASURED_DIMENSION_SET = 0x00000800;
1641 /** {@hide} */
1642 static final int FORCE_LAYOUT = 0x00001000;
Konstantin Lopyrevc6dc4572010-08-06 15:01:52 -07001643 /** {@hide} */
1644 static final int LAYOUT_REQUIRED = 0x00002000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001645
1646 private static final int PRESSED = 0x00004000;
1647
1648 /** {@hide} */
1649 static final int DRAWING_CACHE_VALID = 0x00008000;
1650 /**
1651 * Flag used to indicate that this view should be drawn once more (and only once
1652 * more) after its animation has completed.
1653 * {@hide}
1654 */
1655 static final int ANIMATION_STARTED = 0x00010000;
1656
1657 private static final int SAVE_STATE_CALLED = 0x00020000;
1658
1659 /**
1660 * Indicates that the View returned true when onSetAlpha() was called and that
1661 * the alpha must be restored.
1662 * {@hide}
1663 */
1664 static final int ALPHA_SET = 0x00040000;
1665
1666 /**
1667 * Set by {@link #setScrollContainer(boolean)}.
1668 */
1669 static final int SCROLL_CONTAINER = 0x00080000;
1670
1671 /**
1672 * Set by {@link #setScrollContainer(boolean)}.
1673 */
1674 static final int SCROLL_CONTAINER_ADDED = 0x00100000;
1675
1676 /**
Romain Guy809a7f62009-05-14 15:44:42 -07001677 * View flag indicating whether this view was invalidated (fully or partially.)
1678 *
1679 * @hide
1680 */
1681 static final int DIRTY = 0x00200000;
1682
1683 /**
1684 * View flag indicating whether this view was invalidated by an opaque
1685 * invalidate request.
1686 *
1687 * @hide
1688 */
1689 static final int DIRTY_OPAQUE = 0x00400000;
1690
1691 /**
1692 * Mask for {@link #DIRTY} and {@link #DIRTY_OPAQUE}.
1693 *
1694 * @hide
1695 */
1696 static final int DIRTY_MASK = 0x00600000;
1697
1698 /**
Romain Guy8f1344f52009-05-15 16:03:59 -07001699 * Indicates whether the background is opaque.
1700 *
1701 * @hide
1702 */
1703 static final int OPAQUE_BACKGROUND = 0x00800000;
1704
1705 /**
1706 * Indicates whether the scrollbars are opaque.
1707 *
1708 * @hide
1709 */
1710 static final int OPAQUE_SCROLLBARS = 0x01000000;
1711
1712 /**
1713 * Indicates whether the view is opaque.
1714 *
1715 * @hide
1716 */
1717 static final int OPAQUE_MASK = 0x01800000;
Joe Malin32736f02011-01-19 16:14:20 -08001718
Adam Powelle14579b2009-12-16 18:39:52 -08001719 /**
1720 * Indicates a prepressed state;
1721 * the short time between ACTION_DOWN and recognizing
1722 * a 'real' press. Prepressed is used to recognize quick taps
1723 * even when they are shorter than ViewConfiguration.getTapTimeout().
Joe Malin32736f02011-01-19 16:14:20 -08001724 *
Adam Powelle14579b2009-12-16 18:39:52 -08001725 * @hide
1726 */
1727 private static final int PREPRESSED = 0x02000000;
Joe Malin32736f02011-01-19 16:14:20 -08001728
Adam Powellc9fbaab2010-02-16 17:16:19 -08001729 /**
Romain Guy8afa5152010-02-26 11:56:30 -08001730 * Indicates whether the view is temporarily detached.
1731 *
1732 * @hide
1733 */
1734 static final int CANCEL_NEXT_UP_EVENT = 0x04000000;
Joe Malin32736f02011-01-19 16:14:20 -08001735
Adam Powell8568c3a2010-04-19 14:26:11 -07001736 /**
1737 * Indicates that we should awaken scroll bars once attached
Joe Malin32736f02011-01-19 16:14:20 -08001738 *
Adam Powell8568c3a2010-04-19 14:26:11 -07001739 * @hide
1740 */
1741 private static final int AWAKEN_SCROLL_BARS_ON_ATTACH = 0x08000000;
Romain Guy8f1344f52009-05-15 16:03:59 -07001742
1743 /**
Jeff Browna032cc02011-03-07 16:56:21 -08001744 * Indicates that the view has received HOVER_ENTER. Cleared on HOVER_EXIT.
1745 * @hide
1746 */
1747 private static final int HOVERED = 0x10000000;
1748
1749 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07001750 * Indicates that pivotX or pivotY were explicitly set and we should not assume the center
1751 * for transform operations
1752 *
1753 * @hide
1754 */
Adam Powellf37df072010-09-17 16:22:49 -07001755 private static final int PIVOT_EXPLICITLY_SET = 0x20000000;
Chet Haasefd2b0022010-08-06 13:08:56 -07001756
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001757 /** {@hide} */
Adam Powellf37df072010-09-17 16:22:49 -07001758 static final int ACTIVATED = 0x40000000;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -07001759
Chet Haasefd2b0022010-08-06 13:08:56 -07001760 /**
Chet Haasedaf98e92011-01-10 14:10:36 -08001761 * Indicates that this view was specifically invalidated, not just dirtied because some
1762 * child view was invalidated. The flag is used to determine when we need to recreate
1763 * a view's display list (as opposed to just returning a reference to its existing
1764 * display list).
1765 *
1766 * @hide
1767 */
1768 static final int INVALIDATED = 0x80000000;
1769
Christopher Tate3d4bf172011-03-28 16:16:46 -07001770 /* Masks for mPrivateFlags2 */
1771
1772 /**
1773 * Indicates that this view has reported that it can accept the current drag's content.
1774 * Cleared when the drag operation concludes.
1775 * @hide
1776 */
1777 static final int DRAG_CAN_ACCEPT = 0x00000001;
1778
1779 /**
1780 * Indicates that this view is currently directly under the drag location in a
1781 * drag-and-drop operation involving content that it can accept. Cleared when
1782 * the drag exits the view, or when the drag operation concludes.
1783 * @hide
1784 */
1785 static final int DRAG_HOVERED = 0x00000002;
1786
Cibu Johny86666632010-02-22 13:01:02 -08001787 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001788 * Horizontal layout direction of this view is from Left to Right.
1789 * Use with {@link #setLayoutDirection}.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001790 * @hide
Cibu Johny86666632010-02-22 13:01:02 -08001791 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001792 public static final int LAYOUT_DIRECTION_LTR = 0;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07001793
1794 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001795 * Horizontal layout direction of this view is from Right to Left.
1796 * Use with {@link #setLayoutDirection}.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001797 * @hide
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001798 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001799 public static final int LAYOUT_DIRECTION_RTL = 1;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001800
1801 /**
1802 * Horizontal layout direction of this view is inherited from its parent.
1803 * Use with {@link #setLayoutDirection}.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001804 * @hide
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001805 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001806 public static final int LAYOUT_DIRECTION_INHERIT = 2;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001807
1808 /**
1809 * Horizontal layout direction of this view is from deduced from the default language
1810 * script for the locale. Use with {@link #setLayoutDirection}.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001811 * @hide
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001812 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001813 public static final int LAYOUT_DIRECTION_LOCALE = 3;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001814
1815 /**
1816 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED)
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07001817 * @hide
1818 */
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001819 static final int LAYOUT_DIRECTION_MASK_SHIFT = 2;
1820
1821 /**
1822 * Mask for use with private flags indicating bits used for horizontal layout direction.
1823 * @hide
1824 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001825 static final int LAYOUT_DIRECTION_MASK = 0x00000003 << LAYOUT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001826
1827 /**
1828 * Indicates whether the view horizontal layout direction has been resolved and drawn to the
1829 * right-to-left direction.
1830 * @hide
1831 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001832 static final int LAYOUT_DIRECTION_RESOLVED_RTL = 4 << LAYOUT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001833
1834 /**
1835 * Indicates whether the view horizontal layout direction has been resolved.
1836 * @hide
1837 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001838 static final int LAYOUT_DIRECTION_RESOLVED = 8 << LAYOUT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001839
1840 /**
1841 * Mask for use with private flags indicating bits used for resolved horizontal layout direction.
1842 * @hide
1843 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001844 static final int LAYOUT_DIRECTION_RESOLVED_MASK = 0x0000000C << LAYOUT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001845
1846 /*
1847 * Array of horizontal layout direction flags for mapping attribute "layoutDirection" to correct
1848 * flag value.
1849 * @hide
1850 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001851 private static final int[] LAYOUT_DIRECTION_FLAGS = {
1852 LAYOUT_DIRECTION_LTR,
1853 LAYOUT_DIRECTION_RTL,
1854 LAYOUT_DIRECTION_INHERIT,
1855 LAYOUT_DIRECTION_LOCALE
1856 };
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001857
1858 /**
1859 * Default horizontal layout direction.
1860 * @hide
1861 */
1862 private static final int LAYOUT_DIRECTION_DEFAULT = LAYOUT_DIRECTION_INHERIT;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07001863
Adam Powell539ee872012-02-03 19:00:49 -08001864 /**
1865 * Indicates that the view is tracking some sort of transient state
1866 * that the app should not need to be aware of, but that the framework
1867 * should take special care to preserve.
1868 *
1869 * @hide
1870 */
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07001871 static final int HAS_TRANSIENT_STATE = 0x00000100;
Adam Powell539ee872012-02-03 19:00:49 -08001872
1873
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001874 /**
1875 * Text direction is inherited thru {@link ViewGroup}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001876 * @hide
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001877 */
1878 public static final int TEXT_DIRECTION_INHERIT = 0;
1879
1880 /**
1881 * Text direction is using "first strong algorithm". The first strong directional character
1882 * determines the paragraph direction. If there is no strong directional character, the
1883 * paragraph direction is the view's resolved layout direction.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001884 * @hide
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001885 */
1886 public static final int TEXT_DIRECTION_FIRST_STRONG = 1;
1887
1888 /**
1889 * Text direction is using "any-RTL" algorithm. The paragraph direction is RTL if it contains
1890 * any strong RTL character, otherwise it is LTR if it contains any strong LTR characters.
1891 * If there are neither, the paragraph direction is the view's resolved layout direction.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001892 * @hide
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001893 */
1894 public static final int TEXT_DIRECTION_ANY_RTL = 2;
1895
1896 /**
1897 * Text direction is forced to LTR.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001898 * @hide
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001899 */
1900 public static final int TEXT_DIRECTION_LTR = 3;
1901
1902 /**
1903 * Text direction is forced to RTL.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001904 * @hide
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001905 */
1906 public static final int TEXT_DIRECTION_RTL = 4;
1907
1908 /**
1909 * Text direction is coming from the system Locale.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001910 * @hide
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001911 */
1912 public static final int TEXT_DIRECTION_LOCALE = 5;
1913
1914 /**
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001915 * Default text direction is inherited
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001916 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001917 */
1918 protected static int TEXT_DIRECTION_DEFAULT = TEXT_DIRECTION_INHERIT;
1919
1920 /**
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001921 * Bit shift to get the horizontal layout direction. (bits after LAYOUT_DIRECTION_RESOLVED)
1922 * @hide
1923 */
1924 static final int TEXT_DIRECTION_MASK_SHIFT = 6;
1925
1926 /**
Fabrice Di Megliob934db72012-03-20 14:33:01 -07001927 * Mask for use with private flags indicating bits used for text direction.
1928 * @hide
1929 */
1930 static final int TEXT_DIRECTION_MASK = 0x00000007 << TEXT_DIRECTION_MASK_SHIFT;
1931
1932 /**
1933 * Array of text direction flags for mapping attribute "textDirection" to correct
1934 * flag value.
1935 * @hide
1936 */
1937 private static final int[] TEXT_DIRECTION_FLAGS = {
1938 TEXT_DIRECTION_INHERIT << TEXT_DIRECTION_MASK_SHIFT,
1939 TEXT_DIRECTION_FIRST_STRONG << TEXT_DIRECTION_MASK_SHIFT,
1940 TEXT_DIRECTION_ANY_RTL << TEXT_DIRECTION_MASK_SHIFT,
1941 TEXT_DIRECTION_LTR << TEXT_DIRECTION_MASK_SHIFT,
1942 TEXT_DIRECTION_RTL << TEXT_DIRECTION_MASK_SHIFT,
1943 TEXT_DIRECTION_LOCALE << TEXT_DIRECTION_MASK_SHIFT
1944 };
1945
1946 /**
1947 * Indicates whether the view text direction has been resolved.
1948 * @hide
1949 */
1950 static final int TEXT_DIRECTION_RESOLVED = 0x00000008 << TEXT_DIRECTION_MASK_SHIFT;
1951
1952 /**
1953 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED)
1954 * @hide
1955 */
1956 static final int TEXT_DIRECTION_RESOLVED_MASK_SHIFT = 10;
1957
1958 /**
1959 * Mask for use with private flags indicating bits used for resolved text direction.
1960 * @hide
1961 */
1962 static final int TEXT_DIRECTION_RESOLVED_MASK = 0x00000007 << TEXT_DIRECTION_RESOLVED_MASK_SHIFT;
1963
1964 /**
1965 * Indicates whether the view text direction has been resolved to the "first strong" heuristic.
1966 * @hide
1967 */
1968 static final int TEXT_DIRECTION_RESOLVED_DEFAULT =
1969 TEXT_DIRECTION_FIRST_STRONG << TEXT_DIRECTION_RESOLVED_MASK_SHIFT;
1970
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001971 /*
1972 * Default text alignment. The text alignment of this View is inherited from its parent.
1973 * Use with {@link #setTextAlignment(int)}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001974 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001975 */
1976 public static final int TEXT_ALIGNMENT_INHERIT = 0;
1977
1978 /**
1979 * Default for the root view. The gravity determines the text alignment, ALIGN_NORMAL,
1980 * ALIGN_CENTER, or ALIGN_OPPOSITE, which are relative to each paragraph’s text direction.
1981 *
1982 * Use with {@link #setTextAlignment(int)}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001983 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001984 */
1985 public static final int TEXT_ALIGNMENT_GRAVITY = 1;
1986
1987 /**
1988 * Align to the start of the paragraph, e.g. ALIGN_NORMAL.
1989 *
1990 * Use with {@link #setTextAlignment(int)}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001991 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07001992 */
1993 public static final int TEXT_ALIGNMENT_TEXT_START = 2;
1994
1995 /**
1996 * Align to the end of the paragraph, e.g. ALIGN_OPPOSITE.
1997 *
1998 * Use with {@link #setTextAlignment(int)}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07001999 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07002000 */
2001 public static final int TEXT_ALIGNMENT_TEXT_END = 3;
2002
2003 /**
2004 * Center the paragraph, e.g. ALIGN_CENTER.
2005 *
2006 * Use with {@link #setTextAlignment(int)}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07002007 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07002008 */
2009 public static final int TEXT_ALIGNMENT_CENTER = 4;
2010
2011 /**
2012 * Align to the start of the view, which is ALIGN_LEFT if the view’s resolved
2013 * layoutDirection is LTR, and ALIGN_RIGHT otherwise.
2014 *
2015 * Use with {@link #setTextAlignment(int)}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07002016 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07002017 */
2018 public static final int TEXT_ALIGNMENT_VIEW_START = 5;
2019
2020 /**
2021 * Align to the end of the view, which is ALIGN_RIGHT if the view’s resolved
2022 * layoutDirection is LTR, and ALIGN_LEFT otherwise.
2023 *
2024 * Use with {@link #setTextAlignment(int)}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07002025 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07002026 */
2027 public static final int TEXT_ALIGNMENT_VIEW_END = 6;
2028
2029 /**
2030 * Default text alignment is inherited
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07002031 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07002032 */
2033 protected static int TEXT_ALIGNMENT_DEFAULT = TEXT_ALIGNMENT_GRAVITY;
2034
2035 /**
2036 * Bit shift to get the horizontal layout direction. (bits after DRAG_HOVERED)
2037 * @hide
2038 */
2039 static final int TEXT_ALIGNMENT_MASK_SHIFT = 13;
2040
2041 /**
2042 * Mask for use with private flags indicating bits used for text alignment.
2043 * @hide
2044 */
2045 static final int TEXT_ALIGNMENT_MASK = 0x00000007 << TEXT_ALIGNMENT_MASK_SHIFT;
2046
2047 /**
2048 * Array of text direction flags for mapping attribute "textAlignment" to correct
2049 * flag value.
2050 * @hide
2051 */
2052 private static final int[] TEXT_ALIGNMENT_FLAGS = {
2053 TEXT_ALIGNMENT_INHERIT << TEXT_ALIGNMENT_MASK_SHIFT,
2054 TEXT_ALIGNMENT_GRAVITY << TEXT_ALIGNMENT_MASK_SHIFT,
2055 TEXT_ALIGNMENT_TEXT_START << TEXT_ALIGNMENT_MASK_SHIFT,
2056 TEXT_ALIGNMENT_TEXT_END << TEXT_ALIGNMENT_MASK_SHIFT,
2057 TEXT_ALIGNMENT_CENTER << TEXT_ALIGNMENT_MASK_SHIFT,
2058 TEXT_ALIGNMENT_VIEW_START << TEXT_ALIGNMENT_MASK_SHIFT,
2059 TEXT_ALIGNMENT_VIEW_END << TEXT_ALIGNMENT_MASK_SHIFT
2060 };
2061
2062 /**
2063 * Indicates whether the view text alignment has been resolved.
2064 * @hide
2065 */
2066 static final int TEXT_ALIGNMENT_RESOLVED = 0x00000008 << TEXT_ALIGNMENT_MASK_SHIFT;
2067
2068 /**
2069 * Bit shift to get the resolved text alignment.
2070 * @hide
2071 */
2072 static final int TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT = 17;
2073
2074 /**
2075 * Mask for use with private flags indicating bits used for text alignment.
2076 * @hide
2077 */
2078 static final int TEXT_ALIGNMENT_RESOLVED_MASK = 0x00000007 << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT;
2079
2080 /**
2081 * Indicates whether if the view text alignment has been resolved to gravity
2082 */
2083 public static final int TEXT_ALIGNMENT_RESOLVED_DEFAULT =
2084 TEXT_ALIGNMENT_GRAVITY << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT;
2085
Svetoslav Ganov42138042012-03-20 11:51:39 -07002086 // Accessiblity constants for mPrivateFlags2
2087
2088 /**
2089 * Shift for accessibility related bits in {@link #mPrivateFlags2}.
2090 */
2091 static final int IMPORTANT_FOR_ACCESSIBILITY_SHIFT = 20;
2092
2093 /**
2094 * Automatically determine whether a view is important for accessibility.
2095 */
2096 public static final int IMPORTANT_FOR_ACCESSIBILITY_AUTO = 0x00000000;
2097
2098 /**
2099 * The view is important for accessibility.
2100 */
2101 public static final int IMPORTANT_FOR_ACCESSIBILITY_YES = 0x00000001;
2102
2103 /**
2104 * The view is not important for accessibility.
2105 */
2106 public static final int IMPORTANT_FOR_ACCESSIBILITY_NO = 0x00000002;
2107
2108 /**
2109 * The default whether the view is important for accessiblity.
2110 */
2111 static final int IMPORTANT_FOR_ACCESSIBILITY_DEFAULT = IMPORTANT_FOR_ACCESSIBILITY_AUTO;
2112
2113 /**
2114 * Mask for obtainig the bits which specify how to determine
2115 * whether a view is important for accessibility.
2116 */
2117 static final int IMPORTANT_FOR_ACCESSIBILITY_MASK = (IMPORTANT_FOR_ACCESSIBILITY_AUTO
2118 | IMPORTANT_FOR_ACCESSIBILITY_YES | IMPORTANT_FOR_ACCESSIBILITY_NO)
2119 << IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
2120
2121 /**
2122 * Flag indicating whether a view has accessibility focus.
2123 */
2124 static final int ACCESSIBILITY_FOCUSED = 0x00000040 << IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
2125
2126 /**
2127 * Flag indicating whether a view state for accessibility has changed.
2128 */
2129 static final int ACCESSIBILITY_STATE_CHANGED = 0x00000080 << IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07002130
Christopher Tate3d4bf172011-03-28 16:16:46 -07002131 /* End of masks for mPrivateFlags2 */
2132
2133 static final int DRAG_MASK = DRAG_CAN_ACCEPT | DRAG_HOVERED;
2134
Chet Haasedaf98e92011-01-10 14:10:36 -08002135 /**
Adam Powell637d3372010-08-25 14:37:03 -07002136 * Always allow a user to over-scroll this view, provided it is a
2137 * view that can scroll.
2138 *
2139 * @see #getOverScrollMode()
2140 * @see #setOverScrollMode(int)
2141 */
2142 public static final int OVER_SCROLL_ALWAYS = 0;
2143
2144 /**
2145 * Allow a user to over-scroll this view only if the content is large
2146 * enough to meaningfully scroll, provided it is a view that can scroll.
2147 *
2148 * @see #getOverScrollMode()
2149 * @see #setOverScrollMode(int)
2150 */
2151 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1;
2152
2153 /**
2154 * Never allow a user to over-scroll this view.
2155 *
2156 * @see #getOverScrollMode()
2157 * @see #setOverScrollMode(int)
2158 */
2159 public static final int OVER_SCROLL_NEVER = 2;
2160
2161 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002162 * Special constant for {@link #setSystemUiVisibility(int)}: View has
2163 * requested the system UI (status bar) to be visible (the default).
Joe Onorato664644d2011-01-23 17:53:23 -08002164 *
Joe Malin32736f02011-01-19 16:14:20 -08002165 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08002166 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002167 public static final int SYSTEM_UI_FLAG_VISIBLE = 0;
Joe Onorato664644d2011-01-23 17:53:23 -08002168
2169 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002170 * Flag for {@link #setSystemUiVisibility(int)}: View has requested the
2171 * system UI to enter an unobtrusive "low profile" mode.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002172 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002173 * <p>This is for use in games, book readers, video players, or any other
Philip Milne6c8ea062012-04-03 17:38:43 -07002174 * "immersive" application where the usual system chrome is deemed too distracting.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002175 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002176 * <p>In low profile mode, the status bar and/or navigation icons may dim.
Joe Onorato664644d2011-01-23 17:53:23 -08002177 *
Joe Malin32736f02011-01-19 16:14:20 -08002178 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08002179 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002180 public static final int SYSTEM_UI_FLAG_LOW_PROFILE = 0x00000001;
2181
2182 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002183 * Flag for {@link #setSystemUiVisibility(int)}: View has requested that the
2184 * system navigation be temporarily hidden.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002185 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002186 * <p>This is an even less obtrusive state than that called for by
Daniel Sandler60ee2562011-07-22 12:34:33 -04002187 * {@link #SYSTEM_UI_FLAG_LOW_PROFILE}; on devices that draw essential navigation controls
2188 * (Home, Back, and the like) on screen, <code>SYSTEM_UI_FLAG_HIDE_NAVIGATION</code> will cause
2189 * those to disappear. This is useful (in conjunction with the
Philip Milne6c8ea062012-04-03 17:38:43 -07002190 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN FLAG_FULLSCREEN} and
Daniel Sandler60ee2562011-07-22 12:34:33 -04002191 * {@link android.view.WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN FLAG_LAYOUT_IN_SCREEN}
2192 * window flags) for displaying content using every last pixel on the display.
2193 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002194 * <p>There is a limitation: because navigation controls are so important, the least user
2195 * interaction will cause them to reappear immediately. When this happens, both
2196 * this flag and {@link #SYSTEM_UI_FLAG_FULLSCREEN} will be cleared automatically,
2197 * so that both elements reappear at the same time.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002198 *
2199 * @see #setSystemUiVisibility(int)
2200 */
2201 public static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 0x00000002;
2202
2203 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002204 * Flag for {@link #setSystemUiVisibility(int)}: View has requested to go
2205 * into the normal fullscreen mode so that its content can take over the screen
2206 * while still allowing the user to interact with the application.
2207 *
2208 * <p>This has the same visual effect as
2209 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN
2210 * WindowManager.LayoutParams.FLAG_FULLSCREEN},
2211 * meaning that non-critical screen decorations (such as the status bar) will be
2212 * hidden while the user is in the View's window, focusing the experience on
2213 * that content. Unlike the window flag, if you are using ActionBar in
2214 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY
2215 * Window.FEATURE_ACTION_BAR_OVERLAY}, then enabling this flag will also
2216 * hide the action bar.
2217 *
2218 * <p>This approach to going fullscreen is best used over the window flag when
2219 * it is a transient state -- that is, the application does this at certain
2220 * points in its user interaction where it wants to allow the user to focus
2221 * on content, but not as a continuous state. For situations where the application
2222 * would like to simply stay full screen the entire time (such as a game that
2223 * wants to take over the screen), the
2224 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN window flag}
2225 * is usually a better approach. The state set here will be removed by the system
2226 * in various situations (such as the user moving to another application) like
2227 * the other system UI states.
2228 *
2229 * <p>When using this flag, the application should provide some easy facility
2230 * for the user to go out of it. A common example would be in an e-book
2231 * reader, where tapping on the screen brings back whatever screen and UI
2232 * decorations that had been hidden while the user was immersed in reading
2233 * the book.
2234 *
2235 * @see #setSystemUiVisibility(int)
2236 */
2237 public static final int SYSTEM_UI_FLAG_FULLSCREEN = 0x00000004;
2238
2239 /**
2240 * Flag for {@link #setSystemUiVisibility(int)}: When using other layout
2241 * flags, we would like a stable view of the content insets given to
2242 * {@link #fitSystemWindows(Rect)}. This means that the insets seen there
2243 * will always represent the worst case that the application can expect
2244 * as a continue state. In practice this means with any of system bar,
2245 * nav bar, and status bar shown, but not the space that would be needed
2246 * for an input method.
2247 *
2248 * <p>If you are using ActionBar in
2249 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY
2250 * Window.FEATURE_ACTION_BAR_OVERLAY}, this flag will also impact the
2251 * insets it adds to those given to the application.
2252 */
2253 public static final int SYSTEM_UI_FLAG_LAYOUT_STABLE = 0x00000100;
2254
2255 /**
2256 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window
2257 * to be layed out as if it has requested
2258 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, even if it currently hasn't. This
2259 * allows it to avoid artifacts when switching in and out of that mode, at
2260 * the expense that some of its user interface may be covered by screen
2261 * decorations when they are shown. You can perform layout of your inner
2262 * UI elements to account for the navagation system UI through the
2263 * {@link #fitSystemWindows(Rect)} method.
2264 */
2265 public static final int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 0x00000200;
2266
2267 /**
2268 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window
2269 * to be layed out as if it has requested
2270 * {@link #SYSTEM_UI_FLAG_FULLSCREEN}, even if it currently hasn't. This
2271 * allows it to avoid artifacts when switching in and out of that mode, at
2272 * the expense that some of its user interface may be covered by screen
2273 * decorations when they are shown. You can perform layout of your inner
2274 * UI elements to account for non-fullscreen system UI through the
2275 * {@link #fitSystemWindows(Rect)} method.
2276 */
2277 public static final int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 0x00000400;
2278
2279 /**
Daniel Sandler60ee2562011-07-22 12:34:33 -04002280 * @deprecated Use {@link #SYSTEM_UI_FLAG_LOW_PROFILE} instead.
2281 */
2282 public static final int STATUS_BAR_HIDDEN = SYSTEM_UI_FLAG_LOW_PROFILE;
2283
2284 /**
2285 * @deprecated Use {@link #SYSTEM_UI_FLAG_VISIBLE} instead.
2286 */
2287 public static final int STATUS_BAR_VISIBLE = SYSTEM_UI_FLAG_VISIBLE;
Joe Onorato664644d2011-01-23 17:53:23 -08002288
2289 /**
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002290 * @hide
2291 *
2292 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2293 * out of the public fields to keep the undefined bits out of the developer's way.
2294 *
2295 * Flag to make the status bar not expandable. Unless you also
2296 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show.
2297 */
2298 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000;
2299
2300 /**
2301 * @hide
2302 *
2303 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2304 * out of the public fields to keep the undefined bits out of the developer's way.
2305 *
2306 * Flag to hide notification icons and scrolling ticker text.
2307 */
2308 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000;
2309
2310 /**
2311 * @hide
2312 *
2313 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2314 * out of the public fields to keep the undefined bits out of the developer's way.
2315 *
2316 * Flag to disable incoming notification alerts. This will not block
2317 * icons, but it will block sound, vibrating and other visual or aural notifications.
2318 */
2319 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000;
2320
2321 /**
2322 * @hide
2323 *
2324 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2325 * out of the public fields to keep the undefined bits out of the developer's way.
2326 *
2327 * Flag to hide only the scrolling ticker. Note that
2328 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies
2329 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}.
2330 */
2331 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000;
2332
2333 /**
2334 * @hide
2335 *
2336 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2337 * out of the public fields to keep the undefined bits out of the developer's way.
2338 *
2339 * Flag to hide the center system info area.
2340 */
2341 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000;
2342
2343 /**
2344 * @hide
2345 *
2346 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2347 * out of the public fields to keep the undefined bits out of the developer's way.
2348 *
Daniel Sandlerdba93562011-10-06 16:39:58 -04002349 * Flag to hide only the home button. Don't use this
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002350 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2351 */
Daniel Sandlerdba93562011-10-06 16:39:58 -04002352 public static final int STATUS_BAR_DISABLE_HOME = 0x00200000;
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002353
2354 /**
2355 * @hide
2356 *
2357 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2358 * out of the public fields to keep the undefined bits out of the developer's way.
2359 *
Daniel Sandlerdba93562011-10-06 16:39:58 -04002360 * Flag to hide only the back button. Don't use this
Joe Onorato6478adc2011-01-27 21:15:01 -08002361 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2362 */
2363 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000;
2364
2365 /**
2366 * @hide
2367 *
2368 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2369 * out of the public fields to keep the undefined bits out of the developer's way.
2370 *
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002371 * Flag to hide only the clock. You might use this if your activity has
2372 * its own clock making the status bar's clock redundant.
2373 */
Joe Onorato6478adc2011-01-27 21:15:01 -08002374 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000;
2375
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002376 /**
2377 * @hide
Daniel Sandlerdba93562011-10-06 16:39:58 -04002378 *
2379 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2380 * out of the public fields to keep the undefined bits out of the developer's way.
2381 *
2382 * Flag to hide only the recent apps button. Don't use this
2383 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2384 */
2385 public static final int STATUS_BAR_DISABLE_RECENT = 0x01000000;
2386
2387 /**
2388 * @hide
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002389 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002390 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = 0x0000FFFF;
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002391
2392 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -07002393 * These are the system UI flags that can be cleared by events outside
2394 * of an application. Currently this is just the ability to tap on the
2395 * screen while hiding the navigation bar to have it return.
2396 * @hide
2397 */
2398 public static final int SYSTEM_UI_CLEARABLE_FLAGS =
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002399 SYSTEM_UI_FLAG_LOW_PROFILE | SYSTEM_UI_FLAG_HIDE_NAVIGATION
2400 | SYSTEM_UI_FLAG_FULLSCREEN;
2401
2402 /**
2403 * Flags that can impact the layout in relation to system UI.
2404 */
2405 public static final int SYSTEM_UI_LAYOUT_FLAGS =
2406 SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION
2407 | SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN;
Dianne Hackborn9a230e02011-10-06 11:51:27 -07002408
2409 /**
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07002410 * Find views that render the specified text.
2411 *
2412 * @see #findViewsWithText(ArrayList, CharSequence, int)
2413 */
2414 public static final int FIND_VIEWS_WITH_TEXT = 0x00000001;
2415
2416 /**
2417 * Find find views that contain the specified content description.
2418 *
2419 * @see #findViewsWithText(ArrayList, CharSequence, int)
2420 */
2421 public static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 0x00000002;
2422
2423 /**
Svetoslav Ganov02107852011-10-03 17:06:56 -07002424 * Find views that contain {@link AccessibilityNodeProvider}. Such
2425 * a View is a root of virtual view hierarchy and may contain the searched
2426 * text. If this flag is set Views with providers are automatically
2427 * added and it is a responsibility of the client to call the APIs of
2428 * the provider to determine whether the virtual tree rooted at this View
2429 * contains the text, i.e. getting the list of {@link AccessibilityNodeInfo}s
2430 * represeting the virtual views with this text.
2431 *
2432 * @see #findViewsWithText(ArrayList, CharSequence, int)
2433 *
2434 * @hide
2435 */
2436 public static final int FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS = 0x00000004;
2437
2438 /**
Romain Guybb9908b2012-03-08 11:14:07 -08002439 * Indicates that the screen has changed state and is now off.
2440 *
2441 * @see #onScreenStateChanged(int)
2442 */
2443 public static final int SCREEN_STATE_OFF = 0x0;
2444
2445 /**
2446 * Indicates that the screen has changed state and is now on.
2447 *
Romain Guy1e3d3132012-03-08 15:55:56 -08002448 * @see #onScreenStateChanged(int)
Romain Guybb9908b2012-03-08 11:14:07 -08002449 */
2450 public static final int SCREEN_STATE_ON = 0x1;
2451
2452 /**
Adam Powell637d3372010-08-25 14:37:03 -07002453 * Controls the over-scroll mode for this view.
2454 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)},
2455 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS},
2456 * and {@link #OVER_SCROLL_NEVER}.
2457 */
2458 private int mOverScrollMode;
2459
2460 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002461 * The parent this view is attached to.
2462 * {@hide}
2463 *
2464 * @see #getParent()
2465 */
2466 protected ViewParent mParent;
2467
2468 /**
2469 * {@hide}
2470 */
2471 AttachInfo mAttachInfo;
2472
2473 /**
2474 * {@hide}
2475 */
Romain Guy809a7f62009-05-14 15:44:42 -07002476 @ViewDebug.ExportedProperty(flagMapping = {
2477 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT,
2478 name = "FORCE_LAYOUT"),
2479 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED,
2480 name = "LAYOUT_REQUIRED"),
2481 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07002482 name = "DRAWING_CACHE_INVALID", outputIf = false),
Romain Guy809a7f62009-05-14 15:44:42 -07002483 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true),
2484 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false),
2485 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
2486 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY")
2487 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002488 int mPrivateFlags;
Christopher Tate3d4bf172011-03-28 16:16:46 -07002489 int mPrivateFlags2;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002490
2491 /**
Joe Onorato664644d2011-01-23 17:53:23 -08002492 * This view's request for the visibility of the status bar.
2493 * @hide
2494 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002495 @ViewDebug.ExportedProperty(flagMapping = {
2496 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_LOW_PROFILE,
2497 equals = SYSTEM_UI_FLAG_LOW_PROFILE,
2498 name = "SYSTEM_UI_FLAG_LOW_PROFILE", outputIf = true),
2499 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_HIDE_NAVIGATION,
2500 equals = SYSTEM_UI_FLAG_HIDE_NAVIGATION,
2501 name = "SYSTEM_UI_FLAG_HIDE_NAVIGATION", outputIf = true),
2502 @ViewDebug.FlagToString(mask = PUBLIC_STATUS_BAR_VISIBILITY_MASK,
2503 equals = SYSTEM_UI_FLAG_VISIBLE,
2504 name = "SYSTEM_UI_FLAG_VISIBLE", outputIf = true)
2505 })
Joe Onorato664644d2011-01-23 17:53:23 -08002506 int mSystemUiVisibility;
2507
2508 /**
Chet Haase563d4f22012-04-18 16:20:08 -07002509 * Reference count for transient state.
2510 * @see #setHasTransientState(boolean)
2511 */
2512 int mTransientStateCount = 0;
2513
2514 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002515 * Count of how many windows this view has been attached to.
2516 */
2517 int mWindowAttachCount;
2518
2519 /**
2520 * The layout parameters associated with this view and used by the parent
2521 * {@link android.view.ViewGroup} to determine how this view should be
2522 * laid out.
2523 * {@hide}
2524 */
2525 protected ViewGroup.LayoutParams mLayoutParams;
2526
2527 /**
2528 * The view flags hold various views states.
2529 * {@hide}
2530 */
2531 @ViewDebug.ExportedProperty
2532 int mViewFlags;
2533
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002534 static class TransformationInfo {
2535 /**
2536 * The transform matrix for the View. This transform is calculated internally
2537 * based on the rotation, scaleX, and scaleY properties. The identity matrix
2538 * is used by default. Do *not* use this variable directly; instead call
2539 * getMatrix(), which will automatically recalculate the matrix if necessary
2540 * to get the correct matrix based on the latest rotation and scale properties.
2541 */
2542 private final Matrix mMatrix = new Matrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07002543
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002544 /**
2545 * The transform matrix for the View. This transform is calculated internally
2546 * based on the rotation, scaleX, and scaleY properties. The identity matrix
2547 * is used by default. Do *not* use this variable directly; instead call
2548 * getInverseMatrix(), which will automatically recalculate the matrix if necessary
2549 * to get the correct matrix based on the latest rotation and scale properties.
2550 */
2551 private Matrix mInverseMatrix;
Chet Haasec3aa3612010-06-17 08:50:37 -07002552
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002553 /**
2554 * An internal variable that tracks whether we need to recalculate the
2555 * transform matrix, based on whether the rotation or scaleX/Y properties
2556 * have changed since the matrix was last calculated.
2557 */
2558 boolean mMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07002559
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002560 /**
2561 * An internal variable that tracks whether we need to recalculate the
2562 * transform matrix, based on whether the rotation or scaleX/Y properties
2563 * have changed since the matrix was last calculated.
2564 */
2565 private boolean mInverseMatrixDirty = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07002566
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002567 /**
2568 * A variable that tracks whether we need to recalculate the
2569 * transform matrix, based on whether the rotation or scaleX/Y properties
2570 * have changed since the matrix was last calculated. This variable
2571 * is only valid after a call to updateMatrix() or to a function that
2572 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix().
2573 */
2574 private boolean mMatrixIsIdentity = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07002575
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002576 /**
2577 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set.
2578 */
2579 private Camera mCamera = null;
Chet Haasefd2b0022010-08-06 13:08:56 -07002580
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002581 /**
2582 * This matrix is used when computing the matrix for 3D rotations.
2583 */
2584 private Matrix matrix3D = null;
Chet Haasefd2b0022010-08-06 13:08:56 -07002585
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002586 /**
2587 * These prev values are used to recalculate a centered pivot point when necessary. The
2588 * pivot point is only used in matrix operations (when rotation, scale, or translation are
2589 * set), so thes values are only used then as well.
2590 */
2591 private int mPrevWidth = -1;
2592 private int mPrevHeight = -1;
Philip Milne6c8ea062012-04-03 17:38:43 -07002593
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002594 /**
2595 * The degrees rotation around the vertical axis through the pivot point.
2596 */
2597 @ViewDebug.ExportedProperty
2598 float mRotationY = 0f;
2599
2600 /**
2601 * The degrees rotation around the horizontal axis through the pivot point.
2602 */
2603 @ViewDebug.ExportedProperty
2604 float mRotationX = 0f;
2605
2606 /**
2607 * The degrees rotation around the pivot point.
2608 */
2609 @ViewDebug.ExportedProperty
2610 float mRotation = 0f;
2611
2612 /**
2613 * The amount of translation of the object away from its left property (post-layout).
2614 */
2615 @ViewDebug.ExportedProperty
2616 float mTranslationX = 0f;
2617
2618 /**
2619 * The amount of translation of the object away from its top property (post-layout).
2620 */
2621 @ViewDebug.ExportedProperty
2622 float mTranslationY = 0f;
2623
2624 /**
2625 * The amount of scale in the x direction around the pivot point. A
2626 * value of 1 means no scaling is applied.
2627 */
2628 @ViewDebug.ExportedProperty
2629 float mScaleX = 1f;
2630
2631 /**
2632 * The amount of scale in the y direction around the pivot point. A
2633 * value of 1 means no scaling is applied.
2634 */
2635 @ViewDebug.ExportedProperty
2636 float mScaleY = 1f;
2637
2638 /**
Chet Haasea33de552012-02-03 16:28:24 -08002639 * The x location of the point around which the view is rotated and scaled.
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002640 */
2641 @ViewDebug.ExportedProperty
2642 float mPivotX = 0f;
2643
2644 /**
Chet Haasea33de552012-02-03 16:28:24 -08002645 * The y location of the point around which the view is rotated and scaled.
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002646 */
2647 @ViewDebug.ExportedProperty
2648 float mPivotY = 0f;
2649
2650 /**
2651 * The opacity of the View. This is a value from 0 to 1, where 0 means
2652 * completely transparent and 1 means completely opaque.
2653 */
2654 @ViewDebug.ExportedProperty
2655 float mAlpha = 1f;
2656 }
2657
2658 TransformationInfo mTransformationInfo;
Chet Haasefd2b0022010-08-06 13:08:56 -07002659
Joe Malin32736f02011-01-19 16:14:20 -08002660 private boolean mLastIsOpaque;
2661
Chet Haasefd2b0022010-08-06 13:08:56 -07002662 /**
2663 * Convenience value to check for float values that are close enough to zero to be considered
2664 * zero.
2665 */
Romain Guy2542d192010-08-18 11:47:12 -07002666 private static final float NONZERO_EPSILON = .001f;
Chet Haasefd2b0022010-08-06 13:08:56 -07002667
2668 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002669 * The distance in pixels from the left edge of this view's parent
2670 * to the left edge of this view.
2671 * {@hide}
2672 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002673 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002674 protected int mLeft;
2675 /**
2676 * The distance in pixels from the left edge of this view's parent
2677 * to the right edge of this view.
2678 * {@hide}
2679 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002680 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002681 protected int mRight;
2682 /**
2683 * The distance in pixels from the top edge of this view's parent
2684 * to the top edge of this view.
2685 * {@hide}
2686 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002687 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002688 protected int mTop;
2689 /**
2690 * The distance in pixels from the top edge of this view's parent
2691 * to the bottom edge of this view.
2692 * {@hide}
2693 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002694 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002695 protected int mBottom;
2696
2697 /**
2698 * The offset, in pixels, by which the content of this view is scrolled
2699 * horizontally.
2700 * {@hide}
2701 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002702 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002703 protected int mScrollX;
2704 /**
2705 * The offset, in pixels, by which the content of this view is scrolled
2706 * vertically.
2707 * {@hide}
2708 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002709 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002710 protected int mScrollY;
2711
2712 /**
2713 * The left padding in pixels, that is the distance in pixels between the
2714 * left edge of this view and the left edge of its content.
2715 * {@hide}
2716 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002717 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002718 protected int mPaddingLeft;
2719 /**
2720 * The right padding in pixels, that is the distance in pixels between the
2721 * right edge of this view and the right edge of its content.
2722 * {@hide}
2723 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002724 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002725 protected int mPaddingRight;
2726 /**
2727 * The top padding in pixels, that is the distance in pixels between the
2728 * top edge of this view and the top edge of its content.
2729 * {@hide}
2730 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002731 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002732 protected int mPaddingTop;
2733 /**
2734 * The bottom padding in pixels, that is the distance in pixels between the
2735 * bottom edge of this view and the bottom edge of its content.
2736 * {@hide}
2737 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002738 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002739 protected int mPaddingBottom;
2740
2741 /**
Philip Milne1557fd72012-04-04 23:41:34 -07002742 * The layout insets in pixels, that is the distance in pixels between the
2743 * visible edges of this view its bounds.
2744 */
2745 private Insets mLayoutInsets;
2746
2747 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002748 * Briefly describes the view and is primarily used for accessibility support.
2749 */
2750 private CharSequence mContentDescription;
2751
2752 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002753 * Cache the paddingRight set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002754 *
2755 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002756 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002757 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002758 protected int mUserPaddingRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002759
2760 /**
2761 * Cache the paddingBottom set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002762 *
2763 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002764 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002765 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002766 protected int mUserPaddingBottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002767
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002768 /**
Adam Powell20232d02010-12-08 21:08:53 -08002769 * Cache the paddingLeft set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002770 *
2771 * @hide
Adam Powell20232d02010-12-08 21:08:53 -08002772 */
2773 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002774 protected int mUserPaddingLeft;
Adam Powell20232d02010-12-08 21:08:53 -08002775
2776 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07002777 * Cache if the user padding is relative.
2778 *
2779 */
2780 @ViewDebug.ExportedProperty(category = "padding")
2781 boolean mUserPaddingRelative;
2782
2783 /**
2784 * Cache the paddingStart set by the user to append to the scrollbar's size.
2785 *
2786 */
2787 @ViewDebug.ExportedProperty(category = "padding")
2788 int mUserPaddingStart;
2789
2790 /**
2791 * Cache the paddingEnd set by the user to append to the scrollbar's size.
2792 *
2793 */
2794 @ViewDebug.ExportedProperty(category = "padding")
2795 int mUserPaddingEnd;
2796
2797 /**
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002798 * @hide
2799 */
2800 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
2801 /**
2802 * @hide
2803 */
2804 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002805
Philip Milne6c8ea062012-04-03 17:38:43 -07002806 private Drawable mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002807
2808 private int mBackgroundResource;
2809 private boolean mBackgroundSizeChanged;
2810
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002811 static class ListenerInfo {
2812 /**
2813 * Listener used to dispatch focus change events.
2814 * This field should be made private, so it is hidden from the SDK.
2815 * {@hide}
2816 */
2817 protected OnFocusChangeListener mOnFocusChangeListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002818
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002819 /**
2820 * Listeners for layout change events.
2821 */
2822 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
Chet Haase21cd1382010-09-01 17:42:29 -07002823
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002824 /**
2825 * Listeners for attach events.
2826 */
2827 private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners;
Adam Powell4afd62b2011-02-18 15:02:18 -08002828
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002829 /**
2830 * Listener used to dispatch click events.
2831 * This field should be made private, so it is hidden from the SDK.
2832 * {@hide}
2833 */
2834 public OnClickListener mOnClickListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002835
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002836 /**
2837 * Listener used to dispatch long click events.
2838 * This field should be made private, so it is hidden from the SDK.
2839 * {@hide}
2840 */
2841 protected OnLongClickListener mOnLongClickListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002842
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002843 /**
2844 * Listener used to build the context menu.
2845 * This field should be made private, so it is hidden from the SDK.
2846 * {@hide}
2847 */
2848 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002849
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002850 private OnKeyListener mOnKeyListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002851
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002852 private OnTouchListener mOnTouchListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002853
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002854 private OnHoverListener mOnHoverListener;
Jeff Brown10b62902011-06-20 16:40:37 -07002855
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002856 private OnGenericMotionListener mOnGenericMotionListener;
Jeff Brown33bbfd22011-02-24 20:55:35 -08002857
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002858 private OnDragListener mOnDragListener;
Chris Tate32affef2010-10-18 15:29:21 -07002859
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002860 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener;
2861 }
2862
2863 ListenerInfo mListenerInfo;
Joe Onorato664644d2011-01-23 17:53:23 -08002864
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002865 /**
2866 * The application environment this view lives in.
2867 * This field should be made private, so it is hidden from the SDK.
2868 * {@hide}
2869 */
2870 protected Context mContext;
2871
Dianne Hackbornab0f4852011-09-12 16:59:06 -07002872 private final Resources mResources;
2873
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002874 private ScrollabilityCache mScrollCache;
2875
2876 private int[] mDrawableState = null;
2877
Romain Guy0211a0a2011-02-14 16:34:59 -08002878 /**
2879 * Set to true when drawing cache is enabled and cannot be created.
Philip Milne6c8ea062012-04-03 17:38:43 -07002880 *
Romain Guy0211a0a2011-02-14 16:34:59 -08002881 * @hide
2882 */
2883 public boolean mCachingFailed;
2884
Romain Guy02890fd2010-08-06 17:58:44 -07002885 private Bitmap mDrawingCache;
2886 private Bitmap mUnscaledDrawingCache;
Romain Guy6c319ca2011-01-11 14:29:25 -08002887 private HardwareLayer mHardwareLayer;
Romain Guy65b345f2011-07-27 18:51:50 -07002888 DisplayList mDisplayList;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002889
2890 /**
2891 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
2892 * the user may specify which view to go to next.
2893 */
2894 private int mNextFocusLeftId = View.NO_ID;
2895
2896 /**
2897 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
2898 * the user may specify which view to go to next.
2899 */
2900 private int mNextFocusRightId = View.NO_ID;
2901
2902 /**
2903 * When this view has focus and the next focus is {@link #FOCUS_UP},
2904 * the user may specify which view to go to next.
2905 */
2906 private int mNextFocusUpId = View.NO_ID;
2907
2908 /**
2909 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
2910 * the user may specify which view to go to next.
2911 */
2912 private int mNextFocusDownId = View.NO_ID;
2913
Jeff Brown4e6319b2010-12-13 10:36:51 -08002914 /**
2915 * When this view has focus and the next focus is {@link #FOCUS_FORWARD},
2916 * the user may specify which view to go to next.
2917 */
2918 int mNextFocusForwardId = View.NO_ID;
2919
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002920 private CheckForLongPress mPendingCheckForLongPress;
Adam Powelle14579b2009-12-16 18:39:52 -08002921 private CheckForTap mPendingCheckForTap = null;
Adam Powella35d7682010-03-12 14:48:13 -08002922 private PerformClick mPerformClick;
Svetoslav Ganova0156172011-06-26 17:55:44 -07002923 private SendViewScrolledAccessibilityEvent mSendViewScrolledAccessibilityEvent;
Joe Malin32736f02011-01-19 16:14:20 -08002924
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002925 private UnsetPressedState mUnsetPressedState;
2926
2927 /**
2928 * Whether the long press's action has been invoked. The tap's action is invoked on the
2929 * up event while a long press is invoked as soon as the long press duration is reached, so
2930 * a long press could be performed before the tap is checked, in which case the tap's action
2931 * should not be invoked.
2932 */
2933 private boolean mHasPerformedLongPress;
2934
2935 /**
2936 * The minimum height of the view. We'll try our best to have the height
2937 * of this view to at least this amount.
2938 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002939 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002940 private int mMinHeight;
2941
2942 /**
2943 * The minimum width of the view. We'll try our best to have the width
2944 * of this view to at least this amount.
2945 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002946 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002947 private int mMinWidth;
2948
2949 /**
2950 * The delegate to handle touch events that are physically in this view
2951 * but should be handled by another view.
2952 */
2953 private TouchDelegate mTouchDelegate = null;
2954
2955 /**
2956 * Solid color to use as a background when creating the drawing cache. Enables
2957 * the cache to use 16 bit bitmaps instead of 32 bit.
2958 */
2959 private int mDrawingCacheBackgroundColor = 0;
2960
2961 /**
2962 * Special tree observer used when mAttachInfo is null.
2963 */
2964 private ViewTreeObserver mFloatingTreeObserver;
Joe Malin32736f02011-01-19 16:14:20 -08002965
Adam Powelle14579b2009-12-16 18:39:52 -08002966 /**
2967 * Cache the touch slop from the context that created the view.
2968 */
2969 private int mTouchSlop;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002970
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002971 /**
Chet Haasea00f3862011-02-22 06:34:40 -08002972 * Object that handles automatic animation of view properties.
2973 */
2974 private ViewPropertyAnimator mAnimator = null;
2975
2976 /**
Christopher Tate251602f2011-01-28 17:54:12 -08002977 * Flag indicating that a drag can cross window boundaries. When
2978 * {@link #startDrag(ClipData, DragShadowBuilder, Object, int)} is called
2979 * with this flag set, all visible applications will be able to participate
2980 * in the drag operation and receive the dragged content.
Christopher Tate7f9ff9d2011-02-14 17:31:13 -08002981 *
2982 * @hide
Christopher Tate02d2b3b2011-01-10 20:43:53 -08002983 */
2984 public static final int DRAG_FLAG_GLOBAL = 1;
2985
2986 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08002987 * Vertical scroll factor cached by {@link #getVerticalScrollFactor}.
2988 */
2989 private float mVerticalScrollFactor;
2990
2991 /**
Adam Powell20232d02010-12-08 21:08:53 -08002992 * Position of the vertical scroll bar.
2993 */
2994 private int mVerticalScrollbarPosition;
2995
2996 /**
2997 * Position the scroll bar at the default position as determined by the system.
2998 */
2999 public static final int SCROLLBAR_POSITION_DEFAULT = 0;
3000
3001 /**
3002 * Position the scroll bar along the left edge.
3003 */
3004 public static final int SCROLLBAR_POSITION_LEFT = 1;
3005
3006 /**
3007 * Position the scroll bar along the right edge.
3008 */
3009 public static final int SCROLLBAR_POSITION_RIGHT = 2;
3010
3011 /**
Romain Guy171c5922011-01-06 10:04:23 -08003012 * Indicates that the view does not have a layer.
Joe Malin32736f02011-01-19 16:14:20 -08003013 *
3014 * @see #getLayerType()
3015 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08003016 * @see #LAYER_TYPE_SOFTWARE
Joe Malin32736f02011-01-19 16:14:20 -08003017 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08003018 */
3019 public static final int LAYER_TYPE_NONE = 0;
3020
3021 /**
3022 * <p>Indicates that the view has a software layer. A software layer is backed
3023 * by a bitmap and causes the view to be rendered using Android's software
3024 * rendering pipeline, even if hardware acceleration is enabled.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003025 *
Romain Guy171c5922011-01-06 10:04:23 -08003026 * <p>Software layers have various usages:</p>
3027 * <p>When the application is not using hardware acceleration, a software layer
3028 * is useful to apply a specific color filter and/or blending mode and/or
3029 * translucency to a view and all its children.</p>
3030 * <p>When the application is using hardware acceleration, a software layer
3031 * is useful to render drawing primitives not supported by the hardware
3032 * accelerated pipeline. It can also be used to cache a complex view tree
3033 * into a texture and reduce the complexity of drawing operations. For instance,
3034 * when animating a complex view tree with a translation, a software layer can
3035 * be used to render the view tree only once.</p>
3036 * <p>Software layers should be avoided when the affected view tree updates
3037 * often. Every update will require to re-render the software layer, which can
3038 * potentially be slow (particularly when hardware acceleration is turned on
3039 * since the layer will have to be uploaded into a hardware texture after every
3040 * update.)</p>
Joe Malin32736f02011-01-19 16:14:20 -08003041 *
3042 * @see #getLayerType()
3043 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08003044 * @see #LAYER_TYPE_NONE
Joe Malin32736f02011-01-19 16:14:20 -08003045 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08003046 */
3047 public static final int LAYER_TYPE_SOFTWARE = 1;
3048
3049 /**
3050 * <p>Indicates that the view has a hardware layer. A hardware layer is backed
3051 * by a hardware specific texture (generally Frame Buffer Objects or FBO on
3052 * OpenGL hardware) and causes the view to be rendered using Android's hardware
3053 * rendering pipeline, but only if hardware acceleration is turned on for the
3054 * view hierarchy. When hardware acceleration is turned off, hardware layers
3055 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003056 *
Romain Guy171c5922011-01-06 10:04:23 -08003057 * <p>A hardware layer is useful to apply a specific color filter and/or
3058 * blending mode and/or translucency to a view and all its children.</p>
Romain Guy6c319ca2011-01-11 14:29:25 -08003059 * <p>A hardware layer can be used to cache a complex view tree into a
3060 * texture and reduce the complexity of drawing operations. For instance,
3061 * when animating a complex view tree with a translation, a hardware layer can
3062 * be used to render the view tree only once.</p>
Romain Guy171c5922011-01-06 10:04:23 -08003063 * <p>A hardware layer can also be used to increase the rendering quality when
3064 * rotation transformations are applied on a view. It can also be used to
3065 * prevent potential clipping issues when applying 3D transforms on a view.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003066 *
3067 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -08003068 * @see #setLayerType(int, android.graphics.Paint)
3069 * @see #LAYER_TYPE_NONE
3070 * @see #LAYER_TYPE_SOFTWARE
3071 */
3072 public static final int LAYER_TYPE_HARDWARE = 2;
Joe Malin32736f02011-01-19 16:14:20 -08003073
Romain Guy3aaff3a2011-01-12 14:18:47 -08003074 @ViewDebug.ExportedProperty(category = "drawing", mapping = {
3075 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"),
3076 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"),
3077 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE")
3078 })
Romain Guy171c5922011-01-06 10:04:23 -08003079 int mLayerType = LAYER_TYPE_NONE;
3080 Paint mLayerPaint;
Romain Guy3a3133d2011-02-01 22:59:58 -08003081 Rect mLocalDirtyRect;
Romain Guy171c5922011-01-06 10:04:23 -08003082
3083 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07003084 * Set to true when the view is sending hover accessibility events because it
3085 * is the innermost hovered view.
3086 */
3087 private boolean mSendingHoverAccessibilityEvents;
3088
3089 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003090 * Simple constructor to use when creating a view from code.
3091 *
3092 * @param context The Context the view is running in, through which it can
3093 * access the current theme, resources, etc.
3094 */
3095 public View(Context context) {
3096 mContext = context;
3097 mResources = context != null ? context.getResources() : null;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003098 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07003099 // Set layout and text direction defaults
3100 mPrivateFlags2 = (LAYOUT_DIRECTION_DEFAULT << LAYOUT_DIRECTION_MASK_SHIFT) |
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07003101 (TEXT_DIRECTION_DEFAULT << TEXT_DIRECTION_MASK_SHIFT) |
Svetoslav Ganov42138042012-03-20 11:51:39 -07003102 (TEXT_ALIGNMENT_DEFAULT << TEXT_ALIGNMENT_MASK_SHIFT) |
3103 (IMPORTANT_FOR_ACCESSIBILITY_DEFAULT << IMPORTANT_FOR_ACCESSIBILITY_SHIFT);
Adam Powelle14579b2009-12-16 18:39:52 -08003104 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop();
Adam Powell637d3372010-08-25 14:37:03 -07003105 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS);
Fabrice Di Megliof9e36502011-06-21 18:41:48 -07003106 mUserPaddingStart = -1;
3107 mUserPaddingEnd = -1;
3108 mUserPaddingRelative = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003109 }
3110
3111 /**
Chet Haasedb8c9a62012-03-21 18:54:18 -07003112 * Delegate for injecting accessiblity functionality.
3113 */
3114 AccessibilityDelegate mAccessibilityDelegate;
3115
3116 /**
3117 * Consistency verifier for debugging purposes.
3118 * @hide
3119 */
3120 protected final InputEventConsistencyVerifier mInputEventConsistencyVerifier =
3121 InputEventConsistencyVerifier.isInstrumentationEnabled() ?
3122 new InputEventConsistencyVerifier(this, 0) : null;
3123
3124 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003125 * Constructor that is called when inflating a view from XML. This is called
3126 * when a view is being constructed from an XML file, supplying attributes
3127 * that were specified in the XML file. This version uses a default style of
3128 * 0, so the only attribute values applied are those in the Context's Theme
3129 * and the given AttributeSet.
3130 *
3131 * <p>
3132 * The method onFinishInflate() will be called after all children have been
3133 * added.
3134 *
3135 * @param context The Context the view is running in, through which it can
3136 * access the current theme, resources, etc.
3137 * @param attrs The attributes of the XML tag that is inflating the view.
3138 * @see #View(Context, AttributeSet, int)
3139 */
3140 public View(Context context, AttributeSet attrs) {
3141 this(context, attrs, 0);
3142 }
3143
3144 /**
3145 * Perform inflation from XML and apply a class-specific base style. This
3146 * constructor of View allows subclasses to use their own base style when
3147 * they are inflating. For example, a Button class's constructor would call
3148 * this version of the super class constructor and supply
3149 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
3150 * the theme's button style to modify all of the base view attributes (in
3151 * particular its background) as well as the Button class's attributes.
3152 *
3153 * @param context The Context the view is running in, through which it can
3154 * access the current theme, resources, etc.
3155 * @param attrs The attributes of the XML tag that is inflating the view.
3156 * @param defStyle The default style to apply to this view. If 0, no style
3157 * will be applied (beyond what is included in the theme). This may
3158 * either be an attribute resource, whose value will be retrieved
3159 * from the current theme, or an explicit style resource.
3160 * @see #View(Context, AttributeSet)
3161 */
3162 public View(Context context, AttributeSet attrs, int defStyle) {
3163 this(context);
3164
3165 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
3166 defStyle, 0);
3167
3168 Drawable background = null;
3169
3170 int leftPadding = -1;
3171 int topPadding = -1;
3172 int rightPadding = -1;
3173 int bottomPadding = -1;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003174 int startPadding = -1;
3175 int endPadding = -1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003176
3177 int padding = -1;
3178
3179 int viewFlagValues = 0;
3180 int viewFlagMasks = 0;
3181
3182 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07003183
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003184 int x = 0;
3185 int y = 0;
3186
Chet Haase73066682010-11-29 15:55:32 -08003187 float tx = 0;
3188 float ty = 0;
3189 float rotation = 0;
3190 float rotationX = 0;
3191 float rotationY = 0;
3192 float sx = 1f;
3193 float sy = 1f;
3194 boolean transformSet = false;
3195
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003196 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
3197
Adam Powell637d3372010-08-25 14:37:03 -07003198 int overScrollMode = mOverScrollMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003199 final int N = a.getIndexCount();
3200 for (int i = 0; i < N; i++) {
3201 int attr = a.getIndex(i);
3202 switch (attr) {
3203 case com.android.internal.R.styleable.View_background:
3204 background = a.getDrawable(attr);
3205 break;
3206 case com.android.internal.R.styleable.View_padding:
3207 padding = a.getDimensionPixelSize(attr, -1);
3208 break;
3209 case com.android.internal.R.styleable.View_paddingLeft:
3210 leftPadding = a.getDimensionPixelSize(attr, -1);
3211 break;
3212 case com.android.internal.R.styleable.View_paddingTop:
3213 topPadding = a.getDimensionPixelSize(attr, -1);
3214 break;
3215 case com.android.internal.R.styleable.View_paddingRight:
3216 rightPadding = a.getDimensionPixelSize(attr, -1);
3217 break;
3218 case com.android.internal.R.styleable.View_paddingBottom:
3219 bottomPadding = a.getDimensionPixelSize(attr, -1);
3220 break;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003221 case com.android.internal.R.styleable.View_paddingStart:
3222 startPadding = a.getDimensionPixelSize(attr, -1);
3223 break;
3224 case com.android.internal.R.styleable.View_paddingEnd:
3225 endPadding = a.getDimensionPixelSize(attr, -1);
3226 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003227 case com.android.internal.R.styleable.View_scrollX:
3228 x = a.getDimensionPixelOffset(attr, 0);
3229 break;
3230 case com.android.internal.R.styleable.View_scrollY:
3231 y = a.getDimensionPixelOffset(attr, 0);
3232 break;
Chet Haase73066682010-11-29 15:55:32 -08003233 case com.android.internal.R.styleable.View_alpha:
3234 setAlpha(a.getFloat(attr, 1f));
3235 break;
3236 case com.android.internal.R.styleable.View_transformPivotX:
3237 setPivotX(a.getDimensionPixelOffset(attr, 0));
3238 break;
3239 case com.android.internal.R.styleable.View_transformPivotY:
3240 setPivotY(a.getDimensionPixelOffset(attr, 0));
3241 break;
3242 case com.android.internal.R.styleable.View_translationX:
3243 tx = a.getDimensionPixelOffset(attr, 0);
3244 transformSet = true;
3245 break;
3246 case com.android.internal.R.styleable.View_translationY:
3247 ty = a.getDimensionPixelOffset(attr, 0);
3248 transformSet = true;
3249 break;
3250 case com.android.internal.R.styleable.View_rotation:
3251 rotation = a.getFloat(attr, 0);
3252 transformSet = true;
3253 break;
3254 case com.android.internal.R.styleable.View_rotationX:
3255 rotationX = a.getFloat(attr, 0);
3256 transformSet = true;
3257 break;
3258 case com.android.internal.R.styleable.View_rotationY:
3259 rotationY = a.getFloat(attr, 0);
3260 transformSet = true;
3261 break;
3262 case com.android.internal.R.styleable.View_scaleX:
3263 sx = a.getFloat(attr, 1f);
3264 transformSet = true;
3265 break;
3266 case com.android.internal.R.styleable.View_scaleY:
3267 sy = a.getFloat(attr, 1f);
3268 transformSet = true;
3269 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003270 case com.android.internal.R.styleable.View_id:
3271 mID = a.getResourceId(attr, NO_ID);
3272 break;
3273 case com.android.internal.R.styleable.View_tag:
3274 mTag = a.getText(attr);
3275 break;
3276 case com.android.internal.R.styleable.View_fitsSystemWindows:
3277 if (a.getBoolean(attr, false)) {
3278 viewFlagValues |= FITS_SYSTEM_WINDOWS;
3279 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
3280 }
3281 break;
3282 case com.android.internal.R.styleable.View_focusable:
3283 if (a.getBoolean(attr, false)) {
3284 viewFlagValues |= FOCUSABLE;
3285 viewFlagMasks |= FOCUSABLE_MASK;
3286 }
3287 break;
3288 case com.android.internal.R.styleable.View_focusableInTouchMode:
3289 if (a.getBoolean(attr, false)) {
3290 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
3291 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
3292 }
3293 break;
3294 case com.android.internal.R.styleable.View_clickable:
3295 if (a.getBoolean(attr, false)) {
3296 viewFlagValues |= CLICKABLE;
3297 viewFlagMasks |= CLICKABLE;
3298 }
3299 break;
3300 case com.android.internal.R.styleable.View_longClickable:
3301 if (a.getBoolean(attr, false)) {
3302 viewFlagValues |= LONG_CLICKABLE;
3303 viewFlagMasks |= LONG_CLICKABLE;
3304 }
3305 break;
3306 case com.android.internal.R.styleable.View_saveEnabled:
3307 if (!a.getBoolean(attr, true)) {
3308 viewFlagValues |= SAVE_DISABLED;
3309 viewFlagMasks |= SAVE_DISABLED_MASK;
3310 }
3311 break;
3312 case com.android.internal.R.styleable.View_duplicateParentState:
3313 if (a.getBoolean(attr, false)) {
3314 viewFlagValues |= DUPLICATE_PARENT_STATE;
3315 viewFlagMasks |= DUPLICATE_PARENT_STATE;
3316 }
3317 break;
3318 case com.android.internal.R.styleable.View_visibility:
3319 final int visibility = a.getInt(attr, 0);
3320 if (visibility != 0) {
3321 viewFlagValues |= VISIBILITY_FLAGS[visibility];
3322 viewFlagMasks |= VISIBILITY_MASK;
3323 }
3324 break;
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07003325 case com.android.internal.R.styleable.View_layoutDirection:
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003326 // Clear any layout direction flags (included resolved bits) already set
3327 mPrivateFlags2 &= ~(LAYOUT_DIRECTION_MASK | LAYOUT_DIRECTION_RESOLVED_MASK);
3328 // Set the layout direction flags depending on the value of the attribute
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07003329 final int layoutDirection = a.getInt(attr, -1);
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003330 final int value = (layoutDirection != -1) ?
3331 LAYOUT_DIRECTION_FLAGS[layoutDirection] : LAYOUT_DIRECTION_DEFAULT;
3332 mPrivateFlags2 |= (value << LAYOUT_DIRECTION_MASK_SHIFT);
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07003333 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003334 case com.android.internal.R.styleable.View_drawingCacheQuality:
3335 final int cacheQuality = a.getInt(attr, 0);
3336 if (cacheQuality != 0) {
3337 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
3338 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
3339 }
3340 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07003341 case com.android.internal.R.styleable.View_contentDescription:
3342 mContentDescription = a.getString(attr);
3343 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003344 case com.android.internal.R.styleable.View_soundEffectsEnabled:
3345 if (!a.getBoolean(attr, true)) {
3346 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
3347 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
3348 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07003349 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003350 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
3351 if (!a.getBoolean(attr, true)) {
3352 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
3353 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
3354 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07003355 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003356 case R.styleable.View_scrollbars:
3357 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
3358 if (scrollbars != SCROLLBARS_NONE) {
3359 viewFlagValues |= scrollbars;
3360 viewFlagMasks |= SCROLLBARS_MASK;
3361 initializeScrollbars(a);
3362 }
3363 break;
Romain Guy2a9fa892011-09-28 16:50:02 -07003364 //noinspection deprecation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003365 case R.styleable.View_fadingEdge:
Romain Guy1ef3fdb2011-09-09 15:30:30 -07003366 if (context.getApplicationInfo().targetSdkVersion >= ICE_CREAM_SANDWICH) {
3367 // Ignore the attribute starting with ICS
3368 break;
3369 }
3370 // With builds < ICS, fall through and apply fading edges
3371 case R.styleable.View_requiresFadingEdge:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003372 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
3373 if (fadingEdge != FADING_EDGE_NONE) {
3374 viewFlagValues |= fadingEdge;
3375 viewFlagMasks |= FADING_EDGE_MASK;
3376 initializeFadingEdge(a);
3377 }
3378 break;
3379 case R.styleable.View_scrollbarStyle:
3380 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
3381 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
3382 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
3383 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
3384 }
3385 break;
3386 case R.styleable.View_isScrollContainer:
3387 setScrollContainer = true;
3388 if (a.getBoolean(attr, false)) {
3389 setScrollContainer(true);
3390 }
3391 break;
3392 case com.android.internal.R.styleable.View_keepScreenOn:
3393 if (a.getBoolean(attr, false)) {
3394 viewFlagValues |= KEEP_SCREEN_ON;
3395 viewFlagMasks |= KEEP_SCREEN_ON;
3396 }
3397 break;
Jeff Brown85a31762010-09-01 17:01:00 -07003398 case R.styleable.View_filterTouchesWhenObscured:
3399 if (a.getBoolean(attr, false)) {
3400 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED;
3401 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED;
3402 }
3403 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003404 case R.styleable.View_nextFocusLeft:
3405 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
3406 break;
3407 case R.styleable.View_nextFocusRight:
3408 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
3409 break;
3410 case R.styleable.View_nextFocusUp:
3411 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
3412 break;
3413 case R.styleable.View_nextFocusDown:
3414 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
3415 break;
Jeff Brown4e6319b2010-12-13 10:36:51 -08003416 case R.styleable.View_nextFocusForward:
3417 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID);
3418 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003419 case R.styleable.View_minWidth:
3420 mMinWidth = a.getDimensionPixelSize(attr, 0);
3421 break;
3422 case R.styleable.View_minHeight:
3423 mMinHeight = a.getDimensionPixelSize(attr, 0);
3424 break;
Romain Guy9a817362009-05-01 10:57:14 -07003425 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07003426 if (context.isRestricted()) {
Joe Malin32736f02011-01-19 16:14:20 -08003427 throw new IllegalStateException("The android:onClick attribute cannot "
Romain Guy870e09f2009-07-06 16:35:25 -07003428 + "be used within a restricted context");
3429 }
3430
Romain Guy9a817362009-05-01 10:57:14 -07003431 final String handlerName = a.getString(attr);
3432 if (handlerName != null) {
3433 setOnClickListener(new OnClickListener() {
3434 private Method mHandler;
3435
3436 public void onClick(View v) {
3437 if (mHandler == null) {
3438 try {
3439 mHandler = getContext().getClass().getMethod(handlerName,
3440 View.class);
3441 } catch (NoSuchMethodException e) {
Joe Onorato42e14d72010-03-11 14:51:17 -08003442 int id = getId();
3443 String idText = id == NO_ID ? "" : " with id '"
3444 + getContext().getResources().getResourceEntryName(
3445 id) + "'";
Romain Guy9a817362009-05-01 10:57:14 -07003446 throw new IllegalStateException("Could not find a method " +
Joe Onorato42e14d72010-03-11 14:51:17 -08003447 handlerName + "(View) in the activity "
3448 + getContext().getClass() + " for onClick handler"
3449 + " on view " + View.this.getClass() + idText, e);
Romain Guy9a817362009-05-01 10:57:14 -07003450 }
3451 }
3452
3453 try {
3454 mHandler.invoke(getContext(), View.this);
3455 } catch (IllegalAccessException e) {
3456 throw new IllegalStateException("Could not execute non "
3457 + "public method of the activity", e);
3458 } catch (InvocationTargetException e) {
3459 throw new IllegalStateException("Could not execute "
3460 + "method of the activity", e);
3461 }
3462 }
3463 });
3464 }
3465 break;
Adam Powell637d3372010-08-25 14:37:03 -07003466 case R.styleable.View_overScrollMode:
3467 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS);
3468 break;
Adam Powell20232d02010-12-08 21:08:53 -08003469 case R.styleable.View_verticalScrollbarPosition:
3470 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT);
3471 break;
Romain Guy171c5922011-01-06 10:04:23 -08003472 case R.styleable.View_layerType:
3473 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null);
3474 break;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07003475 case R.styleable.View_textDirection:
Fabrice Di Megliob934db72012-03-20 14:33:01 -07003476 // Clear any text direction flag already set
3477 mPrivateFlags2 &= ~TEXT_DIRECTION_MASK;
3478 // Set the text direction flags depending on the value of the attribute
3479 final int textDirection = a.getInt(attr, -1);
3480 if (textDirection != -1) {
3481 mPrivateFlags2 |= TEXT_DIRECTION_FLAGS[textDirection];
3482 }
Fabrice Di Meglio22268862011-06-27 18:13:18 -07003483 break;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07003484 case R.styleable.View_textAlignment:
3485 // Clear any text alignment flag already set
3486 mPrivateFlags2 &= ~TEXT_ALIGNMENT_MASK;
3487 // Set the text alignment flag depending on the value of the attribute
3488 final int textAlignment = a.getInt(attr, TEXT_ALIGNMENT_DEFAULT);
3489 mPrivateFlags2 |= TEXT_ALIGNMENT_FLAGS[textAlignment];
3490 break;
Svetoslav Ganov42138042012-03-20 11:51:39 -07003491 case R.styleable.View_importantForAccessibility:
3492 setImportantForAccessibility(a.getInt(attr,
3493 IMPORTANT_FOR_ACCESSIBILITY_DEFAULT));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003494 }
3495 }
3496
Dianne Hackbornab0f4852011-09-12 16:59:06 -07003497 a.recycle();
3498
Adam Powell637d3372010-08-25 14:37:03 -07003499 setOverScrollMode(overScrollMode);
3500
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003501 if (background != null) {
Philip Milne6c8ea062012-04-03 17:38:43 -07003502 setBackground(background);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003503 }
3504
Fabrice Di Megliof9e36502011-06-21 18:41:48 -07003505 // Cache user padding as we cannot fully resolve padding here (we dont have yet the resolved
3506 // layout direction). Those cached values will be used later during padding resolution.
3507 mUserPaddingStart = startPadding;
3508 mUserPaddingEnd = endPadding;
3509
Fabrice Di Meglio509708d2012-03-06 15:41:11 -08003510 updateUserPaddingRelative();
3511
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003512 if (padding >= 0) {
3513 leftPadding = padding;
3514 topPadding = padding;
3515 rightPadding = padding;
3516 bottomPadding = padding;
3517 }
3518
3519 // If the user specified the padding (either with android:padding or
3520 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
3521 // use the default padding or the padding from the background drawable
3522 // (stored at this point in mPadding*)
3523 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
3524 topPadding >= 0 ? topPadding : mPaddingTop,
3525 rightPadding >= 0 ? rightPadding : mPaddingRight,
3526 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
3527
3528 if (viewFlagMasks != 0) {
3529 setFlags(viewFlagValues, viewFlagMasks);
3530 }
3531
3532 // Needs to be called after mViewFlags is set
3533 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
3534 recomputePadding();
3535 }
3536
3537 if (x != 0 || y != 0) {
3538 scrollTo(x, y);
3539 }
3540
Chet Haase73066682010-11-29 15:55:32 -08003541 if (transformSet) {
3542 setTranslationX(tx);
3543 setTranslationY(ty);
3544 setRotation(rotation);
3545 setRotationX(rotationX);
3546 setRotationY(rotationY);
3547 setScaleX(sx);
3548 setScaleY(sy);
3549 }
3550
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003551 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
3552 setScrollContainer(true);
3553 }
Romain Guy8f1344f52009-05-15 16:03:59 -07003554
3555 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003556 }
3557
Fabrice Di Meglio509708d2012-03-06 15:41:11 -08003558 private void updateUserPaddingRelative() {
3559 mUserPaddingRelative = (mUserPaddingStart >= 0 || mUserPaddingEnd >= 0);
3560 }
3561
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003562 /**
3563 * Non-public constructor for use in testing
3564 */
3565 View() {
Dianne Hackbornab0f4852011-09-12 16:59:06 -07003566 mResources = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003567 }
3568
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003569 /**
3570 * <p>
3571 * Initializes the fading edges from a given set of styled attributes. This
3572 * method should be called by subclasses that need fading edges and when an
3573 * instance of these subclasses is created programmatically rather than
3574 * being inflated from XML. This method is automatically called when the XML
3575 * is inflated.
3576 * </p>
3577 *
3578 * @param a the styled attributes set to initialize the fading edges from
3579 */
3580 protected void initializeFadingEdge(TypedArray a) {
3581 initScrollCache();
3582
3583 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
3584 R.styleable.View_fadingEdgeLength,
3585 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
3586 }
3587
3588 /**
3589 * Returns the size of the vertical faded edges used to indicate that more
3590 * content in this view is visible.
3591 *
3592 * @return The size in pixels of the vertical faded edge or 0 if vertical
3593 * faded edges are not enabled for this view.
3594 * @attr ref android.R.styleable#View_fadingEdgeLength
3595 */
3596 public int getVerticalFadingEdgeLength() {
3597 if (isVerticalFadingEdgeEnabled()) {
3598 ScrollabilityCache cache = mScrollCache;
3599 if (cache != null) {
3600 return cache.fadingEdgeLength;
3601 }
3602 }
3603 return 0;
3604 }
3605
3606 /**
3607 * Set the size of the faded edge used to indicate that more content in this
3608 * view is available. Will not change whether the fading edge is enabled; use
Romain Guy5c22a8c2011-05-13 11:48:45 -07003609 * {@link #setVerticalFadingEdgeEnabled(boolean)} or
3610 * {@link #setHorizontalFadingEdgeEnabled(boolean)} to enable the fading edge
3611 * for the vertical or horizontal fading edges.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003612 *
3613 * @param length The size in pixels of the faded edge used to indicate that more
3614 * content in this view is visible.
3615 */
3616 public void setFadingEdgeLength(int length) {
3617 initScrollCache();
3618 mScrollCache.fadingEdgeLength = length;
3619 }
3620
3621 /**
3622 * Returns the size of the horizontal faded edges used to indicate that more
3623 * content in this view is visible.
3624 *
3625 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
3626 * faded edges are not enabled for this view.
3627 * @attr ref android.R.styleable#View_fadingEdgeLength
3628 */
3629 public int getHorizontalFadingEdgeLength() {
3630 if (isHorizontalFadingEdgeEnabled()) {
3631 ScrollabilityCache cache = mScrollCache;
3632 if (cache != null) {
3633 return cache.fadingEdgeLength;
3634 }
3635 }
3636 return 0;
3637 }
3638
3639 /**
3640 * Returns the width of the vertical scrollbar.
3641 *
3642 * @return The width in pixels of the vertical scrollbar or 0 if there
3643 * is no vertical scrollbar.
3644 */
3645 public int getVerticalScrollbarWidth() {
3646 ScrollabilityCache cache = mScrollCache;
3647 if (cache != null) {
3648 ScrollBarDrawable scrollBar = cache.scrollBar;
3649 if (scrollBar != null) {
3650 int size = scrollBar.getSize(true);
3651 if (size <= 0) {
3652 size = cache.scrollBarSize;
3653 }
3654 return size;
3655 }
3656 return 0;
3657 }
3658 return 0;
3659 }
3660
3661 /**
3662 * Returns the height of the horizontal scrollbar.
3663 *
3664 * @return The height in pixels of the horizontal scrollbar or 0 if
3665 * there is no horizontal scrollbar.
3666 */
3667 protected int getHorizontalScrollbarHeight() {
3668 ScrollabilityCache cache = mScrollCache;
3669 if (cache != null) {
3670 ScrollBarDrawable scrollBar = cache.scrollBar;
3671 if (scrollBar != null) {
3672 int size = scrollBar.getSize(false);
3673 if (size <= 0) {
3674 size = cache.scrollBarSize;
3675 }
3676 return size;
3677 }
3678 return 0;
3679 }
3680 return 0;
3681 }
3682
3683 /**
3684 * <p>
3685 * Initializes the scrollbars from a given set of styled attributes. This
3686 * method should be called by subclasses that need scrollbars and when an
3687 * instance of these subclasses is created programmatically rather than
3688 * being inflated from XML. This method is automatically called when the XML
3689 * is inflated.
3690 * </p>
3691 *
3692 * @param a the styled attributes set to initialize the scrollbars from
3693 */
3694 protected void initializeScrollbars(TypedArray a) {
3695 initScrollCache();
3696
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003697 final ScrollabilityCache scrollabilityCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08003698
Mike Cleronf116bf82009-09-27 19:14:12 -07003699 if (scrollabilityCache.scrollBar == null) {
3700 scrollabilityCache.scrollBar = new ScrollBarDrawable();
3701 }
Joe Malin32736f02011-01-19 16:14:20 -08003702
Romain Guy8bda2482010-03-02 11:42:11 -08003703 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003704
Mike Cleronf116bf82009-09-27 19:14:12 -07003705 if (!fadeScrollbars) {
3706 scrollabilityCache.state = ScrollabilityCache.ON;
3707 }
3708 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Joe Malin32736f02011-01-19 16:14:20 -08003709
3710
Mike Cleronf116bf82009-09-27 19:14:12 -07003711 scrollabilityCache.scrollBarFadeDuration = a.getInt(
3712 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
3713 .getScrollBarFadeDuration());
3714 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
3715 R.styleable.View_scrollbarDefaultDelayBeforeFade,
3716 ViewConfiguration.getScrollDefaultDelay());
3717
Joe Malin32736f02011-01-19 16:14:20 -08003718
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003719 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
3720 com.android.internal.R.styleable.View_scrollbarSize,
3721 ViewConfiguration.get(mContext).getScaledScrollBarSize());
3722
3723 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
3724 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
3725
3726 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
3727 if (thumb != null) {
3728 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
3729 }
3730
3731 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
3732 false);
3733 if (alwaysDraw) {
3734 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
3735 }
3736
3737 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
3738 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
3739
3740 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
3741 if (thumb != null) {
3742 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
3743 }
3744
3745 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
3746 false);
3747 if (alwaysDraw) {
3748 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
3749 }
3750
3751 // Re-apply user/background padding so that scrollbar(s) get added
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003752 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003753 }
3754
3755 /**
3756 * <p>
3757 * Initalizes the scrollability cache if necessary.
3758 * </p>
3759 */
3760 private void initScrollCache() {
3761 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07003762 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003763 }
3764 }
3765
Philip Milne6c8ea062012-04-03 17:38:43 -07003766 private ScrollabilityCache getScrollCache() {
3767 initScrollCache();
3768 return mScrollCache;
3769 }
3770
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003771 /**
Adam Powell20232d02010-12-08 21:08:53 -08003772 * Set the position of the vertical scroll bar. Should be one of
3773 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or
3774 * {@link #SCROLLBAR_POSITION_RIGHT}.
3775 *
3776 * @param position Where the vertical scroll bar should be positioned.
3777 */
3778 public void setVerticalScrollbarPosition(int position) {
3779 if (mVerticalScrollbarPosition != position) {
3780 mVerticalScrollbarPosition = position;
3781 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003782 resolvePadding();
Adam Powell20232d02010-12-08 21:08:53 -08003783 }
3784 }
3785
3786 /**
3787 * @return The position where the vertical scroll bar will show, if applicable.
3788 * @see #setVerticalScrollbarPosition(int)
3789 */
3790 public int getVerticalScrollbarPosition() {
3791 return mVerticalScrollbarPosition;
3792 }
3793
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003794 ListenerInfo getListenerInfo() {
3795 if (mListenerInfo != null) {
3796 return mListenerInfo;
3797 }
3798 mListenerInfo = new ListenerInfo();
3799 return mListenerInfo;
3800 }
3801
Adam Powell20232d02010-12-08 21:08:53 -08003802 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003803 * Register a callback to be invoked when focus of this view changed.
3804 *
3805 * @param l The callback that will run.
3806 */
3807 public void setOnFocusChangeListener(OnFocusChangeListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003808 getListenerInfo().mOnFocusChangeListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003809 }
3810
3811 /**
Chet Haase21cd1382010-09-01 17:42:29 -07003812 * Add a listener that will be called when the bounds of the view change due to
3813 * layout processing.
3814 *
3815 * @param listener The listener that will be called when layout bounds change.
3816 */
3817 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003818 ListenerInfo li = getListenerInfo();
3819 if (li.mOnLayoutChangeListeners == null) {
3820 li.mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>();
Chet Haase21cd1382010-09-01 17:42:29 -07003821 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003822 if (!li.mOnLayoutChangeListeners.contains(listener)) {
3823 li.mOnLayoutChangeListeners.add(listener);
Chet Haase1a76dcd2011-10-06 11:16:40 -07003824 }
Chet Haase21cd1382010-09-01 17:42:29 -07003825 }
3826
3827 /**
3828 * Remove a listener for layout changes.
3829 *
3830 * @param listener The listener for layout bounds change.
3831 */
3832 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003833 ListenerInfo li = mListenerInfo;
3834 if (li == null || li.mOnLayoutChangeListeners == null) {
Chet Haase21cd1382010-09-01 17:42:29 -07003835 return;
3836 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003837 li.mOnLayoutChangeListeners.remove(listener);
Chet Haase21cd1382010-09-01 17:42:29 -07003838 }
3839
3840 /**
Adam Powell4afd62b2011-02-18 15:02:18 -08003841 * Add a listener for attach state changes.
3842 *
3843 * This listener will be called whenever this view is attached or detached
3844 * from a window. Remove the listener using
3845 * {@link #removeOnAttachStateChangeListener(OnAttachStateChangeListener)}.
3846 *
3847 * @param listener Listener to attach
3848 * @see #removeOnAttachStateChangeListener(OnAttachStateChangeListener)
3849 */
3850 public void addOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003851 ListenerInfo li = getListenerInfo();
3852 if (li.mOnAttachStateChangeListeners == null) {
3853 li.mOnAttachStateChangeListeners
3854 = new CopyOnWriteArrayList<OnAttachStateChangeListener>();
Adam Powell4afd62b2011-02-18 15:02:18 -08003855 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003856 li.mOnAttachStateChangeListeners.add(listener);
Adam Powell4afd62b2011-02-18 15:02:18 -08003857 }
3858
3859 /**
3860 * Remove a listener for attach state changes. The listener will receive no further
3861 * notification of window attach/detach events.
3862 *
3863 * @param listener Listener to remove
3864 * @see #addOnAttachStateChangeListener(OnAttachStateChangeListener)
3865 */
3866 public void removeOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003867 ListenerInfo li = mListenerInfo;
3868 if (li == null || li.mOnAttachStateChangeListeners == null) {
Adam Powell4afd62b2011-02-18 15:02:18 -08003869 return;
3870 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003871 li.mOnAttachStateChangeListeners.remove(listener);
Adam Powell4afd62b2011-02-18 15:02:18 -08003872 }
3873
3874 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003875 * Returns the focus-change callback registered for this view.
3876 *
3877 * @return The callback, or null if one is not registered.
3878 */
3879 public OnFocusChangeListener getOnFocusChangeListener() {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003880 ListenerInfo li = mListenerInfo;
3881 return li != null ? li.mOnFocusChangeListener : null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003882 }
3883
3884 /**
3885 * Register a callback to be invoked when this view is clicked. If this view is not
3886 * clickable, it becomes clickable.
3887 *
3888 * @param l The callback that will run
3889 *
3890 * @see #setClickable(boolean)
3891 */
3892 public void setOnClickListener(OnClickListener l) {
3893 if (!isClickable()) {
3894 setClickable(true);
3895 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003896 getListenerInfo().mOnClickListener = l;
3897 }
3898
3899 /**
3900 * Return whether this view has an attached OnClickListener. Returns
3901 * true if there is a listener, false if there is none.
3902 */
3903 public boolean hasOnClickListeners() {
3904 ListenerInfo li = mListenerInfo;
3905 return (li != null && li.mOnClickListener != null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003906 }
3907
3908 /**
3909 * Register a callback to be invoked when this view is clicked and held. If this view is not
3910 * long clickable, it becomes long clickable.
3911 *
3912 * @param l The callback that will run
3913 *
3914 * @see #setLongClickable(boolean)
3915 */
3916 public void setOnLongClickListener(OnLongClickListener l) {
3917 if (!isLongClickable()) {
3918 setLongClickable(true);
3919 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003920 getListenerInfo().mOnLongClickListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003921 }
3922
3923 /**
3924 * Register a callback to be invoked when the context menu for this view is
3925 * being built. If this view is not long clickable, it becomes long clickable.
3926 *
3927 * @param l The callback that will run
3928 *
3929 */
3930 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
3931 if (!isLongClickable()) {
3932 setLongClickable(true);
3933 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003934 getListenerInfo().mOnCreateContextMenuListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003935 }
3936
3937 /**
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003938 * Call this view's OnClickListener, if it is defined. Performs all normal
3939 * actions associated with clicking: reporting accessibility event, playing
3940 * a sound, etc.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003941 *
3942 * @return True there was an assigned OnClickListener that was called, false
3943 * otherwise is returned.
3944 */
3945 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003946 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
3947
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003948 ListenerInfo li = mListenerInfo;
3949 if (li != null && li.mOnClickListener != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003950 playSoundEffect(SoundEffectConstants.CLICK);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003951 li.mOnClickListener.onClick(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003952 return true;
3953 }
3954
3955 return false;
3956 }
3957
3958 /**
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003959 * Directly call any attached OnClickListener. Unlike {@link #performClick()},
3960 * this only calls the listener, and does not do any associated clicking
3961 * actions like reporting an accessibility event.
3962 *
3963 * @return True there was an assigned OnClickListener that was called, false
3964 * otherwise is returned.
3965 */
3966 public boolean callOnClick() {
3967 ListenerInfo li = mListenerInfo;
3968 if (li != null && li.mOnClickListener != null) {
3969 li.mOnClickListener.onClick(this);
3970 return true;
3971 }
3972 return false;
3973 }
3974
3975 /**
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003976 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the
3977 * OnLongClickListener did not consume the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003978 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07003979 * @return True if one of the above receivers consumed the event, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003980 */
3981 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003982 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
3983
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003984 boolean handled = false;
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003985 ListenerInfo li = mListenerInfo;
3986 if (li != null && li.mOnLongClickListener != null) {
3987 handled = li.mOnLongClickListener.onLongClick(View.this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003988 }
3989 if (!handled) {
3990 handled = showContextMenu();
3991 }
3992 if (handled) {
3993 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
3994 }
3995 return handled;
3996 }
3997
3998 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07003999 * Performs button-related actions during a touch down event.
4000 *
4001 * @param event The event.
4002 * @return True if the down was consumed.
4003 *
4004 * @hide
4005 */
4006 protected boolean performButtonActionOnTouchDown(MotionEvent event) {
4007 if ((event.getButtonState() & MotionEvent.BUTTON_SECONDARY) != 0) {
4008 if (showContextMenu(event.getX(), event.getY(), event.getMetaState())) {
4009 return true;
4010 }
4011 }
4012 return false;
4013 }
4014
4015 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004016 * Bring up the context menu for this view.
4017 *
4018 * @return Whether a context menu was displayed.
4019 */
4020 public boolean showContextMenu() {
4021 return getParent().showContextMenuForChild(this);
4022 }
4023
4024 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07004025 * Bring up the context menu for this view, referring to the item under the specified point.
4026 *
4027 * @param x The referenced x coordinate.
4028 * @param y The referenced y coordinate.
4029 * @param metaState The keyboard modifiers that were pressed.
4030 * @return Whether a context menu was displayed.
4031 *
4032 * @hide
4033 */
4034 public boolean showContextMenu(float x, float y, int metaState) {
4035 return showContextMenu();
4036 }
4037
4038 /**
Adam Powell6e346362010-07-23 10:18:23 -07004039 * Start an action mode.
4040 *
4041 * @param callback Callback that will control the lifecycle of the action mode
4042 * @return The new action mode if it is started, null otherwise
4043 *
4044 * @see ActionMode
4045 */
4046 public ActionMode startActionMode(ActionMode.Callback callback) {
John Reck5160e2a2012-02-22 09:35:12 -08004047 ViewParent parent = getParent();
4048 if (parent == null) return null;
4049 return parent.startActionModeForChild(this, callback);
Adam Powell6e346362010-07-23 10:18:23 -07004050 }
4051
4052 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004053 * Register a callback to be invoked when a key is pressed in this view.
4054 * @param l the key listener to attach to this view
4055 */
4056 public void setOnKeyListener(OnKeyListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004057 getListenerInfo().mOnKeyListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004058 }
4059
4060 /**
4061 * Register a callback to be invoked when a touch event is sent to this view.
4062 * @param l the touch listener to attach to this view
4063 */
4064 public void setOnTouchListener(OnTouchListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004065 getListenerInfo().mOnTouchListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004066 }
4067
4068 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08004069 * Register a callback to be invoked when a generic motion event is sent to this view.
4070 * @param l the generic motion listener to attach to this view
4071 */
4072 public void setOnGenericMotionListener(OnGenericMotionListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004073 getListenerInfo().mOnGenericMotionListener = l;
Jeff Brown33bbfd22011-02-24 20:55:35 -08004074 }
4075
4076 /**
Jeff Brown53ca3f12011-06-27 18:36:00 -07004077 * Register a callback to be invoked when a hover event is sent to this view.
4078 * @param l the hover listener to attach to this view
4079 */
4080 public void setOnHoverListener(OnHoverListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004081 getListenerInfo().mOnHoverListener = l;
Jeff Brown53ca3f12011-06-27 18:36:00 -07004082 }
4083
4084 /**
Joe Malin32736f02011-01-19 16:14:20 -08004085 * Register a drag event listener callback object for this View. The parameter is
4086 * an implementation of {@link android.view.View.OnDragListener}. To send a drag event to a
4087 * View, the system calls the
4088 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent)} method.
4089 * @param l An implementation of {@link android.view.View.OnDragListener}.
Chris Tate32affef2010-10-18 15:29:21 -07004090 */
4091 public void setOnDragListener(OnDragListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004092 getListenerInfo().mOnDragListener = l;
Chris Tate32affef2010-10-18 15:29:21 -07004093 }
4094
4095 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07004096 * Give this view focus. This will cause
4097 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004098 *
4099 * Note: this does not check whether this {@link View} should get focus, it just
4100 * gives it focus no matter what. It should only be called internally by framework
4101 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
4102 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08004103 * @param direction values are {@link View#FOCUS_UP}, {@link View#FOCUS_DOWN},
4104 * {@link View#FOCUS_LEFT} or {@link View#FOCUS_RIGHT}. This is the direction which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004105 * focus moved when requestFocus() is called. It may not always
4106 * apply, in which case use the default View.FOCUS_DOWN.
4107 * @param previouslyFocusedRect The rectangle of the view that had focus
4108 * prior in this View's coordinate system.
4109 */
4110 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
4111 if (DBG) {
4112 System.out.println(this + " requestFocus()");
4113 }
4114
4115 if ((mPrivateFlags & FOCUSED) == 0) {
4116 mPrivateFlags |= FOCUSED;
4117
4118 if (mParent != null) {
4119 mParent.requestChildFocus(this, this);
4120 }
4121
4122 onFocusChanged(true, direction, previouslyFocusedRect);
4123 refreshDrawableState();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004124
4125 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4126 notifyAccessibilityStateChanged();
4127 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004128 }
4129 }
4130
4131 /**
4132 * Request that a rectangle of this view be visible on the screen,
4133 * scrolling if necessary just enough.
4134 *
4135 * <p>A View should call this if it maintains some notion of which part
4136 * of its content is interesting. For example, a text editing view
4137 * should call this when its cursor moves.
4138 *
4139 * @param rectangle The rectangle.
4140 * @return Whether any parent scrolled.
4141 */
4142 public boolean requestRectangleOnScreen(Rect rectangle) {
4143 return requestRectangleOnScreen(rectangle, false);
4144 }
4145
4146 /**
4147 * Request that a rectangle of this view be visible on the screen,
4148 * scrolling if necessary just enough.
4149 *
4150 * <p>A View should call this if it maintains some notion of which part
4151 * of its content is interesting. For example, a text editing view
4152 * should call this when its cursor moves.
4153 *
4154 * <p>When <code>immediate</code> is set to true, scrolling will not be
4155 * animated.
4156 *
4157 * @param rectangle The rectangle.
4158 * @param immediate True to forbid animated scrolling, false otherwise
4159 * @return Whether any parent scrolled.
4160 */
4161 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
4162 View child = this;
4163 ViewParent parent = mParent;
4164 boolean scrolled = false;
4165 while (parent != null) {
4166 scrolled |= parent.requestChildRectangleOnScreen(child,
4167 rectangle, immediate);
4168
4169 // offset rect so next call has the rectangle in the
4170 // coordinate system of its direct child.
4171 rectangle.offset(child.getLeft(), child.getTop());
4172 rectangle.offset(-child.getScrollX(), -child.getScrollY());
4173
4174 if (!(parent instanceof View)) {
4175 break;
4176 }
Romain Guy8506ab42009-06-11 17:35:47 -07004177
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004178 child = (View) parent;
4179 parent = child.getParent();
4180 }
4181 return scrolled;
4182 }
4183
4184 /**
Svetoslav Ganov13fd5612012-02-01 17:01:12 -08004185 * Called when this view wants to give up focus. If focus is cleared
4186 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} is called.
4187 * <p>
4188 * <strong>Note:</strong> When a View clears focus the framework is trying
4189 * to give focus to the first focusable View from the top. Hence, if this
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004190 * View is the first from the top that can take focus, then all callbacks
4191 * related to clearing focus will be invoked after wich the framework will
4192 * give focus to this view.
Svetoslav Ganov13fd5612012-02-01 17:01:12 -08004193 * </p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004194 */
4195 public void clearFocus() {
4196 if (DBG) {
4197 System.out.println(this + " clearFocus()");
4198 }
4199
4200 if ((mPrivateFlags & FOCUSED) != 0) {
4201 mPrivateFlags &= ~FOCUSED;
4202
4203 if (mParent != null) {
4204 mParent.clearChildFocus(this);
4205 }
4206
4207 onFocusChanged(false, 0, null);
Svetoslav Ganov42138042012-03-20 11:51:39 -07004208
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004209 refreshDrawableState();
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004210
4211 ensureInputFocusOnFirstFocusable();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004212
4213 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4214 notifyAccessibilityStateChanged();
4215 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004216 }
4217 }
4218
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004219 void ensureInputFocusOnFirstFocusable() {
4220 View root = getRootView();
4221 if (root != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004222 root.requestFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004223 }
4224 }
4225
4226 /**
4227 * Called internally by the view system when a new view is getting focus.
4228 * This is what clears the old focus.
4229 */
4230 void unFocus() {
4231 if (DBG) {
4232 System.out.println(this + " unFocus()");
4233 }
4234
4235 if ((mPrivateFlags & FOCUSED) != 0) {
4236 mPrivateFlags &= ~FOCUSED;
4237
4238 onFocusChanged(false, 0, null);
4239 refreshDrawableState();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004240
4241 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4242 notifyAccessibilityStateChanged();
4243 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004244 }
4245 }
4246
4247 /**
4248 * Returns true if this view has focus iteself, or is the ancestor of the
4249 * view that has focus.
4250 *
4251 * @return True if this view has or contains focus, false otherwise.
4252 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004253 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004254 public boolean hasFocus() {
4255 return (mPrivateFlags & FOCUSED) != 0;
4256 }
4257
4258 /**
4259 * Returns true if this view is focusable or if it contains a reachable View
4260 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
4261 * is a View whose parents do not block descendants focus.
4262 *
4263 * Only {@link #VISIBLE} views are considered focusable.
4264 *
4265 * @return True if the view is focusable or if the view contains a focusable
4266 * View, false otherwise.
4267 *
4268 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
4269 */
4270 public boolean hasFocusable() {
4271 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
4272 }
4273
4274 /**
4275 * Called by the view system when the focus state of this view changes.
4276 * When the focus change event is caused by directional navigation, direction
4277 * and previouslyFocusedRect provide insight into where the focus is coming from.
4278 * When overriding, be sure to call up through to the super class so that
4279 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07004280 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004281 * @param gainFocus True if the View has focus; false otherwise.
4282 * @param direction The direction focus has moved when requestFocus()
4283 * is called to give this view focus. Values are
Jeff Brown4e6319b2010-12-13 10:36:51 -08004284 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT},
4285 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}.
4286 * It may not always apply, in which case use the default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004287 * @param previouslyFocusedRect The rectangle, in this view's coordinate
4288 * system, of the previously focused view. If applicable, this will be
4289 * passed in as finer grained information about where the focus is coming
4290 * from (in addition to direction). Will be <code>null</code> otherwise.
4291 */
4292 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004293 if (gainFocus) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004294 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4295 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
4296 requestAccessibilityFocus();
4297 }
svetoslavganov75986cf2009-05-14 22:28:01 -07004298 }
4299
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004300 InputMethodManager imm = InputMethodManager.peekInstance();
4301 if (!gainFocus) {
4302 if (isPressed()) {
4303 setPressed(false);
4304 }
4305 if (imm != null && mAttachInfo != null
4306 && mAttachInfo.mHasWindowFocus) {
4307 imm.focusOut(this);
4308 }
Romain Guya2431d02009-04-30 16:30:00 -07004309 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004310 } else if (imm != null && mAttachInfo != null
4311 && mAttachInfo.mHasWindowFocus) {
4312 imm.focusIn(this);
4313 }
Romain Guy8506ab42009-06-11 17:35:47 -07004314
Romain Guy0fd89bf2011-01-26 15:41:30 -08004315 invalidate(true);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004316 ListenerInfo li = mListenerInfo;
4317 if (li != null && li.mOnFocusChangeListener != null) {
4318 li.mOnFocusChangeListener.onFocusChange(this, gainFocus);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004319 }
Joe Malin32736f02011-01-19 16:14:20 -08004320
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004321 if (mAttachInfo != null) {
4322 mAttachInfo.mKeyDispatchState.reset(this);
4323 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004324 }
4325
4326 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004327 * Sends an accessibility event of the given type. If accessiiblity is
4328 * not enabled this method has no effect. The default implementation calls
4329 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)} first
4330 * to populate information about the event source (this View), then calls
4331 * {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} to
4332 * populate the text content of the event source including its descendants,
4333 * and last calls
4334 * {@link ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)}
4335 * on its parent to resuest sending of the event to interested parties.
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004336 * <p>
4337 * If an {@link AccessibilityDelegate} has been specified via calling
4338 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4339 * {@link AccessibilityDelegate#sendAccessibilityEvent(View, int)} is
4340 * responsible for handling this call.
4341 * </p>
Svetoslav Ganov30401322011-05-12 18:53:45 -07004342 *
Scott Mainb303d832011-10-12 16:45:18 -07004343 * @param eventType The type of the event to send, as defined by several types from
4344 * {@link android.view.accessibility.AccessibilityEvent}, such as
4345 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_CLICKED} or
4346 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_HOVER_ENTER}.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004347 *
4348 * @see #onInitializeAccessibilityEvent(AccessibilityEvent)
4349 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4350 * @see ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004351 * @see AccessibilityDelegate
svetoslavganov75986cf2009-05-14 22:28:01 -07004352 */
4353 public void sendAccessibilityEvent(int eventType) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004354 if (mAccessibilityDelegate != null) {
4355 mAccessibilityDelegate.sendAccessibilityEvent(this, eventType);
4356 } else {
4357 sendAccessibilityEventInternal(eventType);
4358 }
4359 }
4360
4361 /**
Svetoslav Ganov51ab90c2012-03-09 10:54:49 -08004362 * Convenience method for sending a {@link AccessibilityEvent#TYPE_ANNOUNCEMENT}
4363 * {@link AccessibilityEvent} to make an announcement which is related to some
4364 * sort of a context change for which none of the events representing UI transitions
4365 * is a good fit. For example, announcing a new page in a book. If accessibility
4366 * is not enabled this method does nothing.
4367 *
4368 * @param text The announcement text.
4369 */
4370 public void announceForAccessibility(CharSequence text) {
4371 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4372 AccessibilityEvent event = AccessibilityEvent.obtain(
4373 AccessibilityEvent.TYPE_ANNOUNCEMENT);
4374 event.getText().add(text);
4375 sendAccessibilityEventUnchecked(event);
4376 }
4377 }
4378
4379 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004380 * @see #sendAccessibilityEvent(int)
4381 *
4382 * Note: Called from the default {@link AccessibilityDelegate}.
4383 */
4384 void sendAccessibilityEventInternal(int eventType) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004385 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4386 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
4387 }
4388 }
4389
4390 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004391 * This method behaves exactly as {@link #sendAccessibilityEvent(int)} but
4392 * takes as an argument an empty {@link AccessibilityEvent} and does not
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004393 * perform a check whether accessibility is enabled.
4394 * <p>
4395 * If an {@link AccessibilityDelegate} has been specified via calling
4396 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4397 * {@link AccessibilityDelegate#sendAccessibilityEventUnchecked(View, AccessibilityEvent)}
4398 * is responsible for handling this call.
4399 * </p>
Svetoslav Ganov30401322011-05-12 18:53:45 -07004400 *
4401 * @param event The event to send.
4402 *
4403 * @see #sendAccessibilityEvent(int)
svetoslavganov75986cf2009-05-14 22:28:01 -07004404 */
4405 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004406 if (mAccessibilityDelegate != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004407 mAccessibilityDelegate.sendAccessibilityEventUnchecked(this, event);
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004408 } else {
4409 sendAccessibilityEventUncheckedInternal(event);
4410 }
4411 }
4412
4413 /**
4414 * @see #sendAccessibilityEventUnchecked(AccessibilityEvent)
4415 *
4416 * Note: Called from the default {@link AccessibilityDelegate}.
4417 */
4418 void sendAccessibilityEventUncheckedInternal(AccessibilityEvent event) {
Svetoslav Ganov9cd1eca2011-01-13 14:24:02 -08004419 if (!isShown()) {
4420 return;
4421 }
Svetoslav Ganov30401322011-05-12 18:53:45 -07004422 onInitializeAccessibilityEvent(event);
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07004423 // Only a subset of accessibility events populates text content.
4424 if ((event.getEventType() & POPULATING_ACCESSIBILITY_EVENT_TYPES) != 0) {
4425 dispatchPopulateAccessibilityEvent(event);
4426 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07004427 // Intercept accessibility focus events fired by virtual nodes to keep
4428 // track of accessibility focus position in such nodes.
4429 final int eventType = event.getEventType();
4430 switch (eventType) {
4431 case AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED: {
4432 final long virtualNodeId = AccessibilityNodeInfo.getVirtualDescendantId(
4433 event.getSourceNodeId());
4434 if (virtualNodeId != AccessibilityNodeInfo.UNDEFINED) {
4435 ViewRootImpl viewRootImpl = getViewRootImpl();
4436 if (viewRootImpl != null) {
4437 viewRootImpl.setAccessibilityFocusedHost(this);
4438 }
4439 }
4440 } break;
4441 case AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED: {
4442 final long virtualNodeId = AccessibilityNodeInfo.getVirtualDescendantId(
4443 event.getSourceNodeId());
4444 if (virtualNodeId != AccessibilityNodeInfo.UNDEFINED) {
4445 ViewRootImpl viewRootImpl = getViewRootImpl();
4446 if (viewRootImpl != null) {
4447 viewRootImpl.setAccessibilityFocusedHost(null);
4448 }
4449 }
4450 } break;
4451 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004452 // In the beginning we called #isShown(), so we know that getParent() is not null.
4453 getParent().requestSendAccessibilityEvent(this, event);
svetoslavganov75986cf2009-05-14 22:28:01 -07004454 }
4455
4456 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004457 * Dispatches an {@link AccessibilityEvent} to the {@link View} first and then
4458 * to its children for adding their text content to the event. Note that the
4459 * event text is populated in a separate dispatch path since we add to the
4460 * event not only the text of the source but also the text of all its descendants.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004461 * A typical implementation will call
4462 * {@link #onPopulateAccessibilityEvent(AccessibilityEvent)} on the this view
4463 * and then call the {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
4464 * on each child. Override this method if custom population of the event text
4465 * content is required.
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004466 * <p>
4467 * If an {@link AccessibilityDelegate} has been specified via calling
4468 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4469 * {@link AccessibilityDelegate#dispatchPopulateAccessibilityEvent(View, AccessibilityEvent)}
4470 * is responsible for handling this call.
4471 * </p>
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07004472 * <p>
4473 * <em>Note:</em> Accessibility events of certain types are not dispatched for
4474 * populating the event text via this method. For details refer to {@link AccessibilityEvent}.
4475 * </p>
svetoslavganov75986cf2009-05-14 22:28:01 -07004476 *
4477 * @param event The event.
4478 *
4479 * @return True if the event population was completed.
4480 */
4481 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004482 if (mAccessibilityDelegate != null) {
4483 return mAccessibilityDelegate.dispatchPopulateAccessibilityEvent(this, event);
4484 } else {
4485 return dispatchPopulateAccessibilityEventInternal(event);
4486 }
4487 }
4488
4489 /**
4490 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4491 *
4492 * Note: Called from the default {@link AccessibilityDelegate}.
4493 */
4494 boolean dispatchPopulateAccessibilityEventInternal(AccessibilityEvent event) {
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004495 onPopulateAccessibilityEvent(event);
svetoslavganov75986cf2009-05-14 22:28:01 -07004496 return false;
4497 }
4498
4499 /**
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004500 * Called from {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
Svetoslav Ganov30401322011-05-12 18:53:45 -07004501 * giving a chance to this View to populate the accessibility event with its
Scott Mainb303d832011-10-12 16:45:18 -07004502 * text content. While this method is free to modify event
4503 * attributes other than text content, doing so should normally be performed in
Svetoslav Ganov30401322011-05-12 18:53:45 -07004504 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)}.
4505 * <p>
4506 * Example: Adding formatted date string to an accessibility event in addition
Scott Mainb303d832011-10-12 16:45:18 -07004507 * to the text added by the super implementation:
4508 * <pre> public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov30401322011-05-12 18:53:45 -07004509 * super.onPopulateAccessibilityEvent(event);
4510 * final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY;
4511 * String selectedDateUtterance = DateUtils.formatDateTime(mContext,
4512 * mCurrentDate.getTimeInMillis(), flags);
4513 * event.getText().add(selectedDateUtterance);
Scott Mainb303d832011-10-12 16:45:18 -07004514 * }</pre>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004515 * <p>
4516 * If an {@link AccessibilityDelegate} has been specified via calling
4517 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4518 * {@link AccessibilityDelegate#onPopulateAccessibilityEvent(View, AccessibilityEvent)}
4519 * is responsible for handling this call.
4520 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07004521 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding
4522 * information to the event, in case the default implementation has basic information to add.
4523 * </p>
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004524 *
4525 * @param event The accessibility event which to populate.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004526 *
4527 * @see #sendAccessibilityEvent(int)
4528 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004529 */
4530 public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004531 if (mAccessibilityDelegate != null) {
4532 mAccessibilityDelegate.onPopulateAccessibilityEvent(this, event);
4533 } else {
4534 onPopulateAccessibilityEventInternal(event);
4535 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004536 }
4537
4538 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004539 * @see #onPopulateAccessibilityEvent(AccessibilityEvent)
4540 *
4541 * Note: Called from the default {@link AccessibilityDelegate}.
4542 */
4543 void onPopulateAccessibilityEventInternal(AccessibilityEvent event) {
4544
4545 }
4546
4547 /**
4548 * Initializes an {@link AccessibilityEvent} with information about
4549 * this View which is the event source. In other words, the source of
4550 * an accessibility event is the view whose state change triggered firing
4551 * the event.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004552 * <p>
4553 * Example: Setting the password property of an event in addition
Scott Mainb303d832011-10-12 16:45:18 -07004554 * to properties set by the super implementation:
4555 * <pre> public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
4556 * super.onInitializeAccessibilityEvent(event);
4557 * event.setPassword(true);
4558 * }</pre>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004559 * <p>
4560 * If an {@link AccessibilityDelegate} has been specified via calling
4561 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4562 * {@link AccessibilityDelegate#onInitializeAccessibilityEvent(View, AccessibilityEvent)}
4563 * is responsible for handling this call.
4564 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07004565 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding
4566 * information to the event, in case the default implementation has basic information to add.
4567 * </p>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004568 * @param event The event to initialize.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004569 *
4570 * @see #sendAccessibilityEvent(int)
4571 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4572 */
4573 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004574 if (mAccessibilityDelegate != null) {
4575 mAccessibilityDelegate.onInitializeAccessibilityEvent(this, event);
4576 } else {
4577 onInitializeAccessibilityEventInternal(event);
4578 }
4579 }
4580
4581 /**
4582 * @see #onInitializeAccessibilityEvent(AccessibilityEvent)
4583 *
4584 * Note: Called from the default {@link AccessibilityDelegate}.
4585 */
4586 void onInitializeAccessibilityEventInternal(AccessibilityEvent event) {
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004587 event.setSource(this);
Svetoslav Ganov8a78fd42012-01-17 14:36:46 -08004588 event.setClassName(View.class.getName());
Svetoslav Ganov30401322011-05-12 18:53:45 -07004589 event.setPackageName(getContext().getPackageName());
4590 event.setEnabled(isEnabled());
4591 event.setContentDescription(mContentDescription);
4592
Svetoslav Ganovd9ee72f2011-10-05 22:26:05 -07004593 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004594 ArrayList<View> focusablesTempList = mAttachInfo.mTempArrayList;
Svetoslav Ganovd9ee72f2011-10-05 22:26:05 -07004595 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD,
4596 FOCUSABLES_ALL);
4597 event.setItemCount(focusablesTempList.size());
4598 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
4599 focusablesTempList.clear();
Svetoslav Ganov30401322011-05-12 18:53:45 -07004600 }
4601 }
4602
4603 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004604 * Returns an {@link AccessibilityNodeInfo} representing this view from the
4605 * point of view of an {@link android.accessibilityservice.AccessibilityService}.
4606 * This method is responsible for obtaining an accessibility node info from a
4607 * pool of reusable instances and calling
4608 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on this view to
4609 * initialize the former.
4610 * <p>
4611 * Note: The client is responsible for recycling the obtained instance by calling
4612 * {@link AccessibilityNodeInfo#recycle()} to minimize object creation.
4613 * </p>
Svetoslav Ganov02107852011-10-03 17:06:56 -07004614 *
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004615 * @return A populated {@link AccessibilityNodeInfo}.
4616 *
4617 * @see AccessibilityNodeInfo
4618 */
4619 public AccessibilityNodeInfo createAccessibilityNodeInfo() {
Svetoslav Ganov02107852011-10-03 17:06:56 -07004620 AccessibilityNodeProvider provider = getAccessibilityNodeProvider();
4621 if (provider != null) {
4622 return provider.createAccessibilityNodeInfo(View.NO_ID);
4623 } else {
4624 AccessibilityNodeInfo info = AccessibilityNodeInfo.obtain(this);
4625 onInitializeAccessibilityNodeInfo(info);
4626 return info;
4627 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004628 }
4629
4630 /**
4631 * Initializes an {@link AccessibilityNodeInfo} with information about this view.
4632 * The base implementation sets:
4633 * <ul>
4634 * <li>{@link AccessibilityNodeInfo#setParent(View)},</li>
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004635 * <li>{@link AccessibilityNodeInfo#setBoundsInParent(Rect)},</li>
4636 * <li>{@link AccessibilityNodeInfo#setBoundsInScreen(Rect)},</li>
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004637 * <li>{@link AccessibilityNodeInfo#setPackageName(CharSequence)},</li>
4638 * <li>{@link AccessibilityNodeInfo#setClassName(CharSequence)},</li>
4639 * <li>{@link AccessibilityNodeInfo#setContentDescription(CharSequence)},</li>
4640 * <li>{@link AccessibilityNodeInfo#setEnabled(boolean)},</li>
4641 * <li>{@link AccessibilityNodeInfo#setClickable(boolean)},</li>
4642 * <li>{@link AccessibilityNodeInfo#setFocusable(boolean)},</li>
4643 * <li>{@link AccessibilityNodeInfo#setFocused(boolean)},</li>
4644 * <li>{@link AccessibilityNodeInfo#setLongClickable(boolean)},</li>
4645 * <li>{@link AccessibilityNodeInfo#setSelected(boolean)},</li>
4646 * </ul>
4647 * <p>
4648 * Subclasses should override this method, call the super implementation,
4649 * and set additional attributes.
4650 * </p>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004651 * <p>
4652 * If an {@link AccessibilityDelegate} has been specified via calling
4653 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4654 * {@link AccessibilityDelegate#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo)}
4655 * is responsible for handling this call.
4656 * </p>
4657 *
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004658 * @param info The instance to initialize.
4659 */
4660 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004661 if (mAccessibilityDelegate != null) {
4662 mAccessibilityDelegate.onInitializeAccessibilityNodeInfo(this, info);
4663 } else {
4664 onInitializeAccessibilityNodeInfoInternal(info);
4665 }
4666 }
4667
4668 /**
4669 * @see #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
4670 *
4671 * Note: Called from the default {@link AccessibilityDelegate}.
4672 */
4673 void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) {
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004674 Rect bounds = mAttachInfo.mTmpInvalRect;
4675 getDrawingRect(bounds);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004676 info.setBoundsInParent(bounds);
4677
Svetoslav Ganovaa6f3de2012-04-09 17:39:00 -07004678 getGlobalVisibleRect(bounds);
4679 bounds.offset(mAttachInfo.mWindowLeft, mAttachInfo.mWindowTop);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004680 info.setBoundsInScreen(bounds);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004681
Svetoslav Ganov57f3b566db2011-10-31 17:59:14 -07004682 if ((mPrivateFlags & IS_ROOT_NAMESPACE) == 0) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004683 ViewParent parent = getParentForAccessibility();
Svetoslav Ganov57f3b566db2011-10-31 17:59:14 -07004684 if (parent instanceof View) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004685 info.setParent((View) parent);
Svetoslav Ganov57f3b566db2011-10-31 17:59:14 -07004686 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004687 }
4688
4689 info.setPackageName(mContext.getPackageName());
Svetoslav Ganov8a78fd42012-01-17 14:36:46 -08004690 info.setClassName(View.class.getName());
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004691 info.setContentDescription(getContentDescription());
4692
4693 info.setEnabled(isEnabled());
4694 info.setClickable(isClickable());
4695 info.setFocusable(isFocusable());
4696 info.setFocused(isFocused());
Svetoslav Ganov42138042012-03-20 11:51:39 -07004697 info.setAccessibilityFocused(isAccessibilityFocused());
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004698 info.setSelected(isSelected());
4699 info.setLongClickable(isLongClickable());
4700
4701 // TODO: These make sense only if we are in an AdapterView but all
4702 // views can be selected. Maybe from accessiiblity perspective
4703 // we should report as selectable view in an AdapterView.
4704 info.addAction(AccessibilityNodeInfo.ACTION_SELECT);
4705 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION);
4706
4707 if (isFocusable()) {
4708 if (isFocused()) {
4709 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS);
4710 } else {
4711 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS);
4712 }
4713 }
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004714
Svetoslav Ganov02afe2c2012-05-07 17:51:59 -07004715 if (!isAccessibilityFocused()) {
4716 info.addAction(AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS);
4717 } else {
4718 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS);
4719 }
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004720
4721 if (isClickable()) {
4722 info.addAction(AccessibilityNodeInfo.ACTION_CLICK);
4723 }
4724
4725 if (isLongClickable()) {
4726 info.addAction(AccessibilityNodeInfo.ACTION_LONG_CLICK);
4727 }
4728
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07004729 if (mContentDescription != null && mContentDescription.length() > 0) {
Svetoslav Ganov2b435aa2012-05-04 17:16:37 -07004730 info.addAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY);
4731 info.addAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY);
4732 info.setMovementGranularities(AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07004733 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD
4734 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH);
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004735 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004736 }
4737
4738 /**
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004739 * Computes whether this view is visible on the screen.
4740 *
4741 * @return Whether the view is visible on the screen.
4742 */
4743 boolean isDisplayedOnScreen() {
4744 // The first two checks are made also made by isShown() which
4745 // however traverses the tree up to the parent to catch that.
4746 // Therefore, we do some fail fast check to minimize the up
4747 // tree traversal.
4748 return (mAttachInfo != null
4749 && mAttachInfo.mWindowVisibility == View.VISIBLE
4750 && getAlpha() > 0
4751 && isShown()
4752 && getGlobalVisibleRect(mAttachInfo.mTmpInvalRect));
4753 }
4754
4755 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004756 * Sets a delegate for implementing accessibility support via compositon as
4757 * opposed to inheritance. The delegate's primary use is for implementing
4758 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}.
4759 *
4760 * @param delegate The delegate instance.
4761 *
4762 * @see AccessibilityDelegate
4763 */
4764 public void setAccessibilityDelegate(AccessibilityDelegate delegate) {
4765 mAccessibilityDelegate = delegate;
4766 }
4767
4768 /**
Svetoslav Ganov02107852011-10-03 17:06:56 -07004769 * Gets the provider for managing a virtual view hierarchy rooted at this View
4770 * and reported to {@link android.accessibilityservice.AccessibilityService}s
4771 * that explore the window content.
4772 * <p>
4773 * If this method returns an instance, this instance is responsible for managing
4774 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this
4775 * View including the one representing the View itself. Similarly the returned
4776 * instance is responsible for performing accessibility actions on any virtual
4777 * view or the root view itself.
4778 * </p>
4779 * <p>
4780 * If an {@link AccessibilityDelegate} has been specified via calling
4781 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4782 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)}
4783 * is responsible for handling this call.
4784 * </p>
4785 *
4786 * @return The provider.
4787 *
4788 * @see AccessibilityNodeProvider
4789 */
4790 public AccessibilityNodeProvider getAccessibilityNodeProvider() {
4791 if (mAccessibilityDelegate != null) {
4792 return mAccessibilityDelegate.getAccessibilityNodeProvider(this);
4793 } else {
4794 return null;
4795 }
4796 }
4797
4798 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004799 * Gets the unique identifier of this view on the screen for accessibility purposes.
4800 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned.
4801 *
4802 * @return The view accessibility id.
4803 *
4804 * @hide
4805 */
4806 public int getAccessibilityViewId() {
4807 if (mAccessibilityViewId == NO_ID) {
4808 mAccessibilityViewId = sNextAccessibilityViewId++;
4809 }
4810 return mAccessibilityViewId;
4811 }
4812
4813 /**
4814 * Gets the unique identifier of the window in which this View reseides.
4815 *
4816 * @return The window accessibility id.
4817 *
4818 * @hide
4819 */
4820 public int getAccessibilityWindowId() {
4821 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId : NO_ID;
4822 }
4823
4824 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07004825 * Gets the {@link View} description. It briefly describes the view and is
4826 * primarily used for accessibility support. Set this property to enable
4827 * better accessibility support for your application. This is especially
4828 * true for views that do not have textual representation (For example,
4829 * ImageButton).
4830 *
Svetoslav Ganov42138042012-03-20 11:51:39 -07004831 * @return The content description.
svetoslavganov75986cf2009-05-14 22:28:01 -07004832 *
4833 * @attr ref android.R.styleable#View_contentDescription
4834 */
Svetoslav Ganov42138042012-03-20 11:51:39 -07004835 @ViewDebug.ExportedProperty(category = "accessibility")
svetoslavganov75986cf2009-05-14 22:28:01 -07004836 public CharSequence getContentDescription() {
4837 return mContentDescription;
4838 }
4839
4840 /**
4841 * Sets the {@link View} description. It briefly describes the view and is
4842 * primarily used for accessibility support. Set this property to enable
4843 * better accessibility support for your application. This is especially
4844 * true for views that do not have textual representation (For example,
4845 * ImageButton).
4846 *
4847 * @param contentDescription The content description.
4848 *
4849 * @attr ref android.R.styleable#View_contentDescription
4850 */
Svetoslav Ganove261e282011-10-18 17:47:04 -07004851 @RemotableViewMethod
svetoslavganov75986cf2009-05-14 22:28:01 -07004852 public void setContentDescription(CharSequence contentDescription) {
4853 mContentDescription = contentDescription;
4854 }
4855
4856 /**
Romain Guya2431d02009-04-30 16:30:00 -07004857 * Invoked whenever this view loses focus, either by losing window focus or by losing
4858 * focus within its window. This method can be used to clear any state tied to the
4859 * focus. For instance, if a button is held pressed with the trackball and the window
4860 * loses focus, this method can be used to cancel the press.
4861 *
4862 * Subclasses of View overriding this method should always call super.onFocusLost().
4863 *
4864 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07004865 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07004866 *
4867 * @hide pending API council approval
4868 */
4869 protected void onFocusLost() {
4870 resetPressedState();
4871 }
4872
4873 private void resetPressedState() {
4874 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4875 return;
4876 }
4877
4878 if (isPressed()) {
4879 setPressed(false);
4880
4881 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05004882 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004883 }
4884 }
4885 }
4886
4887 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004888 * Returns true if this view has focus
4889 *
4890 * @return True if this view has focus, false otherwise.
4891 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004892 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004893 public boolean isFocused() {
4894 return (mPrivateFlags & FOCUSED) != 0;
4895 }
4896
4897 /**
4898 * Find the view in the hierarchy rooted at this view that currently has
4899 * focus.
4900 *
4901 * @return The view that currently has focus, or null if no focused view can
4902 * be found.
4903 */
4904 public View findFocus() {
4905 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
4906 }
4907
4908 /**
Philip Milne6c8ea062012-04-03 17:38:43 -07004909 * Indicates whether this view is one of the set of scrollable containers in
4910 * its window.
4911 *
4912 * @return whether this view is one of the set of scrollable containers in
4913 * its window
4914 *
4915 * @attr ref android.R.styleable#View_isScrollContainer
4916 */
4917 public boolean isScrollContainer() {
4918 return (mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0;
4919 }
4920
4921 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004922 * Change whether this view is one of the set of scrollable containers in
4923 * its window. This will be used to determine whether the window can
4924 * resize or must pan when a soft input area is open -- scrollable
4925 * containers allow the window to use resize mode since the container
4926 * will appropriately shrink.
Philip Milne6c8ea062012-04-03 17:38:43 -07004927 *
4928 * @attr ref android.R.styleable#View_isScrollContainer
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004929 */
4930 public void setScrollContainer(boolean isScrollContainer) {
4931 if (isScrollContainer) {
4932 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
4933 mAttachInfo.mScrollContainers.add(this);
4934 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
4935 }
4936 mPrivateFlags |= SCROLL_CONTAINER;
4937 } else {
4938 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
4939 mAttachInfo.mScrollContainers.remove(this);
4940 }
4941 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
4942 }
4943 }
4944
4945 /**
4946 * Returns the quality of the drawing cache.
4947 *
4948 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
4949 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
4950 *
4951 * @see #setDrawingCacheQuality(int)
4952 * @see #setDrawingCacheEnabled(boolean)
4953 * @see #isDrawingCacheEnabled()
4954 *
4955 * @attr ref android.R.styleable#View_drawingCacheQuality
4956 */
4957 public int getDrawingCacheQuality() {
4958 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
4959 }
4960
4961 /**
4962 * Set the drawing cache quality of this view. This value is used only when the
4963 * drawing cache is enabled
4964 *
4965 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
4966 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
4967 *
4968 * @see #getDrawingCacheQuality()
4969 * @see #setDrawingCacheEnabled(boolean)
4970 * @see #isDrawingCacheEnabled()
4971 *
4972 * @attr ref android.R.styleable#View_drawingCacheQuality
4973 */
4974 public void setDrawingCacheQuality(int quality) {
4975 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
4976 }
4977
4978 /**
4979 * Returns whether the screen should remain on, corresponding to the current
4980 * value of {@link #KEEP_SCREEN_ON}.
4981 *
4982 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
4983 *
4984 * @see #setKeepScreenOn(boolean)
4985 *
4986 * @attr ref android.R.styleable#View_keepScreenOn
4987 */
4988 public boolean getKeepScreenOn() {
4989 return (mViewFlags & KEEP_SCREEN_ON) != 0;
4990 }
4991
4992 /**
4993 * Controls whether the screen should remain on, modifying the
4994 * value of {@link #KEEP_SCREEN_ON}.
4995 *
4996 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
4997 *
4998 * @see #getKeepScreenOn()
4999 *
5000 * @attr ref android.R.styleable#View_keepScreenOn
5001 */
5002 public void setKeepScreenOn(boolean keepScreenOn) {
5003 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
5004 }
5005
5006 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005007 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
5008 * @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 -08005009 *
5010 * @attr ref android.R.styleable#View_nextFocusLeft
5011 */
5012 public int getNextFocusLeftId() {
5013 return mNextFocusLeftId;
5014 }
5015
5016 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005017 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
5018 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
5019 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005020 *
5021 * @attr ref android.R.styleable#View_nextFocusLeft
5022 */
5023 public void setNextFocusLeftId(int nextFocusLeftId) {
5024 mNextFocusLeftId = nextFocusLeftId;
5025 }
5026
5027 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005028 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
5029 * @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 -08005030 *
5031 * @attr ref android.R.styleable#View_nextFocusRight
5032 */
5033 public int getNextFocusRightId() {
5034 return mNextFocusRightId;
5035 }
5036
5037 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005038 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
5039 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
5040 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005041 *
5042 * @attr ref android.R.styleable#View_nextFocusRight
5043 */
5044 public void setNextFocusRightId(int nextFocusRightId) {
5045 mNextFocusRightId = nextFocusRightId;
5046 }
5047
5048 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005049 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
5050 * @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 -08005051 *
5052 * @attr ref android.R.styleable#View_nextFocusUp
5053 */
5054 public int getNextFocusUpId() {
5055 return mNextFocusUpId;
5056 }
5057
5058 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005059 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
5060 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
5061 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005062 *
5063 * @attr ref android.R.styleable#View_nextFocusUp
5064 */
5065 public void setNextFocusUpId(int nextFocusUpId) {
5066 mNextFocusUpId = nextFocusUpId;
5067 }
5068
5069 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005070 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
5071 * @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 -08005072 *
5073 * @attr ref android.R.styleable#View_nextFocusDown
5074 */
5075 public int getNextFocusDownId() {
5076 return mNextFocusDownId;
5077 }
5078
5079 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005080 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
5081 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
5082 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005083 *
5084 * @attr ref android.R.styleable#View_nextFocusDown
5085 */
5086 public void setNextFocusDownId(int nextFocusDownId) {
5087 mNextFocusDownId = nextFocusDownId;
5088 }
5089
5090 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005091 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
5092 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
5093 *
5094 * @attr ref android.R.styleable#View_nextFocusForward
5095 */
5096 public int getNextFocusForwardId() {
5097 return mNextFocusForwardId;
5098 }
5099
5100 /**
5101 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
5102 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
5103 * decide automatically.
5104 *
5105 * @attr ref android.R.styleable#View_nextFocusForward
5106 */
5107 public void setNextFocusForwardId(int nextFocusForwardId) {
5108 mNextFocusForwardId = nextFocusForwardId;
5109 }
5110
5111 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005112 * Returns the visibility of this view and all of its ancestors
5113 *
5114 * @return True if this view and all of its ancestors are {@link #VISIBLE}
5115 */
5116 public boolean isShown() {
5117 View current = this;
5118 //noinspection ConstantConditions
5119 do {
5120 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
5121 return false;
5122 }
5123 ViewParent parent = current.mParent;
5124 if (parent == null) {
5125 return false; // We are not attached to the view root
5126 }
5127 if (!(parent instanceof View)) {
5128 return true;
5129 }
5130 current = (View) parent;
5131 } while (current != null);
5132
5133 return false;
5134 }
5135
5136 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005137 * Called by the view hierarchy when the content insets for a window have
5138 * changed, to allow it to adjust its content to fit within those windows.
5139 * The content insets tell you the space that the status bar, input method,
5140 * and other system windows infringe on the application's window.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005141 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005142 * <p>You do not normally need to deal with this function, since the default
5143 * window decoration given to applications takes care of applying it to the
5144 * content of the window. If you use {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}
5145 * or {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} this will not be the case,
5146 * and your content can be placed under those system elements. You can then
5147 * use this method within your view hierarchy if you have parts of your UI
5148 * which you would like to ensure are not being covered.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005149 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005150 * <p>The default implementation of this method simply applies the content
5151 * inset's to the view's padding. This can be enabled through
5152 * {@link #setFitsSystemWindows(boolean)}. Alternatively, you can override
5153 * the method and handle the insets however you would like. Note that the
5154 * insets provided by the framework are always relative to the far edges
5155 * of the window, not accounting for the location of the called view within
5156 * that window. (In fact when this method is called you do not yet know
5157 * where the layout will place the view, as it is done before layout happens.)
5158 *
5159 * <p>Note: unlike many View methods, there is no dispatch phase to this
5160 * call. If you are overriding it in a ViewGroup and want to allow the
5161 * call to continue to your children, you must be sure to call the super
5162 * implementation.
5163 *
5164 * @param insets Current content insets of the window. Prior to
5165 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} you must not modify
5166 * the insets or else you and Android will be unhappy.
5167 *
5168 * @return Return true if this view applied the insets and it should not
5169 * continue propagating further down the hierarchy, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005170 */
5171 protected boolean fitSystemWindows(Rect insets) {
5172 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005173 mUserPaddingStart = -1;
5174 mUserPaddingEnd = -1;
5175 mUserPaddingRelative = false;
5176 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0
5177 || mAttachInfo == null
5178 || (mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0) {
5179 internalSetPadding(insets.left, insets.top, insets.right, insets.bottom);
5180 return true;
5181 } else {
5182 internalSetPadding(0, 0, 0, 0);
5183 return false;
5184 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005185 }
5186 return false;
5187 }
5188
5189 /**
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005190 * Set whether or not this view should account for system screen decorations
5191 * such as the status bar and inset its content. This allows this view to be
5192 * positioned in absolute screen coordinates and remain visible to the user.
5193 *
5194 * <p>This should only be used by top-level window decor views.
5195 *
5196 * @param fitSystemWindows true to inset content for system screen decorations, false for
5197 * default behavior.
5198 *
5199 * @attr ref android.R.styleable#View_fitsSystemWindows
5200 */
5201 public void setFitsSystemWindows(boolean fitSystemWindows) {
5202 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS);
5203 }
5204
5205 /**
5206 * Check for the FITS_SYSTEM_WINDOWS flag. If this method returns true, this view
5207 * will account for system screen decorations such as the status bar and inset its
5208 * content. This allows the view to be positioned in absolute screen coordinates
5209 * and remain visible to the user.
5210 *
5211 * @return true if this view will adjust its content bounds for system screen decorations.
5212 *
5213 * @attr ref android.R.styleable#View_fitsSystemWindows
5214 */
5215 public boolean fitsSystemWindows() {
5216 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
5217 }
5218
5219 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005220 * Ask that a new dispatch of {@link #fitSystemWindows(Rect)} be performed.
5221 */
5222 public void requestFitSystemWindows() {
5223 if (mParent != null) {
5224 mParent.requestFitSystemWindows();
5225 }
5226 }
5227
5228 /**
5229 * For use by PhoneWindow to make its own system window fitting optional.
5230 * @hide
5231 */
5232 public void makeOptionalFitsSystemWindows() {
5233 setFlags(OPTIONAL_FITS_SYSTEM_WINDOWS, OPTIONAL_FITS_SYSTEM_WINDOWS);
5234 }
5235
5236 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005237 * Returns the visibility status for this view.
5238 *
5239 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
5240 * @attr ref android.R.styleable#View_visibility
5241 */
5242 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07005243 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
5244 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
5245 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005246 })
5247 public int getVisibility() {
5248 return mViewFlags & VISIBILITY_MASK;
5249 }
5250
5251 /**
5252 * Set the enabled state of this view.
5253 *
5254 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
5255 * @attr ref android.R.styleable#View_visibility
5256 */
5257 @RemotableViewMethod
5258 public void setVisibility(int visibility) {
5259 setFlags(visibility, VISIBILITY_MASK);
Philip Milne6c8ea062012-04-03 17:38:43 -07005260 if (mBackground != null) mBackground.setVisible(visibility == VISIBLE, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005261 }
5262
5263 /**
5264 * Returns the enabled status for this view. The interpretation of the
5265 * enabled state varies by subclass.
5266 *
5267 * @return True if this view is enabled, false otherwise.
5268 */
5269 @ViewDebug.ExportedProperty
5270 public boolean isEnabled() {
5271 return (mViewFlags & ENABLED_MASK) == ENABLED;
5272 }
5273
5274 /**
5275 * Set the enabled state of this view. The interpretation of the enabled
5276 * state varies by subclass.
5277 *
5278 * @param enabled True if this view is enabled, false otherwise.
5279 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08005280 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005281 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07005282 if (enabled == isEnabled()) return;
5283
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005284 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
5285
5286 /*
5287 * The View most likely has to change its appearance, so refresh
5288 * the drawable state.
5289 */
5290 refreshDrawableState();
5291
5292 // Invalidate too, since the default behavior for views is to be
5293 // be drawn at 50% alpha rather than to change the drawable.
Romain Guy0fd89bf2011-01-26 15:41:30 -08005294 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005295 }
5296
5297 /**
5298 * Set whether this view can receive the focus.
5299 *
5300 * Setting this to false will also ensure that this view is not focusable
5301 * in touch mode.
5302 *
5303 * @param focusable If true, this view can receive the focus.
5304 *
5305 * @see #setFocusableInTouchMode(boolean)
5306 * @attr ref android.R.styleable#View_focusable
5307 */
5308 public void setFocusable(boolean focusable) {
5309 if (!focusable) {
5310 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
5311 }
5312 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
5313 }
5314
5315 /**
5316 * Set whether this view can receive focus while in touch mode.
5317 *
5318 * Setting this to true will also ensure that this view is focusable.
5319 *
5320 * @param focusableInTouchMode If true, this view can receive the focus while
5321 * in touch mode.
5322 *
5323 * @see #setFocusable(boolean)
5324 * @attr ref android.R.styleable#View_focusableInTouchMode
5325 */
5326 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
5327 // Focusable in touch mode should always be set before the focusable flag
5328 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
5329 // which, in touch mode, will not successfully request focus on this view
5330 // because the focusable in touch mode flag is not set
5331 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
5332 if (focusableInTouchMode) {
5333 setFlags(FOCUSABLE, FOCUSABLE_MASK);
5334 }
5335 }
5336
5337 /**
5338 * Set whether this view should have sound effects enabled for events such as
5339 * clicking and touching.
5340 *
5341 * <p>You may wish to disable sound effects for a view if you already play sounds,
5342 * for instance, a dial key that plays dtmf tones.
5343 *
5344 * @param soundEffectsEnabled whether sound effects are enabled for this view.
5345 * @see #isSoundEffectsEnabled()
5346 * @see #playSoundEffect(int)
5347 * @attr ref android.R.styleable#View_soundEffectsEnabled
5348 */
5349 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
5350 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
5351 }
5352
5353 /**
5354 * @return whether this view should have sound effects enabled for events such as
5355 * clicking and touching.
5356 *
5357 * @see #setSoundEffectsEnabled(boolean)
5358 * @see #playSoundEffect(int)
5359 * @attr ref android.R.styleable#View_soundEffectsEnabled
5360 */
5361 @ViewDebug.ExportedProperty
5362 public boolean isSoundEffectsEnabled() {
5363 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
5364 }
5365
5366 /**
5367 * Set whether this view should have haptic feedback for events such as
5368 * long presses.
5369 *
5370 * <p>You may wish to disable haptic feedback if your view already controls
5371 * its own haptic feedback.
5372 *
5373 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
5374 * @see #isHapticFeedbackEnabled()
5375 * @see #performHapticFeedback(int)
5376 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
5377 */
5378 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
5379 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
5380 }
5381
5382 /**
5383 * @return whether this view should have haptic feedback enabled for events
5384 * long presses.
5385 *
5386 * @see #setHapticFeedbackEnabled(boolean)
5387 * @see #performHapticFeedback(int)
5388 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
5389 */
5390 @ViewDebug.ExportedProperty
5391 public boolean isHapticFeedbackEnabled() {
5392 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
5393 }
5394
5395 /**
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005396 * Returns the layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08005397 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005398 * @return One of {@link #LAYOUT_DIRECTION_LTR},
5399 * {@link #LAYOUT_DIRECTION_RTL},
5400 * {@link #LAYOUT_DIRECTION_INHERIT} or
5401 * {@link #LAYOUT_DIRECTION_LOCALE}.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005402 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005403 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005404 * @hide
Cibu Johny7632cb92010-02-22 13:01:02 -08005405 */
Fabrice Di Megliobce84d22011-06-02 15:57:01 -07005406 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005407 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"),
5408 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"),
5409 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"),
5410 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE")
Cibu Johny7632cb92010-02-22 13:01:02 -08005411 })
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005412 public int getLayoutDirection() {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005413 return (mPrivateFlags2 & LAYOUT_DIRECTION_MASK) >> LAYOUT_DIRECTION_MASK_SHIFT;
Cibu Johny7632cb92010-02-22 13:01:02 -08005414 }
5415
5416 /**
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005417 * Set the layout direction for this view. This will propagate a reset of layout direction
5418 * resolution to the view's children and resolve layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08005419 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005420 * @param layoutDirection One of {@link #LAYOUT_DIRECTION_LTR},
5421 * {@link #LAYOUT_DIRECTION_RTL},
5422 * {@link #LAYOUT_DIRECTION_INHERIT} or
5423 * {@link #LAYOUT_DIRECTION_LOCALE}.
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005424 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005425 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005426 * @hide
Cibu Johny7632cb92010-02-22 13:01:02 -08005427 */
5428 @RemotableViewMethod
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005429 public void setLayoutDirection(int layoutDirection) {
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005430 if (getLayoutDirection() != layoutDirection) {
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -07005431 // Reset the current layout direction and the resolved one
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005432 mPrivateFlags2 &= ~LAYOUT_DIRECTION_MASK;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07005433 resetResolvedLayoutDirection();
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005434 // Set the new layout direction (filtered) and ask for a layout pass
5435 mPrivateFlags2 |=
5436 ((layoutDirection << LAYOUT_DIRECTION_MASK_SHIFT) & LAYOUT_DIRECTION_MASK);
5437 requestLayout();
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005438 }
Cibu Johny7632cb92010-02-22 13:01:02 -08005439 }
5440
5441 /**
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005442 * Returns the resolved layout direction for this view.
5443 *
5444 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005445 * {@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005446 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005447 */
5448 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005449 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"),
5450 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL")
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005451 })
5452 public int getResolvedLayoutDirection() {
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -07005453 // The layout diretion will be resolved only if needed
5454 if ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED) != LAYOUT_DIRECTION_RESOLVED) {
5455 resolveLayoutDirection();
5456 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07005457 return ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED_RTL) == LAYOUT_DIRECTION_RESOLVED_RTL) ?
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005458 LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR;
5459 }
5460
5461 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005462 * Indicates whether or not this view's layout is right-to-left. This is resolved from
5463 * layout attribute and/or the inherited value from the parent
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005464 *
5465 * @return true if the layout is right-to-left.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005466 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005467 */
5468 @ViewDebug.ExportedProperty(category = "layout")
5469 public boolean isLayoutRtl() {
5470 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL);
5471 }
5472
5473 /**
Adam Powell539ee872012-02-03 19:00:49 -08005474 * Indicates whether the view is currently tracking transient state that the
5475 * app should not need to concern itself with saving and restoring, but that
5476 * the framework should take special note to preserve when possible.
5477 *
Adam Powell785c4472012-05-02 21:25:39 -07005478 * <p>A view with transient state cannot be trivially rebound from an external
5479 * data source, such as an adapter binding item views in a list. This may be
5480 * because the view is performing an animation, tracking user selection
5481 * of content, or similar.</p>
5482 *
Adam Powell539ee872012-02-03 19:00:49 -08005483 * @return true if the view has transient state
Adam Powell539ee872012-02-03 19:00:49 -08005484 */
5485 @ViewDebug.ExportedProperty(category = "layout")
5486 public boolean hasTransientState() {
5487 return (mPrivateFlags2 & HAS_TRANSIENT_STATE) == HAS_TRANSIENT_STATE;
5488 }
5489
5490 /**
5491 * Set whether this view is currently tracking transient state that the
Chet Haase563d4f22012-04-18 16:20:08 -07005492 * framework should attempt to preserve when possible. This flag is reference counted,
5493 * so every call to setHasTransientState(true) should be paired with a later call
5494 * to setHasTransientState(false).
Adam Powell539ee872012-02-03 19:00:49 -08005495 *
Adam Powell785c4472012-05-02 21:25:39 -07005496 * <p>A view with transient state cannot be trivially rebound from an external
5497 * data source, such as an adapter binding item views in a list. This may be
5498 * because the view is performing an animation, tracking user selection
5499 * of content, or similar.</p>
5500 *
Adam Powell539ee872012-02-03 19:00:49 -08005501 * @param hasTransientState true if this view has transient state
Adam Powell539ee872012-02-03 19:00:49 -08005502 */
5503 public void setHasTransientState(boolean hasTransientState) {
Chet Haase563d4f22012-04-18 16:20:08 -07005504 mTransientStateCount = hasTransientState ? mTransientStateCount + 1 :
5505 mTransientStateCount - 1;
5506 if (mTransientStateCount < 0) {
5507 mTransientStateCount = 0;
5508 Log.e(VIEW_LOG_TAG, "hasTransientState decremented below 0: " +
5509 "unmatched pair of setHasTransientState calls");
5510 }
5511 if ((hasTransientState && mTransientStateCount == 1) ||
5512 (hasTransientState && mTransientStateCount == 0)) {
5513 // update flag if we've just incremented up from 0 or decremented down to 0
5514 mPrivateFlags2 = (mPrivateFlags2 & ~HAS_TRANSIENT_STATE) |
5515 (hasTransientState ? HAS_TRANSIENT_STATE : 0);
5516 if (mParent != null) {
5517 try {
5518 mParent.childHasTransientStateChanged(this, hasTransientState);
5519 } catch (AbstractMethodError e) {
5520 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() +
5521 " does not fully implement ViewParent", e);
5522 }
Adam Powell539ee872012-02-03 19:00:49 -08005523 }
5524 }
5525 }
5526
5527 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005528 * If this view doesn't do any drawing on its own, set this flag to
5529 * allow further optimizations. By default, this flag is not set on
5530 * View, but could be set on some View subclasses such as ViewGroup.
5531 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005532 * Typically, if you override {@link #onDraw(android.graphics.Canvas)}
5533 * you should clear this flag.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005534 *
5535 * @param willNotDraw whether or not this View draw on its own
5536 */
5537 public void setWillNotDraw(boolean willNotDraw) {
5538 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
5539 }
5540
5541 /**
5542 * Returns whether or not this View draws on its own.
5543 *
5544 * @return true if this view has nothing to draw, false otherwise
5545 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005546 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005547 public boolean willNotDraw() {
5548 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
5549 }
5550
5551 /**
5552 * When a View's drawing cache is enabled, drawing is redirected to an
5553 * offscreen bitmap. Some views, like an ImageView, must be able to
5554 * bypass this mechanism if they already draw a single bitmap, to avoid
5555 * unnecessary usage of the memory.
5556 *
5557 * @param willNotCacheDrawing true if this view does not cache its
5558 * drawing, false otherwise
5559 */
5560 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
5561 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
5562 }
5563
5564 /**
5565 * Returns whether or not this View can cache its drawing or not.
5566 *
5567 * @return true if this view does not cache its drawing, false otherwise
5568 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005569 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005570 public boolean willNotCacheDrawing() {
5571 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
5572 }
5573
5574 /**
5575 * Indicates whether this view reacts to click events or not.
5576 *
5577 * @return true if the view is clickable, false otherwise
5578 *
5579 * @see #setClickable(boolean)
5580 * @attr ref android.R.styleable#View_clickable
5581 */
5582 @ViewDebug.ExportedProperty
5583 public boolean isClickable() {
5584 return (mViewFlags & CLICKABLE) == CLICKABLE;
5585 }
5586
5587 /**
5588 * Enables or disables click events for this view. When a view
5589 * is clickable it will change its state to "pressed" on every click.
5590 * Subclasses should set the view clickable to visually react to
5591 * user's clicks.
5592 *
5593 * @param clickable true to make the view clickable, false otherwise
5594 *
5595 * @see #isClickable()
5596 * @attr ref android.R.styleable#View_clickable
5597 */
5598 public void setClickable(boolean clickable) {
5599 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
5600 }
5601
5602 /**
5603 * Indicates whether this view reacts to long click events or not.
5604 *
5605 * @return true if the view is long clickable, false otherwise
5606 *
5607 * @see #setLongClickable(boolean)
5608 * @attr ref android.R.styleable#View_longClickable
5609 */
5610 public boolean isLongClickable() {
5611 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
5612 }
5613
5614 /**
5615 * Enables or disables long click events for this view. When a view is long
5616 * clickable it reacts to the user holding down the button for a longer
5617 * duration than a tap. This event can either launch the listener or a
5618 * context menu.
5619 *
5620 * @param longClickable true to make the view long clickable, false otherwise
5621 * @see #isLongClickable()
5622 * @attr ref android.R.styleable#View_longClickable
5623 */
5624 public void setLongClickable(boolean longClickable) {
5625 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
5626 }
5627
5628 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07005629 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005630 *
5631 * @see #isClickable()
5632 * @see #setClickable(boolean)
5633 *
5634 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
5635 * the View's internal state from a previously set "pressed" state.
5636 */
5637 public void setPressed(boolean pressed) {
Adam Powell035a1fc2012-02-27 15:23:50 -08005638 final boolean needsRefresh = pressed != ((mPrivateFlags & PRESSED) == PRESSED);
Adam Powell4d6f0662012-02-21 15:11:11 -08005639
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005640 if (pressed) {
5641 mPrivateFlags |= PRESSED;
5642 } else {
5643 mPrivateFlags &= ~PRESSED;
5644 }
Adam Powell035a1fc2012-02-27 15:23:50 -08005645
5646 if (needsRefresh) {
5647 refreshDrawableState();
5648 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005649 dispatchSetPressed(pressed);
5650 }
5651
5652 /**
5653 * Dispatch setPressed to all of this View's children.
5654 *
5655 * @see #setPressed(boolean)
5656 *
5657 * @param pressed The new pressed state
5658 */
5659 protected void dispatchSetPressed(boolean pressed) {
5660 }
5661
5662 /**
5663 * Indicates whether the view is currently in pressed state. Unless
5664 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
5665 * the pressed state.
5666 *
Philip Milne6c8ea062012-04-03 17:38:43 -07005667 * @see #setPressed(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005668 * @see #isClickable()
5669 * @see #setClickable(boolean)
5670 *
5671 * @return true if the view is currently pressed, false otherwise
5672 */
5673 public boolean isPressed() {
5674 return (mPrivateFlags & PRESSED) == PRESSED;
5675 }
5676
5677 /**
5678 * Indicates whether this view will save its state (that is,
5679 * whether its {@link #onSaveInstanceState} method will be called).
5680 *
5681 * @return Returns true if the view state saving is enabled, else false.
5682 *
5683 * @see #setSaveEnabled(boolean)
5684 * @attr ref android.R.styleable#View_saveEnabled
5685 */
5686 public boolean isSaveEnabled() {
5687 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
5688 }
5689
5690 /**
5691 * Controls whether the saving of this view's state is
5692 * enabled (that is, whether its {@link #onSaveInstanceState} method
5693 * will be called). Note that even if freezing is enabled, the
Romain Guy5c22a8c2011-05-13 11:48:45 -07005694 * view still must have an id assigned to it (via {@link #setId(int)})
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005695 * for its state to be saved. This flag can only disable the
5696 * saving of this view; any child views may still have their state saved.
5697 *
5698 * @param enabled Set to false to <em>disable</em> state saving, or true
5699 * (the default) to allow it.
5700 *
5701 * @see #isSaveEnabled()
5702 * @see #setId(int)
5703 * @see #onSaveInstanceState()
5704 * @attr ref android.R.styleable#View_saveEnabled
5705 */
5706 public void setSaveEnabled(boolean enabled) {
5707 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
5708 }
5709
Jeff Brown85a31762010-09-01 17:01:00 -07005710 /**
5711 * Gets whether the framework should discard touches when the view's
5712 * window is obscured by another visible window.
5713 * Refer to the {@link View} security documentation for more details.
5714 *
5715 * @return True if touch filtering is enabled.
5716 *
5717 * @see #setFilterTouchesWhenObscured(boolean)
5718 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
5719 */
5720 @ViewDebug.ExportedProperty
5721 public boolean getFilterTouchesWhenObscured() {
5722 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
5723 }
5724
5725 /**
5726 * Sets whether the framework should discard touches when the view's
5727 * window is obscured by another visible window.
5728 * Refer to the {@link View} security documentation for more details.
5729 *
5730 * @param enabled True if touch filtering should be enabled.
5731 *
5732 * @see #getFilterTouchesWhenObscured
5733 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
5734 */
5735 public void setFilterTouchesWhenObscured(boolean enabled) {
5736 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
5737 FILTER_TOUCHES_WHEN_OBSCURED);
5738 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005739
5740 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07005741 * Indicates whether the entire hierarchy under this view will save its
5742 * state when a state saving traversal occurs from its parent. The default
5743 * is true; if false, these views will not be saved unless
5744 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
5745 *
5746 * @return Returns true if the view state saving from parent is enabled, else false.
5747 *
5748 * @see #setSaveFromParentEnabled(boolean)
5749 */
5750 public boolean isSaveFromParentEnabled() {
5751 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
5752 }
5753
5754 /**
5755 * Controls whether the entire hierarchy under this view will save its
5756 * state when a state saving traversal occurs from its parent. The default
5757 * is true; if false, these views will not be saved unless
5758 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
5759 *
5760 * @param enabled Set to false to <em>disable</em> state saving, or true
5761 * (the default) to allow it.
5762 *
5763 * @see #isSaveFromParentEnabled()
5764 * @see #setId(int)
5765 * @see #onSaveInstanceState()
5766 */
5767 public void setSaveFromParentEnabled(boolean enabled) {
5768 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
5769 }
5770
5771
5772 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005773 * Returns whether this View is able to take focus.
5774 *
5775 * @return True if this view can take focus, or false otherwise.
5776 * @attr ref android.R.styleable#View_focusable
5777 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005778 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005779 public final boolean isFocusable() {
5780 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
5781 }
5782
5783 /**
5784 * When a view is focusable, it may not want to take focus when in touch mode.
5785 * For example, a button would like focus when the user is navigating via a D-pad
5786 * so that the user can click on it, but once the user starts touching the screen,
5787 * the button shouldn't take focus
5788 * @return Whether the view is focusable in touch mode.
5789 * @attr ref android.R.styleable#View_focusableInTouchMode
5790 */
5791 @ViewDebug.ExportedProperty
5792 public final boolean isFocusableInTouchMode() {
5793 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
5794 }
5795
5796 /**
5797 * Find the nearest view in the specified direction that can take focus.
5798 * This does not actually give focus to that view.
5799 *
5800 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
5801 *
5802 * @return The nearest focusable in the specified direction, or null if none
5803 * can be found.
5804 */
5805 public View focusSearch(int direction) {
5806 if (mParent != null) {
5807 return mParent.focusSearch(this, direction);
5808 } else {
5809 return null;
5810 }
5811 }
5812
5813 /**
5814 * This method is the last chance for the focused view and its ancestors to
5815 * respond to an arrow key. This is called when the focused view did not
5816 * consume the key internally, nor could the view system find a new view in
5817 * the requested direction to give focus to.
5818 *
5819 * @param focused The currently focused view.
5820 * @param direction The direction focus wants to move. One of FOCUS_UP,
5821 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
5822 * @return True if the this view consumed this unhandled move.
5823 */
5824 public boolean dispatchUnhandledMove(View focused, int direction) {
5825 return false;
5826 }
5827
5828 /**
5829 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08005830 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005831 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08005832 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
5833 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005834 * @return The user specified next view, or null if there is none.
5835 */
5836 View findUserSetNextFocus(View root, int direction) {
5837 switch (direction) {
5838 case FOCUS_LEFT:
5839 if (mNextFocusLeftId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005840 return findViewInsideOutShouldExist(root, mNextFocusLeftId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005841 case FOCUS_RIGHT:
5842 if (mNextFocusRightId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005843 return findViewInsideOutShouldExist(root, mNextFocusRightId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005844 case FOCUS_UP:
5845 if (mNextFocusUpId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005846 return findViewInsideOutShouldExist(root, mNextFocusUpId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005847 case FOCUS_DOWN:
5848 if (mNextFocusDownId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005849 return findViewInsideOutShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08005850 case FOCUS_FORWARD:
5851 if (mNextFocusForwardId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005852 return findViewInsideOutShouldExist(root, mNextFocusForwardId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08005853 case FOCUS_BACKWARD: {
John Reck1ecebbb2012-03-06 16:08:54 -08005854 if (mID == View.NO_ID) return null;
Jeff Brown4e6319b2010-12-13 10:36:51 -08005855 final int id = mID;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005856 return root.findViewByPredicateInsideOut(this, new Predicate<View>() {
Jeff Brown4e6319b2010-12-13 10:36:51 -08005857 @Override
5858 public boolean apply(View t) {
5859 return t.mNextFocusForwardId == id;
5860 }
5861 });
5862 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005863 }
5864 return null;
5865 }
5866
Jeff Brown4dfbec22011-08-15 14:55:37 -07005867 private View findViewInsideOutShouldExist(View root, final int childViewId) {
5868 View result = root.findViewByPredicateInsideOut(this, new Predicate<View>() {
5869 @Override
5870 public boolean apply(View t) {
5871 return t.mID == childViewId;
5872 }
5873 });
5874
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005875 if (result == null) {
5876 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
5877 + "by user for id " + childViewId);
5878 }
5879 return result;
5880 }
5881
5882 /**
5883 * Find and return all focusable views that are descendants of this view,
5884 * possibly including this view if it is focusable itself.
5885 *
5886 * @param direction The direction of the focus
5887 * @return A list of focusable views
5888 */
5889 public ArrayList<View> getFocusables(int direction) {
5890 ArrayList<View> result = new ArrayList<View>(24);
5891 addFocusables(result, direction);
5892 return result;
5893 }
5894
5895 /**
5896 * Add any focusable views that are descendants of this view (possibly
5897 * including this view if it is focusable itself) to views. If we are in touch mode,
5898 * only add views that are also focusable in touch mode.
5899 *
5900 * @param views Focusable views found so far
5901 * @param direction The direction of the focus
5902 */
5903 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07005904 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
5905 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005906
svetoslavganov75986cf2009-05-14 22:28:01 -07005907 /**
5908 * Adds any focusable views that are descendants of this view (possibly
5909 * including this view if it is focusable itself) to views. This method
5910 * adds all focusable views regardless if we are in touch mode or
Svetoslav Ganov42138042012-03-20 11:51:39 -07005911 * only views focusable in touch mode if we are in touch mode or
5912 * only views that can take accessibility focus if accessibility is enabeld
5913 * depending on the focusable mode paramater.
svetoslavganov75986cf2009-05-14 22:28:01 -07005914 *
5915 * @param views Focusable views found so far or null if all we are interested is
5916 * the number of focusables.
5917 * @param direction The direction of the focus.
5918 * @param focusableMode The type of focusables to be added.
5919 *
5920 * @see #FOCUSABLES_ALL
5921 * @see #FOCUSABLES_TOUCH_MODE
5922 */
5923 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07005924 if (views == null) {
svetoslavganov75986cf2009-05-14 22:28:01 -07005925 return;
5926 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07005927 if ((focusableMode & FOCUSABLES_ACCESSIBILITY) == FOCUSABLES_ACCESSIBILITY) {
5928 if (AccessibilityManager.getInstance(mContext).isEnabled()
5929 && includeForAccessibility()) {
5930 views.add(this);
5931 return;
5932 }
5933 }
Svetoslav Ganov3cb889c2012-04-16 19:10:30 -07005934 if (!isFocusable()) {
5935 return;
svetoslavganov75986cf2009-05-14 22:28:01 -07005936 }
Svetoslav Ganov3cb889c2012-04-16 19:10:30 -07005937 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE
5938 && isInTouchMode() && !isFocusableInTouchMode()) {
5939 return;
5940 }
5941 views.add(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005942 }
5943
5944 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07005945 * Finds the Views that contain given text. The containment is case insensitive.
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07005946 * The search is performed by either the text that the View renders or the content
5947 * description that describes the view for accessibility purposes and the view does
5948 * not render or both. Clients can specify how the search is to be performed via
5949 * passing the {@link #FIND_VIEWS_WITH_TEXT} and
5950 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags.
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07005951 *
5952 * @param outViews The output list of matching Views.
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07005953 * @param searched The text to match against.
Svetoslav Ganov02107852011-10-03 17:06:56 -07005954 *
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07005955 * @see #FIND_VIEWS_WITH_TEXT
5956 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION
5957 * @see #setContentDescription(CharSequence)
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07005958 */
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07005959 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, int flags) {
Svetoslav Ganov02107852011-10-03 17:06:56 -07005960 if (getAccessibilityNodeProvider() != null) {
5961 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) {
5962 outViews.add(this);
5963 }
5964 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07005965 && (searched != null && searched.length() > 0)
5966 && (mContentDescription != null && mContentDescription.length() > 0)) {
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07005967 String searchedLowerCase = searched.toString().toLowerCase();
5968 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase();
5969 if (contentDescriptionLowerCase.contains(searchedLowerCase)) {
5970 outViews.add(this);
5971 }
5972 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07005973 }
5974
5975 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005976 * Find and return all touchable views that are descendants of this view,
5977 * possibly including this view if it is touchable itself.
5978 *
5979 * @return A list of touchable views
5980 */
5981 public ArrayList<View> getTouchables() {
5982 ArrayList<View> result = new ArrayList<View>();
5983 addTouchables(result);
5984 return result;
5985 }
5986
5987 /**
5988 * Add any touchable views that are descendants of this view (possibly
5989 * including this view if it is touchable itself) to views.
5990 *
5991 * @param views Touchable views found so far
5992 */
5993 public void addTouchables(ArrayList<View> views) {
5994 final int viewFlags = mViewFlags;
5995
5996 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
5997 && (viewFlags & ENABLED_MASK) == ENABLED) {
5998 views.add(this);
5999 }
6000 }
6001
6002 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006003 * Returns whether this View is accessibility focused.
6004 *
6005 * @return True if this View is accessibility focused.
6006 */
6007 boolean isAccessibilityFocused() {
6008 return (mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0;
6009 }
6010
6011 /**
6012 * Call this to try to give accessibility focus to this view.
6013 *
6014 * A view will not actually take focus if {@link AccessibilityManager#isEnabled()}
6015 * returns false or the view is no visible or the view already has accessibility
6016 * focus.
6017 *
6018 * See also {@link #focusSearch(int)}, which is what you call to say that you
6019 * have focus, and you want your parent to look for the next one.
6020 *
6021 * @return Whether this view actually took accessibility focus.
6022 *
6023 * @hide
6024 */
6025 public boolean requestAccessibilityFocus() {
Svetoslav Ganov07b726c2012-04-30 12:24:57 -07006026 AccessibilityManager manager = AccessibilityManager.getInstance(mContext);
6027 if (!manager.isEnabled() || !manager.isTouchExplorationEnabled()) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006028 return false;
6029 }
6030 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) {
6031 return false;
6032 }
6033 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) == 0) {
6034 mPrivateFlags2 |= ACCESSIBILITY_FOCUSED;
6035 ViewRootImpl viewRootImpl = getViewRootImpl();
6036 if (viewRootImpl != null) {
6037 viewRootImpl.setAccessibilityFocusedHost(this);
6038 }
6039 invalidate();
6040 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED);
6041 notifyAccessibilityStateChanged();
6042 // Try to give input focus to this view - not a descendant.
6043 requestFocusNoSearch(View.FOCUS_DOWN, null);
6044 return true;
6045 }
6046 return false;
6047 }
6048
6049 /**
6050 * Call this to try to clear accessibility focus of this view.
6051 *
6052 * See also {@link #focusSearch(int)}, which is what you call to say that you
6053 * have focus, and you want your parent to look for the next one.
6054 *
6055 * @hide
6056 */
6057 public void clearAccessibilityFocus() {
6058 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0) {
6059 mPrivateFlags2 &= ~ACCESSIBILITY_FOCUSED;
6060 ViewRootImpl viewRootImpl = getViewRootImpl();
6061 if (viewRootImpl != null) {
6062 viewRootImpl.setAccessibilityFocusedHost(null);
6063 }
6064 invalidate();
6065 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED);
6066 notifyAccessibilityStateChanged();
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006067
6068 // Clear the text navigation state.
6069 setAccessibilityCursorPosition(-1);
6070
Svetoslav Ganov42138042012-03-20 11:51:39 -07006071 // Try to move accessibility focus to the input focus.
6072 View rootView = getRootView();
6073 if (rootView != null) {
6074 View inputFocus = rootView.findFocus();
6075 if (inputFocus != null) {
6076 inputFocus.requestAccessibilityFocus();
6077 }
6078 }
6079 }
6080 }
6081
6082 /**
6083 * Find the best view to take accessibility focus from a hover.
6084 * This function finds the deepest actionable view and if that
6085 * fails ask the parent to take accessibility focus from hover.
6086 *
6087 * @param x The X hovered location in this view coorditantes.
6088 * @param y The Y hovered location in this view coorditantes.
6089 * @return Whether the request was handled.
6090 *
6091 * @hide
6092 */
6093 public boolean requestAccessibilityFocusFromHover(float x, float y) {
6094 if (onRequestAccessibilityFocusFromHover(x, y)) {
6095 return true;
6096 }
6097 ViewParent parent = mParent;
6098 if (parent instanceof View) {
6099 View parentView = (View) parent;
6100
6101 float[] position = mAttachInfo.mTmpTransformLocation;
6102 position[0] = x;
6103 position[1] = y;
6104
6105 // Compensate for the transformation of the current matrix.
6106 if (!hasIdentityMatrix()) {
6107 getMatrix().mapPoints(position);
6108 }
6109
6110 // Compensate for the parent scroll and the offset
6111 // of this view stop from the parent top.
6112 position[0] += mLeft - parentView.mScrollX;
6113 position[1] += mTop - parentView.mScrollY;
6114
6115 return parentView.requestAccessibilityFocusFromHover(position[0], position[1]);
6116 }
6117 return false;
6118 }
6119
6120 /**
6121 * Requests to give this View focus from hover.
6122 *
6123 * @param x The X hovered location in this view coorditantes.
6124 * @param y The Y hovered location in this view coorditantes.
6125 * @return Whether the request was handled.
6126 *
6127 * @hide
6128 */
6129 public boolean onRequestAccessibilityFocusFromHover(float x, float y) {
6130 if (includeForAccessibility()
6131 && (isActionableForAccessibility() || hasListenersForAccessibility())) {
6132 return requestAccessibilityFocus();
6133 }
6134 return false;
6135 }
6136
6137 /**
6138 * Clears accessibility focus without calling any callback methods
6139 * normally invoked in {@link #clearAccessibilityFocus()}. This method
6140 * is used for clearing accessibility focus when giving this focus to
6141 * another view.
6142 */
6143 void clearAccessibilityFocusNoCallbacks() {
6144 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0) {
6145 mPrivateFlags2 &= ~ACCESSIBILITY_FOCUSED;
6146 invalidate();
6147 }
6148 }
6149
6150 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006151 * Call this to try to give focus to a specific view or to one of its
6152 * descendants.
6153 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006154 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6155 * false), or if it is focusable and it is not focusable in touch mode
6156 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006157 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006158 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006159 * have focus, and you want your parent to look for the next one.
6160 *
6161 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
6162 * {@link #FOCUS_DOWN} and <code>null</code>.
6163 *
6164 * @return Whether this view or one of its descendants actually took focus.
6165 */
6166 public final boolean requestFocus() {
6167 return requestFocus(View.FOCUS_DOWN);
6168 }
6169
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006170 /**
6171 * Call this to try to give focus to a specific view or to one of its
6172 * descendants and give it a hint about what direction focus is heading.
6173 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006174 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6175 * false), or if it is focusable and it is not focusable in touch mode
6176 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006177 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006178 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006179 * have focus, and you want your parent to look for the next one.
6180 *
6181 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
6182 * <code>null</code> set for the previously focused rectangle.
6183 *
6184 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
6185 * @return Whether this view or one of its descendants actually took focus.
6186 */
6187 public final boolean requestFocus(int direction) {
6188 return requestFocus(direction, null);
6189 }
6190
6191 /**
6192 * Call this to try to give focus to a specific view or to one of its descendants
6193 * and give it hints about the direction and a specific rectangle that the focus
6194 * is coming from. The rectangle can help give larger views a finer grained hint
6195 * about where focus is coming from, and therefore, where to show selection, or
6196 * forward focus change internally.
6197 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006198 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6199 * false), or if it is focusable and it is not focusable in touch mode
6200 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006201 *
6202 * A View will not take focus if it is not visible.
6203 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006204 * A View will not take focus if one of its parents has
6205 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to
6206 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006207 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006208 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006209 * have focus, and you want your parent to look for the next one.
6210 *
6211 * You may wish to override this method if your custom {@link View} has an internal
6212 * {@link View} that it wishes to forward the request to.
6213 *
6214 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
6215 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
6216 * to give a finer grained hint about where focus is coming from. May be null
6217 * if there is no hint.
6218 * @return Whether this view or one of its descendants actually took focus.
6219 */
6220 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006221 return requestFocusNoSearch(direction, previouslyFocusedRect);
6222 }
6223
6224 private boolean requestFocusNoSearch(int direction, Rect previouslyFocusedRect) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006225 // need to be focusable
6226 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
6227 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
6228 return false;
6229 }
6230
6231 // need to be focusable in touch mode if in touch mode
6232 if (isInTouchMode() &&
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006233 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
6234 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006235 }
6236
6237 // need to not have any parents blocking us
6238 if (hasAncestorThatBlocksDescendantFocus()) {
6239 return false;
6240 }
6241
6242 handleFocusGainInternal(direction, previouslyFocusedRect);
6243 return true;
6244 }
6245
6246 /**
6247 * Call this to try to give focus to a specific view or to one of its descendants. This is a
6248 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
6249 * touch mode to request focus when they are touched.
6250 *
6251 * @return Whether this view or one of its descendants actually took focus.
6252 *
6253 * @see #isInTouchMode()
6254 *
6255 */
6256 public final boolean requestFocusFromTouch() {
6257 // Leave touch mode if we need to
6258 if (isInTouchMode()) {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07006259 ViewRootImpl viewRoot = getViewRootImpl();
Christopher Tate2c095f32010-10-04 14:13:40 -07006260 if (viewRoot != null) {
6261 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006262 }
6263 }
6264 return requestFocus(View.FOCUS_DOWN);
6265 }
6266
6267 /**
6268 * @return Whether any ancestor of this view blocks descendant focus.
6269 */
6270 private boolean hasAncestorThatBlocksDescendantFocus() {
6271 ViewParent ancestor = mParent;
6272 while (ancestor instanceof ViewGroup) {
6273 final ViewGroup vgAncestor = (ViewGroup) ancestor;
6274 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
6275 return true;
6276 } else {
6277 ancestor = vgAncestor.getParent();
6278 }
6279 }
6280 return false;
6281 }
6282
6283 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006284 * Gets the mode for determining whether this View is important for accessibility
6285 * which is if it fires accessibility events and if it is reported to
6286 * accessibility services that query the screen.
6287 *
6288 * @return The mode for determining whether a View is important for accessibility.
6289 *
6290 * @attr ref android.R.styleable#View_importantForAccessibility
6291 *
6292 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES
6293 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO
6294 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO
6295 */
6296 @ViewDebug.ExportedProperty(category = "accessibility", mapping = {
6297 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_AUTO,
6298 to = "IMPORTANT_FOR_ACCESSIBILITY_AUTO"),
6299 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_YES,
6300 to = "IMPORTANT_FOR_ACCESSIBILITY_YES"),
6301 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO,
6302 to = "IMPORTANT_FOR_ACCESSIBILITY_NO")
6303 })
6304 public int getImportantForAccessibility() {
6305 return (mPrivateFlags2 & IMPORTANT_FOR_ACCESSIBILITY_MASK)
6306 >> IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
6307 }
6308
6309 /**
6310 * Sets how to determine whether this view is important for accessibility
6311 * which is if it fires accessibility events and if it is reported to
6312 * accessibility services that query the screen.
6313 *
6314 * @param mode How to determine whether this view is important for accessibility.
6315 *
6316 * @attr ref android.R.styleable#View_importantForAccessibility
6317 *
6318 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES
6319 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO
6320 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO
6321 */
6322 public void setImportantForAccessibility(int mode) {
6323 if (mode != getImportantForAccessibility()) {
6324 mPrivateFlags2 &= ~IMPORTANT_FOR_ACCESSIBILITY_MASK;
6325 mPrivateFlags2 |= (mode << IMPORTANT_FOR_ACCESSIBILITY_SHIFT)
6326 & IMPORTANT_FOR_ACCESSIBILITY_MASK;
6327 notifyAccessibilityStateChanged();
6328 }
6329 }
6330
6331 /**
6332 * Gets whether this view should be exposed for accessibility.
6333 *
6334 * @return Whether the view is exposed for accessibility.
6335 *
6336 * @hide
6337 */
6338 public boolean isImportantForAccessibility() {
6339 final int mode = (mPrivateFlags2 & IMPORTANT_FOR_ACCESSIBILITY_MASK)
6340 >> IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
6341 switch (mode) {
6342 case IMPORTANT_FOR_ACCESSIBILITY_YES:
6343 return true;
6344 case IMPORTANT_FOR_ACCESSIBILITY_NO:
6345 return false;
6346 case IMPORTANT_FOR_ACCESSIBILITY_AUTO:
6347 return isActionableForAccessibility() || hasListenersForAccessibility();
6348 default:
6349 throw new IllegalArgumentException("Unknow important for accessibility mode: "
6350 + mode);
6351 }
6352 }
6353
6354 /**
6355 * Gets the parent for accessibility purposes. Note that the parent for
6356 * accessibility is not necessary the immediate parent. It is the first
6357 * predecessor that is important for accessibility.
6358 *
6359 * @return The parent for accessibility purposes.
6360 */
6361 public ViewParent getParentForAccessibility() {
6362 if (mParent instanceof View) {
6363 View parentView = (View) mParent;
6364 if (parentView.includeForAccessibility()) {
6365 return mParent;
6366 } else {
6367 return mParent.getParentForAccessibility();
6368 }
6369 }
6370 return null;
6371 }
6372
6373 /**
6374 * Adds the children of a given View for accessibility. Since some Views are
6375 * not important for accessibility the children for accessibility are not
6376 * necessarily direct children of the riew, rather they are the first level of
6377 * descendants important for accessibility.
6378 *
6379 * @param children The list of children for accessibility.
6380 */
6381 public void addChildrenForAccessibility(ArrayList<View> children) {
6382 if (includeForAccessibility()) {
6383 children.add(this);
6384 }
6385 }
6386
6387 /**
6388 * Whether to regard this view for accessibility. A view is regarded for
6389 * accessibility if it is important for accessibility or the querying
6390 * accessibility service has explicitly requested that view not
6391 * important for accessibility are regarded.
6392 *
6393 * @return Whether to regard the view for accessibility.
6394 */
6395 boolean includeForAccessibility() {
6396 if (mAttachInfo != null) {
6397 if (!mAttachInfo.mIncludeNotImportantViews) {
Svetoslav Ganov749e7962012-04-19 17:13:46 -07006398 return isImportantForAccessibility() && isDisplayedOnScreen();
Svetoslav Ganov42138042012-03-20 11:51:39 -07006399 } else {
Svetoslav Ganov749e7962012-04-19 17:13:46 -07006400 return isDisplayedOnScreen();
Svetoslav Ganov42138042012-03-20 11:51:39 -07006401 }
6402 }
6403 return false;
6404 }
6405
6406 /**
6407 * Returns whether the View is considered actionable from
6408 * accessibility perspective. Such view are important for
6409 * accessiiblity.
6410 *
6411 * @return True if the view is actionable for accessibility.
6412 */
6413 private boolean isActionableForAccessibility() {
6414 return (isClickable() || isLongClickable() || isFocusable());
6415 }
6416
6417 /**
6418 * Returns whether the View has registered callbacks wich makes it
6419 * important for accessiiblity.
6420 *
6421 * @return True if the view is actionable for accessibility.
6422 */
6423 private boolean hasListenersForAccessibility() {
6424 ListenerInfo info = getListenerInfo();
6425 return mTouchDelegate != null || info.mOnKeyListener != null
6426 || info.mOnTouchListener != null || info.mOnGenericMotionListener != null
6427 || info.mOnHoverListener != null || info.mOnDragListener != null;
6428 }
6429
6430 /**
6431 * Notifies accessibility services that some view's important for
6432 * accessibility state has changed. Note that such notifications
6433 * are made at most once every
6434 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}
6435 * to avoid unnecessary load to the system. Also once a view has
6436 * made a notifucation this method is a NOP until the notification has
6437 * been sent to clients.
6438 *
6439 * @hide
6440 *
6441 * TODO: Makse sure this method is called for any view state change
6442 * that is interesting for accessilility purposes.
6443 */
6444 public void notifyAccessibilityStateChanged() {
6445 if ((mPrivateFlags2 & ACCESSIBILITY_STATE_CHANGED) == 0) {
6446 mPrivateFlags2 |= ACCESSIBILITY_STATE_CHANGED;
6447 if (mParent != null) {
6448 mParent.childAccessibilityStateChanged(this);
6449 }
6450 }
6451 }
6452
6453 /**
6454 * Reset the state indicating the this view has requested clients
6455 * interested in its accessiblity state to be notified.
6456 *
6457 * @hide
6458 */
6459 public void resetAccessibilityStateChanged() {
6460 mPrivateFlags2 &= ~ACCESSIBILITY_STATE_CHANGED;
6461 }
6462
6463 /**
6464 * Performs the specified accessibility action on the view. For
6465 * possible accessibility actions look at {@link AccessibilityNodeInfo}.
alanv8eeefef2012-05-07 16:57:53 -07006466 * <p>
6467 * If an {@link AccessibilityDelegate} has been specified via calling
6468 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
6469 * {@link AccessibilityDelegate#performAccessibilityAction(View, int, Bundle)}
6470 * is responsible for handling this call.
6471 * </p>
Svetoslav Ganov42138042012-03-20 11:51:39 -07006472 *
6473 * @param action The action to perform.
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006474 * @param arguments Optional action arguments.
Svetoslav Ganov42138042012-03-20 11:51:39 -07006475 * @return Whether the action was performed.
6476 */
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006477 public boolean performAccessibilityAction(int action, Bundle arguments) {
alanv8eeefef2012-05-07 16:57:53 -07006478 if (mAccessibilityDelegate != null) {
6479 return mAccessibilityDelegate.performAccessibilityAction(this, action, arguments);
6480 } else {
6481 return performAccessibilityActionInternal(action, arguments);
6482 }
6483 }
6484
6485 /**
6486 * @see #performAccessibilityAction(int, Bundle)
6487 *
6488 * Note: Called from the default {@link AccessibilityDelegate}.
6489 */
6490 boolean performAccessibilityActionInternal(int action, Bundle arguments) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006491 switch (action) {
6492 case AccessibilityNodeInfo.ACTION_CLICK: {
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006493 if (isClickable()) {
Svetoslav Ganov773f2622012-05-05 19:59:42 -07006494 return performClick();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006495 }
6496 } break;
6497 case AccessibilityNodeInfo.ACTION_LONG_CLICK: {
6498 if (isLongClickable()) {
Svetoslav Ganov773f2622012-05-05 19:59:42 -07006499 return performLongClick();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006500 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006501 } break;
6502 case AccessibilityNodeInfo.ACTION_FOCUS: {
6503 if (!hasFocus()) {
6504 // Get out of touch mode since accessibility
6505 // wants to move focus around.
6506 getViewRootImpl().ensureTouchMode(false);
6507 return requestFocus();
6508 }
6509 } break;
6510 case AccessibilityNodeInfo.ACTION_CLEAR_FOCUS: {
6511 if (hasFocus()) {
6512 clearFocus();
6513 return !isFocused();
6514 }
6515 } break;
6516 case AccessibilityNodeInfo.ACTION_SELECT: {
6517 if (!isSelected()) {
6518 setSelected(true);
6519 return isSelected();
6520 }
6521 } break;
6522 case AccessibilityNodeInfo.ACTION_CLEAR_SELECTION: {
6523 if (isSelected()) {
6524 setSelected(false);
6525 return !isSelected();
6526 }
6527 } break;
6528 case AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS: {
6529 if (!isAccessibilityFocused()) {
6530 return requestAccessibilityFocus();
6531 }
6532 } break;
6533 case AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS: {
6534 if (isAccessibilityFocused()) {
6535 clearAccessibilityFocus();
6536 return true;
6537 }
6538 } break;
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006539 case AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY: {
6540 if (arguments != null) {
6541 final int granularity = arguments.getInt(
6542 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT);
6543 return nextAtGranularity(granularity);
6544 }
6545 } break;
6546 case AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: {
6547 if (arguments != null) {
6548 final int granularity = arguments.getInt(
6549 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT);
6550 return previousAtGranularity(granularity);
6551 }
6552 } break;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006553 }
6554 return false;
6555 }
6556
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006557 private boolean nextAtGranularity(int granularity) {
6558 CharSequence text = getIterableTextForAccessibility();
6559 if (text != null && text.length() > 0) {
6560 return false;
6561 }
6562 TextSegmentIterator iterator = getIteratorForGranularity(granularity);
6563 if (iterator == null) {
6564 return false;
6565 }
6566 final int current = getAccessibilityCursorPosition();
6567 final int[] range = iterator.following(current);
6568 if (range == null) {
6569 setAccessibilityCursorPosition(-1);
6570 return false;
6571 }
6572 final int start = range[0];
6573 final int end = range[1];
6574 setAccessibilityCursorPosition(start);
6575 sendViewTextTraversedAtGranularityEvent(
6576 AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY,
6577 granularity, start, end);
6578 return true;
6579 }
6580
6581 private boolean previousAtGranularity(int granularity) {
6582 CharSequence text = getIterableTextForAccessibility();
6583 if (text != null && text.length() > 0) {
6584 return false;
6585 }
6586 TextSegmentIterator iterator = getIteratorForGranularity(granularity);
6587 if (iterator == null) {
6588 return false;
6589 }
6590 final int selectionStart = getAccessibilityCursorPosition();
6591 final int current = selectionStart >= 0 ? selectionStart : text.length() + 1;
6592 final int[] range = iterator.preceding(current);
6593 if (range == null) {
6594 setAccessibilityCursorPosition(-1);
6595 return false;
6596 }
6597 final int start = range[0];
6598 final int end = range[1];
6599 setAccessibilityCursorPosition(end);
6600 sendViewTextTraversedAtGranularityEvent(
6601 AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY,
6602 granularity, start, end);
6603 return true;
6604 }
6605
6606 /**
6607 * Gets the text reported for accessibility purposes.
6608 *
6609 * @return The accessibility text.
6610 *
6611 * @hide
6612 */
6613 public CharSequence getIterableTextForAccessibility() {
6614 return mContentDescription;
6615 }
6616
6617 /**
6618 * @hide
6619 */
6620 public int getAccessibilityCursorPosition() {
6621 return mAccessibilityCursorPosition;
6622 }
6623
6624 /**
6625 * @hide
6626 */
6627 public void setAccessibilityCursorPosition(int position) {
6628 mAccessibilityCursorPosition = position;
6629 }
6630
6631 private void sendViewTextTraversedAtGranularityEvent(int action, int granularity,
6632 int fromIndex, int toIndex) {
6633 if (mParent == null) {
6634 return;
6635 }
6636 AccessibilityEvent event = AccessibilityEvent.obtain(
6637 AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY);
6638 onInitializeAccessibilityEvent(event);
6639 onPopulateAccessibilityEvent(event);
6640 event.setFromIndex(fromIndex);
6641 event.setToIndex(toIndex);
6642 event.setAction(action);
6643 event.setMovementGranularity(granularity);
6644 mParent.requestSendAccessibilityEvent(this, event);
6645 }
6646
6647 /**
6648 * @hide
6649 */
6650 public TextSegmentIterator getIteratorForGranularity(int granularity) {
6651 switch (granularity) {
6652 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER: {
6653 CharSequence text = getIterableTextForAccessibility();
6654 if (text != null && text.length() > 0) {
6655 CharacterTextSegmentIterator iterator =
6656 CharacterTextSegmentIterator.getInstance(mContext);
6657 iterator.initialize(text.toString());
6658 return iterator;
6659 }
6660 } break;
6661 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD: {
6662 CharSequence text = getIterableTextForAccessibility();
6663 if (text != null && text.length() > 0) {
6664 WordTextSegmentIterator iterator =
6665 WordTextSegmentIterator.getInstance(mContext);
6666 iterator.initialize(text.toString());
6667 return iterator;
6668 }
6669 } break;
6670 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH: {
6671 CharSequence text = getIterableTextForAccessibility();
6672 if (text != null && text.length() > 0) {
6673 ParagraphTextSegmentIterator iterator =
6674 ParagraphTextSegmentIterator.getInstance();
6675 iterator.initialize(text.toString());
6676 return iterator;
6677 }
6678 } break;
6679 }
6680 return null;
6681 }
6682
Svetoslav Ganov42138042012-03-20 11:51:39 -07006683 /**
Romain Guya440b002010-02-24 15:57:54 -08006684 * @hide
6685 */
6686 public void dispatchStartTemporaryDetach() {
6687 onStartTemporaryDetach();
6688 }
6689
6690 /**
6691 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006692 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
6693 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08006694 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006695 */
6696 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08006697 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08006698 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08006699 }
6700
6701 /**
6702 * @hide
6703 */
6704 public void dispatchFinishTemporaryDetach() {
6705 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006706 }
Romain Guy8506ab42009-06-11 17:35:47 -07006707
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006708 /**
6709 * Called after {@link #onStartTemporaryDetach} when the container is done
6710 * changing the view.
6711 */
6712 public void onFinishTemporaryDetach() {
6713 }
Romain Guy8506ab42009-06-11 17:35:47 -07006714
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006715 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006716 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
6717 * for this view's window. Returns null if the view is not currently attached
6718 * to the window. Normally you will not need to use this directly, but
Romain Guy5c22a8c2011-05-13 11:48:45 -07006719 * just use the standard high-level event callbacks like
6720 * {@link #onKeyDown(int, KeyEvent)}.
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006721 */
6722 public KeyEvent.DispatcherState getKeyDispatcherState() {
6723 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
6724 }
Joe Malin32736f02011-01-19 16:14:20 -08006725
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006726 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006727 * Dispatch a key event before it is processed by any input method
6728 * associated with the view hierarchy. This can be used to intercept
6729 * key events in special situations before the IME consumes them; a
6730 * typical example would be handling the BACK key to update the application's
6731 * UI instead of allowing the IME to see it and close itself.
6732 *
6733 * @param event The key event to be dispatched.
6734 * @return True if the event was handled, false otherwise.
6735 */
6736 public boolean dispatchKeyEventPreIme(KeyEvent event) {
6737 return onKeyPreIme(event.getKeyCode(), event);
6738 }
6739
6740 /**
6741 * Dispatch a key event to the next view on the focus path. This path runs
6742 * from the top of the view tree down to the currently focused view. If this
6743 * view has focus, it will dispatch to itself. Otherwise it will dispatch
6744 * the next node down the focus path. This method also fires any key
6745 * listeners.
6746 *
6747 * @param event The key event to be dispatched.
6748 * @return True if the event was handled, false otherwise.
6749 */
6750 public boolean dispatchKeyEvent(KeyEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006751 if (mInputEventConsistencyVerifier != null) {
6752 mInputEventConsistencyVerifier.onKeyEvent(event, 0);
6753 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006754
Jeff Brown21bc5c92011-02-28 18:27:14 -08006755 // Give any attached key listener a first crack at the event.
Romain Guyf607bdc2010-09-10 19:20:06 -07006756 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006757 ListenerInfo li = mListenerInfo;
6758 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
6759 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006760 return true;
6761 }
6762
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006763 if (event.dispatch(this, mAttachInfo != null
6764 ? mAttachInfo.mKeyDispatchState : null, this)) {
6765 return true;
6766 }
6767
6768 if (mInputEventConsistencyVerifier != null) {
6769 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
6770 }
6771 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006772 }
6773
6774 /**
6775 * Dispatches a key shortcut event.
6776 *
6777 * @param event The key event to be dispatched.
6778 * @return True if the event was handled by the view, false otherwise.
6779 */
6780 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
6781 return onKeyShortcut(event.getKeyCode(), event);
6782 }
6783
6784 /**
6785 * Pass the touch screen motion event down to the target view, or this
6786 * view if it is the target.
6787 *
6788 * @param event The motion event to be dispatched.
6789 * @return True if the event was handled by the view, false otherwise.
6790 */
6791 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006792 if (mInputEventConsistencyVerifier != null) {
6793 mInputEventConsistencyVerifier.onTouchEvent(event, 0);
6794 }
6795
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006796 if (onFilterTouchEventForSecurity(event)) {
6797 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006798 ListenerInfo li = mListenerInfo;
6799 if (li != null && li.mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
6800 && li.mOnTouchListener.onTouch(this, event)) {
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006801 return true;
6802 }
6803
6804 if (onTouchEvent(event)) {
6805 return true;
6806 }
Jeff Brown85a31762010-09-01 17:01:00 -07006807 }
6808
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006809 if (mInputEventConsistencyVerifier != null) {
6810 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006811 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006812 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006813 }
6814
6815 /**
Jeff Brown85a31762010-09-01 17:01:00 -07006816 * Filter the touch event to apply security policies.
6817 *
6818 * @param event The motion event to be filtered.
6819 * @return True if the event should be dispatched, false if the event should be dropped.
Joe Malin32736f02011-01-19 16:14:20 -08006820 *
Jeff Brown85a31762010-09-01 17:01:00 -07006821 * @see #getFilterTouchesWhenObscured
6822 */
6823 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07006824 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07006825 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
6826 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
6827 // Window is obscured, drop this touch.
6828 return false;
6829 }
6830 return true;
6831 }
6832
6833 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006834 * Pass a trackball motion event down to the focused view.
6835 *
6836 * @param event The motion event to be dispatched.
6837 * @return True if the event was handled by the view, false otherwise.
6838 */
6839 public boolean dispatchTrackballEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006840 if (mInputEventConsistencyVerifier != null) {
6841 mInputEventConsistencyVerifier.onTrackballEvent(event, 0);
6842 }
6843
Romain Guy02ccac62011-06-24 13:20:23 -07006844 return onTrackballEvent(event);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006845 }
6846
6847 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08006848 * Dispatch a generic motion event.
6849 * <p>
6850 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
6851 * are delivered to the view under the pointer. All other generic motion events are
Jeff Browna032cc02011-03-07 16:56:21 -08006852 * delivered to the focused view. Hover events are handled specially and are delivered
Romain Guy5c22a8c2011-05-13 11:48:45 -07006853 * to {@link #onHoverEvent(MotionEvent)}.
Jeff Brown33bbfd22011-02-24 20:55:35 -08006854 * </p>
Jeff Browncb1404e2011-01-15 18:14:15 -08006855 *
6856 * @param event The motion event to be dispatched.
6857 * @return True if the event was handled by the view, false otherwise.
6858 */
6859 public boolean dispatchGenericMotionEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006860 if (mInputEventConsistencyVerifier != null) {
6861 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0);
6862 }
6863
Jeff Browna032cc02011-03-07 16:56:21 -08006864 final int source = event.getSource();
6865 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) {
6866 final int action = event.getAction();
6867 if (action == MotionEvent.ACTION_HOVER_ENTER
6868 || action == MotionEvent.ACTION_HOVER_MOVE
6869 || action == MotionEvent.ACTION_HOVER_EXIT) {
6870 if (dispatchHoverEvent(event)) {
6871 return true;
6872 }
6873 } else if (dispatchGenericPointerEvent(event)) {
6874 return true;
6875 }
6876 } else if (dispatchGenericFocusedEvent(event)) {
6877 return true;
6878 }
6879
Jeff Brown10b62902011-06-20 16:40:37 -07006880 if (dispatchGenericMotionEventInternal(event)) {
6881 return true;
6882 }
6883
6884 if (mInputEventConsistencyVerifier != null) {
6885 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
6886 }
6887 return false;
6888 }
6889
6890 private boolean dispatchGenericMotionEventInternal(MotionEvent event) {
Romain Guy7b5b6ab2011-03-14 18:05:08 -07006891 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006892 ListenerInfo li = mListenerInfo;
6893 if (li != null && li.mOnGenericMotionListener != null
6894 && (mViewFlags & ENABLED_MASK) == ENABLED
6895 && li.mOnGenericMotionListener.onGenericMotion(this, event)) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08006896 return true;
6897 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006898
6899 if (onGenericMotionEvent(event)) {
6900 return true;
6901 }
6902
6903 if (mInputEventConsistencyVerifier != null) {
6904 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
6905 }
6906 return false;
Jeff Browncb1404e2011-01-15 18:14:15 -08006907 }
6908
6909 /**
Jeff Browna032cc02011-03-07 16:56:21 -08006910 * Dispatch a hover event.
6911 * <p>
Philip Milne6c8ea062012-04-03 17:38:43 -07006912 * Do not call this method directly.
Romain Guy5c22a8c2011-05-13 11:48:45 -07006913 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08006914 * </p>
6915 *
6916 * @param event The motion event to be dispatched.
6917 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08006918 */
6919 protected boolean dispatchHoverEvent(MotionEvent event) {
Romain Guy02ccac62011-06-24 13:20:23 -07006920 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006921 ListenerInfo li = mListenerInfo;
6922 if (li != null && li.mOnHoverListener != null
6923 && (mViewFlags & ENABLED_MASK) == ENABLED
6924 && li.mOnHoverListener.onHover(this, event)) {
Jeff Brown10b62902011-06-20 16:40:37 -07006925 return true;
6926 }
6927
Jeff Browna032cc02011-03-07 16:56:21 -08006928 return onHoverEvent(event);
6929 }
6930
6931 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07006932 * Returns true if the view has a child to which it has recently sent
6933 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and
6934 * it does not have a hovered child, then it must be the innermost hovered view.
6935 * @hide
6936 */
6937 protected boolean hasHoveredChild() {
6938 return false;
6939 }
6940
6941 /**
Jeff Browna032cc02011-03-07 16:56:21 -08006942 * Dispatch a generic motion event to the view under the first pointer.
6943 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07006944 * Do not call this method directly.
6945 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08006946 * </p>
6947 *
6948 * @param event The motion event to be dispatched.
6949 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08006950 */
6951 protected boolean dispatchGenericPointerEvent(MotionEvent event) {
6952 return false;
6953 }
6954
6955 /**
6956 * Dispatch a generic motion event to the currently focused view.
6957 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07006958 * Do not call this method directly.
6959 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08006960 * </p>
6961 *
6962 * @param event The motion event to be dispatched.
6963 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08006964 */
6965 protected boolean dispatchGenericFocusedEvent(MotionEvent event) {
6966 return false;
6967 }
6968
6969 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08006970 * Dispatch a pointer event.
6971 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07006972 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all
6973 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns
6974 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches
Jeff Brown33bbfd22011-02-24 20:55:35 -08006975 * and should not be expected to handle other pointing device features.
6976 * </p>
6977 *
6978 * @param event The motion event to be dispatched.
6979 * @return True if the event was handled by the view, false otherwise.
6980 * @hide
6981 */
6982 public final boolean dispatchPointerEvent(MotionEvent event) {
6983 if (event.isTouchEvent()) {
6984 return dispatchTouchEvent(event);
6985 } else {
6986 return dispatchGenericMotionEvent(event);
6987 }
6988 }
6989
6990 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006991 * Called when the window containing this view gains or loses window focus.
6992 * ViewGroups should override to route to their children.
6993 *
6994 * @param hasFocus True if the window containing this view now has focus,
6995 * false otherwise.
6996 */
6997 public void dispatchWindowFocusChanged(boolean hasFocus) {
6998 onWindowFocusChanged(hasFocus);
6999 }
7000
7001 /**
7002 * Called when the window containing this view gains or loses focus. Note
7003 * that this is separate from view focus: to receive key events, both
7004 * your view and its window must have focus. If a window is displayed
7005 * on top of yours that takes input focus, then your own window will lose
7006 * focus but the view focus will remain unchanged.
7007 *
7008 * @param hasWindowFocus True if the window containing this view now has
7009 * focus, false otherwise.
7010 */
7011 public void onWindowFocusChanged(boolean hasWindowFocus) {
7012 InputMethodManager imm = InputMethodManager.peekInstance();
7013 if (!hasWindowFocus) {
7014 if (isPressed()) {
7015 setPressed(false);
7016 }
7017 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
7018 imm.focusOut(this);
7019 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05007020 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08007021 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07007022 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007023 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
7024 imm.focusIn(this);
7025 }
7026 refreshDrawableState();
7027 }
7028
7029 /**
7030 * Returns true if this view is in a window that currently has window focus.
7031 * Note that this is not the same as the view itself having focus.
7032 *
7033 * @return True if this view is in a window that currently has window focus.
7034 */
7035 public boolean hasWindowFocus() {
7036 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
7037 }
7038
7039 /**
Adam Powell326d8082009-12-09 15:10:07 -08007040 * Dispatch a view visibility change down the view hierarchy.
7041 * ViewGroups should override to route to their children.
7042 * @param changedView The view whose visibility changed. Could be 'this' or
7043 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08007044 * @param visibility The new visibility of changedView: {@link #VISIBLE},
7045 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08007046 */
7047 protected void dispatchVisibilityChanged(View changedView, int visibility) {
7048 onVisibilityChanged(changedView, visibility);
7049 }
7050
7051 /**
7052 * Called when the visibility of the view or an ancestor of the view is changed.
7053 * @param changedView The view whose visibility changed. Could be 'this' or
7054 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08007055 * @param visibility The new visibility of changedView: {@link #VISIBLE},
7056 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08007057 */
7058 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07007059 if (visibility == VISIBLE) {
7060 if (mAttachInfo != null) {
7061 initialAwakenScrollBars();
7062 } else {
7063 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
7064 }
7065 }
Adam Powell326d8082009-12-09 15:10:07 -08007066 }
7067
7068 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08007069 * Dispatch a hint about whether this view is displayed. For instance, when
7070 * a View moves out of the screen, it might receives a display hint indicating
7071 * the view is not displayed. Applications should not <em>rely</em> on this hint
7072 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08007073 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08007074 * @param hint A hint about whether or not this view is displayed:
7075 * {@link #VISIBLE} or {@link #INVISIBLE}.
7076 */
7077 public void dispatchDisplayHint(int hint) {
7078 onDisplayHint(hint);
7079 }
7080
7081 /**
7082 * Gives this view a hint about whether is displayed or not. For instance, when
7083 * a View moves out of the screen, it might receives a display hint indicating
7084 * the view is not displayed. Applications should not <em>rely</em> on this hint
7085 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08007086 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08007087 * @param hint A hint about whether or not this view is displayed:
7088 * {@link #VISIBLE} or {@link #INVISIBLE}.
7089 */
7090 protected void onDisplayHint(int hint) {
7091 }
7092
7093 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007094 * Dispatch a window visibility change down the view hierarchy.
7095 * ViewGroups should override to route to their children.
7096 *
7097 * @param visibility The new visibility of the window.
7098 *
Philip Milne6c8ea062012-04-03 17:38:43 -07007099 * @see #onWindowVisibilityChanged(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007100 */
7101 public void dispatchWindowVisibilityChanged(int visibility) {
7102 onWindowVisibilityChanged(visibility);
7103 }
7104
7105 /**
7106 * Called when the window containing has change its visibility
7107 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
7108 * that this tells you whether or not your window is being made visible
7109 * to the window manager; this does <em>not</em> tell you whether or not
7110 * your window is obscured by other windows on the screen, even if it
7111 * is itself visible.
7112 *
7113 * @param visibility The new visibility of the window.
7114 */
7115 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07007116 if (visibility == VISIBLE) {
7117 initialAwakenScrollBars();
7118 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007119 }
7120
7121 /**
7122 * Returns the current visibility of the window this view is attached to
7123 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
7124 *
7125 * @return Returns the current visibility of the view's window.
7126 */
7127 public int getWindowVisibility() {
7128 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
7129 }
7130
7131 /**
7132 * Retrieve the overall visible display size in which the window this view is
7133 * attached to has been positioned in. This takes into account screen
7134 * decorations above the window, for both cases where the window itself
7135 * is being position inside of them or the window is being placed under
7136 * then and covered insets are used for the window to position its content
7137 * inside. In effect, this tells you the available area where content can
7138 * be placed and remain visible to users.
7139 *
7140 * <p>This function requires an IPC back to the window manager to retrieve
7141 * the requested information, so should not be used in performance critical
7142 * code like drawing.
7143 *
7144 * @param outRect Filled in with the visible display frame. If the view
7145 * is not attached to a window, this is simply the raw display size.
7146 */
7147 public void getWindowVisibleDisplayFrame(Rect outRect) {
7148 if (mAttachInfo != null) {
7149 try {
7150 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
7151 } catch (RemoteException e) {
7152 return;
7153 }
7154 // XXX This is really broken, and probably all needs to be done
7155 // in the window manager, and we need to know more about whether
7156 // we want the area behind or in front of the IME.
7157 final Rect insets = mAttachInfo.mVisibleInsets;
7158 outRect.left += insets.left;
7159 outRect.top += insets.top;
7160 outRect.right -= insets.right;
7161 outRect.bottom -= insets.bottom;
7162 return;
7163 }
7164 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
Dianne Hackborn44bc17c2011-04-20 18:18:51 -07007165 d.getRectSize(outRect);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007166 }
7167
7168 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08007169 * Dispatch a notification about a resource configuration change down
7170 * the view hierarchy.
7171 * ViewGroups should override to route to their children.
7172 *
7173 * @param newConfig The new resource configuration.
7174 *
Philip Milne6c8ea062012-04-03 17:38:43 -07007175 * @see #onConfigurationChanged(android.content.res.Configuration)
Dianne Hackborne36d6e22010-02-17 19:46:25 -08007176 */
7177 public void dispatchConfigurationChanged(Configuration newConfig) {
7178 onConfigurationChanged(newConfig);
7179 }
7180
7181 /**
7182 * Called when the current configuration of the resources being used
7183 * by the application have changed. You can use this to decide when
7184 * to reload resources that can changed based on orientation and other
7185 * configuration characterstics. You only need to use this if you are
7186 * not relying on the normal {@link android.app.Activity} mechanism of
7187 * recreating the activity instance upon a configuration change.
7188 *
7189 * @param newConfig The new resource configuration.
7190 */
7191 protected void onConfigurationChanged(Configuration newConfig) {
7192 }
7193
7194 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007195 * Private function to aggregate all per-view attributes in to the view
7196 * root.
7197 */
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007198 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) {
7199 performCollectViewAttributes(attachInfo, visibility);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007200 }
7201
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007202 void performCollectViewAttributes(AttachInfo attachInfo, int visibility) {
7203 if ((visibility & VISIBILITY_MASK) == VISIBLE) {
Joe Onorato664644d2011-01-23 17:53:23 -08007204 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007205 attachInfo.mKeepScreenOn = true;
Joe Onorato664644d2011-01-23 17:53:23 -08007206 }
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007207 attachInfo.mSystemUiVisibility |= mSystemUiVisibility;
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007208 ListenerInfo li = mListenerInfo;
7209 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007210 attachInfo.mHasSystemUiListeners = true;
Joe Onorato664644d2011-01-23 17:53:23 -08007211 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007212 }
7213 }
7214
7215 void needGlobalAttributesUpdate(boolean force) {
Joe Onorato664644d2011-01-23 17:53:23 -08007216 final AttachInfo ai = mAttachInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007217 if (ai != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08007218 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0)
7219 || ai.mHasSystemUiListeners) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007220 ai.mRecomputeGlobalAttributes = true;
7221 }
7222 }
7223 }
7224
7225 /**
7226 * Returns whether the device is currently in touch mode. Touch mode is entered
7227 * once the user begins interacting with the device by touch, and affects various
7228 * things like whether focus is always visible to the user.
7229 *
7230 * @return Whether the device is in touch mode.
7231 */
7232 @ViewDebug.ExportedProperty
7233 public boolean isInTouchMode() {
7234 if (mAttachInfo != null) {
7235 return mAttachInfo.mInTouchMode;
7236 } else {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07007237 return ViewRootImpl.isInTouchMode();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007238 }
7239 }
7240
7241 /**
7242 * Returns the context the view is running in, through which it can
7243 * access the current theme, resources, etc.
7244 *
7245 * @return The view's Context.
7246 */
7247 @ViewDebug.CapturedViewProperty
7248 public final Context getContext() {
7249 return mContext;
7250 }
7251
7252 /**
7253 * Handle a key event before it is processed by any input method
7254 * associated with the view hierarchy. This can be used to intercept
7255 * key events in special situations before the IME consumes them; a
7256 * typical example would be handling the BACK key to update the application's
7257 * UI instead of allowing the IME to see it and close itself.
7258 *
7259 * @param keyCode The value in event.getKeyCode().
7260 * @param event Description of the key event.
7261 * @return If you handled the event, return true. If you want to allow the
7262 * event to be handled by the next receiver, return false.
7263 */
7264 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
7265 return false;
7266 }
7267
7268 /**
Jeff Brown995e7742010-12-22 16:59:36 -08007269 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
7270 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007271 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
7272 * is released, if the view is enabled and clickable.
7273 *
7274 * @param keyCode A key code that represents the button pressed, from
7275 * {@link android.view.KeyEvent}.
7276 * @param event The KeyEvent object that defines the button action.
7277 */
7278 public boolean onKeyDown(int keyCode, KeyEvent event) {
7279 boolean result = false;
7280
7281 switch (keyCode) {
7282 case KeyEvent.KEYCODE_DPAD_CENTER:
7283 case KeyEvent.KEYCODE_ENTER: {
7284 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
7285 return true;
7286 }
7287 // Long clickable items don't necessarily have to be clickable
7288 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
7289 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
7290 (event.getRepeatCount() == 0)) {
7291 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007292 checkForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007293 return true;
7294 }
7295 break;
7296 }
7297 }
7298 return result;
7299 }
7300
7301 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07007302 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
7303 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
7304 * the event).
7305 */
7306 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
7307 return false;
7308 }
7309
7310 /**
Jeff Brown995e7742010-12-22 16:59:36 -08007311 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
7312 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007313 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
7314 * {@link KeyEvent#KEYCODE_ENTER} is released.
7315 *
7316 * @param keyCode A key code that represents the button pressed, from
7317 * {@link android.view.KeyEvent}.
7318 * @param event The KeyEvent object that defines the button action.
7319 */
7320 public boolean onKeyUp(int keyCode, KeyEvent event) {
7321 boolean result = false;
7322
7323 switch (keyCode) {
7324 case KeyEvent.KEYCODE_DPAD_CENTER:
7325 case KeyEvent.KEYCODE_ENTER: {
7326 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
7327 return true;
7328 }
7329 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
7330 setPressed(false);
7331
7332 if (!mHasPerformedLongPress) {
7333 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05007334 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007335
7336 result = performClick();
7337 }
7338 }
7339 break;
7340 }
7341 }
7342 return result;
7343 }
7344
7345 /**
7346 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
7347 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
7348 * the event).
7349 *
7350 * @param keyCode A key code that represents the button pressed, from
7351 * {@link android.view.KeyEvent}.
7352 * @param repeatCount The number of times the action was made.
7353 * @param event The KeyEvent object that defines the button action.
7354 */
7355 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
7356 return false;
7357 }
7358
7359 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08007360 * Called on the focused view when a key shortcut event is not handled.
7361 * Override this method to implement local key shortcuts for the View.
7362 * Key shortcuts can also be implemented by setting the
7363 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007364 *
7365 * @param keyCode The value in event.getKeyCode().
7366 * @param event Description of the key event.
7367 * @return If you handled the event, return true. If you want to allow the
7368 * event to be handled by the next receiver, return false.
7369 */
7370 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
7371 return false;
7372 }
7373
7374 /**
7375 * Check whether the called view is a text editor, in which case it
7376 * would make sense to automatically display a soft input window for
7377 * it. Subclasses should override this if they implement
7378 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007379 * a call on that method would return a non-null InputConnection, and
7380 * they are really a first-class editor that the user would normally
7381 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07007382 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007383 * <p>The default implementation always returns false. This does
7384 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
7385 * will not be called or the user can not otherwise perform edits on your
7386 * view; it is just a hint to the system that this is not the primary
7387 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07007388 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007389 * @return Returns true if this view is a text editor, else false.
7390 */
7391 public boolean onCheckIsTextEditor() {
7392 return false;
7393 }
Romain Guy8506ab42009-06-11 17:35:47 -07007394
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007395 /**
7396 * Create a new InputConnection for an InputMethod to interact
7397 * with the view. The default implementation returns null, since it doesn't
7398 * support input methods. You can override this to implement such support.
7399 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07007400 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007401 * <p>When implementing this, you probably also want to implement
7402 * {@link #onCheckIsTextEditor()} to indicate you will return a
7403 * non-null InputConnection.
7404 *
7405 * @param outAttrs Fill in with attribute information about the connection.
7406 */
7407 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
7408 return null;
7409 }
7410
7411 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007412 * Called by the {@link android.view.inputmethod.InputMethodManager}
7413 * when a view who is not the current
7414 * input connection target is trying to make a call on the manager. The
7415 * default implementation returns false; you can override this to return
7416 * true for certain views if you are performing InputConnection proxying
7417 * to them.
7418 * @param view The View that is making the InputMethodManager call.
7419 * @return Return true to allow the call, false to reject.
7420 */
7421 public boolean checkInputConnectionProxy(View view) {
7422 return false;
7423 }
Romain Guy8506ab42009-06-11 17:35:47 -07007424
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007425 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007426 * Show the context menu for this view. It is not safe to hold on to the
7427 * menu after returning from this method.
7428 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07007429 * You should normally not overload this method. Overload
7430 * {@link #onCreateContextMenu(ContextMenu)} or define an
7431 * {@link OnCreateContextMenuListener} to add items to the context menu.
7432 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007433 * @param menu The context menu to populate
7434 */
7435 public void createContextMenu(ContextMenu menu) {
7436 ContextMenuInfo menuInfo = getContextMenuInfo();
7437
7438 // Sets the current menu info so all items added to menu will have
7439 // my extra info set.
7440 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
7441
7442 onCreateContextMenu(menu);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007443 ListenerInfo li = mListenerInfo;
7444 if (li != null && li.mOnCreateContextMenuListener != null) {
7445 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007446 }
7447
7448 // Clear the extra information so subsequent items that aren't mine don't
7449 // have my extra info.
7450 ((MenuBuilder)menu).setCurrentMenuInfo(null);
7451
7452 if (mParent != null) {
7453 mParent.createContextMenu(menu);
7454 }
7455 }
7456
7457 /**
7458 * Views should implement this if they have extra information to associate
7459 * with the context menu. The return result is supplied as a parameter to
7460 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
7461 * callback.
7462 *
7463 * @return Extra information about the item for which the context menu
7464 * should be shown. This information will vary across different
7465 * subclasses of View.
7466 */
7467 protected ContextMenuInfo getContextMenuInfo() {
7468 return null;
7469 }
7470
7471 /**
7472 * Views should implement this if the view itself is going to add items to
7473 * the context menu.
7474 *
7475 * @param menu the context menu to populate
7476 */
7477 protected void onCreateContextMenu(ContextMenu menu) {
7478 }
7479
7480 /**
7481 * Implement this method to handle trackball motion events. The
7482 * <em>relative</em> movement of the trackball since the last event
7483 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
7484 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
7485 * that a movement of 1 corresponds to the user pressing one DPAD key (so
7486 * they will often be fractional values, representing the more fine-grained
7487 * movement information available from a trackball).
7488 *
7489 * @param event The motion event.
7490 * @return True if the event was handled, false otherwise.
7491 */
7492 public boolean onTrackballEvent(MotionEvent event) {
7493 return false;
7494 }
7495
7496 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08007497 * Implement this method to handle generic motion events.
7498 * <p>
Jeff Brown33bbfd22011-02-24 20:55:35 -08007499 * Generic motion events describe joystick movements, mouse hovers, track pad
7500 * touches, scroll wheel movements and other input events. The
Jeff Browncb1404e2011-01-15 18:14:15 -08007501 * {@link MotionEvent#getSource() source} of the motion event specifies
7502 * the class of input that was received. Implementations of this method
7503 * must examine the bits in the source before processing the event.
7504 * The following code example shows how this is done.
Jeff Brown33bbfd22011-02-24 20:55:35 -08007505 * </p><p>
7506 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
7507 * are delivered to the view under the pointer. All other generic motion events are
7508 * delivered to the focused view.
Jeff Browncb1404e2011-01-15 18:14:15 -08007509 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07007510 * <pre> public boolean onGenericMotionEvent(MotionEvent event) {
Jeff Browncb1404e2011-01-15 18:14:15 -08007511 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_JOYSTICK) != 0) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08007512 * if (event.getAction() == MotionEvent.ACTION_MOVE) {
7513 * // process the joystick movement...
7514 * return true;
7515 * }
7516 * }
7517 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_POINTER) != 0) {
7518 * switch (event.getAction()) {
7519 * case MotionEvent.ACTION_HOVER_MOVE:
7520 * // process the mouse hover movement...
7521 * return true;
7522 * case MotionEvent.ACTION_SCROLL:
7523 * // process the scroll wheel movement...
7524 * return true;
7525 * }
Jeff Browncb1404e2011-01-15 18:14:15 -08007526 * }
7527 * return super.onGenericMotionEvent(event);
Scott Mainb303d832011-10-12 16:45:18 -07007528 * }</pre>
Jeff Browncb1404e2011-01-15 18:14:15 -08007529 *
7530 * @param event The generic motion event being processed.
Jeff Browna032cc02011-03-07 16:56:21 -08007531 * @return True if the event was handled, false otherwise.
Jeff Browncb1404e2011-01-15 18:14:15 -08007532 */
7533 public boolean onGenericMotionEvent(MotionEvent event) {
7534 return false;
7535 }
7536
7537 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007538 * Implement this method to handle hover events.
7539 * <p>
Jeff Brown10b62902011-06-20 16:40:37 -07007540 * This method is called whenever a pointer is hovering into, over, or out of the
7541 * bounds of a view and the view is not currently being touched.
7542 * Hover events are represented as pointer events with action
7543 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE},
7544 * or {@link MotionEvent#ACTION_HOVER_EXIT}.
7545 * </p>
7546 * <ul>
7547 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER}
7548 * when the pointer enters the bounds of the view.</li>
7549 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE}
7550 * when the pointer has already entered the bounds of the view and has moved.</li>
7551 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT}
7552 * when the pointer has exited the bounds of the view or when the pointer is
7553 * about to go down due to a button click, tap, or similar user action that
7554 * causes the view to be touched.</li>
7555 * </ul>
7556 * <p>
7557 * The view should implement this method to return true to indicate that it is
7558 * handling the hover event, such as by changing its drawable state.
Jeff Browna032cc02011-03-07 16:56:21 -08007559 * </p><p>
Jeff Brown10b62902011-06-20 16:40:37 -07007560 * The default implementation calls {@link #setHovered} to update the hovered state
7561 * of the view when a hover enter or hover exit event is received, if the view
Jeff Browna1b24182011-07-28 13:38:24 -07007562 * is enabled and is clickable. The default implementation also sends hover
7563 * accessibility events.
Jeff Browna032cc02011-03-07 16:56:21 -08007564 * </p>
7565 *
7566 * @param event The motion event that describes the hover.
Jeff Brown10b62902011-06-20 16:40:37 -07007567 * @return True if the view handled the hover event.
7568 *
7569 * @see #isHovered
7570 * @see #setHovered
7571 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007572 */
7573 public boolean onHoverEvent(MotionEvent event) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007574 // The root view may receive hover (or touch) events that are outside the bounds of
7575 // the window. This code ensures that we only send accessibility events for
7576 // hovers that are actually within the bounds of the root view.
Svetoslav Ganov42138042012-03-20 11:51:39 -07007577 final int action = event.getActionMasked();
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007578 if (!mSendingHoverAccessibilityEvents) {
7579 if ((action == MotionEvent.ACTION_HOVER_ENTER
7580 || action == MotionEvent.ACTION_HOVER_MOVE)
7581 && !hasHoveredChild()
7582 && pointInView(event.getX(), event.getY())) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007583 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER);
Svetoslav Ganov42138042012-03-20 11:51:39 -07007584 mSendingHoverAccessibilityEvents = true;
7585 requestAccessibilityFocusFromHover((int) event.getX(), (int) event.getY());
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007586 }
7587 } else {
7588 if (action == MotionEvent.ACTION_HOVER_EXIT
Svetoslav Ganov42138042012-03-20 11:51:39 -07007589 || (action == MotionEvent.ACTION_MOVE
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007590 && !pointInView(event.getX(), event.getY()))) {
7591 mSendingHoverAccessibilityEvents = false;
7592 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT);
Svetoslav Ganov42138042012-03-20 11:51:39 -07007593 // If the window does not have input focus we take away accessibility
7594 // focus as soon as the user stop hovering over the view.
Jeff Brown59a422e2012-04-19 15:19:19 -07007595 if (mAttachInfo != null && !mAttachInfo.mHasWindowFocus) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07007596 getViewRootImpl().setAccessibilityFocusedHost(null);
7597 }
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007598 }
Jeff Browna1b24182011-07-28 13:38:24 -07007599 }
7600
Jeff Brown87b7f802011-06-21 18:35:45 -07007601 if (isHoverable()) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007602 switch (action) {
Jeff Brown10b62902011-06-20 16:40:37 -07007603 case MotionEvent.ACTION_HOVER_ENTER:
7604 setHovered(true);
7605 break;
7606 case MotionEvent.ACTION_HOVER_EXIT:
7607 setHovered(false);
7608 break;
7609 }
Jeff Browna1b24182011-07-28 13:38:24 -07007610
7611 // Dispatch the event to onGenericMotionEvent before returning true.
7612 // This is to provide compatibility with existing applications that
7613 // handled HOVER_MOVE events in onGenericMotionEvent and that would
7614 // break because of the new default handling for hoverable views
7615 // in onHoverEvent.
7616 // Note that onGenericMotionEvent will be called by default when
7617 // onHoverEvent returns false (refer to dispatchGenericMotionEvent).
7618 dispatchGenericMotionEventInternal(event);
Jeff Brown10b62902011-06-20 16:40:37 -07007619 return true;
Jeff Browna032cc02011-03-07 16:56:21 -08007620 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07007621
Svetoslav Ganov736c2752011-04-22 18:30:36 -07007622 return false;
Jeff Browna032cc02011-03-07 16:56:21 -08007623 }
7624
7625 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07007626 * Returns true if the view should handle {@link #onHoverEvent}
7627 * by calling {@link #setHovered} to change its hovered state.
7628 *
7629 * @return True if the view is hoverable.
7630 */
7631 private boolean isHoverable() {
7632 final int viewFlags = mViewFlags;
7633 if ((viewFlags & ENABLED_MASK) == DISABLED) {
7634 return false;
7635 }
7636
7637 return (viewFlags & CLICKABLE) == CLICKABLE
7638 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
7639 }
7640
7641 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007642 * Returns true if the view is currently hovered.
7643 *
7644 * @return True if the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007645 *
7646 * @see #setHovered
7647 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007648 */
Jeff Brown10b62902011-06-20 16:40:37 -07007649 @ViewDebug.ExportedProperty
Jeff Browna032cc02011-03-07 16:56:21 -08007650 public boolean isHovered() {
7651 return (mPrivateFlags & HOVERED) != 0;
7652 }
7653
7654 /**
7655 * Sets whether the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007656 * <p>
7657 * Calling this method also changes the drawable state of the view. This
7658 * enables the view to react to hover by using different drawable resources
7659 * to change its appearance.
7660 * </p><p>
7661 * The {@link #onHoverChanged} method is called when the hovered state changes.
7662 * </p>
Jeff Browna032cc02011-03-07 16:56:21 -08007663 *
7664 * @param hovered True if the view is hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007665 *
7666 * @see #isHovered
7667 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007668 */
7669 public void setHovered(boolean hovered) {
7670 if (hovered) {
7671 if ((mPrivateFlags & HOVERED) == 0) {
7672 mPrivateFlags |= HOVERED;
7673 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07007674 onHoverChanged(true);
Jeff Browna032cc02011-03-07 16:56:21 -08007675 }
7676 } else {
7677 if ((mPrivateFlags & HOVERED) != 0) {
7678 mPrivateFlags &= ~HOVERED;
7679 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07007680 onHoverChanged(false);
Jeff Browna032cc02011-03-07 16:56:21 -08007681 }
7682 }
7683 }
7684
7685 /**
Jeff Brown10b62902011-06-20 16:40:37 -07007686 * Implement this method to handle hover state changes.
7687 * <p>
7688 * This method is called whenever the hover state changes as a result of a
7689 * call to {@link #setHovered}.
7690 * </p>
7691 *
7692 * @param hovered The current hover state, as returned by {@link #isHovered}.
7693 *
7694 * @see #isHovered
7695 * @see #setHovered
7696 */
7697 public void onHoverChanged(boolean hovered) {
Jeff Brown10b62902011-06-20 16:40:37 -07007698 }
7699
7700 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007701 * Implement this method to handle touch screen motion events.
7702 *
7703 * @param event The motion event.
7704 * @return True if the event was handled, false otherwise.
7705 */
7706 public boolean onTouchEvent(MotionEvent event) {
7707 final int viewFlags = mViewFlags;
7708
7709 if ((viewFlags & ENABLED_MASK) == DISABLED) {
Svetoslav Ganov77b80c02011-03-15 20:52:58 -07007710 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PRESSED) != 0) {
Adam Powell4d6f0662012-02-21 15:11:11 -08007711 setPressed(false);
Svetoslav Ganov77b80c02011-03-15 20:52:58 -07007712 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007713 // A disabled view that is clickable still consumes the touch
7714 // events, it just doesn't respond to them.
7715 return (((viewFlags & CLICKABLE) == CLICKABLE ||
7716 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
7717 }
7718
7719 if (mTouchDelegate != null) {
7720 if (mTouchDelegate.onTouchEvent(event)) {
7721 return true;
7722 }
7723 }
7724
7725 if (((viewFlags & CLICKABLE) == CLICKABLE ||
7726 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
7727 switch (event.getAction()) {
7728 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08007729 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
7730 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007731 // take focus if we don't have it already and we should in
7732 // touch mode.
7733 boolean focusTaken = false;
7734 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
7735 focusTaken = requestFocus();
7736 }
7737
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08007738 if (prepressed) {
7739 // The button is being released before we actually
7740 // showed it as pressed. Make it show the pressed
7741 // state now (before scheduling the click) to ensure
7742 // the user sees it.
Adam Powell4d6f0662012-02-21 15:11:11 -08007743 setPressed(true);
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08007744 }
Joe Malin32736f02011-01-19 16:14:20 -08007745
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007746 if (!mHasPerformedLongPress) {
7747 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05007748 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007749
7750 // Only perform take click actions if we were in the pressed state
7751 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08007752 // Use a Runnable and post this rather than calling
7753 // performClick directly. This lets other visual state
7754 // of the view update before click actions start.
7755 if (mPerformClick == null) {
7756 mPerformClick = new PerformClick();
7757 }
7758 if (!post(mPerformClick)) {
7759 performClick();
7760 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007761 }
7762 }
7763
7764 if (mUnsetPressedState == null) {
7765 mUnsetPressedState = new UnsetPressedState();
7766 }
7767
Adam Powelle14579b2009-12-16 18:39:52 -08007768 if (prepressed) {
Adam Powelle14579b2009-12-16 18:39:52 -08007769 postDelayed(mUnsetPressedState,
7770 ViewConfiguration.getPressedStateDuration());
7771 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007772 // If the post failed, unpress right now
7773 mUnsetPressedState.run();
7774 }
Adam Powelle14579b2009-12-16 18:39:52 -08007775 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007776 }
7777 break;
7778
7779 case MotionEvent.ACTION_DOWN:
Adam Powell3b023392010-03-11 16:30:28 -08007780 mHasPerformedLongPress = false;
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007781
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07007782 if (performButtonActionOnTouchDown(event)) {
7783 break;
7784 }
7785
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007786 // Walk up the hierarchy to determine if we're inside a scrolling container.
Adam Powell10298662011-08-14 18:26:30 -07007787 boolean isInScrollingContainer = isInScrollingContainer();
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007788
7789 // For views inside a scrolling container, delay the pressed feedback for
7790 // a short period in case this is a scroll.
7791 if (isInScrollingContainer) {
7792 mPrivateFlags |= PREPRESSED;
7793 if (mPendingCheckForTap == null) {
7794 mPendingCheckForTap = new CheckForTap();
7795 }
7796 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
7797 } else {
7798 // Not inside a scrolling container, so show the feedback right away
Adam Powell4d6f0662012-02-21 15:11:11 -08007799 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007800 checkForLongClick(0);
7801 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007802 break;
7803
7804 case MotionEvent.ACTION_CANCEL:
Adam Powell4d6f0662012-02-21 15:11:11 -08007805 setPressed(false);
Adam Powelle14579b2009-12-16 18:39:52 -08007806 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007807 break;
7808
7809 case MotionEvent.ACTION_MOVE:
7810 final int x = (int) event.getX();
7811 final int y = (int) event.getY();
7812
7813 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07007814 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007815 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08007816 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007817 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08007818 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05007819 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007820
Adam Powell4d6f0662012-02-21 15:11:11 -08007821 setPressed(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007822 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007823 }
7824 break;
7825 }
7826 return true;
7827 }
7828
7829 return false;
7830 }
7831
7832 /**
Adam Powell10298662011-08-14 18:26:30 -07007833 * @hide
7834 */
7835 public boolean isInScrollingContainer() {
7836 ViewParent p = getParent();
7837 while (p != null && p instanceof ViewGroup) {
7838 if (((ViewGroup) p).shouldDelayChildPressedState()) {
7839 return true;
7840 }
7841 p = p.getParent();
7842 }
7843 return false;
7844 }
7845
7846 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05007847 * Remove the longpress detection timer.
7848 */
7849 private void removeLongPressCallback() {
7850 if (mPendingCheckForLongPress != null) {
7851 removeCallbacks(mPendingCheckForLongPress);
7852 }
7853 }
Adam Powell3cb8b632011-01-21 15:34:14 -08007854
7855 /**
7856 * Remove the pending click action
7857 */
7858 private void removePerformClickCallback() {
7859 if (mPerformClick != null) {
7860 removeCallbacks(mPerformClick);
7861 }
7862 }
7863
Adam Powelle14579b2009-12-16 18:39:52 -08007864 /**
Romain Guya440b002010-02-24 15:57:54 -08007865 * Remove the prepress detection timer.
7866 */
7867 private void removeUnsetPressCallback() {
7868 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
7869 setPressed(false);
7870 removeCallbacks(mUnsetPressedState);
7871 }
7872 }
7873
7874 /**
Adam Powelle14579b2009-12-16 18:39:52 -08007875 * Remove the tap detection timer.
7876 */
7877 private void removeTapCallback() {
7878 if (mPendingCheckForTap != null) {
7879 mPrivateFlags &= ~PREPRESSED;
7880 removeCallbacks(mPendingCheckForTap);
7881 }
7882 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05007883
7884 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007885 * Cancels a pending long press. Your subclass can use this if you
7886 * want the context menu to come up if the user presses and holds
7887 * at the same place, but you don't want it to come up if they press
7888 * and then move around enough to cause scrolling.
7889 */
7890 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05007891 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08007892
7893 /*
7894 * The prepressed state handled by the tap callback is a display
7895 * construct, but the tap callback will post a long press callback
7896 * less its own timeout. Remove it here.
7897 */
7898 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007899 }
7900
7901 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -07007902 * Remove the pending callback for sending a
7903 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
7904 */
7905 private void removeSendViewScrolledAccessibilityEventCallback() {
7906 if (mSendViewScrolledAccessibilityEvent != null) {
7907 removeCallbacks(mSendViewScrolledAccessibilityEvent);
7908 }
7909 }
7910
7911 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007912 * Sets the TouchDelegate for this View.
7913 */
7914 public void setTouchDelegate(TouchDelegate delegate) {
7915 mTouchDelegate = delegate;
7916 }
7917
7918 /**
7919 * Gets the TouchDelegate for this View.
7920 */
7921 public TouchDelegate getTouchDelegate() {
7922 return mTouchDelegate;
7923 }
7924
7925 /**
7926 * Set flags controlling behavior of this view.
7927 *
7928 * @param flags Constant indicating the value which should be set
7929 * @param mask Constant indicating the bit range that should be changed
7930 */
7931 void setFlags(int flags, int mask) {
7932 int old = mViewFlags;
7933 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
7934
7935 int changed = mViewFlags ^ old;
7936 if (changed == 0) {
7937 return;
7938 }
7939 int privateFlags = mPrivateFlags;
7940
7941 /* Check if the FOCUSABLE bit has changed */
7942 if (((changed & FOCUSABLE_MASK) != 0) &&
7943 ((privateFlags & HAS_BOUNDS) !=0)) {
7944 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
7945 && ((privateFlags & FOCUSED) != 0)) {
7946 /* Give up focus if we are no longer focusable */
7947 clearFocus();
7948 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
7949 && ((privateFlags & FOCUSED) == 0)) {
7950 /*
7951 * Tell the view system that we are now available to take focus
7952 * if no one else already has it.
7953 */
7954 if (mParent != null) mParent.focusableViewAvailable(this);
7955 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07007956 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
7957 notifyAccessibilityStateChanged();
7958 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007959 }
7960
7961 if ((flags & VISIBILITY_MASK) == VISIBLE) {
7962 if ((changed & VISIBILITY_MASK) != 0) {
7963 /*
Chet Haase4324ead2011-08-24 21:31:03 -07007964 * If this view is becoming visible, invalidate it in case it changed while
Chet Haaseaceafe62011-08-26 15:44:33 -07007965 * it was not visible. Marking it drawn ensures that the invalidation will
7966 * go through.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007967 */
Chet Haaseaceafe62011-08-26 15:44:33 -07007968 mPrivateFlags |= DRAWN;
Chet Haase4324ead2011-08-24 21:31:03 -07007969 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007970
7971 needGlobalAttributesUpdate(true);
7972
7973 // a view becoming visible is worth notifying the parent
7974 // about in case nothing has focus. even if this specific view
7975 // isn't focusable, it may contain something that is, so let
7976 // the root view try to give this focus if nothing else does.
7977 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
7978 mParent.focusableViewAvailable(this);
7979 }
7980 }
7981 }
7982
7983 /* Check if the GONE bit has changed */
7984 if ((changed & GONE) != 0) {
7985 needGlobalAttributesUpdate(false);
7986 requestLayout();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007987
Romain Guyecd80ee2009-12-03 17:13:02 -08007988 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
7989 if (hasFocus()) clearFocus();
Svetoslav Ganov42138042012-03-20 11:51:39 -07007990 clearAccessibilityFocus();
Romain Guyecd80ee2009-12-03 17:13:02 -08007991 destroyDrawingCache();
Chet Haaseaceafe62011-08-26 15:44:33 -07007992 if (mParent instanceof View) {
7993 // GONE views noop invalidation, so invalidate the parent
7994 ((View) mParent).invalidate(true);
7995 }
7996 // Mark the view drawn to ensure that it gets invalidated properly the next
7997 // time it is visible and gets invalidated
7998 mPrivateFlags |= DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007999 }
8000 if (mAttachInfo != null) {
8001 mAttachInfo.mViewVisibilityChanged = true;
8002 }
8003 }
8004
8005 /* Check if the VISIBLE bit has changed */
8006 if ((changed & INVISIBLE) != 0) {
8007 needGlobalAttributesUpdate(false);
Chet Haasec8a9a702011-06-17 12:13:42 -07008008 /*
8009 * If this view is becoming invisible, set the DRAWN flag so that
8010 * the next invalidate() will not be skipped.
8011 */
8012 mPrivateFlags |= DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008013
8014 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07008015 // root view becoming invisible shouldn't clear focus and accessibility focus
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008016 if (getRootView() != this) {
8017 clearFocus();
Svetoslav Ganov42138042012-03-20 11:51:39 -07008018 clearAccessibilityFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008019 }
8020 }
8021 if (mAttachInfo != null) {
8022 mAttachInfo.mViewVisibilityChanged = true;
8023 }
8024 }
8025
Adam Powell326d8082009-12-09 15:10:07 -08008026 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07008027 if (mParent instanceof ViewGroup) {
Romain Guyfe455af2012-02-15 16:40:20 -08008028 ((ViewGroup) mParent).onChildVisibilityChanged(this,
8029 (changed & VISIBILITY_MASK), (flags & VISIBILITY_MASK));
Romain Guy0fd89bf2011-01-26 15:41:30 -08008030 ((View) mParent).invalidate(true);
Chet Haasee4e6e202011-08-29 14:34:30 -07008031 } else if (mParent != null) {
8032 mParent.invalidateChild(this, null);
Chet Haase5e25c2c2010-09-16 11:15:56 -07008033 }
Adam Powell326d8082009-12-09 15:10:07 -08008034 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
8035 }
8036
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008037 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
8038 destroyDrawingCache();
8039 }
8040
8041 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
8042 destroyDrawingCache();
8043 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Romain Guy0fd89bf2011-01-26 15:41:30 -08008044 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008045 }
8046
8047 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
8048 destroyDrawingCache();
8049 mPrivateFlags &= ~DRAWING_CACHE_VALID;
8050 }
8051
8052 if ((changed & DRAW_MASK) != 0) {
8053 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
Philip Milne6c8ea062012-04-03 17:38:43 -07008054 if (mBackground != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008055 mPrivateFlags &= ~SKIP_DRAW;
8056 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
8057 } else {
8058 mPrivateFlags |= SKIP_DRAW;
8059 }
8060 } else {
8061 mPrivateFlags &= ~SKIP_DRAW;
8062 }
8063 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08008064 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008065 }
8066
8067 if ((changed & KEEP_SCREEN_ON) != 0) {
Joe Onorato664644d2011-01-23 17:53:23 -08008068 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008069 mParent.recomputeViewAttributes(this);
8070 }
8071 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07008072
8073 if (AccessibilityManager.getInstance(mContext).isEnabled()
8074 && ((changed & FOCUSABLE) != 0 || (changed & CLICKABLE) != 0
8075 || (changed & LONG_CLICKABLE) != 0 || (changed & ENABLED) != 0)) {
8076 notifyAccessibilityStateChanged();
8077 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008078 }
8079
8080 /**
8081 * Change the view's z order in the tree, so it's on top of other sibling
8082 * views
8083 */
8084 public void bringToFront() {
8085 if (mParent != null) {
8086 mParent.bringChildToFront(this);
8087 }
8088 }
8089
8090 /**
8091 * This is called in response to an internal scroll in this view (i.e., the
8092 * view scrolled its own contents). This is typically as a result of
8093 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
8094 * called.
8095 *
8096 * @param l Current horizontal scroll origin.
8097 * @param t Current vertical scroll origin.
8098 * @param oldl Previous horizontal scroll origin.
8099 * @param oldt Previous vertical scroll origin.
8100 */
8101 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Svetoslav Ganova0156172011-06-26 17:55:44 -07008102 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
8103 postSendViewScrolledAccessibilityEventCallback();
8104 }
8105
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008106 mBackgroundSizeChanged = true;
8107
8108 final AttachInfo ai = mAttachInfo;
8109 if (ai != null) {
8110 ai.mViewScrollChanged = true;
8111 }
8112 }
8113
8114 /**
Chet Haase21cd1382010-09-01 17:42:29 -07008115 * Interface definition for a callback to be invoked when the layout bounds of a view
8116 * changes due to layout processing.
8117 */
8118 public interface OnLayoutChangeListener {
8119 /**
8120 * Called when the focus state of a view has changed.
8121 *
8122 * @param v The view whose state has changed.
8123 * @param left The new value of the view's left property.
8124 * @param top The new value of the view's top property.
8125 * @param right The new value of the view's right property.
8126 * @param bottom The new value of the view's bottom property.
8127 * @param oldLeft The previous value of the view's left property.
8128 * @param oldTop The previous value of the view's top property.
8129 * @param oldRight The previous value of the view's right property.
8130 * @param oldBottom The previous value of the view's bottom property.
8131 */
8132 void onLayoutChange(View v, int left, int top, int right, int bottom,
8133 int oldLeft, int oldTop, int oldRight, int oldBottom);
8134 }
8135
8136 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008137 * This is called during layout when the size of this view has changed. If
8138 * you were just added to the view hierarchy, you're called with the old
8139 * values of 0.
8140 *
8141 * @param w Current width of this view.
8142 * @param h Current height of this view.
8143 * @param oldw Old width of this view.
8144 * @param oldh Old height of this view.
8145 */
8146 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
8147 }
8148
8149 /**
8150 * Called by draw to draw the child views. This may be overridden
8151 * by derived classes to gain control just before its children are drawn
8152 * (but after its own view has been drawn).
8153 * @param canvas the canvas on which to draw the view
8154 */
8155 protected void dispatchDraw(Canvas canvas) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07008156
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008157 }
8158
8159 /**
8160 * Gets the parent of this view. Note that the parent is a
8161 * ViewParent and not necessarily a View.
8162 *
8163 * @return Parent of this view.
8164 */
8165 public final ViewParent getParent() {
8166 return mParent;
8167 }
8168
8169 /**
Chet Haasecca2c982011-05-20 14:34:18 -07008170 * Set the horizontal scrolled position of your view. This will cause a call to
8171 * {@link #onScrollChanged(int, int, int, int)} and the view will be
8172 * invalidated.
8173 * @param value the x position to scroll to
8174 */
8175 public void setScrollX(int value) {
8176 scrollTo(value, mScrollY);
8177 }
8178
8179 /**
8180 * Set the vertical scrolled position of your view. This will cause a call to
8181 * {@link #onScrollChanged(int, int, int, int)} and the view will be
8182 * invalidated.
8183 * @param value the y position to scroll to
8184 */
8185 public void setScrollY(int value) {
8186 scrollTo(mScrollX, value);
8187 }
8188
8189 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008190 * Return the scrolled left position of this view. This is the left edge of
8191 * the displayed part of your view. You do not need to draw any pixels
8192 * farther left, since those are outside of the frame of your view on
8193 * screen.
8194 *
8195 * @return The left edge of the displayed part of your view, in pixels.
8196 */
8197 public final int getScrollX() {
8198 return mScrollX;
8199 }
8200
8201 /**
8202 * Return the scrolled top position of this view. This is the top edge of
8203 * the displayed part of your view. You do not need to draw any pixels above
8204 * it, since those are outside of the frame of your view on screen.
8205 *
8206 * @return The top edge of the displayed part of your view, in pixels.
8207 */
8208 public final int getScrollY() {
8209 return mScrollY;
8210 }
8211
8212 /**
8213 * Return the width of the your view.
8214 *
8215 * @return The width of your view, in pixels.
8216 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008217 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008218 public final int getWidth() {
8219 return mRight - mLeft;
8220 }
8221
8222 /**
8223 * Return the height of your view.
8224 *
8225 * @return The height of your view, in pixels.
8226 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008227 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008228 public final int getHeight() {
8229 return mBottom - mTop;
8230 }
8231
8232 /**
8233 * Return the visible drawing bounds of your view. Fills in the output
8234 * rectangle with the values from getScrollX(), getScrollY(),
8235 * getWidth(), and getHeight().
8236 *
8237 * @param outRect The (scrolled) drawing bounds of the view.
8238 */
8239 public void getDrawingRect(Rect outRect) {
8240 outRect.left = mScrollX;
8241 outRect.top = mScrollY;
8242 outRect.right = mScrollX + (mRight - mLeft);
8243 outRect.bottom = mScrollY + (mBottom - mTop);
8244 }
8245
8246 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008247 * Like {@link #getMeasuredWidthAndState()}, but only returns the
8248 * raw width component (that is the result is masked by
8249 * {@link #MEASURED_SIZE_MASK}).
8250 *
8251 * @return The raw measured width of this view.
8252 */
8253 public final int getMeasuredWidth() {
8254 return mMeasuredWidth & MEASURED_SIZE_MASK;
8255 }
8256
8257 /**
8258 * Return the full width measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07008259 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08008260 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008261 * This should be used during measurement and layout calculations only. Use
8262 * {@link #getWidth()} to see how wide a view is after layout.
8263 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08008264 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008265 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08008266 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008267 return mMeasuredWidth;
8268 }
8269
8270 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008271 * Like {@link #getMeasuredHeightAndState()}, but only returns the
8272 * raw width component (that is the result is masked by
8273 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008274 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08008275 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008276 */
8277 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08008278 return mMeasuredHeight & MEASURED_SIZE_MASK;
8279 }
8280
8281 /**
8282 * Return the full height measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07008283 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08008284 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
8285 * This should be used during measurement and layout calculations only. Use
8286 * {@link #getHeight()} to see how wide a view is after layout.
8287 *
8288 * @return The measured width of this view as a bit mask.
8289 */
8290 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008291 return mMeasuredHeight;
8292 }
8293
8294 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008295 * Return only the state bits of {@link #getMeasuredWidthAndState()}
8296 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
8297 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
8298 * and the height component is at the shifted bits
8299 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
8300 */
8301 public final int getMeasuredState() {
8302 return (mMeasuredWidth&MEASURED_STATE_MASK)
8303 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
8304 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
8305 }
8306
8307 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008308 * The transform matrix of this view, which is calculated based on the current
8309 * roation, scale, and pivot properties.
8310 *
8311 * @see #getRotation()
8312 * @see #getScaleX()
8313 * @see #getScaleY()
8314 * @see #getPivotX()
8315 * @see #getPivotY()
8316 * @return The current transform matrix for the view
8317 */
8318 public Matrix getMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008319 if (mTransformationInfo != null) {
8320 updateMatrix();
8321 return mTransformationInfo.mMatrix;
8322 }
8323 return Matrix.IDENTITY_MATRIX;
Romain Guy33e72ae2010-07-17 12:40:29 -07008324 }
8325
8326 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07008327 * Utility function to determine if the value is far enough away from zero to be
8328 * considered non-zero.
8329 * @param value A floating point value to check for zero-ness
8330 * @return whether the passed-in value is far enough away from zero to be considered non-zero
8331 */
8332 private static boolean nonzero(float value) {
8333 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
8334 }
8335
8336 /**
Jeff Brown86671742010-09-30 20:00:15 -07008337 * Returns true if the transform matrix is the identity matrix.
8338 * Recomputes the matrix if necessary.
Joe Malin32736f02011-01-19 16:14:20 -08008339 *
Romain Guy33e72ae2010-07-17 12:40:29 -07008340 * @return True if the transform matrix is the identity matrix, false otherwise.
8341 */
Jeff Brown86671742010-09-30 20:00:15 -07008342 final boolean hasIdentityMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008343 if (mTransformationInfo != null) {
8344 updateMatrix();
8345 return mTransformationInfo.mMatrixIsIdentity;
8346 }
8347 return true;
8348 }
8349
8350 void ensureTransformationInfo() {
8351 if (mTransformationInfo == null) {
8352 mTransformationInfo = new TransformationInfo();
8353 }
Jeff Brown86671742010-09-30 20:00:15 -07008354 }
8355
8356 /**
8357 * Recomputes the transform matrix if necessary.
8358 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008359 private void updateMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008360 final TransformationInfo info = mTransformationInfo;
8361 if (info == null) {
8362 return;
8363 }
8364 if (info.mMatrixDirty) {
Chet Haasec3aa3612010-06-17 08:50:37 -07008365 // transform-related properties have changed since the last time someone
8366 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07008367
8368 // Figure out if we need to update the pivot point
8369 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008370 if ((mRight - mLeft) != info.mPrevWidth || (mBottom - mTop) != info.mPrevHeight) {
8371 info.mPrevWidth = mRight - mLeft;
8372 info.mPrevHeight = mBottom - mTop;
8373 info.mPivotX = info.mPrevWidth / 2f;
8374 info.mPivotY = info.mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07008375 }
8376 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008377 info.mMatrix.reset();
8378 if (!nonzero(info.mRotationX) && !nonzero(info.mRotationY)) {
8379 info.mMatrix.setTranslate(info.mTranslationX, info.mTranslationY);
8380 info.mMatrix.preRotate(info.mRotation, info.mPivotX, info.mPivotY);
8381 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07008382 } else {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008383 if (info.mCamera == null) {
8384 info.mCamera = new Camera();
8385 info.matrix3D = new Matrix();
Chet Haasefd2b0022010-08-06 13:08:56 -07008386 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008387 info.mCamera.save();
8388 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY);
8389 info.mCamera.rotate(info.mRotationX, info.mRotationY, -info.mRotation);
8390 info.mCamera.getMatrix(info.matrix3D);
8391 info.matrix3D.preTranslate(-info.mPivotX, -info.mPivotY);
8392 info.matrix3D.postTranslate(info.mPivotX + info.mTranslationX,
8393 info.mPivotY + info.mTranslationY);
8394 info.mMatrix.postConcat(info.matrix3D);
8395 info.mCamera.restore();
Chet Haasefd2b0022010-08-06 13:08:56 -07008396 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008397 info.mMatrixDirty = false;
8398 info.mMatrixIsIdentity = info.mMatrix.isIdentity();
8399 info.mInverseMatrixDirty = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07008400 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008401 }
8402
8403 /**
8404 * Utility method to retrieve the inverse of the current mMatrix property.
8405 * We cache the matrix to avoid recalculating it when transform properties
8406 * have not changed.
8407 *
8408 * @return The inverse of the current matrix of this view.
8409 */
Jeff Brown86671742010-09-30 20:00:15 -07008410 final Matrix getInverseMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008411 final TransformationInfo info = mTransformationInfo;
8412 if (info != null) {
8413 updateMatrix();
8414 if (info.mInverseMatrixDirty) {
8415 if (info.mInverseMatrix == null) {
8416 info.mInverseMatrix = new Matrix();
8417 }
8418 info.mMatrix.invert(info.mInverseMatrix);
8419 info.mInverseMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07008420 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008421 return info.mInverseMatrix;
Chet Haasec3aa3612010-06-17 08:50:37 -07008422 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008423 return Matrix.IDENTITY_MATRIX;
Chet Haasec3aa3612010-06-17 08:50:37 -07008424 }
8425
8426 /**
Chet Haasea1cff502012-02-21 13:43:44 -08008427 * Gets the distance along the Z axis from the camera to this view.
8428 *
8429 * @see #setCameraDistance(float)
8430 *
8431 * @return The distance along the Z axis.
8432 */
8433 public float getCameraDistance() {
8434 ensureTransformationInfo();
8435 final float dpi = mResources.getDisplayMetrics().densityDpi;
8436 final TransformationInfo info = mTransformationInfo;
8437 if (info.mCamera == null) {
8438 info.mCamera = new Camera();
8439 info.matrix3D = new Matrix();
8440 }
8441 return -(info.mCamera.getLocationZ() * dpi);
8442 }
8443
8444 /**
Romain Guya5364ee2011-02-24 14:46:04 -08008445 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which
8446 * views are drawn) from the camera to this view. The camera's distance
8447 * affects 3D transformations, for instance rotations around the X and Y
8448 * axis. If the rotationX or rotationY properties are changed and this view is
Philip Milne6c8ea062012-04-03 17:38:43 -07008449 * large (more than half the size of the screen), it is recommended to always
Romain Guya5364ee2011-02-24 14:46:04 -08008450 * use a camera distance that's greater than the height (X axis rotation) or
8451 * the width (Y axis rotation) of this view.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008452 *
Romain Guya5364ee2011-02-24 14:46:04 -08008453 * <p>The distance of the camera from the view plane can have an affect on the
8454 * perspective distortion of the view when it is rotated around the x or y axis.
8455 * For example, a large distance will result in a large viewing angle, and there
8456 * will not be much perspective distortion of the view as it rotates. A short
Philip Milne6c8ea062012-04-03 17:38:43 -07008457 * distance may cause much more perspective distortion upon rotation, and can
Romain Guya5364ee2011-02-24 14:46:04 -08008458 * also result in some drawing artifacts if the rotated view ends up partially
8459 * behind the camera (which is why the recommendation is to use a distance at
8460 * least as far as the size of the view, if the view is to be rotated.)</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008461 *
Romain Guya5364ee2011-02-24 14:46:04 -08008462 * <p>The distance is expressed in "depth pixels." The default distance depends
8463 * on the screen density. For instance, on a medium density display, the
8464 * default distance is 1280. On a high density display, the default distance
8465 * is 1920.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008466 *
Romain Guya5364ee2011-02-24 14:46:04 -08008467 * <p>If you want to specify a distance that leads to visually consistent
8468 * results across various densities, use the following formula:</p>
8469 * <pre>
8470 * float scale = context.getResources().getDisplayMetrics().density;
8471 * view.setCameraDistance(distance * scale);
8472 * </pre>
Philip Milne6c8ea062012-04-03 17:38:43 -07008473 *
Romain Guya5364ee2011-02-24 14:46:04 -08008474 * <p>The density scale factor of a high density display is 1.5,
8475 * and 1920 = 1280 * 1.5.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008476 *
Romain Guya5364ee2011-02-24 14:46:04 -08008477 * @param distance The distance in "depth pixels", if negative the opposite
8478 * value is used
Philip Milne6c8ea062012-04-03 17:38:43 -07008479 *
8480 * @see #setRotationX(float)
8481 * @see #setRotationY(float)
Romain Guya5364ee2011-02-24 14:46:04 -08008482 */
8483 public void setCameraDistance(float distance) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008484 invalidateViewProperty(true, false);
Romain Guya5364ee2011-02-24 14:46:04 -08008485
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008486 ensureTransformationInfo();
Romain Guya5364ee2011-02-24 14:46:04 -08008487 final float dpi = mResources.getDisplayMetrics().densityDpi;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008488 final TransformationInfo info = mTransformationInfo;
8489 if (info.mCamera == null) {
8490 info.mCamera = new Camera();
8491 info.matrix3D = new Matrix();
Romain Guya5364ee2011-02-24 14:46:04 -08008492 }
8493
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008494 info.mCamera.setLocation(0.0f, 0.0f, -Math.abs(distance) / dpi);
8495 info.mMatrixDirty = true;
Romain Guya5364ee2011-02-24 14:46:04 -08008496
Chet Haase9d1992d2012-03-13 11:03:25 -07008497 invalidateViewProperty(false, false);
Chet Haase1271e2c2012-04-20 09:54:27 -07008498 if (mDisplayList != null) {
Chet Haaseb85967b2012-03-26 14:37:51 -07008499 mDisplayList.setCameraDistance(-Math.abs(distance) / dpi);
Chet Haasea1cff502012-02-21 13:43:44 -08008500 }
Romain Guya5364ee2011-02-24 14:46:04 -08008501 }
8502
8503 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008504 * The degrees that the view is rotated around the pivot point.
8505 *
Philip Milne6c8ea062012-04-03 17:38:43 -07008506 * @see #setRotation(float)
Chet Haasec3aa3612010-06-17 08:50:37 -07008507 * @see #getPivotX()
8508 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008509 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008510 * @return The degrees of rotation.
8511 */
Chet Haasea5531132012-02-02 13:41:44 -08008512 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008513 public float getRotation() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008514 return mTransformationInfo != null ? mTransformationInfo.mRotation : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008515 }
8516
8517 /**
Chet Haase897247b2010-09-09 14:54:47 -07008518 * Sets the degrees that the view is rotated around the pivot point. Increasing values
8519 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07008520 *
8521 * @param rotation The degrees of rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008522 *
8523 * @see #getRotation()
Chet Haasec3aa3612010-06-17 08:50:37 -07008524 * @see #getPivotX()
8525 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008526 * @see #setRotationX(float)
8527 * @see #setRotationY(float)
Chet Haase73066682010-11-29 15:55:32 -08008528 *
8529 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07008530 */
8531 public void setRotation(float rotation) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008532 ensureTransformationInfo();
8533 final TransformationInfo info = mTransformationInfo;
8534 if (info.mRotation != rotation) {
Chet Haasec3aa3612010-06-17 08:50:37 -07008535 // Double-invalidation is necessary to capture view's old and new areas
Chet Haase9d1992d2012-03-13 11:03:25 -07008536 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008537 info.mRotation = rotation;
8538 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008539 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008540 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008541 mDisplayList.setRotation(rotation);
8542 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008543 }
8544 }
8545
8546 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07008547 * The degrees that the view is rotated around the vertical axis through the pivot point.
8548 *
8549 * @see #getPivotX()
8550 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008551 * @see #setRotationY(float)
8552 *
Chet Haasefd2b0022010-08-06 13:08:56 -07008553 * @return The degrees of Y rotation.
8554 */
Chet Haasea5531132012-02-02 13:41:44 -08008555 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasefd2b0022010-08-06 13:08:56 -07008556 public float getRotationY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008557 return mTransformationInfo != null ? mTransformationInfo.mRotationY : 0;
Chet Haasefd2b0022010-08-06 13:08:56 -07008558 }
8559
8560 /**
Chet Haase897247b2010-09-09 14:54:47 -07008561 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
8562 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
8563 * down the y axis.
Philip Milne6c8ea062012-04-03 17:38:43 -07008564 *
Romain Guya5364ee2011-02-24 14:46:04 -08008565 * When rotating large views, it is recommended to adjust the camera distance
8566 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07008567 *
8568 * @param rotationY The degrees of Y rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008569 *
8570 * @see #getRotationY()
Chet Haasefd2b0022010-08-06 13:08:56 -07008571 * @see #getPivotX()
8572 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08008573 * @see #setRotation(float)
Philip Milne6c8ea062012-04-03 17:38:43 -07008574 * @see #setRotationX(float)
8575 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08008576 *
8577 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07008578 */
8579 public void setRotationY(float rotationY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008580 ensureTransformationInfo();
8581 final TransformationInfo info = mTransformationInfo;
8582 if (info.mRotationY != rotationY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008583 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008584 info.mRotationY = rotationY;
8585 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008586 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008587 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008588 mDisplayList.setRotationY(rotationY);
8589 }
Chet Haasefd2b0022010-08-06 13:08:56 -07008590 }
8591 }
8592
8593 /**
8594 * The degrees that the view is rotated around the horizontal axis through the pivot point.
8595 *
8596 * @see #getPivotX()
8597 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008598 * @see #setRotationX(float)
8599 *
Chet Haasefd2b0022010-08-06 13:08:56 -07008600 * @return The degrees of X rotation.
8601 */
Chet Haasea5531132012-02-02 13:41:44 -08008602 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasefd2b0022010-08-06 13:08:56 -07008603 public float getRotationX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008604 return mTransformationInfo != null ? mTransformationInfo.mRotationX : 0;
Chet Haasefd2b0022010-08-06 13:08:56 -07008605 }
8606
8607 /**
Chet Haase897247b2010-09-09 14:54:47 -07008608 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
8609 * Increasing values result in clockwise rotation from the viewpoint of looking down the
8610 * x axis.
Philip Milne6c8ea062012-04-03 17:38:43 -07008611 *
Romain Guya5364ee2011-02-24 14:46:04 -08008612 * When rotating large views, it is recommended to adjust the camera distance
8613 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07008614 *
8615 * @param rotationX The degrees of X rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008616 *
8617 * @see #getRotationX()
Chet Haasefd2b0022010-08-06 13:08:56 -07008618 * @see #getPivotX()
8619 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08008620 * @see #setRotation(float)
Philip Milne6c8ea062012-04-03 17:38:43 -07008621 * @see #setRotationY(float)
8622 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08008623 *
8624 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07008625 */
8626 public void setRotationX(float rotationX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008627 ensureTransformationInfo();
8628 final TransformationInfo info = mTransformationInfo;
8629 if (info.mRotationX != rotationX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008630 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008631 info.mRotationX = rotationX;
8632 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008633 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008634 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008635 mDisplayList.setRotationX(rotationX);
8636 }
Chet Haasefd2b0022010-08-06 13:08:56 -07008637 }
8638 }
8639
8640 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008641 * The amount that the view is scaled in x around the pivot point, as a proportion of
8642 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
8643 *
Joe Onorato93162322010-09-16 15:42:01 -04008644 * <p>By default, this is 1.0f.
8645 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008646 * @see #getPivotX()
8647 * @see #getPivotY()
8648 * @return The scaling factor.
8649 */
Chet Haasea5531132012-02-02 13:41:44 -08008650 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008651 public float getScaleX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008652 return mTransformationInfo != null ? mTransformationInfo.mScaleX : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008653 }
8654
8655 /**
8656 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
8657 * the view's unscaled width. A value of 1 means that no scaling is applied.
8658 *
8659 * @param scaleX The scaling factor.
8660 * @see #getPivotX()
8661 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008662 *
8663 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07008664 */
8665 public void setScaleX(float scaleX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008666 ensureTransformationInfo();
8667 final TransformationInfo info = mTransformationInfo;
8668 if (info.mScaleX != scaleX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008669 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008670 info.mScaleX = scaleX;
8671 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008672 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008673 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008674 mDisplayList.setScaleX(scaleX);
8675 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008676 }
8677 }
8678
8679 /**
8680 * The amount that the view is scaled in y around the pivot point, as a proportion of
8681 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
8682 *
Joe Onorato93162322010-09-16 15:42:01 -04008683 * <p>By default, this is 1.0f.
8684 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008685 * @see #getPivotX()
8686 * @see #getPivotY()
8687 * @return The scaling factor.
8688 */
Chet Haasea5531132012-02-02 13:41:44 -08008689 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008690 public float getScaleY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008691 return mTransformationInfo != null ? mTransformationInfo.mScaleY : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008692 }
8693
8694 /**
8695 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
8696 * the view's unscaled width. A value of 1 means that no scaling is applied.
8697 *
8698 * @param scaleY The scaling factor.
8699 * @see #getPivotX()
8700 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008701 *
8702 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07008703 */
8704 public void setScaleY(float scaleY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008705 ensureTransformationInfo();
8706 final TransformationInfo info = mTransformationInfo;
8707 if (info.mScaleY != scaleY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008708 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008709 info.mScaleY = scaleY;
8710 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008711 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008712 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008713 mDisplayList.setScaleY(scaleY);
8714 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008715 }
8716 }
8717
8718 /**
8719 * The x location of the point around which the view is {@link #setRotation(float) rotated}
8720 * and {@link #setScaleX(float) scaled}.
8721 *
8722 * @see #getRotation()
8723 * @see #getScaleX()
8724 * @see #getScaleY()
8725 * @see #getPivotY()
8726 * @return The x location of the pivot point.
Philip Milne6c8ea062012-04-03 17:38:43 -07008727 *
8728 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07008729 */
Chet Haasea5531132012-02-02 13:41:44 -08008730 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008731 public float getPivotX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008732 return mTransformationInfo != null ? mTransformationInfo.mPivotX : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008733 }
8734
8735 /**
8736 * Sets the x location of the point around which the view is
8737 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07008738 * By default, the pivot point is centered on the object.
8739 * Setting this property disables this behavior and causes the view to use only the
8740 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07008741 *
8742 * @param pivotX The x location of the pivot point.
8743 * @see #getRotation()
8744 * @see #getScaleX()
8745 * @see #getScaleY()
8746 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008747 *
8748 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07008749 */
8750 public void setPivotX(float pivotX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008751 ensureTransformationInfo();
Chet Haasefd2b0022010-08-06 13:08:56 -07008752 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008753 final TransformationInfo info = mTransformationInfo;
8754 if (info.mPivotX != pivotX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008755 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008756 info.mPivotX = pivotX;
8757 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008758 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008759 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008760 mDisplayList.setPivotX(pivotX);
8761 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008762 }
8763 }
8764
8765 /**
8766 * The y location of the point around which the view is {@link #setRotation(float) rotated}
8767 * and {@link #setScaleY(float) scaled}.
8768 *
8769 * @see #getRotation()
8770 * @see #getScaleX()
8771 * @see #getScaleY()
8772 * @see #getPivotY()
8773 * @return The y location of the pivot point.
Philip Milne6c8ea062012-04-03 17:38:43 -07008774 *
8775 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07008776 */
Chet Haasea5531132012-02-02 13:41:44 -08008777 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008778 public float getPivotY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008779 return mTransformationInfo != null ? mTransformationInfo.mPivotY : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008780 }
8781
8782 /**
8783 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07008784 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
8785 * Setting this property disables this behavior and causes the view to use only the
8786 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07008787 *
8788 * @param pivotY The y location of the pivot point.
8789 * @see #getRotation()
8790 * @see #getScaleX()
8791 * @see #getScaleY()
8792 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008793 *
8794 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07008795 */
8796 public void setPivotY(float pivotY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008797 ensureTransformationInfo();
Chet Haasefd2b0022010-08-06 13:08:56 -07008798 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008799 final TransformationInfo info = mTransformationInfo;
8800 if (info.mPivotY != pivotY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008801 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008802 info.mPivotY = pivotY;
8803 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008804 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008805 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008806 mDisplayList.setPivotY(pivotY);
8807 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008808 }
8809 }
8810
8811 /**
8812 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
8813 * completely transparent and 1 means the view is completely opaque.
8814 *
Joe Onorato93162322010-09-16 15:42:01 -04008815 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07008816 * @return The opacity of the view.
8817 */
Chet Haasea5531132012-02-02 13:41:44 -08008818 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008819 public float getAlpha() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008820 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008821 }
8822
8823 /**
Chet Haasedb8c9a62012-03-21 18:54:18 -07008824 * Returns whether this View has content which overlaps. This function, intended to be
8825 * overridden by specific View types, is an optimization when alpha is set on a view. If
8826 * rendering overlaps in a view with alpha < 1, that view is drawn to an offscreen buffer
8827 * and then composited it into place, which can be expensive. If the view has no overlapping
8828 * rendering, the view can draw each primitive with the appropriate alpha value directly.
8829 * An example of overlapping rendering is a TextView with a background image, such as a
8830 * Button. An example of non-overlapping rendering is a TextView with no background, or
8831 * an ImageView with only the foreground image. The default implementation returns true;
8832 * subclasses should override if they have cases which can be optimized.
8833 *
8834 * @return true if the content in this view might overlap, false otherwise.
8835 */
8836 public boolean hasOverlappingRendering() {
8837 return true;
8838 }
8839
8840 /**
Romain Guy171c5922011-01-06 10:04:23 -08008841 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
8842 * completely transparent and 1 means the view is completely opaque.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008843 *
Romain Guy171c5922011-01-06 10:04:23 -08008844 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
8845 * responsible for applying the opacity itself. Otherwise, calling this method is
8846 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
Joe Malin32736f02011-01-19 16:14:20 -08008847 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07008848 *
Chet Haasea5531132012-02-02 13:41:44 -08008849 * <p>Note that setting alpha to a translucent value (0 < alpha < 1) may have
8850 * performance implications. It is generally best to use the alpha property sparingly and
8851 * transiently, as in the case of fading animations.</p>
8852 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008853 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08008854 *
Joe Malin32736f02011-01-19 16:14:20 -08008855 * @see #setLayerType(int, android.graphics.Paint)
8856 *
Chet Haase73066682010-11-29 15:55:32 -08008857 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07008858 */
8859 public void setAlpha(float alpha) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008860 ensureTransformationInfo();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008861 if (mTransformationInfo.mAlpha != alpha) {
8862 mTransformationInfo.mAlpha = alpha;
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008863 if (onSetAlpha((int) (alpha * 255))) {
8864 mPrivateFlags |= ALPHA_SET;
8865 // subclass is handling alpha - don't optimize rendering cache invalidation
Chet Haase9d1992d2012-03-13 11:03:25 -07008866 invalidateParentCaches();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008867 invalidate(true);
8868 } else {
8869 mPrivateFlags &= ~ALPHA_SET;
Chet Haase9d1992d2012-03-13 11:03:25 -07008870 invalidateViewProperty(true, false);
Chet Haase1271e2c2012-04-20 09:54:27 -07008871 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008872 mDisplayList.setAlpha(alpha);
8873 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008874 }
Chet Haaseed032702010-10-01 14:05:54 -07008875 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008876 }
8877
8878 /**
Chet Haasea00f3862011-02-22 06:34:40 -08008879 * Faster version of setAlpha() which performs the same steps except there are
8880 * no calls to invalidate(). The caller of this function should perform proper invalidation
8881 * on the parent and this object. The return value indicates whether the subclass handles
8882 * alpha (the return value for onSetAlpha()).
8883 *
8884 * @param alpha The new value for the alpha property
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008885 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and
8886 * the new value for the alpha property is different from the old value
Chet Haasea00f3862011-02-22 06:34:40 -08008887 */
8888 boolean setAlphaNoInvalidation(float alpha) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008889 ensureTransformationInfo();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008890 if (mTransformationInfo.mAlpha != alpha) {
8891 mTransformationInfo.mAlpha = alpha;
8892 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255));
8893 if (subclassHandlesAlpha) {
8894 mPrivateFlags |= ALPHA_SET;
8895 return true;
8896 } else {
8897 mPrivateFlags &= ~ALPHA_SET;
Chet Haase1271e2c2012-04-20 09:54:27 -07008898 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008899 mDisplayList.setAlpha(alpha);
8900 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008901 }
Chet Haasea00f3862011-02-22 06:34:40 -08008902 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008903 return false;
Chet Haasea00f3862011-02-22 06:34:40 -08008904 }
8905
8906 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008907 * Top position of this view relative to its parent.
8908 *
8909 * @return The top of this view, in pixels.
8910 */
8911 @ViewDebug.CapturedViewProperty
8912 public final int getTop() {
8913 return mTop;
8914 }
8915
8916 /**
Chet Haase21cd1382010-09-01 17:42:29 -07008917 * Sets the top position of this view relative to its parent. This method is meant to be called
8918 * by the layout system and should not generally be called otherwise, because the property
8919 * may be changed at any time by the layout.
8920 *
8921 * @param top The top of this view, in pixels.
8922 */
8923 public final void setTop(int top) {
8924 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07008925 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008926 final boolean matrixIsIdentity = mTransformationInfo == null
8927 || mTransformationInfo.mMatrixIsIdentity;
8928 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08008929 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07008930 int minTop;
8931 int yLoc;
8932 if (top < mTop) {
8933 minTop = top;
8934 yLoc = top - mTop;
8935 } else {
8936 minTop = mTop;
8937 yLoc = 0;
8938 }
Chet Haasee9140a72011-02-16 16:23:29 -08008939 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop);
Chet Haase21cd1382010-09-01 17:42:29 -07008940 }
8941 } else {
8942 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08008943 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07008944 }
8945
Chet Haaseed032702010-10-01 14:05:54 -07008946 int width = mRight - mLeft;
8947 int oldHeight = mBottom - mTop;
8948
Chet Haase21cd1382010-09-01 17:42:29 -07008949 mTop = top;
Chet Haase1271e2c2012-04-20 09:54:27 -07008950 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008951 mDisplayList.setTop(mTop);
8952 }
Chet Haase21cd1382010-09-01 17:42:29 -07008953
Chet Haaseed032702010-10-01 14:05:54 -07008954 onSizeChanged(width, mBottom - mTop, width, oldHeight);
8955
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008956 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08008957 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
8958 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008959 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08008960 }
Chet Haase21cd1382010-09-01 17:42:29 -07008961 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08008962 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07008963 }
Chet Haase55dbb652010-12-21 20:15:08 -08008964 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08008965 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07008966 }
8967 }
8968
8969 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008970 * Bottom position of this view relative to its parent.
8971 *
8972 * @return The bottom of this view, in pixels.
8973 */
8974 @ViewDebug.CapturedViewProperty
8975 public final int getBottom() {
8976 return mBottom;
8977 }
8978
8979 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08008980 * True if this view has changed since the last time being drawn.
8981 *
8982 * @return The dirty state of this view.
8983 */
8984 public boolean isDirty() {
8985 return (mPrivateFlags & DIRTY_MASK) != 0;
8986 }
8987
8988 /**
Chet Haase21cd1382010-09-01 17:42:29 -07008989 * Sets the bottom position of this view relative to its parent. This method is meant to be
8990 * called by the layout system and should not generally be called otherwise, because the
8991 * property may be changed at any time by the layout.
8992 *
8993 * @param bottom The bottom of this view, in pixels.
8994 */
8995 public final void setBottom(int bottom) {
8996 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07008997 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008998 final boolean matrixIsIdentity = mTransformationInfo == null
8999 || mTransformationInfo.mMatrixIsIdentity;
9000 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009001 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009002 int maxBottom;
9003 if (bottom < mBottom) {
9004 maxBottom = mBottom;
9005 } else {
9006 maxBottom = bottom;
9007 }
Chet Haasee9140a72011-02-16 16:23:29 -08009008 invalidate(0, 0, mRight - mLeft, maxBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009009 }
9010 } else {
9011 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009012 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009013 }
9014
Chet Haaseed032702010-10-01 14:05:54 -07009015 int width = mRight - mLeft;
9016 int oldHeight = mBottom - mTop;
9017
Chet Haase21cd1382010-09-01 17:42:29 -07009018 mBottom = bottom;
Chet Haase1271e2c2012-04-20 09:54:27 -07009019 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009020 mDisplayList.setBottom(mBottom);
9021 }
Chet Haase21cd1382010-09-01 17:42:29 -07009022
Chet Haaseed032702010-10-01 14:05:54 -07009023 onSizeChanged(width, mBottom - mTop, width, oldHeight);
9024
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009025 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009026 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9027 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009028 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009029 }
Chet Haase21cd1382010-09-01 17:42:29 -07009030 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009031 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009032 }
Chet Haase55dbb652010-12-21 20:15:08 -08009033 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009034 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07009035 }
9036 }
9037
9038 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009039 * Left position of this view relative to its parent.
9040 *
9041 * @return The left edge of this view, in pixels.
9042 */
9043 @ViewDebug.CapturedViewProperty
9044 public final int getLeft() {
9045 return mLeft;
9046 }
9047
9048 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009049 * Sets the left position of this view relative to its parent. This method is meant to be called
9050 * by the layout system and should not generally be called otherwise, because the property
9051 * may be changed at any time by the layout.
9052 *
9053 * @param left The bottom of this view, in pixels.
9054 */
9055 public final void setLeft(int left) {
9056 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07009057 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009058 final boolean matrixIsIdentity = mTransformationInfo == null
9059 || mTransformationInfo.mMatrixIsIdentity;
9060 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009061 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009062 int minLeft;
9063 int xLoc;
9064 if (left < mLeft) {
9065 minLeft = left;
9066 xLoc = left - mLeft;
9067 } else {
9068 minLeft = mLeft;
9069 xLoc = 0;
9070 }
Chet Haasee9140a72011-02-16 16:23:29 -08009071 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009072 }
9073 } else {
9074 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009075 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009076 }
9077
Chet Haaseed032702010-10-01 14:05:54 -07009078 int oldWidth = mRight - mLeft;
9079 int height = mBottom - mTop;
9080
Chet Haase21cd1382010-09-01 17:42:29 -07009081 mLeft = left;
Chet Haase1271e2c2012-04-20 09:54:27 -07009082 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009083 mDisplayList.setLeft(left);
9084 }
Chet Haase21cd1382010-09-01 17:42:29 -07009085
Chet Haaseed032702010-10-01 14:05:54 -07009086 onSizeChanged(mRight - mLeft, height, oldWidth, height);
9087
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009088 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009089 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9090 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009091 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009092 }
Chet Haase21cd1382010-09-01 17:42:29 -07009093 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009094 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009095 }
Chet Haase55dbb652010-12-21 20:15:08 -08009096 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009097 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07009098 }
9099 }
9100
9101 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009102 * Right position of this view relative to its parent.
9103 *
9104 * @return The right edge of this view, in pixels.
9105 */
9106 @ViewDebug.CapturedViewProperty
9107 public final int getRight() {
9108 return mRight;
9109 }
9110
9111 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009112 * Sets the right position of this view relative to its parent. This method is meant to be called
9113 * by the layout system and should not generally be called otherwise, because the property
9114 * may be changed at any time by the layout.
9115 *
9116 * @param right The bottom of this view, in pixels.
9117 */
9118 public final void setRight(int right) {
9119 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07009120 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009121 final boolean matrixIsIdentity = mTransformationInfo == null
9122 || mTransformationInfo.mMatrixIsIdentity;
9123 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009124 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009125 int maxRight;
9126 if (right < mRight) {
9127 maxRight = mRight;
9128 } else {
9129 maxRight = right;
9130 }
Chet Haasee9140a72011-02-16 16:23:29 -08009131 invalidate(0, 0, maxRight - mLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009132 }
9133 } else {
9134 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009135 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009136 }
9137
Chet Haaseed032702010-10-01 14:05:54 -07009138 int oldWidth = mRight - mLeft;
9139 int height = mBottom - mTop;
9140
Chet Haase21cd1382010-09-01 17:42:29 -07009141 mRight = right;
Chet Haase1271e2c2012-04-20 09:54:27 -07009142 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009143 mDisplayList.setRight(mRight);
9144 }
Chet Haase21cd1382010-09-01 17:42:29 -07009145
Chet Haaseed032702010-10-01 14:05:54 -07009146 onSizeChanged(mRight - mLeft, height, oldWidth, height);
9147
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009148 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009149 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9150 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009151 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009152 }
Chet Haase21cd1382010-09-01 17:42:29 -07009153 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009154 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009155 }
Chet Haase55dbb652010-12-21 20:15:08 -08009156 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009157 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07009158 }
9159 }
9160
9161 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009162 * The visual x position of this view, in pixels. This is equivalent to the
9163 * {@link #setTranslationX(float) translationX} property plus the current
Joe Malin32736f02011-01-19 16:14:20 -08009164 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07009165 *
Chet Haasedf030d22010-07-30 17:22:38 -07009166 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07009167 */
Chet Haasea5531132012-02-02 13:41:44 -08009168 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009169 public float getX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009170 return mLeft + (mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0);
Chet Haasedf030d22010-07-30 17:22:38 -07009171 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009172
Chet Haasedf030d22010-07-30 17:22:38 -07009173 /**
9174 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
9175 * {@link #setTranslationX(float) translationX} property to be the difference between
9176 * the x value passed in and the current {@link #getLeft() left} property.
9177 *
9178 * @param x The visual x position of this view, in pixels.
9179 */
9180 public void setX(float x) {
9181 setTranslationX(x - mLeft);
9182 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009183
Chet Haasedf030d22010-07-30 17:22:38 -07009184 /**
9185 * The visual y position of this view, in pixels. This is equivalent to the
9186 * {@link #setTranslationY(float) translationY} property plus the current
9187 * {@link #getTop() top} property.
9188 *
9189 * @return The visual y position of this view, in pixels.
9190 */
Chet Haasea5531132012-02-02 13:41:44 -08009191 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009192 public float getY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009193 return mTop + (mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0);
Chet Haasedf030d22010-07-30 17:22:38 -07009194 }
9195
9196 /**
9197 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
9198 * {@link #setTranslationY(float) translationY} property to be the difference between
9199 * the y value passed in and the current {@link #getTop() top} property.
9200 *
9201 * @param y The visual y position of this view, in pixels.
9202 */
9203 public void setY(float y) {
9204 setTranslationY(y - mTop);
9205 }
9206
9207
9208 /**
9209 * The horizontal location of this view relative to its {@link #getLeft() left} position.
9210 * This position is post-layout, in addition to wherever the object's
9211 * layout placed it.
9212 *
9213 * @return The horizontal position of this view relative to its left position, in pixels.
9214 */
Chet Haasea5531132012-02-02 13:41:44 -08009215 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009216 public float getTranslationX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009217 return mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0;
Chet Haasedf030d22010-07-30 17:22:38 -07009218 }
9219
9220 /**
9221 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
9222 * This effectively positions the object post-layout, in addition to wherever the object's
9223 * layout placed it.
9224 *
9225 * @param translationX The horizontal position of this view relative to its left position,
9226 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08009227 *
9228 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07009229 */
9230 public void setTranslationX(float translationX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009231 ensureTransformationInfo();
9232 final TransformationInfo info = mTransformationInfo;
9233 if (info.mTranslationX != translationX) {
Chet Haasedf030d22010-07-30 17:22:38 -07009234 // Double-invalidation is necessary to capture view's old and new areas
Chet Haase9d1992d2012-03-13 11:03:25 -07009235 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009236 info.mTranslationX = translationX;
9237 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009238 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009239 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009240 mDisplayList.setTranslationX(translationX);
9241 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009242 }
9243 }
9244
9245 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009246 * The horizontal location of this view relative to its {@link #getTop() top} position.
9247 * This position is post-layout, in addition to wherever the object's
9248 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07009249 *
Chet Haasedf030d22010-07-30 17:22:38 -07009250 * @return The vertical position of this view relative to its top position,
9251 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07009252 */
Chet Haasea5531132012-02-02 13:41:44 -08009253 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009254 public float getTranslationY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009255 return mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07009256 }
9257
9258 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009259 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
9260 * This effectively positions the object post-layout, in addition to wherever the object's
9261 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07009262 *
Chet Haasedf030d22010-07-30 17:22:38 -07009263 * @param translationY The vertical position of this view relative to its top position,
9264 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08009265 *
9266 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07009267 */
Chet Haasedf030d22010-07-30 17:22:38 -07009268 public void setTranslationY(float translationY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009269 ensureTransformationInfo();
9270 final TransformationInfo info = mTransformationInfo;
9271 if (info.mTranslationY != translationY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009272 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009273 info.mTranslationY = translationY;
9274 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009275 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009276 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009277 mDisplayList.setTranslationY(translationY);
9278 }
Chet Haasedf030d22010-07-30 17:22:38 -07009279 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009280 }
9281
9282 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009283 * Hit rectangle in parent's coordinates
9284 *
9285 * @param outRect The hit rectangle of the view.
9286 */
9287 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07009288 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009289 final TransformationInfo info = mTransformationInfo;
9290 if (info == null || info.mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009291 outRect.set(mLeft, mTop, mRight, mBottom);
9292 } else {
9293 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009294 tmpRect.set(-info.mPivotX, -info.mPivotY,
9295 getWidth() - info.mPivotX, getHeight() - info.mPivotY);
9296 info.mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07009297 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
9298 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07009299 }
9300 }
9301
9302 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07009303 * Determines whether the given point, in local coordinates is inside the view.
9304 */
9305 /*package*/ final boolean pointInView(float localX, float localY) {
9306 return localX >= 0 && localX < (mRight - mLeft)
9307 && localY >= 0 && localY < (mBottom - mTop);
9308 }
9309
9310 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07009311 * Utility method to determine whether the given point, in local coordinates,
9312 * is inside the view, where the area of the view is expanded by the slop factor.
9313 * This method is called while processing touch-move events to determine if the event
9314 * is still within the view.
9315 */
9316 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07009317 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07009318 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009319 }
9320
9321 /**
9322 * When a view has focus and the user navigates away from it, the next view is searched for
9323 * starting from the rectangle filled in by this method.
9324 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009325 * By default, the rectange is the {@link #getDrawingRect(android.graphics.Rect)})
9326 * of the view. However, if your view maintains some idea of internal selection,
9327 * such as a cursor, or a selected row or column, you should override this method and
9328 * fill in a more specific rectangle.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009329 *
9330 * @param r The rectangle to fill in, in this view's coordinates.
9331 */
9332 public void getFocusedRect(Rect r) {
9333 getDrawingRect(r);
9334 }
9335
9336 /**
9337 * If some part of this view is not clipped by any of its parents, then
9338 * return that area in r in global (root) coordinates. To convert r to local
Gilles Debunnecea45132011-11-24 02:19:27 +01009339 * coordinates (without taking possible View rotations into account), offset
9340 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)).
9341 * If the view is completely clipped or translated out, return false.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009342 *
9343 * @param r If true is returned, r holds the global coordinates of the
9344 * visible portion of this view.
9345 * @param globalOffset If true is returned, globalOffset holds the dx,dy
9346 * between this view and its root. globalOffet may be null.
9347 * @return true if r is non-empty (i.e. part of the view is visible at the
9348 * root level.
9349 */
9350 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
9351 int width = mRight - mLeft;
9352 int height = mBottom - mTop;
9353 if (width > 0 && height > 0) {
9354 r.set(0, 0, width, height);
9355 if (globalOffset != null) {
9356 globalOffset.set(-mScrollX, -mScrollY);
9357 }
9358 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
9359 }
9360 return false;
9361 }
9362
9363 public final boolean getGlobalVisibleRect(Rect r) {
9364 return getGlobalVisibleRect(r, null);
9365 }
9366
9367 public final boolean getLocalVisibleRect(Rect r) {
Romain Guyab4c4f4f2012-05-06 13:11:24 -07009368 final Point offset = mAttachInfo != null ? mAttachInfo.mPoint : new Point();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009369 if (getGlobalVisibleRect(r, offset)) {
9370 r.offset(-offset.x, -offset.y); // make r local
9371 return true;
9372 }
9373 return false;
9374 }
9375
9376 /**
9377 * Offset this view's vertical location by the specified number of pixels.
9378 *
9379 * @param offset the number of pixels to offset the view by
9380 */
9381 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009382 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07009383 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009384 final boolean matrixIsIdentity = mTransformationInfo == null
9385 || mTransformationInfo.mMatrixIsIdentity;
9386 if (matrixIsIdentity) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009387 if (mDisplayList != null) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009388 invalidateViewProperty(false, false);
9389 } else {
9390 final ViewParent p = mParent;
9391 if (p != null && mAttachInfo != null) {
9392 final Rect r = mAttachInfo.mTmpInvalRect;
9393 int minTop;
9394 int maxBottom;
9395 int yLoc;
9396 if (offset < 0) {
9397 minTop = mTop + offset;
9398 maxBottom = mBottom;
9399 yLoc = offset;
9400 } else {
9401 minTop = mTop;
9402 maxBottom = mBottom + offset;
9403 yLoc = 0;
9404 }
9405 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
9406 p.invalidateChild(this, r);
Chet Haase8fbf8d22010-07-30 15:01:32 -07009407 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009408 }
9409 } else {
Chet Haase9d1992d2012-03-13 11:03:25 -07009410 invalidateViewProperty(false, false);
Chet Haasec3aa3612010-06-17 08:50:37 -07009411 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009412
Chet Haasec3aa3612010-06-17 08:50:37 -07009413 mTop += offset;
9414 mBottom += offset;
Chet Haase1271e2c2012-04-20 09:54:27 -07009415 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009416 mDisplayList.offsetTopBottom(offset);
Chet Haase9d1992d2012-03-13 11:03:25 -07009417 invalidateViewProperty(false, false);
9418 } else {
9419 if (!matrixIsIdentity) {
9420 invalidateViewProperty(false, true);
9421 }
9422 invalidateParentIfNeeded();
Chet Haasea1cff502012-02-21 13:43:44 -08009423 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009424 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009425 }
9426
9427 /**
9428 * Offset this view's horizontal location by the specified amount of pixels.
9429 *
9430 * @param offset the numer of pixels to offset the view by
9431 */
9432 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009433 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07009434 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009435 final boolean matrixIsIdentity = mTransformationInfo == null
9436 || mTransformationInfo.mMatrixIsIdentity;
9437 if (matrixIsIdentity) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009438 if (mDisplayList != null) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009439 invalidateViewProperty(false, false);
9440 } else {
9441 final ViewParent p = mParent;
9442 if (p != null && mAttachInfo != null) {
9443 final Rect r = mAttachInfo.mTmpInvalRect;
9444 int minLeft;
9445 int maxRight;
9446 if (offset < 0) {
9447 minLeft = mLeft + offset;
9448 maxRight = mRight;
9449 } else {
9450 minLeft = mLeft;
9451 maxRight = mRight + offset;
9452 }
9453 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
9454 p.invalidateChild(this, r);
Chet Haase8fbf8d22010-07-30 15:01:32 -07009455 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009456 }
9457 } else {
Chet Haase9d1992d2012-03-13 11:03:25 -07009458 invalidateViewProperty(false, false);
Chet Haasec3aa3612010-06-17 08:50:37 -07009459 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009460
Chet Haasec3aa3612010-06-17 08:50:37 -07009461 mLeft += offset;
9462 mRight += offset;
Chet Haase1271e2c2012-04-20 09:54:27 -07009463 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009464 mDisplayList.offsetLeftRight(offset);
Chet Haase9d1992d2012-03-13 11:03:25 -07009465 invalidateViewProperty(false, false);
9466 } else {
9467 if (!matrixIsIdentity) {
9468 invalidateViewProperty(false, true);
9469 }
9470 invalidateParentIfNeeded();
Chet Haasea1cff502012-02-21 13:43:44 -08009471 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009472 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009473 }
9474
9475 /**
9476 * Get the LayoutParams associated with this view. All views should have
9477 * layout parameters. These supply parameters to the <i>parent</i> of this
9478 * view specifying how it should be arranged. There are many subclasses of
9479 * ViewGroup.LayoutParams, and these correspond to the different subclasses
9480 * of ViewGroup that are responsible for arranging their children.
Romain Guy01c174b2011-02-22 11:51:06 -08009481 *
9482 * This method may return null if this View is not attached to a parent
9483 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)}
9484 * was not invoked successfully. When a View is attached to a parent
9485 * ViewGroup, this method must not return null.
9486 *
9487 * @return The LayoutParams associated with this view, or null if no
9488 * parameters have been set yet
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009489 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07009490 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009491 public ViewGroup.LayoutParams getLayoutParams() {
9492 return mLayoutParams;
9493 }
9494
9495 /**
9496 * Set the layout parameters associated with this view. These supply
9497 * parameters to the <i>parent</i> of this view specifying how it should be
9498 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
9499 * correspond to the different subclasses of ViewGroup that are responsible
9500 * for arranging their children.
9501 *
Romain Guy01c174b2011-02-22 11:51:06 -08009502 * @param params The layout parameters for this view, cannot be null
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009503 */
9504 public void setLayoutParams(ViewGroup.LayoutParams params) {
9505 if (params == null) {
Romain Guy01c174b2011-02-22 11:51:06 -08009506 throw new NullPointerException("Layout parameters cannot be null");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009507 }
9508 mLayoutParams = params;
Philip Milned7dd8902012-01-26 16:55:30 -08009509 if (mParent instanceof ViewGroup) {
9510 ((ViewGroup) mParent).onSetLayoutParams(this, params);
9511 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009512 requestLayout();
9513 }
9514
9515 /**
9516 * Set the scrolled position of your view. This will cause a call to
9517 * {@link #onScrollChanged(int, int, int, int)} and the view will be
9518 * invalidated.
9519 * @param x the x position to scroll to
9520 * @param y the y position to scroll to
9521 */
9522 public void scrollTo(int x, int y) {
9523 if (mScrollX != x || mScrollY != y) {
9524 int oldX = mScrollX;
9525 int oldY = mScrollY;
9526 mScrollX = x;
9527 mScrollY = y;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009528 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009529 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07009530 if (!awakenScrollBars()) {
Adam Powelldf3ae4f2012-04-10 18:55:22 -07009531 postInvalidateOnAnimation();
Mike Cleronf116bf82009-09-27 19:14:12 -07009532 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009533 }
9534 }
9535
9536 /**
9537 * Move the scrolled position of your view. This will cause a call to
9538 * {@link #onScrollChanged(int, int, int, int)} and the view will be
9539 * invalidated.
9540 * @param x the amount of pixels to scroll by horizontally
9541 * @param y the amount of pixels to scroll by vertically
9542 */
9543 public void scrollBy(int x, int y) {
9544 scrollTo(mScrollX + x, mScrollY + y);
9545 }
9546
9547 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07009548 * <p>Trigger the scrollbars to draw. When invoked this method starts an
9549 * animation to fade the scrollbars out after a default delay. If a subclass
9550 * provides animated scrolling, the start delay should equal the duration
9551 * of the scrolling animation.</p>
9552 *
9553 * <p>The animation starts only if at least one of the scrollbars is
9554 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
9555 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9556 * this method returns true, and false otherwise. If the animation is
9557 * started, this method calls {@link #invalidate()}; in that case the
9558 * caller should not call {@link #invalidate()}.</p>
9559 *
9560 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07009561 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07009562 *
9563 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
9564 * and {@link #scrollTo(int, int)}.</p>
9565 *
9566 * @return true if the animation is played, false otherwise
9567 *
9568 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07009569 * @see #scrollBy(int, int)
9570 * @see #scrollTo(int, int)
9571 * @see #isHorizontalScrollBarEnabled()
9572 * @see #isVerticalScrollBarEnabled()
9573 * @see #setHorizontalScrollBarEnabled(boolean)
9574 * @see #setVerticalScrollBarEnabled(boolean)
9575 */
9576 protected boolean awakenScrollBars() {
9577 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07009578 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07009579 }
9580
9581 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07009582 * Trigger the scrollbars to draw.
9583 * This method differs from awakenScrollBars() only in its default duration.
9584 * initialAwakenScrollBars() will show the scroll bars for longer than
9585 * usual to give the user more of a chance to notice them.
9586 *
9587 * @return true if the animation is played, false otherwise.
9588 */
9589 private boolean initialAwakenScrollBars() {
9590 return mScrollCache != null &&
9591 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
9592 }
9593
9594 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07009595 * <p>
9596 * Trigger the scrollbars to draw. When invoked this method starts an
9597 * animation to fade the scrollbars out after a fixed delay. If a subclass
9598 * provides animated scrolling, the start delay should equal the duration of
9599 * the scrolling animation.
9600 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009601 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009602 * <p>
9603 * The animation starts only if at least one of the scrollbars is enabled,
9604 * as specified by {@link #isHorizontalScrollBarEnabled()} and
9605 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9606 * this method returns true, and false otherwise. If the animation is
9607 * started, this method calls {@link #invalidate()}; in that case the caller
9608 * should not call {@link #invalidate()}.
9609 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009610 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009611 * <p>
9612 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07009613 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07009614 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009615 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009616 * @param startDelay the delay, in milliseconds, after which the animation
9617 * should start; when the delay is 0, the animation starts
9618 * immediately
9619 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08009620 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009621 * @see #scrollBy(int, int)
9622 * @see #scrollTo(int, int)
9623 * @see #isHorizontalScrollBarEnabled()
9624 * @see #isVerticalScrollBarEnabled()
9625 * @see #setHorizontalScrollBarEnabled(boolean)
9626 * @see #setVerticalScrollBarEnabled(boolean)
9627 */
9628 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07009629 return awakenScrollBars(startDelay, true);
9630 }
Joe Malin32736f02011-01-19 16:14:20 -08009631
Mike Cleron290947b2009-09-29 18:34:32 -07009632 /**
9633 * <p>
9634 * Trigger the scrollbars to draw. When invoked this method starts an
9635 * animation to fade the scrollbars out after a fixed delay. If a subclass
9636 * provides animated scrolling, the start delay should equal the duration of
9637 * the scrolling animation.
9638 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009639 *
Mike Cleron290947b2009-09-29 18:34:32 -07009640 * <p>
9641 * The animation starts only if at least one of the scrollbars is enabled,
9642 * as specified by {@link #isHorizontalScrollBarEnabled()} and
9643 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9644 * this method returns true, and false otherwise. If the animation is
Joe Malin32736f02011-01-19 16:14:20 -08009645 * started, this method calls {@link #invalidate()} if the invalidate parameter
Mike Cleron290947b2009-09-29 18:34:32 -07009646 * is set to true; in that case the caller
9647 * should not call {@link #invalidate()}.
9648 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009649 *
Mike Cleron290947b2009-09-29 18:34:32 -07009650 * <p>
9651 * This method should be invoked everytime a subclass directly updates the
9652 * scroll parameters.
9653 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009654 *
Mike Cleron290947b2009-09-29 18:34:32 -07009655 * @param startDelay the delay, in milliseconds, after which the animation
9656 * should start; when the delay is 0, the animation starts
9657 * immediately
Joe Malin32736f02011-01-19 16:14:20 -08009658 *
Mike Cleron290947b2009-09-29 18:34:32 -07009659 * @param invalidate Wheter this method should call invalidate
Joe Malin32736f02011-01-19 16:14:20 -08009660 *
Mike Cleron290947b2009-09-29 18:34:32 -07009661 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08009662 *
Mike Cleron290947b2009-09-29 18:34:32 -07009663 * @see #scrollBy(int, int)
9664 * @see #scrollTo(int, int)
9665 * @see #isHorizontalScrollBarEnabled()
9666 * @see #isVerticalScrollBarEnabled()
9667 * @see #setHorizontalScrollBarEnabled(boolean)
9668 * @see #setVerticalScrollBarEnabled(boolean)
9669 */
9670 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07009671 final ScrollabilityCache scrollCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08009672
Mike Cleronf116bf82009-09-27 19:14:12 -07009673 if (scrollCache == null || !scrollCache.fadeScrollBars) {
9674 return false;
9675 }
9676
9677 if (scrollCache.scrollBar == null) {
9678 scrollCache.scrollBar = new ScrollBarDrawable();
9679 }
9680
9681 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
9682
Mike Cleron290947b2009-09-29 18:34:32 -07009683 if (invalidate) {
9684 // Invalidate to show the scrollbars
Adam Powelldf3ae4f2012-04-10 18:55:22 -07009685 postInvalidateOnAnimation();
Mike Cleron290947b2009-09-29 18:34:32 -07009686 }
Mike Cleronf116bf82009-09-27 19:14:12 -07009687
9688 if (scrollCache.state == ScrollabilityCache.OFF) {
9689 // FIXME: this is copied from WindowManagerService.
9690 // We should get this value from the system when it
9691 // is possible to do so.
9692 final int KEY_REPEAT_FIRST_DELAY = 750;
9693 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
9694 }
9695
9696 // Tell mScrollCache when we should start fading. This may
9697 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07009698 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07009699 scrollCache.fadeStartTime = fadeStartTime;
9700 scrollCache.state = ScrollabilityCache.ON;
9701
9702 // Schedule our fader to run, unscheduling any old ones first
9703 if (mAttachInfo != null) {
9704 mAttachInfo.mHandler.removeCallbacks(scrollCache);
9705 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
9706 }
9707
9708 return true;
9709 }
9710
9711 return false;
9712 }
9713
9714 /**
Chet Haaseaceafe62011-08-26 15:44:33 -07009715 * Do not invalidate views which are not visible and which are not running an animation. They
9716 * will not get drawn and they should not set dirty flags as if they will be drawn
9717 */
9718 private boolean skipInvalidate() {
9719 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null &&
9720 (!(mParent instanceof ViewGroup) ||
9721 !((ViewGroup) mParent).isViewTransitioning(this));
9722 }
9723 /**
Joe Fernandez558459f2011-10-13 16:47:36 -07009724 * Mark the area defined by dirty as needing to be drawn. If the view is
Romain Guy5c22a8c2011-05-13 11:48:45 -07009725 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some point
9726 * in the future. This must be called from a UI thread. To call from a non-UI
9727 * thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009728 *
9729 * WARNING: This method is destructive to dirty.
9730 * @param dirty the rectangle representing the bounds of the dirty region
9731 */
9732 public void invalidate(Rect dirty) {
9733 if (ViewDebug.TRACE_HIERARCHY) {
9734 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
9735 }
9736
Chet Haaseaceafe62011-08-26 15:44:33 -07009737 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -07009738 return;
9739 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009740 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08009741 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
9742 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009743 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08009744 mPrivateFlags |= INVALIDATED;
Chet Haasef186f302011-09-11 11:06:06 -07009745 mPrivateFlags |= DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009746 final ViewParent p = mParent;
9747 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08009748 //noinspection PointlessBooleanExpression,ConstantConditions
9749 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
9750 if (p != null && ai != null && ai.mHardwareAccelerated) {
9751 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07009752 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08009753 p.invalidateChild(this, null);
9754 return;
9755 }
Romain Guyaf636eb2010-12-09 17:47:21 -08009756 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009757 if (p != null && ai != null) {
9758 final int scrollX = mScrollX;
9759 final int scrollY = mScrollY;
9760 final Rect r = ai.mTmpInvalRect;
9761 r.set(dirty.left - scrollX, dirty.top - scrollY,
9762 dirty.right - scrollX, dirty.bottom - scrollY);
9763 mParent.invalidateChild(this, r);
9764 }
9765 }
9766 }
9767
9768 /**
Joe Fernandez558459f2011-10-13 16:47:36 -07009769 * Mark the area defined by the rect (l,t,r,b) as needing to be drawn.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009770 * The coordinates of the dirty rect are relative to the view.
Romain Guy5c22a8c2011-05-13 11:48:45 -07009771 * If the view is visible, {@link #onDraw(android.graphics.Canvas)}
9772 * will be called at some point in the future. This must be called from
9773 * a UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009774 * @param l the left position of the dirty region
9775 * @param t the top position of the dirty region
9776 * @param r the right position of the dirty region
9777 * @param b the bottom position of the dirty region
9778 */
9779 public void invalidate(int l, int t, int r, int b) {
9780 if (ViewDebug.TRACE_HIERARCHY) {
9781 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
9782 }
9783
Chet Haaseaceafe62011-08-26 15:44:33 -07009784 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -07009785 return;
9786 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009787 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08009788 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
9789 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009790 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08009791 mPrivateFlags |= INVALIDATED;
Chet Haasef186f302011-09-11 11:06:06 -07009792 mPrivateFlags |= DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009793 final ViewParent p = mParent;
9794 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08009795 //noinspection PointlessBooleanExpression,ConstantConditions
9796 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
9797 if (p != null && ai != null && ai.mHardwareAccelerated) {
9798 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07009799 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08009800 p.invalidateChild(this, null);
9801 return;
9802 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08009803 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009804 if (p != null && ai != null && l < r && t < b) {
9805 final int scrollX = mScrollX;
9806 final int scrollY = mScrollY;
9807 final Rect tmpr = ai.mTmpInvalRect;
9808 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
9809 p.invalidateChild(this, tmpr);
9810 }
9811 }
9812 }
9813
9814 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07009815 * Invalidate the whole view. If the view is visible,
9816 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in
9817 * the future. This must be called from a UI thread. To call from a non-UI thread,
9818 * call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009819 */
9820 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -07009821 invalidate(true);
9822 }
Joe Malin32736f02011-01-19 16:14:20 -08009823
Chet Haaseed032702010-10-01 14:05:54 -07009824 /**
9825 * This is where the invalidate() work actually happens. A full invalidate()
9826 * causes the drawing cache to be invalidated, but this function can be called with
9827 * invalidateCache set to false to skip that invalidation step for cases that do not
9828 * need it (for example, a component that remains at the same dimensions with the same
9829 * content).
9830 *
9831 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
9832 * well. This is usually true for a full invalidate, but may be set to false if the
9833 * View's contents or dimensions have not changed.
9834 */
Romain Guy849d0a32011-02-01 17:20:48 -08009835 void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009836 if (ViewDebug.TRACE_HIERARCHY) {
9837 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
9838 }
9839
Chet Haaseaceafe62011-08-26 15:44:33 -07009840 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -07009841 return;
9842 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009843 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Romain Guyc5d55862011-01-21 19:01:46 -08009844 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) ||
Romain Guy0fd89bf2011-01-26 15:41:30 -08009845 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) {
9846 mLastIsOpaque = isOpaque();
Chet Haaseed032702010-10-01 14:05:54 -07009847 mPrivateFlags &= ~DRAWN;
Chet Haasef186f302011-09-11 11:06:06 -07009848 mPrivateFlags |= DIRTY;
Chet Haaseed032702010-10-01 14:05:54 -07009849 if (invalidateCache) {
Chet Haasedaf98e92011-01-10 14:10:36 -08009850 mPrivateFlags |= INVALIDATED;
Chet Haaseed032702010-10-01 14:05:54 -07009851 mPrivateFlags &= ~DRAWING_CACHE_VALID;
9852 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009853 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -07009854 final ViewParent p = mParent;
Romain Guy7d7b5492011-01-24 16:33:45 -08009855 //noinspection PointlessBooleanExpression,ConstantConditions
9856 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
9857 if (p != null && ai != null && ai.mHardwareAccelerated) {
9858 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07009859 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08009860 p.invalidateChild(this, null);
9861 return;
9862 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08009863 }
Michael Jurkaebefea42010-11-15 16:04:01 -08009864
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009865 if (p != null && ai != null) {
9866 final Rect r = ai.mTmpInvalRect;
9867 r.set(0, 0, mRight - mLeft, mBottom - mTop);
9868 // Don't call invalidate -- we don't want to internally scroll
9869 // our own bounds
9870 p.invalidateChild(this, r);
9871 }
9872 }
9873 }
9874
9875 /**
Chet Haase9d1992d2012-03-13 11:03:25 -07009876 * Quick invalidation for View property changes (alpha, translationXY, etc.). We don't want to
9877 * set any flags or handle all of the cases handled by the default invalidation methods.
9878 * Instead, we just want to schedule a traversal in ViewRootImpl with the appropriate
9879 * dirty rect. This method calls into fast invalidation methods in ViewGroup that
9880 * walk up the hierarchy, transforming the dirty rect as necessary.
9881 *
9882 * The method also handles normal invalidation logic if display list properties are not
9883 * being used in this view. The invalidateParent and forceRedraw flags are used by that
9884 * backup approach, to handle these cases used in the various property-setting methods.
9885 *
9886 * @param invalidateParent Force a call to invalidateParentCaches() if display list properties
9887 * are not being used in this view
9888 * @param forceRedraw Mark the view as DRAWN to force the invalidation to propagate, if display
9889 * list properties are not being used in this view
9890 */
9891 void invalidateViewProperty(boolean invalidateParent, boolean forceRedraw) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009892 if (mDisplayList == null || (mPrivateFlags & DRAW_ANIMATION) == DRAW_ANIMATION) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009893 if (invalidateParent) {
9894 invalidateParentCaches();
9895 }
9896 if (forceRedraw) {
9897 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
9898 }
9899 invalidate(false);
9900 } else {
9901 final AttachInfo ai = mAttachInfo;
9902 final ViewParent p = mParent;
9903 if (p != null && ai != null) {
9904 final Rect r = ai.mTmpInvalRect;
9905 r.set(0, 0, mRight - mLeft, mBottom - mTop);
9906 if (mParent instanceof ViewGroup) {
9907 ((ViewGroup) mParent).invalidateChildFast(this, r);
9908 } else {
9909 mParent.invalidateChild(this, r);
9910 }
9911 }
9912 }
9913 }
9914
9915 /**
9916 * Utility method to transform a given Rect by the current matrix of this view.
9917 */
9918 void transformRect(final Rect rect) {
9919 if (!getMatrix().isIdentity()) {
9920 RectF boundingRect = mAttachInfo.mTmpTransformRect;
9921 boundingRect.set(rect);
9922 getMatrix().mapRect(boundingRect);
9923 rect.set((int) (boundingRect.left - 0.5f),
9924 (int) (boundingRect.top - 0.5f),
9925 (int) (boundingRect.right + 0.5f),
9926 (int) (boundingRect.bottom + 0.5f));
9927 }
9928 }
9929
9930 /**
Romain Guy0fd89bf2011-01-26 15:41:30 -08009931 * Used to indicate that the parent of this view should clear its caches. This functionality
Chet Haasedaf98e92011-01-10 14:10:36 -08009932 * is used to force the parent to rebuild its display list (when hardware-accelerated),
9933 * which is necessary when various parent-managed properties of the view change, such as
Romain Guy0fd89bf2011-01-26 15:41:30 -08009934 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only
9935 * clears the parent caches and does not causes an invalidate event.
Chet Haasedaf98e92011-01-10 14:10:36 -08009936 *
9937 * @hide
9938 */
Romain Guy0fd89bf2011-01-26 15:41:30 -08009939 protected void invalidateParentCaches() {
9940 if (mParent instanceof View) {
9941 ((View) mParent).mPrivateFlags |= INVALIDATED;
9942 }
9943 }
Joe Malin32736f02011-01-19 16:14:20 -08009944
Romain Guy0fd89bf2011-01-26 15:41:30 -08009945 /**
9946 * Used to indicate that the parent of this view should be invalidated. This functionality
9947 * is used to force the parent to rebuild its display list (when hardware-accelerated),
9948 * which is necessary when various parent-managed properties of the view change, such as
9949 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate
9950 * an invalidation event to the parent.
9951 *
9952 * @hide
9953 */
9954 protected void invalidateParentIfNeeded() {
Chet Haasedaf98e92011-01-10 14:10:36 -08009955 if (isHardwareAccelerated() && mParent instanceof View) {
Romain Guy0fd89bf2011-01-26 15:41:30 -08009956 ((View) mParent).invalidate(true);
Chet Haasedaf98e92011-01-10 14:10:36 -08009957 }
9958 }
9959
9960 /**
Romain Guy24443ea2009-05-11 11:56:30 -07009961 * Indicates whether this View is opaque. An opaque View guarantees that it will
9962 * draw all the pixels overlapping its bounds using a fully opaque color.
9963 *
9964 * Subclasses of View should override this method whenever possible to indicate
9965 * whether an instance is opaque. Opaque Views are treated in a special way by
9966 * the View hierarchy, possibly allowing it to perform optimizations during
9967 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -07009968 *
Romain Guy24443ea2009-05-11 11:56:30 -07009969 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -07009970 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07009971 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -07009972 public boolean isOpaque() {
Chet Haase70d4ba12010-10-06 09:46:45 -07009973 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK &&
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009974 ((mTransformationInfo != null ? mTransformationInfo.mAlpha : 1)
9975 >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD);
Romain Guy8f1344f52009-05-15 16:03:59 -07009976 }
9977
Adam Powell20232d02010-12-08 21:08:53 -08009978 /**
9979 * @hide
9980 */
9981 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -07009982 // Opaque if:
9983 // - Has a background
9984 // - Background is opaque
9985 // - Doesn't have scrollbars or scrollbars are inside overlay
9986
Philip Milne6c8ea062012-04-03 17:38:43 -07009987 if (mBackground != null && mBackground.getOpacity() == PixelFormat.OPAQUE) {
Romain Guy8f1344f52009-05-15 16:03:59 -07009988 mPrivateFlags |= OPAQUE_BACKGROUND;
9989 } else {
9990 mPrivateFlags &= ~OPAQUE_BACKGROUND;
9991 }
9992
9993 final int flags = mViewFlags;
9994 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
9995 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
9996 mPrivateFlags |= OPAQUE_SCROLLBARS;
9997 } else {
9998 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
9999 }
10000 }
10001
10002 /**
10003 * @hide
10004 */
10005 protected boolean hasOpaqueScrollbars() {
10006 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -070010007 }
10008
10009 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010010 * @return A handler associated with the thread running the View. This
10011 * handler can be used to pump events in the UI events queue.
10012 */
10013 public Handler getHandler() {
10014 if (mAttachInfo != null) {
10015 return mAttachInfo.mHandler;
10016 }
10017 return null;
10018 }
10019
10020 /**
Jeff Browna175a5b2012-02-15 19:18:31 -080010021 * Gets the view root associated with the View.
10022 * @return The view root, or null if none.
10023 * @hide
10024 */
10025 public ViewRootImpl getViewRootImpl() {
10026 if (mAttachInfo != null) {
10027 return mAttachInfo.mViewRootImpl;
10028 }
10029 return null;
10030 }
10031
10032 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010033 * <p>Causes the Runnable to be added to the message queue.
10034 * The runnable will be run on the user interface thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010035 *
Romain Guye63a4f32011-08-11 11:33:31 -070010036 * <p>This method can be invoked from outside of the UI thread
10037 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010038 *
10039 * @param action The Runnable that will be executed.
10040 *
10041 * @return Returns true if the Runnable was successfully placed in to the
10042 * message queue. Returns false on failure, usually because the
10043 * looper processing the message queue is exiting.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010044 *
10045 * @see #postDelayed
10046 * @see #removeCallbacks
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010047 */
10048 public boolean post(Runnable action) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010049 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010050 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010051 return attachInfo.mHandler.post(action);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010052 }
Jeff Browna175a5b2012-02-15 19:18:31 -080010053 // Assume that post will succeed later
10054 ViewRootImpl.getRunQueue().post(action);
10055 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010056 }
10057
10058 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010059 * <p>Causes the Runnable to be added to the message queue, to be run
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010060 * after the specified amount of time elapses.
Romain Guye63a4f32011-08-11 11:33:31 -070010061 * The runnable will be run on the user interface thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010062 *
Romain Guye63a4f32011-08-11 11:33:31 -070010063 * <p>This method can be invoked from outside of the UI thread
10064 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010065 *
10066 * @param action The Runnable that will be executed.
10067 * @param delayMillis The delay (in milliseconds) until the Runnable
10068 * will be executed.
10069 *
10070 * @return true if the Runnable was successfully placed in to the
10071 * message queue. Returns false on failure, usually because the
10072 * looper processing the message queue is exiting. Note that a
10073 * result of true does not mean the Runnable will be processed --
10074 * if the looper is quit before the delivery time of the message
10075 * occurs then the message will be dropped.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010076 *
10077 * @see #post
10078 * @see #removeCallbacks
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010079 */
10080 public boolean postDelayed(Runnable action, long delayMillis) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010081 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010082 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010083 return attachInfo.mHandler.postDelayed(action, delayMillis);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010084 }
Jeff Browna175a5b2012-02-15 19:18:31 -080010085 // Assume that post will succeed later
10086 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
10087 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010088 }
10089
10090 /**
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010091 * <p>Causes the Runnable to execute on the next animation time step.
10092 * The runnable will be run on the user interface thread.</p>
10093 *
10094 * <p>This method can be invoked from outside of the UI thread
10095 * only when this View is attached to a window.</p>
10096 *
10097 * @param action The Runnable that will be executed.
10098 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010099 * @see #postOnAnimationDelayed
10100 * @see #removeCallbacks
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010101 */
10102 public void postOnAnimation(Runnable action) {
10103 final AttachInfo attachInfo = mAttachInfo;
10104 if (attachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010105 attachInfo.mViewRootImpl.mChoreographer.postCallback(
10106 Choreographer.CALLBACK_ANIMATION, action, null);
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010107 } else {
10108 // Assume that post will succeed later
10109 ViewRootImpl.getRunQueue().post(action);
10110 }
10111 }
10112
10113 /**
10114 * <p>Causes the Runnable to execute on the next animation time step,
10115 * after the specified amount of time elapses.
10116 * The runnable will be run on the user interface thread.</p>
10117 *
10118 * <p>This method can be invoked from outside of the UI thread
10119 * only when this View is attached to a window.</p>
10120 *
10121 * @param action The Runnable that will be executed.
10122 * @param delayMillis The delay (in milliseconds) until the Runnable
10123 * will be executed.
10124 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010125 * @see #postOnAnimation
10126 * @see #removeCallbacks
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010127 */
10128 public void postOnAnimationDelayed(Runnable action, long delayMillis) {
10129 final AttachInfo attachInfo = mAttachInfo;
10130 if (attachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010131 attachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed(
10132 Choreographer.CALLBACK_ANIMATION, action, null, delayMillis);
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010133 } else {
10134 // Assume that post will succeed later
10135 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
10136 }
10137 }
10138
10139 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010140 * <p>Removes the specified Runnable from the message queue.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010141 *
Romain Guye63a4f32011-08-11 11:33:31 -070010142 * <p>This method can be invoked from outside of the UI thread
10143 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010144 *
10145 * @param action The Runnable to remove from the message handling queue
10146 *
10147 * @return true if this view could ask the Handler to remove the Runnable,
10148 * false otherwise. When the returned value is true, the Runnable
10149 * may or may not have been actually removed from the message queue
10150 * (for instance, if the Runnable was not in the queue already.)
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010151 *
10152 * @see #post
10153 * @see #postDelayed
10154 * @see #postOnAnimation
10155 * @see #postOnAnimationDelayed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010156 */
10157 public boolean removeCallbacks(Runnable action) {
Jeff Brown43ea54b2012-03-09 14:37:48 -080010158 if (action != null) {
10159 final AttachInfo attachInfo = mAttachInfo;
10160 if (attachInfo != null) {
10161 attachInfo.mHandler.removeCallbacks(action);
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010162 attachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
10163 Choreographer.CALLBACK_ANIMATION, action, null);
Jeff Brown43ea54b2012-03-09 14:37:48 -080010164 } else {
10165 // Assume that post will succeed later
10166 ViewRootImpl.getRunQueue().removeCallbacks(action);
10167 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010168 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010169 return true;
10170 }
10171
10172 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010173 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop.
10174 * Use this to invalidate the View from a non-UI thread.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010175 *
Romain Guye63a4f32011-08-11 11:33:31 -070010176 * <p>This method can be invoked from outside of the UI thread
10177 * only when this View is attached to a window.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010178 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010179 * @see #invalidate()
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010180 * @see #postInvalidateDelayed(long)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010181 */
10182 public void postInvalidate() {
10183 postInvalidateDelayed(0);
10184 }
10185
10186 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010187 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
10188 * through the event loop. Use this to invalidate the View from a non-UI thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010189 *
Romain Guye63a4f32011-08-11 11:33:31 -070010190 * <p>This method can be invoked from outside of the UI thread
10191 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010192 *
10193 * @param left The left coordinate of the rectangle to invalidate.
10194 * @param top The top coordinate of the rectangle to invalidate.
10195 * @param right The right coordinate of the rectangle to invalidate.
10196 * @param bottom The bottom coordinate of the rectangle to invalidate.
10197 *
10198 * @see #invalidate(int, int, int, int)
10199 * @see #invalidate(Rect)
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010200 * @see #postInvalidateDelayed(long, int, int, int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010201 */
10202 public void postInvalidate(int left, int top, int right, int bottom) {
10203 postInvalidateDelayed(0, left, top, right, bottom);
10204 }
10205
10206 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010207 * <p>Cause an invalidate to happen on a subsequent cycle through the event
10208 * loop. Waits for the specified amount of time.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010209 *
Romain Guye63a4f32011-08-11 11:33:31 -070010210 * <p>This method can be invoked from outside of the UI thread
10211 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010212 *
10213 * @param delayMilliseconds the duration in milliseconds to delay the
10214 * invalidation by
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010215 *
10216 * @see #invalidate()
10217 * @see #postInvalidate()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010218 */
10219 public void postInvalidateDelayed(long delayMilliseconds) {
10220 // We try only with the AttachInfo because there's no point in invalidating
10221 // if we are not attached to our window
Jeff Browna175a5b2012-02-15 19:18:31 -080010222 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010223 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010224 attachInfo.mViewRootImpl.dispatchInvalidateDelayed(this, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010225 }
10226 }
10227
10228 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010229 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
10230 * through the event loop. Waits for the specified amount of time.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010231 *
Romain Guye63a4f32011-08-11 11:33:31 -070010232 * <p>This method can be invoked from outside of the UI thread
10233 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010234 *
10235 * @param delayMilliseconds the duration in milliseconds to delay the
10236 * invalidation by
10237 * @param left The left coordinate of the rectangle to invalidate.
10238 * @param top The top coordinate of the rectangle to invalidate.
10239 * @param right The right coordinate of the rectangle to invalidate.
10240 * @param bottom The bottom coordinate of the rectangle to invalidate.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010241 *
10242 * @see #invalidate(int, int, int, int)
10243 * @see #invalidate(Rect)
10244 * @see #postInvalidate(int, int, int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010245 */
10246 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
10247 int right, int bottom) {
10248
10249 // We try only with the AttachInfo because there's no point in invalidating
10250 // if we are not attached to our window
Jeff Browna175a5b2012-02-15 19:18:31 -080010251 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010252 if (attachInfo != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010253 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
10254 info.target = this;
10255 info.left = left;
10256 info.top = top;
10257 info.right = right;
10258 info.bottom = bottom;
10259
Jeff Browna175a5b2012-02-15 19:18:31 -080010260 attachInfo.mViewRootImpl.dispatchInvalidateRectDelayed(info, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010261 }
10262 }
10263
10264 /**
Jeff Brown6cb7b462012-03-05 13:21:17 -080010265 * <p>Cause an invalidate to happen on the next animation time step, typically the
10266 * next display frame.</p>
10267 *
10268 * <p>This method can be invoked from outside of the UI thread
10269 * only when this View is attached to a window.</p>
10270 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010271 * @see #invalidate()
Jeff Brown6cb7b462012-03-05 13:21:17 -080010272 */
10273 public void postInvalidateOnAnimation() {
10274 // We try only with the AttachInfo because there's no point in invalidating
10275 // if we are not attached to our window
10276 final AttachInfo attachInfo = mAttachInfo;
10277 if (attachInfo != null) {
10278 attachInfo.mViewRootImpl.dispatchInvalidateOnAnimation(this);
10279 }
10280 }
10281
10282 /**
10283 * <p>Cause an invalidate of the specified area to happen on the next animation
10284 * time step, typically the next display frame.</p>
10285 *
10286 * <p>This method can be invoked from outside of the UI thread
10287 * only when this View is attached to a window.</p>
10288 *
10289 * @param left The left coordinate of the rectangle to invalidate.
10290 * @param top The top coordinate of the rectangle to invalidate.
10291 * @param right The right coordinate of the rectangle to invalidate.
10292 * @param bottom The bottom coordinate of the rectangle to invalidate.
10293 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010294 * @see #invalidate(int, int, int, int)
10295 * @see #invalidate(Rect)
Jeff Brown6cb7b462012-03-05 13:21:17 -080010296 */
10297 public void postInvalidateOnAnimation(int left, int top, int right, int bottom) {
10298 // We try only with the AttachInfo because there's no point in invalidating
10299 // if we are not attached to our window
10300 final AttachInfo attachInfo = mAttachInfo;
10301 if (attachInfo != null) {
10302 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
10303 info.target = this;
10304 info.left = left;
10305 info.top = top;
10306 info.right = right;
10307 info.bottom = bottom;
10308
10309 attachInfo.mViewRootImpl.dispatchInvalidateRectOnAnimation(info);
10310 }
10311 }
10312
10313 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -070010314 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event.
10315 * This event is sent at most once every
10316 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}.
10317 */
10318 private void postSendViewScrolledAccessibilityEventCallback() {
10319 if (mSendViewScrolledAccessibilityEvent == null) {
10320 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent();
10321 }
10322 if (!mSendViewScrolledAccessibilityEvent.mIsPending) {
10323 mSendViewScrolledAccessibilityEvent.mIsPending = true;
10324 postDelayed(mSendViewScrolledAccessibilityEvent,
10325 ViewConfiguration.getSendRecurringAccessibilityEventsInterval());
10326 }
10327 }
10328
10329 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010330 * Called by a parent to request that a child update its values for mScrollX
10331 * and mScrollY if necessary. This will typically be done if the child is
10332 * animating a scroll using a {@link android.widget.Scroller Scroller}
10333 * object.
10334 */
10335 public void computeScroll() {
10336 }
10337
10338 /**
10339 * <p>Indicate whether the horizontal edges are faded when the view is
10340 * scrolled horizontally.</p>
10341 *
10342 * @return true if the horizontal edges should are faded on scroll, false
10343 * otherwise
10344 *
10345 * @see #setHorizontalFadingEdgeEnabled(boolean)
Philip Milne6c8ea062012-04-03 17:38:43 -070010346 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010347 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010348 */
10349 public boolean isHorizontalFadingEdgeEnabled() {
10350 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
10351 }
10352
10353 /**
10354 * <p>Define whether the horizontal edges should be faded when this view
10355 * is scrolled horizontally.</p>
10356 *
10357 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
10358 * be faded when the view is scrolled
10359 * horizontally
10360 *
10361 * @see #isHorizontalFadingEdgeEnabled()
Philip Milne6c8ea062012-04-03 17:38:43 -070010362 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010363 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010364 */
10365 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
10366 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
10367 if (horizontalFadingEdgeEnabled) {
10368 initScrollCache();
10369 }
10370
10371 mViewFlags ^= FADING_EDGE_HORIZONTAL;
10372 }
10373 }
10374
10375 /**
10376 * <p>Indicate whether the vertical edges are faded when the view is
10377 * scrolled horizontally.</p>
10378 *
10379 * @return true if the vertical edges should are faded on scroll, false
10380 * otherwise
10381 *
10382 * @see #setVerticalFadingEdgeEnabled(boolean)
Philip Milne6c8ea062012-04-03 17:38:43 -070010383 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010384 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010385 */
10386 public boolean isVerticalFadingEdgeEnabled() {
10387 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
10388 }
10389
10390 /**
10391 * <p>Define whether the vertical edges should be faded when this view
10392 * is scrolled vertically.</p>
10393 *
10394 * @param verticalFadingEdgeEnabled true if the vertical edges should
10395 * be faded when the view is scrolled
10396 * vertically
10397 *
10398 * @see #isVerticalFadingEdgeEnabled()
Philip Milne6c8ea062012-04-03 17:38:43 -070010399 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010400 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010401 */
10402 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
10403 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
10404 if (verticalFadingEdgeEnabled) {
10405 initScrollCache();
10406 }
10407
10408 mViewFlags ^= FADING_EDGE_VERTICAL;
10409 }
10410 }
10411
10412 /**
10413 * Returns the strength, or intensity, of the top faded edge. The strength is
10414 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10415 * returns 0.0 or 1.0 but no value in between.
10416 *
10417 * Subclasses should override this method to provide a smoother fade transition
10418 * when scrolling occurs.
10419 *
10420 * @return the intensity of the top fade as a float between 0.0f and 1.0f
10421 */
10422 protected float getTopFadingEdgeStrength() {
10423 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
10424 }
10425
10426 /**
10427 * Returns the strength, or intensity, of the bottom faded edge. The strength is
10428 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10429 * returns 0.0 or 1.0 but no value in between.
10430 *
10431 * Subclasses should override this method to provide a smoother fade transition
10432 * when scrolling occurs.
10433 *
10434 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
10435 */
10436 protected float getBottomFadingEdgeStrength() {
10437 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
10438 computeVerticalScrollRange() ? 1.0f : 0.0f;
10439 }
10440
10441 /**
10442 * Returns the strength, or intensity, of the left faded edge. The strength is
10443 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10444 * returns 0.0 or 1.0 but no value in between.
10445 *
10446 * Subclasses should override this method to provide a smoother fade transition
10447 * when scrolling occurs.
10448 *
10449 * @return the intensity of the left fade as a float between 0.0f and 1.0f
10450 */
10451 protected float getLeftFadingEdgeStrength() {
10452 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
10453 }
10454
10455 /**
10456 * Returns the strength, or intensity, of the right faded edge. The strength is
10457 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10458 * returns 0.0 or 1.0 but no value in between.
10459 *
10460 * Subclasses should override this method to provide a smoother fade transition
10461 * when scrolling occurs.
10462 *
10463 * @return the intensity of the right fade as a float between 0.0f and 1.0f
10464 */
10465 protected float getRightFadingEdgeStrength() {
10466 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
10467 computeHorizontalScrollRange() ? 1.0f : 0.0f;
10468 }
10469
10470 /**
10471 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
10472 * scrollbar is not drawn by default.</p>
10473 *
10474 * @return true if the horizontal scrollbar should be painted, false
10475 * otherwise
10476 *
10477 * @see #setHorizontalScrollBarEnabled(boolean)
10478 */
10479 public boolean isHorizontalScrollBarEnabled() {
10480 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
10481 }
10482
10483 /**
10484 * <p>Define whether the horizontal scrollbar should be drawn or not. The
10485 * scrollbar is not drawn by default.</p>
10486 *
10487 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
10488 * be painted
10489 *
10490 * @see #isHorizontalScrollBarEnabled()
10491 */
10492 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
10493 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
10494 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -070010495 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010496 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010497 }
10498 }
10499
10500 /**
10501 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
10502 * scrollbar is not drawn by default.</p>
10503 *
10504 * @return true if the vertical scrollbar should be painted, false
10505 * otherwise
10506 *
10507 * @see #setVerticalScrollBarEnabled(boolean)
10508 */
10509 public boolean isVerticalScrollBarEnabled() {
10510 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
10511 }
10512
10513 /**
10514 * <p>Define whether the vertical scrollbar should be drawn or not. The
10515 * scrollbar is not drawn by default.</p>
10516 *
10517 * @param verticalScrollBarEnabled true if the vertical scrollbar should
10518 * be painted
10519 *
10520 * @see #isVerticalScrollBarEnabled()
10521 */
10522 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
10523 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
10524 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -070010525 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010526 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010527 }
10528 }
10529
Adam Powell20232d02010-12-08 21:08:53 -080010530 /**
10531 * @hide
10532 */
10533 protected void recomputePadding() {
10534 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010535 }
Joe Malin32736f02011-01-19 16:14:20 -080010536
Mike Cleronfe81d382009-09-28 14:22:16 -070010537 /**
10538 * Define whether scrollbars will fade when the view is not scrolling.
Joe Malin32736f02011-01-19 16:14:20 -080010539 *
Mike Cleronfe81d382009-09-28 14:22:16 -070010540 * @param fadeScrollbars wheter to enable fading
Joe Malin32736f02011-01-19 16:14:20 -080010541 *
Philip Milne6c8ea062012-04-03 17:38:43 -070010542 * @attr ref android.R.styleable#View_fadeScrollbars
Mike Cleronfe81d382009-09-28 14:22:16 -070010543 */
10544 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
10545 initScrollCache();
10546 final ScrollabilityCache scrollabilityCache = mScrollCache;
10547 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -070010548 if (fadeScrollbars) {
10549 scrollabilityCache.state = ScrollabilityCache.OFF;
10550 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -070010551 scrollabilityCache.state = ScrollabilityCache.ON;
10552 }
10553 }
Joe Malin32736f02011-01-19 16:14:20 -080010554
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010555 /**
Joe Malin32736f02011-01-19 16:14:20 -080010556 *
Mike Cleron52f0a642009-09-28 18:21:37 -070010557 * Returns true if scrollbars will fade when this view is not scrolling
Joe Malin32736f02011-01-19 16:14:20 -080010558 *
Mike Cleron52f0a642009-09-28 18:21:37 -070010559 * @return true if scrollbar fading is enabled
Philip Milne6c8ea062012-04-03 17:38:43 -070010560 *
10561 * @attr ref android.R.styleable#View_fadeScrollbars
Mike Cleron52f0a642009-09-28 18:21:37 -070010562 */
10563 public boolean isScrollbarFadingEnabled() {
Joe Malin32736f02011-01-19 16:14:20 -080010564 return mScrollCache != null && mScrollCache.fadeScrollBars;
Mike Cleron52f0a642009-09-28 18:21:37 -070010565 }
Joe Malin32736f02011-01-19 16:14:20 -080010566
Mike Cleron52f0a642009-09-28 18:21:37 -070010567 /**
Philip Milne6c8ea062012-04-03 17:38:43 -070010568 *
10569 * Returns the delay before scrollbars fade.
10570 *
10571 * @return the delay before scrollbars fade
10572 *
10573 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
10574 */
10575 public int getScrollBarDefaultDelayBeforeFade() {
10576 return mScrollCache == null ? ViewConfiguration.getScrollDefaultDelay() :
10577 mScrollCache.scrollBarDefaultDelayBeforeFade;
10578 }
10579
10580 /**
10581 * Define the delay before scrollbars fade.
10582 *
10583 * @param scrollBarDefaultDelayBeforeFade - the delay before scrollbars fade
10584 *
10585 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
10586 */
10587 public void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) {
10588 getScrollCache().scrollBarDefaultDelayBeforeFade = scrollBarDefaultDelayBeforeFade;
10589 }
10590
10591 /**
10592 *
10593 * Returns the scrollbar fade duration.
10594 *
10595 * @return the scrollbar fade duration
10596 *
10597 * @attr ref android.R.styleable#View_scrollbarFadeDuration
10598 */
10599 public int getScrollBarFadeDuration() {
10600 return mScrollCache == null ? ViewConfiguration.getScrollBarFadeDuration() :
10601 mScrollCache.scrollBarFadeDuration;
10602 }
10603
10604 /**
10605 * Define the scrollbar fade duration.
10606 *
10607 * @param scrollBarFadeDuration - the scrollbar fade duration
10608 *
10609 * @attr ref android.R.styleable#View_scrollbarFadeDuration
10610 */
10611 public void setScrollBarFadeDuration(int scrollBarFadeDuration) {
10612 getScrollCache().scrollBarFadeDuration = scrollBarFadeDuration;
10613 }
10614
10615 /**
10616 *
10617 * Returns the scrollbar size.
10618 *
10619 * @return the scrollbar size
10620 *
10621 * @attr ref android.R.styleable#View_scrollbarSize
10622 */
10623 public int getScrollBarSize() {
Romain Guyeb378892012-04-12 11:33:14 -070010624 return mScrollCache == null ? ViewConfiguration.get(mContext).getScaledScrollBarSize() :
Philip Milne6c8ea062012-04-03 17:38:43 -070010625 mScrollCache.scrollBarSize;
10626 }
10627
10628 /**
10629 * Define the scrollbar size.
10630 *
10631 * @param scrollBarSize - the scrollbar size
10632 *
10633 * @attr ref android.R.styleable#View_scrollbarSize
10634 */
10635 public void setScrollBarSize(int scrollBarSize) {
10636 getScrollCache().scrollBarSize = scrollBarSize;
10637 }
10638
10639 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010640 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
10641 * inset. When inset, they add to the padding of the view. And the scrollbars
10642 * can be drawn inside the padding area or on the edge of the view. For example,
10643 * if a view has a background drawable and you want to draw the scrollbars
10644 * inside the padding specified by the drawable, you can use
10645 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
10646 * appear at the edge of the view, ignoring the padding, then you can use
10647 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
10648 * @param style the style of the scrollbars. Should be one of
10649 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
10650 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
10651 * @see #SCROLLBARS_INSIDE_OVERLAY
10652 * @see #SCROLLBARS_INSIDE_INSET
10653 * @see #SCROLLBARS_OUTSIDE_OVERLAY
10654 * @see #SCROLLBARS_OUTSIDE_INSET
Philip Milne6c8ea062012-04-03 17:38:43 -070010655 *
10656 * @attr ref android.R.styleable#View_scrollbarStyle
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010657 */
10658 public void setScrollBarStyle(int style) {
10659 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
10660 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -070010661 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010662 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010663 }
10664 }
10665
10666 /**
10667 * <p>Returns the current scrollbar style.</p>
10668 * @return the current scrollbar style
10669 * @see #SCROLLBARS_INSIDE_OVERLAY
10670 * @see #SCROLLBARS_INSIDE_INSET
10671 * @see #SCROLLBARS_OUTSIDE_OVERLAY
10672 * @see #SCROLLBARS_OUTSIDE_INSET
Philip Milne6c8ea062012-04-03 17:38:43 -070010673 *
10674 * @attr ref android.R.styleable#View_scrollbarStyle
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010675 */
Jeff Sharkey010d7e52011-08-08 21:05:02 -070010676 @ViewDebug.ExportedProperty(mapping = {
10677 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"),
10678 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"),
10679 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"),
10680 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET")
10681 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010682 public int getScrollBarStyle() {
10683 return mViewFlags & SCROLLBARS_STYLE_MASK;
10684 }
10685
10686 /**
10687 * <p>Compute the horizontal range that the horizontal scrollbar
10688 * represents.</p>
10689 *
10690 * <p>The range is expressed in arbitrary units that must be the same as the
10691 * units used by {@link #computeHorizontalScrollExtent()} and
10692 * {@link #computeHorizontalScrollOffset()}.</p>
10693 *
10694 * <p>The default range is the drawing width of this view.</p>
10695 *
10696 * @return the total horizontal range represented by the horizontal
10697 * scrollbar
10698 *
10699 * @see #computeHorizontalScrollExtent()
10700 * @see #computeHorizontalScrollOffset()
10701 * @see android.widget.ScrollBarDrawable
10702 */
10703 protected int computeHorizontalScrollRange() {
10704 return getWidth();
10705 }
10706
10707 /**
10708 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
10709 * within the horizontal range. This value is used to compute the position
10710 * of the thumb within the scrollbar's track.</p>
10711 *
10712 * <p>The range is expressed in arbitrary units that must be the same as the
10713 * units used by {@link #computeHorizontalScrollRange()} and
10714 * {@link #computeHorizontalScrollExtent()}.</p>
10715 *
10716 * <p>The default offset is the scroll offset of this view.</p>
10717 *
10718 * @return the horizontal offset of the scrollbar's thumb
10719 *
10720 * @see #computeHorizontalScrollRange()
10721 * @see #computeHorizontalScrollExtent()
10722 * @see android.widget.ScrollBarDrawable
10723 */
10724 protected int computeHorizontalScrollOffset() {
10725 return mScrollX;
10726 }
10727
10728 /**
10729 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
10730 * within the horizontal range. This value is used to compute the length
10731 * of the thumb within the scrollbar's track.</p>
10732 *
10733 * <p>The range is expressed in arbitrary units that must be the same as the
10734 * units used by {@link #computeHorizontalScrollRange()} and
10735 * {@link #computeHorizontalScrollOffset()}.</p>
10736 *
10737 * <p>The default extent is the drawing width of this view.</p>
10738 *
10739 * @return the horizontal extent of the scrollbar's thumb
10740 *
10741 * @see #computeHorizontalScrollRange()
10742 * @see #computeHorizontalScrollOffset()
10743 * @see android.widget.ScrollBarDrawable
10744 */
10745 protected int computeHorizontalScrollExtent() {
10746 return getWidth();
10747 }
10748
10749 /**
10750 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
10751 *
10752 * <p>The range is expressed in arbitrary units that must be the same as the
10753 * units used by {@link #computeVerticalScrollExtent()} and
10754 * {@link #computeVerticalScrollOffset()}.</p>
10755 *
10756 * @return the total vertical range represented by the vertical scrollbar
10757 *
10758 * <p>The default range is the drawing height of this view.</p>
10759 *
10760 * @see #computeVerticalScrollExtent()
10761 * @see #computeVerticalScrollOffset()
10762 * @see android.widget.ScrollBarDrawable
10763 */
10764 protected int computeVerticalScrollRange() {
10765 return getHeight();
10766 }
10767
10768 /**
10769 * <p>Compute the vertical offset of the vertical scrollbar's thumb
10770 * within the horizontal range. This value is used to compute the position
10771 * of the thumb within the scrollbar's track.</p>
10772 *
10773 * <p>The range is expressed in arbitrary units that must be the same as the
10774 * units used by {@link #computeVerticalScrollRange()} and
10775 * {@link #computeVerticalScrollExtent()}.</p>
10776 *
10777 * <p>The default offset is the scroll offset of this view.</p>
10778 *
10779 * @return the vertical offset of the scrollbar's thumb
10780 *
10781 * @see #computeVerticalScrollRange()
10782 * @see #computeVerticalScrollExtent()
10783 * @see android.widget.ScrollBarDrawable
10784 */
10785 protected int computeVerticalScrollOffset() {
10786 return mScrollY;
10787 }
10788
10789 /**
10790 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
10791 * within the vertical range. This value is used to compute the length
10792 * of the thumb within the scrollbar's track.</p>
10793 *
10794 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -080010795 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010796 * {@link #computeVerticalScrollOffset()}.</p>
10797 *
10798 * <p>The default extent is the drawing height of this view.</p>
10799 *
10800 * @return the vertical extent of the scrollbar's thumb
10801 *
10802 * @see #computeVerticalScrollRange()
10803 * @see #computeVerticalScrollOffset()
10804 * @see android.widget.ScrollBarDrawable
10805 */
10806 protected int computeVerticalScrollExtent() {
10807 return getHeight();
10808 }
10809
10810 /**
Adam Powell69159442011-06-13 17:53:06 -070010811 * Check if this view can be scrolled horizontally in a certain direction.
10812 *
10813 * @param direction Negative to check scrolling left, positive to check scrolling right.
10814 * @return true if this view can be scrolled in the specified direction, false otherwise.
10815 */
10816 public boolean canScrollHorizontally(int direction) {
10817 final int offset = computeHorizontalScrollOffset();
10818 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent();
10819 if (range == 0) return false;
10820 if (direction < 0) {
10821 return offset > 0;
10822 } else {
10823 return offset < range - 1;
10824 }
10825 }
10826
10827 /**
10828 * Check if this view can be scrolled vertically in a certain direction.
10829 *
10830 * @param direction Negative to check scrolling up, positive to check scrolling down.
10831 * @return true if this view can be scrolled in the specified direction, false otherwise.
10832 */
10833 public boolean canScrollVertically(int direction) {
10834 final int offset = computeVerticalScrollOffset();
10835 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent();
10836 if (range == 0) return false;
10837 if (direction < 0) {
10838 return offset > 0;
10839 } else {
10840 return offset < range - 1;
10841 }
10842 }
10843
10844 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010845 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
10846 * scrollbars are painted only if they have been awakened first.</p>
10847 *
10848 * @param canvas the canvas on which to draw the scrollbars
Joe Malin32736f02011-01-19 16:14:20 -080010849 *
Mike Cleronf116bf82009-09-27 19:14:12 -070010850 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010851 */
Romain Guy1d5b3a62009-11-05 18:44:12 -080010852 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010853 // scrollbars are drawn only when the animation is running
10854 final ScrollabilityCache cache = mScrollCache;
10855 if (cache != null) {
Joe Malin32736f02011-01-19 16:14:20 -080010856
Mike Cleronf116bf82009-09-27 19:14:12 -070010857 int state = cache.state;
Joe Malin32736f02011-01-19 16:14:20 -080010858
Mike Cleronf116bf82009-09-27 19:14:12 -070010859 if (state == ScrollabilityCache.OFF) {
10860 return;
10861 }
Joe Malin32736f02011-01-19 16:14:20 -080010862
Mike Cleronf116bf82009-09-27 19:14:12 -070010863 boolean invalidate = false;
Joe Malin32736f02011-01-19 16:14:20 -080010864
Mike Cleronf116bf82009-09-27 19:14:12 -070010865 if (state == ScrollabilityCache.FADING) {
10866 // We're fading -- get our fade interpolation
10867 if (cache.interpolatorValues == null) {
10868 cache.interpolatorValues = new float[1];
10869 }
Joe Malin32736f02011-01-19 16:14:20 -080010870
Mike Cleronf116bf82009-09-27 19:14:12 -070010871 float[] values = cache.interpolatorValues;
Joe Malin32736f02011-01-19 16:14:20 -080010872
Mike Cleronf116bf82009-09-27 19:14:12 -070010873 // Stops the animation if we're done
10874 if (cache.scrollBarInterpolator.timeToValues(values) ==
10875 Interpolator.Result.FREEZE_END) {
10876 cache.state = ScrollabilityCache.OFF;
10877 } else {
10878 cache.scrollBar.setAlpha(Math.round(values[0]));
10879 }
Joe Malin32736f02011-01-19 16:14:20 -080010880
10881 // This will make the scroll bars inval themselves after
Mike Cleronf116bf82009-09-27 19:14:12 -070010882 // drawing. We only want this when we're fading so that
10883 // we prevent excessive redraws
10884 invalidate = true;
10885 } else {
10886 // We're just on -- but we may have been fading before so
10887 // reset alpha
10888 cache.scrollBar.setAlpha(255);
10889 }
10890
Joe Malin32736f02011-01-19 16:14:20 -080010891
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010892 final int viewFlags = mViewFlags;
10893
10894 final boolean drawHorizontalScrollBar =
10895 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
10896 final boolean drawVerticalScrollBar =
10897 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
10898 && !isVerticalScrollBarHidden();
10899
10900 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
10901 final int width = mRight - mLeft;
10902 final int height = mBottom - mTop;
10903
10904 final ScrollBarDrawable scrollBar = cache.scrollBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010905
Mike Reede8853fc2009-09-04 14:01:48 -040010906 final int scrollX = mScrollX;
10907 final int scrollY = mScrollY;
10908 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
10909
Mike Cleronf116bf82009-09-27 19:14:12 -070010910 int left, top, right, bottom;
Joe Malin32736f02011-01-19 16:14:20 -080010911
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010912 if (drawHorizontalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -080010913 int size = scrollBar.getSize(false);
10914 if (size <= 0) {
10915 size = cache.scrollBarSize;
10916 }
10917
Mike Cleronf116bf82009-09-27 19:14:12 -070010918 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -040010919 computeHorizontalScrollOffset(),
10920 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -040010921 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -070010922 getVerticalScrollbarWidth() : 0;
Joe Malin32736f02011-01-19 16:14:20 -080010923 top = scrollY + height - size - (mUserPaddingBottom & inside);
Mike Cleronf116bf82009-09-27 19:14:12 -070010924 left = scrollX + (mPaddingLeft & inside);
10925 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
10926 bottom = top + size;
10927 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
10928 if (invalidate) {
10929 invalidate(left, top, right, bottom);
10930 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010931 }
10932
10933 if (drawVerticalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -080010934 int size = scrollBar.getSize(true);
10935 if (size <= 0) {
10936 size = cache.scrollBarSize;
10937 }
10938
Mike Reede8853fc2009-09-04 14:01:48 -040010939 scrollBar.setParameters(computeVerticalScrollRange(),
10940 computeVerticalScrollOffset(),
10941 computeVerticalScrollExtent(), true);
Adam Powell20232d02010-12-08 21:08:53 -080010942 switch (mVerticalScrollbarPosition) {
10943 default:
10944 case SCROLLBAR_POSITION_DEFAULT:
10945 case SCROLLBAR_POSITION_RIGHT:
10946 left = scrollX + width - size - (mUserPaddingRight & inside);
10947 break;
10948 case SCROLLBAR_POSITION_LEFT:
10949 left = scrollX + (mUserPaddingLeft & inside);
10950 break;
10951 }
Mike Cleronf116bf82009-09-27 19:14:12 -070010952 top = scrollY + (mPaddingTop & inside);
10953 right = left + size;
10954 bottom = scrollY + height - (mUserPaddingBottom & inside);
10955 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
10956 if (invalidate) {
10957 invalidate(left, top, right, bottom);
10958 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010959 }
10960 }
10961 }
10962 }
Romain Guy8506ab42009-06-11 17:35:47 -070010963
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010964 /**
Romain Guy8506ab42009-06-11 17:35:47 -070010965 * 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 -080010966 * FastScroller is visible.
10967 * @return whether to temporarily hide the vertical scrollbar
10968 * @hide
10969 */
10970 protected boolean isVerticalScrollBarHidden() {
10971 return false;
10972 }
10973
10974 /**
10975 * <p>Draw the horizontal scrollbar if
10976 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
10977 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010978 * @param canvas the canvas on which to draw the scrollbar
10979 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010980 *
10981 * @see #isHorizontalScrollBarEnabled()
10982 * @see #computeHorizontalScrollRange()
10983 * @see #computeHorizontalScrollExtent()
10984 * @see #computeHorizontalScrollOffset()
10985 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -070010986 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -040010987 */
Romain Guy8fb95422010-08-17 18:38:51 -070010988 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
10989 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -040010990 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -040010991 scrollBar.draw(canvas);
10992 }
Mike Reede8853fc2009-09-04 14:01:48 -040010993
Mike Reed4d6fe5f2009-09-03 13:29:05 -040010994 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010995 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
10996 * returns true.</p>
10997 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010998 * @param canvas the canvas on which to draw the scrollbar
10999 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011000 *
11001 * @see #isVerticalScrollBarEnabled()
11002 * @see #computeVerticalScrollRange()
11003 * @see #computeVerticalScrollExtent()
11004 * @see #computeVerticalScrollOffset()
11005 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -040011006 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011007 */
Romain Guy8fb95422010-08-17 18:38:51 -070011008 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
11009 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -040011010 scrollBar.setBounds(l, t, r, b);
11011 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011012 }
11013
11014 /**
11015 * Implement this to do your drawing.
11016 *
11017 * @param canvas the canvas on which the background will be drawn
11018 */
11019 protected void onDraw(Canvas canvas) {
11020 }
11021
11022 /*
11023 * Caller is responsible for calling requestLayout if necessary.
11024 * (This allows addViewInLayout to not request a new layout.)
11025 */
11026 void assignParent(ViewParent parent) {
11027 if (mParent == null) {
11028 mParent = parent;
11029 } else if (parent == null) {
11030 mParent = null;
11031 } else {
11032 throw new RuntimeException("view " + this + " being added, but"
11033 + " it already has a parent");
11034 }
11035 }
11036
11037 /**
11038 * This is called when the view is attached to a window. At this point it
11039 * has a Surface and will start drawing. Note that this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070011040 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)},
11041 * however it may be called any time before the first onDraw -- including
11042 * before or after {@link #onMeasure(int, int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011043 *
11044 * @see #onDetachedFromWindow()
11045 */
11046 protected void onAttachedToWindow() {
11047 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
11048 mParent.requestTransparentRegion(this);
11049 }
Adam Powell8568c3a2010-04-19 14:26:11 -070011050 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
11051 initialAwakenScrollBars();
11052 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
11053 }
Chet Haasea9b61ac2010-12-20 07:40:25 -080011054 jumpDrawablesToCurrentState();
Fabrice Di Meglioa6461452011-08-19 15:42:04 -070011055 // Order is important here: LayoutDirection MUST be resolved before Padding
11056 // and TextDirection
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011057 resolveLayoutDirection();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011058 resolvePadding();
Fabrice Di Meglio22268862011-06-27 18:13:18 -070011059 resolveTextDirection();
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070011060 resolveTextAlignment();
Svetoslav Ganov42138042012-03-20 11:51:39 -070011061 clearAccessibilityFocus();
Amith Yamasani4503c8d2011-06-17 12:36:14 -070011062 if (isFocused()) {
11063 InputMethodManager imm = InputMethodManager.peekInstance();
11064 imm.focusIn(this);
11065 }
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011066 }
Cibu Johny86666632010-02-22 13:01:02 -080011067
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011068 /**
Romain Guybb9908b2012-03-08 11:14:07 -080011069 * @see #onScreenStateChanged(int)
11070 */
11071 void dispatchScreenStateChanged(int screenState) {
11072 onScreenStateChanged(screenState);
11073 }
11074
11075 /**
11076 * This method is called whenever the state of the screen this view is
11077 * attached to changes. A state change will usually occurs when the screen
11078 * turns on or off (whether it happens automatically or the user does it
11079 * manually.)
11080 *
11081 * @param screenState The new state of the screen. Can be either
11082 * {@link #SCREEN_STATE_ON} or {@link #SCREEN_STATE_OFF}
11083 */
11084 public void onScreenStateChanged(int screenState) {
11085 }
11086
11087 /**
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011088 * Return true if the application tag in the AndroidManifest has set "supportRtl" to true
11089 */
11090 private boolean hasRtlSupport() {
11091 return mContext.getApplicationInfo().hasRtlSupport();
11092 }
11093
11094 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011095 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing
11096 * that the parent directionality can and will be resolved before its children.
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011097 * Will call {@link View#onResolvedLayoutDirectionChanged} when resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011098 * @hide
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011099 */
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011100 public void resolveLayoutDirection() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011101 // Clear any previous layout direction resolution
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -070011102 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_MASK;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011103
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011104 if (hasRtlSupport()) {
11105 // Set resolved depending on layout direction
11106 switch (getLayoutDirection()) {
11107 case LAYOUT_DIRECTION_INHERIT:
11108 // If this is root view, no need to look at parent's layout dir.
11109 if (canResolveLayoutDirection()) {
11110 ViewGroup viewGroup = ((ViewGroup) mParent);
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011111
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011112 if (viewGroup.getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
11113 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11114 }
11115 } else {
11116 // Nothing to do, LTR by default
11117 }
11118 break;
11119 case LAYOUT_DIRECTION_RTL:
11120 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11121 break;
11122 case LAYOUT_DIRECTION_LOCALE:
11123 if(isLayoutDirectionRtl(Locale.getDefault())) {
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011124 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11125 }
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011126 break;
11127 default:
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011128 // Nothing to do, LTR by default
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011129 }
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011130 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011131
11132 // Set to resolved
11133 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011134 onResolvedLayoutDirectionChanged();
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080011135 // Resolve padding
11136 resolvePadding();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011137 }
11138
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -070011139 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011140 * Called when layout direction has been resolved.
11141 *
11142 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011143 * @hide
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011144 */
11145 public void onResolvedLayoutDirectionChanged() {
11146 }
11147
11148 /**
11149 * Resolve padding depending on layout direction.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011150 * @hide
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -070011151 */
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011152 public void resolvePadding() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011153 // If the user specified the absolute padding (either with android:padding or
11154 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
11155 // use the default padding or the padding from the background drawable
11156 // (stored at this point in mPadding*)
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011157 int resolvedLayoutDirection = getResolvedLayoutDirection();
11158 switch (resolvedLayoutDirection) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011159 case LAYOUT_DIRECTION_RTL:
11160 // Start user padding override Right user padding. Otherwise, if Right user
11161 // padding is not defined, use the default Right padding. If Right user padding
11162 // is defined, just use it.
11163 if (mUserPaddingStart >= 0) {
11164 mUserPaddingRight = mUserPaddingStart;
11165 } else if (mUserPaddingRight < 0) {
11166 mUserPaddingRight = mPaddingRight;
11167 }
11168 if (mUserPaddingEnd >= 0) {
11169 mUserPaddingLeft = mUserPaddingEnd;
11170 } else if (mUserPaddingLeft < 0) {
11171 mUserPaddingLeft = mPaddingLeft;
11172 }
11173 break;
11174 case LAYOUT_DIRECTION_LTR:
11175 default:
11176 // Start user padding override Left user padding. Otherwise, if Left user
11177 // padding is not defined, use the default left padding. If Left user padding
11178 // is defined, just use it.
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -070011179 if (mUserPaddingStart >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011180 mUserPaddingLeft = mUserPaddingStart;
11181 } else if (mUserPaddingLeft < 0) {
11182 mUserPaddingLeft = mPaddingLeft;
11183 }
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -070011184 if (mUserPaddingEnd >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011185 mUserPaddingRight = mUserPaddingEnd;
11186 } else if (mUserPaddingRight < 0) {
11187 mUserPaddingRight = mPaddingRight;
11188 }
11189 }
11190
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011191 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom;
11192
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080011193 if(isPaddingRelative()) {
11194 setPaddingRelative(mUserPaddingStart, mPaddingTop, mUserPaddingEnd, mUserPaddingBottom);
11195 } else {
11196 recomputePadding();
11197 }
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011198 onPaddingChanged(resolvedLayoutDirection);
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011199 }
11200
11201 /**
11202 * Resolve padding depending on the layout direction. Subclasses that care about
11203 * padding resolution should override this method. The default implementation does
11204 * nothing.
11205 *
11206 * @param layoutDirection the direction of the layout
11207 *
Fabrice Di Meglioe8dc07d2012-03-09 17:10:19 -080011208 * @see {@link #LAYOUT_DIRECTION_LTR}
11209 * @see {@link #LAYOUT_DIRECTION_RTL}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011210 * @hide
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011211 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011212 public void onPaddingChanged(int layoutDirection) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011213 }
11214
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011215 /**
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011216 * Check if layout direction resolution can be done.
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011217 *
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011218 * @return true if layout direction resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011219 * @hide
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011220 */
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011221 public boolean canResolveLayoutDirection() {
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011222 switch (getLayoutDirection()) {
11223 case LAYOUT_DIRECTION_INHERIT:
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011224 return (mParent != null) && (mParent instanceof ViewGroup);
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011225 default:
11226 return true;
11227 }
11228 }
11229
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011230 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011231 * Reset the resolved layout direction. Will call {@link View#onResolvedLayoutDirectionReset}
11232 * when reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011233 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011234 */
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011235 public void resetResolvedLayoutDirection() {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -070011236 // Reset the current resolved bits
11237 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_MASK;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011238 onResolvedLayoutDirectionReset();
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080011239 // Reset also the text direction
11240 resetResolvedTextDirection();
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011241 }
11242
11243 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011244 * Called during reset of resolved layout direction.
11245 *
11246 * Subclasses need to override this method to clear cached information that depends on the
11247 * resolved layout direction, or to inform child views that inherit their layout direction.
11248 *
11249 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011250 * @hide
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011251 */
11252 public void onResolvedLayoutDirectionReset() {
11253 }
11254
11255 /**
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011256 * Check if a Locale uses an RTL script.
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011257 *
11258 * @param locale Locale to check
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011259 * @return true if the Locale uses an RTL script.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011260 * @hide
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011261 */
Fabrice Di Meglio22268862011-06-27 18:13:18 -070011262 protected static boolean isLayoutDirectionRtl(Locale locale) {
Fabrice Di Meglio3fb824b2012-02-28 17:58:31 -080011263 return (LAYOUT_DIRECTION_RTL == LocaleUtil.getLayoutDirectionFromLocale(locale));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011264 }
11265
11266 /**
11267 * This is called when the view is detached from a window. At this point it
11268 * no longer has a surface for drawing.
11269 *
11270 * @see #onAttachedToWindow()
11271 */
11272 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -080011273 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -080011274
Romain Guya440b002010-02-24 15:57:54 -080011275 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -050011276 removeLongPressCallback();
Adam Powell3cb8b632011-01-21 15:34:14 -080011277 removePerformClickCallback();
Svetoslav Ganova0156172011-06-26 17:55:44 -070011278 removeSendViewScrolledAccessibilityEventCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -080011279
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011280 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -080011281
Romain Guya998dff2012-03-23 18:58:36 -070011282 destroyLayer(false);
Romain Guy8dd5b1e2011-01-14 17:28:51 -080011283
11284 if (mAttachInfo != null) {
Romain Guy51e4d4d2012-03-15 18:30:47 -070011285 if (mDisplayList != null) {
11286 mAttachInfo.mViewRootImpl.invalidateDisplayList(mDisplayList);
11287 }
Jeff Browna175a5b2012-02-15 19:18:31 -080011288 mAttachInfo.mViewRootImpl.cancelInvalidate(this);
Romain Guy51e4d4d2012-03-15 18:30:47 -070011289 } else {
11290 if (mDisplayList != null) {
11291 // Should never happen
11292 mDisplayList.invalidate();
11293 }
Romain Guy8dd5b1e2011-01-14 17:28:51 -080011294 }
11295
Patrick Dubroyec84c3a2011-01-13 17:55:37 -080011296 mCurrentAnimation = null;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -070011297
11298 resetResolvedLayoutDirection();
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070011299 resetResolvedTextAlignment();
Svetoslav Ganov42138042012-03-20 11:51:39 -070011300 resetAccessibilityStateChanged();
11301 clearAccessibilityFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011302 }
11303
11304 /**
11305 * @return The number of times this view has been attached to a window
11306 */
11307 protected int getWindowAttachCount() {
11308 return mWindowAttachCount;
11309 }
11310
11311 /**
11312 * Retrieve a unique token identifying the window this view is attached to.
11313 * @return Return the window's token for use in
11314 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
11315 */
11316 public IBinder getWindowToken() {
11317 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
11318 }
11319
11320 /**
11321 * Retrieve a unique token identifying the top-level "real" window of
11322 * the window that this view is attached to. That is, this is like
11323 * {@link #getWindowToken}, except if the window this view in is a panel
11324 * window (attached to another containing window), then the token of
11325 * the containing window is returned instead.
11326 *
11327 * @return Returns the associated window token, either
11328 * {@link #getWindowToken()} or the containing window's token.
11329 */
11330 public IBinder getApplicationWindowToken() {
11331 AttachInfo ai = mAttachInfo;
11332 if (ai != null) {
11333 IBinder appWindowToken = ai.mPanelParentWindowToken;
11334 if (appWindowToken == null) {
11335 appWindowToken = ai.mWindowToken;
11336 }
11337 return appWindowToken;
11338 }
11339 return null;
11340 }
11341
11342 /**
11343 * Retrieve private session object this view hierarchy is using to
11344 * communicate with the window manager.
11345 * @return the session object to communicate with the window manager
11346 */
11347 /*package*/ IWindowSession getWindowSession() {
11348 return mAttachInfo != null ? mAttachInfo.mSession : null;
11349 }
11350
11351 /**
11352 * @param info the {@link android.view.View.AttachInfo} to associated with
11353 * this view
11354 */
11355 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
11356 //System.out.println("Attached! " + this);
11357 mAttachInfo = info;
11358 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011359 // We will need to evaluate the drawable state at least once.
11360 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011361 if (mFloatingTreeObserver != null) {
11362 info.mTreeObserver.merge(mFloatingTreeObserver);
11363 mFloatingTreeObserver = null;
11364 }
11365 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
11366 mAttachInfo.mScrollContainers.add(this);
11367 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
11368 }
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -070011369 performCollectViewAttributes(mAttachInfo, visibility);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011370 onAttachedToWindow();
Adam Powell4afd62b2011-02-18 15:02:18 -080011371
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011372 ListenerInfo li = mListenerInfo;
Adam Powell4afd62b2011-02-18 15:02:18 -080011373 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011374 li != null ? li.mOnAttachStateChangeListeners : null;
Adam Powell4afd62b2011-02-18 15:02:18 -080011375 if (listeners != null && listeners.size() > 0) {
11376 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
11377 // perform the dispatching. The iterator is a safe guard against listeners that
11378 // could mutate the list by calling the various add/remove methods. This prevents
11379 // the array from being modified while we iterate it.
11380 for (OnAttachStateChangeListener listener : listeners) {
11381 listener.onViewAttachedToWindow(this);
11382 }
11383 }
11384
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011385 int vis = info.mWindowVisibility;
11386 if (vis != GONE) {
11387 onWindowVisibilityChanged(vis);
11388 }
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011389 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) {
11390 // If nobody has evaluated the drawable state yet, then do it now.
11391 refreshDrawableState();
11392 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011393 }
11394
11395 void dispatchDetachedFromWindow() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011396 AttachInfo info = mAttachInfo;
11397 if (info != null) {
11398 int vis = info.mWindowVisibility;
11399 if (vis != GONE) {
11400 onWindowVisibilityChanged(GONE);
11401 }
11402 }
11403
11404 onDetachedFromWindow();
Romain Guy01d5edc2011-01-28 11:28:53 -080011405
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011406 ListenerInfo li = mListenerInfo;
Adam Powell4afd62b2011-02-18 15:02:18 -080011407 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011408 li != null ? li.mOnAttachStateChangeListeners : null;
Adam Powell4afd62b2011-02-18 15:02:18 -080011409 if (listeners != null && listeners.size() > 0) {
11410 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
11411 // perform the dispatching. The iterator is a safe guard against listeners that
11412 // could mutate the list by calling the various add/remove methods. This prevents
11413 // the array from being modified while we iterate it.
11414 for (OnAttachStateChangeListener listener : listeners) {
11415 listener.onViewDetachedFromWindow(this);
11416 }
11417 }
11418
Romain Guy01d5edc2011-01-28 11:28:53 -080011419 if ((mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011420 mAttachInfo.mScrollContainers.remove(this);
11421 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
11422 }
Romain Guy01d5edc2011-01-28 11:28:53 -080011423
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011424 mAttachInfo = null;
11425 }
11426
11427 /**
11428 * Store this view hierarchy's frozen state into the given container.
11429 *
11430 * @param container The SparseArray in which to save the view's state.
11431 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011432 * @see #restoreHierarchyState(android.util.SparseArray)
11433 * @see #dispatchSaveInstanceState(android.util.SparseArray)
11434 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011435 */
11436 public void saveHierarchyState(SparseArray<Parcelable> container) {
11437 dispatchSaveInstanceState(container);
11438 }
11439
11440 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -070011441 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for
11442 * this view and its children. May be overridden to modify how freezing happens to a
11443 * 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 -080011444 *
11445 * @param container The SparseArray in which to save the view's state.
11446 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011447 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
11448 * @see #saveHierarchyState(android.util.SparseArray)
11449 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011450 */
11451 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
11452 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
11453 mPrivateFlags &= ~SAVE_STATE_CALLED;
11454 Parcelable state = onSaveInstanceState();
11455 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
11456 throw new IllegalStateException(
11457 "Derived class did not call super.onSaveInstanceState()");
11458 }
11459 if (state != null) {
11460 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
11461 // + ": " + state);
11462 container.put(mID, state);
11463 }
11464 }
11465 }
11466
11467 /**
11468 * Hook allowing a view to generate a representation of its internal state
11469 * that can later be used to create a new instance with that same state.
11470 * This state should only contain information that is not persistent or can
11471 * not be reconstructed later. For example, you will never store your
11472 * current position on screen because that will be computed again when a
11473 * new instance of the view is placed in its view hierarchy.
11474 * <p>
11475 * Some examples of things you may store here: the current cursor position
11476 * in a text view (but usually not the text itself since that is stored in a
11477 * content provider or other persistent storage), the currently selected
11478 * item in a list view.
11479 *
11480 * @return Returns a Parcelable object containing the view's current dynamic
11481 * state, or null if there is nothing interesting to save. The
11482 * default implementation returns null.
Philip Milne6c8ea062012-04-03 17:38:43 -070011483 * @see #onRestoreInstanceState(android.os.Parcelable)
11484 * @see #saveHierarchyState(android.util.SparseArray)
11485 * @see #dispatchSaveInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011486 * @see #setSaveEnabled(boolean)
11487 */
11488 protected Parcelable onSaveInstanceState() {
11489 mPrivateFlags |= SAVE_STATE_CALLED;
11490 return BaseSavedState.EMPTY_STATE;
11491 }
11492
11493 /**
11494 * Restore this view hierarchy's frozen state from the given container.
11495 *
11496 * @param container The SparseArray which holds previously frozen states.
11497 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011498 * @see #saveHierarchyState(android.util.SparseArray)
11499 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
11500 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011501 */
11502 public void restoreHierarchyState(SparseArray<Parcelable> container) {
11503 dispatchRestoreInstanceState(container);
11504 }
11505
11506 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -070011507 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the
11508 * state for this view and its children. May be overridden to modify how restoring
11509 * happens to a view's children; for example, some views may want to not store state
11510 * for their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011511 *
11512 * @param container The SparseArray which holds previously saved state.
11513 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011514 * @see #dispatchSaveInstanceState(android.util.SparseArray)
11515 * @see #restoreHierarchyState(android.util.SparseArray)
11516 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011517 */
11518 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
11519 if (mID != NO_ID) {
11520 Parcelable state = container.get(mID);
11521 if (state != null) {
11522 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
11523 // + ": " + state);
11524 mPrivateFlags &= ~SAVE_STATE_CALLED;
11525 onRestoreInstanceState(state);
11526 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
11527 throw new IllegalStateException(
11528 "Derived class did not call super.onRestoreInstanceState()");
11529 }
11530 }
11531 }
11532 }
11533
11534 /**
11535 * Hook allowing a view to re-apply a representation of its internal state that had previously
11536 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
11537 * null state.
11538 *
11539 * @param state The frozen state that had previously been returned by
11540 * {@link #onSaveInstanceState}.
11541 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011542 * @see #onSaveInstanceState()
11543 * @see #restoreHierarchyState(android.util.SparseArray)
11544 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011545 */
11546 protected void onRestoreInstanceState(Parcelable state) {
11547 mPrivateFlags |= SAVE_STATE_CALLED;
11548 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -080011549 throw new IllegalArgumentException("Wrong state class, expecting View State but "
11550 + "received " + state.getClass().toString() + " instead. This usually happens "
Joe Malin32736f02011-01-19 16:14:20 -080011551 + "when two views of different type have the same id in the same hierarchy. "
11552 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
Romain Guy237c1ce2009-12-08 11:30:25 -080011553 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011554 }
11555 }
11556
11557 /**
11558 * <p>Return the time at which the drawing of the view hierarchy started.</p>
11559 *
11560 * @return the drawing start time in milliseconds
11561 */
11562 public long getDrawingTime() {
11563 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
11564 }
11565
11566 /**
11567 * <p>Enables or disables the duplication of the parent's state into this view. When
11568 * duplication is enabled, this view gets its drawable state from its parent rather
11569 * than from its own internal properties.</p>
11570 *
11571 * <p>Note: in the current implementation, setting this property to true after the
11572 * view was added to a ViewGroup might have no effect at all. This property should
11573 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
11574 *
11575 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
11576 * property is enabled, an exception will be thrown.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011577 *
Gilles Debunnefb817032011-01-13 13:52:49 -080011578 * <p>Note: if the child view uses and updates additionnal states which are unknown to the
11579 * parent, these states should not be affected by this method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011580 *
11581 * @param enabled True to enable duplication of the parent's drawable state, false
11582 * to disable it.
11583 *
11584 * @see #getDrawableState()
11585 * @see #isDuplicateParentStateEnabled()
11586 */
11587 public void setDuplicateParentStateEnabled(boolean enabled) {
11588 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
11589 }
11590
11591 /**
11592 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
11593 *
11594 * @return True if this view's drawable state is duplicated from the parent,
11595 * false otherwise
11596 *
11597 * @see #getDrawableState()
11598 * @see #setDuplicateParentStateEnabled(boolean)
11599 */
11600 public boolean isDuplicateParentStateEnabled() {
11601 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
11602 }
11603
11604 /**
Romain Guy171c5922011-01-06 10:04:23 -080011605 * <p>Specifies the type of layer backing this view. The layer can be
11606 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
11607 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011608 *
Romain Guy171c5922011-01-06 10:04:23 -080011609 * <p>A layer is associated with an optional {@link android.graphics.Paint}
11610 * instance that controls how the layer is composed on screen. The following
11611 * properties of the paint are taken into account when composing the layer:</p>
11612 * <ul>
11613 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
11614 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
11615 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
11616 * </ul>
Joe Malin32736f02011-01-19 16:14:20 -080011617 *
Romain Guy171c5922011-01-06 10:04:23 -080011618 * <p>If this view has an alpha value set to < 1.0 by calling
11619 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
11620 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
11621 * equivalent to setting a hardware layer on this view and providing a paint with
11622 * the desired alpha value.<p>
Joe Malin32736f02011-01-19 16:14:20 -080011623 *
Romain Guy171c5922011-01-06 10:04:23 -080011624 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
11625 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
11626 * for more information on when and how to use layers.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011627 *
Romain Guy171c5922011-01-06 10:04:23 -080011628 * @param layerType The ype of layer to use with this view, must be one of
11629 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
11630 * {@link #LAYER_TYPE_HARDWARE}
11631 * @param paint The paint used to compose the layer. This argument is optional
11632 * and can be null. It is ignored when the layer type is
11633 * {@link #LAYER_TYPE_NONE}
Joe Malin32736f02011-01-19 16:14:20 -080011634 *
11635 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -080011636 * @see #LAYER_TYPE_NONE
11637 * @see #LAYER_TYPE_SOFTWARE
11638 * @see #LAYER_TYPE_HARDWARE
Joe Malin32736f02011-01-19 16:14:20 -080011639 * @see #setAlpha(float)
11640 *
Romain Guy171c5922011-01-06 10:04:23 -080011641 * @attr ref android.R.styleable#View_layerType
11642 */
11643 public void setLayerType(int layerType, Paint paint) {
11644 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
Joe Malin32736f02011-01-19 16:14:20 -080011645 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
Romain Guy171c5922011-01-06 10:04:23 -080011646 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
11647 }
Chet Haasedaf98e92011-01-10 14:10:36 -080011648
Romain Guyd6cd5722011-01-17 14:42:41 -080011649 if (layerType == mLayerType) {
11650 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) {
11651 mLayerPaint = paint == null ? new Paint() : paint;
Romain Guy0fd89bf2011-01-26 15:41:30 -080011652 invalidateParentCaches();
11653 invalidate(true);
Romain Guyd6cd5722011-01-17 14:42:41 -080011654 }
11655 return;
11656 }
Romain Guy171c5922011-01-06 10:04:23 -080011657
11658 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -080011659 switch (mLayerType) {
Chet Haase6f33e812011-05-17 12:42:19 -070011660 case LAYER_TYPE_HARDWARE:
Romain Guya998dff2012-03-23 18:58:36 -070011661 destroyLayer(false);
Romain Guy31f2c2e2011-11-21 10:55:41 -080011662 // fall through - non-accelerated views may use software layer mechanism instead
Romain Guy6c319ca2011-01-11 14:29:25 -080011663 case LAYER_TYPE_SOFTWARE:
Romain Guy6d7475d2011-07-27 16:28:21 -070011664 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -080011665 break;
Romain Guy6c319ca2011-01-11 14:29:25 -080011666 default:
11667 break;
Romain Guy171c5922011-01-06 10:04:23 -080011668 }
11669
11670 mLayerType = layerType;
Romain Guy3a3133d2011-02-01 22:59:58 -080011671 final boolean layerDisabled = mLayerType == LAYER_TYPE_NONE;
11672 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint);
11673 mLocalDirtyRect = layerDisabled ? null : new Rect();
Romain Guy171c5922011-01-06 10:04:23 -080011674
Romain Guy0fd89bf2011-01-26 15:41:30 -080011675 invalidateParentCaches();
11676 invalidate(true);
Romain Guy171c5922011-01-06 10:04:23 -080011677 }
11678
11679 /**
Romain Guy59c7f802011-09-29 17:21:45 -070011680 * Indicates whether this view has a static layer. A view with layer type
11681 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are
11682 * dynamic.
11683 */
11684 boolean hasStaticLayer() {
Romain Guy2bf68f02012-03-02 13:37:47 -080011685 return true;
Romain Guy59c7f802011-09-29 17:21:45 -070011686 }
11687
11688 /**
Romain Guy171c5922011-01-06 10:04:23 -080011689 * Indicates what type of layer is currently associated with this view. By default
11690 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
11691 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
11692 * for more information on the different types of layers.
Joe Malin32736f02011-01-19 16:14:20 -080011693 *
Romain Guy171c5922011-01-06 10:04:23 -080011694 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
11695 * {@link #LAYER_TYPE_HARDWARE}
Joe Malin32736f02011-01-19 16:14:20 -080011696 *
11697 * @see #setLayerType(int, android.graphics.Paint)
Philip Milne6c8ea062012-04-03 17:38:43 -070011698 * @see #buildLayer()
Romain Guy171c5922011-01-06 10:04:23 -080011699 * @see #LAYER_TYPE_NONE
11700 * @see #LAYER_TYPE_SOFTWARE
11701 * @see #LAYER_TYPE_HARDWARE
11702 */
11703 public int getLayerType() {
11704 return mLayerType;
11705 }
Joe Malin32736f02011-01-19 16:14:20 -080011706
Romain Guy6c319ca2011-01-11 14:29:25 -080011707 /**
Romain Guyf1ae1062011-03-02 18:16:04 -080011708 * Forces this view's layer to be created and this view to be rendered
11709 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE},
11710 * invoking this method will have no effect.
Philip Milne6c8ea062012-04-03 17:38:43 -070011711 *
Romain Guyf1ae1062011-03-02 18:16:04 -080011712 * This method can for instance be used to render a view into its layer before
11713 * starting an animation. If this view is complex, rendering into the layer
11714 * before starting the animation will avoid skipping frames.
Philip Milne6c8ea062012-04-03 17:38:43 -070011715 *
Romain Guyf1ae1062011-03-02 18:16:04 -080011716 * @throws IllegalStateException If this view is not attached to a window
Philip Milne6c8ea062012-04-03 17:38:43 -070011717 *
11718 * @see #setLayerType(int, android.graphics.Paint)
Romain Guyf1ae1062011-03-02 18:16:04 -080011719 */
11720 public void buildLayer() {
11721 if (mLayerType == LAYER_TYPE_NONE) return;
11722
11723 if (mAttachInfo == null) {
11724 throw new IllegalStateException("This view must be attached to a window first");
11725 }
11726
11727 switch (mLayerType) {
11728 case LAYER_TYPE_HARDWARE:
Romain Guyd0609e42011-11-21 17:21:15 -080011729 if (mAttachInfo.mHardwareRenderer != null &&
11730 mAttachInfo.mHardwareRenderer.isEnabled() &&
11731 mAttachInfo.mHardwareRenderer.validate()) {
Michael Jurka7e52caf2012-03-06 15:57:06 -080011732 getHardwareLayer();
Romain Guyd0609e42011-11-21 17:21:15 -080011733 }
Romain Guyf1ae1062011-03-02 18:16:04 -080011734 break;
11735 case LAYER_TYPE_SOFTWARE:
11736 buildDrawingCache(true);
11737 break;
11738 }
11739 }
Philip Milne6c8ea062012-04-03 17:38:43 -070011740
Romain Guy9c4b79a2011-11-10 19:23:58 -080011741 // Make sure the HardwareRenderer.validate() was invoked before calling this method
11742 void flushLayer() {
11743 if (mLayerType == LAYER_TYPE_HARDWARE && mHardwareLayer != null) {
11744 mHardwareLayer.flush();
11745 }
11746 }
Romain Guyf1ae1062011-03-02 18:16:04 -080011747
11748 /**
Romain Guy6c319ca2011-01-11 14:29:25 -080011749 * <p>Returns a hardware layer that can be used to draw this view again
11750 * without executing its draw method.</p>
11751 *
11752 * @return A HardwareLayer ready to render, or null if an error occurred.
11753 */
Michael Jurka7e52caf2012-03-06 15:57:06 -080011754 HardwareLayer getHardwareLayer() {
Romain Guyea835032011-07-28 19:24:37 -070011755 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null ||
11756 !mAttachInfo.mHardwareRenderer.isEnabled()) {
Romain Guy6c319ca2011-01-11 14:29:25 -080011757 return null;
11758 }
Philip Milne6c8ea062012-04-03 17:38:43 -070011759
Romain Guy9c4b79a2011-11-10 19:23:58 -080011760 if (!mAttachInfo.mHardwareRenderer.validate()) return null;
Romain Guy6c319ca2011-01-11 14:29:25 -080011761
11762 final int width = mRight - mLeft;
11763 final int height = mBottom - mTop;
Joe Malin32736f02011-01-19 16:14:20 -080011764
Romain Guy6c319ca2011-01-11 14:29:25 -080011765 if (width == 0 || height == 0) {
11766 return null;
11767 }
11768
11769 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
11770 if (mHardwareLayer == null) {
11771 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
11772 width, height, isOpaque());
Michael Jurka952e02b2012-03-13 18:34:35 -070011773 mLocalDirtyRect.set(0, 0, width, height);
Romain Guy6c319ca2011-01-11 14:29:25 -080011774 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
11775 mHardwareLayer.resize(width, height);
Michael Jurka952e02b2012-03-13 18:34:35 -070011776 mLocalDirtyRect.set(0, 0, width, height);
Romain Guy6c319ca2011-01-11 14:29:25 -080011777 }
11778
Romain Guy5cd5c3f2011-10-17 17:10:02 -070011779 // The layer is not valid if the underlying GPU resources cannot be allocated
11780 if (!mHardwareLayer.isValid()) {
11781 return null;
11782 }
11783
Chet Haasea1cff502012-02-21 13:43:44 -080011784 mHardwareLayer.redraw(getHardwareLayerDisplayList(mHardwareLayer), mLocalDirtyRect);
Michael Jurka7e52caf2012-03-06 15:57:06 -080011785 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -080011786 }
11787
11788 return mHardwareLayer;
11789 }
Romain Guy171c5922011-01-06 10:04:23 -080011790
Romain Guy589b0bb2011-10-10 13:57:47 -070011791 /**
11792 * Destroys this View's hardware layer if possible.
Philip Milne6c8ea062012-04-03 17:38:43 -070011793 *
Romain Guy589b0bb2011-10-10 13:57:47 -070011794 * @return True if the layer was destroyed, false otherwise.
Philip Milne6c8ea062012-04-03 17:38:43 -070011795 *
11796 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy589b0bb2011-10-10 13:57:47 -070011797 * @see #LAYER_TYPE_HARDWARE
11798 */
Romain Guya998dff2012-03-23 18:58:36 -070011799 boolean destroyLayer(boolean valid) {
Romain Guy6d7475d2011-07-27 16:28:21 -070011800 if (mHardwareLayer != null) {
Romain Guy9c4b79a2011-11-10 19:23:58 -080011801 AttachInfo info = mAttachInfo;
11802 if (info != null && info.mHardwareRenderer != null &&
Romain Guya998dff2012-03-23 18:58:36 -070011803 info.mHardwareRenderer.isEnabled() &&
11804 (valid || info.mHardwareRenderer.validate())) {
Romain Guy9c4b79a2011-11-10 19:23:58 -080011805 mHardwareLayer.destroy();
11806 mHardwareLayer = null;
Romain Guy31f2c2e2011-11-21 10:55:41 -080011807
Romain Guy9c4b79a2011-11-10 19:23:58 -080011808 invalidate(true);
11809 invalidateParentCaches();
11810 }
Romain Guy65b345f2011-07-27 18:51:50 -070011811 return true;
Romain Guy6d7475d2011-07-27 16:28:21 -070011812 }
Romain Guy65b345f2011-07-27 18:51:50 -070011813 return false;
Romain Guy6d7475d2011-07-27 16:28:21 -070011814 }
11815
Romain Guy171c5922011-01-06 10:04:23 -080011816 /**
Romain Guy31f2c2e2011-11-21 10:55:41 -080011817 * Destroys all hardware rendering resources. This method is invoked
11818 * when the system needs to reclaim resources. Upon execution of this
11819 * method, you should free any OpenGL resources created by the view.
Philip Milne6c8ea062012-04-03 17:38:43 -070011820 *
Romain Guy31f2c2e2011-11-21 10:55:41 -080011821 * Note: you <strong>must</strong> call
11822 * <code>super.destroyHardwareResources()</code> when overriding
11823 * this method.
Philip Milne6c8ea062012-04-03 17:38:43 -070011824 *
Romain Guy31f2c2e2011-11-21 10:55:41 -080011825 * @hide
11826 */
11827 protected void destroyHardwareResources() {
Romain Guya998dff2012-03-23 18:58:36 -070011828 destroyLayer(true);
Romain Guy31f2c2e2011-11-21 10:55:41 -080011829 }
11830
11831 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011832 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
11833 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
11834 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
11835 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
11836 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
11837 * null.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011838 *
Romain Guy171c5922011-01-06 10:04:23 -080011839 * <p>Enabling the drawing cache is similar to
11840 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
Chet Haasedaf98e92011-01-10 14:10:36 -080011841 * acceleration is turned off. When hardware acceleration is turned on, enabling the
11842 * drawing cache has no effect on rendering because the system uses a different mechanism
11843 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even
11844 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)}
11845 * for information on how to enable software and hardware layers.</p>
11846 *
11847 * <p>This API can be used to manually generate
11848 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling
11849 * {@link #getDrawingCache()}.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011850 *
11851 * @param enabled true to enable the drawing cache, false otherwise
11852 *
11853 * @see #isDrawingCacheEnabled()
11854 * @see #getDrawingCache()
11855 * @see #buildDrawingCache()
Joe Malin32736f02011-01-19 16:14:20 -080011856 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011857 */
11858 public void setDrawingCacheEnabled(boolean enabled) {
Romain Guy0211a0a2011-02-14 16:34:59 -080011859 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011860 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
11861 }
11862
11863 /**
11864 * <p>Indicates whether the drawing cache is enabled for this view.</p>
11865 *
11866 * @return true if the drawing cache is enabled
11867 *
11868 * @see #setDrawingCacheEnabled(boolean)
11869 * @see #getDrawingCache()
11870 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070011871 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011872 public boolean isDrawingCacheEnabled() {
11873 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
11874 }
11875
11876 /**
Chet Haasedaf98e92011-01-10 14:10:36 -080011877 * Debugging utility which recursively outputs the dirty state of a view and its
11878 * descendants.
Joe Malin32736f02011-01-19 16:14:20 -080011879 *
Chet Haasedaf98e92011-01-10 14:10:36 -080011880 * @hide
11881 */
Romain Guy676b1732011-02-14 14:45:33 -080011882 @SuppressWarnings({"UnusedDeclaration"})
Chet Haasedaf98e92011-01-10 14:10:36 -080011883 public void outputDirtyFlags(String indent, boolean clear, int clearMask) {
11884 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) +
11885 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" +
11886 (mPrivateFlags & View.DRAWING_CACHE_VALID) +
11887 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")");
11888 if (clear) {
11889 mPrivateFlags &= clearMask;
11890 }
11891 if (this instanceof ViewGroup) {
11892 ViewGroup parent = (ViewGroup) this;
11893 final int count = parent.getChildCount();
11894 for (int i = 0; i < count; i++) {
Romain Guy7d7b5492011-01-24 16:33:45 -080011895 final View child = parent.getChildAt(i);
Chet Haasedaf98e92011-01-10 14:10:36 -080011896 child.outputDirtyFlags(indent + " ", clear, clearMask);
11897 }
11898 }
11899 }
11900
11901 /**
11902 * This method is used by ViewGroup to cause its children to restore or recreate their
11903 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need
11904 * to recreate its own display list, which would happen if it went through the normal
11905 * draw/dispatchDraw mechanisms.
11906 *
11907 * @hide
11908 */
11909 protected void dispatchGetDisplayList() {}
Chet Haasef4ac5472011-01-27 10:30:25 -080011910
11911 /**
11912 * A view that is not attached or hardware accelerated cannot create a display list.
11913 * This method checks these conditions and returns the appropriate result.
11914 *
11915 * @return true if view has the ability to create a display list, false otherwise.
11916 *
11917 * @hide
11918 */
11919 public boolean canHaveDisplayList() {
Romain Guy676b1732011-02-14 14:45:33 -080011920 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null);
Chet Haasef4ac5472011-01-27 10:30:25 -080011921 }
Joe Malin32736f02011-01-19 16:14:20 -080011922
Chet Haasedaf98e92011-01-10 14:10:36 -080011923 /**
Gilles Debunneb35ab7b2011-12-05 15:54:00 -080011924 * @return The HardwareRenderer associated with that view or null if hardware rendering
11925 * is not supported or this this has not been attached to a window.
11926 *
11927 * @hide
11928 */
11929 public HardwareRenderer getHardwareRenderer() {
11930 if (mAttachInfo != null) {
11931 return mAttachInfo.mHardwareRenderer;
11932 }
11933 return null;
11934 }
11935
11936 /**
Chet Haasea1cff502012-02-21 13:43:44 -080011937 * Returns a DisplayList. If the incoming displayList is null, one will be created.
11938 * Otherwise, the same display list will be returned (after having been rendered into
11939 * along the way, depending on the invalidation state of the view).
11940 *
11941 * @param displayList The previous version of this displayList, could be null.
11942 * @param isLayer Whether the requester of the display list is a layer. If so,
11943 * the view will avoid creating a layer inside the resulting display list.
11944 * @return A new or reused DisplayList object.
11945 */
11946 private DisplayList getDisplayList(DisplayList displayList, boolean isLayer) {
11947 if (!canHaveDisplayList()) {
11948 return null;
11949 }
11950
11951 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 ||
11952 displayList == null || !displayList.isValid() ||
11953 (!isLayer && mRecreateDisplayList))) {
11954 // Don't need to recreate the display list, just need to tell our
11955 // children to restore/recreate theirs
11956 if (displayList != null && displayList.isValid() &&
11957 !isLayer && !mRecreateDisplayList) {
11958 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
11959 mPrivateFlags &= ~DIRTY_MASK;
11960 dispatchGetDisplayList();
11961
11962 return displayList;
11963 }
11964
11965 if (!isLayer) {
11966 // If we got here, we're recreating it. Mark it as such to ensure that
11967 // we copy in child display lists into ours in drawChild()
11968 mRecreateDisplayList = true;
11969 }
11970 if (displayList == null) {
11971 final String name = getClass().getSimpleName();
11972 displayList = mAttachInfo.mHardwareRenderer.createDisplayList(name);
11973 // If we're creating a new display list, make sure our parent gets invalidated
11974 // since they will need to recreate their display list to account for this
11975 // new child display list.
11976 invalidateParentCaches();
11977 }
11978
11979 boolean caching = false;
11980 final HardwareCanvas canvas = displayList.start();
11981 int restoreCount = 0;
11982 int width = mRight - mLeft;
11983 int height = mBottom - mTop;
11984
11985 try {
11986 canvas.setViewport(width, height);
11987 // The dirty rect should always be null for a display list
11988 canvas.onPreDraw(null);
11989 int layerType = (
11990 !(mParent instanceof ViewGroup) || ((ViewGroup)mParent).mDrawLayers) ?
11991 getLayerType() : LAYER_TYPE_NONE;
Chet Haase1271e2c2012-04-20 09:54:27 -070011992 if (!isLayer && layerType != LAYER_TYPE_NONE) {
Chet Haaseb85967b2012-03-26 14:37:51 -070011993 if (layerType == LAYER_TYPE_HARDWARE) {
11994 final HardwareLayer layer = getHardwareLayer();
11995 if (layer != null && layer.isValid()) {
11996 canvas.drawHardwareLayer(layer, 0, 0, mLayerPaint);
11997 } else {
11998 canvas.saveLayer(0, 0, mRight - mLeft, mBottom - mTop, mLayerPaint,
11999 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG |
12000 Canvas.CLIP_TO_LAYER_SAVE_FLAG);
12001 }
12002 caching = true;
Chet Haasea1cff502012-02-21 13:43:44 -080012003 } else {
Chet Haaseb85967b2012-03-26 14:37:51 -070012004 buildDrawingCache(true);
12005 Bitmap cache = getDrawingCache(true);
12006 if (cache != null) {
12007 canvas.drawBitmap(cache, 0, 0, mLayerPaint);
12008 caching = true;
12009 }
Chet Haasea1cff502012-02-21 13:43:44 -080012010 }
Chet Haasea1cff502012-02-21 13:43:44 -080012011 } else {
12012
12013 computeScroll();
12014
Chet Haasea1cff502012-02-21 13:43:44 -080012015 canvas.translate(-mScrollX, -mScrollY);
12016 if (!isLayer) {
12017 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
12018 mPrivateFlags &= ~DIRTY_MASK;
12019 }
12020
12021 // Fast path for layouts with no backgrounds
12022 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12023 dispatchDraw(canvas);
12024 } else {
12025 draw(canvas);
12026 }
12027 }
12028 } finally {
Chet Haasea1cff502012-02-21 13:43:44 -080012029 canvas.onPostDraw();
12030
12031 displayList.end();
Chet Haase1271e2c2012-04-20 09:54:27 -070012032 displayList.setCaching(caching);
12033 if (isLayer) {
Chet Haasea1cff502012-02-21 13:43:44 -080012034 displayList.setLeftTopRightBottom(0, 0, width, height);
12035 } else {
12036 setDisplayListProperties(displayList);
12037 }
12038 }
12039 } else if (!isLayer) {
12040 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
12041 mPrivateFlags &= ~DIRTY_MASK;
12042 }
12043
12044 return displayList;
12045 }
12046
12047 /**
12048 * Get the DisplayList for the HardwareLayer
12049 *
12050 * @param layer The HardwareLayer whose DisplayList we want
12051 * @return A DisplayList fopr the specified HardwareLayer
12052 */
12053 private DisplayList getHardwareLayerDisplayList(HardwareLayer layer) {
12054 DisplayList displayList = getDisplayList(layer.getDisplayList(), true);
12055 layer.setDisplayList(displayList);
12056 return displayList;
12057 }
12058
12059
12060 /**
Romain Guyb051e892010-09-28 19:09:36 -070012061 * <p>Returns a display list that can be used to draw this view again
12062 * without executing its draw method.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012063 *
Romain Guyb051e892010-09-28 19:09:36 -070012064 * @return A DisplayList ready to replay, or null if caching is not enabled.
Chet Haasedaf98e92011-01-10 14:10:36 -080012065 *
12066 * @hide
Romain Guyb051e892010-09-28 19:09:36 -070012067 */
Chet Haasedaf98e92011-01-10 14:10:36 -080012068 public DisplayList getDisplayList() {
Chet Haasea1cff502012-02-21 13:43:44 -080012069 mDisplayList = getDisplayList(mDisplayList, false);
Romain Guyb051e892010-09-28 19:09:36 -070012070 return mDisplayList;
12071 }
12072
12073 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070012074 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012075 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012076 * @return A non-scaled bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -080012077 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012078 * @see #getDrawingCache(boolean)
12079 */
12080 public Bitmap getDrawingCache() {
12081 return getDrawingCache(false);
12082 }
12083
12084 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012085 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
12086 * is null when caching is disabled. If caching is enabled and the cache is not ready,
12087 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
12088 * draw from the cache when the cache is enabled. To benefit from the cache, you must
12089 * request the drawing cache by calling this method and draw it on screen if the
12090 * returned bitmap is not null.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012091 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012092 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
12093 * this method will create a bitmap of the same size as this view. Because this bitmap
12094 * will be drawn scaled by the parent ViewGroup, the result on screen might show
12095 * scaling artifacts. To avoid such artifacts, you should call this method by setting
12096 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
12097 * size than the view. This implies that your application must be able to handle this
12098 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012099 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012100 * @param autoScale Indicates whether the generated bitmap should be scaled based on
12101 * the current density of the screen when the application is in compatibility
12102 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012103 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012104 * @return A bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -080012105 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012106 * @see #setDrawingCacheEnabled(boolean)
12107 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -070012108 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012109 * @see #destroyDrawingCache()
12110 */
Romain Guyfbd8f692009-06-26 14:51:58 -070012111 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012112 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
12113 return null;
12114 }
12115 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012116 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012117 }
Romain Guy02890fd2010-08-06 17:58:44 -070012118 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012119 }
12120
12121 /**
12122 * <p>Frees the resources used by the drawing cache. If you call
12123 * {@link #buildDrawingCache()} manually without calling
12124 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
12125 * should cleanup the cache with this method afterwards.</p>
12126 *
12127 * @see #setDrawingCacheEnabled(boolean)
12128 * @see #buildDrawingCache()
12129 * @see #getDrawingCache()
12130 */
12131 public void destroyDrawingCache() {
12132 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070012133 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012134 mDrawingCache = null;
12135 }
Romain Guyfbd8f692009-06-26 14:51:58 -070012136 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070012137 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -070012138 mUnscaledDrawingCache = null;
12139 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012140 }
12141
12142 /**
12143 * Setting a solid background color for the drawing cache's bitmaps will improve
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070012144 * performance and memory usage. Note, though that this should only be used if this
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012145 * view will always be drawn on top of a solid color.
12146 *
12147 * @param color The background color to use for the drawing cache's bitmap
12148 *
12149 * @see #setDrawingCacheEnabled(boolean)
12150 * @see #buildDrawingCache()
12151 * @see #getDrawingCache()
12152 */
12153 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -080012154 if (color != mDrawingCacheBackgroundColor) {
12155 mDrawingCacheBackgroundColor = color;
12156 mPrivateFlags &= ~DRAWING_CACHE_VALID;
12157 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012158 }
12159
12160 /**
12161 * @see #setDrawingCacheBackgroundColor(int)
12162 *
12163 * @return The background color to used for the drawing cache's bitmap
12164 */
12165 public int getDrawingCacheBackgroundColor() {
12166 return mDrawingCacheBackgroundColor;
12167 }
12168
12169 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070012170 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012171 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012172 * @see #buildDrawingCache(boolean)
12173 */
12174 public void buildDrawingCache() {
12175 buildDrawingCache(false);
12176 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -080012177
Romain Guyfbd8f692009-06-26 14:51:58 -070012178 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012179 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
12180 *
12181 * <p>If you call {@link #buildDrawingCache()} manually without calling
12182 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
12183 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012184 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012185 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
12186 * this method will create a bitmap of the same size as this view. Because this bitmap
12187 * will be drawn scaled by the parent ViewGroup, the result on screen might show
12188 * scaling artifacts. To avoid such artifacts, you should call this method by setting
12189 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
12190 * size than the view. This implies that your application must be able to handle this
12191 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012192 *
Romain Guy0d9275e2010-10-26 14:22:30 -070012193 * <p>You should avoid calling this method when hardware acceleration is enabled. If
12194 * you do not need the drawing cache bitmap, calling this method will increase memory
Joe Malin32736f02011-01-19 16:14:20 -080012195 * usage and cause the view to be rendered in software once, thus negatively impacting
Romain Guy0d9275e2010-10-26 14:22:30 -070012196 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012197 *
12198 * @see #getDrawingCache()
12199 * @see #destroyDrawingCache()
12200 */
Romain Guyfbd8f692009-06-26 14:51:58 -070012201 public void buildDrawingCache(boolean autoScale) {
12202 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -070012203 mDrawingCache == null : mUnscaledDrawingCache == null)) {
Romain Guy0211a0a2011-02-14 16:34:59 -080012204 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012205
12206 if (ViewDebug.TRACE_HIERARCHY) {
12207 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
12208 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012209
Romain Guy8506ab42009-06-11 17:35:47 -070012210 int width = mRight - mLeft;
12211 int height = mBottom - mTop;
12212
12213 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -070012214 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -070012215
Romain Guye1123222009-06-29 14:24:56 -070012216 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012217 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
12218 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -070012219 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012220
12221 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -070012222 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -080012223 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012224
12225 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -070012226 // Projected bitmap size in bytes
Adam Powell26153a32010-11-08 15:22:27 -080012227 (width * height * (opaque && !use32BitCache ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012228 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
12229 destroyDrawingCache();
Romain Guy0211a0a2011-02-14 16:34:59 -080012230 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012231 return;
12232 }
12233
12234 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -070012235 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012236
12237 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012238 Bitmap.Config quality;
12239 if (!opaque) {
Romain Guy676b1732011-02-14 14:45:33 -080012240 // Never pick ARGB_4444 because it looks awful
12241 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012242 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
12243 case DRAWING_CACHE_QUALITY_AUTO:
12244 quality = Bitmap.Config.ARGB_8888;
12245 break;
12246 case DRAWING_CACHE_QUALITY_LOW:
Romain Guy676b1732011-02-14 14:45:33 -080012247 quality = Bitmap.Config.ARGB_8888;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012248 break;
12249 case DRAWING_CACHE_QUALITY_HIGH:
12250 quality = Bitmap.Config.ARGB_8888;
12251 break;
12252 default:
12253 quality = Bitmap.Config.ARGB_8888;
12254 break;
12255 }
12256 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -070012257 // Optimization for translucent windows
12258 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -080012259 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012260 }
12261
12262 // Try to cleanup memory
12263 if (bitmap != null) bitmap.recycle();
12264
12265 try {
12266 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -070012267 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -070012268 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -070012269 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070012270 } else {
Romain Guy02890fd2010-08-06 17:58:44 -070012271 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070012272 }
Adam Powell26153a32010-11-08 15:22:27 -080012273 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012274 } catch (OutOfMemoryError e) {
12275 // If there is not enough memory to create the bitmap cache, just
12276 // ignore the issue as bitmap caches are not required to draw the
12277 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -070012278 if (autoScale) {
12279 mDrawingCache = null;
12280 } else {
12281 mUnscaledDrawingCache = null;
12282 }
Romain Guy0211a0a2011-02-14 16:34:59 -080012283 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012284 return;
12285 }
12286
12287 clear = drawingCacheBackgroundColor != 0;
12288 }
12289
12290 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012291 if (attachInfo != null) {
12292 canvas = attachInfo.mCanvas;
12293 if (canvas == null) {
12294 canvas = new Canvas();
12295 }
12296 canvas.setBitmap(bitmap);
12297 // Temporarily clobber the cached Canvas in case one of our children
12298 // is also using a drawing cache. Without this, the children would
12299 // steal the canvas by attaching their own bitmap to it and bad, bad
12300 // thing would happen (invisible views, corrupted drawings, etc.)
12301 attachInfo.mCanvas = null;
12302 } else {
12303 // This case should hopefully never or seldom happen
12304 canvas = new Canvas(bitmap);
12305 }
12306
12307 if (clear) {
12308 bitmap.eraseColor(drawingCacheBackgroundColor);
12309 }
12310
12311 computeScroll();
12312 final int restoreCount = canvas.save();
Joe Malin32736f02011-01-19 16:14:20 -080012313
Romain Guye1123222009-06-29 14:24:56 -070012314 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012315 final float scale = attachInfo.mApplicationScale;
12316 canvas.scale(scale, scale);
12317 }
Joe Malin32736f02011-01-19 16:14:20 -080012318
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012319 canvas.translate(-mScrollX, -mScrollY);
12320
Romain Guy5bcdff42009-05-14 21:27:18 -070012321 mPrivateFlags |= DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -080012322 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
12323 mLayerType != LAYER_TYPE_NONE) {
Romain Guy0d9275e2010-10-26 14:22:30 -070012324 mPrivateFlags |= DRAWING_CACHE_VALID;
12325 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012326
12327 // Fast path for layouts with no backgrounds
12328 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12329 if (ViewDebug.TRACE_HIERARCHY) {
12330 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
12331 }
Romain Guy5bcdff42009-05-14 21:27:18 -070012332 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012333 dispatchDraw(canvas);
12334 } else {
12335 draw(canvas);
12336 }
12337
12338 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070012339 canvas.setBitmap(null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012340
12341 if (attachInfo != null) {
12342 // Restore the cached Canvas for our siblings
12343 attachInfo.mCanvas = canvas;
12344 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012345 }
12346 }
12347
12348 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012349 * Create a snapshot of the view into a bitmap. We should probably make
12350 * some form of this public, but should think about the API.
12351 */
Romain Guy223ff5c2010-03-02 17:07:47 -080012352 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012353 int width = mRight - mLeft;
12354 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012355
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012356 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -070012357 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012358 width = (int) ((width * scale) + 0.5f);
12359 height = (int) ((height * scale) + 0.5f);
Joe Malin32736f02011-01-19 16:14:20 -080012360
Romain Guy8c11e312009-09-14 15:15:30 -070012361 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012362 if (bitmap == null) {
12363 throw new OutOfMemoryError();
12364 }
12365
Romain Guyc529d8d2011-09-06 15:01:39 -070012366 Resources resources = getResources();
12367 if (resources != null) {
12368 bitmap.setDensity(resources.getDisplayMetrics().densityDpi);
12369 }
Joe Malin32736f02011-01-19 16:14:20 -080012370
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012371 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012372 if (attachInfo != null) {
12373 canvas = attachInfo.mCanvas;
12374 if (canvas == null) {
12375 canvas = new Canvas();
12376 }
12377 canvas.setBitmap(bitmap);
12378 // Temporarily clobber the cached Canvas in case one of our children
12379 // is also using a drawing cache. Without this, the children would
12380 // steal the canvas by attaching their own bitmap to it and bad, bad
12381 // things would happen (invisible views, corrupted drawings, etc.)
12382 attachInfo.mCanvas = null;
12383 } else {
12384 // This case should hopefully never or seldom happen
12385 canvas = new Canvas(bitmap);
12386 }
12387
Romain Guy5bcdff42009-05-14 21:27:18 -070012388 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012389 bitmap.eraseColor(backgroundColor);
12390 }
12391
12392 computeScroll();
12393 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012394 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012395 canvas.translate(-mScrollX, -mScrollY);
12396
Romain Guy5bcdff42009-05-14 21:27:18 -070012397 // Temporarily remove the dirty mask
12398 int flags = mPrivateFlags;
12399 mPrivateFlags &= ~DIRTY_MASK;
12400
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012401 // Fast path for layouts with no backgrounds
12402 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12403 dispatchDraw(canvas);
12404 } else {
12405 draw(canvas);
12406 }
12407
Romain Guy5bcdff42009-05-14 21:27:18 -070012408 mPrivateFlags = flags;
12409
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012410 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070012411 canvas.setBitmap(null);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012412
12413 if (attachInfo != null) {
12414 // Restore the cached Canvas for our siblings
12415 attachInfo.mCanvas = canvas;
12416 }
Romain Guy8506ab42009-06-11 17:35:47 -070012417
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012418 return bitmap;
12419 }
12420
12421 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012422 * Indicates whether this View is currently in edit mode. A View is usually
12423 * in edit mode when displayed within a developer tool. For instance, if
12424 * this View is being drawn by a visual user interface builder, this method
12425 * should return true.
12426 *
12427 * Subclasses should check the return value of this method to provide
12428 * different behaviors if their normal behavior might interfere with the
12429 * host environment. For instance: the class spawns a thread in its
12430 * constructor, the drawing code relies on device-specific features, etc.
12431 *
12432 * This method is usually checked in the drawing code of custom widgets.
12433 *
12434 * @return True if this View is in edit mode, false otherwise.
12435 */
12436 public boolean isInEditMode() {
12437 return false;
12438 }
12439
12440 /**
12441 * If the View draws content inside its padding and enables fading edges,
12442 * it needs to support padding offsets. Padding offsets are added to the
12443 * fading edges to extend the length of the fade so that it covers pixels
12444 * drawn inside the padding.
12445 *
12446 * Subclasses of this class should override this method if they need
12447 * to draw content inside the padding.
12448 *
12449 * @return True if padding offset must be applied, false otherwise.
12450 *
12451 * @see #getLeftPaddingOffset()
12452 * @see #getRightPaddingOffset()
12453 * @see #getTopPaddingOffset()
12454 * @see #getBottomPaddingOffset()
12455 *
12456 * @since CURRENT
12457 */
12458 protected boolean isPaddingOffsetRequired() {
12459 return false;
12460 }
12461
12462 /**
12463 * Amount by which to extend the left fading region. Called only when
12464 * {@link #isPaddingOffsetRequired()} returns true.
12465 *
12466 * @return The left padding offset in pixels.
12467 *
12468 * @see #isPaddingOffsetRequired()
12469 *
12470 * @since CURRENT
12471 */
12472 protected int getLeftPaddingOffset() {
12473 return 0;
12474 }
12475
12476 /**
12477 * Amount by which to extend the right fading region. Called only when
12478 * {@link #isPaddingOffsetRequired()} returns true.
12479 *
12480 * @return The right padding offset in pixels.
12481 *
12482 * @see #isPaddingOffsetRequired()
12483 *
12484 * @since CURRENT
12485 */
12486 protected int getRightPaddingOffset() {
12487 return 0;
12488 }
12489
12490 /**
12491 * Amount by which to extend the top fading region. Called only when
12492 * {@link #isPaddingOffsetRequired()} returns true.
12493 *
12494 * @return The top padding offset in pixels.
12495 *
12496 * @see #isPaddingOffsetRequired()
12497 *
12498 * @since CURRENT
12499 */
12500 protected int getTopPaddingOffset() {
12501 return 0;
12502 }
12503
12504 /**
12505 * Amount by which to extend the bottom fading region. Called only when
12506 * {@link #isPaddingOffsetRequired()} returns true.
12507 *
12508 * @return The bottom padding offset in pixels.
12509 *
12510 * @see #isPaddingOffsetRequired()
12511 *
12512 * @since CURRENT
12513 */
12514 protected int getBottomPaddingOffset() {
12515 return 0;
12516 }
12517
12518 /**
Romain Guyf2fc4602011-07-19 15:20:03 -070012519 * @hide
12520 * @param offsetRequired
12521 */
12522 protected int getFadeTop(boolean offsetRequired) {
12523 int top = mPaddingTop;
12524 if (offsetRequired) top += getTopPaddingOffset();
12525 return top;
12526 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012527
Romain Guyf2fc4602011-07-19 15:20:03 -070012528 /**
12529 * @hide
12530 * @param offsetRequired
12531 */
12532 protected int getFadeHeight(boolean offsetRequired) {
12533 int padding = mPaddingTop;
Philip Milne6c8ea062012-04-03 17:38:43 -070012534 if (offsetRequired) padding += getTopPaddingOffset();
Romain Guyf2fc4602011-07-19 15:20:03 -070012535 return mBottom - mTop - mPaddingBottom - padding;
12536 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012537
Romain Guyf2fc4602011-07-19 15:20:03 -070012538 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +090012539 * <p>Indicates whether this view is attached to a hardware accelerated
Romain Guy2bffd262010-09-12 17:40:02 -070012540 * window or not.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012541 *
Romain Guy2bffd262010-09-12 17:40:02 -070012542 * <p>Even if this method returns true, it does not mean that every call
12543 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
12544 * accelerated {@link android.graphics.Canvas}. For instance, if this view
Ken Wakasaf76a50c2012-03-09 19:56:35 +090012545 * is drawn onto an offscreen {@link android.graphics.Bitmap} and its
Romain Guy2bffd262010-09-12 17:40:02 -070012546 * window is hardware accelerated,
12547 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
12548 * return false, and this method will return true.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012549 *
Romain Guy2bffd262010-09-12 17:40:02 -070012550 * @return True if the view is attached to a window and the window is
12551 * hardware accelerated; false in any other case.
12552 */
12553 public boolean isHardwareAccelerated() {
12554 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
12555 }
Joe Malin32736f02011-01-19 16:14:20 -080012556
Romain Guy2bffd262010-09-12 17:40:02 -070012557 /**
Chet Haasebcca79a2012-02-14 08:45:14 -080012558 * Utility function, called by draw(canvas, parent, drawingTime) to handle the less common
12559 * case of an active Animation being run on the view.
12560 */
12561 private boolean drawAnimation(ViewGroup parent, long drawingTime,
12562 Animation a, boolean scalingRequired) {
12563 Transformation invalidationTransform;
12564 final int flags = parent.mGroupFlags;
12565 final boolean initialized = a.isInitialized();
12566 if (!initialized) {
Chet Haase1fb8a9e2012-04-19 09:22:34 -070012567 a.initialize(mRight - mLeft, mBottom - mTop, parent.getWidth(), parent.getHeight());
Chet Haasebcca79a2012-02-14 08:45:14 -080012568 a.initializeInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop);
12569 onAnimationStart();
12570 }
12571
12572 boolean more = a.getTransformation(drawingTime, parent.mChildTransformation, 1f);
12573 if (scalingRequired && mAttachInfo.mApplicationScale != 1f) {
12574 if (parent.mInvalidationTransformation == null) {
12575 parent.mInvalidationTransformation = new Transformation();
12576 }
12577 invalidationTransform = parent.mInvalidationTransformation;
12578 a.getTransformation(drawingTime, invalidationTransform, 1f);
12579 } else {
12580 invalidationTransform = parent.mChildTransformation;
12581 }
12582 if (more) {
12583 if (!a.willChangeBounds()) {
12584 if ((flags & (parent.FLAG_OPTIMIZE_INVALIDATE | parent.FLAG_ANIMATION_DONE)) ==
12585 parent.FLAG_OPTIMIZE_INVALIDATE) {
12586 parent.mGroupFlags |= parent.FLAG_INVALIDATE_REQUIRED;
12587 } else if ((flags & parent.FLAG_INVALIDATE_REQUIRED) == 0) {
12588 // The child need to draw an animation, potentially offscreen, so
12589 // make sure we do not cancel invalidate requests
12590 parent.mPrivateFlags |= DRAW_ANIMATION;
12591 parent.invalidate(mLeft, mTop, mRight, mBottom);
12592 }
12593 } else {
12594 if (parent.mInvalidateRegion == null) {
12595 parent.mInvalidateRegion = new RectF();
12596 }
12597 final RectF region = parent.mInvalidateRegion;
12598 a.getInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop, region,
12599 invalidationTransform);
12600
12601 // The child need to draw an animation, potentially offscreen, so
12602 // make sure we do not cancel invalidate requests
12603 parent.mPrivateFlags |= DRAW_ANIMATION;
12604
12605 final int left = mLeft + (int) region.left;
12606 final int top = mTop + (int) region.top;
12607 parent.invalidate(left, top, left + (int) (region.width() + .5f),
12608 top + (int) (region.height() + .5f));
12609 }
12610 }
12611 return more;
12612 }
12613
Chet Haasea1cff502012-02-21 13:43:44 -080012614 void setDisplayListProperties() {
12615 setDisplayListProperties(mDisplayList);
12616 }
12617
12618 /**
12619 * This method is called by getDisplayList() when a display list is created or re-rendered.
12620 * It sets or resets the current value of all properties on that display list (resetting is
12621 * necessary when a display list is being re-created, because we need to make sure that
12622 * previously-set transform values
12623 */
12624 void setDisplayListProperties(DisplayList displayList) {
Chet Haase1271e2c2012-04-20 09:54:27 -070012625 if (displayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080012626 displayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom);
Chet Haasedb8c9a62012-03-21 18:54:18 -070012627 displayList.setHasOverlappingRendering(hasOverlappingRendering());
Chet Haasea1cff502012-02-21 13:43:44 -080012628 if (mParent instanceof ViewGroup) {
12629 displayList.setClipChildren(
12630 (((ViewGroup)mParent).mGroupFlags & ViewGroup.FLAG_CLIP_CHILDREN) != 0);
12631 }
Chet Haase9420abd2012-03-29 16:28:32 -070012632 float alpha = 1;
12633 if (mParent instanceof ViewGroup && (((ViewGroup) mParent).mGroupFlags &
12634 ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
12635 ViewGroup parentVG = (ViewGroup) mParent;
12636 final boolean hasTransform =
12637 parentVG.getChildStaticTransformation(this, parentVG.mChildTransformation);
12638 if (hasTransform) {
12639 Transformation transform = parentVG.mChildTransformation;
12640 final int transformType = parentVG.mChildTransformation.getTransformationType();
12641 if (transformType != Transformation.TYPE_IDENTITY) {
12642 if ((transformType & Transformation.TYPE_ALPHA) != 0) {
12643 alpha = transform.getAlpha();
12644 }
12645 if ((transformType & Transformation.TYPE_MATRIX) != 0) {
12646 displayList.setStaticMatrix(transform.getMatrix());
12647 }
12648 }
12649 }
Chet Haasea1cff502012-02-21 13:43:44 -080012650 }
12651 if (mTransformationInfo != null) {
Chet Haase9420abd2012-03-29 16:28:32 -070012652 alpha *= mTransformationInfo.mAlpha;
12653 if (alpha < 1) {
12654 final int multipliedAlpha = (int) (255 * alpha);
12655 if (onSetAlpha(multipliedAlpha)) {
12656 alpha = 1;
12657 }
12658 }
12659 displayList.setTransformationInfo(alpha,
Chet Haasea1cff502012-02-21 13:43:44 -080012660 mTransformationInfo.mTranslationX, mTransformationInfo.mTranslationY,
12661 mTransformationInfo.mRotation, mTransformationInfo.mRotationX,
12662 mTransformationInfo.mRotationY, mTransformationInfo.mScaleX,
12663 mTransformationInfo.mScaleY);
Chet Haaseb85967b2012-03-26 14:37:51 -070012664 if (mTransformationInfo.mCamera == null) {
12665 mTransformationInfo.mCamera = new Camera();
12666 mTransformationInfo.matrix3D = new Matrix();
12667 }
12668 displayList.setCameraDistance(mTransformationInfo.mCamera.getLocationZ());
Chet Haasea1cff502012-02-21 13:43:44 -080012669 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == PIVOT_EXPLICITLY_SET) {
12670 displayList.setPivotX(getPivotX());
12671 displayList.setPivotY(getPivotY());
12672 }
Chet Haase9420abd2012-03-29 16:28:32 -070012673 } else if (alpha < 1) {
12674 displayList.setAlpha(alpha);
Chet Haasea1cff502012-02-21 13:43:44 -080012675 }
12676 }
12677 }
12678
Chet Haasebcca79a2012-02-14 08:45:14 -080012679 /**
Chet Haase64a48c12012-02-13 16:33:29 -080012680 * This method is called by ViewGroup.drawChild() to have each child view draw itself.
12681 * This draw() method is an implementation detail and is not intended to be overridden or
12682 * to be called from anywhere else other than ViewGroup.drawChild().
12683 */
12684 boolean draw(Canvas canvas, ViewGroup parent, long drawingTime) {
Chet Haase1271e2c2012-04-20 09:54:27 -070012685 boolean useDisplayListProperties = mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
Chet Haase64a48c12012-02-13 16:33:29 -080012686 boolean more = false;
Chet Haase64a48c12012-02-13 16:33:29 -080012687 final boolean childHasIdentityMatrix = hasIdentityMatrix();
Chet Haase64a48c12012-02-13 16:33:29 -080012688 final int flags = parent.mGroupFlags;
12689
Chet Haasea1cff502012-02-21 13:43:44 -080012690 if ((flags & ViewGroup.FLAG_CLEAR_TRANSFORMATION) == ViewGroup.FLAG_CLEAR_TRANSFORMATION) {
Chet Haase64a48c12012-02-13 16:33:29 -080012691 parent.mChildTransformation.clear();
Chet Haasea1cff502012-02-21 13:43:44 -080012692 parent.mGroupFlags &= ~ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080012693 }
12694
12695 Transformation transformToApply = null;
Chet Haase64a48c12012-02-13 16:33:29 -080012696 boolean concatMatrix = false;
12697
12698 boolean scalingRequired = false;
12699 boolean caching;
12700 int layerType = parent.mDrawLayers ? getLayerType() : LAYER_TYPE_NONE;
12701
12702 final boolean hardwareAccelerated = canvas.isHardwareAccelerated();
Chet Haasea1cff502012-02-21 13:43:44 -080012703 if ((flags & ViewGroup.FLAG_CHILDREN_DRAWN_WITH_CACHE) != 0 ||
12704 (flags & ViewGroup.FLAG_ALWAYS_DRAWN_WITH_CACHE) != 0) {
Chet Haase64a48c12012-02-13 16:33:29 -080012705 caching = true;
Chet Haase9420abd2012-03-29 16:28:32 -070012706 // Auto-scaled apps are not hw-accelerated, no need to set scaling flag on DisplayList
Chet Haase64a48c12012-02-13 16:33:29 -080012707 if (mAttachInfo != null) scalingRequired = mAttachInfo.mScalingRequired;
12708 } else {
12709 caching = (layerType != LAYER_TYPE_NONE) || hardwareAccelerated;
12710 }
12711
Chet Haasebcca79a2012-02-14 08:45:14 -080012712 final Animation a = getAnimation();
Chet Haase64a48c12012-02-13 16:33:29 -080012713 if (a != null) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012714 more = drawAnimation(parent, drawingTime, a, scalingRequired);
Chet Haase64a48c12012-02-13 16:33:29 -080012715 concatMatrix = a.willChangeTransformationMatrix();
Chet Haasebcca79a2012-02-14 08:45:14 -080012716 transformToApply = parent.mChildTransformation;
Chet Haase9420abd2012-03-29 16:28:32 -070012717 } else if (!useDisplayListProperties &&
12718 (flags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012719 final boolean hasTransform =
12720 parent.getChildStaticTransformation(this, parent.mChildTransformation);
Chet Haase64a48c12012-02-13 16:33:29 -080012721 if (hasTransform) {
12722 final int transformType = parent.mChildTransformation.getTransformationType();
12723 transformToApply = transformType != Transformation.TYPE_IDENTITY ?
12724 parent.mChildTransformation : null;
12725 concatMatrix = (transformType & Transformation.TYPE_MATRIX) != 0;
12726 }
12727 }
12728
12729 concatMatrix |= !childHasIdentityMatrix;
12730
12731 // Sets the flag as early as possible to allow draw() implementations
12732 // to call invalidate() successfully when doing animations
12733 mPrivateFlags |= DRAWN;
12734
Chet Haasebcca79a2012-02-14 08:45:14 -080012735 if (!concatMatrix && canvas.quickReject(mLeft, mTop, mRight, mBottom, Canvas.EdgeType.BW) &&
Chet Haase64a48c12012-02-13 16:33:29 -080012736 (mPrivateFlags & DRAW_ANIMATION) == 0) {
12737 return more;
12738 }
12739
12740 if (hardwareAccelerated) {
12741 // Clear INVALIDATED flag to allow invalidation to occur during rendering, but
12742 // retain the flag's value temporarily in the mRecreateDisplayList flag
12743 mRecreateDisplayList = (mPrivateFlags & INVALIDATED) == INVALIDATED;
12744 mPrivateFlags &= ~INVALIDATED;
12745 }
12746
12747 computeScroll();
12748
12749 final int sx = mScrollX;
12750 final int sy = mScrollY;
12751
12752 DisplayList displayList = null;
12753 Bitmap cache = null;
12754 boolean hasDisplayList = false;
12755 if (caching) {
12756 if (!hardwareAccelerated) {
12757 if (layerType != LAYER_TYPE_NONE) {
12758 layerType = LAYER_TYPE_SOFTWARE;
12759 buildDrawingCache(true);
12760 }
12761 cache = getDrawingCache(true);
12762 } else {
12763 switch (layerType) {
12764 case LAYER_TYPE_SOFTWARE:
Chet Haaseb85967b2012-03-26 14:37:51 -070012765 if (useDisplayListProperties) {
12766 hasDisplayList = canHaveDisplayList();
12767 } else {
12768 buildDrawingCache(true);
12769 cache = getDrawingCache(true);
12770 }
Chet Haase64a48c12012-02-13 16:33:29 -080012771 break;
Chet Haasea1cff502012-02-21 13:43:44 -080012772 case LAYER_TYPE_HARDWARE:
12773 if (useDisplayListProperties) {
12774 hasDisplayList = canHaveDisplayList();
12775 }
12776 break;
Chet Haase64a48c12012-02-13 16:33:29 -080012777 case LAYER_TYPE_NONE:
12778 // Delay getting the display list until animation-driven alpha values are
12779 // set up and possibly passed on to the view
12780 hasDisplayList = canHaveDisplayList();
12781 break;
12782 }
12783 }
12784 }
Chet Haasea1cff502012-02-21 13:43:44 -080012785 useDisplayListProperties &= hasDisplayList;
Chet Haase9420abd2012-03-29 16:28:32 -070012786 if (useDisplayListProperties) {
12787 displayList = getDisplayList();
12788 if (!displayList.isValid()) {
12789 // Uncommon, but possible. If a view is removed from the hierarchy during the call
12790 // to getDisplayList(), the display list will be marked invalid and we should not
12791 // try to use it again.
12792 displayList = null;
12793 hasDisplayList = false;
12794 useDisplayListProperties = false;
12795 }
12796 }
Chet Haase64a48c12012-02-13 16:33:29 -080012797
12798 final boolean hasNoCache = cache == null || hasDisplayList;
12799 final boolean offsetForScroll = cache == null && !hasDisplayList &&
12800 layerType != LAYER_TYPE_HARDWARE;
12801
Chet Haasea1cff502012-02-21 13:43:44 -080012802 int restoreTo = -1;
Chet Haase89b7f2e2012-03-21 11:15:37 -070012803 if (!useDisplayListProperties || transformToApply != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080012804 restoreTo = canvas.save();
12805 }
Chet Haase64a48c12012-02-13 16:33:29 -080012806 if (offsetForScroll) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012807 canvas.translate(mLeft - sx, mTop - sy);
Chet Haase64a48c12012-02-13 16:33:29 -080012808 } else {
Chet Haasea1cff502012-02-21 13:43:44 -080012809 if (!useDisplayListProperties) {
12810 canvas.translate(mLeft, mTop);
12811 }
Chet Haase64a48c12012-02-13 16:33:29 -080012812 if (scalingRequired) {
Chet Haasea1cff502012-02-21 13:43:44 -080012813 if (useDisplayListProperties) {
Chet Haase9420abd2012-03-29 16:28:32 -070012814 // TODO: Might not need this if we put everything inside the DL
Chet Haasea1cff502012-02-21 13:43:44 -080012815 restoreTo = canvas.save();
12816 }
Chet Haase64a48c12012-02-13 16:33:29 -080012817 // mAttachInfo cannot be null, otherwise scalingRequired == false
12818 final float scale = 1.0f / mAttachInfo.mApplicationScale;
12819 canvas.scale(scale, scale);
12820 }
12821 }
12822
Chet Haasea1cff502012-02-21 13:43:44 -080012823 float alpha = useDisplayListProperties ? 1 : getAlpha();
Chet Haase9420abd2012-03-29 16:28:32 -070012824 if (transformToApply != null || alpha < 1 || !hasIdentityMatrix()) {
Chet Haase64a48c12012-02-13 16:33:29 -080012825 if (transformToApply != null || !childHasIdentityMatrix) {
12826 int transX = 0;
12827 int transY = 0;
12828
12829 if (offsetForScroll) {
12830 transX = -sx;
12831 transY = -sy;
12832 }
12833
12834 if (transformToApply != null) {
12835 if (concatMatrix) {
Chet Haase9420abd2012-03-29 16:28:32 -070012836 if (useDisplayListProperties) {
12837 displayList.setAnimationMatrix(transformToApply.getMatrix());
12838 } else {
12839 // Undo the scroll translation, apply the transformation matrix,
12840 // then redo the scroll translate to get the correct result.
12841 canvas.translate(-transX, -transY);
12842 canvas.concat(transformToApply.getMatrix());
12843 canvas.translate(transX, transY);
12844 }
Chet Haasea1cff502012-02-21 13:43:44 -080012845 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080012846 }
12847
12848 float transformAlpha = transformToApply.getAlpha();
Chet Haase9420abd2012-03-29 16:28:32 -070012849 if (transformAlpha < 1) {
Chet Haase64a48c12012-02-13 16:33:29 -080012850 alpha *= transformToApply.getAlpha();
Chet Haasea1cff502012-02-21 13:43:44 -080012851 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080012852 }
12853 }
12854
Chet Haasea1cff502012-02-21 13:43:44 -080012855 if (!childHasIdentityMatrix && !useDisplayListProperties) {
Chet Haase64a48c12012-02-13 16:33:29 -080012856 canvas.translate(-transX, -transY);
12857 canvas.concat(getMatrix());
12858 canvas.translate(transX, transY);
12859 }
12860 }
12861
Chet Haase9420abd2012-03-29 16:28:32 -070012862 if (alpha < 1) {
Chet Haasea1cff502012-02-21 13:43:44 -080012863 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080012864 if (hasNoCache) {
12865 final int multipliedAlpha = (int) (255 * alpha);
12866 if (!onSetAlpha(multipliedAlpha)) {
12867 int layerFlags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
Chet Haasea1cff502012-02-21 13:43:44 -080012868 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) != 0 ||
Chet Haase64a48c12012-02-13 16:33:29 -080012869 layerType != LAYER_TYPE_NONE) {
12870 layerFlags |= Canvas.CLIP_TO_LAYER_SAVE_FLAG;
12871 }
Chet Haase9420abd2012-03-29 16:28:32 -070012872 if (useDisplayListProperties) {
12873 displayList.setAlpha(alpha * getAlpha());
12874 } else if (layerType == LAYER_TYPE_NONE) {
Chet Haase89b7f2e2012-03-21 11:15:37 -070012875 final int scrollX = hasDisplayList ? 0 : sx;
12876 final int scrollY = hasDisplayList ? 0 : sy;
12877 canvas.saveLayerAlpha(scrollX, scrollY, scrollX + mRight - mLeft,
12878 scrollY + mBottom - mTop, multipliedAlpha, layerFlags);
Chet Haase64a48c12012-02-13 16:33:29 -080012879 }
12880 } else {
12881 // Alpha is handled by the child directly, clobber the layer's alpha
12882 mPrivateFlags |= ALPHA_SET;
12883 }
12884 }
12885 }
12886 } else if ((mPrivateFlags & ALPHA_SET) == ALPHA_SET) {
12887 onSetAlpha(255);
12888 mPrivateFlags &= ~ALPHA_SET;
12889 }
12890
Chet Haasea1cff502012-02-21 13:43:44 -080012891 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) == ViewGroup.FLAG_CLIP_CHILDREN &&
12892 !useDisplayListProperties) {
Chet Haase64a48c12012-02-13 16:33:29 -080012893 if (offsetForScroll) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012894 canvas.clipRect(sx, sy, sx + (mRight - mLeft), sy + (mBottom - mTop));
Chet Haase64a48c12012-02-13 16:33:29 -080012895 } else {
12896 if (!scalingRequired || cache == null) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012897 canvas.clipRect(0, 0, mRight - mLeft, mBottom - mTop);
Chet Haase64a48c12012-02-13 16:33:29 -080012898 } else {
12899 canvas.clipRect(0, 0, cache.getWidth(), cache.getHeight());
12900 }
12901 }
12902 }
12903
Chet Haase9420abd2012-03-29 16:28:32 -070012904 if (!useDisplayListProperties && hasDisplayList) {
Chet Haase64a48c12012-02-13 16:33:29 -080012905 displayList = getDisplayList();
12906 if (!displayList.isValid()) {
12907 // Uncommon, but possible. If a view is removed from the hierarchy during the call
12908 // to getDisplayList(), the display list will be marked invalid and we should not
12909 // try to use it again.
12910 displayList = null;
12911 hasDisplayList = false;
12912 }
12913 }
12914
12915 if (hasNoCache) {
12916 boolean layerRendered = false;
Chet Haasea1cff502012-02-21 13:43:44 -080012917 if (layerType == LAYER_TYPE_HARDWARE && !useDisplayListProperties) {
Michael Jurka7e52caf2012-03-06 15:57:06 -080012918 final HardwareLayer layer = getHardwareLayer();
Chet Haase64a48c12012-02-13 16:33:29 -080012919 if (layer != null && layer.isValid()) {
12920 mLayerPaint.setAlpha((int) (alpha * 255));
12921 ((HardwareCanvas) canvas).drawHardwareLayer(layer, 0, 0, mLayerPaint);
12922 layerRendered = true;
12923 } else {
12924 final int scrollX = hasDisplayList ? 0 : sx;
12925 final int scrollY = hasDisplayList ? 0 : sy;
12926 canvas.saveLayer(scrollX, scrollY,
Chet Haasebcca79a2012-02-14 08:45:14 -080012927 scrollX + mRight - mLeft, scrollY + mBottom - mTop, mLayerPaint,
Chet Haase64a48c12012-02-13 16:33:29 -080012928 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | Canvas.CLIP_TO_LAYER_SAVE_FLAG);
12929 }
12930 }
12931
12932 if (!layerRendered) {
12933 if (!hasDisplayList) {
12934 // Fast path for layouts with no backgrounds
12935 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12936 if (ViewDebug.TRACE_HIERARCHY) {
12937 ViewDebug.trace(parent, ViewDebug.HierarchyTraceType.DRAW);
12938 }
12939 mPrivateFlags &= ~DIRTY_MASK;
12940 dispatchDraw(canvas);
12941 } else {
12942 draw(canvas);
12943 }
12944 } else {
12945 mPrivateFlags &= ~DIRTY_MASK;
Chet Haase1271e2c2012-04-20 09:54:27 -070012946 ((HardwareCanvas) canvas).drawDisplayList(displayList, null, flags);
Chet Haase64a48c12012-02-13 16:33:29 -080012947 }
12948 }
12949 } else if (cache != null) {
12950 mPrivateFlags &= ~DIRTY_MASK;
12951 Paint cachePaint;
12952
12953 if (layerType == LAYER_TYPE_NONE) {
12954 cachePaint = parent.mCachePaint;
12955 if (cachePaint == null) {
12956 cachePaint = new Paint();
12957 cachePaint.setDither(false);
12958 parent.mCachePaint = cachePaint;
12959 }
Chet Haase9420abd2012-03-29 16:28:32 -070012960 if (alpha < 1) {
Chet Haase64a48c12012-02-13 16:33:29 -080012961 cachePaint.setAlpha((int) (alpha * 255));
Chet Haasea1cff502012-02-21 13:43:44 -080012962 parent.mGroupFlags |= ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE;
12963 } else if ((flags & ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE) != 0) {
Chet Haase64a48c12012-02-13 16:33:29 -080012964 cachePaint.setAlpha(255);
Chet Haasea1cff502012-02-21 13:43:44 -080012965 parent.mGroupFlags &= ~ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE;
Chet Haase64a48c12012-02-13 16:33:29 -080012966 }
12967 } else {
12968 cachePaint = mLayerPaint;
12969 cachePaint.setAlpha((int) (alpha * 255));
12970 }
12971 canvas.drawBitmap(cache, 0.0f, 0.0f, cachePaint);
12972 }
12973
Chet Haasea1cff502012-02-21 13:43:44 -080012974 if (restoreTo >= 0) {
12975 canvas.restoreToCount(restoreTo);
12976 }
Chet Haase64a48c12012-02-13 16:33:29 -080012977
12978 if (a != null && !more) {
12979 if (!hardwareAccelerated && !a.getFillAfter()) {
12980 onSetAlpha(255);
12981 }
12982 parent.finishAnimatingView(this, a);
12983 }
12984
12985 if (more && hardwareAccelerated) {
12986 // invalidation is the trigger to recreate display lists, so if we're using
12987 // display lists to render, force an invalidate to allow the animation to
12988 // continue drawing another frame
12989 parent.invalidate(true);
12990 if (a.hasAlpha() && (mPrivateFlags & ALPHA_SET) == ALPHA_SET) {
12991 // alpha animations should cause the child to recreate its display list
12992 invalidate(true);
12993 }
12994 }
12995
12996 mRecreateDisplayList = false;
12997
12998 return more;
12999 }
13000
13001 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013002 * Manually render this view (and all of its children) to the given Canvas.
13003 * The view must have already done a full layout before this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070013004 * called. When implementing a view, implement
13005 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method.
13006 * If you do need to override this method, call the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013007 *
13008 * @param canvas The Canvas to which the View is rendered.
13009 */
13010 public void draw(Canvas canvas) {
13011 if (ViewDebug.TRACE_HIERARCHY) {
13012 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
13013 }
13014
Romain Guy5bcdff42009-05-14 21:27:18 -070013015 final int privateFlags = mPrivateFlags;
13016 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
13017 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
13018 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -070013019
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013020 /*
13021 * Draw traversal performs several drawing steps which must be executed
13022 * in the appropriate order:
13023 *
13024 * 1. Draw the background
13025 * 2. If necessary, save the canvas' layers to prepare for fading
13026 * 3. Draw view's content
13027 * 4. Draw children
13028 * 5. If necessary, draw the fading edges and restore layers
13029 * 6. Draw decorations (scrollbars for instance)
13030 */
13031
13032 // Step 1, draw the background, if needed
13033 int saveCount;
13034
Romain Guy24443ea2009-05-11 11:56:30 -070013035 if (!dirtyOpaque) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013036 final Drawable background = mBackground;
Romain Guy24443ea2009-05-11 11:56:30 -070013037 if (background != null) {
13038 final int scrollX = mScrollX;
13039 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013040
Romain Guy24443ea2009-05-11 11:56:30 -070013041 if (mBackgroundSizeChanged) {
13042 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
13043 mBackgroundSizeChanged = false;
13044 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013045
Romain Guy24443ea2009-05-11 11:56:30 -070013046 if ((scrollX | scrollY) == 0) {
13047 background.draw(canvas);
13048 } else {
13049 canvas.translate(scrollX, scrollY);
13050 background.draw(canvas);
13051 canvas.translate(-scrollX, -scrollY);
13052 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013053 }
13054 }
13055
13056 // skip step 2 & 5 if possible (common case)
13057 final int viewFlags = mViewFlags;
13058 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
13059 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
13060 if (!verticalEdges && !horizontalEdges) {
13061 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070013062 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013063
13064 // Step 4, draw the children
13065 dispatchDraw(canvas);
13066
13067 // Step 6, draw decorations (scrollbars)
13068 onDrawScrollBars(canvas);
13069
13070 // we're done...
13071 return;
13072 }
13073
13074 /*
13075 * Here we do the full fledged routine...
13076 * (this is an uncommon case where speed matters less,
13077 * this is why we repeat some of the tests that have been
13078 * done above)
13079 */
13080
13081 boolean drawTop = false;
13082 boolean drawBottom = false;
13083 boolean drawLeft = false;
13084 boolean drawRight = false;
13085
13086 float topFadeStrength = 0.0f;
13087 float bottomFadeStrength = 0.0f;
13088 float leftFadeStrength = 0.0f;
13089 float rightFadeStrength = 0.0f;
13090
13091 // Step 2, save the canvas' layers
13092 int paddingLeft = mPaddingLeft;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013093
13094 final boolean offsetRequired = isPaddingOffsetRequired();
13095 if (offsetRequired) {
13096 paddingLeft += getLeftPaddingOffset();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013097 }
13098
13099 int left = mScrollX + paddingLeft;
13100 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
Romain Guyf2fc4602011-07-19 15:20:03 -070013101 int top = mScrollY + getFadeTop(offsetRequired);
13102 int bottom = top + getFadeHeight(offsetRequired);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013103
13104 if (offsetRequired) {
13105 right += getRightPaddingOffset();
13106 bottom += getBottomPaddingOffset();
13107 }
13108
13109 final ScrollabilityCache scrollabilityCache = mScrollCache;
Philip Milne6c8ea062012-04-03 17:38:43 -070013110 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013111 int length = (int) fadeHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013112
13113 // clip the fade length if top and bottom fades overlap
13114 // overlapping fades produce odd-looking artifacts
13115 if (verticalEdges && (top + length > bottom - length)) {
13116 length = (bottom - top) / 2;
13117 }
13118
13119 // also clip horizontal fades if necessary
13120 if (horizontalEdges && (left + length > right - length)) {
13121 length = (right - left) / 2;
13122 }
13123
13124 if (verticalEdges) {
13125 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013126 drawTop = topFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013127 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013128 drawBottom = bottomFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013129 }
13130
13131 if (horizontalEdges) {
13132 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013133 drawLeft = leftFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013134 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013135 drawRight = rightFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013136 }
13137
13138 saveCount = canvas.getSaveCount();
13139
13140 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -070013141 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013142 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
13143
13144 if (drawTop) {
13145 canvas.saveLayer(left, top, right, top + length, null, flags);
13146 }
13147
13148 if (drawBottom) {
13149 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
13150 }
13151
13152 if (drawLeft) {
13153 canvas.saveLayer(left, top, left + length, bottom, null, flags);
13154 }
13155
13156 if (drawRight) {
13157 canvas.saveLayer(right - length, top, right, bottom, null, flags);
13158 }
13159 } else {
13160 scrollabilityCache.setFadeColor(solidColor);
13161 }
13162
13163 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070013164 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013165
13166 // Step 4, draw the children
13167 dispatchDraw(canvas);
13168
13169 // Step 5, draw the fade effect and restore layers
13170 final Paint p = scrollabilityCache.paint;
13171 final Matrix matrix = scrollabilityCache.matrix;
13172 final Shader fade = scrollabilityCache.shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013173
13174 if (drawTop) {
13175 matrix.setScale(1, fadeHeight * topFadeStrength);
13176 matrix.postTranslate(left, top);
13177 fade.setLocalMatrix(matrix);
13178 canvas.drawRect(left, top, right, top + length, p);
13179 }
13180
13181 if (drawBottom) {
13182 matrix.setScale(1, fadeHeight * bottomFadeStrength);
13183 matrix.postRotate(180);
13184 matrix.postTranslate(left, bottom);
13185 fade.setLocalMatrix(matrix);
13186 canvas.drawRect(left, bottom - length, right, bottom, p);
13187 }
13188
13189 if (drawLeft) {
13190 matrix.setScale(1, fadeHeight * leftFadeStrength);
13191 matrix.postRotate(-90);
13192 matrix.postTranslate(left, top);
13193 fade.setLocalMatrix(matrix);
13194 canvas.drawRect(left, top, left + length, bottom, p);
13195 }
13196
13197 if (drawRight) {
13198 matrix.setScale(1, fadeHeight * rightFadeStrength);
13199 matrix.postRotate(90);
13200 matrix.postTranslate(right, top);
13201 fade.setLocalMatrix(matrix);
13202 canvas.drawRect(right - length, top, right, bottom, p);
13203 }
13204
13205 canvas.restoreToCount(saveCount);
13206
13207 // Step 6, draw decorations (scrollbars)
13208 onDrawScrollBars(canvas);
13209 }
13210
13211 /**
13212 * Override this if your view is known to always be drawn on top of a solid color background,
13213 * and needs to draw fading edges. Returning a non-zero color enables the view system to
13214 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
13215 * should be set to 0xFF.
13216 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013217 * @see #setVerticalFadingEdgeEnabled(boolean)
13218 * @see #setHorizontalFadingEdgeEnabled(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013219 *
13220 * @return The known solid color background for this view, or 0 if the color may vary
13221 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013222 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013223 public int getSolidColor() {
13224 return 0;
13225 }
13226
13227 /**
13228 * Build a human readable string representation of the specified view flags.
13229 *
13230 * @param flags the view flags to convert to a string
13231 * @return a String representing the supplied flags
13232 */
13233 private static String printFlags(int flags) {
13234 String output = "";
13235 int numFlags = 0;
13236 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
13237 output += "TAKES_FOCUS";
13238 numFlags++;
13239 }
13240
13241 switch (flags & VISIBILITY_MASK) {
13242 case INVISIBLE:
13243 if (numFlags > 0) {
13244 output += " ";
13245 }
13246 output += "INVISIBLE";
13247 // USELESS HERE numFlags++;
13248 break;
13249 case GONE:
13250 if (numFlags > 0) {
13251 output += " ";
13252 }
13253 output += "GONE";
13254 // USELESS HERE numFlags++;
13255 break;
13256 default:
13257 break;
13258 }
13259 return output;
13260 }
13261
13262 /**
13263 * Build a human readable string representation of the specified private
13264 * view flags.
13265 *
13266 * @param privateFlags the private view flags to convert to a string
13267 * @return a String representing the supplied flags
13268 */
13269 private static String printPrivateFlags(int privateFlags) {
13270 String output = "";
13271 int numFlags = 0;
13272
13273 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
13274 output += "WANTS_FOCUS";
13275 numFlags++;
13276 }
13277
13278 if ((privateFlags & FOCUSED) == FOCUSED) {
13279 if (numFlags > 0) {
13280 output += " ";
13281 }
13282 output += "FOCUSED";
13283 numFlags++;
13284 }
13285
13286 if ((privateFlags & SELECTED) == SELECTED) {
13287 if (numFlags > 0) {
13288 output += " ";
13289 }
13290 output += "SELECTED";
13291 numFlags++;
13292 }
13293
13294 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
13295 if (numFlags > 0) {
13296 output += " ";
13297 }
13298 output += "IS_ROOT_NAMESPACE";
13299 numFlags++;
13300 }
13301
13302 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
13303 if (numFlags > 0) {
13304 output += " ";
13305 }
13306 output += "HAS_BOUNDS";
13307 numFlags++;
13308 }
13309
13310 if ((privateFlags & DRAWN) == DRAWN) {
13311 if (numFlags > 0) {
13312 output += " ";
13313 }
13314 output += "DRAWN";
13315 // USELESS HERE numFlags++;
13316 }
13317 return output;
13318 }
13319
13320 /**
13321 * <p>Indicates whether or not this view's layout will be requested during
13322 * the next hierarchy layout pass.</p>
13323 *
13324 * @return true if the layout will be forced during next layout pass
13325 */
13326 public boolean isLayoutRequested() {
13327 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
13328 }
13329
13330 /**
13331 * Assign a size and position to a view and all of its
13332 * descendants
13333 *
13334 * <p>This is the second phase of the layout mechanism.
13335 * (The first is measuring). In this phase, each parent calls
13336 * layout on all of its children to position them.
13337 * This is typically done using the child measurements
Chet Haase9c087442011-01-12 16:20:16 -080013338 * that were stored in the measure pass().</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013339 *
Chet Haase9c087442011-01-12 16:20:16 -080013340 * <p>Derived classes should not override this method.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013341 * Derived classes with children should override
13342 * onLayout. In that method, they should
Chet Haase9c087442011-01-12 16:20:16 -080013343 * call layout on each of their children.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013344 *
13345 * @param l Left position, relative to parent
13346 * @param t Top position, relative to parent
13347 * @param r Right position, relative to parent
13348 * @param b Bottom position, relative to parent
13349 */
Romain Guy5429e1d2010-09-07 12:38:00 -070013350 @SuppressWarnings({"unchecked"})
Chet Haase9c087442011-01-12 16:20:16 -080013351 public void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -070013352 int oldL = mLeft;
13353 int oldT = mTop;
13354 int oldB = mBottom;
13355 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013356 boolean changed = setFrame(l, t, r, b);
13357 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
13358 if (ViewDebug.TRACE_HIERARCHY) {
13359 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
13360 }
13361
13362 onLayout(changed, l, t, r, b);
13363 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -070013364
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070013365 ListenerInfo li = mListenerInfo;
13366 if (li != null && li.mOnLayoutChangeListeners != null) {
Chet Haase21cd1382010-09-01 17:42:29 -070013367 ArrayList<OnLayoutChangeListener> listenersCopy =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070013368 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone();
Chet Haase21cd1382010-09-01 17:42:29 -070013369 int numListeners = listenersCopy.size();
13370 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -070013371 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -070013372 }
13373 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013374 }
13375 mPrivateFlags &= ~FORCE_LAYOUT;
13376 }
13377
13378 /**
13379 * Called from layout when this view should
13380 * assign a size and position to each of its children.
13381 *
13382 * Derived classes with children should override
13383 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -070013384 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013385 * @param changed This is a new size or position for this view
13386 * @param left Left position, relative to parent
13387 * @param top Top position, relative to parent
13388 * @param right Right position, relative to parent
13389 * @param bottom Bottom position, relative to parent
13390 */
13391 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
13392 }
13393
13394 /**
13395 * Assign a size and position to this view.
13396 *
13397 * This is called from layout.
13398 *
13399 * @param left Left position, relative to parent
13400 * @param top Top position, relative to parent
13401 * @param right Right position, relative to parent
13402 * @param bottom Bottom position, relative to parent
13403 * @return true if the new size and position are different than the
13404 * previous ones
13405 * {@hide}
13406 */
13407 protected boolean setFrame(int left, int top, int right, int bottom) {
13408 boolean changed = false;
13409
13410 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -070013411 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013412 + right + "," + bottom + ")");
13413 }
13414
13415 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
13416 changed = true;
13417
13418 // Remember our drawn bit
13419 int drawn = mPrivateFlags & DRAWN;
13420
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013421 int oldWidth = mRight - mLeft;
13422 int oldHeight = mBottom - mTop;
Chet Haase75755e22011-07-18 17:48:25 -070013423 int newWidth = right - left;
13424 int newHeight = bottom - top;
13425 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight);
13426
13427 // Invalidate our old position
13428 invalidate(sizeChanged);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013429
13430 mLeft = left;
13431 mTop = top;
13432 mRight = right;
13433 mBottom = bottom;
Chet Haase1271e2c2012-04-20 09:54:27 -070013434 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080013435 mDisplayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom);
13436 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013437
13438 mPrivateFlags |= HAS_BOUNDS;
13439
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013440
Chet Haase75755e22011-07-18 17:48:25 -070013441 if (sizeChanged) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013442 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
13443 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -070013444 if (mTransformationInfo != null) {
13445 mTransformationInfo.mMatrixDirty = true;
13446 }
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013447 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013448 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
13449 }
13450
13451 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
13452 // If we are visible, force the DRAWN bit to on so that
13453 // this invalidate will go through (at least to our parent).
13454 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013455 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013456 // the DRAWN bit.
13457 mPrivateFlags |= DRAWN;
Chet Haase75755e22011-07-18 17:48:25 -070013458 invalidate(sizeChanged);
Chet Haasef28595e2011-01-31 18:52:12 -080013459 // parent display list may need to be recreated based on a change in the bounds
13460 // of any child
13461 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013462 }
13463
13464 // Reset drawn bit to original value (invalidate turns it off)
13465 mPrivateFlags |= drawn;
13466
13467 mBackgroundSizeChanged = true;
13468 }
13469 return changed;
13470 }
13471
13472 /**
13473 * Finalize inflating a view from XML. This is called as the last phase
13474 * of inflation, after all child views have been added.
13475 *
13476 * <p>Even if the subclass overrides onFinishInflate, they should always be
13477 * sure to call the super method, so that we get called.
13478 */
13479 protected void onFinishInflate() {
13480 }
13481
13482 /**
13483 * Returns the resources associated with this view.
13484 *
13485 * @return Resources object.
13486 */
13487 public Resources getResources() {
13488 return mResources;
13489 }
13490
13491 /**
13492 * Invalidates the specified Drawable.
13493 *
13494 * @param drawable the drawable to invalidate
13495 */
13496 public void invalidateDrawable(Drawable drawable) {
13497 if (verifyDrawable(drawable)) {
13498 final Rect dirty = drawable.getBounds();
13499 final int scrollX = mScrollX;
13500 final int scrollY = mScrollY;
13501
13502 invalidate(dirty.left + scrollX, dirty.top + scrollY,
13503 dirty.right + scrollX, dirty.bottom + scrollY);
13504 }
13505 }
13506
13507 /**
13508 * Schedules an action on a drawable to occur at a specified time.
13509 *
13510 * @param who the recipient of the action
13511 * @param what the action to run on the drawable
13512 * @param when the time at which the action must occur. Uses the
13513 * {@link SystemClock#uptimeMillis} timebase.
13514 */
13515 public void scheduleDrawable(Drawable who, Runnable what, long when) {
Adam Powell37419d72011-11-10 11:32:09 -080013516 if (verifyDrawable(who) && what != null) {
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080013517 final long delay = when - SystemClock.uptimeMillis();
Adam Powell37419d72011-11-10 11:32:09 -080013518 if (mAttachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013519 mAttachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed(
13520 Choreographer.CALLBACK_ANIMATION, what, who,
13521 Choreographer.subtractFrameDelay(delay));
Adam Powell37419d72011-11-10 11:32:09 -080013522 } else {
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080013523 ViewRootImpl.getRunQueue().postDelayed(what, delay);
Adam Powell37419d72011-11-10 11:32:09 -080013524 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013525 }
13526 }
13527
13528 /**
13529 * Cancels a scheduled action on a drawable.
13530 *
13531 * @param who the recipient of the action
13532 * @param what the action to cancel
13533 */
13534 public void unscheduleDrawable(Drawable who, Runnable what) {
Adam Powell37419d72011-11-10 11:32:09 -080013535 if (verifyDrawable(who) && what != null) {
13536 if (mAttachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013537 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
13538 Choreographer.CALLBACK_ANIMATION, what, who);
Adam Powell37419d72011-11-10 11:32:09 -080013539 } else {
13540 ViewRootImpl.getRunQueue().removeCallbacks(what);
13541 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013542 }
13543 }
13544
13545 /**
13546 * Unschedule any events associated with the given Drawable. This can be
13547 * used when selecting a new Drawable into a view, so that the previous
13548 * one is completely unscheduled.
13549 *
13550 * @param who The Drawable to unschedule.
13551 *
13552 * @see #drawableStateChanged
13553 */
13554 public void unscheduleDrawable(Drawable who) {
Jeff Brown43ea54b2012-03-09 14:37:48 -080013555 if (mAttachInfo != null && who != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013556 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
13557 Choreographer.CALLBACK_ANIMATION, null, who);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013558 }
13559 }
13560
Fabrice Di Meglioc0053222011-06-13 12:16:51 -070013561 /**
13562 * Return the layout direction of a given Drawable.
13563 *
13564 * @param who the Drawable to query
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070013565 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -070013566 */
13567 public int getResolvedLayoutDirection(Drawable who) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013568 return (who == mBackground) ? getResolvedLayoutDirection() : LAYOUT_DIRECTION_DEFAULT;
Fabrice Di Meglio6a036402011-05-23 14:43:23 -070013569 }
13570
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013571 /**
13572 * If your view subclass is displaying its own Drawable objects, it should
13573 * override this function and return true for any Drawable it is
13574 * displaying. This allows animations for those drawables to be
13575 * scheduled.
13576 *
13577 * <p>Be sure to call through to the super class when overriding this
13578 * function.
13579 *
13580 * @param who The Drawable to verify. Return true if it is one you are
13581 * displaying, else return the result of calling through to the
13582 * super class.
13583 *
13584 * @return boolean If true than the Drawable is being displayed in the
13585 * view; else false and it is not allowed to animate.
13586 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013587 * @see #unscheduleDrawable(android.graphics.drawable.Drawable)
13588 * @see #drawableStateChanged()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013589 */
13590 protected boolean verifyDrawable(Drawable who) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013591 return who == mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013592 }
13593
13594 /**
13595 * This function is called whenever the state of the view changes in such
13596 * a way that it impacts the state of drawables being shown.
13597 *
13598 * <p>Be sure to call through to the superclass when overriding this
13599 * function.
13600 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013601 * @see Drawable#setState(int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013602 */
13603 protected void drawableStateChanged() {
Philip Milne6c8ea062012-04-03 17:38:43 -070013604 Drawable d = mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013605 if (d != null && d.isStateful()) {
13606 d.setState(getDrawableState());
13607 }
13608 }
13609
13610 /**
13611 * Call this to force a view to update its drawable state. This will cause
13612 * drawableStateChanged to be called on this view. Views that are interested
13613 * in the new state should call getDrawableState.
13614 *
13615 * @see #drawableStateChanged
13616 * @see #getDrawableState
13617 */
13618 public void refreshDrawableState() {
13619 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
13620 drawableStateChanged();
13621
13622 ViewParent parent = mParent;
13623 if (parent != null) {
13624 parent.childDrawableStateChanged(this);
13625 }
13626 }
13627
13628 /**
13629 * Return an array of resource IDs of the drawable states representing the
13630 * current state of the view.
13631 *
13632 * @return The current drawable state
13633 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013634 * @see Drawable#setState(int[])
13635 * @see #drawableStateChanged()
13636 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013637 */
13638 public final int[] getDrawableState() {
13639 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
13640 return mDrawableState;
13641 } else {
13642 mDrawableState = onCreateDrawableState(0);
13643 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
13644 return mDrawableState;
13645 }
13646 }
13647
13648 /**
13649 * Generate the new {@link android.graphics.drawable.Drawable} state for
13650 * this view. This is called by the view
13651 * system when the cached Drawable state is determined to be invalid. To
13652 * retrieve the current state, you should use {@link #getDrawableState}.
13653 *
13654 * @param extraSpace if non-zero, this is the number of extra entries you
13655 * would like in the returned array in which you can place your own
13656 * states.
13657 *
13658 * @return Returns an array holding the current {@link Drawable} state of
13659 * the view.
13660 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013661 * @see #mergeDrawableStates(int[], int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013662 */
13663 protected int[] onCreateDrawableState(int extraSpace) {
13664 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
13665 mParent instanceof View) {
13666 return ((View) mParent).onCreateDrawableState(extraSpace);
13667 }
13668
13669 int[] drawableState;
13670
13671 int privateFlags = mPrivateFlags;
13672
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013673 int viewStateIndex = 0;
13674 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
13675 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
13676 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -070013677 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013678 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
13679 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Adam Powell5a7e94e2011-04-25 15:30:43 -070013680 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested &&
13681 HardwareRenderer.isAvailable()) {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080013682 // This is set if HW acceleration is requested, even if the current
13683 // process doesn't allow it. This is just to allow app preview
13684 // windows to better match their app.
13685 viewStateIndex |= VIEW_STATE_ACCELERATED;
13686 }
PY Laligandc33d8d49e2011-03-14 18:22:53 -070013687 if ((privateFlags & HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013688
Christopher Tate3d4bf172011-03-28 16:16:46 -070013689 final int privateFlags2 = mPrivateFlags2;
13690 if ((privateFlags2 & DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT;
13691 if ((privateFlags2 & DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED;
13692
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013693 drawableState = VIEW_STATE_SETS[viewStateIndex];
13694
13695 //noinspection ConstantIfStatement
13696 if (false) {
13697 Log.i("View", "drawableStateIndex=" + viewStateIndex);
13698 Log.i("View", toString()
13699 + " pressed=" + ((privateFlags & PRESSED) != 0)
13700 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
13701 + " fo=" + hasFocus()
13702 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013703 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013704 + ": " + Arrays.toString(drawableState));
13705 }
13706
13707 if (extraSpace == 0) {
13708 return drawableState;
13709 }
13710
13711 final int[] fullState;
13712 if (drawableState != null) {
13713 fullState = new int[drawableState.length + extraSpace];
13714 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
13715 } else {
13716 fullState = new int[extraSpace];
13717 }
13718
13719 return fullState;
13720 }
13721
13722 /**
13723 * Merge your own state values in <var>additionalState</var> into the base
13724 * state values <var>baseState</var> that were returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070013725 * {@link #onCreateDrawableState(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013726 *
13727 * @param baseState The base state values returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070013728 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013729 * own additional state values.
13730 *
13731 * @param additionalState The additional state values you would like
13732 * added to <var>baseState</var>; this array is not modified.
13733 *
13734 * @return As a convenience, the <var>baseState</var> array you originally
13735 * passed into the function is returned.
13736 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013737 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013738 */
13739 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
13740 final int N = baseState.length;
13741 int i = N - 1;
13742 while (i >= 0 && baseState[i] == 0) {
13743 i--;
13744 }
13745 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
13746 return baseState;
13747 }
13748
13749 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -070013750 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
13751 * on all Drawable objects associated with this view.
13752 */
13753 public void jumpDrawablesToCurrentState() {
Philip Milne6c8ea062012-04-03 17:38:43 -070013754 if (mBackground != null) {
13755 mBackground.jumpToCurrentState();
Dianne Hackborn079e2352010-10-18 17:02:43 -070013756 }
13757 }
13758
13759 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013760 * Sets the background color for this view.
13761 * @param color the color of the background
13762 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000013763 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013764 public void setBackgroundColor(int color) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013765 if (mBackground instanceof ColorDrawable) {
13766 ((ColorDrawable) mBackground).setColor(color);
Chet Haase70d4ba12010-10-06 09:46:45 -070013767 } else {
Philip Milne6c8ea062012-04-03 17:38:43 -070013768 setBackground(new ColorDrawable(color));
Chet Haase70d4ba12010-10-06 09:46:45 -070013769 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013770 }
13771
13772 /**
13773 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -070013774 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013775 * @param resid The identifier of the resource.
Philip Milne6c8ea062012-04-03 17:38:43 -070013776 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013777 * @attr ref android.R.styleable#View_background
13778 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000013779 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013780 public void setBackgroundResource(int resid) {
13781 if (resid != 0 && resid == mBackgroundResource) {
13782 return;
13783 }
13784
13785 Drawable d= null;
13786 if (resid != 0) {
13787 d = mResources.getDrawable(resid);
13788 }
Philip Milne6c8ea062012-04-03 17:38:43 -070013789 setBackground(d);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013790
13791 mBackgroundResource = resid;
13792 }
13793
13794 /**
13795 * Set the background to a given Drawable, or remove the background. If the
13796 * background has padding, this View's padding is set to the background's
13797 * padding. However, when a background is removed, this View's padding isn't
13798 * touched. If setting the padding is desired, please use
13799 * {@link #setPadding(int, int, int, int)}.
13800 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013801 * @param background The Drawable to use as the background, or null to remove the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013802 * background
13803 */
Philip Milne6c8ea062012-04-03 17:38:43 -070013804 public void setBackground(Drawable background) {
Romain Guyeb378892012-04-12 11:33:14 -070013805 //noinspection deprecation
Philip Milne6c8ea062012-04-03 17:38:43 -070013806 setBackgroundDrawable(background);
13807 }
13808
13809 /**
13810 * @deprecated use {@link #setBackground(Drawable)} instead
13811 */
13812 @Deprecated
13813 public void setBackgroundDrawable(Drawable background) {
13814 if (background == mBackground) {
Adam Powell4d36ec12011-07-17 16:44:16 -070013815 return;
13816 }
13817
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013818 boolean requestLayout = false;
13819
13820 mBackgroundResource = 0;
13821
13822 /*
13823 * Regardless of whether we're setting a new background or not, we want
13824 * to clear the previous drawable.
13825 */
Philip Milne6c8ea062012-04-03 17:38:43 -070013826 if (mBackground != null) {
13827 mBackground.setCallback(null);
13828 unscheduleDrawable(mBackground);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013829 }
13830
Philip Milne6c8ea062012-04-03 17:38:43 -070013831 if (background != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013832 Rect padding = sThreadLocal.get();
13833 if (padding == null) {
13834 padding = new Rect();
13835 sThreadLocal.set(padding);
13836 }
Philip Milne6c8ea062012-04-03 17:38:43 -070013837 if (background.getPadding(padding)) {
13838 switch (background.getResolvedLayoutDirectionSelf()) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070013839 case LAYOUT_DIRECTION_RTL:
13840 setPadding(padding.right, padding.top, padding.left, padding.bottom);
13841 break;
13842 case LAYOUT_DIRECTION_LTR:
13843 default:
13844 setPadding(padding.left, padding.top, padding.right, padding.bottom);
13845 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013846 }
13847
13848 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
13849 // if it has a different minimum size, we should layout again
Philip Milne6c8ea062012-04-03 17:38:43 -070013850 if (mBackground == null || mBackground.getMinimumHeight() != background.getMinimumHeight() ||
13851 mBackground.getMinimumWidth() != background.getMinimumWidth()) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013852 requestLayout = true;
13853 }
13854
Philip Milne6c8ea062012-04-03 17:38:43 -070013855 background.setCallback(this);
13856 if (background.isStateful()) {
13857 background.setState(getDrawableState());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013858 }
Philip Milne6c8ea062012-04-03 17:38:43 -070013859 background.setVisible(getVisibility() == VISIBLE, false);
13860 mBackground = background;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013861
13862 if ((mPrivateFlags & SKIP_DRAW) != 0) {
13863 mPrivateFlags &= ~SKIP_DRAW;
13864 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
13865 requestLayout = true;
13866 }
13867 } else {
13868 /* Remove the background */
Philip Milne6c8ea062012-04-03 17:38:43 -070013869 mBackground = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013870
13871 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
13872 /*
13873 * This view ONLY drew the background before and we're removing
13874 * the background, so now it won't draw anything
13875 * (hence we SKIP_DRAW)
13876 */
13877 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
13878 mPrivateFlags |= SKIP_DRAW;
13879 }
13880
13881 /*
13882 * When the background is set, we try to apply its padding to this
13883 * View. When the background is removed, we don't touch this View's
13884 * padding. This is noted in the Javadocs. Hence, we don't need to
13885 * requestLayout(), the invalidate() below is sufficient.
13886 */
13887
13888 // The old background's minimum size could have affected this
13889 // View's layout, so let's requestLayout
13890 requestLayout = true;
13891 }
13892
Romain Guy8f1344f52009-05-15 16:03:59 -070013893 computeOpaqueFlags();
13894
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013895 if (requestLayout) {
13896 requestLayout();
13897 }
13898
13899 mBackgroundSizeChanged = true;
Romain Guy0fd89bf2011-01-26 15:41:30 -080013900 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013901 }
13902
13903 /**
13904 * Gets the background drawable
Philip Milne6c8ea062012-04-03 17:38:43 -070013905 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013906 * @return The drawable used as the background for this view, if any.
Philip Milne6c8ea062012-04-03 17:38:43 -070013907 *
13908 * @see #setBackground(Drawable)
13909 *
13910 * @attr ref android.R.styleable#View_background
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013911 */
13912 public Drawable getBackground() {
Philip Milne6c8ea062012-04-03 17:38:43 -070013913 return mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013914 }
13915
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013916 /**
13917 * Sets the padding. The view may add on the space required to display
13918 * the scrollbars, depending on the style and visibility of the scrollbars.
13919 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
13920 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
13921 * from the values set in this call.
13922 *
13923 * @attr ref android.R.styleable#View_padding
13924 * @attr ref android.R.styleable#View_paddingBottom
13925 * @attr ref android.R.styleable#View_paddingLeft
13926 * @attr ref android.R.styleable#View_paddingRight
13927 * @attr ref android.R.styleable#View_paddingTop
13928 * @param left the left padding in pixels
13929 * @param top the top padding in pixels
13930 * @param right the right padding in pixels
13931 * @param bottom the bottom padding in pixels
13932 */
13933 public void setPadding(int left, int top, int right, int bottom) {
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080013934 mUserPaddingStart = -1;
13935 mUserPaddingEnd = -1;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070013936 mUserPaddingRelative = false;
13937
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080013938 internalSetPadding(left, top, right, bottom);
13939 }
13940
13941 private void internalSetPadding(int left, int top, int right, int bottom) {
Adam Powell20232d02010-12-08 21:08:53 -080013942 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013943 mUserPaddingRight = right;
13944 mUserPaddingBottom = bottom;
13945
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070013946 final int viewFlags = mViewFlags;
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080013947 boolean changed = false;
Romain Guy8506ab42009-06-11 17:35:47 -070013948
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070013949 // Common case is there are no scroll bars.
13950 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070013951 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -080013952 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070013953 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -080013954 switch (mVerticalScrollbarPosition) {
13955 case SCROLLBAR_POSITION_DEFAULT:
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070013956 if (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
13957 left += offset;
13958 } else {
13959 right += offset;
13960 }
13961 break;
Adam Powell20232d02010-12-08 21:08:53 -080013962 case SCROLLBAR_POSITION_RIGHT:
13963 right += offset;
13964 break;
13965 case SCROLLBAR_POSITION_LEFT:
13966 left += offset;
13967 break;
13968 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070013969 }
Adam Powell20232d02010-12-08 21:08:53 -080013970 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070013971 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
13972 ? 0 : getHorizontalScrollbarHeight();
13973 }
13974 }
Romain Guy8506ab42009-06-11 17:35:47 -070013975
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070013976 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013977 changed = true;
13978 mPaddingLeft = left;
13979 }
13980 if (mPaddingTop != top) {
13981 changed = true;
13982 mPaddingTop = top;
13983 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070013984 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013985 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070013986 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013987 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070013988 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013989 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070013990 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013991 }
13992
13993 if (changed) {
13994 requestLayout();
13995 }
13996 }
13997
13998 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070013999 * Sets the relative padding. The view may add on the space required to display
14000 * the scrollbars, depending on the style and visibility of the scrollbars.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014001 * from the values set in this call.
14002 *
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014003 * @param start the start padding in pixels
14004 * @param top the top padding in pixels
14005 * @param end the end padding in pixels
14006 * @param bottom the bottom padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014007 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014008 */
14009 public void setPaddingRelative(int start, int top, int end, int bottom) {
Fabrice Di Megliof9e36502011-06-21 18:41:48 -070014010 mUserPaddingStart = start;
14011 mUserPaddingEnd = end;
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014012 mUserPaddingRelative = true;
Fabrice Di Megliof9e36502011-06-21 18:41:48 -070014013
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014014 switch(getResolvedLayoutDirection()) {
14015 case LAYOUT_DIRECTION_RTL:
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014016 internalSetPadding(end, top, start, bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014017 break;
14018 case LAYOUT_DIRECTION_LTR:
14019 default:
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014020 internalSetPadding(start, top, end, bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014021 }
14022 }
14023
14024 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014025 * Returns the top padding of this view.
14026 *
14027 * @return the top padding in pixels
14028 */
14029 public int getPaddingTop() {
14030 return mPaddingTop;
14031 }
14032
14033 /**
14034 * Returns the bottom padding of this view. If there are inset and enabled
14035 * scrollbars, this value may include the space required to display the
14036 * scrollbars as well.
14037 *
14038 * @return the bottom padding in pixels
14039 */
14040 public int getPaddingBottom() {
14041 return mPaddingBottom;
14042 }
14043
14044 /**
14045 * Returns the left padding of this view. If there are inset and enabled
14046 * scrollbars, this value may include the space required to display the
14047 * scrollbars as well.
14048 *
14049 * @return the left padding in pixels
14050 */
14051 public int getPaddingLeft() {
14052 return mPaddingLeft;
14053 }
14054
14055 /**
Fabrice Di Meglio30a21e12012-03-12 13:12:19 -070014056 * Returns the start padding of this view depending on its resolved layout direction.
14057 * If there are inset and enabled scrollbars, this value may include the space
14058 * required to display the scrollbars as well.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014059 *
14060 * @return the start padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014061 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014062 */
14063 public int getPaddingStart() {
14064 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
14065 mPaddingRight : mPaddingLeft;
14066 }
14067
14068 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014069 * Returns the right padding of this view. If there are inset and enabled
14070 * scrollbars, this value may include the space required to display the
14071 * scrollbars as well.
14072 *
14073 * @return the right padding in pixels
14074 */
14075 public int getPaddingRight() {
14076 return mPaddingRight;
14077 }
14078
14079 /**
Fabrice Di Meglio30a21e12012-03-12 13:12:19 -070014080 * Returns the end padding of this view depending on its resolved layout direction.
14081 * If there are inset and enabled scrollbars, this value may include the space
14082 * required to display the scrollbars as well.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014083 *
14084 * @return the end padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014085 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014086 */
14087 public int getPaddingEnd() {
14088 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
14089 mPaddingLeft : mPaddingRight;
14090 }
14091
14092 /**
14093 * Return if the padding as been set thru relative values
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014094 * {@link #setPaddingRelative(int, int, int, int)}
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014095 *
14096 * @return true if the padding is relative or false if it is not.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014097 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014098 */
14099 public boolean isPaddingRelative() {
14100 return mUserPaddingRelative;
14101 }
14102
14103 /**
Philip Milne1557fd72012-04-04 23:41:34 -070014104 * @hide
14105 */
Philip Milne7a23b492012-04-24 22:12:36 -070014106 public Insets getOpticalInsets() {
Philip Milne1557fd72012-04-04 23:41:34 -070014107 if (mLayoutInsets == null) {
Philip Milnebbd51f12012-04-18 15:09:05 -070014108 mLayoutInsets = (mBackground == null) ? Insets.NONE : mBackground.getLayoutInsets();
Philip Milne1557fd72012-04-04 23:41:34 -070014109 }
14110 return mLayoutInsets;
14111 }
14112
14113 /**
14114 * @hide
14115 */
14116 public void setLayoutInsets(Insets layoutInsets) {
14117 mLayoutInsets = layoutInsets;
14118 }
14119
14120 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014121 * Changes the selection state of this view. A view can be selected or not.
14122 * Note that selection is not the same as focus. Views are typically
14123 * selected in the context of an AdapterView like ListView or GridView;
14124 * the selected view is the view that is highlighted.
14125 *
14126 * @param selected true if the view must be selected, false otherwise
14127 */
14128 public void setSelected(boolean selected) {
14129 if (((mPrivateFlags & SELECTED) != 0) != selected) {
14130 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -070014131 if (!selected) resetPressedState();
Romain Guy0fd89bf2011-01-26 15:41:30 -080014132 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014133 refreshDrawableState();
14134 dispatchSetSelected(selected);
Svetoslav Ganov42138042012-03-20 11:51:39 -070014135 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
14136 notifyAccessibilityStateChanged();
14137 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014138 }
14139 }
14140
14141 /**
14142 * Dispatch setSelected to all of this View's children.
14143 *
14144 * @see #setSelected(boolean)
14145 *
14146 * @param selected The new selected state
14147 */
14148 protected void dispatchSetSelected(boolean selected) {
14149 }
14150
14151 /**
14152 * Indicates the selection state of this view.
14153 *
14154 * @return true if the view is selected, false otherwise
14155 */
14156 @ViewDebug.ExportedProperty
14157 public boolean isSelected() {
14158 return (mPrivateFlags & SELECTED) != 0;
14159 }
14160
14161 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014162 * Changes the activated state of this view. A view can be activated or not.
14163 * Note that activation is not the same as selection. Selection is
14164 * a transient property, representing the view (hierarchy) the user is
14165 * currently interacting with. Activation is a longer-term state that the
14166 * user can move views in and out of. For example, in a list view with
14167 * single or multiple selection enabled, the views in the current selection
14168 * set are activated. (Um, yeah, we are deeply sorry about the terminology
14169 * here.) The activated state is propagated down to children of the view it
14170 * is set on.
14171 *
14172 * @param activated true if the view must be activated, false otherwise
14173 */
14174 public void setActivated(boolean activated) {
14175 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
14176 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
Romain Guy0fd89bf2011-01-26 15:41:30 -080014177 invalidate(true);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014178 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -070014179 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014180 }
14181 }
14182
14183 /**
14184 * Dispatch setActivated to all of this View's children.
14185 *
14186 * @see #setActivated(boolean)
14187 *
14188 * @param activated The new activated state
14189 */
14190 protected void dispatchSetActivated(boolean activated) {
14191 }
14192
14193 /**
14194 * Indicates the activation state of this view.
14195 *
14196 * @return true if the view is activated, false otherwise
14197 */
14198 @ViewDebug.ExportedProperty
14199 public boolean isActivated() {
14200 return (mPrivateFlags & ACTIVATED) != 0;
14201 }
14202
14203 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014204 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
14205 * observer can be used to get notifications when global events, like
14206 * layout, happen.
14207 *
14208 * The returned ViewTreeObserver observer is not guaranteed to remain
14209 * valid for the lifetime of this View. If the caller of this method keeps
14210 * a long-lived reference to ViewTreeObserver, it should always check for
14211 * the return value of {@link ViewTreeObserver#isAlive()}.
14212 *
14213 * @return The ViewTreeObserver for this view's hierarchy.
14214 */
14215 public ViewTreeObserver getViewTreeObserver() {
14216 if (mAttachInfo != null) {
14217 return mAttachInfo.mTreeObserver;
14218 }
14219 if (mFloatingTreeObserver == null) {
14220 mFloatingTreeObserver = new ViewTreeObserver();
14221 }
14222 return mFloatingTreeObserver;
14223 }
14224
14225 /**
14226 * <p>Finds the topmost view in the current view hierarchy.</p>
14227 *
14228 * @return the topmost view containing this view
14229 */
14230 public View getRootView() {
14231 if (mAttachInfo != null) {
14232 final View v = mAttachInfo.mRootView;
14233 if (v != null) {
14234 return v;
14235 }
14236 }
Romain Guy8506ab42009-06-11 17:35:47 -070014237
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014238 View parent = this;
14239
14240 while (parent.mParent != null && parent.mParent instanceof View) {
14241 parent = (View) parent.mParent;
14242 }
14243
14244 return parent;
14245 }
14246
14247 /**
14248 * <p>Computes the coordinates of this view on the screen. The argument
14249 * must be an array of two integers. After the method returns, the array
14250 * contains the x and y location in that order.</p>
14251 *
14252 * @param location an array of two integers in which to hold the coordinates
14253 */
14254 public void getLocationOnScreen(int[] location) {
14255 getLocationInWindow(location);
14256
14257 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -070014258 if (info != null) {
14259 location[0] += info.mWindowLeft;
14260 location[1] += info.mWindowTop;
14261 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014262 }
14263
14264 /**
14265 * <p>Computes the coordinates of this view in its window. The argument
14266 * must be an array of two integers. After the method returns, the array
14267 * contains the x and y location in that order.</p>
14268 *
14269 * @param location an array of two integers in which to hold the coordinates
14270 */
14271 public void getLocationInWindow(int[] location) {
14272 if (location == null || location.length < 2) {
Gilles Debunnecea45132011-11-24 02:19:27 +010014273 throw new IllegalArgumentException("location must be an array of two integers");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014274 }
14275
Gilles Debunne6583ce52011-12-06 18:09:02 -080014276 if (mAttachInfo == null) {
14277 // When the view is not attached to a window, this method does not make sense
14278 location[0] = location[1] = 0;
14279 return;
14280 }
14281
Gilles Debunnecea45132011-11-24 02:19:27 +010014282 float[] position = mAttachInfo.mTmpTransformLocation;
14283 position[0] = position[1] = 0.0f;
14284
14285 if (!hasIdentityMatrix()) {
14286 getMatrix().mapPoints(position);
Dianne Hackbornddb715b2011-09-09 14:43:39 -070014287 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014288
Gilles Debunnecea45132011-11-24 02:19:27 +010014289 position[0] += mLeft;
14290 position[1] += mTop;
14291
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014292 ViewParent viewParent = mParent;
14293 while (viewParent instanceof View) {
Gilles Debunnecea45132011-11-24 02:19:27 +010014294 final View view = (View) viewParent;
14295
14296 position[0] -= view.mScrollX;
14297 position[1] -= view.mScrollY;
14298
14299 if (!view.hasIdentityMatrix()) {
14300 view.getMatrix().mapPoints(position);
Dianne Hackbornddb715b2011-09-09 14:43:39 -070014301 }
Gilles Debunnecea45132011-11-24 02:19:27 +010014302
14303 position[0] += view.mLeft;
14304 position[1] += view.mTop;
14305
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014306 viewParent = view.mParent;
Svetoslav Ganov42138042012-03-20 11:51:39 -070014307 }
Romain Guy8506ab42009-06-11 17:35:47 -070014308
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070014309 if (viewParent instanceof ViewRootImpl) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014310 // *cough*
Gilles Debunnecea45132011-11-24 02:19:27 +010014311 final ViewRootImpl vr = (ViewRootImpl) viewParent;
14312 position[1] -= vr.mCurScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014313 }
Gilles Debunnecea45132011-11-24 02:19:27 +010014314
14315 location[0] = (int) (position[0] + 0.5f);
14316 location[1] = (int) (position[1] + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014317 }
14318
14319 /**
14320 * {@hide}
14321 * @param id the id of the view to be found
14322 * @return the view of the specified id, null if cannot be found
14323 */
14324 protected View findViewTraversal(int id) {
14325 if (id == mID) {
14326 return this;
14327 }
14328 return null;
14329 }
14330
14331 /**
14332 * {@hide}
14333 * @param tag the tag of the view to be found
14334 * @return the view of specified tag, null if cannot be found
14335 */
14336 protected View findViewWithTagTraversal(Object tag) {
14337 if (tag != null && tag.equals(mTag)) {
14338 return this;
14339 }
14340 return null;
14341 }
14342
14343 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080014344 * {@hide}
14345 * @param predicate The predicate to evaluate.
Jeff Brown4dfbec22011-08-15 14:55:37 -070014346 * @param childToSkip If not null, ignores this child during the recursive traversal.
Jeff Brown4e6319b2010-12-13 10:36:51 -080014347 * @return The first view that matches the predicate or null.
14348 */
Jeff Brown4dfbec22011-08-15 14:55:37 -070014349 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) {
Jeff Brown4e6319b2010-12-13 10:36:51 -080014350 if (predicate.apply(this)) {
14351 return this;
14352 }
14353 return null;
14354 }
14355
14356 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014357 * Look for a child view with the given id. If this view has the given
14358 * id, return this view.
14359 *
14360 * @param id The id to search for.
14361 * @return The view that has the given id in the hierarchy or null
14362 */
14363 public final View findViewById(int id) {
14364 if (id < 0) {
14365 return null;
14366 }
14367 return findViewTraversal(id);
14368 }
14369
14370 /**
Svetoslav Ganov2cdedff2011-10-03 14:18:42 -070014371 * Finds a view by its unuque and stable accessibility id.
14372 *
14373 * @param accessibilityId The searched accessibility id.
14374 * @return The found view.
14375 */
14376 final View findViewByAccessibilityId(int accessibilityId) {
14377 if (accessibilityId < 0) {
14378 return null;
14379 }
14380 return findViewByAccessibilityIdTraversal(accessibilityId);
14381 }
14382
14383 /**
14384 * Performs the traversal to find a view by its unuque and stable accessibility id.
14385 *
14386 * <strong>Note:</strong>This method does not stop at the root namespace
14387 * boundary since the user can touch the screen at an arbitrary location
14388 * potentially crossing the root namespace bounday which will send an
14389 * accessibility event to accessibility services and they should be able
14390 * to obtain the event source. Also accessibility ids are guaranteed to be
14391 * unique in the window.
14392 *
14393 * @param accessibilityId The accessibility id.
14394 * @return The found view.
14395 */
14396 View findViewByAccessibilityIdTraversal(int accessibilityId) {
14397 if (getAccessibilityViewId() == accessibilityId) {
14398 return this;
14399 }
14400 return null;
14401 }
14402
14403 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014404 * Look for a child view with the given tag. If this view has the given
14405 * tag, return this view.
14406 *
14407 * @param tag The tag to search for, using "tag.equals(getTag())".
14408 * @return The View that has the given tag in the hierarchy or null
14409 */
14410 public final View findViewWithTag(Object tag) {
14411 if (tag == null) {
14412 return null;
14413 }
14414 return findViewWithTagTraversal(tag);
14415 }
14416
14417 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080014418 * {@hide}
14419 * Look for a child view that matches the specified predicate.
14420 * If this view matches the predicate, return this view.
14421 *
14422 * @param predicate The predicate to evaluate.
14423 * @return The first view that matches the predicate or null.
14424 */
14425 public final View findViewByPredicate(Predicate<View> predicate) {
Jeff Brown4dfbec22011-08-15 14:55:37 -070014426 return findViewByPredicateTraversal(predicate, null);
14427 }
14428
14429 /**
14430 * {@hide}
14431 * Look for a child view that matches the specified predicate,
14432 * starting with the specified view and its descendents and then
14433 * recusively searching the ancestors and siblings of that view
14434 * until this view is reached.
14435 *
14436 * This method is useful in cases where the predicate does not match
14437 * a single unique view (perhaps multiple views use the same id)
14438 * and we are trying to find the view that is "closest" in scope to the
14439 * starting view.
14440 *
14441 * @param start The view to start from.
14442 * @param predicate The predicate to evaluate.
14443 * @return The first view that matches the predicate or null.
14444 */
14445 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) {
14446 View childToSkip = null;
14447 for (;;) {
14448 View view = start.findViewByPredicateTraversal(predicate, childToSkip);
14449 if (view != null || start == this) {
14450 return view;
14451 }
14452
14453 ViewParent parent = start.getParent();
14454 if (parent == null || !(parent instanceof View)) {
14455 return null;
14456 }
14457
14458 childToSkip = start;
14459 start = (View) parent;
14460 }
Jeff Brown4e6319b2010-12-13 10:36:51 -080014461 }
14462
14463 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014464 * Sets the identifier for this view. The identifier does not have to be
14465 * unique in this view's hierarchy. The identifier should be a positive
14466 * number.
14467 *
14468 * @see #NO_ID
Philip Milne6c8ea062012-04-03 17:38:43 -070014469 * @see #getId()
14470 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014471 *
14472 * @param id a number used to identify the view
14473 *
14474 * @attr ref android.R.styleable#View_id
14475 */
14476 public void setId(int id) {
14477 mID = id;
14478 }
14479
14480 /**
14481 * {@hide}
14482 *
14483 * @param isRoot true if the view belongs to the root namespace, false
14484 * otherwise
14485 */
14486 public void setIsRootNamespace(boolean isRoot) {
14487 if (isRoot) {
14488 mPrivateFlags |= IS_ROOT_NAMESPACE;
14489 } else {
14490 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
14491 }
14492 }
14493
14494 /**
14495 * {@hide}
14496 *
14497 * @return true if the view belongs to the root namespace, false otherwise
14498 */
14499 public boolean isRootNamespace() {
14500 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
14501 }
14502
14503 /**
14504 * Returns this view's identifier.
14505 *
14506 * @return a positive integer used to identify the view or {@link #NO_ID}
14507 * if the view has no ID
14508 *
Philip Milne6c8ea062012-04-03 17:38:43 -070014509 * @see #setId(int)
14510 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014511 * @attr ref android.R.styleable#View_id
14512 */
14513 @ViewDebug.CapturedViewProperty
14514 public int getId() {
14515 return mID;
14516 }
14517
14518 /**
14519 * Returns this view's tag.
14520 *
14521 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -070014522 *
14523 * @see #setTag(Object)
14524 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014525 */
14526 @ViewDebug.ExportedProperty
14527 public Object getTag() {
14528 return mTag;
14529 }
14530
14531 /**
14532 * Sets the tag associated with this view. A tag can be used to mark
14533 * a view in its hierarchy and does not have to be unique within the
14534 * hierarchy. Tags can also be used to store data within a view without
14535 * resorting to another data structure.
14536 *
14537 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -070014538 *
14539 * @see #getTag()
14540 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014541 */
14542 public void setTag(final Object tag) {
14543 mTag = tag;
14544 }
14545
14546 /**
Romain Guyd90a3312009-05-06 14:54:28 -070014547 * Returns the tag associated with this view and the specified key.
14548 *
14549 * @param key The key identifying the tag
14550 *
14551 * @return the Object stored in this view as a tag
14552 *
14553 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -070014554 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -070014555 */
14556 public Object getTag(int key) {
Adam Powell7db82ac2011-09-22 19:44:04 -070014557 if (mKeyedTags != null) return mKeyedTags.get(key);
Romain Guyd90a3312009-05-06 14:54:28 -070014558 return null;
14559 }
14560
14561 /**
14562 * Sets a tag associated with this view and a key. A tag can be used
14563 * to mark a view in its hierarchy and does not have to be unique within
14564 * the hierarchy. Tags can also be used to store data within a view
14565 * without resorting to another data structure.
14566 *
14567 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -070014568 * application to ensure it is unique (see the <a
14569 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
14570 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -070014571 * the Android framework or not associated with any package will cause
14572 * an {@link IllegalArgumentException} to be thrown.
14573 *
14574 * @param key The key identifying the tag
14575 * @param tag An Object to tag the view with
14576 *
14577 * @throws IllegalArgumentException If they specified key is not valid
14578 *
14579 * @see #setTag(Object)
14580 * @see #getTag(int)
14581 */
14582 public void setTag(int key, final Object tag) {
14583 // If the package id is 0x00 or 0x01, it's either an undefined package
14584 // or a framework id
14585 if ((key >>> 24) < 2) {
14586 throw new IllegalArgumentException("The key must be an application-specific "
14587 + "resource id.");
14588 }
14589
Adam Powell2b2f6d62011-09-23 11:15:39 -070014590 setKeyedTag(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014591 }
14592
14593 /**
14594 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
14595 * framework id.
14596 *
14597 * @hide
14598 */
14599 public void setTagInternal(int key, Object tag) {
14600 if ((key >>> 24) != 0x1) {
14601 throw new IllegalArgumentException("The key must be a framework-specific "
14602 + "resource id.");
14603 }
14604
Adam Powell2b2f6d62011-09-23 11:15:39 -070014605 setKeyedTag(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014606 }
14607
Adam Powell2b2f6d62011-09-23 11:15:39 -070014608 private void setKeyedTag(int key, Object tag) {
Adam Powell7db82ac2011-09-22 19:44:04 -070014609 if (mKeyedTags == null) {
14610 mKeyedTags = new SparseArray<Object>();
Romain Guyd90a3312009-05-06 14:54:28 -070014611 }
14612
Adam Powell7db82ac2011-09-22 19:44:04 -070014613 mKeyedTags.put(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014614 }
14615
14616 /**
Romain Guy13922e02009-05-12 17:56:14 -070014617 * @param consistency The type of consistency. See ViewDebug for more information.
14618 *
14619 * @hide
14620 */
14621 protected boolean dispatchConsistencyCheck(int consistency) {
14622 return onConsistencyCheck(consistency);
14623 }
14624
14625 /**
14626 * Method that subclasses should implement to check their consistency. The type of
14627 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -070014628 *
Romain Guy13922e02009-05-12 17:56:14 -070014629 * @param consistency The type of consistency. See ViewDebug for more information.
14630 *
14631 * @throws IllegalStateException if the view is in an inconsistent state.
14632 *
14633 * @hide
14634 */
14635 protected boolean onConsistencyCheck(int consistency) {
14636 boolean result = true;
14637
14638 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
14639 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
14640
14641 if (checkLayout) {
14642 if (getParent() == null) {
14643 result = false;
14644 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14645 "View " + this + " does not have a parent.");
14646 }
14647
14648 if (mAttachInfo == null) {
14649 result = false;
14650 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14651 "View " + this + " is not attached to a window.");
14652 }
14653 }
14654
14655 if (checkDrawing) {
14656 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
14657 // from their draw() method
14658
14659 if ((mPrivateFlags & DRAWN) != DRAWN &&
14660 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
14661 result = false;
14662 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14663 "View " + this + " was invalidated but its drawing cache is valid.");
14664 }
14665 }
14666
14667 return result;
14668 }
14669
14670 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014671 * Prints information about this view in the log output, with the tag
14672 * {@link #VIEW_LOG_TAG}.
14673 *
14674 * @hide
14675 */
14676 public void debug() {
14677 debug(0);
14678 }
14679
14680 /**
14681 * Prints information about this view in the log output, with the tag
14682 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
14683 * indentation defined by the <code>depth</code>.
14684 *
14685 * @param depth the indentation level
14686 *
14687 * @hide
14688 */
14689 protected void debug(int depth) {
14690 String output = debugIndent(depth - 1);
14691
14692 output += "+ " + this;
14693 int id = getId();
14694 if (id != -1) {
14695 output += " (id=" + id + ")";
14696 }
14697 Object tag = getTag();
14698 if (tag != null) {
14699 output += " (tag=" + tag + ")";
14700 }
14701 Log.d(VIEW_LOG_TAG, output);
14702
14703 if ((mPrivateFlags & FOCUSED) != 0) {
14704 output = debugIndent(depth) + " FOCUSED";
14705 Log.d(VIEW_LOG_TAG, output);
14706 }
14707
14708 output = debugIndent(depth);
14709 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
14710 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
14711 + "} ";
14712 Log.d(VIEW_LOG_TAG, output);
14713
14714 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
14715 || mPaddingBottom != 0) {
14716 output = debugIndent(depth);
14717 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
14718 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
14719 Log.d(VIEW_LOG_TAG, output);
14720 }
14721
14722 output = debugIndent(depth);
14723 output += "mMeasureWidth=" + mMeasuredWidth +
14724 " mMeasureHeight=" + mMeasuredHeight;
14725 Log.d(VIEW_LOG_TAG, output);
14726
14727 output = debugIndent(depth);
14728 if (mLayoutParams == null) {
14729 output += "BAD! no layout params";
14730 } else {
14731 output = mLayoutParams.debug(output);
14732 }
14733 Log.d(VIEW_LOG_TAG, output);
14734
14735 output = debugIndent(depth);
14736 output += "flags={";
14737 output += View.printFlags(mViewFlags);
14738 output += "}";
14739 Log.d(VIEW_LOG_TAG, output);
14740
14741 output = debugIndent(depth);
14742 output += "privateFlags={";
14743 output += View.printPrivateFlags(mPrivateFlags);
14744 output += "}";
14745 Log.d(VIEW_LOG_TAG, output);
14746 }
14747
14748 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +090014749 * Creates a string of whitespaces used for indentation.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014750 *
14751 * @param depth the indentation level
14752 * @return a String containing (depth * 2 + 3) * 2 white spaces
14753 *
14754 * @hide
14755 */
14756 protected static String debugIndent(int depth) {
14757 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
14758 for (int i = 0; i < (depth * 2) + 3; i++) {
14759 spaces.append(' ').append(' ');
14760 }
14761 return spaces.toString();
14762 }
14763
14764 /**
14765 * <p>Return the offset of the widget's text baseline from the widget's top
14766 * boundary. If this widget does not support baseline alignment, this
14767 * method returns -1. </p>
14768 *
14769 * @return the offset of the baseline within the widget's bounds or -1
14770 * if baseline alignment is not supported
14771 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070014772 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014773 public int getBaseline() {
14774 return -1;
14775 }
14776
14777 /**
14778 * Call this when something has changed which has invalidated the
14779 * layout of this view. This will schedule a layout pass of the view
14780 * tree.
14781 */
14782 public void requestLayout() {
14783 if (ViewDebug.TRACE_HIERARCHY) {
14784 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
14785 }
14786
14787 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080014788 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014789
Fabrice Di Meglio4a5268852012-03-30 15:56:48 -070014790 if (mLayoutParams != null) {
14791 mLayoutParams.onResolveLayoutDirection(getResolvedLayoutDirection());
14792 }
14793
14794 if (mParent != null && !mParent.isLayoutRequested()) {
14795 mParent.requestLayout();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014796 }
14797 }
14798
14799 /**
14800 * Forces this view to be laid out during the next layout pass.
14801 * This method does not call requestLayout() or forceLayout()
14802 * on the parent.
14803 */
14804 public void forceLayout() {
14805 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080014806 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014807 }
14808
14809 /**
14810 * <p>
14811 * This is called to find out how big a view should be. The parent
14812 * supplies constraint information in the width and height parameters.
14813 * </p>
14814 *
14815 * <p>
Romain Guy967e2bf2012-02-07 17:04:34 -080014816 * The actual measurement work of a view is performed in
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014817 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
Romain Guy967e2bf2012-02-07 17:04:34 -080014818 * {@link #onMeasure(int, int)} can and must be overridden by subclasses.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014819 * </p>
14820 *
14821 *
14822 * @param widthMeasureSpec Horizontal space requirements as imposed by the
14823 * parent
14824 * @param heightMeasureSpec Vertical space requirements as imposed by the
14825 * parent
14826 *
14827 * @see #onMeasure(int, int)
14828 */
14829 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
14830 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
14831 widthMeasureSpec != mOldWidthMeasureSpec ||
14832 heightMeasureSpec != mOldHeightMeasureSpec) {
14833
14834 // first clears the measured dimension flag
14835 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
14836
14837 if (ViewDebug.TRACE_HIERARCHY) {
14838 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
14839 }
14840
14841 // measure ourselves, this should set the measured dimension flag back
14842 onMeasure(widthMeasureSpec, heightMeasureSpec);
14843
14844 // flag not set, setMeasuredDimension() was not invoked, we raise
14845 // an exception to warn the developer
14846 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
14847 throw new IllegalStateException("onMeasure() did not set the"
14848 + " measured dimension by calling"
14849 + " setMeasuredDimension()");
14850 }
14851
14852 mPrivateFlags |= LAYOUT_REQUIRED;
14853 }
14854
14855 mOldWidthMeasureSpec = widthMeasureSpec;
14856 mOldHeightMeasureSpec = heightMeasureSpec;
14857 }
14858
14859 /**
14860 * <p>
14861 * Measure the view and its content to determine the measured width and the
14862 * measured height. This method is invoked by {@link #measure(int, int)} and
14863 * should be overriden by subclasses to provide accurate and efficient
14864 * measurement of their contents.
14865 * </p>
14866 *
14867 * <p>
14868 * <strong>CONTRACT:</strong> When overriding this method, you
14869 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
14870 * measured width and height of this view. Failure to do so will trigger an
14871 * <code>IllegalStateException</code>, thrown by
14872 * {@link #measure(int, int)}. Calling the superclass'
14873 * {@link #onMeasure(int, int)} is a valid use.
14874 * </p>
14875 *
14876 * <p>
14877 * The base class implementation of measure defaults to the background size,
14878 * unless a larger size is allowed by the MeasureSpec. Subclasses should
14879 * override {@link #onMeasure(int, int)} to provide better measurements of
14880 * their content.
14881 * </p>
14882 *
14883 * <p>
14884 * If this method is overridden, it is the subclass's responsibility to make
14885 * sure the measured height and width are at least the view's minimum height
14886 * and width ({@link #getSuggestedMinimumHeight()} and
14887 * {@link #getSuggestedMinimumWidth()}).
14888 * </p>
14889 *
14890 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
14891 * The requirements are encoded with
14892 * {@link android.view.View.MeasureSpec}.
14893 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
14894 * The requirements are encoded with
14895 * {@link android.view.View.MeasureSpec}.
14896 *
14897 * @see #getMeasuredWidth()
14898 * @see #getMeasuredHeight()
14899 * @see #setMeasuredDimension(int, int)
14900 * @see #getSuggestedMinimumHeight()
14901 * @see #getSuggestedMinimumWidth()
14902 * @see android.view.View.MeasureSpec#getMode(int)
14903 * @see android.view.View.MeasureSpec#getSize(int)
14904 */
14905 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
14906 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
14907 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
14908 }
14909
14910 /**
14911 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
14912 * measured width and measured height. Failing to do so will trigger an
14913 * exception at measurement time.</p>
14914 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080014915 * @param measuredWidth The measured width of this view. May be a complex
14916 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
14917 * {@link #MEASURED_STATE_TOO_SMALL}.
14918 * @param measuredHeight The measured height of this view. May be a complex
14919 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
14920 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014921 */
14922 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
14923 mMeasuredWidth = measuredWidth;
14924 mMeasuredHeight = measuredHeight;
14925
14926 mPrivateFlags |= MEASURED_DIMENSION_SET;
14927 }
14928
14929 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080014930 * Merge two states as returned by {@link #getMeasuredState()}.
14931 * @param curState The current state as returned from a view or the result
14932 * of combining multiple views.
14933 * @param newState The new view state to combine.
14934 * @return Returns a new integer reflecting the combination of the two
14935 * states.
14936 */
14937 public static int combineMeasuredStates(int curState, int newState) {
14938 return curState | newState;
14939 }
14940
14941 /**
14942 * Version of {@link #resolveSizeAndState(int, int, int)}
14943 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
14944 */
14945 public static int resolveSize(int size, int measureSpec) {
14946 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
14947 }
14948
14949 /**
14950 * Utility to reconcile a desired size and state, with constraints imposed
14951 * by a MeasureSpec. Will take the desired size, unless a different size
14952 * is imposed by the constraints. The returned value is a compound integer,
14953 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
14954 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
14955 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014956 *
14957 * @param size How big the view wants to be
14958 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080014959 * @return Size information bit mask as defined by
14960 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014961 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080014962 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014963 int result = size;
14964 int specMode = MeasureSpec.getMode(measureSpec);
14965 int specSize = MeasureSpec.getSize(measureSpec);
14966 switch (specMode) {
14967 case MeasureSpec.UNSPECIFIED:
14968 result = size;
14969 break;
14970 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080014971 if (specSize < size) {
14972 result = specSize | MEASURED_STATE_TOO_SMALL;
14973 } else {
14974 result = size;
14975 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014976 break;
14977 case MeasureSpec.EXACTLY:
14978 result = specSize;
14979 break;
14980 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080014981 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014982 }
14983
14984 /**
14985 * Utility to return a default size. Uses the supplied size if the
Romain Guy98029c82011-06-17 15:47:07 -070014986 * MeasureSpec imposed no constraints. Will get larger if allowed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014987 * by the MeasureSpec.
14988 *
14989 * @param size Default size for this view
14990 * @param measureSpec Constraints imposed by the parent
14991 * @return The size this view should be.
14992 */
14993 public static int getDefaultSize(int size, int measureSpec) {
14994 int result = size;
14995 int specMode = MeasureSpec.getMode(measureSpec);
Romain Guy98029c82011-06-17 15:47:07 -070014996 int specSize = MeasureSpec.getSize(measureSpec);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014997
14998 switch (specMode) {
14999 case MeasureSpec.UNSPECIFIED:
15000 result = size;
15001 break;
15002 case MeasureSpec.AT_MOST:
15003 case MeasureSpec.EXACTLY:
15004 result = specSize;
15005 break;
15006 }
15007 return result;
15008 }
15009
15010 /**
15011 * Returns the suggested minimum height that the view should use. This
15012 * returns the maximum of the view's minimum height
15013 * and the background's minimum height
15014 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
15015 * <p>
15016 * When being used in {@link #onMeasure(int, int)}, the caller should still
15017 * ensure the returned height is within the requirements of the parent.
15018 *
15019 * @return The suggested minimum height of the view.
15020 */
15021 protected int getSuggestedMinimumHeight() {
Philip Milne6c8ea062012-04-03 17:38:43 -070015022 return (mBackground == null) ? mMinHeight : max(mMinHeight, mBackground.getMinimumHeight());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015023
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015024 }
15025
15026 /**
15027 * Returns the suggested minimum width that the view should use. This
15028 * returns the maximum of the view's minimum width)
15029 * and the background's minimum width
15030 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
15031 * <p>
15032 * When being used in {@link #onMeasure(int, int)}, the caller should still
15033 * ensure the returned width is within the requirements of the parent.
15034 *
15035 * @return The suggested minimum width of the view.
15036 */
15037 protected int getSuggestedMinimumWidth() {
Philip Milne6c8ea062012-04-03 17:38:43 -070015038 return (mBackground == null) ? mMinWidth : max(mMinWidth, mBackground.getMinimumWidth());
15039 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015040
Philip Milne6c8ea062012-04-03 17:38:43 -070015041 /**
15042 * Returns the minimum height of the view.
15043 *
15044 * @return the minimum height the view will try to be.
15045 *
15046 * @see #setMinimumHeight(int)
15047 *
15048 * @attr ref android.R.styleable#View_minHeight
15049 */
15050 public int getMinimumHeight() {
15051 return mMinHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015052 }
15053
15054 /**
15055 * Sets the minimum height of the view. It is not guaranteed the view will
15056 * be able to achieve this minimum height (for example, if its parent layout
15057 * constrains it with less available height).
15058 *
15059 * @param minHeight The minimum height the view will try to be.
Philip Milne6c8ea062012-04-03 17:38:43 -070015060 *
15061 * @see #getMinimumHeight()
15062 *
15063 * @attr ref android.R.styleable#View_minHeight
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015064 */
15065 public void setMinimumHeight(int minHeight) {
15066 mMinHeight = minHeight;
Philip Milne6c8ea062012-04-03 17:38:43 -070015067 requestLayout();
15068 }
15069
15070 /**
15071 * Returns the minimum width of the view.
15072 *
15073 * @return the minimum width the view will try to be.
15074 *
15075 * @see #setMinimumWidth(int)
15076 *
15077 * @attr ref android.R.styleable#View_minWidth
15078 */
15079 public int getMinimumWidth() {
15080 return mMinWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015081 }
15082
15083 /**
15084 * Sets the minimum width of the view. It is not guaranteed the view will
15085 * be able to achieve this minimum width (for example, if its parent layout
15086 * constrains it with less available width).
15087 *
15088 * @param minWidth The minimum width the view will try to be.
Philip Milne6c8ea062012-04-03 17:38:43 -070015089 *
15090 * @see #getMinimumWidth()
15091 *
15092 * @attr ref android.R.styleable#View_minWidth
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015093 */
15094 public void setMinimumWidth(int minWidth) {
15095 mMinWidth = minWidth;
Philip Milne6c8ea062012-04-03 17:38:43 -070015096 requestLayout();
15097
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015098 }
15099
15100 /**
15101 * Get the animation currently associated with this view.
15102 *
15103 * @return The animation that is currently playing or
15104 * scheduled to play for this view.
15105 */
15106 public Animation getAnimation() {
15107 return mCurrentAnimation;
15108 }
15109
15110 /**
15111 * Start the specified animation now.
15112 *
15113 * @param animation the animation to start now
15114 */
15115 public void startAnimation(Animation animation) {
15116 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
15117 setAnimation(animation);
Romain Guy0fd89bf2011-01-26 15:41:30 -080015118 invalidateParentCaches();
15119 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015120 }
15121
15122 /**
15123 * Cancels any animations for this view.
15124 */
15125 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080015126 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080015127 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080015128 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015129 mCurrentAnimation = null;
Romain Guy0fd89bf2011-01-26 15:41:30 -080015130 invalidateParentIfNeeded();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015131 }
15132
15133 /**
15134 * Sets the next animation to play for this view.
15135 * If you want the animation to play immediately, use
15136 * startAnimation. This method provides allows fine-grained
15137 * control over the start time and invalidation, but you
15138 * must make sure that 1) the animation has a start time set, and
15139 * 2) the view will be invalidated when the animation is supposed to
15140 * start.
15141 *
15142 * @param animation The next animation, or null.
15143 */
15144 public void setAnimation(Animation animation) {
15145 mCurrentAnimation = animation;
Romain Guyeb378892012-04-12 11:33:14 -070015146
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015147 if (animation != null) {
Romain Guyeb378892012-04-12 11:33:14 -070015148 // If the screen is off assume the animation start time is now instead of
15149 // the next frame we draw. Keeping the START_ON_FIRST_FRAME start time
15150 // would cause the animation to start when the screen turns back on
15151 if (mAttachInfo != null && !mAttachInfo.mScreenOn &&
15152 animation.getStartTime() == Animation.START_ON_FIRST_FRAME) {
15153 animation.setStartTime(AnimationUtils.currentAnimationTimeMillis());
15154 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015155 animation.reset();
15156 }
15157 }
15158
15159 /**
15160 * Invoked by a parent ViewGroup to notify the start of the animation
15161 * currently associated with this view. If you override this method,
15162 * always call super.onAnimationStart();
15163 *
15164 * @see #setAnimation(android.view.animation.Animation)
15165 * @see #getAnimation()
15166 */
15167 protected void onAnimationStart() {
15168 mPrivateFlags |= ANIMATION_STARTED;
15169 }
15170
15171 /**
15172 * Invoked by a parent ViewGroup to notify the end of the animation
15173 * currently associated with this view. If you override this method,
15174 * always call super.onAnimationEnd();
15175 *
15176 * @see #setAnimation(android.view.animation.Animation)
15177 * @see #getAnimation()
15178 */
15179 protected void onAnimationEnd() {
15180 mPrivateFlags &= ~ANIMATION_STARTED;
15181 }
15182
15183 /**
15184 * Invoked if there is a Transform that involves alpha. Subclass that can
15185 * draw themselves with the specified alpha should return true, and then
15186 * respect that alpha when their onDraw() is called. If this returns false
15187 * then the view may be redirected to draw into an offscreen buffer to
15188 * fulfill the request, which will look fine, but may be slower than if the
15189 * subclass handles it internally. The default implementation returns false.
15190 *
15191 * @param alpha The alpha (0..255) to apply to the view's drawing
15192 * @return true if the view can draw with the specified alpha.
15193 */
15194 protected boolean onSetAlpha(int alpha) {
15195 return false;
15196 }
15197
15198 /**
15199 * This is used by the RootView to perform an optimization when
15200 * the view hierarchy contains one or several SurfaceView.
15201 * SurfaceView is always considered transparent, but its children are not,
15202 * therefore all View objects remove themselves from the global transparent
15203 * region (passed as a parameter to this function).
15204 *
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070015205 * @param region The transparent region for this ViewAncestor (window).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015206 *
15207 * @return Returns true if the effective visibility of the view at this
15208 * point is opaque, regardless of the transparent region; returns false
15209 * if it is possible for underlying windows to be seen behind the view.
15210 *
15211 * {@hide}
15212 */
15213 public boolean gatherTransparentRegion(Region region) {
15214 final AttachInfo attachInfo = mAttachInfo;
15215 if (region != null && attachInfo != null) {
15216 final int pflags = mPrivateFlags;
15217 if ((pflags & SKIP_DRAW) == 0) {
15218 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
15219 // remove it from the transparent region.
15220 final int[] location = attachInfo.mTransparentLocation;
15221 getLocationInWindow(location);
15222 region.op(location[0], location[1], location[0] + mRight - mLeft,
15223 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
Philip Milne6c8ea062012-04-03 17:38:43 -070015224 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBackground != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015225 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
15226 // exists, so we remove the background drawable's non-transparent
15227 // parts from this transparent region.
Philip Milne6c8ea062012-04-03 17:38:43 -070015228 applyDrawableToTransparentRegion(mBackground, region);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015229 }
15230 }
15231 return true;
15232 }
15233
15234 /**
15235 * Play a sound effect for this view.
15236 *
15237 * <p>The framework will play sound effects for some built in actions, such as
15238 * clicking, but you may wish to play these effects in your widget,
15239 * for instance, for internal navigation.
15240 *
15241 * <p>The sound effect will only be played if sound effects are enabled by the user, and
15242 * {@link #isSoundEffectsEnabled()} is true.
15243 *
15244 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
15245 */
15246 public void playSoundEffect(int soundConstant) {
15247 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
15248 return;
15249 }
15250 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
15251 }
15252
15253 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015254 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070015255 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015256 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015257 *
15258 * <p>The framework will provide haptic feedback for some built in actions,
15259 * such as long presses, but you may wish to provide feedback for your
15260 * own widget.
15261 *
15262 * <p>The feedback will only be performed if
15263 * {@link #isHapticFeedbackEnabled()} is true.
15264 *
15265 * @param feedbackConstant One of the constants defined in
15266 * {@link HapticFeedbackConstants}
15267 */
15268 public boolean performHapticFeedback(int feedbackConstant) {
15269 return performHapticFeedback(feedbackConstant, 0);
15270 }
15271
15272 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015273 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070015274 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015275 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015276 *
15277 * @param feedbackConstant One of the constants defined in
15278 * {@link HapticFeedbackConstants}
15279 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
15280 */
15281 public boolean performHapticFeedback(int feedbackConstant, int flags) {
15282 if (mAttachInfo == null) {
15283 return false;
15284 }
Romain Guyf607bdc2010-09-10 19:20:06 -070015285 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070015286 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015287 && !isHapticFeedbackEnabled()) {
15288 return false;
15289 }
Romain Guy812ccbe2010-06-01 14:07:24 -070015290 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
15291 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015292 }
15293
15294 /**
Dianne Hackborn98014352012-04-05 18:31:41 -070015295 * Request that the visibility of the status bar or other screen/window
15296 * decorations be changed.
15297 *
15298 * <p>This method is used to put the over device UI into temporary modes
15299 * where the user's attention is focused more on the application content,
15300 * by dimming or hiding surrounding system affordances. This is typically
15301 * used in conjunction with {@link Window#FEATURE_ACTION_BAR_OVERLAY
15302 * Window.FEATURE_ACTION_BAR_OVERLAY}, allowing the applications content
15303 * to be placed behind the action bar (and with these flags other system
15304 * affordances) so that smooth transitions between hiding and showing them
15305 * can be done.
15306 *
15307 * <p>Two representative examples of the use of system UI visibility is
15308 * implementing a content browsing application (like a magazine reader)
15309 * and a video playing application.
15310 *
15311 * <p>The first code shows a typical implementation of a View in a content
15312 * browsing application. In this implementation, the application goes
15313 * into a content-oriented mode by hiding the status bar and action bar,
15314 * and putting the navigation elements into lights out mode. The user can
15315 * then interact with content while in this mode. Such an application should
15316 * provide an easy way for the user to toggle out of the mode (such as to
15317 * check information in the status bar or access notifications). In the
15318 * implementation here, this is done simply by tapping on the content.
15319 *
15320 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/ContentBrowserActivity.java
15321 * content}
15322 *
15323 * <p>This second code sample shows a typical implementation of a View
15324 * in a video playing application. In this situation, while the video is
15325 * playing the application would like to go into a complete full-screen mode,
15326 * to use as much of the display as possible for the video. When in this state
15327 * the user can not interact with the application; the system intercepts
15328 * touching on the screen to pop the UI out of full screen mode.
15329 *
15330 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/VideoPlayerActivity.java
15331 * content}
15332 *
15333 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
15334 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN},
15335 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION},
15336 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080015337 */
15338 public void setSystemUiVisibility(int visibility) {
Daniel Sandler70524062011-09-21 00:30:47 -040015339 if (visibility != mSystemUiVisibility) {
15340 mSystemUiVisibility = visibility;
15341 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
15342 mParent.recomputeViewAttributes(this);
15343 }
Joe Onorato664644d2011-01-23 17:53:23 -080015344 }
15345 }
15346
15347 /**
Dianne Hackborn98014352012-04-05 18:31:41 -070015348 * Returns the last {@link #setSystemUiVisibility(int) that this view has requested.
15349 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
15350 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN},
15351 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION},
15352 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080015353 */
Joe Onoratoe595cad2011-01-24 09:22:12 -080015354 public int getSystemUiVisibility() {
Joe Onorato664644d2011-01-23 17:53:23 -080015355 return mSystemUiVisibility;
15356 }
15357
Scott Mainec6331b2011-05-24 16:55:56 -070015358 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -070015359 * Returns the current system UI visibility that is currently set for
15360 * the entire window. This is the combination of the
15361 * {@link #setSystemUiVisibility(int)} values supplied by all of the
15362 * views in the window.
15363 */
15364 public int getWindowSystemUiVisibility() {
15365 return mAttachInfo != null ? mAttachInfo.mSystemUiVisibility : 0;
15366 }
15367
15368 /**
15369 * Override to find out when the window's requested system UI visibility
15370 * has changed, that is the value returned by {@link #getWindowSystemUiVisibility()}.
15371 * This is different from the callbacks recieved through
15372 * {@link #setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener)}
15373 * in that this is only telling you about the local request of the window,
15374 * not the actual values applied by the system.
15375 */
15376 public void onWindowSystemUiVisibilityChanged(int visible) {
15377 }
15378
15379 /**
15380 * Dispatch callbacks to {@link #onWindowSystemUiVisibilityChanged(int)} down
15381 * the view hierarchy.
15382 */
15383 public void dispatchWindowSystemUiVisiblityChanged(int visible) {
15384 onWindowSystemUiVisibilityChanged(visible);
15385 }
15386
15387 /**
Scott Mainec6331b2011-05-24 16:55:56 -070015388 * Set a listener to receive callbacks when the visibility of the system bar changes.
15389 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks.
15390 */
Joe Onorato664644d2011-01-23 17:53:23 -080015391 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015392 getListenerInfo().mOnSystemUiVisibilityChangeListener = l;
Joe Onorato664644d2011-01-23 17:53:23 -080015393 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
15394 mParent.recomputeViewAttributes(this);
15395 }
15396 }
15397
15398 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015399 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down
15400 * the view hierarchy.
Joe Onorato664644d2011-01-23 17:53:23 -080015401 */
15402 public void dispatchSystemUiVisibilityChanged(int visibility) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015403 ListenerInfo li = mListenerInfo;
15404 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) {
15405 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange(
Joe Onorato6ab77bd2011-01-31 11:21:10 -080015406 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK);
Joe Onorato664644d2011-01-23 17:53:23 -080015407 }
15408 }
15409
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015410 void updateLocalSystemUiVisibility(int localValue, int localChanges) {
15411 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges);
15412 if (val != mSystemUiVisibility) {
15413 setSystemUiVisibility(val);
15414 }
15415 }
15416
Dianne Hackborn139e5aa2012-05-05 20:36:38 -070015417 /** @hide */
15418 public void setDisabledSystemUiVisibility(int flags) {
15419 if (mAttachInfo != null) {
15420 if (mAttachInfo.mDisabledSystemUiVisibility != flags) {
15421 mAttachInfo.mDisabledSystemUiVisibility = flags;
15422 if (mParent != null) {
15423 mParent.recomputeViewAttributes(this);
15424 }
15425 }
15426 }
15427 }
15428
Joe Onorato664644d2011-01-23 17:53:23 -080015429 /**
Joe Malin32736f02011-01-19 16:14:20 -080015430 * Creates an image that the system displays during the drag and drop
15431 * operation. This is called a &quot;drag shadow&quot;. The default implementation
15432 * for a DragShadowBuilder based on a View returns an image that has exactly the same
15433 * appearance as the given View. The default also positions the center of the drag shadow
15434 * directly under the touch point. If no View is provided (the constructor with no parameters
15435 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and
15436 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the
15437 * default is an invisible drag shadow.
15438 * <p>
15439 * You are not required to use the View you provide to the constructor as the basis of the
15440 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw
15441 * anything you want as the drag shadow.
15442 * </p>
15443 * <p>
15444 * You pass a DragShadowBuilder object to the system when you start the drag. The system
15445 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the
15446 * size and position of the drag shadow. It uses this data to construct a
15447 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()}
15448 * so that your application can draw the shadow image in the Canvas.
15449 * </p>
Joe Fernandez558459f2011-10-13 16:47:36 -070015450 *
15451 * <div class="special reference">
15452 * <h3>Developer Guides</h3>
15453 * <p>For a guide to implementing drag and drop features, read the
15454 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p>
15455 * </div>
Christopher Tate2c095f32010-10-04 14:13:40 -070015456 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015457 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070015458 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070015459
15460 /**
Joe Malin32736f02011-01-19 16:14:20 -080015461 * Constructs a shadow image builder based on a View. By default, the resulting drag
15462 * shadow will have the same appearance and dimensions as the View, with the touch point
15463 * over the center of the View.
15464 * @param view A View. Any View in scope can be used.
Christopher Tate2c095f32010-10-04 14:13:40 -070015465 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015466 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070015467 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070015468 }
15469
Christopher Tate17ed60c2011-01-18 12:50:26 -080015470 /**
15471 * Construct a shadow builder object with no associated View. This
15472 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)}
15473 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order
15474 * to supply the drag shadow's dimensions and appearance without
Joe Malin32736f02011-01-19 16:14:20 -080015475 * reference to any View object. If they are not overridden, then the result is an
15476 * invisible drag shadow.
Christopher Tate17ed60c2011-01-18 12:50:26 -080015477 */
15478 public DragShadowBuilder() {
15479 mView = new WeakReference<View>(null);
15480 }
15481
15482 /**
15483 * Returns the View object that had been passed to the
15484 * {@link #View.DragShadowBuilder(View)}
15485 * constructor. If that View parameter was {@code null} or if the
15486 * {@link #View.DragShadowBuilder()}
15487 * constructor was used to instantiate the builder object, this method will return
15488 * null.
15489 *
15490 * @return The View object associate with this builder object.
15491 */
Romain Guy5c22a8c2011-05-13 11:48:45 -070015492 @SuppressWarnings({"JavadocReference"})
Chris Tate6b391282010-10-14 15:48:59 -070015493 final public View getView() {
15494 return mView.get();
15495 }
15496
Christopher Tate2c095f32010-10-04 14:13:40 -070015497 /**
Joe Malin32736f02011-01-19 16:14:20 -080015498 * Provides the metrics for the shadow image. These include the dimensions of
15499 * the shadow image, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070015500 * be centered under the touch location while dragging.
15501 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015502 * The default implementation sets the dimensions of the shadow to be the
Joe Malin32736f02011-01-19 16:14:20 -080015503 * same as the dimensions of the View itself and centers the shadow under
15504 * the touch point.
15505 * </p>
Christopher Tate2c095f32010-10-04 14:13:40 -070015506 *
Joe Malin32736f02011-01-19 16:14:20 -080015507 * @param shadowSize A {@link android.graphics.Point} containing the width and height
15508 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the
15509 * desired width and must set {@link android.graphics.Point#y} to the desired height of the
15510 * image.
15511 *
15512 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the
15513 * shadow image that should be underneath the touch point during the drag and drop
15514 * operation. Your application must set {@link android.graphics.Point#x} to the
15515 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position.
Christopher Tate2c095f32010-10-04 14:13:40 -070015516 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015517 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070015518 final View view = mView.get();
15519 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015520 shadowSize.set(view.getWidth(), view.getHeight());
15521 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070015522 } else {
15523 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
15524 }
Christopher Tate2c095f32010-10-04 14:13:40 -070015525 }
15526
15527 /**
Joe Malin32736f02011-01-19 16:14:20 -080015528 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object
15529 * based on the dimensions it received from the
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015530 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate2c095f32010-10-04 14:13:40 -070015531 *
Joe Malin32736f02011-01-19 16:14:20 -080015532 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image.
Christopher Tate2c095f32010-10-04 14:13:40 -070015533 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015534 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070015535 final View view = mView.get();
15536 if (view != null) {
15537 view.draw(canvas);
15538 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015539 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070015540 }
Christopher Tate2c095f32010-10-04 14:13:40 -070015541 }
15542 }
15543
15544 /**
Joe Malin32736f02011-01-19 16:14:20 -080015545 * Starts a drag and drop operation. When your application calls this method, it passes a
15546 * {@link android.view.View.DragShadowBuilder} object to the system. The
15547 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)}
15548 * to get metrics for the drag shadow, and then calls the object's
15549 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself.
15550 * <p>
15551 * Once the system has the drag shadow, it begins the drag and drop operation by sending
15552 * drag events to all the View objects in your application that are currently visible. It does
15553 * this either by calling the View object's drag listener (an implementation of
15554 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the
15555 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method.
15556 * Both are passed a {@link android.view.DragEvent} object that has a
15557 * {@link android.view.DragEvent#getAction()} value of
15558 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}.
15559 * </p>
15560 * <p>
15561 * Your application can invoke startDrag() on any attached View object. The View object does not
15562 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to
15563 * be related to the View the user selected for dragging.
15564 * </p>
15565 * @param data A {@link android.content.ClipData} object pointing to the data to be
15566 * transferred by the drag and drop operation.
15567 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the
15568 * drag shadow.
15569 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and
15570 * drop operation. This Object is put into every DragEvent object sent by the system during the
15571 * current drag.
15572 * <p>
15573 * myLocalState is a lightweight mechanism for the sending information from the dragged View
15574 * to the target Views. For example, it can contain flags that differentiate between a
15575 * a copy operation and a move operation.
15576 * </p>
15577 * @param flags Flags that control the drag and drop operation. No flags are currently defined,
15578 * so the parameter should be set to 0.
15579 * @return {@code true} if the method completes successfully, or
15580 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to
15581 * do a drag, and so no drag operation is in progress.
Christopher Tatea53146c2010-09-07 11:57:52 -070015582 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015583 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015584 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070015585 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015586 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070015587 }
15588 boolean okay = false;
15589
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015590 Point shadowSize = new Point();
15591 Point shadowTouchPoint = new Point();
15592 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070015593
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015594 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
15595 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
15596 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070015597 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015598
Chris Tatea32dcf72010-10-14 12:13:50 -070015599 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015600 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
15601 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070015602 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015603 Surface surface = new Surface();
15604 try {
15605 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015606 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070015607 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070015608 + " surface=" + surface);
15609 if (token != null) {
15610 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070015611 try {
Chris Tate6b391282010-10-14 15:48:59 -070015612 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015613 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070015614 } finally {
15615 surface.unlockCanvasAndPost(canvas);
15616 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015617
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070015618 final ViewRootImpl root = getViewRootImpl();
Christopher Tate407b4e92010-11-30 17:14:08 -080015619
15620 // Cache the local state object for delivery with DragEvents
15621 root.setLocalDragState(myLocalState);
15622
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015623 // repurpose 'shadowSize' for the last touch point
15624 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070015625
Christopher Tatea53146c2010-09-07 11:57:52 -070015626 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015627 shadowSize.x, shadowSize.y,
15628 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070015629 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tate8f73b5d2011-09-12 15:22:12 -070015630
15631 // Off and running! Release our local surface instance; the drag
15632 // shadow surface is now managed by the system process.
15633 surface.release();
Christopher Tatea53146c2010-09-07 11:57:52 -070015634 }
15635 } catch (Exception e) {
15636 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
15637 surface.destroy();
15638 }
15639
15640 return okay;
15641 }
15642
Christopher Tatea53146c2010-09-07 11:57:52 -070015643 /**
Joe Malin32736f02011-01-19 16:14:20 -080015644 * Handles drag events sent by the system following a call to
15645 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}.
15646 *<p>
15647 * When the system calls this method, it passes a
15648 * {@link android.view.DragEvent} object. A call to
15649 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined
15650 * in DragEvent. The method uses these to determine what is happening in the drag and drop
15651 * operation.
15652 * @param event The {@link android.view.DragEvent} sent by the system.
15653 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined
15654 * in DragEvent, indicating the type of drag event represented by this object.
15655 * @return {@code true} if the method was successful, otherwise {@code false}.
15656 * <p>
15657 * The method should return {@code true} in response to an action type of
15658 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current
15659 * operation.
15660 * </p>
15661 * <p>
15662 * The method should also return {@code true} in response to an action type of
15663 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or
15664 * {@code false} if it didn't.
15665 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070015666 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070015667 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070015668 return false;
15669 }
15670
15671 /**
Joe Malin32736f02011-01-19 16:14:20 -080015672 * Detects if this View is enabled and has a drag event listener.
15673 * If both are true, then it calls the drag event listener with the
15674 * {@link android.view.DragEvent} it received. If the drag event listener returns
15675 * {@code true}, then dispatchDragEvent() returns {@code true}.
15676 * <p>
15677 * For all other cases, the method calls the
15678 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler
15679 * method and returns its result.
15680 * </p>
15681 * <p>
15682 * This ensures that a drag event is always consumed, even if the View does not have a drag
15683 * event listener. However, if the View has a listener and the listener returns true, then
15684 * onDragEvent() is not called.
15685 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070015686 */
15687 public boolean dispatchDragEvent(DragEvent event) {
Romain Guy676b1732011-02-14 14:45:33 -080015688 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015689 ListenerInfo li = mListenerInfo;
15690 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
15691 && li.mOnDragListener.onDrag(this, event)) {
Chris Tate32affef2010-10-18 15:29:21 -070015692 return true;
15693 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015694 return onDragEvent(event);
15695 }
15696
Christopher Tate3d4bf172011-03-28 16:16:46 -070015697 boolean canAcceptDrag() {
15698 return (mPrivateFlags2 & DRAG_CAN_ACCEPT) != 0;
15699 }
15700
Christopher Tatea53146c2010-09-07 11:57:52 -070015701 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070015702 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
15703 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070015704 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070015705 */
15706 public void onCloseSystemDialogs(String reason) {
15707 }
Joe Malin32736f02011-01-19 16:14:20 -080015708
Dianne Hackbornffa42482009-09-23 22:20:11 -070015709 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015710 * Given a Drawable whose bounds have been set to draw into this view,
Romain Guy5c22a8c2011-05-13 11:48:45 -070015711 * update a Region being computed for
15712 * {@link #gatherTransparentRegion(android.graphics.Region)} so
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015713 * that any non-transparent parts of the Drawable are removed from the
15714 * given transparent region.
15715 *
15716 * @param dr The Drawable whose transparency is to be applied to the region.
15717 * @param region A Region holding the current transparency information,
15718 * where any parts of the region that are set are considered to be
15719 * transparent. On return, this region will be modified to have the
15720 * transparency information reduced by the corresponding parts of the
15721 * Drawable that are not transparent.
15722 * {@hide}
15723 */
15724 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
15725 if (DBG) {
15726 Log.i("View", "Getting transparent region for: " + this);
15727 }
15728 final Region r = dr.getTransparentRegion();
15729 final Rect db = dr.getBounds();
15730 final AttachInfo attachInfo = mAttachInfo;
15731 if (r != null && attachInfo != null) {
15732 final int w = getRight()-getLeft();
15733 final int h = getBottom()-getTop();
15734 if (db.left > 0) {
15735 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
15736 r.op(0, 0, db.left, h, Region.Op.UNION);
15737 }
15738 if (db.right < w) {
15739 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
15740 r.op(db.right, 0, w, h, Region.Op.UNION);
15741 }
15742 if (db.top > 0) {
15743 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
15744 r.op(0, 0, w, db.top, Region.Op.UNION);
15745 }
15746 if (db.bottom < h) {
15747 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
15748 r.op(0, db.bottom, w, h, Region.Op.UNION);
15749 }
15750 final int[] location = attachInfo.mTransparentLocation;
15751 getLocationInWindow(location);
15752 r.translate(location[0], location[1]);
15753 region.op(r, Region.Op.INTERSECT);
15754 } else {
15755 region.op(db, Region.Op.DIFFERENCE);
15756 }
15757 }
15758
Patrick Dubroye0a799a2011-05-04 16:19:22 -070015759 private void checkForLongClick(int delayOffset) {
15760 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
15761 mHasPerformedLongPress = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015762
Patrick Dubroye0a799a2011-05-04 16:19:22 -070015763 if (mPendingCheckForLongPress == null) {
15764 mPendingCheckForLongPress = new CheckForLongPress();
15765 }
15766 mPendingCheckForLongPress.rememberWindowAttachCount();
15767 postDelayed(mPendingCheckForLongPress,
15768 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015769 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015770 }
15771
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015772 /**
15773 * Inflate a view from an XML resource. This convenience method wraps the {@link
15774 * LayoutInflater} class, which provides a full range of options for view inflation.
15775 *
15776 * @param context The Context object for your activity or application.
15777 * @param resource The resource ID to inflate
15778 * @param root A view group that will be the parent. Used to properly inflate the
15779 * layout_* parameters.
15780 * @see LayoutInflater
15781 */
15782 public static View inflate(Context context, int resource, ViewGroup root) {
15783 LayoutInflater factory = LayoutInflater.from(context);
15784 return factory.inflate(resource, root);
15785 }
Romain Guy33e72ae2010-07-17 12:40:29 -070015786
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015787 /**
Adam Powell637d3372010-08-25 14:37:03 -070015788 * Scroll the view with standard behavior for scrolling beyond the normal
15789 * content boundaries. Views that call this method should override
15790 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
15791 * results of an over-scroll operation.
15792 *
15793 * Views can use this method to handle any touch or fling-based scrolling.
15794 *
15795 * @param deltaX Change in X in pixels
15796 * @param deltaY Change in Y in pixels
15797 * @param scrollX Current X scroll value in pixels before applying deltaX
15798 * @param scrollY Current Y scroll value in pixels before applying deltaY
15799 * @param scrollRangeX Maximum content scroll range along the X axis
15800 * @param scrollRangeY Maximum content scroll range along the Y axis
15801 * @param maxOverScrollX Number of pixels to overscroll by in either direction
15802 * along the X axis.
15803 * @param maxOverScrollY Number of pixels to overscroll by in either direction
15804 * along the Y axis.
15805 * @param isTouchEvent true if this scroll operation is the result of a touch event.
15806 * @return true if scrolling was clamped to an over-scroll boundary along either
15807 * axis, false otherwise.
15808 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070015809 @SuppressWarnings({"UnusedParameters"})
Adam Powell637d3372010-08-25 14:37:03 -070015810 protected boolean overScrollBy(int deltaX, int deltaY,
15811 int scrollX, int scrollY,
15812 int scrollRangeX, int scrollRangeY,
15813 int maxOverScrollX, int maxOverScrollY,
15814 boolean isTouchEvent) {
15815 final int overScrollMode = mOverScrollMode;
15816 final boolean canScrollHorizontal =
15817 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
15818 final boolean canScrollVertical =
15819 computeVerticalScrollRange() > computeVerticalScrollExtent();
15820 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
15821 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
15822 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
15823 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
15824
15825 int newScrollX = scrollX + deltaX;
15826 if (!overScrollHorizontal) {
15827 maxOverScrollX = 0;
15828 }
15829
15830 int newScrollY = scrollY + deltaY;
15831 if (!overScrollVertical) {
15832 maxOverScrollY = 0;
15833 }
15834
15835 // Clamp values if at the limits and record
15836 final int left = -maxOverScrollX;
15837 final int right = maxOverScrollX + scrollRangeX;
15838 final int top = -maxOverScrollY;
15839 final int bottom = maxOverScrollY + scrollRangeY;
15840
15841 boolean clampedX = false;
15842 if (newScrollX > right) {
15843 newScrollX = right;
15844 clampedX = true;
15845 } else if (newScrollX < left) {
15846 newScrollX = left;
15847 clampedX = true;
15848 }
15849
15850 boolean clampedY = false;
15851 if (newScrollY > bottom) {
15852 newScrollY = bottom;
15853 clampedY = true;
15854 } else if (newScrollY < top) {
15855 newScrollY = top;
15856 clampedY = true;
15857 }
15858
15859 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
15860
15861 return clampedX || clampedY;
15862 }
15863
15864 /**
15865 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
15866 * respond to the results of an over-scroll operation.
15867 *
15868 * @param scrollX New X scroll value in pixels
15869 * @param scrollY New Y scroll value in pixels
15870 * @param clampedX True if scrollX was clamped to an over-scroll boundary
15871 * @param clampedY True if scrollY was clamped to an over-scroll boundary
15872 */
15873 protected void onOverScrolled(int scrollX, int scrollY,
15874 boolean clampedX, boolean clampedY) {
15875 // Intentionally empty.
15876 }
15877
15878 /**
15879 * Returns the over-scroll mode for this view. The result will be
15880 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
15881 * (allow over-scrolling only if the view content is larger than the container),
15882 * or {@link #OVER_SCROLL_NEVER}.
15883 *
15884 * @return This view's over-scroll mode.
15885 */
15886 public int getOverScrollMode() {
15887 return mOverScrollMode;
15888 }
15889
15890 /**
15891 * Set the over-scroll mode for this view. Valid over-scroll modes are
15892 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
15893 * (allow over-scrolling only if the view content is larger than the container),
15894 * or {@link #OVER_SCROLL_NEVER}.
15895 *
15896 * Setting the over-scroll mode of a view will have an effect only if the
15897 * view is capable of scrolling.
15898 *
15899 * @param overScrollMode The new over-scroll mode for this view.
15900 */
15901 public void setOverScrollMode(int overScrollMode) {
15902 if (overScrollMode != OVER_SCROLL_ALWAYS &&
15903 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
15904 overScrollMode != OVER_SCROLL_NEVER) {
15905 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
15906 }
15907 mOverScrollMode = overScrollMode;
15908 }
15909
15910 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080015911 * Gets a scale factor that determines the distance the view should scroll
15912 * vertically in response to {@link MotionEvent#ACTION_SCROLL}.
15913 * @return The vertical scroll scale factor.
15914 * @hide
15915 */
15916 protected float getVerticalScrollFactor() {
15917 if (mVerticalScrollFactor == 0) {
15918 TypedValue outValue = new TypedValue();
15919 if (!mContext.getTheme().resolveAttribute(
15920 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) {
15921 throw new IllegalStateException(
15922 "Expected theme to define listPreferredItemHeight.");
15923 }
15924 mVerticalScrollFactor = outValue.getDimension(
15925 mContext.getResources().getDisplayMetrics());
15926 }
15927 return mVerticalScrollFactor;
15928 }
15929
15930 /**
15931 * Gets a scale factor that determines the distance the view should scroll
15932 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}.
15933 * @return The horizontal scroll scale factor.
15934 * @hide
15935 */
15936 protected float getHorizontalScrollFactor() {
15937 // TODO: Should use something else.
15938 return getVerticalScrollFactor();
15939 }
15940
Fabrice Di Meglio22268862011-06-27 18:13:18 -070015941 /**
15942 * Return the value specifying the text direction or policy that was set with
15943 * {@link #setTextDirection(int)}.
15944 *
15945 * @return the defined text direction. It can be one of:
15946 *
15947 * {@link #TEXT_DIRECTION_INHERIT},
15948 * {@link #TEXT_DIRECTION_FIRST_STRONG}
15949 * {@link #TEXT_DIRECTION_ANY_RTL},
15950 * {@link #TEXT_DIRECTION_LTR},
15951 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070015952 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070015953 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070015954 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -070015955 @ViewDebug.ExportedProperty(category = "text", mapping = {
15956 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"),
15957 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"),
15958 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"),
15959 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"),
15960 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"),
15961 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE")
15962 })
Fabrice Di Meglio22268862011-06-27 18:13:18 -070015963 public int getTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070015964 return (mPrivateFlags2 & TEXT_DIRECTION_MASK) >> TEXT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070015965 }
15966
15967 /**
15968 * Set the text direction.
15969 *
15970 * @param textDirection the direction to set. Should be one of:
15971 *
15972 * {@link #TEXT_DIRECTION_INHERIT},
15973 * {@link #TEXT_DIRECTION_FIRST_STRONG}
15974 * {@link #TEXT_DIRECTION_ANY_RTL},
15975 * {@link #TEXT_DIRECTION_LTR},
15976 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070015977 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070015978 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070015979 */
15980 public void setTextDirection(int textDirection) {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070015981 if (getTextDirection() != textDirection) {
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070015982 // Reset the current text direction and the resolved one
Fabrice Di Megliob934db72012-03-20 14:33:01 -070015983 mPrivateFlags2 &= ~TEXT_DIRECTION_MASK;
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070015984 resetResolvedTextDirection();
Fabrice Di Megliob934db72012-03-20 14:33:01 -070015985 // Set the new text direction
15986 mPrivateFlags2 |= ((textDirection << TEXT_DIRECTION_MASK_SHIFT) & TEXT_DIRECTION_MASK);
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070015987 // Refresh
Fabrice Di Meglio22268862011-06-27 18:13:18 -070015988 requestLayout();
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070015989 invalidate(true);
Fabrice Di Meglio22268862011-06-27 18:13:18 -070015990 }
15991 }
15992
15993 /**
15994 * Return the resolved text direction.
15995 *
Fabrice Di Megliob934db72012-03-20 14:33:01 -070015996 * This needs resolution if the value is TEXT_DIRECTION_INHERIT. The resolution matches
15997 * {@link #getTextDirection()}if it is not TEXT_DIRECTION_INHERIT, otherwise resolution proceeds
15998 * up the parent chain of the view. if there is no parent, then it will return the default
15999 * {@link #TEXT_DIRECTION_FIRST_STRONG}.
16000 *
16001 * @return the resolved text direction. Returns one of:
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016002 *
Doug Feltcb3791202011-07-07 11:57:48 -070016003 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16004 * {@link #TEXT_DIRECTION_ANY_RTL},
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016005 * {@link #TEXT_DIRECTION_LTR},
16006 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016007 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016008 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016009 */
16010 public int getResolvedTextDirection() {
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070016011 // The text direction will be resolved only if needed
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016012 if ((mPrivateFlags2 & TEXT_DIRECTION_RESOLVED) != TEXT_DIRECTION_RESOLVED) {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016013 resolveTextDirection();
16014 }
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016015 return (mPrivateFlags2 & TEXT_DIRECTION_RESOLVED_MASK) >> TEXT_DIRECTION_RESOLVED_MASK_SHIFT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016016 }
16017
16018 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016019 * Resolve the text direction. Will call {@link View#onResolvedTextDirectionChanged} when
16020 * resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016021 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016022 */
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016023 public void resolveTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016024 // Reset any previous text direction resolution
16025 mPrivateFlags2 &= ~(TEXT_DIRECTION_RESOLVED | TEXT_DIRECTION_RESOLVED_MASK);
16026
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016027 if (hasRtlSupport()) {
16028 // Set resolved text direction flag depending on text direction flag
16029 final int textDirection = getTextDirection();
16030 switch(textDirection) {
16031 case TEXT_DIRECTION_INHERIT:
16032 if (canResolveTextDirection()) {
16033 ViewGroup viewGroup = ((ViewGroup) mParent);
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016034
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016035 // Set current resolved direction to the same value as the parent's one
16036 final int parentResolvedDirection = viewGroup.getResolvedTextDirection();
16037 switch (parentResolvedDirection) {
16038 case TEXT_DIRECTION_FIRST_STRONG:
16039 case TEXT_DIRECTION_ANY_RTL:
16040 case TEXT_DIRECTION_LTR:
16041 case TEXT_DIRECTION_RTL:
16042 case TEXT_DIRECTION_LOCALE:
16043 mPrivateFlags2 |=
16044 (parentResolvedDirection << TEXT_DIRECTION_RESOLVED_MASK_SHIFT);
16045 break;
16046 default:
16047 // Default resolved direction is "first strong" heuristic
16048 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
16049 }
16050 } else {
16051 // We cannot do the resolution if there is no parent, so use the default one
16052 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016053 }
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016054 break;
16055 case TEXT_DIRECTION_FIRST_STRONG:
16056 case TEXT_DIRECTION_ANY_RTL:
16057 case TEXT_DIRECTION_LTR:
16058 case TEXT_DIRECTION_RTL:
16059 case TEXT_DIRECTION_LOCALE:
16060 // Resolved direction is the same as text direction
16061 mPrivateFlags2 |= (textDirection << TEXT_DIRECTION_RESOLVED_MASK_SHIFT);
16062 break;
16063 default:
16064 // Default resolved direction is "first strong" heuristic
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016065 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016066 }
16067 } else {
16068 // Default resolved direction is "first strong" heuristic
16069 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016070 }
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016071
16072 // Set to resolved
16073 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016074 onResolvedTextDirectionChanged();
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016075 }
16076
16077 /**
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016078 * Called when text direction has been resolved. Subclasses that care about text direction
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016079 * resolution should override this method.
16080 *
16081 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016082 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016083 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016084 public void onResolvedTextDirectionChanged() {
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016085 }
16086
16087 /**
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016088 * Check if text direction resolution can be done.
16089 *
16090 * @return true if text direction resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016091 * @hide
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016092 */
16093 public boolean canResolveTextDirection() {
16094 switch (getTextDirection()) {
16095 case TEXT_DIRECTION_INHERIT:
16096 return (mParent != null) && (mParent instanceof ViewGroup);
16097 default:
16098 return true;
16099 }
16100 }
16101
16102 /**
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016103 * Reset resolved text direction. Text direction can be resolved with a call to
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016104 * getResolvedTextDirection(). Will call {@link View#onResolvedTextDirectionReset} when
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016105 * reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016106 * @hide
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016107 */
16108 public void resetResolvedTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016109 mPrivateFlags2 &= ~(TEXT_DIRECTION_RESOLVED | TEXT_DIRECTION_RESOLVED_MASK);
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016110 onResolvedTextDirectionReset();
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016111 }
16112
16113 /**
16114 * Called when text direction is reset. Subclasses that care about text direction reset should
16115 * override this method and do a reset of the text direction of their children. The default
16116 * implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016117 * @hide
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016118 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016119 public void onResolvedTextDirectionReset() {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016120 }
16121
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016122 /**
16123 * Return the value specifying the text alignment or policy that was set with
16124 * {@link #setTextAlignment(int)}.
16125 *
16126 * @return the defined text alignment. It can be one of:
16127 *
16128 * {@link #TEXT_ALIGNMENT_INHERIT},
16129 * {@link #TEXT_ALIGNMENT_GRAVITY},
16130 * {@link #TEXT_ALIGNMENT_CENTER},
16131 * {@link #TEXT_ALIGNMENT_TEXT_START},
16132 * {@link #TEXT_ALIGNMENT_TEXT_END},
16133 * {@link #TEXT_ALIGNMENT_VIEW_START},
16134 * {@link #TEXT_ALIGNMENT_VIEW_END}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016135 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016136 */
16137 @ViewDebug.ExportedProperty(category = "text", mapping = {
16138 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"),
16139 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"),
16140 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"),
16141 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"),
16142 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"),
16143 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"),
16144 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END")
16145 })
16146 public int getTextAlignment() {
16147 return (mPrivateFlags2 & TEXT_ALIGNMENT_MASK) >> TEXT_ALIGNMENT_MASK_SHIFT;
16148 }
16149
16150 /**
16151 * Set the text alignment.
16152 *
16153 * @param textAlignment The text alignment to set. Should be one of
16154 *
16155 * {@link #TEXT_ALIGNMENT_INHERIT},
16156 * {@link #TEXT_ALIGNMENT_GRAVITY},
16157 * {@link #TEXT_ALIGNMENT_CENTER},
16158 * {@link #TEXT_ALIGNMENT_TEXT_START},
16159 * {@link #TEXT_ALIGNMENT_TEXT_END},
16160 * {@link #TEXT_ALIGNMENT_VIEW_START},
16161 * {@link #TEXT_ALIGNMENT_VIEW_END}
16162 *
16163 * @attr ref android.R.styleable#View_textAlignment
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016164 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016165 */
16166 public void setTextAlignment(int textAlignment) {
16167 if (textAlignment != getTextAlignment()) {
16168 // Reset the current and resolved text alignment
16169 mPrivateFlags2 &= ~TEXT_ALIGNMENT_MASK;
16170 resetResolvedTextAlignment();
16171 // Set the new text alignment
16172 mPrivateFlags2 |= ((textAlignment << TEXT_ALIGNMENT_MASK_SHIFT) & TEXT_ALIGNMENT_MASK);
16173 // Refresh
16174 requestLayout();
16175 invalidate(true);
16176 }
16177 }
16178
16179 /**
16180 * Return the resolved text alignment.
16181 *
16182 * The resolved text alignment. This needs resolution if the value is
16183 * TEXT_ALIGNMENT_INHERIT. The resolution matches {@link #setTextAlignment(int)} if it is
16184 * not TEXT_ALIGNMENT_INHERIT, otherwise resolution proceeds up the parent chain of the view.
16185 *
16186 * @return the resolved text alignment. Returns one of:
16187 *
16188 * {@link #TEXT_ALIGNMENT_GRAVITY},
16189 * {@link #TEXT_ALIGNMENT_CENTER},
16190 * {@link #TEXT_ALIGNMENT_TEXT_START},
16191 * {@link #TEXT_ALIGNMENT_TEXT_END},
16192 * {@link #TEXT_ALIGNMENT_VIEW_START},
16193 * {@link #TEXT_ALIGNMENT_VIEW_END}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016194 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016195 */
16196 @ViewDebug.ExportedProperty(category = "text", mapping = {
16197 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"),
16198 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"),
16199 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"),
16200 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"),
16201 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"),
16202 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"),
16203 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END")
16204 })
16205 public int getResolvedTextAlignment() {
16206 // If text alignment is not resolved, then resolve it
16207 if ((mPrivateFlags2 & TEXT_ALIGNMENT_RESOLVED) != TEXT_ALIGNMENT_RESOLVED) {
16208 resolveTextAlignment();
16209 }
16210 return (mPrivateFlags2 & TEXT_ALIGNMENT_RESOLVED_MASK) >> TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT;
16211 }
16212
16213 /**
16214 * Resolve the text alignment. Will call {@link View#onResolvedTextAlignmentChanged} when
16215 * resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016216 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016217 */
16218 public void resolveTextAlignment() {
16219 // Reset any previous text alignment resolution
16220 mPrivateFlags2 &= ~(TEXT_ALIGNMENT_RESOLVED | TEXT_ALIGNMENT_RESOLVED_MASK);
16221
16222 if (hasRtlSupport()) {
16223 // Set resolved text alignment flag depending on text alignment flag
16224 final int textAlignment = getTextAlignment();
16225 switch (textAlignment) {
16226 case TEXT_ALIGNMENT_INHERIT:
16227 // Check if we can resolve the text alignment
16228 if (canResolveLayoutDirection() && mParent instanceof View) {
16229 View view = (View) mParent;
16230
16231 final int parentResolvedTextAlignment = view.getResolvedTextAlignment();
16232 switch (parentResolvedTextAlignment) {
16233 case TEXT_ALIGNMENT_GRAVITY:
16234 case TEXT_ALIGNMENT_TEXT_START:
16235 case TEXT_ALIGNMENT_TEXT_END:
16236 case TEXT_ALIGNMENT_CENTER:
16237 case TEXT_ALIGNMENT_VIEW_START:
16238 case TEXT_ALIGNMENT_VIEW_END:
16239 // Resolved text alignment is the same as the parent resolved
16240 // text alignment
16241 mPrivateFlags2 |=
16242 (parentResolvedTextAlignment << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT);
16243 break;
16244 default:
16245 // Use default resolved text alignment
16246 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16247 }
16248 }
16249 else {
16250 // We cannot do the resolution if there is no parent so use the default
16251 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16252 }
16253 break;
16254 case TEXT_ALIGNMENT_GRAVITY:
16255 case TEXT_ALIGNMENT_TEXT_START:
16256 case TEXT_ALIGNMENT_TEXT_END:
16257 case TEXT_ALIGNMENT_CENTER:
16258 case TEXT_ALIGNMENT_VIEW_START:
16259 case TEXT_ALIGNMENT_VIEW_END:
16260 // Resolved text alignment is the same as text alignment
16261 mPrivateFlags2 |= (textAlignment << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT);
16262 break;
16263 default:
16264 // Use default resolved text alignment
16265 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16266 }
16267 } else {
16268 // Use default resolved text alignment
16269 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16270 }
16271
16272 // Set the resolved
16273 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED;
16274 onResolvedTextAlignmentChanged();
16275 }
16276
16277 /**
16278 * Check if text alignment resolution can be done.
16279 *
16280 * @return true if text alignment resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016281 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016282 */
16283 public boolean canResolveTextAlignment() {
16284 switch (getTextAlignment()) {
16285 case TEXT_DIRECTION_INHERIT:
16286 return (mParent != null);
16287 default:
16288 return true;
16289 }
16290 }
16291
16292 /**
16293 * Called when text alignment has been resolved. Subclasses that care about text alignment
16294 * resolution should override this method.
16295 *
16296 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016297 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016298 */
16299 public void onResolvedTextAlignmentChanged() {
16300 }
16301
16302 /**
16303 * Reset resolved text alignment. Text alignment can be resolved with a call to
16304 * getResolvedTextAlignment(). Will call {@link View#onResolvedTextAlignmentReset} when
16305 * reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016306 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016307 */
16308 public void resetResolvedTextAlignment() {
16309 // Reset any previous text alignment resolution
16310 mPrivateFlags2 &= ~(TEXT_ALIGNMENT_RESOLVED | TEXT_ALIGNMENT_RESOLVED_MASK);
16311 onResolvedTextAlignmentReset();
16312 }
16313
16314 /**
16315 * Called when text alignment is reset. Subclasses that care about text alignment reset should
16316 * override this method and do a reset of the text alignment of their children. The default
16317 * implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016318 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016319 */
16320 public void onResolvedTextAlignmentReset() {
16321 }
16322
Chet Haaseb39f0512011-05-24 14:36:40 -070016323 //
16324 // Properties
16325 //
16326 /**
16327 * A Property wrapper around the <code>alpha</code> functionality handled by the
16328 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods.
16329 */
Chet Haased47f1532011-12-16 11:18:52 -080016330 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016331 @Override
16332 public void setValue(View object, float value) {
16333 object.setAlpha(value);
16334 }
16335
16336 @Override
16337 public Float get(View object) {
16338 return object.getAlpha();
16339 }
16340 };
16341
16342 /**
16343 * A Property wrapper around the <code>translationX</code> functionality handled by the
16344 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods.
16345 */
Chet Haased47f1532011-12-16 11:18:52 -080016346 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016347 @Override
16348 public void setValue(View object, float value) {
16349 object.setTranslationX(value);
16350 }
16351
16352 @Override
16353 public Float get(View object) {
16354 return object.getTranslationX();
16355 }
16356 };
16357
16358 /**
16359 * A Property wrapper around the <code>translationY</code> functionality handled by the
16360 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods.
16361 */
Chet Haased47f1532011-12-16 11:18:52 -080016362 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016363 @Override
16364 public void setValue(View object, float value) {
16365 object.setTranslationY(value);
16366 }
16367
16368 @Override
16369 public Float get(View object) {
16370 return object.getTranslationY();
16371 }
16372 };
16373
16374 /**
16375 * A Property wrapper around the <code>x</code> functionality handled by the
16376 * {@link View#setX(float)} and {@link View#getX()} methods.
16377 */
Chet Haased47f1532011-12-16 11:18:52 -080016378 public static final Property<View, Float> X = new FloatProperty<View>("x") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016379 @Override
16380 public void setValue(View object, float value) {
16381 object.setX(value);
16382 }
16383
16384 @Override
16385 public Float get(View object) {
16386 return object.getX();
16387 }
16388 };
16389
16390 /**
16391 * A Property wrapper around the <code>y</code> functionality handled by the
16392 * {@link View#setY(float)} and {@link View#getY()} methods.
16393 */
Chet Haased47f1532011-12-16 11:18:52 -080016394 public static final Property<View, Float> Y = new FloatProperty<View>("y") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016395 @Override
16396 public void setValue(View object, float value) {
16397 object.setY(value);
16398 }
16399
16400 @Override
16401 public Float get(View object) {
16402 return object.getY();
16403 }
16404 };
16405
16406 /**
16407 * A Property wrapper around the <code>rotation</code> functionality handled by the
16408 * {@link View#setRotation(float)} and {@link View#getRotation()} methods.
16409 */
Chet Haased47f1532011-12-16 11:18:52 -080016410 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016411 @Override
16412 public void setValue(View object, float value) {
16413 object.setRotation(value);
16414 }
16415
16416 @Override
16417 public Float get(View object) {
16418 return object.getRotation();
16419 }
16420 };
16421
16422 /**
16423 * A Property wrapper around the <code>rotationX</code> functionality handled by the
16424 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods.
16425 */
Chet Haased47f1532011-12-16 11:18:52 -080016426 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016427 @Override
16428 public void setValue(View object, float value) {
16429 object.setRotationX(value);
16430 }
16431
16432 @Override
16433 public Float get(View object) {
16434 return object.getRotationX();
16435 }
16436 };
16437
16438 /**
16439 * A Property wrapper around the <code>rotationY</code> functionality handled by the
16440 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods.
16441 */
Chet Haased47f1532011-12-16 11:18:52 -080016442 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016443 @Override
16444 public void setValue(View object, float value) {
16445 object.setRotationY(value);
16446 }
16447
16448 @Override
16449 public Float get(View object) {
16450 return object.getRotationY();
16451 }
16452 };
16453
16454 /**
16455 * A Property wrapper around the <code>scaleX</code> functionality handled by the
16456 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods.
16457 */
Chet Haased47f1532011-12-16 11:18:52 -080016458 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016459 @Override
16460 public void setValue(View object, float value) {
16461 object.setScaleX(value);
16462 }
16463
16464 @Override
16465 public Float get(View object) {
16466 return object.getScaleX();
16467 }
16468 };
16469
16470 /**
16471 * A Property wrapper around the <code>scaleY</code> functionality handled by the
16472 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods.
16473 */
Chet Haased47f1532011-12-16 11:18:52 -080016474 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016475 @Override
16476 public void setValue(View object, float value) {
16477 object.setScaleY(value);
16478 }
16479
16480 @Override
16481 public Float get(View object) {
16482 return object.getScaleY();
16483 }
16484 };
16485
Jeff Brown33bbfd22011-02-24 20:55:35 -080016486 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016487 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
16488 * Each MeasureSpec represents a requirement for either the width or the height.
16489 * A MeasureSpec is comprised of a size and a mode. There are three possible
16490 * modes:
16491 * <dl>
16492 * <dt>UNSPECIFIED</dt>
16493 * <dd>
16494 * The parent has not imposed any constraint on the child. It can be whatever size
16495 * it wants.
16496 * </dd>
16497 *
16498 * <dt>EXACTLY</dt>
16499 * <dd>
16500 * The parent has determined an exact size for the child. The child is going to be
16501 * given those bounds regardless of how big it wants to be.
16502 * </dd>
16503 *
16504 * <dt>AT_MOST</dt>
16505 * <dd>
16506 * The child can be as large as it wants up to the specified size.
16507 * </dd>
16508 * </dl>
16509 *
16510 * MeasureSpecs are implemented as ints to reduce object allocation. This class
16511 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
16512 */
16513 public static class MeasureSpec {
16514 private static final int MODE_SHIFT = 30;
16515 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
16516
16517 /**
16518 * Measure specification mode: The parent has not imposed any constraint
16519 * on the child. It can be whatever size it wants.
16520 */
16521 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
16522
16523 /**
16524 * Measure specification mode: The parent has determined an exact size
16525 * for the child. The child is going to be given those bounds regardless
16526 * of how big it wants to be.
16527 */
16528 public static final int EXACTLY = 1 << MODE_SHIFT;
16529
16530 /**
16531 * Measure specification mode: The child can be as large as it wants up
16532 * to the specified size.
16533 */
16534 public static final int AT_MOST = 2 << MODE_SHIFT;
16535
16536 /**
16537 * Creates a measure specification based on the supplied size and mode.
16538 *
16539 * The mode must always be one of the following:
16540 * <ul>
16541 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
16542 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
16543 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
16544 * </ul>
16545 *
16546 * @param size the size of the measure specification
16547 * @param mode the mode of the measure specification
16548 * @return the measure specification based on size and mode
16549 */
16550 public static int makeMeasureSpec(int size, int mode) {
16551 return size + mode;
16552 }
16553
16554 /**
16555 * Extracts the mode from the supplied measure specification.
16556 *
16557 * @param measureSpec the measure specification to extract the mode from
16558 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
16559 * {@link android.view.View.MeasureSpec#AT_MOST} or
16560 * {@link android.view.View.MeasureSpec#EXACTLY}
16561 */
16562 public static int getMode(int measureSpec) {
16563 return (measureSpec & MODE_MASK);
16564 }
16565
16566 /**
16567 * Extracts the size from the supplied measure specification.
16568 *
16569 * @param measureSpec the measure specification to extract the size from
16570 * @return the size in pixels defined in the supplied measure specification
16571 */
16572 public static int getSize(int measureSpec) {
16573 return (measureSpec & ~MODE_MASK);
16574 }
16575
16576 /**
16577 * Returns a String representation of the specified measure
16578 * specification.
16579 *
16580 * @param measureSpec the measure specification to convert to a String
16581 * @return a String with the following format: "MeasureSpec: MODE SIZE"
16582 */
16583 public static String toString(int measureSpec) {
16584 int mode = getMode(measureSpec);
16585 int size = getSize(measureSpec);
16586
16587 StringBuilder sb = new StringBuilder("MeasureSpec: ");
16588
16589 if (mode == UNSPECIFIED)
16590 sb.append("UNSPECIFIED ");
16591 else if (mode == EXACTLY)
16592 sb.append("EXACTLY ");
16593 else if (mode == AT_MOST)
16594 sb.append("AT_MOST ");
16595 else
16596 sb.append(mode).append(" ");
16597
16598 sb.append(size);
16599 return sb.toString();
16600 }
16601 }
16602
16603 class CheckForLongPress implements Runnable {
16604
16605 private int mOriginalWindowAttachCount;
16606
16607 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070016608 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016609 && mOriginalWindowAttachCount == mWindowAttachCount) {
16610 if (performLongClick()) {
16611 mHasPerformedLongPress = true;
16612 }
16613 }
16614 }
16615
16616 public void rememberWindowAttachCount() {
16617 mOriginalWindowAttachCount = mWindowAttachCount;
16618 }
16619 }
Joe Malin32736f02011-01-19 16:14:20 -080016620
Adam Powelle14579b2009-12-16 18:39:52 -080016621 private final class CheckForTap implements Runnable {
16622 public void run() {
16623 mPrivateFlags &= ~PREPRESSED;
Adam Powell4d6f0662012-02-21 15:11:11 -080016624 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -070016625 checkForLongClick(ViewConfiguration.getTapTimeout());
Adam Powelle14579b2009-12-16 18:39:52 -080016626 }
16627 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016628
Adam Powella35d7682010-03-12 14:48:13 -080016629 private final class PerformClick implements Runnable {
16630 public void run() {
16631 performClick();
16632 }
16633 }
16634
Dianne Hackborn63042d62011-01-26 18:56:29 -080016635 /** @hide */
16636 public void hackTurnOffWindowResizeAnim(boolean off) {
16637 mAttachInfo.mTurnOffWindowResizeAnim = off;
16638 }
Joe Malin32736f02011-01-19 16:14:20 -080016639
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016640 /**
Chet Haasea00f3862011-02-22 06:34:40 -080016641 * This method returns a ViewPropertyAnimator object, which can be used to animate
16642 * specific properties on this View.
16643 *
16644 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View.
16645 */
16646 public ViewPropertyAnimator animate() {
16647 if (mAnimator == null) {
16648 mAnimator = new ViewPropertyAnimator(this);
16649 }
16650 return mAnimator;
16651 }
16652
16653 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016654 * Interface definition for a callback to be invoked when a key event is
16655 * dispatched to this view. The callback will be invoked before the key
16656 * event is given to the view.
16657 */
16658 public interface OnKeyListener {
16659 /**
16660 * Called when a key is dispatched to a view. This allows listeners to
16661 * get a chance to respond before the target view.
16662 *
16663 * @param v The view the key has been dispatched to.
16664 * @param keyCode The code for the physical key that was pressed
16665 * @param event The KeyEvent object containing full information about
16666 * the event.
16667 * @return True if the listener has consumed the event, false otherwise.
16668 */
16669 boolean onKey(View v, int keyCode, KeyEvent event);
16670 }
16671
16672 /**
16673 * Interface definition for a callback to be invoked when a touch event is
16674 * dispatched to this view. The callback will be invoked before the touch
16675 * event is given to the view.
16676 */
16677 public interface OnTouchListener {
16678 /**
16679 * Called when a touch event is dispatched to a view. This allows listeners to
16680 * get a chance to respond before the target view.
16681 *
16682 * @param v The view the touch event has been dispatched to.
16683 * @param event The MotionEvent object containing full information about
16684 * the event.
16685 * @return True if the listener has consumed the event, false otherwise.
16686 */
16687 boolean onTouch(View v, MotionEvent event);
16688 }
16689
16690 /**
Jeff Brown10b62902011-06-20 16:40:37 -070016691 * Interface definition for a callback to be invoked when a hover event is
16692 * dispatched to this view. The callback will be invoked before the hover
16693 * event is given to the view.
16694 */
16695 public interface OnHoverListener {
16696 /**
16697 * Called when a hover event is dispatched to a view. This allows listeners to
16698 * get a chance to respond before the target view.
16699 *
16700 * @param v The view the hover event has been dispatched to.
16701 * @param event The MotionEvent object containing full information about
16702 * the event.
16703 * @return True if the listener has consumed the event, false otherwise.
16704 */
16705 boolean onHover(View v, MotionEvent event);
16706 }
16707
16708 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080016709 * Interface definition for a callback to be invoked when a generic motion event is
16710 * dispatched to this view. The callback will be invoked before the generic motion
16711 * event is given to the view.
16712 */
16713 public interface OnGenericMotionListener {
16714 /**
16715 * Called when a generic motion event is dispatched to a view. This allows listeners to
16716 * get a chance to respond before the target view.
16717 *
16718 * @param v The view the generic motion event has been dispatched to.
16719 * @param event The MotionEvent object containing full information about
16720 * the event.
16721 * @return True if the listener has consumed the event, false otherwise.
16722 */
16723 boolean onGenericMotion(View v, MotionEvent event);
16724 }
16725
16726 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016727 * Interface definition for a callback to be invoked when a view has been clicked and held.
16728 */
16729 public interface OnLongClickListener {
16730 /**
16731 * Called when a view has been clicked and held.
16732 *
16733 * @param v The view that was clicked and held.
16734 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080016735 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016736 */
16737 boolean onLongClick(View v);
16738 }
16739
16740 /**
Chris Tate32affef2010-10-18 15:29:21 -070016741 * Interface definition for a callback to be invoked when a drag is being dispatched
16742 * to this view. The callback will be invoked before the hosting view's own
16743 * onDrag(event) method. If the listener wants to fall back to the hosting view's
16744 * onDrag(event) behavior, it should return 'false' from this callback.
Joe Fernandez558459f2011-10-13 16:47:36 -070016745 *
16746 * <div class="special reference">
16747 * <h3>Developer Guides</h3>
16748 * <p>For a guide to implementing drag and drop features, read the
16749 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p>
16750 * </div>
Chris Tate32affef2010-10-18 15:29:21 -070016751 */
16752 public interface OnDragListener {
16753 /**
16754 * Called when a drag event is dispatched to a view. This allows listeners
16755 * to get a chance to override base View behavior.
16756 *
Joe Malin32736f02011-01-19 16:14:20 -080016757 * @param v The View that received the drag event.
16758 * @param event The {@link android.view.DragEvent} object for the drag event.
16759 * @return {@code true} if the drag event was handled successfully, or {@code false}
16760 * if the drag event was not handled. Note that {@code false} will trigger the View
16761 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler.
Chris Tate32affef2010-10-18 15:29:21 -070016762 */
16763 boolean onDrag(View v, DragEvent event);
16764 }
16765
16766 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016767 * Interface definition for a callback to be invoked when the focus state of
16768 * a view changed.
16769 */
16770 public interface OnFocusChangeListener {
16771 /**
16772 * Called when the focus state of a view has changed.
16773 *
16774 * @param v The view whose state has changed.
16775 * @param hasFocus The new focus state of v.
16776 */
16777 void onFocusChange(View v, boolean hasFocus);
16778 }
16779
16780 /**
16781 * Interface definition for a callback to be invoked when a view is clicked.
16782 */
16783 public interface OnClickListener {
16784 /**
16785 * Called when a view has been clicked.
16786 *
16787 * @param v The view that was clicked.
16788 */
16789 void onClick(View v);
16790 }
16791
16792 /**
16793 * Interface definition for a callback to be invoked when the context menu
16794 * for this view is being built.
16795 */
16796 public interface OnCreateContextMenuListener {
16797 /**
16798 * Called when the context menu for this view is being built. It is not
16799 * safe to hold onto the menu after this method returns.
16800 *
16801 * @param menu The context menu that is being built
16802 * @param v The view for which the context menu is being built
16803 * @param menuInfo Extra information about the item for which the
16804 * context menu should be shown. This information will vary
16805 * depending on the class of v.
16806 */
16807 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
16808 }
16809
Joe Onorato664644d2011-01-23 17:53:23 -080016810 /**
16811 * Interface definition for a callback to be invoked when the status bar changes
Dianne Hackborn9a230e02011-10-06 11:51:27 -070016812 * visibility. This reports <strong>global</strong> changes to the system UI
16813 * state, not just what the application is requesting.
Joe Onorato664644d2011-01-23 17:53:23 -080016814 *
Philip Milne6c8ea062012-04-03 17:38:43 -070016815 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener)
Joe Onorato664644d2011-01-23 17:53:23 -080016816 */
16817 public interface OnSystemUiVisibilityChangeListener {
16818 /**
16819 * Called when the status bar changes visibility because of a call to
Romain Guy5c22a8c2011-05-13 11:48:45 -070016820 * {@link View#setSystemUiVisibility(int)}.
Joe Onorato664644d2011-01-23 17:53:23 -080016821 *
Daniel Sandler60ee2562011-07-22 12:34:33 -040016822 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE} or
Dianne Hackborn9a230e02011-10-06 11:51:27 -070016823 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}. This tells you the
16824 * <strong>global</strong> state of the UI visibility flags, not what your
16825 * app is currently applying.
Joe Onorato664644d2011-01-23 17:53:23 -080016826 */
16827 public void onSystemUiVisibilityChange(int visibility);
16828 }
16829
Adam Powell4afd62b2011-02-18 15:02:18 -080016830 /**
16831 * Interface definition for a callback to be invoked when this view is attached
16832 * or detached from its window.
16833 */
16834 public interface OnAttachStateChangeListener {
16835 /**
16836 * Called when the view is attached to a window.
16837 * @param v The view that was attached
16838 */
16839 public void onViewAttachedToWindow(View v);
16840 /**
16841 * Called when the view is detached from a window.
16842 * @param v The view that was detached
16843 */
16844 public void onViewDetachedFromWindow(View v);
16845 }
16846
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016847 private final class UnsetPressedState implements Runnable {
16848 public void run() {
16849 setPressed(false);
16850 }
16851 }
16852
16853 /**
16854 * Base class for derived classes that want to save and restore their own
16855 * state in {@link android.view.View#onSaveInstanceState()}.
16856 */
16857 public static class BaseSavedState extends AbsSavedState {
16858 /**
16859 * Constructor used when reading from a parcel. Reads the state of the superclass.
16860 *
16861 * @param source
16862 */
16863 public BaseSavedState(Parcel source) {
16864 super(source);
16865 }
16866
16867 /**
16868 * Constructor called by derived classes when creating their SavedState objects
16869 *
16870 * @param superState The state of the superclass of this view
16871 */
16872 public BaseSavedState(Parcelable superState) {
16873 super(superState);
16874 }
16875
16876 public static final Parcelable.Creator<BaseSavedState> CREATOR =
16877 new Parcelable.Creator<BaseSavedState>() {
16878 public BaseSavedState createFromParcel(Parcel in) {
16879 return new BaseSavedState(in);
16880 }
16881
16882 public BaseSavedState[] newArray(int size) {
16883 return new BaseSavedState[size];
16884 }
16885 };
16886 }
16887
16888 /**
16889 * A set of information given to a view when it is attached to its parent
16890 * window.
16891 */
16892 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016893 interface Callbacks {
16894 void playSoundEffect(int effectId);
16895 boolean performHapticFeedback(int effectId, boolean always);
16896 }
16897
16898 /**
16899 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
16900 * to a Handler. This class contains the target (View) to invalidate and
16901 * the coordinates of the dirty rectangle.
16902 *
16903 * For performance purposes, this class also implements a pool of up to
16904 * POOL_LIMIT objects that get reused. This reduces memory allocations
16905 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016906 */
Romain Guyd928d682009-03-31 17:52:16 -070016907 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016908 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070016909 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
16910 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070016911 public InvalidateInfo newInstance() {
16912 return new InvalidateInfo();
16913 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016914
Romain Guyd928d682009-03-31 17:52:16 -070016915 public void onAcquired(InvalidateInfo element) {
16916 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016917
Romain Guyd928d682009-03-31 17:52:16 -070016918 public void onReleased(InvalidateInfo element) {
Romain Guy40c18f52011-09-01 17:01:18 -070016919 element.target = null;
Romain Guyd928d682009-03-31 17:52:16 -070016920 }
16921 }, POOL_LIMIT)
16922 );
16923
16924 private InvalidateInfo mNext;
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070016925 private boolean mIsPooled;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016926
16927 View target;
16928
16929 int left;
16930 int top;
16931 int right;
16932 int bottom;
16933
Romain Guyd928d682009-03-31 17:52:16 -070016934 public void setNextPoolable(InvalidateInfo element) {
16935 mNext = element;
16936 }
16937
16938 public InvalidateInfo getNextPoolable() {
16939 return mNext;
16940 }
16941
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016942 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070016943 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016944 }
16945
16946 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070016947 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016948 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070016949
16950 public boolean isPooled() {
16951 return mIsPooled;
16952 }
16953
16954 public void setPooled(boolean isPooled) {
16955 mIsPooled = isPooled;
16956 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016957 }
16958
16959 final IWindowSession mSession;
16960
16961 final IWindow mWindow;
16962
16963 final IBinder mWindowToken;
16964
16965 final Callbacks mRootCallbacks;
16966
Romain Guy59a12ca2011-06-09 17:48:21 -070016967 HardwareCanvas mHardwareCanvas;
Chet Haasedaf98e92011-01-10 14:10:36 -080016968
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016969 /**
16970 * The top view of the hierarchy.
16971 */
16972 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070016973
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016974 IBinder mPanelParentWindowToken;
16975 Surface mSurface;
16976
Romain Guyb051e892010-09-28 19:09:36 -070016977 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080016978 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070016979 HardwareRenderer mHardwareRenderer;
Joe Malin32736f02011-01-19 16:14:20 -080016980
Romain Guy7e4e5612012-03-05 14:37:29 -080016981 boolean mScreenOn;
16982
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016983 /**
Romain Guy8506ab42009-06-11 17:35:47 -070016984 * Scale factor used by the compatibility mode
16985 */
16986 float mApplicationScale;
16987
16988 /**
16989 * Indicates whether the application is in compatibility mode
16990 */
16991 boolean mScalingRequired;
16992
16993 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070016994 * If set, ViewAncestor doesn't use its lame animation for when the window resizes.
Dianne Hackborn63042d62011-01-26 18:56:29 -080016995 */
16996 boolean mTurnOffWindowResizeAnim;
Joe Malin32736f02011-01-19 16:14:20 -080016997
Dianne Hackborn63042d62011-01-26 18:56:29 -080016998 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016999 * Left position of this view's window
17000 */
17001 int mWindowLeft;
17002
17003 /**
17004 * Top position of this view's window
17005 */
17006 int mWindowTop;
17007
17008 /**
Adam Powell26153a32010-11-08 15:22:27 -080017009 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070017010 */
Adam Powell26153a32010-11-08 15:22:27 -080017011 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070017012
17013 /**
Dianne Hackborn3556c9a2012-05-04 16:31:25 -070017014 * Describes the parts of the window that are currently completely
17015 * obscured by system UI elements.
17016 */
17017 final Rect mSystemInsets = new Rect();
17018
17019 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017020 * For windows that are full-screen but using insets to layout inside
17021 * of the screen decorations, these are the current insets for the
17022 * content of the window.
17023 */
17024 final Rect mContentInsets = new Rect();
17025
17026 /**
17027 * For windows that are full-screen but using insets to layout inside
17028 * of the screen decorations, these are the current insets for the
17029 * actual visible parts of the window.
17030 */
17031 final Rect mVisibleInsets = new Rect();
17032
17033 /**
17034 * The internal insets given by this window. This value is
17035 * supplied by the client (through
17036 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
17037 * be given to the window manager when changed to be used in laying
17038 * out windows behind it.
17039 */
17040 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
17041 = new ViewTreeObserver.InternalInsetsInfo();
17042
17043 /**
17044 * All views in the window's hierarchy that serve as scroll containers,
17045 * used to determine if the window can be resized or must be panned
17046 * to adjust for a soft input area.
17047 */
17048 final ArrayList<View> mScrollContainers = new ArrayList<View>();
17049
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070017050 final KeyEvent.DispatcherState mKeyDispatchState
17051 = new KeyEvent.DispatcherState();
17052
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017053 /**
17054 * Indicates whether the view's window currently has the focus.
17055 */
17056 boolean mHasWindowFocus;
17057
17058 /**
17059 * The current visibility of the window.
17060 */
17061 int mWindowVisibility;
17062
17063 /**
17064 * Indicates the time at which drawing started to occur.
17065 */
17066 long mDrawingTime;
17067
17068 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070017069 * Indicates whether or not ignoring the DIRTY_MASK flags.
17070 */
17071 boolean mIgnoreDirtyState;
17072
17073 /**
Romain Guy02ccac62011-06-24 13:20:23 -070017074 * This flag tracks when the mIgnoreDirtyState flag is set during draw(),
17075 * to avoid clearing that flag prematurely.
17076 */
17077 boolean mSetIgnoreDirtyState = false;
17078
17079 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017080 * Indicates whether the view's window is currently in touch mode.
17081 */
17082 boolean mInTouchMode;
17083
17084 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070017085 * Indicates that ViewAncestor should trigger a global layout change
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017086 * the next time it performs a traversal
17087 */
17088 boolean mRecomputeGlobalAttributes;
17089
17090 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -070017091 * Always report new attributes at next traversal.
17092 */
17093 boolean mForceReportNewAttributes;
17094
17095 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017096 * Set during a traveral if any views want to keep the screen on.
17097 */
17098 boolean mKeepScreenOn;
17099
17100 /**
Joe Onorato664644d2011-01-23 17:53:23 -080017101 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility().
17102 */
17103 int mSystemUiVisibility;
17104
17105 /**
Dianne Hackborn139e5aa2012-05-05 20:36:38 -070017106 * Hack to force certain system UI visibility flags to be cleared.
17107 */
17108 int mDisabledSystemUiVisibility;
17109
17110 /**
Joe Onorato664644d2011-01-23 17:53:23 -080017111 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener
17112 * attached.
17113 */
17114 boolean mHasSystemUiListeners;
17115
17116 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017117 * Set if the visibility of any views has changed.
17118 */
17119 boolean mViewVisibilityChanged;
17120
17121 /**
17122 * Set to true if a view has been scrolled.
17123 */
17124 boolean mViewScrollChanged;
17125
17126 /**
17127 * Global to the view hierarchy used as a temporary for dealing with
17128 * x/y points in the transparent region computations.
17129 */
17130 final int[] mTransparentLocation = new int[2];
17131
17132 /**
17133 * Global to the view hierarchy used as a temporary for dealing with
17134 * x/y points in the ViewGroup.invalidateChild implementation.
17135 */
17136 final int[] mInvalidateChildLocation = new int[2];
17137
Chet Haasec3aa3612010-06-17 08:50:37 -070017138
17139 /**
17140 * Global to the view hierarchy used as a temporary for dealing with
17141 * x/y location when view is transformed.
17142 */
17143 final float[] mTmpTransformLocation = new float[2];
17144
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017145 /**
17146 * The view tree observer used to dispatch global events like
17147 * layout, pre-draw, touch mode change, etc.
17148 */
17149 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
17150
17151 /**
17152 * A Canvas used by the view hierarchy to perform bitmap caching.
17153 */
17154 Canvas mCanvas;
17155
17156 /**
Jeff Browna175a5b2012-02-15 19:18:31 -080017157 * The view root impl.
17158 */
17159 final ViewRootImpl mViewRootImpl;
17160
17161 /**
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070017162 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017163 * handler can be used to pump events in the UI events queue.
17164 */
17165 final Handler mHandler;
17166
17167 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017168 * Temporary for use in computing invalidate rectangles while
17169 * calling up the hierarchy.
17170 */
17171 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070017172
17173 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070017174 * Temporary for use in computing hit areas with transformed views
17175 */
17176 final RectF mTmpTransformRect = new RectF();
17177
17178 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070017179 * Temporary list for use in collecting focusable descendents of a view.
17180 */
Svetoslav Ganov42138042012-03-20 11:51:39 -070017181 final ArrayList<View> mTempArrayList = new ArrayList<View>(24);
svetoslavganov75986cf2009-05-14 22:28:01 -070017182
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017183 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017184 * The id of the window for accessibility purposes.
17185 */
17186 int mAccessibilityWindowId = View.NO_ID;
17187
17188 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -070017189 * Whether to ingore not exposed for accessibility Views when
17190 * reporting the view tree to accessibility services.
17191 */
17192 boolean mIncludeNotImportantViews;
17193
17194 /**
17195 * The drawable for highlighting accessibility focus.
17196 */
17197 Drawable mAccessibilityFocusDrawable;
17198
17199 /**
Philip Milne10ca24a2012-04-23 15:38:27 -070017200 * Show where the margins, bounds and layout bounds are for each view.
17201 */
Romain Guy4b8c4f82012-04-27 15:48:35 -070017202 final boolean mDebugLayout = SystemProperties.getBoolean(DEBUG_LAYOUT_PROPERTY, false);
Philip Milne10ca24a2012-04-23 15:38:27 -070017203
17204 /**
Romain Guyab4c4f4f2012-05-06 13:11:24 -070017205 * Point used to compute visible regions.
17206 */
17207 final Point mPoint = new Point();
17208
17209 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017210 * Creates a new set of attachment information with the specified
17211 * events handler and thread.
17212 *
17213 * @param handler the events handler the view must use
17214 */
17215 AttachInfo(IWindowSession session, IWindow window,
Jeff Browna175a5b2012-02-15 19:18:31 -080017216 ViewRootImpl viewRootImpl, Handler handler, Callbacks effectPlayer) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017217 mSession = session;
17218 mWindow = window;
17219 mWindowToken = window.asBinder();
Jeff Browna175a5b2012-02-15 19:18:31 -080017220 mViewRootImpl = viewRootImpl;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017221 mHandler = handler;
17222 mRootCallbacks = effectPlayer;
17223 }
17224 }
17225
17226 /**
17227 * <p>ScrollabilityCache holds various fields used by a View when scrolling
17228 * is supported. This avoids keeping too many unused fields in most
17229 * instances of View.</p>
17230 */
Mike Cleronf116bf82009-09-27 19:14:12 -070017231 private static class ScrollabilityCache implements Runnable {
Joe Malin32736f02011-01-19 16:14:20 -080017232
Mike Cleronf116bf82009-09-27 19:14:12 -070017233 /**
17234 * Scrollbars are not visible
17235 */
17236 public static final int OFF = 0;
17237
17238 /**
17239 * Scrollbars are visible
17240 */
17241 public static final int ON = 1;
17242
17243 /**
17244 * Scrollbars are fading away
17245 */
17246 public static final int FADING = 2;
17247
17248 public boolean fadeScrollBars;
Joe Malin32736f02011-01-19 16:14:20 -080017249
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017250 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070017251 public int scrollBarDefaultDelayBeforeFade;
17252 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017253
17254 public int scrollBarSize;
17255 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070017256 public float[] interpolatorValues;
17257 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017258
17259 public final Paint paint;
17260 public final Matrix matrix;
17261 public Shader shader;
17262
Mike Cleronf116bf82009-09-27 19:14:12 -070017263 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
17264
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017265 private static final float[] OPAQUE = { 255 };
17266 private static final float[] TRANSPARENT = { 0.0f };
Joe Malin32736f02011-01-19 16:14:20 -080017267
Mike Cleronf116bf82009-09-27 19:14:12 -070017268 /**
17269 * When fading should start. This time moves into the future every time
17270 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
17271 */
17272 public long fadeStartTime;
17273
17274
17275 /**
17276 * The current state of the scrollbars: ON, OFF, or FADING
17277 */
17278 public int state = OFF;
17279
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017280 private int mLastColor;
17281
Mike Cleronf116bf82009-09-27 19:14:12 -070017282 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017283 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
17284 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070017285 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
17286 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017287
17288 paint = new Paint();
17289 matrix = new Matrix();
17290 // use use a height of 1, and then wack the matrix each time we
17291 // actually use it.
17292 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070017293
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017294 paint.setShader(shader);
17295 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070017296 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017297 }
Romain Guy8506ab42009-06-11 17:35:47 -070017298
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017299 public void setFadeColor(int color) {
17300 if (color != 0 && color != mLastColor) {
17301 mLastColor = color;
17302 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070017303
Romain Guye55e1a72009-08-27 10:42:26 -070017304 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
17305 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070017306
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017307 paint.setShader(shader);
17308 // Restore the default transfer mode (src_over)
17309 paint.setXfermode(null);
17310 }
17311 }
Joe Malin32736f02011-01-19 16:14:20 -080017312
Mike Cleronf116bf82009-09-27 19:14:12 -070017313 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070017314 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070017315 if (now >= fadeStartTime) {
17316
17317 // the animation fades the scrollbars out by changing
17318 // the opacity (alpha) from fully opaque to fully
17319 // transparent
17320 int nextFrame = (int) now;
17321 int framesCount = 0;
17322
17323 Interpolator interpolator = scrollBarInterpolator;
17324
17325 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017326 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070017327
17328 // End transparent
17329 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017330 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070017331
17332 state = FADING;
17333
17334 // Kick off the fade animation
Romain Guy0fd89bf2011-01-26 15:41:30 -080017335 host.invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -070017336 }
17337 }
Svetoslav Ganova0156172011-06-26 17:55:44 -070017338 }
Mike Cleronf116bf82009-09-27 19:14:12 -070017339
Svetoslav Ganova0156172011-06-26 17:55:44 -070017340 /**
17341 * Resuable callback for sending
17342 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
17343 */
17344 private class SendViewScrolledAccessibilityEvent implements Runnable {
17345 public volatile boolean mIsPending;
17346
17347 public void run() {
17348 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED);
17349 mIsPending = false;
17350 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017351 }
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017352
17353 /**
17354 * <p>
17355 * This class represents a delegate that can be registered in a {@link View}
17356 * to enhance accessibility support via composition rather via inheritance.
17357 * It is specifically targeted to widget developers that extend basic View
17358 * classes i.e. classes in package android.view, that would like their
17359 * applications to be backwards compatible.
17360 * </p>
Joe Fernandeze1302ed2012-02-06 14:30:15 -080017361 * <div class="special reference">
17362 * <h3>Developer Guides</h3>
17363 * <p>For more information about making applications accessible, read the
17364 * <a href="{@docRoot}guide/topics/ui/accessibility/index.html">Accessibility</a>
17365 * developer guide.</p>
17366 * </div>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017367 * <p>
17368 * A scenario in which a developer would like to use an accessibility delegate
17369 * is overriding a method introduced in a later API version then the minimal API
17370 * version supported by the application. For example, the method
17371 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available
17372 * in API version 4 when the accessibility APIs were first introduced. If a
17373 * developer would like his application to run on API version 4 devices (assuming
17374 * all other APIs used by the application are version 4 or lower) and take advantage
17375 * of this method, instead of overriding the method which would break the application's
17376 * backwards compatibility, he can override the corresponding method in this
17377 * delegate and register the delegate in the target View if the API version of
17378 * the system is high enough i.e. the API version is same or higher to the API
17379 * version that introduced
17380 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}.
17381 * </p>
17382 * <p>
17383 * Here is an example implementation:
17384 * </p>
17385 * <code><pre><p>
17386 * if (Build.VERSION.SDK_INT >= 14) {
17387 * // If the API version is equal of higher than the version in
17388 * // which onInitializeAccessibilityNodeInfo was introduced we
17389 * // register a delegate with a customized implementation.
17390 * View view = findViewById(R.id.view_id);
17391 * view.setAccessibilityDelegate(new AccessibilityDelegate() {
17392 * public void onInitializeAccessibilityNodeInfo(View host,
17393 * AccessibilityNodeInfo info) {
17394 * // Let the default implementation populate the info.
17395 * super.onInitializeAccessibilityNodeInfo(host, info);
17396 * // Set some other information.
17397 * info.setEnabled(host.isEnabled());
17398 * }
17399 * });
17400 * }
17401 * </code></pre></p>
17402 * <p>
17403 * This delegate contains methods that correspond to the accessibility methods
17404 * in View. If a delegate has been specified the implementation in View hands
17405 * off handling to the corresponding method in this delegate. The default
17406 * implementation the delegate methods behaves exactly as the corresponding
17407 * method in View for the case of no accessibility delegate been set. Hence,
17408 * to customize the behavior of a View method, clients can override only the
17409 * corresponding delegate method without altering the behavior of the rest
17410 * accessibility related methods of the host view.
17411 * </p>
17412 */
17413 public static class AccessibilityDelegate {
17414
17415 /**
17416 * Sends an accessibility event of the given type. If accessibility is not
17417 * enabled this method has no effect.
17418 * <p>
17419 * The default implementation behaves as {@link View#sendAccessibilityEvent(int)
17420 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate
17421 * been set.
17422 * </p>
17423 *
17424 * @param host The View hosting the delegate.
17425 * @param eventType The type of the event to send.
17426 *
17427 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int)
17428 */
17429 public void sendAccessibilityEvent(View host, int eventType) {
17430 host.sendAccessibilityEventInternal(eventType);
17431 }
17432
17433 /**
alanv8eeefef2012-05-07 16:57:53 -070017434 * Performs the specified accessibility action on the view. For
17435 * possible accessibility actions look at {@link AccessibilityNodeInfo}.
17436 * <p>
17437 * The default implementation behaves as
17438 * {@link View#performAccessibilityAction(int, Bundle)
17439 * View#performAccessibilityAction(int, Bundle)} for the case of
17440 * no accessibility delegate been set.
17441 * </p>
17442 *
17443 * @param action The action to perform.
17444 * @return Whether the action was performed.
17445 *
17446 * @see View#performAccessibilityAction(int, Bundle)
17447 * View#performAccessibilityAction(int, Bundle)
17448 */
17449 public boolean performAccessibilityAction(View host, int action, Bundle args) {
17450 return host.performAccessibilityActionInternal(action, args);
17451 }
17452
17453 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017454 * Sends an accessibility event. This method behaves exactly as
17455 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an
17456 * empty {@link AccessibilityEvent} and does not perform a check whether
17457 * accessibility is enabled.
17458 * <p>
17459 * The default implementation behaves as
17460 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17461 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for
17462 * the case of no accessibility delegate been set.
17463 * </p>
17464 *
17465 * @param host The View hosting the delegate.
17466 * @param event The event to send.
17467 *
17468 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17469 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17470 */
17471 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) {
17472 host.sendAccessibilityEventUncheckedInternal(event);
17473 }
17474
17475 /**
17476 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then
17477 * to its children for adding their text content to the event.
17478 * <p>
17479 * The default implementation behaves as
17480 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17481 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for
17482 * the case of no accessibility delegate been set.
17483 * </p>
17484 *
17485 * @param host The View hosting the delegate.
17486 * @param event The event.
17487 * @return True if the event population was completed.
17488 *
17489 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17490 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17491 */
17492 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) {
17493 return host.dispatchPopulateAccessibilityEventInternal(event);
17494 }
17495
17496 /**
17497 * Gives a chance to the host View to populate the accessibility event with its
17498 * text content.
17499 * <p>
17500 * The default implementation behaves as
17501 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent)
17502 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for
17503 * the case of no accessibility delegate been set.
17504 * </p>
17505 *
17506 * @param host The View hosting the delegate.
17507 * @param event The accessibility event which to populate.
17508 *
17509 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent)
17510 * View#onPopulateAccessibilityEvent(AccessibilityEvent)
17511 */
17512 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) {
17513 host.onPopulateAccessibilityEventInternal(event);
17514 }
17515
17516 /**
17517 * Initializes an {@link AccessibilityEvent} with information about the
17518 * the host View which is the event source.
17519 * <p>
17520 * The default implementation behaves as
17521 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent)
17522 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for
17523 * the case of no accessibility delegate been set.
17524 * </p>
17525 *
17526 * @param host The View hosting the delegate.
17527 * @param event The event to initialize.
17528 *
17529 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent)
17530 * View#onInitializeAccessibilityEvent(AccessibilityEvent)
17531 */
17532 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) {
17533 host.onInitializeAccessibilityEventInternal(event);
17534 }
17535
17536 /**
17537 * Initializes an {@link AccessibilityNodeInfo} with information about the host view.
17538 * <p>
17539 * The default implementation behaves as
17540 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17541 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for
17542 * the case of no accessibility delegate been set.
17543 * </p>
17544 *
17545 * @param host The View hosting the delegate.
17546 * @param info The instance to initialize.
17547 *
17548 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17549 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17550 */
17551 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) {
17552 host.onInitializeAccessibilityNodeInfoInternal(info);
17553 }
17554
17555 /**
17556 * Called when a child of the host View has requested sending an
17557 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host)
17558 * to augment the event.
17559 * <p>
17560 * The default implementation behaves as
17561 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17562 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for
17563 * the case of no accessibility delegate been set.
17564 * </p>
17565 *
17566 * @param host The View hosting the delegate.
17567 * @param child The child which requests sending the event.
17568 * @param event The event to be sent.
17569 * @return True if the event should be sent
17570 *
17571 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17572 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17573 */
17574 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child,
17575 AccessibilityEvent event) {
17576 return host.onRequestSendAccessibilityEventInternal(child, event);
17577 }
Svetoslav Ganov02107852011-10-03 17:06:56 -070017578
17579 /**
17580 * Gets the provider for managing a virtual view hierarchy rooted at this View
17581 * and reported to {@link android.accessibilityservice.AccessibilityService}s
17582 * that explore the window content.
17583 * <p>
17584 * The default implementation behaves as
17585 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for
17586 * the case of no accessibility delegate been set.
17587 * </p>
17588 *
17589 * @return The provider.
17590 *
17591 * @see AccessibilityNodeProvider
17592 */
17593 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) {
17594 return null;
17595 }
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017596 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017597}