blob: 99079a91c15007c5433ba7820ed82a08c2d3a155 [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 /**
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004669 * Gets the location of this view in screen coordintates.
4670 *
4671 * @param outRect The output location
4672 */
4673 private void getBoundsOnScreen(Rect outRect) {
4674 if (mAttachInfo == null) {
4675 return;
4676 }
4677
4678 RectF position = mAttachInfo.mTmpTransformRect;
Svetoslav Ganov14b2b742012-05-08 16:36:34 -07004679 position.set(0, 0, mRight - mLeft, mBottom - mTop);
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004680
4681 if (!hasIdentityMatrix()) {
4682 getMatrix().mapRect(position);
4683 }
4684
Svetoslav Ganov14b2b742012-05-08 16:36:34 -07004685 position.offset(mLeft, mTop);
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004686
4687 ViewParent parent = mParent;
4688 while (parent instanceof View) {
4689 View parentView = (View) parent;
4690
4691 position.offset(-parentView.mScrollX, -parentView.mScrollY);
4692
4693 if (!parentView.hasIdentityMatrix()) {
4694 parentView.getMatrix().mapRect(position);
4695 }
4696
4697 position.offset(parentView.mLeft, parentView.mTop);
4698
4699 parent = parentView.mParent;
4700 }
4701
4702 if (parent instanceof ViewRootImpl) {
4703 ViewRootImpl viewRootImpl = (ViewRootImpl) parent;
4704 position.offset(0, -viewRootImpl.mCurScrollY);
4705 }
4706
4707 position.offset(mAttachInfo.mWindowLeft, mAttachInfo.mWindowTop);
4708
4709 outRect.set((int) (position.left + 0.5f), (int) (position.top + 0.5f),
4710 (int) (position.right + 0.5f), (int) (position.bottom + 0.5f));
4711 }
4712
4713 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004714 * @see #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
4715 *
4716 * Note: Called from the default {@link AccessibilityDelegate}.
4717 */
4718 void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) {
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004719 Rect bounds = mAttachInfo.mTmpInvalRect;
4720 getDrawingRect(bounds);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004721 info.setBoundsInParent(bounds);
4722
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004723 getBoundsOnScreen(bounds);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004724 info.setBoundsInScreen(bounds);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004725
Svetoslav Ganov57f3b566db2011-10-31 17:59:14 -07004726 if ((mPrivateFlags & IS_ROOT_NAMESPACE) == 0) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004727 ViewParent parent = getParentForAccessibility();
Svetoslav Ganov57f3b566db2011-10-31 17:59:14 -07004728 if (parent instanceof View) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004729 info.setParent((View) parent);
Svetoslav Ganov57f3b566db2011-10-31 17:59:14 -07004730 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004731 }
4732
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004733 info.setVisibleToUser(isVisibleToUser());
4734
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004735 info.setPackageName(mContext.getPackageName());
Svetoslav Ganov8a78fd42012-01-17 14:36:46 -08004736 info.setClassName(View.class.getName());
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004737 info.setContentDescription(getContentDescription());
4738
4739 info.setEnabled(isEnabled());
4740 info.setClickable(isClickable());
4741 info.setFocusable(isFocusable());
4742 info.setFocused(isFocused());
Svetoslav Ganov42138042012-03-20 11:51:39 -07004743 info.setAccessibilityFocused(isAccessibilityFocused());
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004744 info.setSelected(isSelected());
4745 info.setLongClickable(isLongClickable());
4746
4747 // TODO: These make sense only if we are in an AdapterView but all
4748 // views can be selected. Maybe from accessiiblity perspective
4749 // we should report as selectable view in an AdapterView.
4750 info.addAction(AccessibilityNodeInfo.ACTION_SELECT);
4751 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION);
4752
4753 if (isFocusable()) {
4754 if (isFocused()) {
4755 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS);
4756 } else {
4757 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS);
4758 }
4759 }
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004760
Svetoslav Ganov02afe2c2012-05-07 17:51:59 -07004761 if (!isAccessibilityFocused()) {
4762 info.addAction(AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS);
4763 } else {
4764 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS);
4765 }
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004766
4767 if (isClickable()) {
4768 info.addAction(AccessibilityNodeInfo.ACTION_CLICK);
4769 }
4770
4771 if (isLongClickable()) {
4772 info.addAction(AccessibilityNodeInfo.ACTION_LONG_CLICK);
4773 }
4774
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07004775 if (mContentDescription != null && mContentDescription.length() > 0) {
Svetoslav Ganov2b435aa2012-05-04 17:16:37 -07004776 info.addAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY);
4777 info.addAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY);
4778 info.setMovementGranularities(AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07004779 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD
4780 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH);
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004781 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004782 }
4783
4784 /**
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004785 * Computes whether this view is visible to the user. Such a view is
4786 * attached, visible, all its predecessors are visible, it is not clipped
4787 * entirely by its predecessors, and has an alpha greater than zero.
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004788 *
4789 * @return Whether the view is visible on the screen.
4790 */
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004791 private boolean isVisibleToUser() {
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004792 // The first two checks are made also made by isShown() which
4793 // however traverses the tree up to the parent to catch that.
4794 // Therefore, we do some fail fast check to minimize the up
4795 // tree traversal.
4796 return (mAttachInfo != null
4797 && mAttachInfo.mWindowVisibility == View.VISIBLE
4798 && getAlpha() > 0
4799 && isShown()
4800 && getGlobalVisibleRect(mAttachInfo.mTmpInvalRect));
4801 }
4802
4803 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004804 * Sets a delegate for implementing accessibility support via compositon as
4805 * opposed to inheritance. The delegate's primary use is for implementing
4806 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}.
4807 *
4808 * @param delegate The delegate instance.
4809 *
4810 * @see AccessibilityDelegate
4811 */
4812 public void setAccessibilityDelegate(AccessibilityDelegate delegate) {
4813 mAccessibilityDelegate = delegate;
4814 }
4815
4816 /**
Svetoslav Ganov02107852011-10-03 17:06:56 -07004817 * Gets the provider for managing a virtual view hierarchy rooted at this View
4818 * and reported to {@link android.accessibilityservice.AccessibilityService}s
4819 * that explore the window content.
4820 * <p>
4821 * If this method returns an instance, this instance is responsible for managing
4822 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this
4823 * View including the one representing the View itself. Similarly the returned
4824 * instance is responsible for performing accessibility actions on any virtual
4825 * view or the root view itself.
4826 * </p>
4827 * <p>
4828 * If an {@link AccessibilityDelegate} has been specified via calling
4829 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4830 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)}
4831 * is responsible for handling this call.
4832 * </p>
4833 *
4834 * @return The provider.
4835 *
4836 * @see AccessibilityNodeProvider
4837 */
4838 public AccessibilityNodeProvider getAccessibilityNodeProvider() {
4839 if (mAccessibilityDelegate != null) {
4840 return mAccessibilityDelegate.getAccessibilityNodeProvider(this);
4841 } else {
4842 return null;
4843 }
4844 }
4845
4846 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004847 * Gets the unique identifier of this view on the screen for accessibility purposes.
4848 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned.
4849 *
4850 * @return The view accessibility id.
4851 *
4852 * @hide
4853 */
4854 public int getAccessibilityViewId() {
4855 if (mAccessibilityViewId == NO_ID) {
4856 mAccessibilityViewId = sNextAccessibilityViewId++;
4857 }
4858 return mAccessibilityViewId;
4859 }
4860
4861 /**
4862 * Gets the unique identifier of the window in which this View reseides.
4863 *
4864 * @return The window accessibility id.
4865 *
4866 * @hide
4867 */
4868 public int getAccessibilityWindowId() {
4869 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId : NO_ID;
4870 }
4871
4872 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07004873 * Gets the {@link View} description. It briefly describes the view and is
4874 * primarily used for accessibility support. Set this property to enable
4875 * better accessibility support for your application. This is especially
4876 * true for views that do not have textual representation (For example,
4877 * ImageButton).
4878 *
Svetoslav Ganov42138042012-03-20 11:51:39 -07004879 * @return The content description.
svetoslavganov75986cf2009-05-14 22:28:01 -07004880 *
4881 * @attr ref android.R.styleable#View_contentDescription
4882 */
Svetoslav Ganov42138042012-03-20 11:51:39 -07004883 @ViewDebug.ExportedProperty(category = "accessibility")
svetoslavganov75986cf2009-05-14 22:28:01 -07004884 public CharSequence getContentDescription() {
4885 return mContentDescription;
4886 }
4887
4888 /**
4889 * Sets the {@link View} description. It briefly describes the view and is
4890 * primarily used for accessibility support. Set this property to enable
4891 * better accessibility support for your application. This is especially
4892 * true for views that do not have textual representation (For example,
4893 * ImageButton).
4894 *
4895 * @param contentDescription The content description.
4896 *
4897 * @attr ref android.R.styleable#View_contentDescription
4898 */
Svetoslav Ganove261e282011-10-18 17:47:04 -07004899 @RemotableViewMethod
svetoslavganov75986cf2009-05-14 22:28:01 -07004900 public void setContentDescription(CharSequence contentDescription) {
4901 mContentDescription = contentDescription;
4902 }
4903
4904 /**
Romain Guya2431d02009-04-30 16:30:00 -07004905 * Invoked whenever this view loses focus, either by losing window focus or by losing
4906 * focus within its window. This method can be used to clear any state tied to the
4907 * focus. For instance, if a button is held pressed with the trackball and the window
4908 * loses focus, this method can be used to cancel the press.
4909 *
4910 * Subclasses of View overriding this method should always call super.onFocusLost().
4911 *
4912 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07004913 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07004914 *
4915 * @hide pending API council approval
4916 */
4917 protected void onFocusLost() {
4918 resetPressedState();
4919 }
4920
4921 private void resetPressedState() {
4922 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4923 return;
4924 }
4925
4926 if (isPressed()) {
4927 setPressed(false);
4928
4929 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05004930 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004931 }
4932 }
4933 }
4934
4935 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004936 * Returns true if this view has focus
4937 *
4938 * @return True if this view has focus, false otherwise.
4939 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004940 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004941 public boolean isFocused() {
4942 return (mPrivateFlags & FOCUSED) != 0;
4943 }
4944
4945 /**
4946 * Find the view in the hierarchy rooted at this view that currently has
4947 * focus.
4948 *
4949 * @return The view that currently has focus, or null if no focused view can
4950 * be found.
4951 */
4952 public View findFocus() {
4953 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
4954 }
4955
4956 /**
Philip Milne6c8ea062012-04-03 17:38:43 -07004957 * Indicates whether this view is one of the set of scrollable containers in
4958 * its window.
4959 *
4960 * @return whether this view is one of the set of scrollable containers in
4961 * its window
4962 *
4963 * @attr ref android.R.styleable#View_isScrollContainer
4964 */
4965 public boolean isScrollContainer() {
4966 return (mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0;
4967 }
4968
4969 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004970 * Change whether this view is one of the set of scrollable containers in
4971 * its window. This will be used to determine whether the window can
4972 * resize or must pan when a soft input area is open -- scrollable
4973 * containers allow the window to use resize mode since the container
4974 * will appropriately shrink.
Philip Milne6c8ea062012-04-03 17:38:43 -07004975 *
4976 * @attr ref android.R.styleable#View_isScrollContainer
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004977 */
4978 public void setScrollContainer(boolean isScrollContainer) {
4979 if (isScrollContainer) {
4980 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
4981 mAttachInfo.mScrollContainers.add(this);
4982 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
4983 }
4984 mPrivateFlags |= SCROLL_CONTAINER;
4985 } else {
4986 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
4987 mAttachInfo.mScrollContainers.remove(this);
4988 }
4989 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
4990 }
4991 }
4992
4993 /**
4994 * Returns the quality of the drawing cache.
4995 *
4996 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
4997 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
4998 *
4999 * @see #setDrawingCacheQuality(int)
5000 * @see #setDrawingCacheEnabled(boolean)
5001 * @see #isDrawingCacheEnabled()
5002 *
5003 * @attr ref android.R.styleable#View_drawingCacheQuality
5004 */
5005 public int getDrawingCacheQuality() {
5006 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
5007 }
5008
5009 /**
5010 * Set the drawing cache quality of this view. This value is used only when the
5011 * drawing cache is enabled
5012 *
5013 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
5014 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
5015 *
5016 * @see #getDrawingCacheQuality()
5017 * @see #setDrawingCacheEnabled(boolean)
5018 * @see #isDrawingCacheEnabled()
5019 *
5020 * @attr ref android.R.styleable#View_drawingCacheQuality
5021 */
5022 public void setDrawingCacheQuality(int quality) {
5023 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
5024 }
5025
5026 /**
5027 * Returns whether the screen should remain on, corresponding to the current
5028 * value of {@link #KEEP_SCREEN_ON}.
5029 *
5030 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
5031 *
5032 * @see #setKeepScreenOn(boolean)
5033 *
5034 * @attr ref android.R.styleable#View_keepScreenOn
5035 */
5036 public boolean getKeepScreenOn() {
5037 return (mViewFlags & KEEP_SCREEN_ON) != 0;
5038 }
5039
5040 /**
5041 * Controls whether the screen should remain on, modifying the
5042 * value of {@link #KEEP_SCREEN_ON}.
5043 *
5044 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
5045 *
5046 * @see #getKeepScreenOn()
5047 *
5048 * @attr ref android.R.styleable#View_keepScreenOn
5049 */
5050 public void setKeepScreenOn(boolean keepScreenOn) {
5051 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
5052 }
5053
5054 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005055 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
5056 * @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 -08005057 *
5058 * @attr ref android.R.styleable#View_nextFocusLeft
5059 */
5060 public int getNextFocusLeftId() {
5061 return mNextFocusLeftId;
5062 }
5063
5064 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005065 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
5066 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
5067 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005068 *
5069 * @attr ref android.R.styleable#View_nextFocusLeft
5070 */
5071 public void setNextFocusLeftId(int nextFocusLeftId) {
5072 mNextFocusLeftId = nextFocusLeftId;
5073 }
5074
5075 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005076 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
5077 * @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 -08005078 *
5079 * @attr ref android.R.styleable#View_nextFocusRight
5080 */
5081 public int getNextFocusRightId() {
5082 return mNextFocusRightId;
5083 }
5084
5085 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005086 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
5087 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
5088 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005089 *
5090 * @attr ref android.R.styleable#View_nextFocusRight
5091 */
5092 public void setNextFocusRightId(int nextFocusRightId) {
5093 mNextFocusRightId = nextFocusRightId;
5094 }
5095
5096 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005097 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
5098 * @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 -08005099 *
5100 * @attr ref android.R.styleable#View_nextFocusUp
5101 */
5102 public int getNextFocusUpId() {
5103 return mNextFocusUpId;
5104 }
5105
5106 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005107 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
5108 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
5109 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005110 *
5111 * @attr ref android.R.styleable#View_nextFocusUp
5112 */
5113 public void setNextFocusUpId(int nextFocusUpId) {
5114 mNextFocusUpId = nextFocusUpId;
5115 }
5116
5117 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005118 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
5119 * @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 -08005120 *
5121 * @attr ref android.R.styleable#View_nextFocusDown
5122 */
5123 public int getNextFocusDownId() {
5124 return mNextFocusDownId;
5125 }
5126
5127 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005128 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
5129 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
5130 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005131 *
5132 * @attr ref android.R.styleable#View_nextFocusDown
5133 */
5134 public void setNextFocusDownId(int nextFocusDownId) {
5135 mNextFocusDownId = nextFocusDownId;
5136 }
5137
5138 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005139 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
5140 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
5141 *
5142 * @attr ref android.R.styleable#View_nextFocusForward
5143 */
5144 public int getNextFocusForwardId() {
5145 return mNextFocusForwardId;
5146 }
5147
5148 /**
5149 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
5150 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
5151 * decide automatically.
5152 *
5153 * @attr ref android.R.styleable#View_nextFocusForward
5154 */
5155 public void setNextFocusForwardId(int nextFocusForwardId) {
5156 mNextFocusForwardId = nextFocusForwardId;
5157 }
5158
5159 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005160 * Returns the visibility of this view and all of its ancestors
5161 *
5162 * @return True if this view and all of its ancestors are {@link #VISIBLE}
5163 */
5164 public boolean isShown() {
5165 View current = this;
5166 //noinspection ConstantConditions
5167 do {
5168 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
5169 return false;
5170 }
5171 ViewParent parent = current.mParent;
5172 if (parent == null) {
5173 return false; // We are not attached to the view root
5174 }
5175 if (!(parent instanceof View)) {
5176 return true;
5177 }
5178 current = (View) parent;
5179 } while (current != null);
5180
5181 return false;
5182 }
5183
5184 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005185 * Called by the view hierarchy when the content insets for a window have
5186 * changed, to allow it to adjust its content to fit within those windows.
5187 * The content insets tell you the space that the status bar, input method,
5188 * and other system windows infringe on the application's window.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005189 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005190 * <p>You do not normally need to deal with this function, since the default
5191 * window decoration given to applications takes care of applying it to the
5192 * content of the window. If you use {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}
5193 * or {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} this will not be the case,
5194 * and your content can be placed under those system elements. You can then
5195 * use this method within your view hierarchy if you have parts of your UI
5196 * which you would like to ensure are not being covered.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005197 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005198 * <p>The default implementation of this method simply applies the content
5199 * inset's to the view's padding. This can be enabled through
5200 * {@link #setFitsSystemWindows(boolean)}. Alternatively, you can override
5201 * the method and handle the insets however you would like. Note that the
5202 * insets provided by the framework are always relative to the far edges
5203 * of the window, not accounting for the location of the called view within
5204 * that window. (In fact when this method is called you do not yet know
5205 * where the layout will place the view, as it is done before layout happens.)
5206 *
5207 * <p>Note: unlike many View methods, there is no dispatch phase to this
5208 * call. If you are overriding it in a ViewGroup and want to allow the
5209 * call to continue to your children, you must be sure to call the super
5210 * implementation.
5211 *
Dianne Hackborncf675782012-05-10 15:07:24 -07005212 * <p>Here is a sample layout that makes use of fitting system windows
5213 * to have controls for a video view placed inside of the window decorations
5214 * that it hides and shows. This can be used with code like the second
5215 * sample (video player) shown in {@link #setSystemUiVisibility(int)}.
5216 *
5217 * {@sample development/samples/ApiDemos/res/layout/video_player.xml complete}
5218 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005219 * @param insets Current content insets of the window. Prior to
5220 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} you must not modify
5221 * the insets or else you and Android will be unhappy.
5222 *
5223 * @return Return true if this view applied the insets and it should not
5224 * continue propagating further down the hierarchy, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005225 */
5226 protected boolean fitSystemWindows(Rect insets) {
5227 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005228 mUserPaddingStart = -1;
5229 mUserPaddingEnd = -1;
5230 mUserPaddingRelative = false;
5231 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0
5232 || mAttachInfo == null
5233 || (mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0) {
5234 internalSetPadding(insets.left, insets.top, insets.right, insets.bottom);
5235 return true;
5236 } else {
5237 internalSetPadding(0, 0, 0, 0);
5238 return false;
5239 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005240 }
5241 return false;
5242 }
5243
5244 /**
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005245 * Set whether or not this view should account for system screen decorations
5246 * such as the status bar and inset its content. This allows this view to be
5247 * positioned in absolute screen coordinates and remain visible to the user.
5248 *
5249 * <p>This should only be used by top-level window decor views.
5250 *
5251 * @param fitSystemWindows true to inset content for system screen decorations, false for
5252 * default behavior.
5253 *
5254 * @attr ref android.R.styleable#View_fitsSystemWindows
5255 */
5256 public void setFitsSystemWindows(boolean fitSystemWindows) {
5257 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS);
5258 }
5259
5260 /**
Dianne Hackborncf675782012-05-10 15:07:24 -07005261 * Check for state of {@link #setFitsSystemWindows(boolean). If this method
5262 * returns true, this view
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005263 * will account for system screen decorations such as the status bar and inset its
5264 * content. This allows the view to be positioned in absolute screen coordinates
5265 * and remain visible to the user.
5266 *
5267 * @return true if this view will adjust its content bounds for system screen decorations.
5268 *
5269 * @attr ref android.R.styleable#View_fitsSystemWindows
5270 */
Dianne Hackborncf675782012-05-10 15:07:24 -07005271 public boolean getFitsSystemWindows() {
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005272 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
5273 }
5274
5275 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005276 * Ask that a new dispatch of {@link #fitSystemWindows(Rect)} be performed.
5277 */
5278 public void requestFitSystemWindows() {
5279 if (mParent != null) {
5280 mParent.requestFitSystemWindows();
5281 }
5282 }
5283
5284 /**
5285 * For use by PhoneWindow to make its own system window fitting optional.
5286 * @hide
5287 */
5288 public void makeOptionalFitsSystemWindows() {
5289 setFlags(OPTIONAL_FITS_SYSTEM_WINDOWS, OPTIONAL_FITS_SYSTEM_WINDOWS);
5290 }
5291
5292 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005293 * Returns the visibility status for this view.
5294 *
5295 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
5296 * @attr ref android.R.styleable#View_visibility
5297 */
5298 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07005299 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
5300 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
5301 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005302 })
5303 public int getVisibility() {
5304 return mViewFlags & VISIBILITY_MASK;
5305 }
5306
5307 /**
5308 * Set the enabled state of this view.
5309 *
5310 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
5311 * @attr ref android.R.styleable#View_visibility
5312 */
5313 @RemotableViewMethod
5314 public void setVisibility(int visibility) {
5315 setFlags(visibility, VISIBILITY_MASK);
Philip Milne6c8ea062012-04-03 17:38:43 -07005316 if (mBackground != null) mBackground.setVisible(visibility == VISIBLE, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005317 }
5318
5319 /**
5320 * Returns the enabled status for this view. The interpretation of the
5321 * enabled state varies by subclass.
5322 *
5323 * @return True if this view is enabled, false otherwise.
5324 */
5325 @ViewDebug.ExportedProperty
5326 public boolean isEnabled() {
5327 return (mViewFlags & ENABLED_MASK) == ENABLED;
5328 }
5329
5330 /**
5331 * Set the enabled state of this view. The interpretation of the enabled
5332 * state varies by subclass.
5333 *
5334 * @param enabled True if this view is enabled, false otherwise.
5335 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08005336 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005337 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07005338 if (enabled == isEnabled()) return;
5339
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005340 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
5341
5342 /*
5343 * The View most likely has to change its appearance, so refresh
5344 * the drawable state.
5345 */
5346 refreshDrawableState();
5347
5348 // Invalidate too, since the default behavior for views is to be
5349 // be drawn at 50% alpha rather than to change the drawable.
Romain Guy0fd89bf2011-01-26 15:41:30 -08005350 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005351 }
5352
5353 /**
5354 * Set whether this view can receive the focus.
5355 *
5356 * Setting this to false will also ensure that this view is not focusable
5357 * in touch mode.
5358 *
5359 * @param focusable If true, this view can receive the focus.
5360 *
5361 * @see #setFocusableInTouchMode(boolean)
5362 * @attr ref android.R.styleable#View_focusable
5363 */
5364 public void setFocusable(boolean focusable) {
5365 if (!focusable) {
5366 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
5367 }
5368 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
5369 }
5370
5371 /**
5372 * Set whether this view can receive focus while in touch mode.
5373 *
5374 * Setting this to true will also ensure that this view is focusable.
5375 *
5376 * @param focusableInTouchMode If true, this view can receive the focus while
5377 * in touch mode.
5378 *
5379 * @see #setFocusable(boolean)
5380 * @attr ref android.R.styleable#View_focusableInTouchMode
5381 */
5382 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
5383 // Focusable in touch mode should always be set before the focusable flag
5384 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
5385 // which, in touch mode, will not successfully request focus on this view
5386 // because the focusable in touch mode flag is not set
5387 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
5388 if (focusableInTouchMode) {
5389 setFlags(FOCUSABLE, FOCUSABLE_MASK);
5390 }
5391 }
5392
5393 /**
5394 * Set whether this view should have sound effects enabled for events such as
5395 * clicking and touching.
5396 *
5397 * <p>You may wish to disable sound effects for a view if you already play sounds,
5398 * for instance, a dial key that plays dtmf tones.
5399 *
5400 * @param soundEffectsEnabled whether sound effects are enabled for this view.
5401 * @see #isSoundEffectsEnabled()
5402 * @see #playSoundEffect(int)
5403 * @attr ref android.R.styleable#View_soundEffectsEnabled
5404 */
5405 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
5406 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
5407 }
5408
5409 /**
5410 * @return whether this view should have sound effects enabled for events such as
5411 * clicking and touching.
5412 *
5413 * @see #setSoundEffectsEnabled(boolean)
5414 * @see #playSoundEffect(int)
5415 * @attr ref android.R.styleable#View_soundEffectsEnabled
5416 */
5417 @ViewDebug.ExportedProperty
5418 public boolean isSoundEffectsEnabled() {
5419 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
5420 }
5421
5422 /**
5423 * Set whether this view should have haptic feedback for events such as
5424 * long presses.
5425 *
5426 * <p>You may wish to disable haptic feedback if your view already controls
5427 * its own haptic feedback.
5428 *
5429 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
5430 * @see #isHapticFeedbackEnabled()
5431 * @see #performHapticFeedback(int)
5432 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
5433 */
5434 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
5435 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
5436 }
5437
5438 /**
5439 * @return whether this view should have haptic feedback enabled for events
5440 * long presses.
5441 *
5442 * @see #setHapticFeedbackEnabled(boolean)
5443 * @see #performHapticFeedback(int)
5444 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
5445 */
5446 @ViewDebug.ExportedProperty
5447 public boolean isHapticFeedbackEnabled() {
5448 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
5449 }
5450
5451 /**
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005452 * Returns the layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08005453 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005454 * @return One of {@link #LAYOUT_DIRECTION_LTR},
5455 * {@link #LAYOUT_DIRECTION_RTL},
5456 * {@link #LAYOUT_DIRECTION_INHERIT} or
5457 * {@link #LAYOUT_DIRECTION_LOCALE}.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005458 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005459 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005460 * @hide
Cibu Johny7632cb92010-02-22 13:01:02 -08005461 */
Fabrice Di Megliobce84d22011-06-02 15:57:01 -07005462 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005463 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"),
5464 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"),
5465 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"),
5466 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE")
Cibu Johny7632cb92010-02-22 13:01:02 -08005467 })
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005468 public int getLayoutDirection() {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005469 return (mPrivateFlags2 & LAYOUT_DIRECTION_MASK) >> LAYOUT_DIRECTION_MASK_SHIFT;
Cibu Johny7632cb92010-02-22 13:01:02 -08005470 }
5471
5472 /**
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005473 * Set the layout direction for this view. This will propagate a reset of layout direction
5474 * resolution to the view's children and resolve layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08005475 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005476 * @param layoutDirection One of {@link #LAYOUT_DIRECTION_LTR},
5477 * {@link #LAYOUT_DIRECTION_RTL},
5478 * {@link #LAYOUT_DIRECTION_INHERIT} or
5479 * {@link #LAYOUT_DIRECTION_LOCALE}.
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005480 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005481 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005482 * @hide
Cibu Johny7632cb92010-02-22 13:01:02 -08005483 */
5484 @RemotableViewMethod
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005485 public void setLayoutDirection(int layoutDirection) {
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005486 if (getLayoutDirection() != layoutDirection) {
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -07005487 // Reset the current layout direction and the resolved one
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005488 mPrivateFlags2 &= ~LAYOUT_DIRECTION_MASK;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07005489 resetResolvedLayoutDirection();
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005490 // Set the new layout direction (filtered) and ask for a layout pass
5491 mPrivateFlags2 |=
5492 ((layoutDirection << LAYOUT_DIRECTION_MASK_SHIFT) & LAYOUT_DIRECTION_MASK);
5493 requestLayout();
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005494 }
Cibu Johny7632cb92010-02-22 13:01:02 -08005495 }
5496
5497 /**
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005498 * Returns the resolved layout direction for this view.
5499 *
5500 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005501 * {@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005502 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005503 */
5504 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005505 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"),
5506 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL")
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005507 })
5508 public int getResolvedLayoutDirection() {
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -07005509 // The layout diretion will be resolved only if needed
5510 if ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED) != LAYOUT_DIRECTION_RESOLVED) {
5511 resolveLayoutDirection();
5512 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07005513 return ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED_RTL) == LAYOUT_DIRECTION_RESOLVED_RTL) ?
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005514 LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR;
5515 }
5516
5517 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005518 * Indicates whether or not this view's layout is right-to-left. This is resolved from
5519 * layout attribute and/or the inherited value from the parent
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005520 *
5521 * @return true if the layout is right-to-left.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005522 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005523 */
5524 @ViewDebug.ExportedProperty(category = "layout")
5525 public boolean isLayoutRtl() {
5526 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL);
5527 }
5528
5529 /**
Adam Powell539ee872012-02-03 19:00:49 -08005530 * Indicates whether the view is currently tracking transient state that the
5531 * app should not need to concern itself with saving and restoring, but that
5532 * the framework should take special note to preserve when possible.
5533 *
Adam Powell785c4472012-05-02 21:25:39 -07005534 * <p>A view with transient state cannot be trivially rebound from an external
5535 * data source, such as an adapter binding item views in a list. This may be
5536 * because the view is performing an animation, tracking user selection
5537 * of content, or similar.</p>
5538 *
Adam Powell539ee872012-02-03 19:00:49 -08005539 * @return true if the view has transient state
Adam Powell539ee872012-02-03 19:00:49 -08005540 */
5541 @ViewDebug.ExportedProperty(category = "layout")
5542 public boolean hasTransientState() {
5543 return (mPrivateFlags2 & HAS_TRANSIENT_STATE) == HAS_TRANSIENT_STATE;
5544 }
5545
5546 /**
5547 * Set whether this view is currently tracking transient state that the
Chet Haase563d4f22012-04-18 16:20:08 -07005548 * framework should attempt to preserve when possible. This flag is reference counted,
5549 * so every call to setHasTransientState(true) should be paired with a later call
5550 * to setHasTransientState(false).
Adam Powell539ee872012-02-03 19:00:49 -08005551 *
Adam Powell785c4472012-05-02 21:25:39 -07005552 * <p>A view with transient state cannot be trivially rebound from an external
5553 * data source, such as an adapter binding item views in a list. This may be
5554 * because the view is performing an animation, tracking user selection
5555 * of content, or similar.</p>
5556 *
Adam Powell539ee872012-02-03 19:00:49 -08005557 * @param hasTransientState true if this view has transient state
Adam Powell539ee872012-02-03 19:00:49 -08005558 */
5559 public void setHasTransientState(boolean hasTransientState) {
Chet Haase563d4f22012-04-18 16:20:08 -07005560 mTransientStateCount = hasTransientState ? mTransientStateCount + 1 :
5561 mTransientStateCount - 1;
5562 if (mTransientStateCount < 0) {
5563 mTransientStateCount = 0;
5564 Log.e(VIEW_LOG_TAG, "hasTransientState decremented below 0: " +
5565 "unmatched pair of setHasTransientState calls");
5566 }
5567 if ((hasTransientState && mTransientStateCount == 1) ||
5568 (hasTransientState && mTransientStateCount == 0)) {
5569 // update flag if we've just incremented up from 0 or decremented down to 0
5570 mPrivateFlags2 = (mPrivateFlags2 & ~HAS_TRANSIENT_STATE) |
5571 (hasTransientState ? HAS_TRANSIENT_STATE : 0);
5572 if (mParent != null) {
5573 try {
5574 mParent.childHasTransientStateChanged(this, hasTransientState);
5575 } catch (AbstractMethodError e) {
5576 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() +
5577 " does not fully implement ViewParent", e);
5578 }
Adam Powell539ee872012-02-03 19:00:49 -08005579 }
5580 }
5581 }
5582
5583 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005584 * If this view doesn't do any drawing on its own, set this flag to
5585 * allow further optimizations. By default, this flag is not set on
5586 * View, but could be set on some View subclasses such as ViewGroup.
5587 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005588 * Typically, if you override {@link #onDraw(android.graphics.Canvas)}
5589 * you should clear this flag.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005590 *
5591 * @param willNotDraw whether or not this View draw on its own
5592 */
5593 public void setWillNotDraw(boolean willNotDraw) {
5594 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
5595 }
5596
5597 /**
5598 * Returns whether or not this View draws on its own.
5599 *
5600 * @return true if this view has nothing to draw, false otherwise
5601 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005602 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005603 public boolean willNotDraw() {
5604 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
5605 }
5606
5607 /**
5608 * When a View's drawing cache is enabled, drawing is redirected to an
5609 * offscreen bitmap. Some views, like an ImageView, must be able to
5610 * bypass this mechanism if they already draw a single bitmap, to avoid
5611 * unnecessary usage of the memory.
5612 *
5613 * @param willNotCacheDrawing true if this view does not cache its
5614 * drawing, false otherwise
5615 */
5616 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
5617 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
5618 }
5619
5620 /**
5621 * Returns whether or not this View can cache its drawing or not.
5622 *
5623 * @return true if this view does not cache its drawing, false otherwise
5624 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005625 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005626 public boolean willNotCacheDrawing() {
5627 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
5628 }
5629
5630 /**
5631 * Indicates whether this view reacts to click events or not.
5632 *
5633 * @return true if the view is clickable, false otherwise
5634 *
5635 * @see #setClickable(boolean)
5636 * @attr ref android.R.styleable#View_clickable
5637 */
5638 @ViewDebug.ExportedProperty
5639 public boolean isClickable() {
5640 return (mViewFlags & CLICKABLE) == CLICKABLE;
5641 }
5642
5643 /**
5644 * Enables or disables click events for this view. When a view
5645 * is clickable it will change its state to "pressed" on every click.
5646 * Subclasses should set the view clickable to visually react to
5647 * user's clicks.
5648 *
5649 * @param clickable true to make the view clickable, false otherwise
5650 *
5651 * @see #isClickable()
5652 * @attr ref android.R.styleable#View_clickable
5653 */
5654 public void setClickable(boolean clickable) {
5655 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
5656 }
5657
5658 /**
5659 * Indicates whether this view reacts to long click events or not.
5660 *
5661 * @return true if the view is long clickable, false otherwise
5662 *
5663 * @see #setLongClickable(boolean)
5664 * @attr ref android.R.styleable#View_longClickable
5665 */
5666 public boolean isLongClickable() {
5667 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
5668 }
5669
5670 /**
5671 * Enables or disables long click events for this view. When a view is long
5672 * clickable it reacts to the user holding down the button for a longer
5673 * duration than a tap. This event can either launch the listener or a
5674 * context menu.
5675 *
5676 * @param longClickable true to make the view long clickable, false otherwise
5677 * @see #isLongClickable()
5678 * @attr ref android.R.styleable#View_longClickable
5679 */
5680 public void setLongClickable(boolean longClickable) {
5681 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
5682 }
5683
5684 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07005685 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005686 *
5687 * @see #isClickable()
5688 * @see #setClickable(boolean)
5689 *
5690 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
5691 * the View's internal state from a previously set "pressed" state.
5692 */
5693 public void setPressed(boolean pressed) {
Adam Powell035a1fc2012-02-27 15:23:50 -08005694 final boolean needsRefresh = pressed != ((mPrivateFlags & PRESSED) == PRESSED);
Adam Powell4d6f0662012-02-21 15:11:11 -08005695
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005696 if (pressed) {
5697 mPrivateFlags |= PRESSED;
5698 } else {
5699 mPrivateFlags &= ~PRESSED;
5700 }
Adam Powell035a1fc2012-02-27 15:23:50 -08005701
5702 if (needsRefresh) {
5703 refreshDrawableState();
5704 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005705 dispatchSetPressed(pressed);
5706 }
5707
5708 /**
5709 * Dispatch setPressed to all of this View's children.
5710 *
5711 * @see #setPressed(boolean)
5712 *
5713 * @param pressed The new pressed state
5714 */
5715 protected void dispatchSetPressed(boolean pressed) {
5716 }
5717
5718 /**
5719 * Indicates whether the view is currently in pressed state. Unless
5720 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
5721 * the pressed state.
5722 *
Philip Milne6c8ea062012-04-03 17:38:43 -07005723 * @see #setPressed(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005724 * @see #isClickable()
5725 * @see #setClickable(boolean)
5726 *
5727 * @return true if the view is currently pressed, false otherwise
5728 */
5729 public boolean isPressed() {
5730 return (mPrivateFlags & PRESSED) == PRESSED;
5731 }
5732
5733 /**
5734 * Indicates whether this view will save its state (that is,
5735 * whether its {@link #onSaveInstanceState} method will be called).
5736 *
5737 * @return Returns true if the view state saving is enabled, else false.
5738 *
5739 * @see #setSaveEnabled(boolean)
5740 * @attr ref android.R.styleable#View_saveEnabled
5741 */
5742 public boolean isSaveEnabled() {
5743 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
5744 }
5745
5746 /**
5747 * Controls whether the saving of this view's state is
5748 * enabled (that is, whether its {@link #onSaveInstanceState} method
5749 * will be called). Note that even if freezing is enabled, the
Romain Guy5c22a8c2011-05-13 11:48:45 -07005750 * view still must have an id assigned to it (via {@link #setId(int)})
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005751 * for its state to be saved. This flag can only disable the
5752 * saving of this view; any child views may still have their state saved.
5753 *
5754 * @param enabled Set to false to <em>disable</em> state saving, or true
5755 * (the default) to allow it.
5756 *
5757 * @see #isSaveEnabled()
5758 * @see #setId(int)
5759 * @see #onSaveInstanceState()
5760 * @attr ref android.R.styleable#View_saveEnabled
5761 */
5762 public void setSaveEnabled(boolean enabled) {
5763 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
5764 }
5765
Jeff Brown85a31762010-09-01 17:01:00 -07005766 /**
5767 * Gets whether the framework should discard touches when the view's
5768 * window is obscured by another visible window.
5769 * Refer to the {@link View} security documentation for more details.
5770 *
5771 * @return True if touch filtering is enabled.
5772 *
5773 * @see #setFilterTouchesWhenObscured(boolean)
5774 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
5775 */
5776 @ViewDebug.ExportedProperty
5777 public boolean getFilterTouchesWhenObscured() {
5778 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
5779 }
5780
5781 /**
5782 * Sets whether the framework should discard touches when the view's
5783 * window is obscured by another visible window.
5784 * Refer to the {@link View} security documentation for more details.
5785 *
5786 * @param enabled True if touch filtering should be enabled.
5787 *
5788 * @see #getFilterTouchesWhenObscured
5789 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
5790 */
5791 public void setFilterTouchesWhenObscured(boolean enabled) {
5792 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
5793 FILTER_TOUCHES_WHEN_OBSCURED);
5794 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005795
5796 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07005797 * Indicates whether the entire hierarchy under this view will save its
5798 * state when a state saving traversal occurs from its parent. The default
5799 * is true; if false, these views will not be saved unless
5800 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
5801 *
5802 * @return Returns true if the view state saving from parent is enabled, else false.
5803 *
5804 * @see #setSaveFromParentEnabled(boolean)
5805 */
5806 public boolean isSaveFromParentEnabled() {
5807 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
5808 }
5809
5810 /**
5811 * Controls whether the entire hierarchy under this view will save its
5812 * state when a state saving traversal occurs from its parent. The default
5813 * is true; if false, these views will not be saved unless
5814 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
5815 *
5816 * @param enabled Set to false to <em>disable</em> state saving, or true
5817 * (the default) to allow it.
5818 *
5819 * @see #isSaveFromParentEnabled()
5820 * @see #setId(int)
5821 * @see #onSaveInstanceState()
5822 */
5823 public void setSaveFromParentEnabled(boolean enabled) {
5824 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
5825 }
5826
5827
5828 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005829 * Returns whether this View is able to take focus.
5830 *
5831 * @return True if this view can take focus, or false otherwise.
5832 * @attr ref android.R.styleable#View_focusable
5833 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005834 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005835 public final boolean isFocusable() {
5836 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
5837 }
5838
5839 /**
5840 * When a view is focusable, it may not want to take focus when in touch mode.
5841 * For example, a button would like focus when the user is navigating via a D-pad
5842 * so that the user can click on it, but once the user starts touching the screen,
5843 * the button shouldn't take focus
5844 * @return Whether the view is focusable in touch mode.
5845 * @attr ref android.R.styleable#View_focusableInTouchMode
5846 */
5847 @ViewDebug.ExportedProperty
5848 public final boolean isFocusableInTouchMode() {
5849 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
5850 }
5851
5852 /**
5853 * Find the nearest view in the specified direction that can take focus.
5854 * This does not actually give focus to that view.
5855 *
5856 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
5857 *
5858 * @return The nearest focusable in the specified direction, or null if none
5859 * can be found.
5860 */
5861 public View focusSearch(int direction) {
5862 if (mParent != null) {
5863 return mParent.focusSearch(this, direction);
5864 } else {
5865 return null;
5866 }
5867 }
5868
5869 /**
5870 * This method is the last chance for the focused view and its ancestors to
5871 * respond to an arrow key. This is called when the focused view did not
5872 * consume the key internally, nor could the view system find a new view in
5873 * the requested direction to give focus to.
5874 *
5875 * @param focused The currently focused view.
5876 * @param direction The direction focus wants to move. One of FOCUS_UP,
5877 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
5878 * @return True if the this view consumed this unhandled move.
5879 */
5880 public boolean dispatchUnhandledMove(View focused, int direction) {
5881 return false;
5882 }
5883
5884 /**
5885 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08005886 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005887 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08005888 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
5889 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005890 * @return The user specified next view, or null if there is none.
5891 */
5892 View findUserSetNextFocus(View root, int direction) {
5893 switch (direction) {
5894 case FOCUS_LEFT:
5895 if (mNextFocusLeftId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005896 return findViewInsideOutShouldExist(root, mNextFocusLeftId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005897 case FOCUS_RIGHT:
5898 if (mNextFocusRightId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005899 return findViewInsideOutShouldExist(root, mNextFocusRightId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005900 case FOCUS_UP:
5901 if (mNextFocusUpId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005902 return findViewInsideOutShouldExist(root, mNextFocusUpId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005903 case FOCUS_DOWN:
5904 if (mNextFocusDownId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005905 return findViewInsideOutShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08005906 case FOCUS_FORWARD:
5907 if (mNextFocusForwardId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005908 return findViewInsideOutShouldExist(root, mNextFocusForwardId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08005909 case FOCUS_BACKWARD: {
John Reck1ecebbb2012-03-06 16:08:54 -08005910 if (mID == View.NO_ID) return null;
Jeff Brown4e6319b2010-12-13 10:36:51 -08005911 final int id = mID;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005912 return root.findViewByPredicateInsideOut(this, new Predicate<View>() {
Jeff Brown4e6319b2010-12-13 10:36:51 -08005913 @Override
5914 public boolean apply(View t) {
5915 return t.mNextFocusForwardId == id;
5916 }
5917 });
5918 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005919 }
5920 return null;
5921 }
5922
Jeff Brown4dfbec22011-08-15 14:55:37 -07005923 private View findViewInsideOutShouldExist(View root, final int childViewId) {
5924 View result = root.findViewByPredicateInsideOut(this, new Predicate<View>() {
5925 @Override
5926 public boolean apply(View t) {
5927 return t.mID == childViewId;
5928 }
5929 });
5930
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005931 if (result == null) {
5932 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
5933 + "by user for id " + childViewId);
5934 }
5935 return result;
5936 }
5937
5938 /**
5939 * Find and return all focusable views that are descendants of this view,
5940 * possibly including this view if it is focusable itself.
5941 *
5942 * @param direction The direction of the focus
5943 * @return A list of focusable views
5944 */
5945 public ArrayList<View> getFocusables(int direction) {
5946 ArrayList<View> result = new ArrayList<View>(24);
5947 addFocusables(result, direction);
5948 return result;
5949 }
5950
5951 /**
5952 * Add any focusable views that are descendants of this view (possibly
5953 * including this view if it is focusable itself) to views. If we are in touch mode,
5954 * only add views that are also focusable in touch mode.
5955 *
5956 * @param views Focusable views found so far
5957 * @param direction The direction of the focus
5958 */
5959 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07005960 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
5961 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005962
svetoslavganov75986cf2009-05-14 22:28:01 -07005963 /**
5964 * Adds any focusable views that are descendants of this view (possibly
5965 * including this view if it is focusable itself) to views. This method
5966 * adds all focusable views regardless if we are in touch mode or
Svetoslav Ganov42138042012-03-20 11:51:39 -07005967 * only views focusable in touch mode if we are in touch mode or
5968 * only views that can take accessibility focus if accessibility is enabeld
5969 * depending on the focusable mode paramater.
svetoslavganov75986cf2009-05-14 22:28:01 -07005970 *
5971 * @param views Focusable views found so far or null if all we are interested is
5972 * the number of focusables.
5973 * @param direction The direction of the focus.
5974 * @param focusableMode The type of focusables to be added.
5975 *
5976 * @see #FOCUSABLES_ALL
5977 * @see #FOCUSABLES_TOUCH_MODE
5978 */
5979 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07005980 if (views == null) {
svetoslavganov75986cf2009-05-14 22:28:01 -07005981 return;
5982 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07005983 if ((focusableMode & FOCUSABLES_ACCESSIBILITY) == FOCUSABLES_ACCESSIBILITY) {
5984 if (AccessibilityManager.getInstance(mContext).isEnabled()
5985 && includeForAccessibility()) {
5986 views.add(this);
5987 return;
5988 }
5989 }
Svetoslav Ganov3cb889c2012-04-16 19:10:30 -07005990 if (!isFocusable()) {
5991 return;
svetoslavganov75986cf2009-05-14 22:28:01 -07005992 }
Svetoslav Ganov3cb889c2012-04-16 19:10:30 -07005993 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE
5994 && isInTouchMode() && !isFocusableInTouchMode()) {
5995 return;
5996 }
5997 views.add(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005998 }
5999
6000 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006001 * Finds the Views that contain given text. The containment is case insensitive.
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006002 * The search is performed by either the text that the View renders or the content
6003 * description that describes the view for accessibility purposes and the view does
6004 * not render or both. Clients can specify how the search is to be performed via
6005 * passing the {@link #FIND_VIEWS_WITH_TEXT} and
6006 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags.
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006007 *
6008 * @param outViews The output list of matching Views.
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006009 * @param searched The text to match against.
Svetoslav Ganov02107852011-10-03 17:06:56 -07006010 *
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006011 * @see #FIND_VIEWS_WITH_TEXT
6012 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION
6013 * @see #setContentDescription(CharSequence)
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006014 */
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006015 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, int flags) {
Svetoslav Ganov02107852011-10-03 17:06:56 -07006016 if (getAccessibilityNodeProvider() != null) {
6017 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) {
6018 outViews.add(this);
6019 }
6020 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006021 && (searched != null && searched.length() > 0)
6022 && (mContentDescription != null && mContentDescription.length() > 0)) {
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006023 String searchedLowerCase = searched.toString().toLowerCase();
6024 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase();
6025 if (contentDescriptionLowerCase.contains(searchedLowerCase)) {
6026 outViews.add(this);
6027 }
6028 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006029 }
6030
6031 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006032 * Find and return all touchable views that are descendants of this view,
6033 * possibly including this view if it is touchable itself.
6034 *
6035 * @return A list of touchable views
6036 */
6037 public ArrayList<View> getTouchables() {
6038 ArrayList<View> result = new ArrayList<View>();
6039 addTouchables(result);
6040 return result;
6041 }
6042
6043 /**
6044 * Add any touchable views that are descendants of this view (possibly
6045 * including this view if it is touchable itself) to views.
6046 *
6047 * @param views Touchable views found so far
6048 */
6049 public void addTouchables(ArrayList<View> views) {
6050 final int viewFlags = mViewFlags;
6051
6052 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
6053 && (viewFlags & ENABLED_MASK) == ENABLED) {
6054 views.add(this);
6055 }
6056 }
6057
6058 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006059 * Returns whether this View is accessibility focused.
6060 *
6061 * @return True if this View is accessibility focused.
6062 */
6063 boolean isAccessibilityFocused() {
6064 return (mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0;
6065 }
6066
6067 /**
6068 * Call this to try to give accessibility focus to this view.
6069 *
6070 * A view will not actually take focus if {@link AccessibilityManager#isEnabled()}
6071 * returns false or the view is no visible or the view already has accessibility
6072 * focus.
6073 *
6074 * See also {@link #focusSearch(int)}, which is what you call to say that you
6075 * have focus, and you want your parent to look for the next one.
6076 *
6077 * @return Whether this view actually took accessibility focus.
6078 *
6079 * @hide
6080 */
6081 public boolean requestAccessibilityFocus() {
Svetoslav Ganov07b726c2012-04-30 12:24:57 -07006082 AccessibilityManager manager = AccessibilityManager.getInstance(mContext);
6083 if (!manager.isEnabled() || !manager.isTouchExplorationEnabled()) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006084 return false;
6085 }
6086 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) {
6087 return false;
6088 }
6089 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) == 0) {
6090 mPrivateFlags2 |= ACCESSIBILITY_FOCUSED;
6091 ViewRootImpl viewRootImpl = getViewRootImpl();
6092 if (viewRootImpl != null) {
6093 viewRootImpl.setAccessibilityFocusedHost(this);
6094 }
6095 invalidate();
6096 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED);
6097 notifyAccessibilityStateChanged();
6098 // Try to give input focus to this view - not a descendant.
6099 requestFocusNoSearch(View.FOCUS_DOWN, null);
6100 return true;
6101 }
6102 return false;
6103 }
6104
6105 /**
6106 * Call this to try to clear accessibility focus of this view.
6107 *
6108 * See also {@link #focusSearch(int)}, which is what you call to say that you
6109 * have focus, and you want your parent to look for the next one.
6110 *
6111 * @hide
6112 */
6113 public void clearAccessibilityFocus() {
6114 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0) {
6115 mPrivateFlags2 &= ~ACCESSIBILITY_FOCUSED;
6116 ViewRootImpl viewRootImpl = getViewRootImpl();
6117 if (viewRootImpl != null) {
6118 viewRootImpl.setAccessibilityFocusedHost(null);
6119 }
6120 invalidate();
6121 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED);
6122 notifyAccessibilityStateChanged();
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006123
6124 // Clear the text navigation state.
6125 setAccessibilityCursorPosition(-1);
6126
Svetoslav Ganov42138042012-03-20 11:51:39 -07006127 // Try to move accessibility focus to the input focus.
6128 View rootView = getRootView();
6129 if (rootView != null) {
6130 View inputFocus = rootView.findFocus();
6131 if (inputFocus != null) {
6132 inputFocus.requestAccessibilityFocus();
6133 }
6134 }
6135 }
6136 }
6137
6138 /**
6139 * Find the best view to take accessibility focus from a hover.
6140 * This function finds the deepest actionable view and if that
6141 * fails ask the parent to take accessibility focus from hover.
6142 *
6143 * @param x The X hovered location in this view coorditantes.
6144 * @param y The Y hovered location in this view coorditantes.
6145 * @return Whether the request was handled.
6146 *
6147 * @hide
6148 */
6149 public boolean requestAccessibilityFocusFromHover(float x, float y) {
6150 if (onRequestAccessibilityFocusFromHover(x, y)) {
6151 return true;
6152 }
6153 ViewParent parent = mParent;
6154 if (parent instanceof View) {
6155 View parentView = (View) parent;
6156
6157 float[] position = mAttachInfo.mTmpTransformLocation;
6158 position[0] = x;
6159 position[1] = y;
6160
6161 // Compensate for the transformation of the current matrix.
6162 if (!hasIdentityMatrix()) {
6163 getMatrix().mapPoints(position);
6164 }
6165
6166 // Compensate for the parent scroll and the offset
6167 // of this view stop from the parent top.
6168 position[0] += mLeft - parentView.mScrollX;
6169 position[1] += mTop - parentView.mScrollY;
6170
6171 return parentView.requestAccessibilityFocusFromHover(position[0], position[1]);
6172 }
6173 return false;
6174 }
6175
6176 /**
6177 * Requests to give this View focus from hover.
6178 *
6179 * @param x The X hovered location in this view coorditantes.
6180 * @param y The Y hovered location in this view coorditantes.
6181 * @return Whether the request was handled.
6182 *
6183 * @hide
6184 */
6185 public boolean onRequestAccessibilityFocusFromHover(float x, float y) {
6186 if (includeForAccessibility()
6187 && (isActionableForAccessibility() || hasListenersForAccessibility())) {
6188 return requestAccessibilityFocus();
6189 }
6190 return false;
6191 }
6192
6193 /**
6194 * Clears accessibility focus without calling any callback methods
6195 * normally invoked in {@link #clearAccessibilityFocus()}. This method
6196 * is used for clearing accessibility focus when giving this focus to
6197 * another view.
6198 */
6199 void clearAccessibilityFocusNoCallbacks() {
6200 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0) {
6201 mPrivateFlags2 &= ~ACCESSIBILITY_FOCUSED;
6202 invalidate();
6203 }
6204 }
6205
6206 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006207 * Call this to try to give focus to a specific view or to one of its
6208 * descendants.
6209 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006210 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6211 * false), or if it is focusable and it is not focusable in touch mode
6212 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006213 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006214 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006215 * have focus, and you want your parent to look for the next one.
6216 *
6217 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
6218 * {@link #FOCUS_DOWN} and <code>null</code>.
6219 *
6220 * @return Whether this view or one of its descendants actually took focus.
6221 */
6222 public final boolean requestFocus() {
6223 return requestFocus(View.FOCUS_DOWN);
6224 }
6225
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006226 /**
6227 * Call this to try to give focus to a specific view or to one of its
6228 * descendants and give it a hint about what direction focus is heading.
6229 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006230 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6231 * false), or if it is focusable and it is not focusable in touch mode
6232 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006233 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006234 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006235 * have focus, and you want your parent to look for the next one.
6236 *
6237 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
6238 * <code>null</code> set for the previously focused rectangle.
6239 *
6240 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
6241 * @return Whether this view or one of its descendants actually took focus.
6242 */
6243 public final boolean requestFocus(int direction) {
6244 return requestFocus(direction, null);
6245 }
6246
6247 /**
6248 * Call this to try to give focus to a specific view or to one of its descendants
6249 * and give it hints about the direction and a specific rectangle that the focus
6250 * is coming from. The rectangle can help give larger views a finer grained hint
6251 * about where focus is coming from, and therefore, where to show selection, or
6252 * forward focus change internally.
6253 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006254 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6255 * false), or if it is focusable and it is not focusable in touch mode
6256 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006257 *
6258 * A View will not take focus if it is not visible.
6259 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006260 * A View will not take focus if one of its parents has
6261 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to
6262 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006263 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006264 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006265 * have focus, and you want your parent to look for the next one.
6266 *
6267 * You may wish to override this method if your custom {@link View} has an internal
6268 * {@link View} that it wishes to forward the request to.
6269 *
6270 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
6271 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
6272 * to give a finer grained hint about where focus is coming from. May be null
6273 * if there is no hint.
6274 * @return Whether this view or one of its descendants actually took focus.
6275 */
6276 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006277 return requestFocusNoSearch(direction, previouslyFocusedRect);
6278 }
6279
6280 private boolean requestFocusNoSearch(int direction, Rect previouslyFocusedRect) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006281 // need to be focusable
6282 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
6283 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
6284 return false;
6285 }
6286
6287 // need to be focusable in touch mode if in touch mode
6288 if (isInTouchMode() &&
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006289 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
6290 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006291 }
6292
6293 // need to not have any parents blocking us
6294 if (hasAncestorThatBlocksDescendantFocus()) {
6295 return false;
6296 }
6297
6298 handleFocusGainInternal(direction, previouslyFocusedRect);
6299 return true;
6300 }
6301
6302 /**
6303 * Call this to try to give focus to a specific view or to one of its descendants. This is a
6304 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
6305 * touch mode to request focus when they are touched.
6306 *
6307 * @return Whether this view or one of its descendants actually took focus.
6308 *
6309 * @see #isInTouchMode()
6310 *
6311 */
6312 public final boolean requestFocusFromTouch() {
6313 // Leave touch mode if we need to
6314 if (isInTouchMode()) {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07006315 ViewRootImpl viewRoot = getViewRootImpl();
Christopher Tate2c095f32010-10-04 14:13:40 -07006316 if (viewRoot != null) {
6317 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006318 }
6319 }
6320 return requestFocus(View.FOCUS_DOWN);
6321 }
6322
6323 /**
6324 * @return Whether any ancestor of this view blocks descendant focus.
6325 */
6326 private boolean hasAncestorThatBlocksDescendantFocus() {
6327 ViewParent ancestor = mParent;
6328 while (ancestor instanceof ViewGroup) {
6329 final ViewGroup vgAncestor = (ViewGroup) ancestor;
6330 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
6331 return true;
6332 } else {
6333 ancestor = vgAncestor.getParent();
6334 }
6335 }
6336 return false;
6337 }
6338
6339 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006340 * Gets the mode for determining whether this View is important for accessibility
6341 * which is if it fires accessibility events and if it is reported to
6342 * accessibility services that query the screen.
6343 *
6344 * @return The mode for determining whether a View is important for accessibility.
6345 *
6346 * @attr ref android.R.styleable#View_importantForAccessibility
6347 *
6348 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES
6349 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO
6350 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO
6351 */
6352 @ViewDebug.ExportedProperty(category = "accessibility", mapping = {
6353 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_AUTO,
6354 to = "IMPORTANT_FOR_ACCESSIBILITY_AUTO"),
6355 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_YES,
6356 to = "IMPORTANT_FOR_ACCESSIBILITY_YES"),
6357 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO,
6358 to = "IMPORTANT_FOR_ACCESSIBILITY_NO")
6359 })
6360 public int getImportantForAccessibility() {
6361 return (mPrivateFlags2 & IMPORTANT_FOR_ACCESSIBILITY_MASK)
6362 >> IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
6363 }
6364
6365 /**
6366 * Sets how to determine whether this view is important for accessibility
6367 * which is if it fires accessibility events and if it is reported to
6368 * accessibility services that query the screen.
6369 *
6370 * @param mode How to determine whether this view is important for accessibility.
6371 *
6372 * @attr ref android.R.styleable#View_importantForAccessibility
6373 *
6374 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES
6375 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO
6376 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO
6377 */
6378 public void setImportantForAccessibility(int mode) {
6379 if (mode != getImportantForAccessibility()) {
6380 mPrivateFlags2 &= ~IMPORTANT_FOR_ACCESSIBILITY_MASK;
6381 mPrivateFlags2 |= (mode << IMPORTANT_FOR_ACCESSIBILITY_SHIFT)
6382 & IMPORTANT_FOR_ACCESSIBILITY_MASK;
6383 notifyAccessibilityStateChanged();
6384 }
6385 }
6386
6387 /**
6388 * Gets whether this view should be exposed for accessibility.
6389 *
6390 * @return Whether the view is exposed for accessibility.
6391 *
6392 * @hide
6393 */
6394 public boolean isImportantForAccessibility() {
6395 final int mode = (mPrivateFlags2 & IMPORTANT_FOR_ACCESSIBILITY_MASK)
6396 >> IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
6397 switch (mode) {
6398 case IMPORTANT_FOR_ACCESSIBILITY_YES:
6399 return true;
6400 case IMPORTANT_FOR_ACCESSIBILITY_NO:
6401 return false;
6402 case IMPORTANT_FOR_ACCESSIBILITY_AUTO:
6403 return isActionableForAccessibility() || hasListenersForAccessibility();
6404 default:
6405 throw new IllegalArgumentException("Unknow important for accessibility mode: "
6406 + mode);
6407 }
6408 }
6409
6410 /**
6411 * Gets the parent for accessibility purposes. Note that the parent for
6412 * accessibility is not necessary the immediate parent. It is the first
6413 * predecessor that is important for accessibility.
6414 *
6415 * @return The parent for accessibility purposes.
6416 */
6417 public ViewParent getParentForAccessibility() {
6418 if (mParent instanceof View) {
6419 View parentView = (View) mParent;
6420 if (parentView.includeForAccessibility()) {
6421 return mParent;
6422 } else {
6423 return mParent.getParentForAccessibility();
6424 }
6425 }
6426 return null;
6427 }
6428
6429 /**
6430 * Adds the children of a given View for accessibility. Since some Views are
6431 * not important for accessibility the children for accessibility are not
6432 * necessarily direct children of the riew, rather they are the first level of
6433 * descendants important for accessibility.
6434 *
6435 * @param children The list of children for accessibility.
6436 */
6437 public void addChildrenForAccessibility(ArrayList<View> children) {
6438 if (includeForAccessibility()) {
6439 children.add(this);
6440 }
6441 }
6442
6443 /**
6444 * Whether to regard this view for accessibility. A view is regarded for
6445 * accessibility if it is important for accessibility or the querying
6446 * accessibility service has explicitly requested that view not
6447 * important for accessibility are regarded.
6448 *
6449 * @return Whether to regard the view for accessibility.
6450 */
6451 boolean includeForAccessibility() {
6452 if (mAttachInfo != null) {
6453 if (!mAttachInfo.mIncludeNotImportantViews) {
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07006454 return isImportantForAccessibility();
Svetoslav Ganov42138042012-03-20 11:51:39 -07006455 } else {
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07006456 return true;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006457 }
6458 }
6459 return false;
6460 }
6461
6462 /**
6463 * Returns whether the View is considered actionable from
6464 * accessibility perspective. Such view are important for
6465 * accessiiblity.
6466 *
6467 * @return True if the view is actionable for accessibility.
6468 */
6469 private boolean isActionableForAccessibility() {
6470 return (isClickable() || isLongClickable() || isFocusable());
6471 }
6472
6473 /**
6474 * Returns whether the View has registered callbacks wich makes it
6475 * important for accessiiblity.
6476 *
6477 * @return True if the view is actionable for accessibility.
6478 */
6479 private boolean hasListenersForAccessibility() {
6480 ListenerInfo info = getListenerInfo();
6481 return mTouchDelegate != null || info.mOnKeyListener != null
6482 || info.mOnTouchListener != null || info.mOnGenericMotionListener != null
6483 || info.mOnHoverListener != null || info.mOnDragListener != null;
6484 }
6485
6486 /**
6487 * Notifies accessibility services that some view's important for
6488 * accessibility state has changed. Note that such notifications
6489 * are made at most once every
6490 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}
6491 * to avoid unnecessary load to the system. Also once a view has
6492 * made a notifucation this method is a NOP until the notification has
6493 * been sent to clients.
6494 *
6495 * @hide
6496 *
6497 * TODO: Makse sure this method is called for any view state change
6498 * that is interesting for accessilility purposes.
6499 */
6500 public void notifyAccessibilityStateChanged() {
6501 if ((mPrivateFlags2 & ACCESSIBILITY_STATE_CHANGED) == 0) {
6502 mPrivateFlags2 |= ACCESSIBILITY_STATE_CHANGED;
6503 if (mParent != null) {
6504 mParent.childAccessibilityStateChanged(this);
6505 }
6506 }
6507 }
6508
6509 /**
6510 * Reset the state indicating the this view has requested clients
6511 * interested in its accessiblity state to be notified.
6512 *
6513 * @hide
6514 */
6515 public void resetAccessibilityStateChanged() {
6516 mPrivateFlags2 &= ~ACCESSIBILITY_STATE_CHANGED;
6517 }
6518
6519 /**
6520 * Performs the specified accessibility action on the view. For
6521 * possible accessibility actions look at {@link AccessibilityNodeInfo}.
alanv8eeefef2012-05-07 16:57:53 -07006522 * <p>
6523 * If an {@link AccessibilityDelegate} has been specified via calling
6524 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
6525 * {@link AccessibilityDelegate#performAccessibilityAction(View, int, Bundle)}
6526 * is responsible for handling this call.
6527 * </p>
Svetoslav Ganov42138042012-03-20 11:51:39 -07006528 *
6529 * @param action The action to perform.
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006530 * @param arguments Optional action arguments.
Svetoslav Ganov42138042012-03-20 11:51:39 -07006531 * @return Whether the action was performed.
6532 */
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006533 public boolean performAccessibilityAction(int action, Bundle arguments) {
alanv8eeefef2012-05-07 16:57:53 -07006534 if (mAccessibilityDelegate != null) {
6535 return mAccessibilityDelegate.performAccessibilityAction(this, action, arguments);
6536 } else {
6537 return performAccessibilityActionInternal(action, arguments);
6538 }
6539 }
6540
6541 /**
6542 * @see #performAccessibilityAction(int, Bundle)
6543 *
6544 * Note: Called from the default {@link AccessibilityDelegate}.
6545 */
6546 boolean performAccessibilityActionInternal(int action, Bundle arguments) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006547 switch (action) {
6548 case AccessibilityNodeInfo.ACTION_CLICK: {
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006549 if (isClickable()) {
Svetoslav Ganov773f2622012-05-05 19:59:42 -07006550 return performClick();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006551 }
6552 } break;
6553 case AccessibilityNodeInfo.ACTION_LONG_CLICK: {
6554 if (isLongClickable()) {
Svetoslav Ganov773f2622012-05-05 19:59:42 -07006555 return performLongClick();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006556 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006557 } break;
6558 case AccessibilityNodeInfo.ACTION_FOCUS: {
6559 if (!hasFocus()) {
6560 // Get out of touch mode since accessibility
6561 // wants to move focus around.
6562 getViewRootImpl().ensureTouchMode(false);
6563 return requestFocus();
6564 }
6565 } break;
6566 case AccessibilityNodeInfo.ACTION_CLEAR_FOCUS: {
6567 if (hasFocus()) {
6568 clearFocus();
6569 return !isFocused();
6570 }
6571 } break;
6572 case AccessibilityNodeInfo.ACTION_SELECT: {
6573 if (!isSelected()) {
6574 setSelected(true);
6575 return isSelected();
6576 }
6577 } break;
6578 case AccessibilityNodeInfo.ACTION_CLEAR_SELECTION: {
6579 if (isSelected()) {
6580 setSelected(false);
6581 return !isSelected();
6582 }
6583 } break;
6584 case AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS: {
6585 if (!isAccessibilityFocused()) {
6586 return requestAccessibilityFocus();
6587 }
6588 } break;
6589 case AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS: {
6590 if (isAccessibilityFocused()) {
6591 clearAccessibilityFocus();
6592 return true;
6593 }
6594 } break;
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006595 case AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY: {
6596 if (arguments != null) {
6597 final int granularity = arguments.getInt(
6598 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT);
6599 return nextAtGranularity(granularity);
6600 }
6601 } break;
6602 case AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: {
6603 if (arguments != null) {
6604 final int granularity = arguments.getInt(
6605 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT);
6606 return previousAtGranularity(granularity);
6607 }
6608 } break;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006609 }
6610 return false;
6611 }
6612
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006613 private boolean nextAtGranularity(int granularity) {
6614 CharSequence text = getIterableTextForAccessibility();
6615 if (text != null && text.length() > 0) {
6616 return false;
6617 }
6618 TextSegmentIterator iterator = getIteratorForGranularity(granularity);
6619 if (iterator == null) {
6620 return false;
6621 }
6622 final int current = getAccessibilityCursorPosition();
6623 final int[] range = iterator.following(current);
6624 if (range == null) {
6625 setAccessibilityCursorPosition(-1);
6626 return false;
6627 }
6628 final int start = range[0];
6629 final int end = range[1];
6630 setAccessibilityCursorPosition(start);
6631 sendViewTextTraversedAtGranularityEvent(
6632 AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY,
6633 granularity, start, end);
6634 return true;
6635 }
6636
6637 private boolean previousAtGranularity(int granularity) {
6638 CharSequence text = getIterableTextForAccessibility();
6639 if (text != null && text.length() > 0) {
6640 return false;
6641 }
6642 TextSegmentIterator iterator = getIteratorForGranularity(granularity);
6643 if (iterator == null) {
6644 return false;
6645 }
6646 final int selectionStart = getAccessibilityCursorPosition();
6647 final int current = selectionStart >= 0 ? selectionStart : text.length() + 1;
6648 final int[] range = iterator.preceding(current);
6649 if (range == null) {
6650 setAccessibilityCursorPosition(-1);
6651 return false;
6652 }
6653 final int start = range[0];
6654 final int end = range[1];
6655 setAccessibilityCursorPosition(end);
6656 sendViewTextTraversedAtGranularityEvent(
6657 AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY,
6658 granularity, start, end);
6659 return true;
6660 }
6661
6662 /**
6663 * Gets the text reported for accessibility purposes.
6664 *
6665 * @return The accessibility text.
6666 *
6667 * @hide
6668 */
6669 public CharSequence getIterableTextForAccessibility() {
6670 return mContentDescription;
6671 }
6672
6673 /**
6674 * @hide
6675 */
6676 public int getAccessibilityCursorPosition() {
6677 return mAccessibilityCursorPosition;
6678 }
6679
6680 /**
6681 * @hide
6682 */
6683 public void setAccessibilityCursorPosition(int position) {
6684 mAccessibilityCursorPosition = position;
6685 }
6686
6687 private void sendViewTextTraversedAtGranularityEvent(int action, int granularity,
6688 int fromIndex, int toIndex) {
6689 if (mParent == null) {
6690 return;
6691 }
6692 AccessibilityEvent event = AccessibilityEvent.obtain(
6693 AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY);
6694 onInitializeAccessibilityEvent(event);
6695 onPopulateAccessibilityEvent(event);
6696 event.setFromIndex(fromIndex);
6697 event.setToIndex(toIndex);
6698 event.setAction(action);
6699 event.setMovementGranularity(granularity);
6700 mParent.requestSendAccessibilityEvent(this, event);
6701 }
6702
6703 /**
6704 * @hide
6705 */
6706 public TextSegmentIterator getIteratorForGranularity(int granularity) {
6707 switch (granularity) {
6708 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER: {
6709 CharSequence text = getIterableTextForAccessibility();
6710 if (text != null && text.length() > 0) {
6711 CharacterTextSegmentIterator iterator =
6712 CharacterTextSegmentIterator.getInstance(mContext);
6713 iterator.initialize(text.toString());
6714 return iterator;
6715 }
6716 } break;
6717 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD: {
6718 CharSequence text = getIterableTextForAccessibility();
6719 if (text != null && text.length() > 0) {
6720 WordTextSegmentIterator iterator =
6721 WordTextSegmentIterator.getInstance(mContext);
6722 iterator.initialize(text.toString());
6723 return iterator;
6724 }
6725 } break;
6726 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH: {
6727 CharSequence text = getIterableTextForAccessibility();
6728 if (text != null && text.length() > 0) {
6729 ParagraphTextSegmentIterator iterator =
6730 ParagraphTextSegmentIterator.getInstance();
6731 iterator.initialize(text.toString());
6732 return iterator;
6733 }
6734 } break;
6735 }
6736 return null;
6737 }
6738
Svetoslav Ganov42138042012-03-20 11:51:39 -07006739 /**
Romain Guya440b002010-02-24 15:57:54 -08006740 * @hide
6741 */
6742 public void dispatchStartTemporaryDetach() {
Svetoslav Ganov961bf0e2012-05-08 09:40:03 -07006743 clearAccessibilityFocus();
Romain Guya440b002010-02-24 15:57:54 -08006744 onStartTemporaryDetach();
6745 }
6746
6747 /**
6748 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006749 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
6750 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08006751 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006752 */
6753 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08006754 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08006755 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08006756 }
6757
6758 /**
6759 * @hide
6760 */
6761 public void dispatchFinishTemporaryDetach() {
6762 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006763 }
Romain Guy8506ab42009-06-11 17:35:47 -07006764
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006765 /**
6766 * Called after {@link #onStartTemporaryDetach} when the container is done
6767 * changing the view.
6768 */
6769 public void onFinishTemporaryDetach() {
6770 }
Romain Guy8506ab42009-06-11 17:35:47 -07006771
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006772 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006773 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
6774 * for this view's window. Returns null if the view is not currently attached
6775 * to the window. Normally you will not need to use this directly, but
Romain Guy5c22a8c2011-05-13 11:48:45 -07006776 * just use the standard high-level event callbacks like
6777 * {@link #onKeyDown(int, KeyEvent)}.
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006778 */
6779 public KeyEvent.DispatcherState getKeyDispatcherState() {
6780 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
6781 }
Joe Malin32736f02011-01-19 16:14:20 -08006782
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006783 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006784 * Dispatch a key event before it is processed by any input method
6785 * associated with the view hierarchy. This can be used to intercept
6786 * key events in special situations before the IME consumes them; a
6787 * typical example would be handling the BACK key to update the application's
6788 * UI instead of allowing the IME to see it and close itself.
6789 *
6790 * @param event The key event to be dispatched.
6791 * @return True if the event was handled, false otherwise.
6792 */
6793 public boolean dispatchKeyEventPreIme(KeyEvent event) {
6794 return onKeyPreIme(event.getKeyCode(), event);
6795 }
6796
6797 /**
6798 * Dispatch a key event to the next view on the focus path. This path runs
6799 * from the top of the view tree down to the currently focused view. If this
6800 * view has focus, it will dispatch to itself. Otherwise it will dispatch
6801 * the next node down the focus path. This method also fires any key
6802 * listeners.
6803 *
6804 * @param event The key event to be dispatched.
6805 * @return True if the event was handled, false otherwise.
6806 */
6807 public boolean dispatchKeyEvent(KeyEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006808 if (mInputEventConsistencyVerifier != null) {
6809 mInputEventConsistencyVerifier.onKeyEvent(event, 0);
6810 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006811
Jeff Brown21bc5c92011-02-28 18:27:14 -08006812 // Give any attached key listener a first crack at the event.
Romain Guyf607bdc2010-09-10 19:20:06 -07006813 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006814 ListenerInfo li = mListenerInfo;
6815 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
6816 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006817 return true;
6818 }
6819
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006820 if (event.dispatch(this, mAttachInfo != null
6821 ? mAttachInfo.mKeyDispatchState : null, this)) {
6822 return true;
6823 }
6824
6825 if (mInputEventConsistencyVerifier != null) {
6826 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
6827 }
6828 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006829 }
6830
6831 /**
6832 * Dispatches a key shortcut event.
6833 *
6834 * @param event The key event to be dispatched.
6835 * @return True if the event was handled by the view, false otherwise.
6836 */
6837 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
6838 return onKeyShortcut(event.getKeyCode(), event);
6839 }
6840
6841 /**
6842 * Pass the touch screen motion event down to the target view, or this
6843 * view if it is the target.
6844 *
6845 * @param event The motion event to be dispatched.
6846 * @return True if the event was handled by the view, false otherwise.
6847 */
6848 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006849 if (mInputEventConsistencyVerifier != null) {
6850 mInputEventConsistencyVerifier.onTouchEvent(event, 0);
6851 }
6852
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006853 if (onFilterTouchEventForSecurity(event)) {
6854 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006855 ListenerInfo li = mListenerInfo;
6856 if (li != null && li.mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
6857 && li.mOnTouchListener.onTouch(this, event)) {
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006858 return true;
6859 }
6860
6861 if (onTouchEvent(event)) {
6862 return true;
6863 }
Jeff Brown85a31762010-09-01 17:01:00 -07006864 }
6865
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006866 if (mInputEventConsistencyVerifier != null) {
6867 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006868 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006869 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006870 }
6871
6872 /**
Jeff Brown85a31762010-09-01 17:01:00 -07006873 * Filter the touch event to apply security policies.
6874 *
6875 * @param event The motion event to be filtered.
6876 * @return True if the event should be dispatched, false if the event should be dropped.
Joe Malin32736f02011-01-19 16:14:20 -08006877 *
Jeff Brown85a31762010-09-01 17:01:00 -07006878 * @see #getFilterTouchesWhenObscured
6879 */
6880 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07006881 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07006882 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
6883 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
6884 // Window is obscured, drop this touch.
6885 return false;
6886 }
6887 return true;
6888 }
6889
6890 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006891 * Pass a trackball motion event down to the focused view.
6892 *
6893 * @param event The motion event to be dispatched.
6894 * @return True if the event was handled by the view, false otherwise.
6895 */
6896 public boolean dispatchTrackballEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006897 if (mInputEventConsistencyVerifier != null) {
6898 mInputEventConsistencyVerifier.onTrackballEvent(event, 0);
6899 }
6900
Romain Guy02ccac62011-06-24 13:20:23 -07006901 return onTrackballEvent(event);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006902 }
6903
6904 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08006905 * Dispatch a generic motion event.
6906 * <p>
6907 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
6908 * are delivered to the view under the pointer. All other generic motion events are
Jeff Browna032cc02011-03-07 16:56:21 -08006909 * delivered to the focused view. Hover events are handled specially and are delivered
Romain Guy5c22a8c2011-05-13 11:48:45 -07006910 * to {@link #onHoverEvent(MotionEvent)}.
Jeff Brown33bbfd22011-02-24 20:55:35 -08006911 * </p>
Jeff Browncb1404e2011-01-15 18:14:15 -08006912 *
6913 * @param event The motion event to be dispatched.
6914 * @return True if the event was handled by the view, false otherwise.
6915 */
6916 public boolean dispatchGenericMotionEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006917 if (mInputEventConsistencyVerifier != null) {
6918 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0);
6919 }
6920
Jeff Browna032cc02011-03-07 16:56:21 -08006921 final int source = event.getSource();
6922 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) {
6923 final int action = event.getAction();
6924 if (action == MotionEvent.ACTION_HOVER_ENTER
6925 || action == MotionEvent.ACTION_HOVER_MOVE
6926 || action == MotionEvent.ACTION_HOVER_EXIT) {
6927 if (dispatchHoverEvent(event)) {
6928 return true;
6929 }
6930 } else if (dispatchGenericPointerEvent(event)) {
6931 return true;
6932 }
6933 } else if (dispatchGenericFocusedEvent(event)) {
6934 return true;
6935 }
6936
Jeff Brown10b62902011-06-20 16:40:37 -07006937 if (dispatchGenericMotionEventInternal(event)) {
6938 return true;
6939 }
6940
6941 if (mInputEventConsistencyVerifier != null) {
6942 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
6943 }
6944 return false;
6945 }
6946
6947 private boolean dispatchGenericMotionEventInternal(MotionEvent event) {
Romain Guy7b5b6ab2011-03-14 18:05:08 -07006948 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006949 ListenerInfo li = mListenerInfo;
6950 if (li != null && li.mOnGenericMotionListener != null
6951 && (mViewFlags & ENABLED_MASK) == ENABLED
6952 && li.mOnGenericMotionListener.onGenericMotion(this, event)) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08006953 return true;
6954 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006955
6956 if (onGenericMotionEvent(event)) {
6957 return true;
6958 }
6959
6960 if (mInputEventConsistencyVerifier != null) {
6961 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
6962 }
6963 return false;
Jeff Browncb1404e2011-01-15 18:14:15 -08006964 }
6965
6966 /**
Jeff Browna032cc02011-03-07 16:56:21 -08006967 * Dispatch a hover event.
6968 * <p>
Philip Milne6c8ea062012-04-03 17:38:43 -07006969 * Do not call this method directly.
Romain Guy5c22a8c2011-05-13 11:48:45 -07006970 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08006971 * </p>
6972 *
6973 * @param event The motion event to be dispatched.
6974 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08006975 */
6976 protected boolean dispatchHoverEvent(MotionEvent event) {
Romain Guy02ccac62011-06-24 13:20:23 -07006977 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006978 ListenerInfo li = mListenerInfo;
6979 if (li != null && li.mOnHoverListener != null
6980 && (mViewFlags & ENABLED_MASK) == ENABLED
6981 && li.mOnHoverListener.onHover(this, event)) {
Jeff Brown10b62902011-06-20 16:40:37 -07006982 return true;
6983 }
6984
Jeff Browna032cc02011-03-07 16:56:21 -08006985 return onHoverEvent(event);
6986 }
6987
6988 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07006989 * Returns true if the view has a child to which it has recently sent
6990 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and
6991 * it does not have a hovered child, then it must be the innermost hovered view.
6992 * @hide
6993 */
6994 protected boolean hasHoveredChild() {
6995 return false;
6996 }
6997
6998 /**
Jeff Browna032cc02011-03-07 16:56:21 -08006999 * Dispatch a generic motion event to the view under the first pointer.
7000 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007001 * Do not call this method directly.
7002 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08007003 * </p>
7004 *
7005 * @param event The motion event to be dispatched.
7006 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08007007 */
7008 protected boolean dispatchGenericPointerEvent(MotionEvent event) {
7009 return false;
7010 }
7011
7012 /**
7013 * Dispatch a generic motion event to the currently focused view.
7014 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007015 * Do not call this method directly.
7016 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08007017 * </p>
7018 *
7019 * @param event The motion event to be dispatched.
7020 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08007021 */
7022 protected boolean dispatchGenericFocusedEvent(MotionEvent event) {
7023 return false;
7024 }
7025
7026 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08007027 * Dispatch a pointer event.
7028 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007029 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all
7030 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns
7031 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches
Jeff Brown33bbfd22011-02-24 20:55:35 -08007032 * and should not be expected to handle other pointing device features.
7033 * </p>
7034 *
7035 * @param event The motion event to be dispatched.
7036 * @return True if the event was handled by the view, false otherwise.
7037 * @hide
7038 */
7039 public final boolean dispatchPointerEvent(MotionEvent event) {
7040 if (event.isTouchEvent()) {
7041 return dispatchTouchEvent(event);
7042 } else {
7043 return dispatchGenericMotionEvent(event);
7044 }
7045 }
7046
7047 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007048 * Called when the window containing this view gains or loses window focus.
7049 * ViewGroups should override to route to their children.
7050 *
7051 * @param hasFocus True if the window containing this view now has focus,
7052 * false otherwise.
7053 */
7054 public void dispatchWindowFocusChanged(boolean hasFocus) {
7055 onWindowFocusChanged(hasFocus);
7056 }
7057
7058 /**
7059 * Called when the window containing this view gains or loses focus. Note
7060 * that this is separate from view focus: to receive key events, both
7061 * your view and its window must have focus. If a window is displayed
7062 * on top of yours that takes input focus, then your own window will lose
7063 * focus but the view focus will remain unchanged.
7064 *
7065 * @param hasWindowFocus True if the window containing this view now has
7066 * focus, false otherwise.
7067 */
7068 public void onWindowFocusChanged(boolean hasWindowFocus) {
7069 InputMethodManager imm = InputMethodManager.peekInstance();
7070 if (!hasWindowFocus) {
7071 if (isPressed()) {
7072 setPressed(false);
7073 }
7074 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
7075 imm.focusOut(this);
7076 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05007077 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08007078 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07007079 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007080 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
7081 imm.focusIn(this);
7082 }
7083 refreshDrawableState();
7084 }
7085
7086 /**
7087 * Returns true if this view is in a window that currently has window focus.
7088 * Note that this is not the same as the view itself having focus.
7089 *
7090 * @return True if this view is in a window that currently has window focus.
7091 */
7092 public boolean hasWindowFocus() {
7093 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
7094 }
7095
7096 /**
Adam Powell326d8082009-12-09 15:10:07 -08007097 * Dispatch a view visibility change down the view hierarchy.
7098 * ViewGroups should override to route to their children.
7099 * @param changedView The view whose visibility changed. Could be 'this' or
7100 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08007101 * @param visibility The new visibility of changedView: {@link #VISIBLE},
7102 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08007103 */
7104 protected void dispatchVisibilityChanged(View changedView, int visibility) {
7105 onVisibilityChanged(changedView, visibility);
7106 }
7107
7108 /**
7109 * Called when the visibility of the view or an ancestor of the view is changed.
7110 * @param changedView The view whose visibility changed. Could be 'this' or
7111 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08007112 * @param visibility The new visibility of changedView: {@link #VISIBLE},
7113 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08007114 */
7115 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07007116 if (visibility == VISIBLE) {
7117 if (mAttachInfo != null) {
7118 initialAwakenScrollBars();
7119 } else {
7120 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
7121 }
7122 }
Adam Powell326d8082009-12-09 15:10:07 -08007123 }
7124
7125 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08007126 * Dispatch a hint about whether this view is displayed. For instance, when
7127 * a View moves out of the screen, it might receives a display hint indicating
7128 * the view is not displayed. Applications should not <em>rely</em> on this hint
7129 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08007130 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08007131 * @param hint A hint about whether or not this view is displayed:
7132 * {@link #VISIBLE} or {@link #INVISIBLE}.
7133 */
7134 public void dispatchDisplayHint(int hint) {
7135 onDisplayHint(hint);
7136 }
7137
7138 /**
7139 * Gives this view a hint about whether is displayed or not. For instance, when
7140 * a View moves out of the screen, it might receives a display hint indicating
7141 * the view is not displayed. Applications should not <em>rely</em> on this hint
7142 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08007143 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08007144 * @param hint A hint about whether or not this view is displayed:
7145 * {@link #VISIBLE} or {@link #INVISIBLE}.
7146 */
7147 protected void onDisplayHint(int hint) {
7148 }
7149
7150 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007151 * Dispatch a window visibility change down the view hierarchy.
7152 * ViewGroups should override to route to their children.
7153 *
7154 * @param visibility The new visibility of the window.
7155 *
Philip Milne6c8ea062012-04-03 17:38:43 -07007156 * @see #onWindowVisibilityChanged(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007157 */
7158 public void dispatchWindowVisibilityChanged(int visibility) {
7159 onWindowVisibilityChanged(visibility);
7160 }
7161
7162 /**
7163 * Called when the window containing has change its visibility
7164 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
7165 * that this tells you whether or not your window is being made visible
7166 * to the window manager; this does <em>not</em> tell you whether or not
7167 * your window is obscured by other windows on the screen, even if it
7168 * is itself visible.
7169 *
7170 * @param visibility The new visibility of the window.
7171 */
7172 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07007173 if (visibility == VISIBLE) {
7174 initialAwakenScrollBars();
7175 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007176 }
7177
7178 /**
7179 * Returns the current visibility of the window this view is attached to
7180 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
7181 *
7182 * @return Returns the current visibility of the view's window.
7183 */
7184 public int getWindowVisibility() {
7185 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
7186 }
7187
7188 /**
7189 * Retrieve the overall visible display size in which the window this view is
7190 * attached to has been positioned in. This takes into account screen
7191 * decorations above the window, for both cases where the window itself
7192 * is being position inside of them or the window is being placed under
7193 * then and covered insets are used for the window to position its content
7194 * inside. In effect, this tells you the available area where content can
7195 * be placed and remain visible to users.
7196 *
7197 * <p>This function requires an IPC back to the window manager to retrieve
7198 * the requested information, so should not be used in performance critical
7199 * code like drawing.
7200 *
7201 * @param outRect Filled in with the visible display frame. If the view
7202 * is not attached to a window, this is simply the raw display size.
7203 */
7204 public void getWindowVisibleDisplayFrame(Rect outRect) {
7205 if (mAttachInfo != null) {
7206 try {
7207 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
7208 } catch (RemoteException e) {
7209 return;
7210 }
7211 // XXX This is really broken, and probably all needs to be done
7212 // in the window manager, and we need to know more about whether
7213 // we want the area behind or in front of the IME.
7214 final Rect insets = mAttachInfo.mVisibleInsets;
7215 outRect.left += insets.left;
7216 outRect.top += insets.top;
7217 outRect.right -= insets.right;
7218 outRect.bottom -= insets.bottom;
7219 return;
7220 }
7221 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
Dianne Hackborn44bc17c2011-04-20 18:18:51 -07007222 d.getRectSize(outRect);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007223 }
7224
7225 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08007226 * Dispatch a notification about a resource configuration change down
7227 * the view hierarchy.
7228 * ViewGroups should override to route to their children.
7229 *
7230 * @param newConfig The new resource configuration.
7231 *
Philip Milne6c8ea062012-04-03 17:38:43 -07007232 * @see #onConfigurationChanged(android.content.res.Configuration)
Dianne Hackborne36d6e22010-02-17 19:46:25 -08007233 */
7234 public void dispatchConfigurationChanged(Configuration newConfig) {
7235 onConfigurationChanged(newConfig);
7236 }
7237
7238 /**
7239 * Called when the current configuration of the resources being used
7240 * by the application have changed. You can use this to decide when
7241 * to reload resources that can changed based on orientation and other
7242 * configuration characterstics. You only need to use this if you are
7243 * not relying on the normal {@link android.app.Activity} mechanism of
7244 * recreating the activity instance upon a configuration change.
7245 *
7246 * @param newConfig The new resource configuration.
7247 */
7248 protected void onConfigurationChanged(Configuration newConfig) {
7249 }
7250
7251 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007252 * Private function to aggregate all per-view attributes in to the view
7253 * root.
7254 */
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007255 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) {
7256 performCollectViewAttributes(attachInfo, visibility);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007257 }
7258
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007259 void performCollectViewAttributes(AttachInfo attachInfo, int visibility) {
7260 if ((visibility & VISIBILITY_MASK) == VISIBLE) {
Joe Onorato664644d2011-01-23 17:53:23 -08007261 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007262 attachInfo.mKeepScreenOn = true;
Joe Onorato664644d2011-01-23 17:53:23 -08007263 }
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007264 attachInfo.mSystemUiVisibility |= mSystemUiVisibility;
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007265 ListenerInfo li = mListenerInfo;
7266 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007267 attachInfo.mHasSystemUiListeners = true;
Joe Onorato664644d2011-01-23 17:53:23 -08007268 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007269 }
7270 }
7271
7272 void needGlobalAttributesUpdate(boolean force) {
Joe Onorato664644d2011-01-23 17:53:23 -08007273 final AttachInfo ai = mAttachInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007274 if (ai != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08007275 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0)
7276 || ai.mHasSystemUiListeners) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007277 ai.mRecomputeGlobalAttributes = true;
7278 }
7279 }
7280 }
7281
7282 /**
7283 * Returns whether the device is currently in touch mode. Touch mode is entered
7284 * once the user begins interacting with the device by touch, and affects various
7285 * things like whether focus is always visible to the user.
7286 *
7287 * @return Whether the device is in touch mode.
7288 */
7289 @ViewDebug.ExportedProperty
7290 public boolean isInTouchMode() {
7291 if (mAttachInfo != null) {
7292 return mAttachInfo.mInTouchMode;
7293 } else {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07007294 return ViewRootImpl.isInTouchMode();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007295 }
7296 }
7297
7298 /**
7299 * Returns the context the view is running in, through which it can
7300 * access the current theme, resources, etc.
7301 *
7302 * @return The view's Context.
7303 */
7304 @ViewDebug.CapturedViewProperty
7305 public final Context getContext() {
7306 return mContext;
7307 }
7308
7309 /**
7310 * Handle a key event before it is processed by any input method
7311 * associated with the view hierarchy. This can be used to intercept
7312 * key events in special situations before the IME consumes them; a
7313 * typical example would be handling the BACK key to update the application's
7314 * UI instead of allowing the IME to see it and close itself.
7315 *
7316 * @param keyCode The value in event.getKeyCode().
7317 * @param event Description of the key event.
7318 * @return If you handled the event, return true. If you want to allow the
7319 * event to be handled by the next receiver, return false.
7320 */
7321 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
7322 return false;
7323 }
7324
7325 /**
Jeff Brown995e7742010-12-22 16:59:36 -08007326 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
7327 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007328 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
7329 * is released, if the view is enabled and clickable.
7330 *
7331 * @param keyCode A key code that represents the button pressed, from
7332 * {@link android.view.KeyEvent}.
7333 * @param event The KeyEvent object that defines the button action.
7334 */
7335 public boolean onKeyDown(int keyCode, KeyEvent event) {
7336 boolean result = false;
7337
7338 switch (keyCode) {
7339 case KeyEvent.KEYCODE_DPAD_CENTER:
7340 case KeyEvent.KEYCODE_ENTER: {
7341 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
7342 return true;
7343 }
7344 // Long clickable items don't necessarily have to be clickable
7345 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
7346 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
7347 (event.getRepeatCount() == 0)) {
7348 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007349 checkForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007350 return true;
7351 }
7352 break;
7353 }
7354 }
7355 return result;
7356 }
7357
7358 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07007359 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
7360 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
7361 * the event).
7362 */
7363 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
7364 return false;
7365 }
7366
7367 /**
Jeff Brown995e7742010-12-22 16:59:36 -08007368 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
7369 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007370 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
7371 * {@link KeyEvent#KEYCODE_ENTER} is released.
7372 *
7373 * @param keyCode A key code that represents the button pressed, from
7374 * {@link android.view.KeyEvent}.
7375 * @param event The KeyEvent object that defines the button action.
7376 */
7377 public boolean onKeyUp(int keyCode, KeyEvent event) {
7378 boolean result = false;
7379
7380 switch (keyCode) {
7381 case KeyEvent.KEYCODE_DPAD_CENTER:
7382 case KeyEvent.KEYCODE_ENTER: {
7383 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
7384 return true;
7385 }
7386 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
7387 setPressed(false);
7388
7389 if (!mHasPerformedLongPress) {
7390 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05007391 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007392
7393 result = performClick();
7394 }
7395 }
7396 break;
7397 }
7398 }
7399 return result;
7400 }
7401
7402 /**
7403 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
7404 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
7405 * the event).
7406 *
7407 * @param keyCode A key code that represents the button pressed, from
7408 * {@link android.view.KeyEvent}.
7409 * @param repeatCount The number of times the action was made.
7410 * @param event The KeyEvent object that defines the button action.
7411 */
7412 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
7413 return false;
7414 }
7415
7416 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08007417 * Called on the focused view when a key shortcut event is not handled.
7418 * Override this method to implement local key shortcuts for the View.
7419 * Key shortcuts can also be implemented by setting the
7420 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007421 *
7422 * @param keyCode The value in event.getKeyCode().
7423 * @param event Description of the key event.
7424 * @return If you handled the event, return true. If you want to allow the
7425 * event to be handled by the next receiver, return false.
7426 */
7427 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
7428 return false;
7429 }
7430
7431 /**
7432 * Check whether the called view is a text editor, in which case it
7433 * would make sense to automatically display a soft input window for
7434 * it. Subclasses should override this if they implement
7435 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007436 * a call on that method would return a non-null InputConnection, and
7437 * they are really a first-class editor that the user would normally
7438 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07007439 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007440 * <p>The default implementation always returns false. This does
7441 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
7442 * will not be called or the user can not otherwise perform edits on your
7443 * view; it is just a hint to the system that this is not the primary
7444 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07007445 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007446 * @return Returns true if this view is a text editor, else false.
7447 */
7448 public boolean onCheckIsTextEditor() {
7449 return false;
7450 }
Romain Guy8506ab42009-06-11 17:35:47 -07007451
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007452 /**
7453 * Create a new InputConnection for an InputMethod to interact
7454 * with the view. The default implementation returns null, since it doesn't
7455 * support input methods. You can override this to implement such support.
7456 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07007457 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007458 * <p>When implementing this, you probably also want to implement
7459 * {@link #onCheckIsTextEditor()} to indicate you will return a
7460 * non-null InputConnection.
7461 *
7462 * @param outAttrs Fill in with attribute information about the connection.
7463 */
7464 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
7465 return null;
7466 }
7467
7468 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007469 * Called by the {@link android.view.inputmethod.InputMethodManager}
7470 * when a view who is not the current
7471 * input connection target is trying to make a call on the manager. The
7472 * default implementation returns false; you can override this to return
7473 * true for certain views if you are performing InputConnection proxying
7474 * to them.
7475 * @param view The View that is making the InputMethodManager call.
7476 * @return Return true to allow the call, false to reject.
7477 */
7478 public boolean checkInputConnectionProxy(View view) {
7479 return false;
7480 }
Romain Guy8506ab42009-06-11 17:35:47 -07007481
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007482 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007483 * Show the context menu for this view. It is not safe to hold on to the
7484 * menu after returning from this method.
7485 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07007486 * You should normally not overload this method. Overload
7487 * {@link #onCreateContextMenu(ContextMenu)} or define an
7488 * {@link OnCreateContextMenuListener} to add items to the context menu.
7489 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007490 * @param menu The context menu to populate
7491 */
7492 public void createContextMenu(ContextMenu menu) {
7493 ContextMenuInfo menuInfo = getContextMenuInfo();
7494
7495 // Sets the current menu info so all items added to menu will have
7496 // my extra info set.
7497 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
7498
7499 onCreateContextMenu(menu);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007500 ListenerInfo li = mListenerInfo;
7501 if (li != null && li.mOnCreateContextMenuListener != null) {
7502 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007503 }
7504
7505 // Clear the extra information so subsequent items that aren't mine don't
7506 // have my extra info.
7507 ((MenuBuilder)menu).setCurrentMenuInfo(null);
7508
7509 if (mParent != null) {
7510 mParent.createContextMenu(menu);
7511 }
7512 }
7513
7514 /**
7515 * Views should implement this if they have extra information to associate
7516 * with the context menu. The return result is supplied as a parameter to
7517 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
7518 * callback.
7519 *
7520 * @return Extra information about the item for which the context menu
7521 * should be shown. This information will vary across different
7522 * subclasses of View.
7523 */
7524 protected ContextMenuInfo getContextMenuInfo() {
7525 return null;
7526 }
7527
7528 /**
7529 * Views should implement this if the view itself is going to add items to
7530 * the context menu.
7531 *
7532 * @param menu the context menu to populate
7533 */
7534 protected void onCreateContextMenu(ContextMenu menu) {
7535 }
7536
7537 /**
7538 * Implement this method to handle trackball motion events. The
7539 * <em>relative</em> movement of the trackball since the last event
7540 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
7541 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
7542 * that a movement of 1 corresponds to the user pressing one DPAD key (so
7543 * they will often be fractional values, representing the more fine-grained
7544 * movement information available from a trackball).
7545 *
7546 * @param event The motion event.
7547 * @return True if the event was handled, false otherwise.
7548 */
7549 public boolean onTrackballEvent(MotionEvent event) {
7550 return false;
7551 }
7552
7553 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08007554 * Implement this method to handle generic motion events.
7555 * <p>
Jeff Brown33bbfd22011-02-24 20:55:35 -08007556 * Generic motion events describe joystick movements, mouse hovers, track pad
7557 * touches, scroll wheel movements and other input events. The
Jeff Browncb1404e2011-01-15 18:14:15 -08007558 * {@link MotionEvent#getSource() source} of the motion event specifies
7559 * the class of input that was received. Implementations of this method
7560 * must examine the bits in the source before processing the event.
7561 * The following code example shows how this is done.
Jeff Brown33bbfd22011-02-24 20:55:35 -08007562 * </p><p>
7563 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
7564 * are delivered to the view under the pointer. All other generic motion events are
7565 * delivered to the focused view.
Jeff Browncb1404e2011-01-15 18:14:15 -08007566 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07007567 * <pre> public boolean onGenericMotionEvent(MotionEvent event) {
Jeff Browncb1404e2011-01-15 18:14:15 -08007568 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_JOYSTICK) != 0) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08007569 * if (event.getAction() == MotionEvent.ACTION_MOVE) {
7570 * // process the joystick movement...
7571 * return true;
7572 * }
7573 * }
7574 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_POINTER) != 0) {
7575 * switch (event.getAction()) {
7576 * case MotionEvent.ACTION_HOVER_MOVE:
7577 * // process the mouse hover movement...
7578 * return true;
7579 * case MotionEvent.ACTION_SCROLL:
7580 * // process the scroll wheel movement...
7581 * return true;
7582 * }
Jeff Browncb1404e2011-01-15 18:14:15 -08007583 * }
7584 * return super.onGenericMotionEvent(event);
Scott Mainb303d832011-10-12 16:45:18 -07007585 * }</pre>
Jeff Browncb1404e2011-01-15 18:14:15 -08007586 *
7587 * @param event The generic motion event being processed.
Jeff Browna032cc02011-03-07 16:56:21 -08007588 * @return True if the event was handled, false otherwise.
Jeff Browncb1404e2011-01-15 18:14:15 -08007589 */
7590 public boolean onGenericMotionEvent(MotionEvent event) {
7591 return false;
7592 }
7593
7594 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007595 * Implement this method to handle hover events.
7596 * <p>
Jeff Brown10b62902011-06-20 16:40:37 -07007597 * This method is called whenever a pointer is hovering into, over, or out of the
7598 * bounds of a view and the view is not currently being touched.
7599 * Hover events are represented as pointer events with action
7600 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE},
7601 * or {@link MotionEvent#ACTION_HOVER_EXIT}.
7602 * </p>
7603 * <ul>
7604 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER}
7605 * when the pointer enters the bounds of the view.</li>
7606 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE}
7607 * when the pointer has already entered the bounds of the view and has moved.</li>
7608 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT}
7609 * when the pointer has exited the bounds of the view or when the pointer is
7610 * about to go down due to a button click, tap, or similar user action that
7611 * causes the view to be touched.</li>
7612 * </ul>
7613 * <p>
7614 * The view should implement this method to return true to indicate that it is
7615 * handling the hover event, such as by changing its drawable state.
Jeff Browna032cc02011-03-07 16:56:21 -08007616 * </p><p>
Jeff Brown10b62902011-06-20 16:40:37 -07007617 * The default implementation calls {@link #setHovered} to update the hovered state
7618 * of the view when a hover enter or hover exit event is received, if the view
Jeff Browna1b24182011-07-28 13:38:24 -07007619 * is enabled and is clickable. The default implementation also sends hover
7620 * accessibility events.
Jeff Browna032cc02011-03-07 16:56:21 -08007621 * </p>
7622 *
7623 * @param event The motion event that describes the hover.
Jeff Brown10b62902011-06-20 16:40:37 -07007624 * @return True if the view handled the hover event.
7625 *
7626 * @see #isHovered
7627 * @see #setHovered
7628 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007629 */
7630 public boolean onHoverEvent(MotionEvent event) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007631 // The root view may receive hover (or touch) events that are outside the bounds of
7632 // the window. This code ensures that we only send accessibility events for
7633 // hovers that are actually within the bounds of the root view.
Svetoslav Ganov42138042012-03-20 11:51:39 -07007634 final int action = event.getActionMasked();
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007635 if (!mSendingHoverAccessibilityEvents) {
7636 if ((action == MotionEvent.ACTION_HOVER_ENTER
7637 || action == MotionEvent.ACTION_HOVER_MOVE)
7638 && !hasHoveredChild()
7639 && pointInView(event.getX(), event.getY())) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007640 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER);
Svetoslav Ganov42138042012-03-20 11:51:39 -07007641 mSendingHoverAccessibilityEvents = true;
7642 requestAccessibilityFocusFromHover((int) event.getX(), (int) event.getY());
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007643 }
7644 } else {
7645 if (action == MotionEvent.ACTION_HOVER_EXIT
Svetoslav Ganov42138042012-03-20 11:51:39 -07007646 || (action == MotionEvent.ACTION_MOVE
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007647 && !pointInView(event.getX(), event.getY()))) {
7648 mSendingHoverAccessibilityEvents = false;
7649 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT);
Svetoslav Ganov42138042012-03-20 11:51:39 -07007650 // If the window does not have input focus we take away accessibility
7651 // focus as soon as the user stop hovering over the view.
Jeff Brown59a422e2012-04-19 15:19:19 -07007652 if (mAttachInfo != null && !mAttachInfo.mHasWindowFocus) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07007653 getViewRootImpl().setAccessibilityFocusedHost(null);
7654 }
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007655 }
Jeff Browna1b24182011-07-28 13:38:24 -07007656 }
7657
Jeff Brown87b7f802011-06-21 18:35:45 -07007658 if (isHoverable()) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007659 switch (action) {
Jeff Brown10b62902011-06-20 16:40:37 -07007660 case MotionEvent.ACTION_HOVER_ENTER:
7661 setHovered(true);
7662 break;
7663 case MotionEvent.ACTION_HOVER_EXIT:
7664 setHovered(false);
7665 break;
7666 }
Jeff Browna1b24182011-07-28 13:38:24 -07007667
7668 // Dispatch the event to onGenericMotionEvent before returning true.
7669 // This is to provide compatibility with existing applications that
7670 // handled HOVER_MOVE events in onGenericMotionEvent and that would
7671 // break because of the new default handling for hoverable views
7672 // in onHoverEvent.
7673 // Note that onGenericMotionEvent will be called by default when
7674 // onHoverEvent returns false (refer to dispatchGenericMotionEvent).
7675 dispatchGenericMotionEventInternal(event);
Jeff Brown10b62902011-06-20 16:40:37 -07007676 return true;
Jeff Browna032cc02011-03-07 16:56:21 -08007677 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07007678
Svetoslav Ganov736c2752011-04-22 18:30:36 -07007679 return false;
Jeff Browna032cc02011-03-07 16:56:21 -08007680 }
7681
7682 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07007683 * Returns true if the view should handle {@link #onHoverEvent}
7684 * by calling {@link #setHovered} to change its hovered state.
7685 *
7686 * @return True if the view is hoverable.
7687 */
7688 private boolean isHoverable() {
7689 final int viewFlags = mViewFlags;
7690 if ((viewFlags & ENABLED_MASK) == DISABLED) {
7691 return false;
7692 }
7693
7694 return (viewFlags & CLICKABLE) == CLICKABLE
7695 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
7696 }
7697
7698 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007699 * Returns true if the view is currently hovered.
7700 *
7701 * @return True if the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007702 *
7703 * @see #setHovered
7704 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007705 */
Jeff Brown10b62902011-06-20 16:40:37 -07007706 @ViewDebug.ExportedProperty
Jeff Browna032cc02011-03-07 16:56:21 -08007707 public boolean isHovered() {
7708 return (mPrivateFlags & HOVERED) != 0;
7709 }
7710
7711 /**
7712 * Sets whether the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007713 * <p>
7714 * Calling this method also changes the drawable state of the view. This
7715 * enables the view to react to hover by using different drawable resources
7716 * to change its appearance.
7717 * </p><p>
7718 * The {@link #onHoverChanged} method is called when the hovered state changes.
7719 * </p>
Jeff Browna032cc02011-03-07 16:56:21 -08007720 *
7721 * @param hovered True if the view is hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007722 *
7723 * @see #isHovered
7724 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007725 */
7726 public void setHovered(boolean hovered) {
7727 if (hovered) {
7728 if ((mPrivateFlags & HOVERED) == 0) {
7729 mPrivateFlags |= HOVERED;
7730 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07007731 onHoverChanged(true);
Jeff Browna032cc02011-03-07 16:56:21 -08007732 }
7733 } else {
7734 if ((mPrivateFlags & HOVERED) != 0) {
7735 mPrivateFlags &= ~HOVERED;
7736 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07007737 onHoverChanged(false);
Jeff Browna032cc02011-03-07 16:56:21 -08007738 }
7739 }
7740 }
7741
7742 /**
Jeff Brown10b62902011-06-20 16:40:37 -07007743 * Implement this method to handle hover state changes.
7744 * <p>
7745 * This method is called whenever the hover state changes as a result of a
7746 * call to {@link #setHovered}.
7747 * </p>
7748 *
7749 * @param hovered The current hover state, as returned by {@link #isHovered}.
7750 *
7751 * @see #isHovered
7752 * @see #setHovered
7753 */
7754 public void onHoverChanged(boolean hovered) {
Jeff Brown10b62902011-06-20 16:40:37 -07007755 }
7756
7757 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007758 * Implement this method to handle touch screen motion events.
7759 *
7760 * @param event The motion event.
7761 * @return True if the event was handled, false otherwise.
7762 */
7763 public boolean onTouchEvent(MotionEvent event) {
7764 final int viewFlags = mViewFlags;
7765
7766 if ((viewFlags & ENABLED_MASK) == DISABLED) {
Svetoslav Ganov77b80c02011-03-15 20:52:58 -07007767 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PRESSED) != 0) {
Adam Powell4d6f0662012-02-21 15:11:11 -08007768 setPressed(false);
Svetoslav Ganov77b80c02011-03-15 20:52:58 -07007769 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007770 // A disabled view that is clickable still consumes the touch
7771 // events, it just doesn't respond to them.
7772 return (((viewFlags & CLICKABLE) == CLICKABLE ||
7773 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
7774 }
7775
7776 if (mTouchDelegate != null) {
7777 if (mTouchDelegate.onTouchEvent(event)) {
7778 return true;
7779 }
7780 }
7781
7782 if (((viewFlags & CLICKABLE) == CLICKABLE ||
7783 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
7784 switch (event.getAction()) {
7785 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08007786 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
7787 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007788 // take focus if we don't have it already and we should in
7789 // touch mode.
7790 boolean focusTaken = false;
7791 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
7792 focusTaken = requestFocus();
7793 }
7794
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08007795 if (prepressed) {
7796 // The button is being released before we actually
7797 // showed it as pressed. Make it show the pressed
7798 // state now (before scheduling the click) to ensure
7799 // the user sees it.
Adam Powell4d6f0662012-02-21 15:11:11 -08007800 setPressed(true);
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08007801 }
Joe Malin32736f02011-01-19 16:14:20 -08007802
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007803 if (!mHasPerformedLongPress) {
7804 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05007805 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007806
7807 // Only perform take click actions if we were in the pressed state
7808 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08007809 // Use a Runnable and post this rather than calling
7810 // performClick directly. This lets other visual state
7811 // of the view update before click actions start.
7812 if (mPerformClick == null) {
7813 mPerformClick = new PerformClick();
7814 }
7815 if (!post(mPerformClick)) {
7816 performClick();
7817 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007818 }
7819 }
7820
7821 if (mUnsetPressedState == null) {
7822 mUnsetPressedState = new UnsetPressedState();
7823 }
7824
Adam Powelle14579b2009-12-16 18:39:52 -08007825 if (prepressed) {
Adam Powelle14579b2009-12-16 18:39:52 -08007826 postDelayed(mUnsetPressedState,
7827 ViewConfiguration.getPressedStateDuration());
7828 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007829 // If the post failed, unpress right now
7830 mUnsetPressedState.run();
7831 }
Adam Powelle14579b2009-12-16 18:39:52 -08007832 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007833 }
7834 break;
7835
7836 case MotionEvent.ACTION_DOWN:
Adam Powell3b023392010-03-11 16:30:28 -08007837 mHasPerformedLongPress = false;
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007838
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07007839 if (performButtonActionOnTouchDown(event)) {
7840 break;
7841 }
7842
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007843 // Walk up the hierarchy to determine if we're inside a scrolling container.
Adam Powell10298662011-08-14 18:26:30 -07007844 boolean isInScrollingContainer = isInScrollingContainer();
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007845
7846 // For views inside a scrolling container, delay the pressed feedback for
7847 // a short period in case this is a scroll.
7848 if (isInScrollingContainer) {
7849 mPrivateFlags |= PREPRESSED;
7850 if (mPendingCheckForTap == null) {
7851 mPendingCheckForTap = new CheckForTap();
7852 }
7853 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
7854 } else {
7855 // Not inside a scrolling container, so show the feedback right away
Adam Powell4d6f0662012-02-21 15:11:11 -08007856 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007857 checkForLongClick(0);
7858 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007859 break;
7860
7861 case MotionEvent.ACTION_CANCEL:
Adam Powell4d6f0662012-02-21 15:11:11 -08007862 setPressed(false);
Adam Powelle14579b2009-12-16 18:39:52 -08007863 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007864 break;
7865
7866 case MotionEvent.ACTION_MOVE:
7867 final int x = (int) event.getX();
7868 final int y = (int) event.getY();
7869
7870 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07007871 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007872 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08007873 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007874 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08007875 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05007876 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007877
Adam Powell4d6f0662012-02-21 15:11:11 -08007878 setPressed(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007879 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007880 }
7881 break;
7882 }
7883 return true;
7884 }
7885
7886 return false;
7887 }
7888
7889 /**
Adam Powell10298662011-08-14 18:26:30 -07007890 * @hide
7891 */
7892 public boolean isInScrollingContainer() {
7893 ViewParent p = getParent();
7894 while (p != null && p instanceof ViewGroup) {
7895 if (((ViewGroup) p).shouldDelayChildPressedState()) {
7896 return true;
7897 }
7898 p = p.getParent();
7899 }
7900 return false;
7901 }
7902
7903 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05007904 * Remove the longpress detection timer.
7905 */
7906 private void removeLongPressCallback() {
7907 if (mPendingCheckForLongPress != null) {
7908 removeCallbacks(mPendingCheckForLongPress);
7909 }
7910 }
Adam Powell3cb8b632011-01-21 15:34:14 -08007911
7912 /**
7913 * Remove the pending click action
7914 */
7915 private void removePerformClickCallback() {
7916 if (mPerformClick != null) {
7917 removeCallbacks(mPerformClick);
7918 }
7919 }
7920
Adam Powelle14579b2009-12-16 18:39:52 -08007921 /**
Romain Guya440b002010-02-24 15:57:54 -08007922 * Remove the prepress detection timer.
7923 */
7924 private void removeUnsetPressCallback() {
7925 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
7926 setPressed(false);
7927 removeCallbacks(mUnsetPressedState);
7928 }
7929 }
7930
7931 /**
Adam Powelle14579b2009-12-16 18:39:52 -08007932 * Remove the tap detection timer.
7933 */
7934 private void removeTapCallback() {
7935 if (mPendingCheckForTap != null) {
7936 mPrivateFlags &= ~PREPRESSED;
7937 removeCallbacks(mPendingCheckForTap);
7938 }
7939 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05007940
7941 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007942 * Cancels a pending long press. Your subclass can use this if you
7943 * want the context menu to come up if the user presses and holds
7944 * at the same place, but you don't want it to come up if they press
7945 * and then move around enough to cause scrolling.
7946 */
7947 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05007948 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08007949
7950 /*
7951 * The prepressed state handled by the tap callback is a display
7952 * construct, but the tap callback will post a long press callback
7953 * less its own timeout. Remove it here.
7954 */
7955 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007956 }
7957
7958 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -07007959 * Remove the pending callback for sending a
7960 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
7961 */
7962 private void removeSendViewScrolledAccessibilityEventCallback() {
7963 if (mSendViewScrolledAccessibilityEvent != null) {
7964 removeCallbacks(mSendViewScrolledAccessibilityEvent);
7965 }
7966 }
7967
7968 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007969 * Sets the TouchDelegate for this View.
7970 */
7971 public void setTouchDelegate(TouchDelegate delegate) {
7972 mTouchDelegate = delegate;
7973 }
7974
7975 /**
7976 * Gets the TouchDelegate for this View.
7977 */
7978 public TouchDelegate getTouchDelegate() {
7979 return mTouchDelegate;
7980 }
7981
7982 /**
7983 * Set flags controlling behavior of this view.
7984 *
7985 * @param flags Constant indicating the value which should be set
7986 * @param mask Constant indicating the bit range that should be changed
7987 */
7988 void setFlags(int flags, int mask) {
7989 int old = mViewFlags;
7990 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
7991
7992 int changed = mViewFlags ^ old;
7993 if (changed == 0) {
7994 return;
7995 }
7996 int privateFlags = mPrivateFlags;
7997
7998 /* Check if the FOCUSABLE bit has changed */
7999 if (((changed & FOCUSABLE_MASK) != 0) &&
8000 ((privateFlags & HAS_BOUNDS) !=0)) {
8001 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
8002 && ((privateFlags & FOCUSED) != 0)) {
8003 /* Give up focus if we are no longer focusable */
8004 clearFocus();
8005 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
8006 && ((privateFlags & FOCUSED) == 0)) {
8007 /*
8008 * Tell the view system that we are now available to take focus
8009 * if no one else already has it.
8010 */
8011 if (mParent != null) mParent.focusableViewAvailable(this);
8012 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07008013 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
8014 notifyAccessibilityStateChanged();
8015 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008016 }
8017
8018 if ((flags & VISIBILITY_MASK) == VISIBLE) {
8019 if ((changed & VISIBILITY_MASK) != 0) {
8020 /*
Chet Haase4324ead2011-08-24 21:31:03 -07008021 * If this view is becoming visible, invalidate it in case it changed while
Chet Haaseaceafe62011-08-26 15:44:33 -07008022 * it was not visible. Marking it drawn ensures that the invalidation will
8023 * go through.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008024 */
Chet Haaseaceafe62011-08-26 15:44:33 -07008025 mPrivateFlags |= DRAWN;
Chet Haase4324ead2011-08-24 21:31:03 -07008026 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008027
8028 needGlobalAttributesUpdate(true);
8029
8030 // a view becoming visible is worth notifying the parent
8031 // about in case nothing has focus. even if this specific view
8032 // isn't focusable, it may contain something that is, so let
8033 // the root view try to give this focus if nothing else does.
8034 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
8035 mParent.focusableViewAvailable(this);
8036 }
8037 }
8038 }
8039
8040 /* Check if the GONE bit has changed */
8041 if ((changed & GONE) != 0) {
8042 needGlobalAttributesUpdate(false);
8043 requestLayout();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008044
Romain Guyecd80ee2009-12-03 17:13:02 -08008045 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
8046 if (hasFocus()) clearFocus();
Svetoslav Ganov42138042012-03-20 11:51:39 -07008047 clearAccessibilityFocus();
Romain Guyecd80ee2009-12-03 17:13:02 -08008048 destroyDrawingCache();
Chet Haaseaceafe62011-08-26 15:44:33 -07008049 if (mParent instanceof View) {
8050 // GONE views noop invalidation, so invalidate the parent
8051 ((View) mParent).invalidate(true);
8052 }
8053 // Mark the view drawn to ensure that it gets invalidated properly the next
8054 // time it is visible and gets invalidated
8055 mPrivateFlags |= DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008056 }
8057 if (mAttachInfo != null) {
8058 mAttachInfo.mViewVisibilityChanged = true;
8059 }
8060 }
8061
8062 /* Check if the VISIBLE bit has changed */
8063 if ((changed & INVISIBLE) != 0) {
8064 needGlobalAttributesUpdate(false);
Chet Haasec8a9a702011-06-17 12:13:42 -07008065 /*
8066 * If this view is becoming invisible, set the DRAWN flag so that
8067 * the next invalidate() will not be skipped.
8068 */
8069 mPrivateFlags |= DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008070
8071 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07008072 // root view becoming invisible shouldn't clear focus and accessibility focus
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008073 if (getRootView() != this) {
8074 clearFocus();
Svetoslav Ganov42138042012-03-20 11:51:39 -07008075 clearAccessibilityFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008076 }
8077 }
8078 if (mAttachInfo != null) {
8079 mAttachInfo.mViewVisibilityChanged = true;
8080 }
8081 }
8082
Adam Powell326d8082009-12-09 15:10:07 -08008083 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07008084 if (mParent instanceof ViewGroup) {
Romain Guyfe455af2012-02-15 16:40:20 -08008085 ((ViewGroup) mParent).onChildVisibilityChanged(this,
8086 (changed & VISIBILITY_MASK), (flags & VISIBILITY_MASK));
Romain Guy0fd89bf2011-01-26 15:41:30 -08008087 ((View) mParent).invalidate(true);
Chet Haasee4e6e202011-08-29 14:34:30 -07008088 } else if (mParent != null) {
8089 mParent.invalidateChild(this, null);
Chet Haase5e25c2c2010-09-16 11:15:56 -07008090 }
Adam Powell326d8082009-12-09 15:10:07 -08008091 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
8092 }
8093
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008094 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
8095 destroyDrawingCache();
8096 }
8097
8098 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
8099 destroyDrawingCache();
8100 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Romain Guy0fd89bf2011-01-26 15:41:30 -08008101 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008102 }
8103
8104 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
8105 destroyDrawingCache();
8106 mPrivateFlags &= ~DRAWING_CACHE_VALID;
8107 }
8108
8109 if ((changed & DRAW_MASK) != 0) {
8110 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
Philip Milne6c8ea062012-04-03 17:38:43 -07008111 if (mBackground != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008112 mPrivateFlags &= ~SKIP_DRAW;
8113 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
8114 } else {
8115 mPrivateFlags |= SKIP_DRAW;
8116 }
8117 } else {
8118 mPrivateFlags &= ~SKIP_DRAW;
8119 }
8120 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08008121 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008122 }
8123
8124 if ((changed & KEEP_SCREEN_ON) != 0) {
Joe Onorato664644d2011-01-23 17:53:23 -08008125 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008126 mParent.recomputeViewAttributes(this);
8127 }
8128 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07008129
8130 if (AccessibilityManager.getInstance(mContext).isEnabled()
8131 && ((changed & FOCUSABLE) != 0 || (changed & CLICKABLE) != 0
8132 || (changed & LONG_CLICKABLE) != 0 || (changed & ENABLED) != 0)) {
8133 notifyAccessibilityStateChanged();
8134 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008135 }
8136
8137 /**
8138 * Change the view's z order in the tree, so it's on top of other sibling
8139 * views
8140 */
8141 public void bringToFront() {
8142 if (mParent != null) {
8143 mParent.bringChildToFront(this);
8144 }
8145 }
8146
8147 /**
8148 * This is called in response to an internal scroll in this view (i.e., the
8149 * view scrolled its own contents). This is typically as a result of
8150 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
8151 * called.
8152 *
8153 * @param l Current horizontal scroll origin.
8154 * @param t Current vertical scroll origin.
8155 * @param oldl Previous horizontal scroll origin.
8156 * @param oldt Previous vertical scroll origin.
8157 */
8158 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Svetoslav Ganova0156172011-06-26 17:55:44 -07008159 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
8160 postSendViewScrolledAccessibilityEventCallback();
8161 }
8162
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008163 mBackgroundSizeChanged = true;
8164
8165 final AttachInfo ai = mAttachInfo;
8166 if (ai != null) {
8167 ai.mViewScrollChanged = true;
8168 }
8169 }
8170
8171 /**
Chet Haase21cd1382010-09-01 17:42:29 -07008172 * Interface definition for a callback to be invoked when the layout bounds of a view
8173 * changes due to layout processing.
8174 */
8175 public interface OnLayoutChangeListener {
8176 /**
8177 * Called when the focus state of a view has changed.
8178 *
8179 * @param v The view whose state has changed.
8180 * @param left The new value of the view's left property.
8181 * @param top The new value of the view's top property.
8182 * @param right The new value of the view's right property.
8183 * @param bottom The new value of the view's bottom property.
8184 * @param oldLeft The previous value of the view's left property.
8185 * @param oldTop The previous value of the view's top property.
8186 * @param oldRight The previous value of the view's right property.
8187 * @param oldBottom The previous value of the view's bottom property.
8188 */
8189 void onLayoutChange(View v, int left, int top, int right, int bottom,
8190 int oldLeft, int oldTop, int oldRight, int oldBottom);
8191 }
8192
8193 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008194 * This is called during layout when the size of this view has changed. If
8195 * you were just added to the view hierarchy, you're called with the old
8196 * values of 0.
8197 *
8198 * @param w Current width of this view.
8199 * @param h Current height of this view.
8200 * @param oldw Old width of this view.
8201 * @param oldh Old height of this view.
8202 */
8203 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
8204 }
8205
8206 /**
8207 * Called by draw to draw the child views. This may be overridden
8208 * by derived classes to gain control just before its children are drawn
8209 * (but after its own view has been drawn).
8210 * @param canvas the canvas on which to draw the view
8211 */
8212 protected void dispatchDraw(Canvas canvas) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07008213
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008214 }
8215
8216 /**
8217 * Gets the parent of this view. Note that the parent is a
8218 * ViewParent and not necessarily a View.
8219 *
8220 * @return Parent of this view.
8221 */
8222 public final ViewParent getParent() {
8223 return mParent;
8224 }
8225
8226 /**
Chet Haasecca2c982011-05-20 14:34:18 -07008227 * Set the horizontal scrolled position of your view. This will cause a call to
8228 * {@link #onScrollChanged(int, int, int, int)} and the view will be
8229 * invalidated.
8230 * @param value the x position to scroll to
8231 */
8232 public void setScrollX(int value) {
8233 scrollTo(value, mScrollY);
8234 }
8235
8236 /**
8237 * Set the vertical scrolled position of your view. This will cause a call to
8238 * {@link #onScrollChanged(int, int, int, int)} and the view will be
8239 * invalidated.
8240 * @param value the y position to scroll to
8241 */
8242 public void setScrollY(int value) {
8243 scrollTo(mScrollX, value);
8244 }
8245
8246 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008247 * Return the scrolled left position of this view. This is the left edge of
8248 * the displayed part of your view. You do not need to draw any pixels
8249 * farther left, since those are outside of the frame of your view on
8250 * screen.
8251 *
8252 * @return The left edge of the displayed part of your view, in pixels.
8253 */
8254 public final int getScrollX() {
8255 return mScrollX;
8256 }
8257
8258 /**
8259 * Return the scrolled top position of this view. This is the top edge of
8260 * the displayed part of your view. You do not need to draw any pixels above
8261 * it, since those are outside of the frame of your view on screen.
8262 *
8263 * @return The top edge of the displayed part of your view, in pixels.
8264 */
8265 public final int getScrollY() {
8266 return mScrollY;
8267 }
8268
8269 /**
8270 * Return the width of the your view.
8271 *
8272 * @return The width of your view, in pixels.
8273 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008274 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008275 public final int getWidth() {
8276 return mRight - mLeft;
8277 }
8278
8279 /**
8280 * Return the height of your view.
8281 *
8282 * @return The height of your view, in pixels.
8283 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008284 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008285 public final int getHeight() {
8286 return mBottom - mTop;
8287 }
8288
8289 /**
8290 * Return the visible drawing bounds of your view. Fills in the output
8291 * rectangle with the values from getScrollX(), getScrollY(),
8292 * getWidth(), and getHeight().
8293 *
8294 * @param outRect The (scrolled) drawing bounds of the view.
8295 */
8296 public void getDrawingRect(Rect outRect) {
8297 outRect.left = mScrollX;
8298 outRect.top = mScrollY;
8299 outRect.right = mScrollX + (mRight - mLeft);
8300 outRect.bottom = mScrollY + (mBottom - mTop);
8301 }
8302
8303 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008304 * Like {@link #getMeasuredWidthAndState()}, but only returns the
8305 * raw width component (that is the result is masked by
8306 * {@link #MEASURED_SIZE_MASK}).
8307 *
8308 * @return The raw measured width of this view.
8309 */
8310 public final int getMeasuredWidth() {
8311 return mMeasuredWidth & MEASURED_SIZE_MASK;
8312 }
8313
8314 /**
8315 * Return the full width measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07008316 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08008317 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008318 * This should be used during measurement and layout calculations only. Use
8319 * {@link #getWidth()} to see how wide a view is after layout.
8320 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08008321 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008322 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08008323 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008324 return mMeasuredWidth;
8325 }
8326
8327 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008328 * Like {@link #getMeasuredHeightAndState()}, but only returns the
8329 * raw width component (that is the result is masked by
8330 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008331 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08008332 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008333 */
8334 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08008335 return mMeasuredHeight & MEASURED_SIZE_MASK;
8336 }
8337
8338 /**
8339 * Return the full height measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07008340 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08008341 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
8342 * This should be used during measurement and layout calculations only. Use
8343 * {@link #getHeight()} to see how wide a view is after layout.
8344 *
8345 * @return The measured width of this view as a bit mask.
8346 */
8347 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008348 return mMeasuredHeight;
8349 }
8350
8351 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008352 * Return only the state bits of {@link #getMeasuredWidthAndState()}
8353 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
8354 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
8355 * and the height component is at the shifted bits
8356 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
8357 */
8358 public final int getMeasuredState() {
8359 return (mMeasuredWidth&MEASURED_STATE_MASK)
8360 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
8361 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
8362 }
8363
8364 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008365 * The transform matrix of this view, which is calculated based on the current
8366 * roation, scale, and pivot properties.
8367 *
8368 * @see #getRotation()
8369 * @see #getScaleX()
8370 * @see #getScaleY()
8371 * @see #getPivotX()
8372 * @see #getPivotY()
8373 * @return The current transform matrix for the view
8374 */
8375 public Matrix getMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008376 if (mTransformationInfo != null) {
8377 updateMatrix();
8378 return mTransformationInfo.mMatrix;
8379 }
8380 return Matrix.IDENTITY_MATRIX;
Romain Guy33e72ae2010-07-17 12:40:29 -07008381 }
8382
8383 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07008384 * Utility function to determine if the value is far enough away from zero to be
8385 * considered non-zero.
8386 * @param value A floating point value to check for zero-ness
8387 * @return whether the passed-in value is far enough away from zero to be considered non-zero
8388 */
8389 private static boolean nonzero(float value) {
8390 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
8391 }
8392
8393 /**
Jeff Brown86671742010-09-30 20:00:15 -07008394 * Returns true if the transform matrix is the identity matrix.
8395 * Recomputes the matrix if necessary.
Joe Malin32736f02011-01-19 16:14:20 -08008396 *
Romain Guy33e72ae2010-07-17 12:40:29 -07008397 * @return True if the transform matrix is the identity matrix, false otherwise.
8398 */
Jeff Brown86671742010-09-30 20:00:15 -07008399 final boolean hasIdentityMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008400 if (mTransformationInfo != null) {
8401 updateMatrix();
8402 return mTransformationInfo.mMatrixIsIdentity;
8403 }
8404 return true;
8405 }
8406
8407 void ensureTransformationInfo() {
8408 if (mTransformationInfo == null) {
8409 mTransformationInfo = new TransformationInfo();
8410 }
Jeff Brown86671742010-09-30 20:00:15 -07008411 }
8412
8413 /**
8414 * Recomputes the transform matrix if necessary.
8415 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008416 private void updateMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008417 final TransformationInfo info = mTransformationInfo;
8418 if (info == null) {
8419 return;
8420 }
8421 if (info.mMatrixDirty) {
Chet Haasec3aa3612010-06-17 08:50:37 -07008422 // transform-related properties have changed since the last time someone
8423 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07008424
8425 // Figure out if we need to update the pivot point
8426 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008427 if ((mRight - mLeft) != info.mPrevWidth || (mBottom - mTop) != info.mPrevHeight) {
8428 info.mPrevWidth = mRight - mLeft;
8429 info.mPrevHeight = mBottom - mTop;
8430 info.mPivotX = info.mPrevWidth / 2f;
8431 info.mPivotY = info.mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07008432 }
8433 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008434 info.mMatrix.reset();
8435 if (!nonzero(info.mRotationX) && !nonzero(info.mRotationY)) {
8436 info.mMatrix.setTranslate(info.mTranslationX, info.mTranslationY);
8437 info.mMatrix.preRotate(info.mRotation, info.mPivotX, info.mPivotY);
8438 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07008439 } else {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008440 if (info.mCamera == null) {
8441 info.mCamera = new Camera();
8442 info.matrix3D = new Matrix();
Chet Haasefd2b0022010-08-06 13:08:56 -07008443 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008444 info.mCamera.save();
8445 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY);
8446 info.mCamera.rotate(info.mRotationX, info.mRotationY, -info.mRotation);
8447 info.mCamera.getMatrix(info.matrix3D);
8448 info.matrix3D.preTranslate(-info.mPivotX, -info.mPivotY);
8449 info.matrix3D.postTranslate(info.mPivotX + info.mTranslationX,
8450 info.mPivotY + info.mTranslationY);
8451 info.mMatrix.postConcat(info.matrix3D);
8452 info.mCamera.restore();
Chet Haasefd2b0022010-08-06 13:08:56 -07008453 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008454 info.mMatrixDirty = false;
8455 info.mMatrixIsIdentity = info.mMatrix.isIdentity();
8456 info.mInverseMatrixDirty = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07008457 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008458 }
8459
8460 /**
8461 * Utility method to retrieve the inverse of the current mMatrix property.
8462 * We cache the matrix to avoid recalculating it when transform properties
8463 * have not changed.
8464 *
8465 * @return The inverse of the current matrix of this view.
8466 */
Jeff Brown86671742010-09-30 20:00:15 -07008467 final Matrix getInverseMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008468 final TransformationInfo info = mTransformationInfo;
8469 if (info != null) {
8470 updateMatrix();
8471 if (info.mInverseMatrixDirty) {
8472 if (info.mInverseMatrix == null) {
8473 info.mInverseMatrix = new Matrix();
8474 }
8475 info.mMatrix.invert(info.mInverseMatrix);
8476 info.mInverseMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07008477 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008478 return info.mInverseMatrix;
Chet Haasec3aa3612010-06-17 08:50:37 -07008479 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008480 return Matrix.IDENTITY_MATRIX;
Chet Haasec3aa3612010-06-17 08:50:37 -07008481 }
8482
8483 /**
Chet Haasea1cff502012-02-21 13:43:44 -08008484 * Gets the distance along the Z axis from the camera to this view.
8485 *
8486 * @see #setCameraDistance(float)
8487 *
8488 * @return The distance along the Z axis.
8489 */
8490 public float getCameraDistance() {
8491 ensureTransformationInfo();
8492 final float dpi = mResources.getDisplayMetrics().densityDpi;
8493 final TransformationInfo info = mTransformationInfo;
8494 if (info.mCamera == null) {
8495 info.mCamera = new Camera();
8496 info.matrix3D = new Matrix();
8497 }
8498 return -(info.mCamera.getLocationZ() * dpi);
8499 }
8500
8501 /**
Romain Guya5364ee2011-02-24 14:46:04 -08008502 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which
8503 * views are drawn) from the camera to this view. The camera's distance
8504 * affects 3D transformations, for instance rotations around the X and Y
8505 * axis. If the rotationX or rotationY properties are changed and this view is
Philip Milne6c8ea062012-04-03 17:38:43 -07008506 * large (more than half the size of the screen), it is recommended to always
Romain Guya5364ee2011-02-24 14:46:04 -08008507 * use a camera distance that's greater than the height (X axis rotation) or
8508 * the width (Y axis rotation) of this view.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008509 *
Romain Guya5364ee2011-02-24 14:46:04 -08008510 * <p>The distance of the camera from the view plane can have an affect on the
8511 * perspective distortion of the view when it is rotated around the x or y axis.
8512 * For example, a large distance will result in a large viewing angle, and there
8513 * will not be much perspective distortion of the view as it rotates. A short
Philip Milne6c8ea062012-04-03 17:38:43 -07008514 * distance may cause much more perspective distortion upon rotation, and can
Romain Guya5364ee2011-02-24 14:46:04 -08008515 * also result in some drawing artifacts if the rotated view ends up partially
8516 * behind the camera (which is why the recommendation is to use a distance at
8517 * least as far as the size of the view, if the view is to be rotated.)</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008518 *
Romain Guya5364ee2011-02-24 14:46:04 -08008519 * <p>The distance is expressed in "depth pixels." The default distance depends
8520 * on the screen density. For instance, on a medium density display, the
8521 * default distance is 1280. On a high density display, the default distance
8522 * is 1920.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008523 *
Romain Guya5364ee2011-02-24 14:46:04 -08008524 * <p>If you want to specify a distance that leads to visually consistent
8525 * results across various densities, use the following formula:</p>
8526 * <pre>
8527 * float scale = context.getResources().getDisplayMetrics().density;
8528 * view.setCameraDistance(distance * scale);
8529 * </pre>
Philip Milne6c8ea062012-04-03 17:38:43 -07008530 *
Romain Guya5364ee2011-02-24 14:46:04 -08008531 * <p>The density scale factor of a high density display is 1.5,
8532 * and 1920 = 1280 * 1.5.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008533 *
Romain Guya5364ee2011-02-24 14:46:04 -08008534 * @param distance The distance in "depth pixels", if negative the opposite
8535 * value is used
Philip Milne6c8ea062012-04-03 17:38:43 -07008536 *
8537 * @see #setRotationX(float)
8538 * @see #setRotationY(float)
Romain Guya5364ee2011-02-24 14:46:04 -08008539 */
8540 public void setCameraDistance(float distance) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008541 invalidateViewProperty(true, false);
Romain Guya5364ee2011-02-24 14:46:04 -08008542
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008543 ensureTransformationInfo();
Romain Guya5364ee2011-02-24 14:46:04 -08008544 final float dpi = mResources.getDisplayMetrics().densityDpi;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008545 final TransformationInfo info = mTransformationInfo;
8546 if (info.mCamera == null) {
8547 info.mCamera = new Camera();
8548 info.matrix3D = new Matrix();
Romain Guya5364ee2011-02-24 14:46:04 -08008549 }
8550
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008551 info.mCamera.setLocation(0.0f, 0.0f, -Math.abs(distance) / dpi);
8552 info.mMatrixDirty = true;
Romain Guya5364ee2011-02-24 14:46:04 -08008553
Chet Haase9d1992d2012-03-13 11:03:25 -07008554 invalidateViewProperty(false, false);
Chet Haase1271e2c2012-04-20 09:54:27 -07008555 if (mDisplayList != null) {
Chet Haaseb85967b2012-03-26 14:37:51 -07008556 mDisplayList.setCameraDistance(-Math.abs(distance) / dpi);
Chet Haasea1cff502012-02-21 13:43:44 -08008557 }
Romain Guya5364ee2011-02-24 14:46:04 -08008558 }
8559
8560 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008561 * The degrees that the view is rotated around the pivot point.
8562 *
Philip Milne6c8ea062012-04-03 17:38:43 -07008563 * @see #setRotation(float)
Chet Haasec3aa3612010-06-17 08:50:37 -07008564 * @see #getPivotX()
8565 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008566 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008567 * @return The degrees of rotation.
8568 */
Chet Haasea5531132012-02-02 13:41:44 -08008569 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008570 public float getRotation() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008571 return mTransformationInfo != null ? mTransformationInfo.mRotation : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008572 }
8573
8574 /**
Chet Haase897247b2010-09-09 14:54:47 -07008575 * Sets the degrees that the view is rotated around the pivot point. Increasing values
8576 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07008577 *
8578 * @param rotation The degrees of rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008579 *
8580 * @see #getRotation()
Chet Haasec3aa3612010-06-17 08:50:37 -07008581 * @see #getPivotX()
8582 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008583 * @see #setRotationX(float)
8584 * @see #setRotationY(float)
Chet Haase73066682010-11-29 15:55:32 -08008585 *
8586 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07008587 */
8588 public void setRotation(float rotation) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008589 ensureTransformationInfo();
8590 final TransformationInfo info = mTransformationInfo;
8591 if (info.mRotation != rotation) {
Chet Haasec3aa3612010-06-17 08:50:37 -07008592 // Double-invalidation is necessary to capture view's old and new areas
Chet Haase9d1992d2012-03-13 11:03:25 -07008593 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008594 info.mRotation = rotation;
8595 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008596 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008597 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008598 mDisplayList.setRotation(rotation);
8599 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008600 }
8601 }
8602
8603 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07008604 * The degrees that the view is rotated around the vertical axis through the pivot point.
8605 *
8606 * @see #getPivotX()
8607 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008608 * @see #setRotationY(float)
8609 *
Chet Haasefd2b0022010-08-06 13:08:56 -07008610 * @return The degrees of Y rotation.
8611 */
Chet Haasea5531132012-02-02 13:41:44 -08008612 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasefd2b0022010-08-06 13:08:56 -07008613 public float getRotationY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008614 return mTransformationInfo != null ? mTransformationInfo.mRotationY : 0;
Chet Haasefd2b0022010-08-06 13:08:56 -07008615 }
8616
8617 /**
Chet Haase897247b2010-09-09 14:54:47 -07008618 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
8619 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
8620 * down the y axis.
Philip Milne6c8ea062012-04-03 17:38:43 -07008621 *
Romain Guya5364ee2011-02-24 14:46:04 -08008622 * When rotating large views, it is recommended to adjust the camera distance
8623 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07008624 *
8625 * @param rotationY The degrees of Y rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008626 *
8627 * @see #getRotationY()
Chet Haasefd2b0022010-08-06 13:08:56 -07008628 * @see #getPivotX()
8629 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08008630 * @see #setRotation(float)
Philip Milne6c8ea062012-04-03 17:38:43 -07008631 * @see #setRotationX(float)
8632 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08008633 *
8634 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07008635 */
8636 public void setRotationY(float rotationY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008637 ensureTransformationInfo();
8638 final TransformationInfo info = mTransformationInfo;
8639 if (info.mRotationY != rotationY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008640 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008641 info.mRotationY = rotationY;
8642 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008643 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008644 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008645 mDisplayList.setRotationY(rotationY);
8646 }
Chet Haasefd2b0022010-08-06 13:08:56 -07008647 }
8648 }
8649
8650 /**
8651 * The degrees that the view is rotated around the horizontal axis through the pivot point.
8652 *
8653 * @see #getPivotX()
8654 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008655 * @see #setRotationX(float)
8656 *
Chet Haasefd2b0022010-08-06 13:08:56 -07008657 * @return The degrees of X rotation.
8658 */
Chet Haasea5531132012-02-02 13:41:44 -08008659 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasefd2b0022010-08-06 13:08:56 -07008660 public float getRotationX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008661 return mTransformationInfo != null ? mTransformationInfo.mRotationX : 0;
Chet Haasefd2b0022010-08-06 13:08:56 -07008662 }
8663
8664 /**
Chet Haase897247b2010-09-09 14:54:47 -07008665 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
8666 * Increasing values result in clockwise rotation from the viewpoint of looking down the
8667 * x axis.
Philip Milne6c8ea062012-04-03 17:38:43 -07008668 *
Romain Guya5364ee2011-02-24 14:46:04 -08008669 * When rotating large views, it is recommended to adjust the camera distance
8670 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07008671 *
8672 * @param rotationX The degrees of X rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008673 *
8674 * @see #getRotationX()
Chet Haasefd2b0022010-08-06 13:08:56 -07008675 * @see #getPivotX()
8676 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08008677 * @see #setRotation(float)
Philip Milne6c8ea062012-04-03 17:38:43 -07008678 * @see #setRotationY(float)
8679 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08008680 *
8681 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07008682 */
8683 public void setRotationX(float rotationX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008684 ensureTransformationInfo();
8685 final TransformationInfo info = mTransformationInfo;
8686 if (info.mRotationX != rotationX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008687 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008688 info.mRotationX = rotationX;
8689 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008690 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008691 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008692 mDisplayList.setRotationX(rotationX);
8693 }
Chet Haasefd2b0022010-08-06 13:08:56 -07008694 }
8695 }
8696
8697 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008698 * The amount that the view is scaled in x around the pivot point, as a proportion of
8699 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
8700 *
Joe Onorato93162322010-09-16 15:42:01 -04008701 * <p>By default, this is 1.0f.
8702 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008703 * @see #getPivotX()
8704 * @see #getPivotY()
8705 * @return The scaling factor.
8706 */
Chet Haasea5531132012-02-02 13:41:44 -08008707 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008708 public float getScaleX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008709 return mTransformationInfo != null ? mTransformationInfo.mScaleX : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008710 }
8711
8712 /**
8713 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
8714 * the view's unscaled width. A value of 1 means that no scaling is applied.
8715 *
8716 * @param scaleX The scaling factor.
8717 * @see #getPivotX()
8718 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008719 *
8720 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07008721 */
8722 public void setScaleX(float scaleX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008723 ensureTransformationInfo();
8724 final TransformationInfo info = mTransformationInfo;
8725 if (info.mScaleX != scaleX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008726 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008727 info.mScaleX = scaleX;
8728 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008729 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008730 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008731 mDisplayList.setScaleX(scaleX);
8732 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008733 }
8734 }
8735
8736 /**
8737 * The amount that the view is scaled in y around the pivot point, as a proportion of
8738 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
8739 *
Joe Onorato93162322010-09-16 15:42:01 -04008740 * <p>By default, this is 1.0f.
8741 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008742 * @see #getPivotX()
8743 * @see #getPivotY()
8744 * @return The scaling factor.
8745 */
Chet Haasea5531132012-02-02 13:41:44 -08008746 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008747 public float getScaleY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008748 return mTransformationInfo != null ? mTransformationInfo.mScaleY : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008749 }
8750
8751 /**
8752 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
8753 * the view's unscaled width. A value of 1 means that no scaling is applied.
8754 *
8755 * @param scaleY The scaling factor.
8756 * @see #getPivotX()
8757 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008758 *
8759 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07008760 */
8761 public void setScaleY(float scaleY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008762 ensureTransformationInfo();
8763 final TransformationInfo info = mTransformationInfo;
8764 if (info.mScaleY != scaleY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008765 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008766 info.mScaleY = scaleY;
8767 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008768 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008769 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008770 mDisplayList.setScaleY(scaleY);
8771 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008772 }
8773 }
8774
8775 /**
8776 * The x location of the point around which the view is {@link #setRotation(float) rotated}
8777 * and {@link #setScaleX(float) scaled}.
8778 *
8779 * @see #getRotation()
8780 * @see #getScaleX()
8781 * @see #getScaleY()
8782 * @see #getPivotY()
8783 * @return The x location of the pivot point.
Philip Milne6c8ea062012-04-03 17:38:43 -07008784 *
8785 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07008786 */
Chet Haasea5531132012-02-02 13:41:44 -08008787 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008788 public float getPivotX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008789 return mTransformationInfo != null ? mTransformationInfo.mPivotX : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008790 }
8791
8792 /**
8793 * Sets the x location of the point around which the view is
8794 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07008795 * By default, the pivot point is centered on the object.
8796 * Setting this property disables this behavior and causes the view to use only the
8797 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07008798 *
8799 * @param pivotX The x location of the pivot point.
8800 * @see #getRotation()
8801 * @see #getScaleX()
8802 * @see #getScaleY()
8803 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008804 *
8805 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07008806 */
8807 public void setPivotX(float pivotX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008808 ensureTransformationInfo();
Chet Haasefd2b0022010-08-06 13:08:56 -07008809 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008810 final TransformationInfo info = mTransformationInfo;
8811 if (info.mPivotX != pivotX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008812 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008813 info.mPivotX = pivotX;
8814 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008815 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008816 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008817 mDisplayList.setPivotX(pivotX);
8818 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008819 }
8820 }
8821
8822 /**
8823 * The y location of the point around which the view is {@link #setRotation(float) rotated}
8824 * and {@link #setScaleY(float) scaled}.
8825 *
8826 * @see #getRotation()
8827 * @see #getScaleX()
8828 * @see #getScaleY()
8829 * @see #getPivotY()
8830 * @return The y location of the pivot point.
Philip Milne6c8ea062012-04-03 17:38:43 -07008831 *
8832 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07008833 */
Chet Haasea5531132012-02-02 13:41:44 -08008834 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008835 public float getPivotY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008836 return mTransformationInfo != null ? mTransformationInfo.mPivotY : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008837 }
8838
8839 /**
8840 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07008841 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
8842 * Setting this property disables this behavior and causes the view to use only the
8843 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07008844 *
8845 * @param pivotY The y location of the pivot point.
8846 * @see #getRotation()
8847 * @see #getScaleX()
8848 * @see #getScaleY()
8849 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008850 *
8851 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07008852 */
8853 public void setPivotY(float pivotY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008854 ensureTransformationInfo();
Chet Haasefd2b0022010-08-06 13:08:56 -07008855 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008856 final TransformationInfo info = mTransformationInfo;
8857 if (info.mPivotY != pivotY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008858 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008859 info.mPivotY = pivotY;
8860 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008861 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008862 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008863 mDisplayList.setPivotY(pivotY);
8864 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008865 }
8866 }
8867
8868 /**
8869 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
8870 * completely transparent and 1 means the view is completely opaque.
8871 *
Joe Onorato93162322010-09-16 15:42:01 -04008872 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07008873 * @return The opacity of the view.
8874 */
Chet Haasea5531132012-02-02 13:41:44 -08008875 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008876 public float getAlpha() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008877 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008878 }
8879
8880 /**
Chet Haasedb8c9a62012-03-21 18:54:18 -07008881 * Returns whether this View has content which overlaps. This function, intended to be
8882 * overridden by specific View types, is an optimization when alpha is set on a view. If
8883 * rendering overlaps in a view with alpha < 1, that view is drawn to an offscreen buffer
8884 * and then composited it into place, which can be expensive. If the view has no overlapping
8885 * rendering, the view can draw each primitive with the appropriate alpha value directly.
8886 * An example of overlapping rendering is a TextView with a background image, such as a
8887 * Button. An example of non-overlapping rendering is a TextView with no background, or
8888 * an ImageView with only the foreground image. The default implementation returns true;
8889 * subclasses should override if they have cases which can be optimized.
8890 *
8891 * @return true if the content in this view might overlap, false otherwise.
8892 */
8893 public boolean hasOverlappingRendering() {
8894 return true;
8895 }
8896
8897 /**
Romain Guy171c5922011-01-06 10:04:23 -08008898 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
8899 * completely transparent and 1 means the view is completely opaque.</p>
Joe Malin32736f02011-01-19 16:14:20 -08008900 *
Romain Guy171c5922011-01-06 10:04:23 -08008901 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
8902 * responsible for applying the opacity itself. Otherwise, calling this method is
8903 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
Joe Malin32736f02011-01-19 16:14:20 -08008904 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07008905 *
Chet Haasea5531132012-02-02 13:41:44 -08008906 * <p>Note that setting alpha to a translucent value (0 < alpha < 1) may have
8907 * performance implications. It is generally best to use the alpha property sparingly and
8908 * transiently, as in the case of fading animations.</p>
8909 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008910 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08008911 *
Joe Malin32736f02011-01-19 16:14:20 -08008912 * @see #setLayerType(int, android.graphics.Paint)
8913 *
Chet Haase73066682010-11-29 15:55:32 -08008914 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07008915 */
8916 public void setAlpha(float alpha) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008917 ensureTransformationInfo();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008918 if (mTransformationInfo.mAlpha != alpha) {
8919 mTransformationInfo.mAlpha = alpha;
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008920 if (onSetAlpha((int) (alpha * 255))) {
8921 mPrivateFlags |= ALPHA_SET;
8922 // subclass is handling alpha - don't optimize rendering cache invalidation
Chet Haase9d1992d2012-03-13 11:03:25 -07008923 invalidateParentCaches();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008924 invalidate(true);
8925 } else {
8926 mPrivateFlags &= ~ALPHA_SET;
Chet Haase9d1992d2012-03-13 11:03:25 -07008927 invalidateViewProperty(true, false);
Chet Haase1271e2c2012-04-20 09:54:27 -07008928 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008929 mDisplayList.setAlpha(alpha);
8930 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008931 }
Chet Haaseed032702010-10-01 14:05:54 -07008932 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008933 }
8934
8935 /**
Chet Haasea00f3862011-02-22 06:34:40 -08008936 * Faster version of setAlpha() which performs the same steps except there are
8937 * no calls to invalidate(). The caller of this function should perform proper invalidation
8938 * on the parent and this object. The return value indicates whether the subclass handles
8939 * alpha (the return value for onSetAlpha()).
8940 *
8941 * @param alpha The new value for the alpha property
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008942 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and
8943 * the new value for the alpha property is different from the old value
Chet Haasea00f3862011-02-22 06:34:40 -08008944 */
8945 boolean setAlphaNoInvalidation(float alpha) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008946 ensureTransformationInfo();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008947 if (mTransformationInfo.mAlpha != alpha) {
8948 mTransformationInfo.mAlpha = alpha;
8949 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255));
8950 if (subclassHandlesAlpha) {
8951 mPrivateFlags |= ALPHA_SET;
8952 return true;
8953 } else {
8954 mPrivateFlags &= ~ALPHA_SET;
Chet Haase1271e2c2012-04-20 09:54:27 -07008955 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008956 mDisplayList.setAlpha(alpha);
8957 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008958 }
Chet Haasea00f3862011-02-22 06:34:40 -08008959 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08008960 return false;
Chet Haasea00f3862011-02-22 06:34:40 -08008961 }
8962
8963 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008964 * Top position of this view relative to its parent.
8965 *
8966 * @return The top of this view, in pixels.
8967 */
8968 @ViewDebug.CapturedViewProperty
8969 public final int getTop() {
8970 return mTop;
8971 }
8972
8973 /**
Chet Haase21cd1382010-09-01 17:42:29 -07008974 * Sets the top position of this view relative to its parent. This method is meant to be called
8975 * by the layout system and should not generally be called otherwise, because the property
8976 * may be changed at any time by the layout.
8977 *
8978 * @param top The top of this view, in pixels.
8979 */
8980 public final void setTop(int top) {
8981 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07008982 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008983 final boolean matrixIsIdentity = mTransformationInfo == null
8984 || mTransformationInfo.mMatrixIsIdentity;
8985 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08008986 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07008987 int minTop;
8988 int yLoc;
8989 if (top < mTop) {
8990 minTop = top;
8991 yLoc = top - mTop;
8992 } else {
8993 minTop = mTop;
8994 yLoc = 0;
8995 }
Chet Haasee9140a72011-02-16 16:23:29 -08008996 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop);
Chet Haase21cd1382010-09-01 17:42:29 -07008997 }
8998 } else {
8999 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009000 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009001 }
9002
Chet Haaseed032702010-10-01 14:05:54 -07009003 int width = mRight - mLeft;
9004 int oldHeight = mBottom - mTop;
9005
Chet Haase21cd1382010-09-01 17:42:29 -07009006 mTop = top;
Chet Haase1271e2c2012-04-20 09:54:27 -07009007 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009008 mDisplayList.setTop(mTop);
9009 }
Chet Haase21cd1382010-09-01 17:42:29 -07009010
Chet Haaseed032702010-10-01 14:05:54 -07009011 onSizeChanged(width, mBottom - mTop, width, oldHeight);
9012
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009013 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009014 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9015 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009016 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009017 }
Chet Haase21cd1382010-09-01 17:42:29 -07009018 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009019 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009020 }
Chet Haase55dbb652010-12-21 20:15:08 -08009021 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009022 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07009023 }
9024 }
9025
9026 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009027 * Bottom position of this view relative to its parent.
9028 *
9029 * @return The bottom of this view, in pixels.
9030 */
9031 @ViewDebug.CapturedViewProperty
9032 public final int getBottom() {
9033 return mBottom;
9034 }
9035
9036 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08009037 * True if this view has changed since the last time being drawn.
9038 *
9039 * @return The dirty state of this view.
9040 */
9041 public boolean isDirty() {
9042 return (mPrivateFlags & DIRTY_MASK) != 0;
9043 }
9044
9045 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009046 * Sets the bottom position of this view relative to its parent. This method is meant to be
9047 * called by the layout system and should not generally be called otherwise, because the
9048 * property may be changed at any time by the layout.
9049 *
9050 * @param bottom The bottom of this view, in pixels.
9051 */
9052 public final void setBottom(int bottom) {
9053 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07009054 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009055 final boolean matrixIsIdentity = mTransformationInfo == null
9056 || mTransformationInfo.mMatrixIsIdentity;
9057 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009058 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009059 int maxBottom;
9060 if (bottom < mBottom) {
9061 maxBottom = mBottom;
9062 } else {
9063 maxBottom = bottom;
9064 }
Chet Haasee9140a72011-02-16 16:23:29 -08009065 invalidate(0, 0, mRight - mLeft, maxBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009066 }
9067 } else {
9068 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009069 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009070 }
9071
Chet Haaseed032702010-10-01 14:05:54 -07009072 int width = mRight - mLeft;
9073 int oldHeight = mBottom - mTop;
9074
Chet Haase21cd1382010-09-01 17:42:29 -07009075 mBottom = bottom;
Chet Haase1271e2c2012-04-20 09:54:27 -07009076 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009077 mDisplayList.setBottom(mBottom);
9078 }
Chet Haase21cd1382010-09-01 17:42:29 -07009079
Chet Haaseed032702010-10-01 14:05:54 -07009080 onSizeChanged(width, mBottom - mTop, width, oldHeight);
9081
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009082 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009083 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9084 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009085 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009086 }
Chet Haase21cd1382010-09-01 17:42:29 -07009087 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009088 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009089 }
Chet Haase55dbb652010-12-21 20:15:08 -08009090 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009091 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07009092 }
9093 }
9094
9095 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009096 * Left position of this view relative to its parent.
9097 *
9098 * @return The left edge of this view, in pixels.
9099 */
9100 @ViewDebug.CapturedViewProperty
9101 public final int getLeft() {
9102 return mLeft;
9103 }
9104
9105 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009106 * Sets the left position of this view relative to its parent. This method is meant to be called
9107 * by the layout system and should not generally be called otherwise, because the property
9108 * may be changed at any time by the layout.
9109 *
9110 * @param left The bottom of this view, in pixels.
9111 */
9112 public final void setLeft(int left) {
9113 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07009114 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009115 final boolean matrixIsIdentity = mTransformationInfo == null
9116 || mTransformationInfo.mMatrixIsIdentity;
9117 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009118 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009119 int minLeft;
9120 int xLoc;
9121 if (left < mLeft) {
9122 minLeft = left;
9123 xLoc = left - mLeft;
9124 } else {
9125 minLeft = mLeft;
9126 xLoc = 0;
9127 }
Chet Haasee9140a72011-02-16 16:23:29 -08009128 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009129 }
9130 } else {
9131 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009132 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009133 }
9134
Chet Haaseed032702010-10-01 14:05:54 -07009135 int oldWidth = mRight - mLeft;
9136 int height = mBottom - mTop;
9137
Chet Haase21cd1382010-09-01 17:42:29 -07009138 mLeft = left;
Chet Haase1271e2c2012-04-20 09:54:27 -07009139 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009140 mDisplayList.setLeft(left);
9141 }
Chet Haase21cd1382010-09-01 17:42:29 -07009142
Chet Haaseed032702010-10-01 14:05:54 -07009143 onSizeChanged(mRight - mLeft, height, oldWidth, height);
9144
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009145 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009146 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9147 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009148 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009149 }
Chet Haase21cd1382010-09-01 17:42:29 -07009150 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009151 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009152 }
Chet Haase55dbb652010-12-21 20:15:08 -08009153 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009154 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07009155 }
9156 }
9157
9158 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009159 * Right position of this view relative to its parent.
9160 *
9161 * @return The right edge of this view, in pixels.
9162 */
9163 @ViewDebug.CapturedViewProperty
9164 public final int getRight() {
9165 return mRight;
9166 }
9167
9168 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009169 * Sets the right position of this view relative to its parent. This method is meant to be called
9170 * by the layout system and should not generally be called otherwise, because the property
9171 * may be changed at any time by the layout.
9172 *
9173 * @param right The bottom of this view, in pixels.
9174 */
9175 public final void setRight(int right) {
9176 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07009177 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009178 final boolean matrixIsIdentity = mTransformationInfo == null
9179 || mTransformationInfo.mMatrixIsIdentity;
9180 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009181 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009182 int maxRight;
9183 if (right < mRight) {
9184 maxRight = mRight;
9185 } else {
9186 maxRight = right;
9187 }
Chet Haasee9140a72011-02-16 16:23:29 -08009188 invalidate(0, 0, maxRight - mLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009189 }
9190 } else {
9191 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009192 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009193 }
9194
Chet Haaseed032702010-10-01 14:05:54 -07009195 int oldWidth = mRight - mLeft;
9196 int height = mBottom - mTop;
9197
Chet Haase21cd1382010-09-01 17:42:29 -07009198 mRight = right;
Chet Haase1271e2c2012-04-20 09:54:27 -07009199 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009200 mDisplayList.setRight(mRight);
9201 }
Chet Haase21cd1382010-09-01 17:42:29 -07009202
Chet Haaseed032702010-10-01 14:05:54 -07009203 onSizeChanged(mRight - mLeft, height, oldWidth, height);
9204
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009205 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009206 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9207 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009208 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009209 }
Chet Haase21cd1382010-09-01 17:42:29 -07009210 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009211 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009212 }
Chet Haase55dbb652010-12-21 20:15:08 -08009213 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009214 invalidateParentIfNeeded();
Chet Haase21cd1382010-09-01 17:42:29 -07009215 }
9216 }
9217
9218 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009219 * The visual x position of this view, in pixels. This is equivalent to the
9220 * {@link #setTranslationX(float) translationX} property plus the current
Joe Malin32736f02011-01-19 16:14:20 -08009221 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07009222 *
Chet Haasedf030d22010-07-30 17:22:38 -07009223 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07009224 */
Chet Haasea5531132012-02-02 13:41:44 -08009225 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009226 public float getX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009227 return mLeft + (mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0);
Chet Haasedf030d22010-07-30 17:22:38 -07009228 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009229
Chet Haasedf030d22010-07-30 17:22:38 -07009230 /**
9231 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
9232 * {@link #setTranslationX(float) translationX} property to be the difference between
9233 * the x value passed in and the current {@link #getLeft() left} property.
9234 *
9235 * @param x The visual x position of this view, in pixels.
9236 */
9237 public void setX(float x) {
9238 setTranslationX(x - mLeft);
9239 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009240
Chet Haasedf030d22010-07-30 17:22:38 -07009241 /**
9242 * The visual y position of this view, in pixels. This is equivalent to the
9243 * {@link #setTranslationY(float) translationY} property plus the current
9244 * {@link #getTop() top} property.
9245 *
9246 * @return The visual y position of this view, in pixels.
9247 */
Chet Haasea5531132012-02-02 13:41:44 -08009248 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009249 public float getY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009250 return mTop + (mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0);
Chet Haasedf030d22010-07-30 17:22:38 -07009251 }
9252
9253 /**
9254 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
9255 * {@link #setTranslationY(float) translationY} property to be the difference between
9256 * the y value passed in and the current {@link #getTop() top} property.
9257 *
9258 * @param y The visual y position of this view, in pixels.
9259 */
9260 public void setY(float y) {
9261 setTranslationY(y - mTop);
9262 }
9263
9264
9265 /**
9266 * The horizontal location of this view relative to its {@link #getLeft() left} position.
9267 * This position is post-layout, in addition to wherever the object's
9268 * layout placed it.
9269 *
9270 * @return The horizontal position of this view relative to its left position, in pixels.
9271 */
Chet Haasea5531132012-02-02 13:41:44 -08009272 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009273 public float getTranslationX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009274 return mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0;
Chet Haasedf030d22010-07-30 17:22:38 -07009275 }
9276
9277 /**
9278 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
9279 * This effectively positions the object post-layout, in addition to wherever the object's
9280 * layout placed it.
9281 *
9282 * @param translationX The horizontal position of this view relative to its left position,
9283 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08009284 *
9285 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07009286 */
9287 public void setTranslationX(float translationX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009288 ensureTransformationInfo();
9289 final TransformationInfo info = mTransformationInfo;
9290 if (info.mTranslationX != translationX) {
Chet Haasedf030d22010-07-30 17:22:38 -07009291 // Double-invalidation is necessary to capture view's old and new areas
Chet Haase9d1992d2012-03-13 11:03:25 -07009292 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009293 info.mTranslationX = translationX;
9294 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009295 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009296 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009297 mDisplayList.setTranslationX(translationX);
9298 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009299 }
9300 }
9301
9302 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009303 * The horizontal location of this view relative to its {@link #getTop() top} position.
9304 * This position is post-layout, in addition to wherever the object's
9305 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07009306 *
Chet Haasedf030d22010-07-30 17:22:38 -07009307 * @return The vertical position of this view relative to its top position,
9308 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07009309 */
Chet Haasea5531132012-02-02 13:41:44 -08009310 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009311 public float getTranslationY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009312 return mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07009313 }
9314
9315 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009316 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
9317 * This effectively positions the object post-layout, in addition to wherever the object's
9318 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07009319 *
Chet Haasedf030d22010-07-30 17:22:38 -07009320 * @param translationY The vertical position of this view relative to its top position,
9321 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08009322 *
9323 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07009324 */
Chet Haasedf030d22010-07-30 17:22:38 -07009325 public void setTranslationY(float translationY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009326 ensureTransformationInfo();
9327 final TransformationInfo info = mTransformationInfo;
9328 if (info.mTranslationY != translationY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009329 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009330 info.mTranslationY = translationY;
9331 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009332 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009333 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009334 mDisplayList.setTranslationY(translationY);
9335 }
Chet Haasedf030d22010-07-30 17:22:38 -07009336 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009337 }
9338
9339 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009340 * Hit rectangle in parent's coordinates
9341 *
9342 * @param outRect The hit rectangle of the view.
9343 */
9344 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07009345 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009346 final TransformationInfo info = mTransformationInfo;
9347 if (info == null || info.mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009348 outRect.set(mLeft, mTop, mRight, mBottom);
9349 } else {
9350 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009351 tmpRect.set(-info.mPivotX, -info.mPivotY,
9352 getWidth() - info.mPivotX, getHeight() - info.mPivotY);
9353 info.mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07009354 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
9355 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07009356 }
9357 }
9358
9359 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07009360 * Determines whether the given point, in local coordinates is inside the view.
9361 */
9362 /*package*/ final boolean pointInView(float localX, float localY) {
9363 return localX >= 0 && localX < (mRight - mLeft)
9364 && localY >= 0 && localY < (mBottom - mTop);
9365 }
9366
9367 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07009368 * Utility method to determine whether the given point, in local coordinates,
9369 * is inside the view, where the area of the view is expanded by the slop factor.
9370 * This method is called while processing touch-move events to determine if the event
9371 * is still within the view.
9372 */
9373 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07009374 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07009375 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009376 }
9377
9378 /**
9379 * When a view has focus and the user navigates away from it, the next view is searched for
9380 * starting from the rectangle filled in by this method.
9381 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009382 * By default, the rectange is the {@link #getDrawingRect(android.graphics.Rect)})
9383 * of the view. However, if your view maintains some idea of internal selection,
9384 * such as a cursor, or a selected row or column, you should override this method and
9385 * fill in a more specific rectangle.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009386 *
9387 * @param r The rectangle to fill in, in this view's coordinates.
9388 */
9389 public void getFocusedRect(Rect r) {
9390 getDrawingRect(r);
9391 }
9392
9393 /**
9394 * If some part of this view is not clipped by any of its parents, then
9395 * return that area in r in global (root) coordinates. To convert r to local
Gilles Debunnecea45132011-11-24 02:19:27 +01009396 * coordinates (without taking possible View rotations into account), offset
9397 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)).
9398 * If the view is completely clipped or translated out, return false.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009399 *
9400 * @param r If true is returned, r holds the global coordinates of the
9401 * visible portion of this view.
9402 * @param globalOffset If true is returned, globalOffset holds the dx,dy
9403 * between this view and its root. globalOffet may be null.
9404 * @return true if r is non-empty (i.e. part of the view is visible at the
9405 * root level.
9406 */
9407 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
9408 int width = mRight - mLeft;
9409 int height = mBottom - mTop;
9410 if (width > 0 && height > 0) {
9411 r.set(0, 0, width, height);
9412 if (globalOffset != null) {
9413 globalOffset.set(-mScrollX, -mScrollY);
9414 }
9415 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
9416 }
9417 return false;
9418 }
9419
9420 public final boolean getGlobalVisibleRect(Rect r) {
9421 return getGlobalVisibleRect(r, null);
9422 }
9423
9424 public final boolean getLocalVisibleRect(Rect r) {
Romain Guyab4c4f4f2012-05-06 13:11:24 -07009425 final Point offset = mAttachInfo != null ? mAttachInfo.mPoint : new Point();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009426 if (getGlobalVisibleRect(r, offset)) {
9427 r.offset(-offset.x, -offset.y); // make r local
9428 return true;
9429 }
9430 return false;
9431 }
9432
9433 /**
9434 * Offset this view's vertical location by the specified number of pixels.
9435 *
9436 * @param offset the number of pixels to offset the view by
9437 */
9438 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009439 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07009440 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009441 final boolean matrixIsIdentity = mTransformationInfo == null
9442 || mTransformationInfo.mMatrixIsIdentity;
9443 if (matrixIsIdentity) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009444 if (mDisplayList != null) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009445 invalidateViewProperty(false, false);
9446 } else {
9447 final ViewParent p = mParent;
9448 if (p != null && mAttachInfo != null) {
9449 final Rect r = mAttachInfo.mTmpInvalRect;
9450 int minTop;
9451 int maxBottom;
9452 int yLoc;
9453 if (offset < 0) {
9454 minTop = mTop + offset;
9455 maxBottom = mBottom;
9456 yLoc = offset;
9457 } else {
9458 minTop = mTop;
9459 maxBottom = mBottom + offset;
9460 yLoc = 0;
9461 }
9462 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
9463 p.invalidateChild(this, r);
Chet Haase8fbf8d22010-07-30 15:01:32 -07009464 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009465 }
9466 } else {
Chet Haase9d1992d2012-03-13 11:03:25 -07009467 invalidateViewProperty(false, false);
Chet Haasec3aa3612010-06-17 08:50:37 -07009468 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009469
Chet Haasec3aa3612010-06-17 08:50:37 -07009470 mTop += offset;
9471 mBottom += offset;
Chet Haase1271e2c2012-04-20 09:54:27 -07009472 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009473 mDisplayList.offsetTopBottom(offset);
Chet Haase9d1992d2012-03-13 11:03:25 -07009474 invalidateViewProperty(false, false);
9475 } else {
9476 if (!matrixIsIdentity) {
9477 invalidateViewProperty(false, true);
9478 }
9479 invalidateParentIfNeeded();
Chet Haasea1cff502012-02-21 13:43:44 -08009480 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009481 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009482 }
9483
9484 /**
9485 * Offset this view's horizontal location by the specified amount of pixels.
9486 *
9487 * @param offset the numer of pixels to offset the view by
9488 */
9489 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009490 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07009491 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009492 final boolean matrixIsIdentity = mTransformationInfo == null
9493 || mTransformationInfo.mMatrixIsIdentity;
9494 if (matrixIsIdentity) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009495 if (mDisplayList != null) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009496 invalidateViewProperty(false, false);
9497 } else {
9498 final ViewParent p = mParent;
9499 if (p != null && mAttachInfo != null) {
9500 final Rect r = mAttachInfo.mTmpInvalRect;
9501 int minLeft;
9502 int maxRight;
9503 if (offset < 0) {
9504 minLeft = mLeft + offset;
9505 maxRight = mRight;
9506 } else {
9507 minLeft = mLeft;
9508 maxRight = mRight + offset;
9509 }
9510 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
9511 p.invalidateChild(this, r);
Chet Haase8fbf8d22010-07-30 15:01:32 -07009512 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009513 }
9514 } else {
Chet Haase9d1992d2012-03-13 11:03:25 -07009515 invalidateViewProperty(false, false);
Chet Haasec3aa3612010-06-17 08:50:37 -07009516 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009517
Chet Haasec3aa3612010-06-17 08:50:37 -07009518 mLeft += offset;
9519 mRight += offset;
Chet Haase1271e2c2012-04-20 09:54:27 -07009520 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009521 mDisplayList.offsetLeftRight(offset);
Chet Haase9d1992d2012-03-13 11:03:25 -07009522 invalidateViewProperty(false, false);
9523 } else {
9524 if (!matrixIsIdentity) {
9525 invalidateViewProperty(false, true);
9526 }
9527 invalidateParentIfNeeded();
Chet Haasea1cff502012-02-21 13:43:44 -08009528 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009529 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009530 }
9531
9532 /**
9533 * Get the LayoutParams associated with this view. All views should have
9534 * layout parameters. These supply parameters to the <i>parent</i> of this
9535 * view specifying how it should be arranged. There are many subclasses of
9536 * ViewGroup.LayoutParams, and these correspond to the different subclasses
9537 * of ViewGroup that are responsible for arranging their children.
Romain Guy01c174b2011-02-22 11:51:06 -08009538 *
9539 * This method may return null if this View is not attached to a parent
9540 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)}
9541 * was not invoked successfully. When a View is attached to a parent
9542 * ViewGroup, this method must not return null.
9543 *
9544 * @return The LayoutParams associated with this view, or null if no
9545 * parameters have been set yet
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009546 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07009547 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009548 public ViewGroup.LayoutParams getLayoutParams() {
9549 return mLayoutParams;
9550 }
9551
9552 /**
9553 * Set the layout parameters associated with this view. These supply
9554 * parameters to the <i>parent</i> of this view specifying how it should be
9555 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
9556 * correspond to the different subclasses of ViewGroup that are responsible
9557 * for arranging their children.
9558 *
Romain Guy01c174b2011-02-22 11:51:06 -08009559 * @param params The layout parameters for this view, cannot be null
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009560 */
9561 public void setLayoutParams(ViewGroup.LayoutParams params) {
9562 if (params == null) {
Romain Guy01c174b2011-02-22 11:51:06 -08009563 throw new NullPointerException("Layout parameters cannot be null");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009564 }
9565 mLayoutParams = params;
Philip Milned7dd8902012-01-26 16:55:30 -08009566 if (mParent instanceof ViewGroup) {
9567 ((ViewGroup) mParent).onSetLayoutParams(this, params);
9568 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009569 requestLayout();
9570 }
9571
9572 /**
9573 * Set the scrolled position of your view. This will cause a call to
9574 * {@link #onScrollChanged(int, int, int, int)} and the view will be
9575 * invalidated.
9576 * @param x the x position to scroll to
9577 * @param y the y position to scroll to
9578 */
9579 public void scrollTo(int x, int y) {
9580 if (mScrollX != x || mScrollY != y) {
9581 int oldX = mScrollX;
9582 int oldY = mScrollY;
9583 mScrollX = x;
9584 mScrollY = y;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009585 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009586 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07009587 if (!awakenScrollBars()) {
Adam Powelldf3ae4f2012-04-10 18:55:22 -07009588 postInvalidateOnAnimation();
Mike Cleronf116bf82009-09-27 19:14:12 -07009589 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009590 }
9591 }
9592
9593 /**
9594 * Move the scrolled position of your view. This will cause a call to
9595 * {@link #onScrollChanged(int, int, int, int)} and the view will be
9596 * invalidated.
9597 * @param x the amount of pixels to scroll by horizontally
9598 * @param y the amount of pixels to scroll by vertically
9599 */
9600 public void scrollBy(int x, int y) {
9601 scrollTo(mScrollX + x, mScrollY + y);
9602 }
9603
9604 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07009605 * <p>Trigger the scrollbars to draw. When invoked this method starts an
9606 * animation to fade the scrollbars out after a default delay. If a subclass
9607 * provides animated scrolling, the start delay should equal the duration
9608 * of the scrolling animation.</p>
9609 *
9610 * <p>The animation starts only if at least one of the scrollbars is
9611 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
9612 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9613 * this method returns true, and false otherwise. If the animation is
9614 * started, this method calls {@link #invalidate()}; in that case the
9615 * caller should not call {@link #invalidate()}.</p>
9616 *
9617 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07009618 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07009619 *
9620 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
9621 * and {@link #scrollTo(int, int)}.</p>
9622 *
9623 * @return true if the animation is played, false otherwise
9624 *
9625 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07009626 * @see #scrollBy(int, int)
9627 * @see #scrollTo(int, int)
9628 * @see #isHorizontalScrollBarEnabled()
9629 * @see #isVerticalScrollBarEnabled()
9630 * @see #setHorizontalScrollBarEnabled(boolean)
9631 * @see #setVerticalScrollBarEnabled(boolean)
9632 */
9633 protected boolean awakenScrollBars() {
9634 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07009635 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07009636 }
9637
9638 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07009639 * Trigger the scrollbars to draw.
9640 * This method differs from awakenScrollBars() only in its default duration.
9641 * initialAwakenScrollBars() will show the scroll bars for longer than
9642 * usual to give the user more of a chance to notice them.
9643 *
9644 * @return true if the animation is played, false otherwise.
9645 */
9646 private boolean initialAwakenScrollBars() {
9647 return mScrollCache != null &&
9648 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
9649 }
9650
9651 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07009652 * <p>
9653 * Trigger the scrollbars to draw. When invoked this method starts an
9654 * animation to fade the scrollbars out after a fixed delay. If a subclass
9655 * provides animated scrolling, the start delay should equal the duration of
9656 * the scrolling animation.
9657 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009658 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009659 * <p>
9660 * The animation starts only if at least one of the scrollbars is enabled,
9661 * as specified by {@link #isHorizontalScrollBarEnabled()} and
9662 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9663 * this method returns true, and false otherwise. If the animation is
9664 * started, this method calls {@link #invalidate()}; in that case the caller
9665 * should not call {@link #invalidate()}.
9666 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009667 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009668 * <p>
9669 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07009670 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07009671 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009672 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009673 * @param startDelay the delay, in milliseconds, after which the animation
9674 * should start; when the delay is 0, the animation starts
9675 * immediately
9676 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08009677 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009678 * @see #scrollBy(int, int)
9679 * @see #scrollTo(int, int)
9680 * @see #isHorizontalScrollBarEnabled()
9681 * @see #isVerticalScrollBarEnabled()
9682 * @see #setHorizontalScrollBarEnabled(boolean)
9683 * @see #setVerticalScrollBarEnabled(boolean)
9684 */
9685 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07009686 return awakenScrollBars(startDelay, true);
9687 }
Joe Malin32736f02011-01-19 16:14:20 -08009688
Mike Cleron290947b2009-09-29 18:34:32 -07009689 /**
9690 * <p>
9691 * Trigger the scrollbars to draw. When invoked this method starts an
9692 * animation to fade the scrollbars out after a fixed delay. If a subclass
9693 * provides animated scrolling, the start delay should equal the duration of
9694 * the scrolling animation.
9695 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009696 *
Mike Cleron290947b2009-09-29 18:34:32 -07009697 * <p>
9698 * The animation starts only if at least one of the scrollbars is enabled,
9699 * as specified by {@link #isHorizontalScrollBarEnabled()} and
9700 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9701 * this method returns true, and false otherwise. If the animation is
Joe Malin32736f02011-01-19 16:14:20 -08009702 * started, this method calls {@link #invalidate()} if the invalidate parameter
Mike Cleron290947b2009-09-29 18:34:32 -07009703 * is set to true; in that case the caller
9704 * should not call {@link #invalidate()}.
9705 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009706 *
Mike Cleron290947b2009-09-29 18:34:32 -07009707 * <p>
9708 * This method should be invoked everytime a subclass directly updates the
9709 * scroll parameters.
9710 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009711 *
Mike Cleron290947b2009-09-29 18:34:32 -07009712 * @param startDelay the delay, in milliseconds, after which the animation
9713 * should start; when the delay is 0, the animation starts
9714 * immediately
Joe Malin32736f02011-01-19 16:14:20 -08009715 *
Mike Cleron290947b2009-09-29 18:34:32 -07009716 * @param invalidate Wheter this method should call invalidate
Joe Malin32736f02011-01-19 16:14:20 -08009717 *
Mike Cleron290947b2009-09-29 18:34:32 -07009718 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08009719 *
Mike Cleron290947b2009-09-29 18:34:32 -07009720 * @see #scrollBy(int, int)
9721 * @see #scrollTo(int, int)
9722 * @see #isHorizontalScrollBarEnabled()
9723 * @see #isVerticalScrollBarEnabled()
9724 * @see #setHorizontalScrollBarEnabled(boolean)
9725 * @see #setVerticalScrollBarEnabled(boolean)
9726 */
9727 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07009728 final ScrollabilityCache scrollCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08009729
Mike Cleronf116bf82009-09-27 19:14:12 -07009730 if (scrollCache == null || !scrollCache.fadeScrollBars) {
9731 return false;
9732 }
9733
9734 if (scrollCache.scrollBar == null) {
9735 scrollCache.scrollBar = new ScrollBarDrawable();
9736 }
9737
9738 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
9739
Mike Cleron290947b2009-09-29 18:34:32 -07009740 if (invalidate) {
9741 // Invalidate to show the scrollbars
Adam Powelldf3ae4f2012-04-10 18:55:22 -07009742 postInvalidateOnAnimation();
Mike Cleron290947b2009-09-29 18:34:32 -07009743 }
Mike Cleronf116bf82009-09-27 19:14:12 -07009744
9745 if (scrollCache.state == ScrollabilityCache.OFF) {
9746 // FIXME: this is copied from WindowManagerService.
9747 // We should get this value from the system when it
9748 // is possible to do so.
9749 final int KEY_REPEAT_FIRST_DELAY = 750;
9750 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
9751 }
9752
9753 // Tell mScrollCache when we should start fading. This may
9754 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07009755 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07009756 scrollCache.fadeStartTime = fadeStartTime;
9757 scrollCache.state = ScrollabilityCache.ON;
9758
9759 // Schedule our fader to run, unscheduling any old ones first
9760 if (mAttachInfo != null) {
9761 mAttachInfo.mHandler.removeCallbacks(scrollCache);
9762 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
9763 }
9764
9765 return true;
9766 }
9767
9768 return false;
9769 }
9770
9771 /**
Chet Haaseaceafe62011-08-26 15:44:33 -07009772 * Do not invalidate views which are not visible and which are not running an animation. They
9773 * will not get drawn and they should not set dirty flags as if they will be drawn
9774 */
9775 private boolean skipInvalidate() {
9776 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null &&
9777 (!(mParent instanceof ViewGroup) ||
9778 !((ViewGroup) mParent).isViewTransitioning(this));
9779 }
9780 /**
Joe Fernandez558459f2011-10-13 16:47:36 -07009781 * Mark the area defined by dirty as needing to be drawn. If the view is
Romain Guy5c22a8c2011-05-13 11:48:45 -07009782 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some point
9783 * in the future. This must be called from a UI thread. To call from a non-UI
9784 * thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009785 *
9786 * WARNING: This method is destructive to dirty.
9787 * @param dirty the rectangle representing the bounds of the dirty region
9788 */
9789 public void invalidate(Rect dirty) {
9790 if (ViewDebug.TRACE_HIERARCHY) {
9791 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
9792 }
9793
Chet Haaseaceafe62011-08-26 15:44:33 -07009794 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -07009795 return;
9796 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009797 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08009798 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
9799 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009800 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08009801 mPrivateFlags |= INVALIDATED;
Chet Haasef186f302011-09-11 11:06:06 -07009802 mPrivateFlags |= DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009803 final ViewParent p = mParent;
9804 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08009805 //noinspection PointlessBooleanExpression,ConstantConditions
9806 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
9807 if (p != null && ai != null && ai.mHardwareAccelerated) {
9808 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07009809 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08009810 p.invalidateChild(this, null);
9811 return;
9812 }
Romain Guyaf636eb2010-12-09 17:47:21 -08009813 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009814 if (p != null && ai != null) {
9815 final int scrollX = mScrollX;
9816 final int scrollY = mScrollY;
9817 final Rect r = ai.mTmpInvalRect;
9818 r.set(dirty.left - scrollX, dirty.top - scrollY,
9819 dirty.right - scrollX, dirty.bottom - scrollY);
9820 mParent.invalidateChild(this, r);
9821 }
9822 }
9823 }
9824
9825 /**
Joe Fernandez558459f2011-10-13 16:47:36 -07009826 * 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 -08009827 * The coordinates of the dirty rect are relative to the view.
Romain Guy5c22a8c2011-05-13 11:48:45 -07009828 * If the view is visible, {@link #onDraw(android.graphics.Canvas)}
9829 * will be called at some point in the future. This must be called from
9830 * a UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009831 * @param l the left position of the dirty region
9832 * @param t the top position of the dirty region
9833 * @param r the right position of the dirty region
9834 * @param b the bottom position of the dirty region
9835 */
9836 public void invalidate(int l, int t, int r, int b) {
9837 if (ViewDebug.TRACE_HIERARCHY) {
9838 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
9839 }
9840
Chet Haaseaceafe62011-08-26 15:44:33 -07009841 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -07009842 return;
9843 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009844 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08009845 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
9846 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009847 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08009848 mPrivateFlags |= INVALIDATED;
Chet Haasef186f302011-09-11 11:06:06 -07009849 mPrivateFlags |= DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009850 final ViewParent p = mParent;
9851 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08009852 //noinspection PointlessBooleanExpression,ConstantConditions
9853 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
9854 if (p != null && ai != null && ai.mHardwareAccelerated) {
9855 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07009856 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08009857 p.invalidateChild(this, null);
9858 return;
9859 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08009860 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009861 if (p != null && ai != null && l < r && t < b) {
9862 final int scrollX = mScrollX;
9863 final int scrollY = mScrollY;
9864 final Rect tmpr = ai.mTmpInvalRect;
9865 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
9866 p.invalidateChild(this, tmpr);
9867 }
9868 }
9869 }
9870
9871 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07009872 * Invalidate the whole view. If the view is visible,
9873 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in
9874 * the future. This must be called from a UI thread. To call from a non-UI thread,
9875 * call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009876 */
9877 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -07009878 invalidate(true);
9879 }
Joe Malin32736f02011-01-19 16:14:20 -08009880
Chet Haaseed032702010-10-01 14:05:54 -07009881 /**
9882 * This is where the invalidate() work actually happens. A full invalidate()
9883 * causes the drawing cache to be invalidated, but this function can be called with
9884 * invalidateCache set to false to skip that invalidation step for cases that do not
9885 * need it (for example, a component that remains at the same dimensions with the same
9886 * content).
9887 *
9888 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
9889 * well. This is usually true for a full invalidate, but may be set to false if the
9890 * View's contents or dimensions have not changed.
9891 */
Romain Guy849d0a32011-02-01 17:20:48 -08009892 void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009893 if (ViewDebug.TRACE_HIERARCHY) {
9894 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
9895 }
9896
Chet Haaseaceafe62011-08-26 15:44:33 -07009897 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -07009898 return;
9899 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009900 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Romain Guyc5d55862011-01-21 19:01:46 -08009901 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) ||
Romain Guy0fd89bf2011-01-26 15:41:30 -08009902 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) {
9903 mLastIsOpaque = isOpaque();
Chet Haaseed032702010-10-01 14:05:54 -07009904 mPrivateFlags &= ~DRAWN;
Chet Haasef186f302011-09-11 11:06:06 -07009905 mPrivateFlags |= DIRTY;
Chet Haaseed032702010-10-01 14:05:54 -07009906 if (invalidateCache) {
Chet Haasedaf98e92011-01-10 14:10:36 -08009907 mPrivateFlags |= INVALIDATED;
Chet Haaseed032702010-10-01 14:05:54 -07009908 mPrivateFlags &= ~DRAWING_CACHE_VALID;
9909 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009910 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -07009911 final ViewParent p = mParent;
Romain Guy7d7b5492011-01-24 16:33:45 -08009912 //noinspection PointlessBooleanExpression,ConstantConditions
9913 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
9914 if (p != null && ai != null && ai.mHardwareAccelerated) {
9915 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07009916 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08009917 p.invalidateChild(this, null);
9918 return;
9919 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08009920 }
Michael Jurkaebefea42010-11-15 16:04:01 -08009921
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009922 if (p != null && ai != null) {
9923 final Rect r = ai.mTmpInvalRect;
9924 r.set(0, 0, mRight - mLeft, mBottom - mTop);
9925 // Don't call invalidate -- we don't want to internally scroll
9926 // our own bounds
9927 p.invalidateChild(this, r);
9928 }
9929 }
9930 }
9931
9932 /**
Chet Haase9d1992d2012-03-13 11:03:25 -07009933 * Quick invalidation for View property changes (alpha, translationXY, etc.). We don't want to
9934 * set any flags or handle all of the cases handled by the default invalidation methods.
9935 * Instead, we just want to schedule a traversal in ViewRootImpl with the appropriate
9936 * dirty rect. This method calls into fast invalidation methods in ViewGroup that
9937 * walk up the hierarchy, transforming the dirty rect as necessary.
9938 *
9939 * The method also handles normal invalidation logic if display list properties are not
9940 * being used in this view. The invalidateParent and forceRedraw flags are used by that
9941 * backup approach, to handle these cases used in the various property-setting methods.
9942 *
9943 * @param invalidateParent Force a call to invalidateParentCaches() if display list properties
9944 * are not being used in this view
9945 * @param forceRedraw Mark the view as DRAWN to force the invalidation to propagate, if display
9946 * list properties are not being used in this view
9947 */
9948 void invalidateViewProperty(boolean invalidateParent, boolean forceRedraw) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009949 if (mDisplayList == null || (mPrivateFlags & DRAW_ANIMATION) == DRAW_ANIMATION) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009950 if (invalidateParent) {
9951 invalidateParentCaches();
9952 }
9953 if (forceRedraw) {
9954 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
9955 }
9956 invalidate(false);
9957 } else {
9958 final AttachInfo ai = mAttachInfo;
9959 final ViewParent p = mParent;
9960 if (p != null && ai != null) {
9961 final Rect r = ai.mTmpInvalRect;
9962 r.set(0, 0, mRight - mLeft, mBottom - mTop);
9963 if (mParent instanceof ViewGroup) {
9964 ((ViewGroup) mParent).invalidateChildFast(this, r);
9965 } else {
9966 mParent.invalidateChild(this, r);
9967 }
9968 }
9969 }
9970 }
9971
9972 /**
9973 * Utility method to transform a given Rect by the current matrix of this view.
9974 */
9975 void transformRect(final Rect rect) {
9976 if (!getMatrix().isIdentity()) {
9977 RectF boundingRect = mAttachInfo.mTmpTransformRect;
9978 boundingRect.set(rect);
9979 getMatrix().mapRect(boundingRect);
9980 rect.set((int) (boundingRect.left - 0.5f),
9981 (int) (boundingRect.top - 0.5f),
9982 (int) (boundingRect.right + 0.5f),
9983 (int) (boundingRect.bottom + 0.5f));
9984 }
9985 }
9986
9987 /**
Romain Guy0fd89bf2011-01-26 15:41:30 -08009988 * Used to indicate that the parent of this view should clear its caches. This functionality
Chet Haasedaf98e92011-01-10 14:10:36 -08009989 * is used to force the parent to rebuild its display list (when hardware-accelerated),
9990 * which is necessary when various parent-managed properties of the view change, such as
Romain Guy0fd89bf2011-01-26 15:41:30 -08009991 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only
9992 * clears the parent caches and does not causes an invalidate event.
Chet Haasedaf98e92011-01-10 14:10:36 -08009993 *
9994 * @hide
9995 */
Romain Guy0fd89bf2011-01-26 15:41:30 -08009996 protected void invalidateParentCaches() {
9997 if (mParent instanceof View) {
9998 ((View) mParent).mPrivateFlags |= INVALIDATED;
9999 }
10000 }
Joe Malin32736f02011-01-19 16:14:20 -080010001
Romain Guy0fd89bf2011-01-26 15:41:30 -080010002 /**
10003 * Used to indicate that the parent of this view should be invalidated. This functionality
10004 * is used to force the parent to rebuild its display list (when hardware-accelerated),
10005 * which is necessary when various parent-managed properties of the view change, such as
10006 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate
10007 * an invalidation event to the parent.
10008 *
10009 * @hide
10010 */
10011 protected void invalidateParentIfNeeded() {
Chet Haasedaf98e92011-01-10 14:10:36 -080010012 if (isHardwareAccelerated() && mParent instanceof View) {
Romain Guy0fd89bf2011-01-26 15:41:30 -080010013 ((View) mParent).invalidate(true);
Chet Haasedaf98e92011-01-10 14:10:36 -080010014 }
10015 }
10016
10017 /**
Romain Guy24443ea2009-05-11 11:56:30 -070010018 * Indicates whether this View is opaque. An opaque View guarantees that it will
10019 * draw all the pixels overlapping its bounds using a fully opaque color.
10020 *
10021 * Subclasses of View should override this method whenever possible to indicate
10022 * whether an instance is opaque. Opaque Views are treated in a special way by
10023 * the View hierarchy, possibly allowing it to perform optimizations during
10024 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -070010025 *
Romain Guy24443ea2009-05-11 11:56:30 -070010026 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -070010027 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070010028 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -070010029 public boolean isOpaque() {
Chet Haase70d4ba12010-10-06 09:46:45 -070010030 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK &&
Dianne Hackbornddb715b2011-09-09 14:43:39 -070010031 ((mTransformationInfo != null ? mTransformationInfo.mAlpha : 1)
10032 >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD);
Romain Guy8f1344f52009-05-15 16:03:59 -070010033 }
10034
Adam Powell20232d02010-12-08 21:08:53 -080010035 /**
10036 * @hide
10037 */
10038 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -070010039 // Opaque if:
10040 // - Has a background
10041 // - Background is opaque
10042 // - Doesn't have scrollbars or scrollbars are inside overlay
10043
Philip Milne6c8ea062012-04-03 17:38:43 -070010044 if (mBackground != null && mBackground.getOpacity() == PixelFormat.OPAQUE) {
Romain Guy8f1344f52009-05-15 16:03:59 -070010045 mPrivateFlags |= OPAQUE_BACKGROUND;
10046 } else {
10047 mPrivateFlags &= ~OPAQUE_BACKGROUND;
10048 }
10049
10050 final int flags = mViewFlags;
10051 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
10052 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
10053 mPrivateFlags |= OPAQUE_SCROLLBARS;
10054 } else {
10055 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
10056 }
10057 }
10058
10059 /**
10060 * @hide
10061 */
10062 protected boolean hasOpaqueScrollbars() {
10063 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -070010064 }
10065
10066 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010067 * @return A handler associated with the thread running the View. This
10068 * handler can be used to pump events in the UI events queue.
10069 */
10070 public Handler getHandler() {
10071 if (mAttachInfo != null) {
10072 return mAttachInfo.mHandler;
10073 }
10074 return null;
10075 }
10076
10077 /**
Jeff Browna175a5b2012-02-15 19:18:31 -080010078 * Gets the view root associated with the View.
10079 * @return The view root, or null if none.
10080 * @hide
10081 */
10082 public ViewRootImpl getViewRootImpl() {
10083 if (mAttachInfo != null) {
10084 return mAttachInfo.mViewRootImpl;
10085 }
10086 return null;
10087 }
10088
10089 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010090 * <p>Causes the Runnable to be added to the message queue.
10091 * The runnable will be run on the user interface thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010092 *
Romain Guye63a4f32011-08-11 11:33:31 -070010093 * <p>This method can be invoked from outside of the UI thread
10094 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010095 *
10096 * @param action The Runnable that will be executed.
10097 *
10098 * @return Returns true if the Runnable was successfully placed in to the
10099 * message queue. Returns false on failure, usually because the
10100 * looper processing the message queue is exiting.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010101 *
10102 * @see #postDelayed
10103 * @see #removeCallbacks
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010104 */
10105 public boolean post(Runnable action) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010106 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010107 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010108 return attachInfo.mHandler.post(action);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010109 }
Jeff Browna175a5b2012-02-15 19:18:31 -080010110 // Assume that post will succeed later
10111 ViewRootImpl.getRunQueue().post(action);
10112 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010113 }
10114
10115 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010116 * <p>Causes the Runnable to be added to the message queue, to be run
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010117 * after the specified amount of time elapses.
Romain Guye63a4f32011-08-11 11:33:31 -070010118 * The runnable will be run on the user interface thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010119 *
Romain Guye63a4f32011-08-11 11:33:31 -070010120 * <p>This method can be invoked from outside of the UI thread
10121 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010122 *
10123 * @param action The Runnable that will be executed.
10124 * @param delayMillis The delay (in milliseconds) until the Runnable
10125 * will be executed.
10126 *
10127 * @return true if the Runnable was successfully placed in to the
10128 * message queue. Returns false on failure, usually because the
10129 * looper processing the message queue is exiting. Note that a
10130 * result of true does not mean the Runnable will be processed --
10131 * if the looper is quit before the delivery time of the message
10132 * occurs then the message will be dropped.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010133 *
10134 * @see #post
10135 * @see #removeCallbacks
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010136 */
10137 public boolean postDelayed(Runnable action, long delayMillis) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010138 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010139 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010140 return attachInfo.mHandler.postDelayed(action, delayMillis);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010141 }
Jeff Browna175a5b2012-02-15 19:18:31 -080010142 // Assume that post will succeed later
10143 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
10144 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010145 }
10146
10147 /**
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010148 * <p>Causes the Runnable to execute on the next animation time step.
10149 * The runnable will be run on the user interface thread.</p>
10150 *
10151 * <p>This method can be invoked from outside of the UI thread
10152 * only when this View is attached to a window.</p>
10153 *
10154 * @param action The Runnable that will be executed.
10155 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010156 * @see #postOnAnimationDelayed
10157 * @see #removeCallbacks
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010158 */
10159 public void postOnAnimation(Runnable action) {
10160 final AttachInfo attachInfo = mAttachInfo;
10161 if (attachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010162 attachInfo.mViewRootImpl.mChoreographer.postCallback(
10163 Choreographer.CALLBACK_ANIMATION, action, null);
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010164 } else {
10165 // Assume that post will succeed later
10166 ViewRootImpl.getRunQueue().post(action);
10167 }
10168 }
10169
10170 /**
10171 * <p>Causes the Runnable to execute on the next animation time step,
10172 * after the specified amount of time elapses.
10173 * The runnable will be run on the user interface thread.</p>
10174 *
10175 * <p>This method can be invoked from outside of the UI thread
10176 * only when this View is attached to a window.</p>
10177 *
10178 * @param action The Runnable that will be executed.
10179 * @param delayMillis The delay (in milliseconds) until the Runnable
10180 * will be executed.
10181 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010182 * @see #postOnAnimation
10183 * @see #removeCallbacks
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010184 */
10185 public void postOnAnimationDelayed(Runnable action, long delayMillis) {
10186 final AttachInfo attachInfo = mAttachInfo;
10187 if (attachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010188 attachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed(
10189 Choreographer.CALLBACK_ANIMATION, action, null, delayMillis);
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010190 } else {
10191 // Assume that post will succeed later
10192 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
10193 }
10194 }
10195
10196 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010197 * <p>Removes the specified Runnable from the message queue.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010198 *
Romain Guye63a4f32011-08-11 11:33:31 -070010199 * <p>This method can be invoked from outside of the UI thread
10200 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010201 *
10202 * @param action The Runnable to remove from the message handling queue
10203 *
10204 * @return true if this view could ask the Handler to remove the Runnable,
10205 * false otherwise. When the returned value is true, the Runnable
10206 * may or may not have been actually removed from the message queue
10207 * (for instance, if the Runnable was not in the queue already.)
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010208 *
10209 * @see #post
10210 * @see #postDelayed
10211 * @see #postOnAnimation
10212 * @see #postOnAnimationDelayed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010213 */
10214 public boolean removeCallbacks(Runnable action) {
Jeff Brown43ea54b2012-03-09 14:37:48 -080010215 if (action != null) {
10216 final AttachInfo attachInfo = mAttachInfo;
10217 if (attachInfo != null) {
10218 attachInfo.mHandler.removeCallbacks(action);
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010219 attachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
10220 Choreographer.CALLBACK_ANIMATION, action, null);
Jeff Brown43ea54b2012-03-09 14:37:48 -080010221 } else {
10222 // Assume that post will succeed later
10223 ViewRootImpl.getRunQueue().removeCallbacks(action);
10224 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010225 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010226 return true;
10227 }
10228
10229 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010230 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop.
10231 * Use this to invalidate the View from a non-UI thread.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010232 *
Romain Guye63a4f32011-08-11 11:33:31 -070010233 * <p>This method can be invoked from outside of the UI thread
10234 * only when this View is attached to a window.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010235 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010236 * @see #invalidate()
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010237 * @see #postInvalidateDelayed(long)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010238 */
10239 public void postInvalidate() {
10240 postInvalidateDelayed(0);
10241 }
10242
10243 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010244 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
10245 * through the event loop. Use this to invalidate the View from a non-UI thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010246 *
Romain Guye63a4f32011-08-11 11:33:31 -070010247 * <p>This method can be invoked from outside of the UI thread
10248 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010249 *
10250 * @param left The left coordinate of the rectangle to invalidate.
10251 * @param top The top coordinate of the rectangle to invalidate.
10252 * @param right The right coordinate of the rectangle to invalidate.
10253 * @param bottom The bottom coordinate of the rectangle to invalidate.
10254 *
10255 * @see #invalidate(int, int, int, int)
10256 * @see #invalidate(Rect)
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010257 * @see #postInvalidateDelayed(long, int, int, int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010258 */
10259 public void postInvalidate(int left, int top, int right, int bottom) {
10260 postInvalidateDelayed(0, left, top, right, bottom);
10261 }
10262
10263 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010264 * <p>Cause an invalidate to happen on a subsequent cycle through the event
10265 * loop. Waits for the specified amount of time.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010266 *
Romain Guye63a4f32011-08-11 11:33:31 -070010267 * <p>This method can be invoked from outside of the UI thread
10268 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010269 *
10270 * @param delayMilliseconds the duration in milliseconds to delay the
10271 * invalidation by
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010272 *
10273 * @see #invalidate()
10274 * @see #postInvalidate()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010275 */
10276 public void postInvalidateDelayed(long delayMilliseconds) {
10277 // We try only with the AttachInfo because there's no point in invalidating
10278 // if we are not attached to our window
Jeff Browna175a5b2012-02-15 19:18:31 -080010279 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010280 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010281 attachInfo.mViewRootImpl.dispatchInvalidateDelayed(this, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010282 }
10283 }
10284
10285 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010286 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
10287 * through the event loop. Waits for the specified amount of time.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010288 *
Romain Guye63a4f32011-08-11 11:33:31 -070010289 * <p>This method can be invoked from outside of the UI thread
10290 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010291 *
10292 * @param delayMilliseconds the duration in milliseconds to delay the
10293 * invalidation by
10294 * @param left The left coordinate of the rectangle to invalidate.
10295 * @param top The top coordinate of the rectangle to invalidate.
10296 * @param right The right coordinate of the rectangle to invalidate.
10297 * @param bottom The bottom coordinate of the rectangle to invalidate.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010298 *
10299 * @see #invalidate(int, int, int, int)
10300 * @see #invalidate(Rect)
10301 * @see #postInvalidate(int, int, int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010302 */
10303 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
10304 int right, int bottom) {
10305
10306 // We try only with the AttachInfo because there's no point in invalidating
10307 // if we are not attached to our window
Jeff Browna175a5b2012-02-15 19:18:31 -080010308 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010309 if (attachInfo != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010310 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
10311 info.target = this;
10312 info.left = left;
10313 info.top = top;
10314 info.right = right;
10315 info.bottom = bottom;
10316
Jeff Browna175a5b2012-02-15 19:18:31 -080010317 attachInfo.mViewRootImpl.dispatchInvalidateRectDelayed(info, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010318 }
10319 }
10320
10321 /**
Jeff Brown6cb7b462012-03-05 13:21:17 -080010322 * <p>Cause an invalidate to happen on the next animation time step, typically the
10323 * next display frame.</p>
10324 *
10325 * <p>This method can be invoked from outside of the UI thread
10326 * only when this View is attached to a window.</p>
10327 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010328 * @see #invalidate()
Jeff Brown6cb7b462012-03-05 13:21:17 -080010329 */
10330 public void postInvalidateOnAnimation() {
10331 // We try only with the AttachInfo because there's no point in invalidating
10332 // if we are not attached to our window
10333 final AttachInfo attachInfo = mAttachInfo;
10334 if (attachInfo != null) {
10335 attachInfo.mViewRootImpl.dispatchInvalidateOnAnimation(this);
10336 }
10337 }
10338
10339 /**
10340 * <p>Cause an invalidate of the specified area to happen on the next animation
10341 * time step, typically the next display frame.</p>
10342 *
10343 * <p>This method can be invoked from outside of the UI thread
10344 * only when this View is attached to a window.</p>
10345 *
10346 * @param left The left coordinate of the rectangle to invalidate.
10347 * @param top The top coordinate of the rectangle to invalidate.
10348 * @param right The right coordinate of the rectangle to invalidate.
10349 * @param bottom The bottom coordinate of the rectangle to invalidate.
10350 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010351 * @see #invalidate(int, int, int, int)
10352 * @see #invalidate(Rect)
Jeff Brown6cb7b462012-03-05 13:21:17 -080010353 */
10354 public void postInvalidateOnAnimation(int left, int top, int right, int bottom) {
10355 // We try only with the AttachInfo because there's no point in invalidating
10356 // if we are not attached to our window
10357 final AttachInfo attachInfo = mAttachInfo;
10358 if (attachInfo != null) {
10359 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
10360 info.target = this;
10361 info.left = left;
10362 info.top = top;
10363 info.right = right;
10364 info.bottom = bottom;
10365
10366 attachInfo.mViewRootImpl.dispatchInvalidateRectOnAnimation(info);
10367 }
10368 }
10369
10370 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -070010371 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event.
10372 * This event is sent at most once every
10373 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}.
10374 */
10375 private void postSendViewScrolledAccessibilityEventCallback() {
10376 if (mSendViewScrolledAccessibilityEvent == null) {
10377 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent();
10378 }
10379 if (!mSendViewScrolledAccessibilityEvent.mIsPending) {
10380 mSendViewScrolledAccessibilityEvent.mIsPending = true;
10381 postDelayed(mSendViewScrolledAccessibilityEvent,
10382 ViewConfiguration.getSendRecurringAccessibilityEventsInterval());
10383 }
10384 }
10385
10386 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010387 * Called by a parent to request that a child update its values for mScrollX
10388 * and mScrollY if necessary. This will typically be done if the child is
10389 * animating a scroll using a {@link android.widget.Scroller Scroller}
10390 * object.
10391 */
10392 public void computeScroll() {
10393 }
10394
10395 /**
10396 * <p>Indicate whether the horizontal edges are faded when the view is
10397 * scrolled horizontally.</p>
10398 *
10399 * @return true if the horizontal edges should are faded on scroll, false
10400 * otherwise
10401 *
10402 * @see #setHorizontalFadingEdgeEnabled(boolean)
Philip Milne6c8ea062012-04-03 17:38:43 -070010403 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010404 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010405 */
10406 public boolean isHorizontalFadingEdgeEnabled() {
10407 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
10408 }
10409
10410 /**
10411 * <p>Define whether the horizontal edges should be faded when this view
10412 * is scrolled horizontally.</p>
10413 *
10414 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
10415 * be faded when the view is scrolled
10416 * horizontally
10417 *
10418 * @see #isHorizontalFadingEdgeEnabled()
Philip Milne6c8ea062012-04-03 17:38:43 -070010419 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010420 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010421 */
10422 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
10423 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
10424 if (horizontalFadingEdgeEnabled) {
10425 initScrollCache();
10426 }
10427
10428 mViewFlags ^= FADING_EDGE_HORIZONTAL;
10429 }
10430 }
10431
10432 /**
10433 * <p>Indicate whether the vertical edges are faded when the view is
10434 * scrolled horizontally.</p>
10435 *
10436 * @return true if the vertical edges should are faded on scroll, false
10437 * otherwise
10438 *
10439 * @see #setVerticalFadingEdgeEnabled(boolean)
Philip Milne6c8ea062012-04-03 17:38:43 -070010440 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010441 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010442 */
10443 public boolean isVerticalFadingEdgeEnabled() {
10444 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
10445 }
10446
10447 /**
10448 * <p>Define whether the vertical edges should be faded when this view
10449 * is scrolled vertically.</p>
10450 *
10451 * @param verticalFadingEdgeEnabled true if the vertical edges should
10452 * be faded when the view is scrolled
10453 * vertically
10454 *
10455 * @see #isVerticalFadingEdgeEnabled()
Philip Milne6c8ea062012-04-03 17:38:43 -070010456 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010457 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010458 */
10459 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
10460 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
10461 if (verticalFadingEdgeEnabled) {
10462 initScrollCache();
10463 }
10464
10465 mViewFlags ^= FADING_EDGE_VERTICAL;
10466 }
10467 }
10468
10469 /**
10470 * Returns the strength, or intensity, of the top faded edge. The strength is
10471 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10472 * returns 0.0 or 1.0 but no value in between.
10473 *
10474 * Subclasses should override this method to provide a smoother fade transition
10475 * when scrolling occurs.
10476 *
10477 * @return the intensity of the top fade as a float between 0.0f and 1.0f
10478 */
10479 protected float getTopFadingEdgeStrength() {
10480 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
10481 }
10482
10483 /**
10484 * Returns the strength, or intensity, of the bottom faded edge. The strength is
10485 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10486 * returns 0.0 or 1.0 but no value in between.
10487 *
10488 * Subclasses should override this method to provide a smoother fade transition
10489 * when scrolling occurs.
10490 *
10491 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
10492 */
10493 protected float getBottomFadingEdgeStrength() {
10494 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
10495 computeVerticalScrollRange() ? 1.0f : 0.0f;
10496 }
10497
10498 /**
10499 * Returns the strength, or intensity, of the left faded edge. The strength is
10500 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10501 * returns 0.0 or 1.0 but no value in between.
10502 *
10503 * Subclasses should override this method to provide a smoother fade transition
10504 * when scrolling occurs.
10505 *
10506 * @return the intensity of the left fade as a float between 0.0f and 1.0f
10507 */
10508 protected float getLeftFadingEdgeStrength() {
10509 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
10510 }
10511
10512 /**
10513 * Returns the strength, or intensity, of the right faded edge. The strength is
10514 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10515 * returns 0.0 or 1.0 but no value in between.
10516 *
10517 * Subclasses should override this method to provide a smoother fade transition
10518 * when scrolling occurs.
10519 *
10520 * @return the intensity of the right fade as a float between 0.0f and 1.0f
10521 */
10522 protected float getRightFadingEdgeStrength() {
10523 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
10524 computeHorizontalScrollRange() ? 1.0f : 0.0f;
10525 }
10526
10527 /**
10528 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
10529 * scrollbar is not drawn by default.</p>
10530 *
10531 * @return true if the horizontal scrollbar should be painted, false
10532 * otherwise
10533 *
10534 * @see #setHorizontalScrollBarEnabled(boolean)
10535 */
10536 public boolean isHorizontalScrollBarEnabled() {
10537 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
10538 }
10539
10540 /**
10541 * <p>Define whether the horizontal scrollbar should be drawn or not. The
10542 * scrollbar is not drawn by default.</p>
10543 *
10544 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
10545 * be painted
10546 *
10547 * @see #isHorizontalScrollBarEnabled()
10548 */
10549 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
10550 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
10551 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -070010552 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010553 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010554 }
10555 }
10556
10557 /**
10558 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
10559 * scrollbar is not drawn by default.</p>
10560 *
10561 * @return true if the vertical scrollbar should be painted, false
10562 * otherwise
10563 *
10564 * @see #setVerticalScrollBarEnabled(boolean)
10565 */
10566 public boolean isVerticalScrollBarEnabled() {
10567 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
10568 }
10569
10570 /**
10571 * <p>Define whether the vertical scrollbar should be drawn or not. The
10572 * scrollbar is not drawn by default.</p>
10573 *
10574 * @param verticalScrollBarEnabled true if the vertical scrollbar should
10575 * be painted
10576 *
10577 * @see #isVerticalScrollBarEnabled()
10578 */
10579 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
10580 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
10581 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -070010582 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010583 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010584 }
10585 }
10586
Adam Powell20232d02010-12-08 21:08:53 -080010587 /**
10588 * @hide
10589 */
10590 protected void recomputePadding() {
10591 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010592 }
Joe Malin32736f02011-01-19 16:14:20 -080010593
Mike Cleronfe81d382009-09-28 14:22:16 -070010594 /**
10595 * Define whether scrollbars will fade when the view is not scrolling.
Joe Malin32736f02011-01-19 16:14:20 -080010596 *
Mike Cleronfe81d382009-09-28 14:22:16 -070010597 * @param fadeScrollbars wheter to enable fading
Joe Malin32736f02011-01-19 16:14:20 -080010598 *
Philip Milne6c8ea062012-04-03 17:38:43 -070010599 * @attr ref android.R.styleable#View_fadeScrollbars
Mike Cleronfe81d382009-09-28 14:22:16 -070010600 */
10601 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
10602 initScrollCache();
10603 final ScrollabilityCache scrollabilityCache = mScrollCache;
10604 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -070010605 if (fadeScrollbars) {
10606 scrollabilityCache.state = ScrollabilityCache.OFF;
10607 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -070010608 scrollabilityCache.state = ScrollabilityCache.ON;
10609 }
10610 }
Joe Malin32736f02011-01-19 16:14:20 -080010611
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010612 /**
Joe Malin32736f02011-01-19 16:14:20 -080010613 *
Mike Cleron52f0a642009-09-28 18:21:37 -070010614 * Returns true if scrollbars will fade when this view is not scrolling
Joe Malin32736f02011-01-19 16:14:20 -080010615 *
Mike Cleron52f0a642009-09-28 18:21:37 -070010616 * @return true if scrollbar fading is enabled
Philip Milne6c8ea062012-04-03 17:38:43 -070010617 *
10618 * @attr ref android.R.styleable#View_fadeScrollbars
Mike Cleron52f0a642009-09-28 18:21:37 -070010619 */
10620 public boolean isScrollbarFadingEnabled() {
Joe Malin32736f02011-01-19 16:14:20 -080010621 return mScrollCache != null && mScrollCache.fadeScrollBars;
Mike Cleron52f0a642009-09-28 18:21:37 -070010622 }
Joe Malin32736f02011-01-19 16:14:20 -080010623
Mike Cleron52f0a642009-09-28 18:21:37 -070010624 /**
Philip Milne6c8ea062012-04-03 17:38:43 -070010625 *
10626 * Returns the delay before scrollbars fade.
10627 *
10628 * @return the delay before scrollbars fade
10629 *
10630 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
10631 */
10632 public int getScrollBarDefaultDelayBeforeFade() {
10633 return mScrollCache == null ? ViewConfiguration.getScrollDefaultDelay() :
10634 mScrollCache.scrollBarDefaultDelayBeforeFade;
10635 }
10636
10637 /**
10638 * Define the delay before scrollbars fade.
10639 *
10640 * @param scrollBarDefaultDelayBeforeFade - the delay before scrollbars fade
10641 *
10642 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
10643 */
10644 public void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) {
10645 getScrollCache().scrollBarDefaultDelayBeforeFade = scrollBarDefaultDelayBeforeFade;
10646 }
10647
10648 /**
10649 *
10650 * Returns the scrollbar fade duration.
10651 *
10652 * @return the scrollbar fade duration
10653 *
10654 * @attr ref android.R.styleable#View_scrollbarFadeDuration
10655 */
10656 public int getScrollBarFadeDuration() {
10657 return mScrollCache == null ? ViewConfiguration.getScrollBarFadeDuration() :
10658 mScrollCache.scrollBarFadeDuration;
10659 }
10660
10661 /**
10662 * Define the scrollbar fade duration.
10663 *
10664 * @param scrollBarFadeDuration - the scrollbar fade duration
10665 *
10666 * @attr ref android.R.styleable#View_scrollbarFadeDuration
10667 */
10668 public void setScrollBarFadeDuration(int scrollBarFadeDuration) {
10669 getScrollCache().scrollBarFadeDuration = scrollBarFadeDuration;
10670 }
10671
10672 /**
10673 *
10674 * Returns the scrollbar size.
10675 *
10676 * @return the scrollbar size
10677 *
10678 * @attr ref android.R.styleable#View_scrollbarSize
10679 */
10680 public int getScrollBarSize() {
Romain Guyeb378892012-04-12 11:33:14 -070010681 return mScrollCache == null ? ViewConfiguration.get(mContext).getScaledScrollBarSize() :
Philip Milne6c8ea062012-04-03 17:38:43 -070010682 mScrollCache.scrollBarSize;
10683 }
10684
10685 /**
10686 * Define the scrollbar size.
10687 *
10688 * @param scrollBarSize - the scrollbar size
10689 *
10690 * @attr ref android.R.styleable#View_scrollbarSize
10691 */
10692 public void setScrollBarSize(int scrollBarSize) {
10693 getScrollCache().scrollBarSize = scrollBarSize;
10694 }
10695
10696 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010697 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
10698 * inset. When inset, they add to the padding of the view. And the scrollbars
10699 * can be drawn inside the padding area or on the edge of the view. For example,
10700 * if a view has a background drawable and you want to draw the scrollbars
10701 * inside the padding specified by the drawable, you can use
10702 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
10703 * appear at the edge of the view, ignoring the padding, then you can use
10704 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
10705 * @param style the style of the scrollbars. Should be one of
10706 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
10707 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
10708 * @see #SCROLLBARS_INSIDE_OVERLAY
10709 * @see #SCROLLBARS_INSIDE_INSET
10710 * @see #SCROLLBARS_OUTSIDE_OVERLAY
10711 * @see #SCROLLBARS_OUTSIDE_INSET
Philip Milne6c8ea062012-04-03 17:38:43 -070010712 *
10713 * @attr ref android.R.styleable#View_scrollbarStyle
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010714 */
10715 public void setScrollBarStyle(int style) {
10716 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
10717 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -070010718 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010719 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010720 }
10721 }
10722
10723 /**
10724 * <p>Returns the current scrollbar style.</p>
10725 * @return the current scrollbar style
10726 * @see #SCROLLBARS_INSIDE_OVERLAY
10727 * @see #SCROLLBARS_INSIDE_INSET
10728 * @see #SCROLLBARS_OUTSIDE_OVERLAY
10729 * @see #SCROLLBARS_OUTSIDE_INSET
Philip Milne6c8ea062012-04-03 17:38:43 -070010730 *
10731 * @attr ref android.R.styleable#View_scrollbarStyle
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010732 */
Jeff Sharkey010d7e52011-08-08 21:05:02 -070010733 @ViewDebug.ExportedProperty(mapping = {
10734 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"),
10735 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"),
10736 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"),
10737 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET")
10738 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010739 public int getScrollBarStyle() {
10740 return mViewFlags & SCROLLBARS_STYLE_MASK;
10741 }
10742
10743 /**
10744 * <p>Compute the horizontal range that the horizontal scrollbar
10745 * represents.</p>
10746 *
10747 * <p>The range is expressed in arbitrary units that must be the same as the
10748 * units used by {@link #computeHorizontalScrollExtent()} and
10749 * {@link #computeHorizontalScrollOffset()}.</p>
10750 *
10751 * <p>The default range is the drawing width of this view.</p>
10752 *
10753 * @return the total horizontal range represented by the horizontal
10754 * scrollbar
10755 *
10756 * @see #computeHorizontalScrollExtent()
10757 * @see #computeHorizontalScrollOffset()
10758 * @see android.widget.ScrollBarDrawable
10759 */
10760 protected int computeHorizontalScrollRange() {
10761 return getWidth();
10762 }
10763
10764 /**
10765 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
10766 * within the horizontal range. This value is used to compute the position
10767 * of the thumb within the scrollbar's track.</p>
10768 *
10769 * <p>The range is expressed in arbitrary units that must be the same as the
10770 * units used by {@link #computeHorizontalScrollRange()} and
10771 * {@link #computeHorizontalScrollExtent()}.</p>
10772 *
10773 * <p>The default offset is the scroll offset of this view.</p>
10774 *
10775 * @return the horizontal offset of the scrollbar's thumb
10776 *
10777 * @see #computeHorizontalScrollRange()
10778 * @see #computeHorizontalScrollExtent()
10779 * @see android.widget.ScrollBarDrawable
10780 */
10781 protected int computeHorizontalScrollOffset() {
10782 return mScrollX;
10783 }
10784
10785 /**
10786 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
10787 * within the horizontal range. This value is used to compute the length
10788 * of the thumb within the scrollbar's track.</p>
10789 *
10790 * <p>The range is expressed in arbitrary units that must be the same as the
10791 * units used by {@link #computeHorizontalScrollRange()} and
10792 * {@link #computeHorizontalScrollOffset()}.</p>
10793 *
10794 * <p>The default extent is the drawing width of this view.</p>
10795 *
10796 * @return the horizontal extent of the scrollbar's thumb
10797 *
10798 * @see #computeHorizontalScrollRange()
10799 * @see #computeHorizontalScrollOffset()
10800 * @see android.widget.ScrollBarDrawable
10801 */
10802 protected int computeHorizontalScrollExtent() {
10803 return getWidth();
10804 }
10805
10806 /**
10807 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
10808 *
10809 * <p>The range is expressed in arbitrary units that must be the same as the
10810 * units used by {@link #computeVerticalScrollExtent()} and
10811 * {@link #computeVerticalScrollOffset()}.</p>
10812 *
10813 * @return the total vertical range represented by the vertical scrollbar
10814 *
10815 * <p>The default range is the drawing height of this view.</p>
10816 *
10817 * @see #computeVerticalScrollExtent()
10818 * @see #computeVerticalScrollOffset()
10819 * @see android.widget.ScrollBarDrawable
10820 */
10821 protected int computeVerticalScrollRange() {
10822 return getHeight();
10823 }
10824
10825 /**
10826 * <p>Compute the vertical offset of the vertical scrollbar's thumb
10827 * within the horizontal range. This value is used to compute the position
10828 * of the thumb within the scrollbar's track.</p>
10829 *
10830 * <p>The range is expressed in arbitrary units that must be the same as the
10831 * units used by {@link #computeVerticalScrollRange()} and
10832 * {@link #computeVerticalScrollExtent()}.</p>
10833 *
10834 * <p>The default offset is the scroll offset of this view.</p>
10835 *
10836 * @return the vertical offset of the scrollbar's thumb
10837 *
10838 * @see #computeVerticalScrollRange()
10839 * @see #computeVerticalScrollExtent()
10840 * @see android.widget.ScrollBarDrawable
10841 */
10842 protected int computeVerticalScrollOffset() {
10843 return mScrollY;
10844 }
10845
10846 /**
10847 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
10848 * within the vertical range. This value is used to compute the length
10849 * of the thumb within the scrollbar's track.</p>
10850 *
10851 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -080010852 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010853 * {@link #computeVerticalScrollOffset()}.</p>
10854 *
10855 * <p>The default extent is the drawing height of this view.</p>
10856 *
10857 * @return the vertical extent of the scrollbar's thumb
10858 *
10859 * @see #computeVerticalScrollRange()
10860 * @see #computeVerticalScrollOffset()
10861 * @see android.widget.ScrollBarDrawable
10862 */
10863 protected int computeVerticalScrollExtent() {
10864 return getHeight();
10865 }
10866
10867 /**
Adam Powell69159442011-06-13 17:53:06 -070010868 * Check if this view can be scrolled horizontally in a certain direction.
10869 *
10870 * @param direction Negative to check scrolling left, positive to check scrolling right.
10871 * @return true if this view can be scrolled in the specified direction, false otherwise.
10872 */
10873 public boolean canScrollHorizontally(int direction) {
10874 final int offset = computeHorizontalScrollOffset();
10875 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent();
10876 if (range == 0) return false;
10877 if (direction < 0) {
10878 return offset > 0;
10879 } else {
10880 return offset < range - 1;
10881 }
10882 }
10883
10884 /**
10885 * Check if this view can be scrolled vertically in a certain direction.
10886 *
10887 * @param direction Negative to check scrolling up, positive to check scrolling down.
10888 * @return true if this view can be scrolled in the specified direction, false otherwise.
10889 */
10890 public boolean canScrollVertically(int direction) {
10891 final int offset = computeVerticalScrollOffset();
10892 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent();
10893 if (range == 0) return false;
10894 if (direction < 0) {
10895 return offset > 0;
10896 } else {
10897 return offset < range - 1;
10898 }
10899 }
10900
10901 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010902 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
10903 * scrollbars are painted only if they have been awakened first.</p>
10904 *
10905 * @param canvas the canvas on which to draw the scrollbars
Joe Malin32736f02011-01-19 16:14:20 -080010906 *
Mike Cleronf116bf82009-09-27 19:14:12 -070010907 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010908 */
Romain Guy1d5b3a62009-11-05 18:44:12 -080010909 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010910 // scrollbars are drawn only when the animation is running
10911 final ScrollabilityCache cache = mScrollCache;
10912 if (cache != null) {
Joe Malin32736f02011-01-19 16:14:20 -080010913
Mike Cleronf116bf82009-09-27 19:14:12 -070010914 int state = cache.state;
Joe Malin32736f02011-01-19 16:14:20 -080010915
Mike Cleronf116bf82009-09-27 19:14:12 -070010916 if (state == ScrollabilityCache.OFF) {
10917 return;
10918 }
Joe Malin32736f02011-01-19 16:14:20 -080010919
Mike Cleronf116bf82009-09-27 19:14:12 -070010920 boolean invalidate = false;
Joe Malin32736f02011-01-19 16:14:20 -080010921
Mike Cleronf116bf82009-09-27 19:14:12 -070010922 if (state == ScrollabilityCache.FADING) {
10923 // We're fading -- get our fade interpolation
10924 if (cache.interpolatorValues == null) {
10925 cache.interpolatorValues = new float[1];
10926 }
Joe Malin32736f02011-01-19 16:14:20 -080010927
Mike Cleronf116bf82009-09-27 19:14:12 -070010928 float[] values = cache.interpolatorValues;
Joe Malin32736f02011-01-19 16:14:20 -080010929
Mike Cleronf116bf82009-09-27 19:14:12 -070010930 // Stops the animation if we're done
10931 if (cache.scrollBarInterpolator.timeToValues(values) ==
10932 Interpolator.Result.FREEZE_END) {
10933 cache.state = ScrollabilityCache.OFF;
10934 } else {
10935 cache.scrollBar.setAlpha(Math.round(values[0]));
10936 }
Joe Malin32736f02011-01-19 16:14:20 -080010937
10938 // This will make the scroll bars inval themselves after
Mike Cleronf116bf82009-09-27 19:14:12 -070010939 // drawing. We only want this when we're fading so that
10940 // we prevent excessive redraws
10941 invalidate = true;
10942 } else {
10943 // We're just on -- but we may have been fading before so
10944 // reset alpha
10945 cache.scrollBar.setAlpha(255);
10946 }
10947
Joe Malin32736f02011-01-19 16:14:20 -080010948
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010949 final int viewFlags = mViewFlags;
10950
10951 final boolean drawHorizontalScrollBar =
10952 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
10953 final boolean drawVerticalScrollBar =
10954 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
10955 && !isVerticalScrollBarHidden();
10956
10957 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
10958 final int width = mRight - mLeft;
10959 final int height = mBottom - mTop;
10960
10961 final ScrollBarDrawable scrollBar = cache.scrollBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010962
Mike Reede8853fc2009-09-04 14:01:48 -040010963 final int scrollX = mScrollX;
10964 final int scrollY = mScrollY;
10965 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
10966
Mike Cleronf116bf82009-09-27 19:14:12 -070010967 int left, top, right, bottom;
Joe Malin32736f02011-01-19 16:14:20 -080010968
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010969 if (drawHorizontalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -080010970 int size = scrollBar.getSize(false);
10971 if (size <= 0) {
10972 size = cache.scrollBarSize;
10973 }
10974
Mike Cleronf116bf82009-09-27 19:14:12 -070010975 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -040010976 computeHorizontalScrollOffset(),
10977 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -040010978 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -070010979 getVerticalScrollbarWidth() : 0;
Joe Malin32736f02011-01-19 16:14:20 -080010980 top = scrollY + height - size - (mUserPaddingBottom & inside);
Mike Cleronf116bf82009-09-27 19:14:12 -070010981 left = scrollX + (mPaddingLeft & inside);
10982 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
10983 bottom = top + size;
10984 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
10985 if (invalidate) {
10986 invalidate(left, top, right, bottom);
10987 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010988 }
10989
10990 if (drawVerticalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -080010991 int size = scrollBar.getSize(true);
10992 if (size <= 0) {
10993 size = cache.scrollBarSize;
10994 }
10995
Mike Reede8853fc2009-09-04 14:01:48 -040010996 scrollBar.setParameters(computeVerticalScrollRange(),
10997 computeVerticalScrollOffset(),
10998 computeVerticalScrollExtent(), true);
Adam Powell20232d02010-12-08 21:08:53 -080010999 switch (mVerticalScrollbarPosition) {
11000 default:
11001 case SCROLLBAR_POSITION_DEFAULT:
11002 case SCROLLBAR_POSITION_RIGHT:
11003 left = scrollX + width - size - (mUserPaddingRight & inside);
11004 break;
11005 case SCROLLBAR_POSITION_LEFT:
11006 left = scrollX + (mUserPaddingLeft & inside);
11007 break;
11008 }
Mike Cleronf116bf82009-09-27 19:14:12 -070011009 top = scrollY + (mPaddingTop & inside);
11010 right = left + size;
11011 bottom = scrollY + height - (mUserPaddingBottom & inside);
11012 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
11013 if (invalidate) {
11014 invalidate(left, top, right, bottom);
11015 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011016 }
11017 }
11018 }
11019 }
Romain Guy8506ab42009-06-11 17:35:47 -070011020
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011021 /**
Romain Guy8506ab42009-06-11 17:35:47 -070011022 * 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 -080011023 * FastScroller is visible.
11024 * @return whether to temporarily hide the vertical scrollbar
11025 * @hide
11026 */
11027 protected boolean isVerticalScrollBarHidden() {
11028 return false;
11029 }
11030
11031 /**
11032 * <p>Draw the horizontal scrollbar if
11033 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
11034 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011035 * @param canvas the canvas on which to draw the scrollbar
11036 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011037 *
11038 * @see #isHorizontalScrollBarEnabled()
11039 * @see #computeHorizontalScrollRange()
11040 * @see #computeHorizontalScrollExtent()
11041 * @see #computeHorizontalScrollOffset()
11042 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -070011043 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011044 */
Romain Guy8fb95422010-08-17 18:38:51 -070011045 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
11046 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011047 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011048 scrollBar.draw(canvas);
11049 }
Mike Reede8853fc2009-09-04 14:01:48 -040011050
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011051 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011052 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
11053 * returns true.</p>
11054 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011055 * @param canvas the canvas on which to draw the scrollbar
11056 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011057 *
11058 * @see #isVerticalScrollBarEnabled()
11059 * @see #computeVerticalScrollRange()
11060 * @see #computeVerticalScrollExtent()
11061 * @see #computeVerticalScrollOffset()
11062 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -040011063 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011064 */
Romain Guy8fb95422010-08-17 18:38:51 -070011065 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
11066 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -040011067 scrollBar.setBounds(l, t, r, b);
11068 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011069 }
11070
11071 /**
11072 * Implement this to do your drawing.
11073 *
11074 * @param canvas the canvas on which the background will be drawn
11075 */
11076 protected void onDraw(Canvas canvas) {
11077 }
11078
11079 /*
11080 * Caller is responsible for calling requestLayout if necessary.
11081 * (This allows addViewInLayout to not request a new layout.)
11082 */
11083 void assignParent(ViewParent parent) {
11084 if (mParent == null) {
11085 mParent = parent;
11086 } else if (parent == null) {
11087 mParent = null;
11088 } else {
11089 throw new RuntimeException("view " + this + " being added, but"
11090 + " it already has a parent");
11091 }
11092 }
11093
11094 /**
11095 * This is called when the view is attached to a window. At this point it
11096 * has a Surface and will start drawing. Note that this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070011097 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)},
11098 * however it may be called any time before the first onDraw -- including
11099 * before or after {@link #onMeasure(int, int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011100 *
11101 * @see #onDetachedFromWindow()
11102 */
11103 protected void onAttachedToWindow() {
11104 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
11105 mParent.requestTransparentRegion(this);
11106 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011107
Adam Powell8568c3a2010-04-19 14:26:11 -070011108 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
11109 initialAwakenScrollBars();
11110 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
11111 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011112
Chet Haasea9b61ac2010-12-20 07:40:25 -080011113 jumpDrawablesToCurrentState();
Romain Guy2a0f2282012-05-08 14:43:12 -070011114
Fabrice Di Meglioa6461452011-08-19 15:42:04 -070011115 // Order is important here: LayoutDirection MUST be resolved before Padding
11116 // and TextDirection
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011117 resolveLayoutDirection();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011118 resolvePadding();
Fabrice Di Meglio22268862011-06-27 18:13:18 -070011119 resolveTextDirection();
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070011120 resolveTextAlignment();
Romain Guy2a0f2282012-05-08 14:43:12 -070011121
Svetoslav Ganov42138042012-03-20 11:51:39 -070011122 clearAccessibilityFocus();
Amith Yamasani4503c8d2011-06-17 12:36:14 -070011123 if (isFocused()) {
11124 InputMethodManager imm = InputMethodManager.peekInstance();
11125 imm.focusIn(this);
11126 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011127
11128 if (mAttachInfo != null && mDisplayList != null) {
11129 mAttachInfo.mViewRootImpl.dequeueDisplayList(mDisplayList);
11130 }
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011131 }
Cibu Johny86666632010-02-22 13:01:02 -080011132
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011133 /**
Romain Guybb9908b2012-03-08 11:14:07 -080011134 * @see #onScreenStateChanged(int)
11135 */
11136 void dispatchScreenStateChanged(int screenState) {
11137 onScreenStateChanged(screenState);
11138 }
11139
11140 /**
11141 * This method is called whenever the state of the screen this view is
11142 * attached to changes. A state change will usually occurs when the screen
11143 * turns on or off (whether it happens automatically or the user does it
11144 * manually.)
11145 *
11146 * @param screenState The new state of the screen. Can be either
11147 * {@link #SCREEN_STATE_ON} or {@link #SCREEN_STATE_OFF}
11148 */
11149 public void onScreenStateChanged(int screenState) {
11150 }
11151
11152 /**
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011153 * Return true if the application tag in the AndroidManifest has set "supportRtl" to true
11154 */
11155 private boolean hasRtlSupport() {
11156 return mContext.getApplicationInfo().hasRtlSupport();
11157 }
11158
11159 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011160 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing
11161 * that the parent directionality can and will be resolved before its children.
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011162 * Will call {@link View#onResolvedLayoutDirectionChanged} when resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011163 * @hide
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011164 */
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011165 public void resolveLayoutDirection() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011166 // Clear any previous layout direction resolution
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -070011167 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_MASK;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011168
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011169 if (hasRtlSupport()) {
11170 // Set resolved depending on layout direction
11171 switch (getLayoutDirection()) {
11172 case LAYOUT_DIRECTION_INHERIT:
11173 // If this is root view, no need to look at parent's layout dir.
11174 if (canResolveLayoutDirection()) {
11175 ViewGroup viewGroup = ((ViewGroup) mParent);
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011176
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011177 if (viewGroup.getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
11178 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11179 }
11180 } else {
11181 // Nothing to do, LTR by default
11182 }
11183 break;
11184 case LAYOUT_DIRECTION_RTL:
11185 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11186 break;
11187 case LAYOUT_DIRECTION_LOCALE:
11188 if(isLayoutDirectionRtl(Locale.getDefault())) {
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011189 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11190 }
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011191 break;
11192 default:
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011193 // Nothing to do, LTR by default
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011194 }
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011195 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011196
11197 // Set to resolved
11198 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011199 onResolvedLayoutDirectionChanged();
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080011200 // Resolve padding
11201 resolvePadding();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011202 }
11203
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -070011204 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011205 * Called when layout direction has been resolved.
11206 *
11207 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011208 * @hide
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011209 */
11210 public void onResolvedLayoutDirectionChanged() {
11211 }
11212
11213 /**
11214 * Resolve padding depending on layout direction.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011215 * @hide
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -070011216 */
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011217 public void resolvePadding() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011218 // If the user specified the absolute padding (either with android:padding or
11219 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
11220 // use the default padding or the padding from the background drawable
11221 // (stored at this point in mPadding*)
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011222 int resolvedLayoutDirection = getResolvedLayoutDirection();
11223 switch (resolvedLayoutDirection) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011224 case LAYOUT_DIRECTION_RTL:
11225 // Start user padding override Right user padding. Otherwise, if Right user
11226 // padding is not defined, use the default Right padding. If Right user padding
11227 // is defined, just use it.
11228 if (mUserPaddingStart >= 0) {
11229 mUserPaddingRight = mUserPaddingStart;
11230 } else if (mUserPaddingRight < 0) {
11231 mUserPaddingRight = mPaddingRight;
11232 }
11233 if (mUserPaddingEnd >= 0) {
11234 mUserPaddingLeft = mUserPaddingEnd;
11235 } else if (mUserPaddingLeft < 0) {
11236 mUserPaddingLeft = mPaddingLeft;
11237 }
11238 break;
11239 case LAYOUT_DIRECTION_LTR:
11240 default:
11241 // Start user padding override Left user padding. Otherwise, if Left user
11242 // padding is not defined, use the default left padding. If Left user padding
11243 // is defined, just use it.
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -070011244 if (mUserPaddingStart >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011245 mUserPaddingLeft = mUserPaddingStart;
11246 } else if (mUserPaddingLeft < 0) {
11247 mUserPaddingLeft = mPaddingLeft;
11248 }
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -070011249 if (mUserPaddingEnd >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011250 mUserPaddingRight = mUserPaddingEnd;
11251 } else if (mUserPaddingRight < 0) {
11252 mUserPaddingRight = mPaddingRight;
11253 }
11254 }
11255
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011256 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom;
11257
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080011258 if(isPaddingRelative()) {
11259 setPaddingRelative(mUserPaddingStart, mPaddingTop, mUserPaddingEnd, mUserPaddingBottom);
11260 } else {
11261 recomputePadding();
11262 }
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011263 onPaddingChanged(resolvedLayoutDirection);
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011264 }
11265
11266 /**
11267 * Resolve padding depending on the layout direction. Subclasses that care about
11268 * padding resolution should override this method. The default implementation does
11269 * nothing.
11270 *
11271 * @param layoutDirection the direction of the layout
11272 *
Fabrice Di Meglioe8dc07d2012-03-09 17:10:19 -080011273 * @see {@link #LAYOUT_DIRECTION_LTR}
11274 * @see {@link #LAYOUT_DIRECTION_RTL}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011275 * @hide
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011276 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011277 public void onPaddingChanged(int layoutDirection) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011278 }
11279
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011280 /**
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011281 * Check if layout direction resolution can be done.
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011282 *
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011283 * @return true if layout direction resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011284 * @hide
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011285 */
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011286 public boolean canResolveLayoutDirection() {
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011287 switch (getLayoutDirection()) {
11288 case LAYOUT_DIRECTION_INHERIT:
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011289 return (mParent != null) && (mParent instanceof ViewGroup);
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011290 default:
11291 return true;
11292 }
11293 }
11294
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011295 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011296 * Reset the resolved layout direction. Will call {@link View#onResolvedLayoutDirectionReset}
11297 * when reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011298 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011299 */
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011300 public void resetResolvedLayoutDirection() {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -070011301 // Reset the current resolved bits
11302 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_MASK;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011303 onResolvedLayoutDirectionReset();
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080011304 // Reset also the text direction
11305 resetResolvedTextDirection();
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011306 }
11307
11308 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011309 * Called during reset of resolved layout direction.
11310 *
11311 * Subclasses need to override this method to clear cached information that depends on the
11312 * resolved layout direction, or to inform child views that inherit their layout direction.
11313 *
11314 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011315 * @hide
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011316 */
11317 public void onResolvedLayoutDirectionReset() {
11318 }
11319
11320 /**
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011321 * Check if a Locale uses an RTL script.
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011322 *
11323 * @param locale Locale to check
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011324 * @return true if the Locale uses an RTL script.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011325 * @hide
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011326 */
Fabrice Di Meglio22268862011-06-27 18:13:18 -070011327 protected static boolean isLayoutDirectionRtl(Locale locale) {
Fabrice Di Meglio3fb824b2012-02-28 17:58:31 -080011328 return (LAYOUT_DIRECTION_RTL == LocaleUtil.getLayoutDirectionFromLocale(locale));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011329 }
11330
11331 /**
11332 * This is called when the view is detached from a window. At this point it
11333 * no longer has a surface for drawing.
11334 *
11335 * @see #onAttachedToWindow()
11336 */
11337 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -080011338 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -080011339
Romain Guya440b002010-02-24 15:57:54 -080011340 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -050011341 removeLongPressCallback();
Adam Powell3cb8b632011-01-21 15:34:14 -080011342 removePerformClickCallback();
Svetoslav Ganova0156172011-06-26 17:55:44 -070011343 removeSendViewScrolledAccessibilityEventCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -080011344
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011345 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -080011346
Romain Guya998dff2012-03-23 18:58:36 -070011347 destroyLayer(false);
Romain Guy8dd5b1e2011-01-14 17:28:51 -080011348
11349 if (mAttachInfo != null) {
Romain Guy51e4d4d2012-03-15 18:30:47 -070011350 if (mDisplayList != null) {
Romain Guy2a0f2282012-05-08 14:43:12 -070011351 mAttachInfo.mViewRootImpl.enqueueDisplayList(mDisplayList);
Romain Guy51e4d4d2012-03-15 18:30:47 -070011352 }
Jeff Browna175a5b2012-02-15 19:18:31 -080011353 mAttachInfo.mViewRootImpl.cancelInvalidate(this);
Romain Guy51e4d4d2012-03-15 18:30:47 -070011354 } else {
11355 if (mDisplayList != null) {
11356 // Should never happen
11357 mDisplayList.invalidate();
11358 }
Romain Guy8dd5b1e2011-01-14 17:28:51 -080011359 }
11360
Patrick Dubroyec84c3a2011-01-13 17:55:37 -080011361 mCurrentAnimation = null;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -070011362
11363 resetResolvedLayoutDirection();
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070011364 resetResolvedTextAlignment();
Svetoslav Ganov42138042012-03-20 11:51:39 -070011365 resetAccessibilityStateChanged();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011366 }
11367
11368 /**
11369 * @return The number of times this view has been attached to a window
11370 */
11371 protected int getWindowAttachCount() {
11372 return mWindowAttachCount;
11373 }
11374
11375 /**
11376 * Retrieve a unique token identifying the window this view is attached to.
11377 * @return Return the window's token for use in
11378 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
11379 */
11380 public IBinder getWindowToken() {
11381 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
11382 }
11383
11384 /**
11385 * Retrieve a unique token identifying the top-level "real" window of
11386 * the window that this view is attached to. That is, this is like
11387 * {@link #getWindowToken}, except if the window this view in is a panel
11388 * window (attached to another containing window), then the token of
11389 * the containing window is returned instead.
11390 *
11391 * @return Returns the associated window token, either
11392 * {@link #getWindowToken()} or the containing window's token.
11393 */
11394 public IBinder getApplicationWindowToken() {
11395 AttachInfo ai = mAttachInfo;
11396 if (ai != null) {
11397 IBinder appWindowToken = ai.mPanelParentWindowToken;
11398 if (appWindowToken == null) {
11399 appWindowToken = ai.mWindowToken;
11400 }
11401 return appWindowToken;
11402 }
11403 return null;
11404 }
11405
11406 /**
11407 * Retrieve private session object this view hierarchy is using to
11408 * communicate with the window manager.
11409 * @return the session object to communicate with the window manager
11410 */
11411 /*package*/ IWindowSession getWindowSession() {
11412 return mAttachInfo != null ? mAttachInfo.mSession : null;
11413 }
11414
11415 /**
11416 * @param info the {@link android.view.View.AttachInfo} to associated with
11417 * this view
11418 */
11419 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
11420 //System.out.println("Attached! " + this);
11421 mAttachInfo = info;
11422 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011423 // We will need to evaluate the drawable state at least once.
11424 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011425 if (mFloatingTreeObserver != null) {
11426 info.mTreeObserver.merge(mFloatingTreeObserver);
11427 mFloatingTreeObserver = null;
11428 }
11429 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
11430 mAttachInfo.mScrollContainers.add(this);
11431 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
11432 }
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -070011433 performCollectViewAttributes(mAttachInfo, visibility);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011434 onAttachedToWindow();
Adam Powell4afd62b2011-02-18 15:02:18 -080011435
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011436 ListenerInfo li = mListenerInfo;
Adam Powell4afd62b2011-02-18 15:02:18 -080011437 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011438 li != null ? li.mOnAttachStateChangeListeners : null;
Adam Powell4afd62b2011-02-18 15:02:18 -080011439 if (listeners != null && listeners.size() > 0) {
11440 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
11441 // perform the dispatching. The iterator is a safe guard against listeners that
11442 // could mutate the list by calling the various add/remove methods. This prevents
11443 // the array from being modified while we iterate it.
11444 for (OnAttachStateChangeListener listener : listeners) {
11445 listener.onViewAttachedToWindow(this);
11446 }
11447 }
11448
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011449 int vis = info.mWindowVisibility;
11450 if (vis != GONE) {
11451 onWindowVisibilityChanged(vis);
11452 }
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011453 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) {
11454 // If nobody has evaluated the drawable state yet, then do it now.
11455 refreshDrawableState();
11456 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011457 }
11458
11459 void dispatchDetachedFromWindow() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011460 AttachInfo info = mAttachInfo;
11461 if (info != null) {
11462 int vis = info.mWindowVisibility;
11463 if (vis != GONE) {
11464 onWindowVisibilityChanged(GONE);
11465 }
11466 }
11467
11468 onDetachedFromWindow();
Romain Guy01d5edc2011-01-28 11:28:53 -080011469
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011470 ListenerInfo li = mListenerInfo;
Adam Powell4afd62b2011-02-18 15:02:18 -080011471 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011472 li != null ? li.mOnAttachStateChangeListeners : null;
Adam Powell4afd62b2011-02-18 15:02:18 -080011473 if (listeners != null && listeners.size() > 0) {
11474 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
11475 // perform the dispatching. The iterator is a safe guard against listeners that
11476 // could mutate the list by calling the various add/remove methods. This prevents
11477 // the array from being modified while we iterate it.
11478 for (OnAttachStateChangeListener listener : listeners) {
11479 listener.onViewDetachedFromWindow(this);
11480 }
11481 }
11482
Romain Guy01d5edc2011-01-28 11:28:53 -080011483 if ((mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011484 mAttachInfo.mScrollContainers.remove(this);
11485 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
11486 }
Romain Guy01d5edc2011-01-28 11:28:53 -080011487
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011488 mAttachInfo = null;
11489 }
11490
11491 /**
11492 * Store this view hierarchy's frozen state into the given container.
11493 *
11494 * @param container The SparseArray in which to save the view's state.
11495 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011496 * @see #restoreHierarchyState(android.util.SparseArray)
11497 * @see #dispatchSaveInstanceState(android.util.SparseArray)
11498 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011499 */
11500 public void saveHierarchyState(SparseArray<Parcelable> container) {
11501 dispatchSaveInstanceState(container);
11502 }
11503
11504 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -070011505 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for
11506 * this view and its children. May be overridden to modify how freezing happens to a
11507 * 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 -080011508 *
11509 * @param container The SparseArray in which to save the view's state.
11510 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011511 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
11512 * @see #saveHierarchyState(android.util.SparseArray)
11513 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011514 */
11515 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
11516 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
11517 mPrivateFlags &= ~SAVE_STATE_CALLED;
11518 Parcelable state = onSaveInstanceState();
11519 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
11520 throw new IllegalStateException(
11521 "Derived class did not call super.onSaveInstanceState()");
11522 }
11523 if (state != null) {
11524 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
11525 // + ": " + state);
11526 container.put(mID, state);
11527 }
11528 }
11529 }
11530
11531 /**
11532 * Hook allowing a view to generate a representation of its internal state
11533 * that can later be used to create a new instance with that same state.
11534 * This state should only contain information that is not persistent or can
11535 * not be reconstructed later. For example, you will never store your
11536 * current position on screen because that will be computed again when a
11537 * new instance of the view is placed in its view hierarchy.
11538 * <p>
11539 * Some examples of things you may store here: the current cursor position
11540 * in a text view (but usually not the text itself since that is stored in a
11541 * content provider or other persistent storage), the currently selected
11542 * item in a list view.
11543 *
11544 * @return Returns a Parcelable object containing the view's current dynamic
11545 * state, or null if there is nothing interesting to save. The
11546 * default implementation returns null.
Philip Milne6c8ea062012-04-03 17:38:43 -070011547 * @see #onRestoreInstanceState(android.os.Parcelable)
11548 * @see #saveHierarchyState(android.util.SparseArray)
11549 * @see #dispatchSaveInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011550 * @see #setSaveEnabled(boolean)
11551 */
11552 protected Parcelable onSaveInstanceState() {
11553 mPrivateFlags |= SAVE_STATE_CALLED;
11554 return BaseSavedState.EMPTY_STATE;
11555 }
11556
11557 /**
11558 * Restore this view hierarchy's frozen state from the given container.
11559 *
11560 * @param container The SparseArray which holds previously frozen states.
11561 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011562 * @see #saveHierarchyState(android.util.SparseArray)
11563 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
11564 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011565 */
11566 public void restoreHierarchyState(SparseArray<Parcelable> container) {
11567 dispatchRestoreInstanceState(container);
11568 }
11569
11570 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -070011571 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the
11572 * state for this view and its children. May be overridden to modify how restoring
11573 * happens to a view's children; for example, some views may want to not store state
11574 * for their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011575 *
11576 * @param container The SparseArray which holds previously saved state.
11577 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011578 * @see #dispatchSaveInstanceState(android.util.SparseArray)
11579 * @see #restoreHierarchyState(android.util.SparseArray)
11580 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011581 */
11582 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
11583 if (mID != NO_ID) {
11584 Parcelable state = container.get(mID);
11585 if (state != null) {
11586 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
11587 // + ": " + state);
11588 mPrivateFlags &= ~SAVE_STATE_CALLED;
11589 onRestoreInstanceState(state);
11590 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
11591 throw new IllegalStateException(
11592 "Derived class did not call super.onRestoreInstanceState()");
11593 }
11594 }
11595 }
11596 }
11597
11598 /**
11599 * Hook allowing a view to re-apply a representation of its internal state that had previously
11600 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
11601 * null state.
11602 *
11603 * @param state The frozen state that had previously been returned by
11604 * {@link #onSaveInstanceState}.
11605 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011606 * @see #onSaveInstanceState()
11607 * @see #restoreHierarchyState(android.util.SparseArray)
11608 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011609 */
11610 protected void onRestoreInstanceState(Parcelable state) {
11611 mPrivateFlags |= SAVE_STATE_CALLED;
11612 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -080011613 throw new IllegalArgumentException("Wrong state class, expecting View State but "
11614 + "received " + state.getClass().toString() + " instead. This usually happens "
Joe Malin32736f02011-01-19 16:14:20 -080011615 + "when two views of different type have the same id in the same hierarchy. "
11616 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
Romain Guy237c1ce2009-12-08 11:30:25 -080011617 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011618 }
11619 }
11620
11621 /**
11622 * <p>Return the time at which the drawing of the view hierarchy started.</p>
11623 *
11624 * @return the drawing start time in milliseconds
11625 */
11626 public long getDrawingTime() {
11627 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
11628 }
11629
11630 /**
11631 * <p>Enables or disables the duplication of the parent's state into this view. When
11632 * duplication is enabled, this view gets its drawable state from its parent rather
11633 * than from its own internal properties.</p>
11634 *
11635 * <p>Note: in the current implementation, setting this property to true after the
11636 * view was added to a ViewGroup might have no effect at all. This property should
11637 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
11638 *
11639 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
11640 * property is enabled, an exception will be thrown.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011641 *
Gilles Debunnefb817032011-01-13 13:52:49 -080011642 * <p>Note: if the child view uses and updates additionnal states which are unknown to the
11643 * parent, these states should not be affected by this method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011644 *
11645 * @param enabled True to enable duplication of the parent's drawable state, false
11646 * to disable it.
11647 *
11648 * @see #getDrawableState()
11649 * @see #isDuplicateParentStateEnabled()
11650 */
11651 public void setDuplicateParentStateEnabled(boolean enabled) {
11652 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
11653 }
11654
11655 /**
11656 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
11657 *
11658 * @return True if this view's drawable state is duplicated from the parent,
11659 * false otherwise
11660 *
11661 * @see #getDrawableState()
11662 * @see #setDuplicateParentStateEnabled(boolean)
11663 */
11664 public boolean isDuplicateParentStateEnabled() {
11665 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
11666 }
11667
11668 /**
Romain Guy171c5922011-01-06 10:04:23 -080011669 * <p>Specifies the type of layer backing this view. The layer can be
11670 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
11671 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011672 *
Romain Guy171c5922011-01-06 10:04:23 -080011673 * <p>A layer is associated with an optional {@link android.graphics.Paint}
11674 * instance that controls how the layer is composed on screen. The following
11675 * properties of the paint are taken into account when composing the layer:</p>
11676 * <ul>
11677 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
11678 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
11679 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
11680 * </ul>
Joe Malin32736f02011-01-19 16:14:20 -080011681 *
Romain Guy171c5922011-01-06 10:04:23 -080011682 * <p>If this view has an alpha value set to < 1.0 by calling
11683 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
11684 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
11685 * equivalent to setting a hardware layer on this view and providing a paint with
11686 * the desired alpha value.<p>
Joe Malin32736f02011-01-19 16:14:20 -080011687 *
Romain Guy171c5922011-01-06 10:04:23 -080011688 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
11689 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
11690 * for more information on when and how to use layers.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011691 *
Romain Guy171c5922011-01-06 10:04:23 -080011692 * @param layerType The ype of layer to use with this view, must be one of
11693 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
11694 * {@link #LAYER_TYPE_HARDWARE}
11695 * @param paint The paint used to compose the layer. This argument is optional
11696 * and can be null. It is ignored when the layer type is
11697 * {@link #LAYER_TYPE_NONE}
Joe Malin32736f02011-01-19 16:14:20 -080011698 *
11699 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -080011700 * @see #LAYER_TYPE_NONE
11701 * @see #LAYER_TYPE_SOFTWARE
11702 * @see #LAYER_TYPE_HARDWARE
Joe Malin32736f02011-01-19 16:14:20 -080011703 * @see #setAlpha(float)
11704 *
Romain Guy171c5922011-01-06 10:04:23 -080011705 * @attr ref android.R.styleable#View_layerType
11706 */
11707 public void setLayerType(int layerType, Paint paint) {
11708 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
Joe Malin32736f02011-01-19 16:14:20 -080011709 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
Romain Guy171c5922011-01-06 10:04:23 -080011710 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
11711 }
Chet Haasedaf98e92011-01-10 14:10:36 -080011712
Romain Guyd6cd5722011-01-17 14:42:41 -080011713 if (layerType == mLayerType) {
11714 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) {
11715 mLayerPaint = paint == null ? new Paint() : paint;
Romain Guy0fd89bf2011-01-26 15:41:30 -080011716 invalidateParentCaches();
11717 invalidate(true);
Romain Guyd6cd5722011-01-17 14:42:41 -080011718 }
11719 return;
11720 }
Romain Guy171c5922011-01-06 10:04:23 -080011721
11722 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -080011723 switch (mLayerType) {
Chet Haase6f33e812011-05-17 12:42:19 -070011724 case LAYER_TYPE_HARDWARE:
Romain Guya998dff2012-03-23 18:58:36 -070011725 destroyLayer(false);
Romain Guy31f2c2e2011-11-21 10:55:41 -080011726 // fall through - non-accelerated views may use software layer mechanism instead
Romain Guy6c319ca2011-01-11 14:29:25 -080011727 case LAYER_TYPE_SOFTWARE:
Romain Guy6d7475d2011-07-27 16:28:21 -070011728 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -080011729 break;
Romain Guy6c319ca2011-01-11 14:29:25 -080011730 default:
11731 break;
Romain Guy171c5922011-01-06 10:04:23 -080011732 }
11733
11734 mLayerType = layerType;
Romain Guy3a3133d2011-02-01 22:59:58 -080011735 final boolean layerDisabled = mLayerType == LAYER_TYPE_NONE;
11736 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint);
11737 mLocalDirtyRect = layerDisabled ? null : new Rect();
Romain Guy171c5922011-01-06 10:04:23 -080011738
Romain Guy0fd89bf2011-01-26 15:41:30 -080011739 invalidateParentCaches();
11740 invalidate(true);
Romain Guy171c5922011-01-06 10:04:23 -080011741 }
11742
11743 /**
Romain Guy59c7f802011-09-29 17:21:45 -070011744 * Indicates whether this view has a static layer. A view with layer type
11745 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are
11746 * dynamic.
11747 */
11748 boolean hasStaticLayer() {
Romain Guy2bf68f02012-03-02 13:37:47 -080011749 return true;
Romain Guy59c7f802011-09-29 17:21:45 -070011750 }
11751
11752 /**
Romain Guy171c5922011-01-06 10:04:23 -080011753 * Indicates what type of layer is currently associated with this view. By default
11754 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
11755 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
11756 * for more information on the different types of layers.
Joe Malin32736f02011-01-19 16:14:20 -080011757 *
Romain Guy171c5922011-01-06 10:04:23 -080011758 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
11759 * {@link #LAYER_TYPE_HARDWARE}
Joe Malin32736f02011-01-19 16:14:20 -080011760 *
11761 * @see #setLayerType(int, android.graphics.Paint)
Philip Milne6c8ea062012-04-03 17:38:43 -070011762 * @see #buildLayer()
Romain Guy171c5922011-01-06 10:04:23 -080011763 * @see #LAYER_TYPE_NONE
11764 * @see #LAYER_TYPE_SOFTWARE
11765 * @see #LAYER_TYPE_HARDWARE
11766 */
11767 public int getLayerType() {
11768 return mLayerType;
11769 }
Joe Malin32736f02011-01-19 16:14:20 -080011770
Romain Guy6c319ca2011-01-11 14:29:25 -080011771 /**
Romain Guyf1ae1062011-03-02 18:16:04 -080011772 * Forces this view's layer to be created and this view to be rendered
11773 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE},
11774 * invoking this method will have no effect.
Philip Milne6c8ea062012-04-03 17:38:43 -070011775 *
Romain Guyf1ae1062011-03-02 18:16:04 -080011776 * This method can for instance be used to render a view into its layer before
11777 * starting an animation. If this view is complex, rendering into the layer
11778 * before starting the animation will avoid skipping frames.
Philip Milne6c8ea062012-04-03 17:38:43 -070011779 *
Romain Guyf1ae1062011-03-02 18:16:04 -080011780 * @throws IllegalStateException If this view is not attached to a window
Philip Milne6c8ea062012-04-03 17:38:43 -070011781 *
11782 * @see #setLayerType(int, android.graphics.Paint)
Romain Guyf1ae1062011-03-02 18:16:04 -080011783 */
11784 public void buildLayer() {
11785 if (mLayerType == LAYER_TYPE_NONE) return;
11786
11787 if (mAttachInfo == null) {
11788 throw new IllegalStateException("This view must be attached to a window first");
11789 }
11790
11791 switch (mLayerType) {
11792 case LAYER_TYPE_HARDWARE:
Romain Guyd0609e42011-11-21 17:21:15 -080011793 if (mAttachInfo.mHardwareRenderer != null &&
11794 mAttachInfo.mHardwareRenderer.isEnabled() &&
11795 mAttachInfo.mHardwareRenderer.validate()) {
Michael Jurka7e52caf2012-03-06 15:57:06 -080011796 getHardwareLayer();
Romain Guyd0609e42011-11-21 17:21:15 -080011797 }
Romain Guyf1ae1062011-03-02 18:16:04 -080011798 break;
11799 case LAYER_TYPE_SOFTWARE:
11800 buildDrawingCache(true);
11801 break;
11802 }
11803 }
Philip Milne6c8ea062012-04-03 17:38:43 -070011804
Romain Guy9c4b79a2011-11-10 19:23:58 -080011805 // Make sure the HardwareRenderer.validate() was invoked before calling this method
11806 void flushLayer() {
11807 if (mLayerType == LAYER_TYPE_HARDWARE && mHardwareLayer != null) {
11808 mHardwareLayer.flush();
11809 }
11810 }
Romain Guyf1ae1062011-03-02 18:16:04 -080011811
11812 /**
Romain Guy6c319ca2011-01-11 14:29:25 -080011813 * <p>Returns a hardware layer that can be used to draw this view again
11814 * without executing its draw method.</p>
11815 *
11816 * @return A HardwareLayer ready to render, or null if an error occurred.
11817 */
Michael Jurka7e52caf2012-03-06 15:57:06 -080011818 HardwareLayer getHardwareLayer() {
Romain Guyea835032011-07-28 19:24:37 -070011819 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null ||
11820 !mAttachInfo.mHardwareRenderer.isEnabled()) {
Romain Guy6c319ca2011-01-11 14:29:25 -080011821 return null;
11822 }
Philip Milne6c8ea062012-04-03 17:38:43 -070011823
Romain Guy9c4b79a2011-11-10 19:23:58 -080011824 if (!mAttachInfo.mHardwareRenderer.validate()) return null;
Romain Guy6c319ca2011-01-11 14:29:25 -080011825
11826 final int width = mRight - mLeft;
11827 final int height = mBottom - mTop;
Joe Malin32736f02011-01-19 16:14:20 -080011828
Romain Guy6c319ca2011-01-11 14:29:25 -080011829 if (width == 0 || height == 0) {
11830 return null;
11831 }
11832
11833 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
11834 if (mHardwareLayer == null) {
11835 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
11836 width, height, isOpaque());
Michael Jurka952e02b2012-03-13 18:34:35 -070011837 mLocalDirtyRect.set(0, 0, width, height);
Romain Guy6c319ca2011-01-11 14:29:25 -080011838 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
11839 mHardwareLayer.resize(width, height);
Michael Jurka952e02b2012-03-13 18:34:35 -070011840 mLocalDirtyRect.set(0, 0, width, height);
Romain Guy6c319ca2011-01-11 14:29:25 -080011841 }
11842
Romain Guy5cd5c3f2011-10-17 17:10:02 -070011843 // The layer is not valid if the underlying GPU resources cannot be allocated
11844 if (!mHardwareLayer.isValid()) {
11845 return null;
11846 }
11847
Chet Haasea1cff502012-02-21 13:43:44 -080011848 mHardwareLayer.redraw(getHardwareLayerDisplayList(mHardwareLayer), mLocalDirtyRect);
Michael Jurka7e52caf2012-03-06 15:57:06 -080011849 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -080011850 }
11851
11852 return mHardwareLayer;
11853 }
Romain Guy171c5922011-01-06 10:04:23 -080011854
Romain Guy589b0bb2011-10-10 13:57:47 -070011855 /**
11856 * Destroys this View's hardware layer if possible.
Philip Milne6c8ea062012-04-03 17:38:43 -070011857 *
Romain Guy589b0bb2011-10-10 13:57:47 -070011858 * @return True if the layer was destroyed, false otherwise.
Philip Milne6c8ea062012-04-03 17:38:43 -070011859 *
11860 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy589b0bb2011-10-10 13:57:47 -070011861 * @see #LAYER_TYPE_HARDWARE
11862 */
Romain Guya998dff2012-03-23 18:58:36 -070011863 boolean destroyLayer(boolean valid) {
Romain Guy6d7475d2011-07-27 16:28:21 -070011864 if (mHardwareLayer != null) {
Romain Guy9c4b79a2011-11-10 19:23:58 -080011865 AttachInfo info = mAttachInfo;
11866 if (info != null && info.mHardwareRenderer != null &&
Romain Guya998dff2012-03-23 18:58:36 -070011867 info.mHardwareRenderer.isEnabled() &&
11868 (valid || info.mHardwareRenderer.validate())) {
Romain Guy9c4b79a2011-11-10 19:23:58 -080011869 mHardwareLayer.destroy();
11870 mHardwareLayer = null;
Romain Guy31f2c2e2011-11-21 10:55:41 -080011871
Romain Guy9c4b79a2011-11-10 19:23:58 -080011872 invalidate(true);
11873 invalidateParentCaches();
11874 }
Romain Guy65b345f2011-07-27 18:51:50 -070011875 return true;
Romain Guy6d7475d2011-07-27 16:28:21 -070011876 }
Romain Guy65b345f2011-07-27 18:51:50 -070011877 return false;
Romain Guy6d7475d2011-07-27 16:28:21 -070011878 }
11879
Romain Guy171c5922011-01-06 10:04:23 -080011880 /**
Romain Guy31f2c2e2011-11-21 10:55:41 -080011881 * Destroys all hardware rendering resources. This method is invoked
11882 * when the system needs to reclaim resources. Upon execution of this
11883 * method, you should free any OpenGL resources created by the view.
Philip Milne6c8ea062012-04-03 17:38:43 -070011884 *
Romain Guy31f2c2e2011-11-21 10:55:41 -080011885 * Note: you <strong>must</strong> call
11886 * <code>super.destroyHardwareResources()</code> when overriding
11887 * this method.
Philip Milne6c8ea062012-04-03 17:38:43 -070011888 *
Romain Guy31f2c2e2011-11-21 10:55:41 -080011889 * @hide
11890 */
11891 protected void destroyHardwareResources() {
Romain Guya998dff2012-03-23 18:58:36 -070011892 destroyLayer(true);
Romain Guy31f2c2e2011-11-21 10:55:41 -080011893 }
11894
11895 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011896 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
11897 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
11898 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
11899 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
11900 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
11901 * null.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011902 *
Romain Guy171c5922011-01-06 10:04:23 -080011903 * <p>Enabling the drawing cache is similar to
11904 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
Chet Haasedaf98e92011-01-10 14:10:36 -080011905 * acceleration is turned off. When hardware acceleration is turned on, enabling the
11906 * drawing cache has no effect on rendering because the system uses a different mechanism
11907 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even
11908 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)}
11909 * for information on how to enable software and hardware layers.</p>
11910 *
11911 * <p>This API can be used to manually generate
11912 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling
11913 * {@link #getDrawingCache()}.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011914 *
11915 * @param enabled true to enable the drawing cache, false otherwise
11916 *
11917 * @see #isDrawingCacheEnabled()
11918 * @see #getDrawingCache()
11919 * @see #buildDrawingCache()
Joe Malin32736f02011-01-19 16:14:20 -080011920 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011921 */
11922 public void setDrawingCacheEnabled(boolean enabled) {
Romain Guy0211a0a2011-02-14 16:34:59 -080011923 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011924 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
11925 }
11926
11927 /**
11928 * <p>Indicates whether the drawing cache is enabled for this view.</p>
11929 *
11930 * @return true if the drawing cache is enabled
11931 *
11932 * @see #setDrawingCacheEnabled(boolean)
11933 * @see #getDrawingCache()
11934 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070011935 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011936 public boolean isDrawingCacheEnabled() {
11937 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
11938 }
11939
11940 /**
Chet Haasedaf98e92011-01-10 14:10:36 -080011941 * Debugging utility which recursively outputs the dirty state of a view and its
11942 * descendants.
Joe Malin32736f02011-01-19 16:14:20 -080011943 *
Chet Haasedaf98e92011-01-10 14:10:36 -080011944 * @hide
11945 */
Romain Guy676b1732011-02-14 14:45:33 -080011946 @SuppressWarnings({"UnusedDeclaration"})
Chet Haasedaf98e92011-01-10 14:10:36 -080011947 public void outputDirtyFlags(String indent, boolean clear, int clearMask) {
11948 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) +
11949 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" +
11950 (mPrivateFlags & View.DRAWING_CACHE_VALID) +
11951 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")");
11952 if (clear) {
11953 mPrivateFlags &= clearMask;
11954 }
11955 if (this instanceof ViewGroup) {
11956 ViewGroup parent = (ViewGroup) this;
11957 final int count = parent.getChildCount();
11958 for (int i = 0; i < count; i++) {
Romain Guy7d7b5492011-01-24 16:33:45 -080011959 final View child = parent.getChildAt(i);
Chet Haasedaf98e92011-01-10 14:10:36 -080011960 child.outputDirtyFlags(indent + " ", clear, clearMask);
11961 }
11962 }
11963 }
11964
11965 /**
11966 * This method is used by ViewGroup to cause its children to restore or recreate their
11967 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need
11968 * to recreate its own display list, which would happen if it went through the normal
11969 * draw/dispatchDraw mechanisms.
11970 *
11971 * @hide
11972 */
11973 protected void dispatchGetDisplayList() {}
Chet Haasef4ac5472011-01-27 10:30:25 -080011974
11975 /**
11976 * A view that is not attached or hardware accelerated cannot create a display list.
11977 * This method checks these conditions and returns the appropriate result.
11978 *
11979 * @return true if view has the ability to create a display list, false otherwise.
11980 *
11981 * @hide
11982 */
11983 public boolean canHaveDisplayList() {
Romain Guy676b1732011-02-14 14:45:33 -080011984 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null);
Chet Haasef4ac5472011-01-27 10:30:25 -080011985 }
Joe Malin32736f02011-01-19 16:14:20 -080011986
Chet Haasedaf98e92011-01-10 14:10:36 -080011987 /**
Gilles Debunneb35ab7b2011-12-05 15:54:00 -080011988 * @return The HardwareRenderer associated with that view or null if hardware rendering
11989 * is not supported or this this has not been attached to a window.
11990 *
11991 * @hide
11992 */
11993 public HardwareRenderer getHardwareRenderer() {
11994 if (mAttachInfo != null) {
11995 return mAttachInfo.mHardwareRenderer;
11996 }
11997 return null;
11998 }
11999
12000 /**
Chet Haasea1cff502012-02-21 13:43:44 -080012001 * Returns a DisplayList. If the incoming displayList is null, one will be created.
12002 * Otherwise, the same display list will be returned (after having been rendered into
12003 * along the way, depending on the invalidation state of the view).
12004 *
12005 * @param displayList The previous version of this displayList, could be null.
12006 * @param isLayer Whether the requester of the display list is a layer. If so,
12007 * the view will avoid creating a layer inside the resulting display list.
12008 * @return A new or reused DisplayList object.
12009 */
12010 private DisplayList getDisplayList(DisplayList displayList, boolean isLayer) {
12011 if (!canHaveDisplayList()) {
12012 return null;
12013 }
12014
12015 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 ||
12016 displayList == null || !displayList.isValid() ||
12017 (!isLayer && mRecreateDisplayList))) {
12018 // Don't need to recreate the display list, just need to tell our
12019 // children to restore/recreate theirs
12020 if (displayList != null && displayList.isValid() &&
12021 !isLayer && !mRecreateDisplayList) {
12022 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
12023 mPrivateFlags &= ~DIRTY_MASK;
12024 dispatchGetDisplayList();
12025
12026 return displayList;
12027 }
12028
12029 if (!isLayer) {
12030 // If we got here, we're recreating it. Mark it as such to ensure that
12031 // we copy in child display lists into ours in drawChild()
12032 mRecreateDisplayList = true;
12033 }
12034 if (displayList == null) {
12035 final String name = getClass().getSimpleName();
12036 displayList = mAttachInfo.mHardwareRenderer.createDisplayList(name);
12037 // If we're creating a new display list, make sure our parent gets invalidated
12038 // since they will need to recreate their display list to account for this
12039 // new child display list.
12040 invalidateParentCaches();
12041 }
12042
12043 boolean caching = false;
12044 final HardwareCanvas canvas = displayList.start();
Chet Haasea1cff502012-02-21 13:43:44 -080012045 int width = mRight - mLeft;
12046 int height = mBottom - mTop;
12047
12048 try {
12049 canvas.setViewport(width, height);
12050 // The dirty rect should always be null for a display list
12051 canvas.onPreDraw(null);
12052 int layerType = (
12053 !(mParent instanceof ViewGroup) || ((ViewGroup)mParent).mDrawLayers) ?
12054 getLayerType() : LAYER_TYPE_NONE;
Chet Haase1271e2c2012-04-20 09:54:27 -070012055 if (!isLayer && layerType != LAYER_TYPE_NONE) {
Chet Haaseb85967b2012-03-26 14:37:51 -070012056 if (layerType == LAYER_TYPE_HARDWARE) {
12057 final HardwareLayer layer = getHardwareLayer();
12058 if (layer != null && layer.isValid()) {
12059 canvas.drawHardwareLayer(layer, 0, 0, mLayerPaint);
12060 } else {
12061 canvas.saveLayer(0, 0, mRight - mLeft, mBottom - mTop, mLayerPaint,
12062 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG |
12063 Canvas.CLIP_TO_LAYER_SAVE_FLAG);
12064 }
12065 caching = true;
Chet Haasea1cff502012-02-21 13:43:44 -080012066 } else {
Chet Haaseb85967b2012-03-26 14:37:51 -070012067 buildDrawingCache(true);
12068 Bitmap cache = getDrawingCache(true);
12069 if (cache != null) {
12070 canvas.drawBitmap(cache, 0, 0, mLayerPaint);
12071 caching = true;
12072 }
Chet Haasea1cff502012-02-21 13:43:44 -080012073 }
Chet Haasea1cff502012-02-21 13:43:44 -080012074 } else {
12075
12076 computeScroll();
12077
Chet Haasea1cff502012-02-21 13:43:44 -080012078 canvas.translate(-mScrollX, -mScrollY);
12079 if (!isLayer) {
12080 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
12081 mPrivateFlags &= ~DIRTY_MASK;
12082 }
12083
12084 // Fast path for layouts with no backgrounds
12085 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12086 dispatchDraw(canvas);
12087 } else {
12088 draw(canvas);
12089 }
12090 }
12091 } finally {
Chet Haasea1cff502012-02-21 13:43:44 -080012092 canvas.onPostDraw();
12093
12094 displayList.end();
Chet Haase1271e2c2012-04-20 09:54:27 -070012095 displayList.setCaching(caching);
12096 if (isLayer) {
Chet Haasea1cff502012-02-21 13:43:44 -080012097 displayList.setLeftTopRightBottom(0, 0, width, height);
12098 } else {
12099 setDisplayListProperties(displayList);
12100 }
12101 }
12102 } else if (!isLayer) {
12103 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
12104 mPrivateFlags &= ~DIRTY_MASK;
12105 }
12106
12107 return displayList;
12108 }
12109
12110 /**
12111 * Get the DisplayList for the HardwareLayer
12112 *
12113 * @param layer The HardwareLayer whose DisplayList we want
12114 * @return A DisplayList fopr the specified HardwareLayer
12115 */
12116 private DisplayList getHardwareLayerDisplayList(HardwareLayer layer) {
12117 DisplayList displayList = getDisplayList(layer.getDisplayList(), true);
12118 layer.setDisplayList(displayList);
12119 return displayList;
12120 }
12121
12122
12123 /**
Romain Guyb051e892010-09-28 19:09:36 -070012124 * <p>Returns a display list that can be used to draw this view again
12125 * without executing its draw method.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012126 *
Romain Guyb051e892010-09-28 19:09:36 -070012127 * @return A DisplayList ready to replay, or null if caching is not enabled.
Chet Haasedaf98e92011-01-10 14:10:36 -080012128 *
12129 * @hide
Romain Guyb051e892010-09-28 19:09:36 -070012130 */
Chet Haasedaf98e92011-01-10 14:10:36 -080012131 public DisplayList getDisplayList() {
Chet Haasea1cff502012-02-21 13:43:44 -080012132 mDisplayList = getDisplayList(mDisplayList, false);
Romain Guyb051e892010-09-28 19:09:36 -070012133 return mDisplayList;
12134 }
12135
12136 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070012137 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012138 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012139 * @return A non-scaled bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -080012140 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012141 * @see #getDrawingCache(boolean)
12142 */
12143 public Bitmap getDrawingCache() {
12144 return getDrawingCache(false);
12145 }
12146
12147 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012148 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
12149 * is null when caching is disabled. If caching is enabled and the cache is not ready,
12150 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
12151 * draw from the cache when the cache is enabled. To benefit from the cache, you must
12152 * request the drawing cache by calling this method and draw it on screen if the
12153 * returned bitmap is not null.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012154 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012155 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
12156 * this method will create a bitmap of the same size as this view. Because this bitmap
12157 * will be drawn scaled by the parent ViewGroup, the result on screen might show
12158 * scaling artifacts. To avoid such artifacts, you should call this method by setting
12159 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
12160 * size than the view. This implies that your application must be able to handle this
12161 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012162 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012163 * @param autoScale Indicates whether the generated bitmap should be scaled based on
12164 * the current density of the screen when the application is in compatibility
12165 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012166 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012167 * @return A bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -080012168 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012169 * @see #setDrawingCacheEnabled(boolean)
12170 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -070012171 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012172 * @see #destroyDrawingCache()
12173 */
Romain Guyfbd8f692009-06-26 14:51:58 -070012174 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012175 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
12176 return null;
12177 }
12178 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012179 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012180 }
Romain Guy02890fd2010-08-06 17:58:44 -070012181 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012182 }
12183
12184 /**
12185 * <p>Frees the resources used by the drawing cache. If you call
12186 * {@link #buildDrawingCache()} manually without calling
12187 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
12188 * should cleanup the cache with this method afterwards.</p>
12189 *
12190 * @see #setDrawingCacheEnabled(boolean)
12191 * @see #buildDrawingCache()
12192 * @see #getDrawingCache()
12193 */
12194 public void destroyDrawingCache() {
12195 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070012196 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012197 mDrawingCache = null;
12198 }
Romain Guyfbd8f692009-06-26 14:51:58 -070012199 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070012200 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -070012201 mUnscaledDrawingCache = null;
12202 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012203 }
12204
12205 /**
12206 * Setting a solid background color for the drawing cache's bitmaps will improve
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070012207 * performance and memory usage. Note, though that this should only be used if this
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012208 * view will always be drawn on top of a solid color.
12209 *
12210 * @param color The background color to use for the drawing cache's bitmap
12211 *
12212 * @see #setDrawingCacheEnabled(boolean)
12213 * @see #buildDrawingCache()
12214 * @see #getDrawingCache()
12215 */
12216 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -080012217 if (color != mDrawingCacheBackgroundColor) {
12218 mDrawingCacheBackgroundColor = color;
12219 mPrivateFlags &= ~DRAWING_CACHE_VALID;
12220 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012221 }
12222
12223 /**
12224 * @see #setDrawingCacheBackgroundColor(int)
12225 *
12226 * @return The background color to used for the drawing cache's bitmap
12227 */
12228 public int getDrawingCacheBackgroundColor() {
12229 return mDrawingCacheBackgroundColor;
12230 }
12231
12232 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070012233 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012234 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012235 * @see #buildDrawingCache(boolean)
12236 */
12237 public void buildDrawingCache() {
12238 buildDrawingCache(false);
12239 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -080012240
Romain Guyfbd8f692009-06-26 14:51:58 -070012241 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012242 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
12243 *
12244 * <p>If you call {@link #buildDrawingCache()} manually without calling
12245 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
12246 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012247 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012248 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
12249 * this method will create a bitmap of the same size as this view. Because this bitmap
12250 * will be drawn scaled by the parent ViewGroup, the result on screen might show
12251 * scaling artifacts. To avoid such artifacts, you should call this method by setting
12252 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
12253 * size than the view. This implies that your application must be able to handle this
12254 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012255 *
Romain Guy0d9275e2010-10-26 14:22:30 -070012256 * <p>You should avoid calling this method when hardware acceleration is enabled. If
12257 * you do not need the drawing cache bitmap, calling this method will increase memory
Joe Malin32736f02011-01-19 16:14:20 -080012258 * usage and cause the view to be rendered in software once, thus negatively impacting
Romain Guy0d9275e2010-10-26 14:22:30 -070012259 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012260 *
12261 * @see #getDrawingCache()
12262 * @see #destroyDrawingCache()
12263 */
Romain Guyfbd8f692009-06-26 14:51:58 -070012264 public void buildDrawingCache(boolean autoScale) {
12265 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -070012266 mDrawingCache == null : mUnscaledDrawingCache == null)) {
Romain Guy0211a0a2011-02-14 16:34:59 -080012267 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012268
12269 if (ViewDebug.TRACE_HIERARCHY) {
12270 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
12271 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012272
Romain Guy8506ab42009-06-11 17:35:47 -070012273 int width = mRight - mLeft;
12274 int height = mBottom - mTop;
12275
12276 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -070012277 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -070012278
Romain Guye1123222009-06-29 14:24:56 -070012279 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012280 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
12281 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -070012282 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012283
12284 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -070012285 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -080012286 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012287
12288 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -070012289 // Projected bitmap size in bytes
Adam Powell26153a32010-11-08 15:22:27 -080012290 (width * height * (opaque && !use32BitCache ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012291 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
12292 destroyDrawingCache();
Romain Guy0211a0a2011-02-14 16:34:59 -080012293 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012294 return;
12295 }
12296
12297 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -070012298 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012299
12300 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012301 Bitmap.Config quality;
12302 if (!opaque) {
Romain Guy676b1732011-02-14 14:45:33 -080012303 // Never pick ARGB_4444 because it looks awful
12304 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012305 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
12306 case DRAWING_CACHE_QUALITY_AUTO:
12307 quality = Bitmap.Config.ARGB_8888;
12308 break;
12309 case DRAWING_CACHE_QUALITY_LOW:
Romain Guy676b1732011-02-14 14:45:33 -080012310 quality = Bitmap.Config.ARGB_8888;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012311 break;
12312 case DRAWING_CACHE_QUALITY_HIGH:
12313 quality = Bitmap.Config.ARGB_8888;
12314 break;
12315 default:
12316 quality = Bitmap.Config.ARGB_8888;
12317 break;
12318 }
12319 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -070012320 // Optimization for translucent windows
12321 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -080012322 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012323 }
12324
12325 // Try to cleanup memory
12326 if (bitmap != null) bitmap.recycle();
12327
12328 try {
12329 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -070012330 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -070012331 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -070012332 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070012333 } else {
Romain Guy02890fd2010-08-06 17:58:44 -070012334 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070012335 }
Adam Powell26153a32010-11-08 15:22:27 -080012336 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012337 } catch (OutOfMemoryError e) {
12338 // If there is not enough memory to create the bitmap cache, just
12339 // ignore the issue as bitmap caches are not required to draw the
12340 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -070012341 if (autoScale) {
12342 mDrawingCache = null;
12343 } else {
12344 mUnscaledDrawingCache = null;
12345 }
Romain Guy0211a0a2011-02-14 16:34:59 -080012346 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012347 return;
12348 }
12349
12350 clear = drawingCacheBackgroundColor != 0;
12351 }
12352
12353 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012354 if (attachInfo != null) {
12355 canvas = attachInfo.mCanvas;
12356 if (canvas == null) {
12357 canvas = new Canvas();
12358 }
12359 canvas.setBitmap(bitmap);
12360 // Temporarily clobber the cached Canvas in case one of our children
12361 // is also using a drawing cache. Without this, the children would
12362 // steal the canvas by attaching their own bitmap to it and bad, bad
12363 // thing would happen (invisible views, corrupted drawings, etc.)
12364 attachInfo.mCanvas = null;
12365 } else {
12366 // This case should hopefully never or seldom happen
12367 canvas = new Canvas(bitmap);
12368 }
12369
12370 if (clear) {
12371 bitmap.eraseColor(drawingCacheBackgroundColor);
12372 }
12373
12374 computeScroll();
12375 final int restoreCount = canvas.save();
Joe Malin32736f02011-01-19 16:14:20 -080012376
Romain Guye1123222009-06-29 14:24:56 -070012377 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012378 final float scale = attachInfo.mApplicationScale;
12379 canvas.scale(scale, scale);
12380 }
Joe Malin32736f02011-01-19 16:14:20 -080012381
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012382 canvas.translate(-mScrollX, -mScrollY);
12383
Romain Guy5bcdff42009-05-14 21:27:18 -070012384 mPrivateFlags |= DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -080012385 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
12386 mLayerType != LAYER_TYPE_NONE) {
Romain Guy0d9275e2010-10-26 14:22:30 -070012387 mPrivateFlags |= DRAWING_CACHE_VALID;
12388 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012389
12390 // Fast path for layouts with no backgrounds
12391 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12392 if (ViewDebug.TRACE_HIERARCHY) {
12393 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
12394 }
Romain Guy5bcdff42009-05-14 21:27:18 -070012395 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012396 dispatchDraw(canvas);
12397 } else {
12398 draw(canvas);
12399 }
12400
12401 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070012402 canvas.setBitmap(null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012403
12404 if (attachInfo != null) {
12405 // Restore the cached Canvas for our siblings
12406 attachInfo.mCanvas = canvas;
12407 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012408 }
12409 }
12410
12411 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012412 * Create a snapshot of the view into a bitmap. We should probably make
12413 * some form of this public, but should think about the API.
12414 */
Romain Guy223ff5c2010-03-02 17:07:47 -080012415 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012416 int width = mRight - mLeft;
12417 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012418
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012419 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -070012420 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012421 width = (int) ((width * scale) + 0.5f);
12422 height = (int) ((height * scale) + 0.5f);
Joe Malin32736f02011-01-19 16:14:20 -080012423
Romain Guy8c11e312009-09-14 15:15:30 -070012424 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012425 if (bitmap == null) {
12426 throw new OutOfMemoryError();
12427 }
12428
Romain Guyc529d8d2011-09-06 15:01:39 -070012429 Resources resources = getResources();
12430 if (resources != null) {
12431 bitmap.setDensity(resources.getDisplayMetrics().densityDpi);
12432 }
Joe Malin32736f02011-01-19 16:14:20 -080012433
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012434 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012435 if (attachInfo != null) {
12436 canvas = attachInfo.mCanvas;
12437 if (canvas == null) {
12438 canvas = new Canvas();
12439 }
12440 canvas.setBitmap(bitmap);
12441 // Temporarily clobber the cached Canvas in case one of our children
12442 // is also using a drawing cache. Without this, the children would
12443 // steal the canvas by attaching their own bitmap to it and bad, bad
12444 // things would happen (invisible views, corrupted drawings, etc.)
12445 attachInfo.mCanvas = null;
12446 } else {
12447 // This case should hopefully never or seldom happen
12448 canvas = new Canvas(bitmap);
12449 }
12450
Romain Guy5bcdff42009-05-14 21:27:18 -070012451 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012452 bitmap.eraseColor(backgroundColor);
12453 }
12454
12455 computeScroll();
12456 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012457 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012458 canvas.translate(-mScrollX, -mScrollY);
12459
Romain Guy5bcdff42009-05-14 21:27:18 -070012460 // Temporarily remove the dirty mask
12461 int flags = mPrivateFlags;
12462 mPrivateFlags &= ~DIRTY_MASK;
12463
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012464 // Fast path for layouts with no backgrounds
12465 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12466 dispatchDraw(canvas);
12467 } else {
12468 draw(canvas);
12469 }
12470
Romain Guy5bcdff42009-05-14 21:27:18 -070012471 mPrivateFlags = flags;
12472
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012473 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070012474 canvas.setBitmap(null);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012475
12476 if (attachInfo != null) {
12477 // Restore the cached Canvas for our siblings
12478 attachInfo.mCanvas = canvas;
12479 }
Romain Guy8506ab42009-06-11 17:35:47 -070012480
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012481 return bitmap;
12482 }
12483
12484 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012485 * Indicates whether this View is currently in edit mode. A View is usually
12486 * in edit mode when displayed within a developer tool. For instance, if
12487 * this View is being drawn by a visual user interface builder, this method
12488 * should return true.
12489 *
12490 * Subclasses should check the return value of this method to provide
12491 * different behaviors if their normal behavior might interfere with the
12492 * host environment. For instance: the class spawns a thread in its
12493 * constructor, the drawing code relies on device-specific features, etc.
12494 *
12495 * This method is usually checked in the drawing code of custom widgets.
12496 *
12497 * @return True if this View is in edit mode, false otherwise.
12498 */
12499 public boolean isInEditMode() {
12500 return false;
12501 }
12502
12503 /**
12504 * If the View draws content inside its padding and enables fading edges,
12505 * it needs to support padding offsets. Padding offsets are added to the
12506 * fading edges to extend the length of the fade so that it covers pixels
12507 * drawn inside the padding.
12508 *
12509 * Subclasses of this class should override this method if they need
12510 * to draw content inside the padding.
12511 *
12512 * @return True if padding offset must be applied, false otherwise.
12513 *
12514 * @see #getLeftPaddingOffset()
12515 * @see #getRightPaddingOffset()
12516 * @see #getTopPaddingOffset()
12517 * @see #getBottomPaddingOffset()
12518 *
12519 * @since CURRENT
12520 */
12521 protected boolean isPaddingOffsetRequired() {
12522 return false;
12523 }
12524
12525 /**
12526 * Amount by which to extend the left fading region. Called only when
12527 * {@link #isPaddingOffsetRequired()} returns true.
12528 *
12529 * @return The left padding offset in pixels.
12530 *
12531 * @see #isPaddingOffsetRequired()
12532 *
12533 * @since CURRENT
12534 */
12535 protected int getLeftPaddingOffset() {
12536 return 0;
12537 }
12538
12539 /**
12540 * Amount by which to extend the right fading region. Called only when
12541 * {@link #isPaddingOffsetRequired()} returns true.
12542 *
12543 * @return The right padding offset in pixels.
12544 *
12545 * @see #isPaddingOffsetRequired()
12546 *
12547 * @since CURRENT
12548 */
12549 protected int getRightPaddingOffset() {
12550 return 0;
12551 }
12552
12553 /**
12554 * Amount by which to extend the top fading region. Called only when
12555 * {@link #isPaddingOffsetRequired()} returns true.
12556 *
12557 * @return The top padding offset in pixels.
12558 *
12559 * @see #isPaddingOffsetRequired()
12560 *
12561 * @since CURRENT
12562 */
12563 protected int getTopPaddingOffset() {
12564 return 0;
12565 }
12566
12567 /**
12568 * Amount by which to extend the bottom fading region. Called only when
12569 * {@link #isPaddingOffsetRequired()} returns true.
12570 *
12571 * @return The bottom padding offset in pixels.
12572 *
12573 * @see #isPaddingOffsetRequired()
12574 *
12575 * @since CURRENT
12576 */
12577 protected int getBottomPaddingOffset() {
12578 return 0;
12579 }
12580
12581 /**
Romain Guyf2fc4602011-07-19 15:20:03 -070012582 * @hide
12583 * @param offsetRequired
12584 */
12585 protected int getFadeTop(boolean offsetRequired) {
12586 int top = mPaddingTop;
12587 if (offsetRequired) top += getTopPaddingOffset();
12588 return top;
12589 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012590
Romain Guyf2fc4602011-07-19 15:20:03 -070012591 /**
12592 * @hide
12593 * @param offsetRequired
12594 */
12595 protected int getFadeHeight(boolean offsetRequired) {
12596 int padding = mPaddingTop;
Philip Milne6c8ea062012-04-03 17:38:43 -070012597 if (offsetRequired) padding += getTopPaddingOffset();
Romain Guyf2fc4602011-07-19 15:20:03 -070012598 return mBottom - mTop - mPaddingBottom - padding;
12599 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012600
Romain Guyf2fc4602011-07-19 15:20:03 -070012601 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +090012602 * <p>Indicates whether this view is attached to a hardware accelerated
Romain Guy2bffd262010-09-12 17:40:02 -070012603 * window or not.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012604 *
Romain Guy2bffd262010-09-12 17:40:02 -070012605 * <p>Even if this method returns true, it does not mean that every call
12606 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
12607 * accelerated {@link android.graphics.Canvas}. For instance, if this view
Ken Wakasaf76a50c2012-03-09 19:56:35 +090012608 * is drawn onto an offscreen {@link android.graphics.Bitmap} and its
Romain Guy2bffd262010-09-12 17:40:02 -070012609 * window is hardware accelerated,
12610 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
12611 * return false, and this method will return true.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012612 *
Romain Guy2bffd262010-09-12 17:40:02 -070012613 * @return True if the view is attached to a window and the window is
12614 * hardware accelerated; false in any other case.
12615 */
12616 public boolean isHardwareAccelerated() {
12617 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
12618 }
Joe Malin32736f02011-01-19 16:14:20 -080012619
Romain Guy2bffd262010-09-12 17:40:02 -070012620 /**
Chet Haasebcca79a2012-02-14 08:45:14 -080012621 * Utility function, called by draw(canvas, parent, drawingTime) to handle the less common
12622 * case of an active Animation being run on the view.
12623 */
12624 private boolean drawAnimation(ViewGroup parent, long drawingTime,
12625 Animation a, boolean scalingRequired) {
12626 Transformation invalidationTransform;
12627 final int flags = parent.mGroupFlags;
12628 final boolean initialized = a.isInitialized();
12629 if (!initialized) {
Chet Haase1fb8a9e2012-04-19 09:22:34 -070012630 a.initialize(mRight - mLeft, mBottom - mTop, parent.getWidth(), parent.getHeight());
Chet Haasebcca79a2012-02-14 08:45:14 -080012631 a.initializeInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop);
12632 onAnimationStart();
12633 }
12634
12635 boolean more = a.getTransformation(drawingTime, parent.mChildTransformation, 1f);
12636 if (scalingRequired && mAttachInfo.mApplicationScale != 1f) {
12637 if (parent.mInvalidationTransformation == null) {
12638 parent.mInvalidationTransformation = new Transformation();
12639 }
12640 invalidationTransform = parent.mInvalidationTransformation;
12641 a.getTransformation(drawingTime, invalidationTransform, 1f);
12642 } else {
12643 invalidationTransform = parent.mChildTransformation;
12644 }
12645 if (more) {
12646 if (!a.willChangeBounds()) {
12647 if ((flags & (parent.FLAG_OPTIMIZE_INVALIDATE | parent.FLAG_ANIMATION_DONE)) ==
12648 parent.FLAG_OPTIMIZE_INVALIDATE) {
12649 parent.mGroupFlags |= parent.FLAG_INVALIDATE_REQUIRED;
12650 } else if ((flags & parent.FLAG_INVALIDATE_REQUIRED) == 0) {
12651 // The child need to draw an animation, potentially offscreen, so
12652 // make sure we do not cancel invalidate requests
12653 parent.mPrivateFlags |= DRAW_ANIMATION;
12654 parent.invalidate(mLeft, mTop, mRight, mBottom);
12655 }
12656 } else {
12657 if (parent.mInvalidateRegion == null) {
12658 parent.mInvalidateRegion = new RectF();
12659 }
12660 final RectF region = parent.mInvalidateRegion;
12661 a.getInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop, region,
12662 invalidationTransform);
12663
12664 // The child need to draw an animation, potentially offscreen, so
12665 // make sure we do not cancel invalidate requests
12666 parent.mPrivateFlags |= DRAW_ANIMATION;
12667
12668 final int left = mLeft + (int) region.left;
12669 final int top = mTop + (int) region.top;
12670 parent.invalidate(left, top, left + (int) (region.width() + .5f),
12671 top + (int) (region.height() + .5f));
12672 }
12673 }
12674 return more;
12675 }
12676
Chet Haasea1cff502012-02-21 13:43:44 -080012677 /**
12678 * This method is called by getDisplayList() when a display list is created or re-rendered.
12679 * It sets or resets the current value of all properties on that display list (resetting is
12680 * necessary when a display list is being re-created, because we need to make sure that
12681 * previously-set transform values
12682 */
12683 void setDisplayListProperties(DisplayList displayList) {
Chet Haase1271e2c2012-04-20 09:54:27 -070012684 if (displayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080012685 displayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom);
Chet Haasedb8c9a62012-03-21 18:54:18 -070012686 displayList.setHasOverlappingRendering(hasOverlappingRendering());
Chet Haasea1cff502012-02-21 13:43:44 -080012687 if (mParent instanceof ViewGroup) {
12688 displayList.setClipChildren(
12689 (((ViewGroup)mParent).mGroupFlags & ViewGroup.FLAG_CLIP_CHILDREN) != 0);
12690 }
Chet Haase9420abd2012-03-29 16:28:32 -070012691 float alpha = 1;
12692 if (mParent instanceof ViewGroup && (((ViewGroup) mParent).mGroupFlags &
12693 ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
12694 ViewGroup parentVG = (ViewGroup) mParent;
12695 final boolean hasTransform =
12696 parentVG.getChildStaticTransformation(this, parentVG.mChildTransformation);
12697 if (hasTransform) {
12698 Transformation transform = parentVG.mChildTransformation;
12699 final int transformType = parentVG.mChildTransformation.getTransformationType();
12700 if (transformType != Transformation.TYPE_IDENTITY) {
12701 if ((transformType & Transformation.TYPE_ALPHA) != 0) {
12702 alpha = transform.getAlpha();
12703 }
12704 if ((transformType & Transformation.TYPE_MATRIX) != 0) {
12705 displayList.setStaticMatrix(transform.getMatrix());
12706 }
12707 }
12708 }
Chet Haasea1cff502012-02-21 13:43:44 -080012709 }
12710 if (mTransformationInfo != null) {
Chet Haase9420abd2012-03-29 16:28:32 -070012711 alpha *= mTransformationInfo.mAlpha;
12712 if (alpha < 1) {
12713 final int multipliedAlpha = (int) (255 * alpha);
12714 if (onSetAlpha(multipliedAlpha)) {
12715 alpha = 1;
12716 }
12717 }
12718 displayList.setTransformationInfo(alpha,
Chet Haasea1cff502012-02-21 13:43:44 -080012719 mTransformationInfo.mTranslationX, mTransformationInfo.mTranslationY,
12720 mTransformationInfo.mRotation, mTransformationInfo.mRotationX,
12721 mTransformationInfo.mRotationY, mTransformationInfo.mScaleX,
12722 mTransformationInfo.mScaleY);
Chet Haaseb85967b2012-03-26 14:37:51 -070012723 if (mTransformationInfo.mCamera == null) {
12724 mTransformationInfo.mCamera = new Camera();
12725 mTransformationInfo.matrix3D = new Matrix();
12726 }
12727 displayList.setCameraDistance(mTransformationInfo.mCamera.getLocationZ());
Chet Haasea1cff502012-02-21 13:43:44 -080012728 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == PIVOT_EXPLICITLY_SET) {
12729 displayList.setPivotX(getPivotX());
12730 displayList.setPivotY(getPivotY());
12731 }
Chet Haase9420abd2012-03-29 16:28:32 -070012732 } else if (alpha < 1) {
12733 displayList.setAlpha(alpha);
Chet Haasea1cff502012-02-21 13:43:44 -080012734 }
12735 }
12736 }
12737
Chet Haasebcca79a2012-02-14 08:45:14 -080012738 /**
Chet Haase64a48c12012-02-13 16:33:29 -080012739 * This method is called by ViewGroup.drawChild() to have each child view draw itself.
12740 * This draw() method is an implementation detail and is not intended to be overridden or
12741 * to be called from anywhere else other than ViewGroup.drawChild().
12742 */
12743 boolean draw(Canvas canvas, ViewGroup parent, long drawingTime) {
Chet Haase1271e2c2012-04-20 09:54:27 -070012744 boolean useDisplayListProperties = mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
Chet Haase64a48c12012-02-13 16:33:29 -080012745 boolean more = false;
Chet Haase64a48c12012-02-13 16:33:29 -080012746 final boolean childHasIdentityMatrix = hasIdentityMatrix();
Chet Haase64a48c12012-02-13 16:33:29 -080012747 final int flags = parent.mGroupFlags;
12748
Chet Haasea1cff502012-02-21 13:43:44 -080012749 if ((flags & ViewGroup.FLAG_CLEAR_TRANSFORMATION) == ViewGroup.FLAG_CLEAR_TRANSFORMATION) {
Chet Haase64a48c12012-02-13 16:33:29 -080012750 parent.mChildTransformation.clear();
Chet Haasea1cff502012-02-21 13:43:44 -080012751 parent.mGroupFlags &= ~ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080012752 }
12753
12754 Transformation transformToApply = null;
Chet Haase64a48c12012-02-13 16:33:29 -080012755 boolean concatMatrix = false;
12756
12757 boolean scalingRequired = false;
12758 boolean caching;
12759 int layerType = parent.mDrawLayers ? getLayerType() : LAYER_TYPE_NONE;
12760
12761 final boolean hardwareAccelerated = canvas.isHardwareAccelerated();
Chet Haasea1cff502012-02-21 13:43:44 -080012762 if ((flags & ViewGroup.FLAG_CHILDREN_DRAWN_WITH_CACHE) != 0 ||
12763 (flags & ViewGroup.FLAG_ALWAYS_DRAWN_WITH_CACHE) != 0) {
Chet Haase64a48c12012-02-13 16:33:29 -080012764 caching = true;
Chet Haase9420abd2012-03-29 16:28:32 -070012765 // Auto-scaled apps are not hw-accelerated, no need to set scaling flag on DisplayList
Chet Haase64a48c12012-02-13 16:33:29 -080012766 if (mAttachInfo != null) scalingRequired = mAttachInfo.mScalingRequired;
12767 } else {
12768 caching = (layerType != LAYER_TYPE_NONE) || hardwareAccelerated;
12769 }
12770
Chet Haasebcca79a2012-02-14 08:45:14 -080012771 final Animation a = getAnimation();
Chet Haase64a48c12012-02-13 16:33:29 -080012772 if (a != null) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012773 more = drawAnimation(parent, drawingTime, a, scalingRequired);
Chet Haase64a48c12012-02-13 16:33:29 -080012774 concatMatrix = a.willChangeTransformationMatrix();
Chet Haasebcca79a2012-02-14 08:45:14 -080012775 transformToApply = parent.mChildTransformation;
Chet Haase9420abd2012-03-29 16:28:32 -070012776 } else if (!useDisplayListProperties &&
12777 (flags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012778 final boolean hasTransform =
12779 parent.getChildStaticTransformation(this, parent.mChildTransformation);
Chet Haase64a48c12012-02-13 16:33:29 -080012780 if (hasTransform) {
12781 final int transformType = parent.mChildTransformation.getTransformationType();
12782 transformToApply = transformType != Transformation.TYPE_IDENTITY ?
12783 parent.mChildTransformation : null;
12784 concatMatrix = (transformType & Transformation.TYPE_MATRIX) != 0;
12785 }
12786 }
12787
12788 concatMatrix |= !childHasIdentityMatrix;
12789
12790 // Sets the flag as early as possible to allow draw() implementations
12791 // to call invalidate() successfully when doing animations
12792 mPrivateFlags |= DRAWN;
12793
Chet Haasebcca79a2012-02-14 08:45:14 -080012794 if (!concatMatrix && canvas.quickReject(mLeft, mTop, mRight, mBottom, Canvas.EdgeType.BW) &&
Chet Haase64a48c12012-02-13 16:33:29 -080012795 (mPrivateFlags & DRAW_ANIMATION) == 0) {
12796 return more;
12797 }
12798
12799 if (hardwareAccelerated) {
12800 // Clear INVALIDATED flag to allow invalidation to occur during rendering, but
12801 // retain the flag's value temporarily in the mRecreateDisplayList flag
12802 mRecreateDisplayList = (mPrivateFlags & INVALIDATED) == INVALIDATED;
12803 mPrivateFlags &= ~INVALIDATED;
12804 }
12805
12806 computeScroll();
12807
12808 final int sx = mScrollX;
12809 final int sy = mScrollY;
12810
12811 DisplayList displayList = null;
12812 Bitmap cache = null;
12813 boolean hasDisplayList = false;
12814 if (caching) {
12815 if (!hardwareAccelerated) {
12816 if (layerType != LAYER_TYPE_NONE) {
12817 layerType = LAYER_TYPE_SOFTWARE;
12818 buildDrawingCache(true);
12819 }
12820 cache = getDrawingCache(true);
12821 } else {
12822 switch (layerType) {
12823 case LAYER_TYPE_SOFTWARE:
Chet Haaseb85967b2012-03-26 14:37:51 -070012824 if (useDisplayListProperties) {
12825 hasDisplayList = canHaveDisplayList();
12826 } else {
12827 buildDrawingCache(true);
12828 cache = getDrawingCache(true);
12829 }
Chet Haase64a48c12012-02-13 16:33:29 -080012830 break;
Chet Haasea1cff502012-02-21 13:43:44 -080012831 case LAYER_TYPE_HARDWARE:
12832 if (useDisplayListProperties) {
12833 hasDisplayList = canHaveDisplayList();
12834 }
12835 break;
Chet Haase64a48c12012-02-13 16:33:29 -080012836 case LAYER_TYPE_NONE:
12837 // Delay getting the display list until animation-driven alpha values are
12838 // set up and possibly passed on to the view
12839 hasDisplayList = canHaveDisplayList();
12840 break;
12841 }
12842 }
12843 }
Chet Haasea1cff502012-02-21 13:43:44 -080012844 useDisplayListProperties &= hasDisplayList;
Chet Haase9420abd2012-03-29 16:28:32 -070012845 if (useDisplayListProperties) {
12846 displayList = getDisplayList();
12847 if (!displayList.isValid()) {
12848 // Uncommon, but possible. If a view is removed from the hierarchy during the call
12849 // to getDisplayList(), the display list will be marked invalid and we should not
12850 // try to use it again.
12851 displayList = null;
12852 hasDisplayList = false;
12853 useDisplayListProperties = false;
12854 }
12855 }
Chet Haase64a48c12012-02-13 16:33:29 -080012856
12857 final boolean hasNoCache = cache == null || hasDisplayList;
12858 final boolean offsetForScroll = cache == null && !hasDisplayList &&
12859 layerType != LAYER_TYPE_HARDWARE;
12860
Chet Haasea1cff502012-02-21 13:43:44 -080012861 int restoreTo = -1;
Chet Haase89b7f2e2012-03-21 11:15:37 -070012862 if (!useDisplayListProperties || transformToApply != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080012863 restoreTo = canvas.save();
12864 }
Chet Haase64a48c12012-02-13 16:33:29 -080012865 if (offsetForScroll) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012866 canvas.translate(mLeft - sx, mTop - sy);
Chet Haase64a48c12012-02-13 16:33:29 -080012867 } else {
Chet Haasea1cff502012-02-21 13:43:44 -080012868 if (!useDisplayListProperties) {
12869 canvas.translate(mLeft, mTop);
12870 }
Chet Haase64a48c12012-02-13 16:33:29 -080012871 if (scalingRequired) {
Chet Haasea1cff502012-02-21 13:43:44 -080012872 if (useDisplayListProperties) {
Chet Haase9420abd2012-03-29 16:28:32 -070012873 // TODO: Might not need this if we put everything inside the DL
Chet Haasea1cff502012-02-21 13:43:44 -080012874 restoreTo = canvas.save();
12875 }
Chet Haase64a48c12012-02-13 16:33:29 -080012876 // mAttachInfo cannot be null, otherwise scalingRequired == false
12877 final float scale = 1.0f / mAttachInfo.mApplicationScale;
12878 canvas.scale(scale, scale);
12879 }
12880 }
12881
Chet Haasea1cff502012-02-21 13:43:44 -080012882 float alpha = useDisplayListProperties ? 1 : getAlpha();
Chet Haase9420abd2012-03-29 16:28:32 -070012883 if (transformToApply != null || alpha < 1 || !hasIdentityMatrix()) {
Chet Haase64a48c12012-02-13 16:33:29 -080012884 if (transformToApply != null || !childHasIdentityMatrix) {
12885 int transX = 0;
12886 int transY = 0;
12887
12888 if (offsetForScroll) {
12889 transX = -sx;
12890 transY = -sy;
12891 }
12892
12893 if (transformToApply != null) {
12894 if (concatMatrix) {
Chet Haase9420abd2012-03-29 16:28:32 -070012895 if (useDisplayListProperties) {
12896 displayList.setAnimationMatrix(transformToApply.getMatrix());
12897 } else {
12898 // Undo the scroll translation, apply the transformation matrix,
12899 // then redo the scroll translate to get the correct result.
12900 canvas.translate(-transX, -transY);
12901 canvas.concat(transformToApply.getMatrix());
12902 canvas.translate(transX, transY);
12903 }
Chet Haasea1cff502012-02-21 13:43:44 -080012904 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080012905 }
12906
12907 float transformAlpha = transformToApply.getAlpha();
Chet Haase9420abd2012-03-29 16:28:32 -070012908 if (transformAlpha < 1) {
Chet Haase64a48c12012-02-13 16:33:29 -080012909 alpha *= transformToApply.getAlpha();
Chet Haasea1cff502012-02-21 13:43:44 -080012910 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080012911 }
12912 }
12913
Chet Haasea1cff502012-02-21 13:43:44 -080012914 if (!childHasIdentityMatrix && !useDisplayListProperties) {
Chet Haase64a48c12012-02-13 16:33:29 -080012915 canvas.translate(-transX, -transY);
12916 canvas.concat(getMatrix());
12917 canvas.translate(transX, transY);
12918 }
12919 }
12920
Chet Haase9420abd2012-03-29 16:28:32 -070012921 if (alpha < 1) {
Chet Haasea1cff502012-02-21 13:43:44 -080012922 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080012923 if (hasNoCache) {
12924 final int multipliedAlpha = (int) (255 * alpha);
12925 if (!onSetAlpha(multipliedAlpha)) {
12926 int layerFlags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
Chet Haasea1cff502012-02-21 13:43:44 -080012927 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) != 0 ||
Chet Haase64a48c12012-02-13 16:33:29 -080012928 layerType != LAYER_TYPE_NONE) {
12929 layerFlags |= Canvas.CLIP_TO_LAYER_SAVE_FLAG;
12930 }
Chet Haase9420abd2012-03-29 16:28:32 -070012931 if (useDisplayListProperties) {
12932 displayList.setAlpha(alpha * getAlpha());
12933 } else if (layerType == LAYER_TYPE_NONE) {
Chet Haase89b7f2e2012-03-21 11:15:37 -070012934 final int scrollX = hasDisplayList ? 0 : sx;
12935 final int scrollY = hasDisplayList ? 0 : sy;
12936 canvas.saveLayerAlpha(scrollX, scrollY, scrollX + mRight - mLeft,
12937 scrollY + mBottom - mTop, multipliedAlpha, layerFlags);
Chet Haase64a48c12012-02-13 16:33:29 -080012938 }
12939 } else {
12940 // Alpha is handled by the child directly, clobber the layer's alpha
12941 mPrivateFlags |= ALPHA_SET;
12942 }
12943 }
12944 }
12945 } else if ((mPrivateFlags & ALPHA_SET) == ALPHA_SET) {
12946 onSetAlpha(255);
12947 mPrivateFlags &= ~ALPHA_SET;
12948 }
12949
Chet Haasea1cff502012-02-21 13:43:44 -080012950 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) == ViewGroup.FLAG_CLIP_CHILDREN &&
12951 !useDisplayListProperties) {
Chet Haase64a48c12012-02-13 16:33:29 -080012952 if (offsetForScroll) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012953 canvas.clipRect(sx, sy, sx + (mRight - mLeft), sy + (mBottom - mTop));
Chet Haase64a48c12012-02-13 16:33:29 -080012954 } else {
12955 if (!scalingRequired || cache == null) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012956 canvas.clipRect(0, 0, mRight - mLeft, mBottom - mTop);
Chet Haase64a48c12012-02-13 16:33:29 -080012957 } else {
12958 canvas.clipRect(0, 0, cache.getWidth(), cache.getHeight());
12959 }
12960 }
12961 }
12962
Chet Haase9420abd2012-03-29 16:28:32 -070012963 if (!useDisplayListProperties && hasDisplayList) {
Chet Haase64a48c12012-02-13 16:33:29 -080012964 displayList = getDisplayList();
12965 if (!displayList.isValid()) {
12966 // Uncommon, but possible. If a view is removed from the hierarchy during the call
12967 // to getDisplayList(), the display list will be marked invalid and we should not
12968 // try to use it again.
12969 displayList = null;
12970 hasDisplayList = false;
12971 }
12972 }
12973
12974 if (hasNoCache) {
12975 boolean layerRendered = false;
Chet Haasea1cff502012-02-21 13:43:44 -080012976 if (layerType == LAYER_TYPE_HARDWARE && !useDisplayListProperties) {
Michael Jurka7e52caf2012-03-06 15:57:06 -080012977 final HardwareLayer layer = getHardwareLayer();
Chet Haase64a48c12012-02-13 16:33:29 -080012978 if (layer != null && layer.isValid()) {
12979 mLayerPaint.setAlpha((int) (alpha * 255));
12980 ((HardwareCanvas) canvas).drawHardwareLayer(layer, 0, 0, mLayerPaint);
12981 layerRendered = true;
12982 } else {
12983 final int scrollX = hasDisplayList ? 0 : sx;
12984 final int scrollY = hasDisplayList ? 0 : sy;
12985 canvas.saveLayer(scrollX, scrollY,
Chet Haasebcca79a2012-02-14 08:45:14 -080012986 scrollX + mRight - mLeft, scrollY + mBottom - mTop, mLayerPaint,
Chet Haase64a48c12012-02-13 16:33:29 -080012987 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | Canvas.CLIP_TO_LAYER_SAVE_FLAG);
12988 }
12989 }
12990
12991 if (!layerRendered) {
12992 if (!hasDisplayList) {
12993 // Fast path for layouts with no backgrounds
12994 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12995 if (ViewDebug.TRACE_HIERARCHY) {
12996 ViewDebug.trace(parent, ViewDebug.HierarchyTraceType.DRAW);
12997 }
12998 mPrivateFlags &= ~DIRTY_MASK;
12999 dispatchDraw(canvas);
13000 } else {
13001 draw(canvas);
13002 }
13003 } else {
13004 mPrivateFlags &= ~DIRTY_MASK;
Chet Haase1271e2c2012-04-20 09:54:27 -070013005 ((HardwareCanvas) canvas).drawDisplayList(displayList, null, flags);
Chet Haase64a48c12012-02-13 16:33:29 -080013006 }
13007 }
13008 } else if (cache != null) {
13009 mPrivateFlags &= ~DIRTY_MASK;
13010 Paint cachePaint;
13011
13012 if (layerType == LAYER_TYPE_NONE) {
13013 cachePaint = parent.mCachePaint;
13014 if (cachePaint == null) {
13015 cachePaint = new Paint();
13016 cachePaint.setDither(false);
13017 parent.mCachePaint = cachePaint;
13018 }
Chet Haase9420abd2012-03-29 16:28:32 -070013019 if (alpha < 1) {
Chet Haase64a48c12012-02-13 16:33:29 -080013020 cachePaint.setAlpha((int) (alpha * 255));
Chet Haasea1cff502012-02-21 13:43:44 -080013021 parent.mGroupFlags |= ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE;
13022 } else if ((flags & ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE) != 0) {
Chet Haase64a48c12012-02-13 16:33:29 -080013023 cachePaint.setAlpha(255);
Chet Haasea1cff502012-02-21 13:43:44 -080013024 parent.mGroupFlags &= ~ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE;
Chet Haase64a48c12012-02-13 16:33:29 -080013025 }
13026 } else {
13027 cachePaint = mLayerPaint;
13028 cachePaint.setAlpha((int) (alpha * 255));
13029 }
13030 canvas.drawBitmap(cache, 0.0f, 0.0f, cachePaint);
13031 }
13032
Chet Haasea1cff502012-02-21 13:43:44 -080013033 if (restoreTo >= 0) {
13034 canvas.restoreToCount(restoreTo);
13035 }
Chet Haase64a48c12012-02-13 16:33:29 -080013036
13037 if (a != null && !more) {
13038 if (!hardwareAccelerated && !a.getFillAfter()) {
13039 onSetAlpha(255);
13040 }
13041 parent.finishAnimatingView(this, a);
13042 }
13043
13044 if (more && hardwareAccelerated) {
13045 // invalidation is the trigger to recreate display lists, so if we're using
13046 // display lists to render, force an invalidate to allow the animation to
13047 // continue drawing another frame
13048 parent.invalidate(true);
13049 if (a.hasAlpha() && (mPrivateFlags & ALPHA_SET) == ALPHA_SET) {
13050 // alpha animations should cause the child to recreate its display list
13051 invalidate(true);
13052 }
13053 }
13054
13055 mRecreateDisplayList = false;
13056
13057 return more;
13058 }
13059
13060 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013061 * Manually render this view (and all of its children) to the given Canvas.
13062 * The view must have already done a full layout before this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070013063 * called. When implementing a view, implement
13064 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method.
13065 * If you do need to override this method, call the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013066 *
13067 * @param canvas The Canvas to which the View is rendered.
13068 */
13069 public void draw(Canvas canvas) {
13070 if (ViewDebug.TRACE_HIERARCHY) {
13071 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
13072 }
13073
Romain Guy5bcdff42009-05-14 21:27:18 -070013074 final int privateFlags = mPrivateFlags;
13075 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
13076 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
13077 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -070013078
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013079 /*
13080 * Draw traversal performs several drawing steps which must be executed
13081 * in the appropriate order:
13082 *
13083 * 1. Draw the background
13084 * 2. If necessary, save the canvas' layers to prepare for fading
13085 * 3. Draw view's content
13086 * 4. Draw children
13087 * 5. If necessary, draw the fading edges and restore layers
13088 * 6. Draw decorations (scrollbars for instance)
13089 */
13090
13091 // Step 1, draw the background, if needed
13092 int saveCount;
13093
Romain Guy24443ea2009-05-11 11:56:30 -070013094 if (!dirtyOpaque) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013095 final Drawable background = mBackground;
Romain Guy24443ea2009-05-11 11:56:30 -070013096 if (background != null) {
13097 final int scrollX = mScrollX;
13098 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013099
Romain Guy24443ea2009-05-11 11:56:30 -070013100 if (mBackgroundSizeChanged) {
13101 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
13102 mBackgroundSizeChanged = false;
13103 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013104
Romain Guy24443ea2009-05-11 11:56:30 -070013105 if ((scrollX | scrollY) == 0) {
13106 background.draw(canvas);
13107 } else {
13108 canvas.translate(scrollX, scrollY);
13109 background.draw(canvas);
13110 canvas.translate(-scrollX, -scrollY);
13111 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013112 }
13113 }
13114
13115 // skip step 2 & 5 if possible (common case)
13116 final int viewFlags = mViewFlags;
13117 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
13118 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
13119 if (!verticalEdges && !horizontalEdges) {
13120 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070013121 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013122
13123 // Step 4, draw the children
13124 dispatchDraw(canvas);
13125
13126 // Step 6, draw decorations (scrollbars)
13127 onDrawScrollBars(canvas);
13128
13129 // we're done...
13130 return;
13131 }
13132
13133 /*
13134 * Here we do the full fledged routine...
13135 * (this is an uncommon case where speed matters less,
13136 * this is why we repeat some of the tests that have been
13137 * done above)
13138 */
13139
13140 boolean drawTop = false;
13141 boolean drawBottom = false;
13142 boolean drawLeft = false;
13143 boolean drawRight = false;
13144
13145 float topFadeStrength = 0.0f;
13146 float bottomFadeStrength = 0.0f;
13147 float leftFadeStrength = 0.0f;
13148 float rightFadeStrength = 0.0f;
13149
13150 // Step 2, save the canvas' layers
13151 int paddingLeft = mPaddingLeft;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013152
13153 final boolean offsetRequired = isPaddingOffsetRequired();
13154 if (offsetRequired) {
13155 paddingLeft += getLeftPaddingOffset();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013156 }
13157
13158 int left = mScrollX + paddingLeft;
13159 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
Romain Guyf2fc4602011-07-19 15:20:03 -070013160 int top = mScrollY + getFadeTop(offsetRequired);
13161 int bottom = top + getFadeHeight(offsetRequired);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013162
13163 if (offsetRequired) {
13164 right += getRightPaddingOffset();
13165 bottom += getBottomPaddingOffset();
13166 }
13167
13168 final ScrollabilityCache scrollabilityCache = mScrollCache;
Philip Milne6c8ea062012-04-03 17:38:43 -070013169 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013170 int length = (int) fadeHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013171
13172 // clip the fade length if top and bottom fades overlap
13173 // overlapping fades produce odd-looking artifacts
13174 if (verticalEdges && (top + length > bottom - length)) {
13175 length = (bottom - top) / 2;
13176 }
13177
13178 // also clip horizontal fades if necessary
13179 if (horizontalEdges && (left + length > right - length)) {
13180 length = (right - left) / 2;
13181 }
13182
13183 if (verticalEdges) {
13184 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013185 drawTop = topFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013186 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013187 drawBottom = bottomFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013188 }
13189
13190 if (horizontalEdges) {
13191 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013192 drawLeft = leftFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013193 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013194 drawRight = rightFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013195 }
13196
13197 saveCount = canvas.getSaveCount();
13198
13199 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -070013200 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013201 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
13202
13203 if (drawTop) {
13204 canvas.saveLayer(left, top, right, top + length, null, flags);
13205 }
13206
13207 if (drawBottom) {
13208 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
13209 }
13210
13211 if (drawLeft) {
13212 canvas.saveLayer(left, top, left + length, bottom, null, flags);
13213 }
13214
13215 if (drawRight) {
13216 canvas.saveLayer(right - length, top, right, bottom, null, flags);
13217 }
13218 } else {
13219 scrollabilityCache.setFadeColor(solidColor);
13220 }
13221
13222 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070013223 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013224
13225 // Step 4, draw the children
13226 dispatchDraw(canvas);
13227
13228 // Step 5, draw the fade effect and restore layers
13229 final Paint p = scrollabilityCache.paint;
13230 final Matrix matrix = scrollabilityCache.matrix;
13231 final Shader fade = scrollabilityCache.shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013232
13233 if (drawTop) {
13234 matrix.setScale(1, fadeHeight * topFadeStrength);
13235 matrix.postTranslate(left, top);
13236 fade.setLocalMatrix(matrix);
13237 canvas.drawRect(left, top, right, top + length, p);
13238 }
13239
13240 if (drawBottom) {
13241 matrix.setScale(1, fadeHeight * bottomFadeStrength);
13242 matrix.postRotate(180);
13243 matrix.postTranslate(left, bottom);
13244 fade.setLocalMatrix(matrix);
13245 canvas.drawRect(left, bottom - length, right, bottom, p);
13246 }
13247
13248 if (drawLeft) {
13249 matrix.setScale(1, fadeHeight * leftFadeStrength);
13250 matrix.postRotate(-90);
13251 matrix.postTranslate(left, top);
13252 fade.setLocalMatrix(matrix);
13253 canvas.drawRect(left, top, left + length, bottom, p);
13254 }
13255
13256 if (drawRight) {
13257 matrix.setScale(1, fadeHeight * rightFadeStrength);
13258 matrix.postRotate(90);
13259 matrix.postTranslate(right, top);
13260 fade.setLocalMatrix(matrix);
13261 canvas.drawRect(right - length, top, right, bottom, p);
13262 }
13263
13264 canvas.restoreToCount(saveCount);
13265
13266 // Step 6, draw decorations (scrollbars)
13267 onDrawScrollBars(canvas);
13268 }
13269
13270 /**
13271 * Override this if your view is known to always be drawn on top of a solid color background,
13272 * and needs to draw fading edges. Returning a non-zero color enables the view system to
13273 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
13274 * should be set to 0xFF.
13275 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013276 * @see #setVerticalFadingEdgeEnabled(boolean)
13277 * @see #setHorizontalFadingEdgeEnabled(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013278 *
13279 * @return The known solid color background for this view, or 0 if the color may vary
13280 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013281 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013282 public int getSolidColor() {
13283 return 0;
13284 }
13285
13286 /**
13287 * Build a human readable string representation of the specified view flags.
13288 *
13289 * @param flags the view flags to convert to a string
13290 * @return a String representing the supplied flags
13291 */
13292 private static String printFlags(int flags) {
13293 String output = "";
13294 int numFlags = 0;
13295 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
13296 output += "TAKES_FOCUS";
13297 numFlags++;
13298 }
13299
13300 switch (flags & VISIBILITY_MASK) {
13301 case INVISIBLE:
13302 if (numFlags > 0) {
13303 output += " ";
13304 }
13305 output += "INVISIBLE";
13306 // USELESS HERE numFlags++;
13307 break;
13308 case GONE:
13309 if (numFlags > 0) {
13310 output += " ";
13311 }
13312 output += "GONE";
13313 // USELESS HERE numFlags++;
13314 break;
13315 default:
13316 break;
13317 }
13318 return output;
13319 }
13320
13321 /**
13322 * Build a human readable string representation of the specified private
13323 * view flags.
13324 *
13325 * @param privateFlags the private view flags to convert to a string
13326 * @return a String representing the supplied flags
13327 */
13328 private static String printPrivateFlags(int privateFlags) {
13329 String output = "";
13330 int numFlags = 0;
13331
13332 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
13333 output += "WANTS_FOCUS";
13334 numFlags++;
13335 }
13336
13337 if ((privateFlags & FOCUSED) == FOCUSED) {
13338 if (numFlags > 0) {
13339 output += " ";
13340 }
13341 output += "FOCUSED";
13342 numFlags++;
13343 }
13344
13345 if ((privateFlags & SELECTED) == SELECTED) {
13346 if (numFlags > 0) {
13347 output += " ";
13348 }
13349 output += "SELECTED";
13350 numFlags++;
13351 }
13352
13353 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
13354 if (numFlags > 0) {
13355 output += " ";
13356 }
13357 output += "IS_ROOT_NAMESPACE";
13358 numFlags++;
13359 }
13360
13361 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
13362 if (numFlags > 0) {
13363 output += " ";
13364 }
13365 output += "HAS_BOUNDS";
13366 numFlags++;
13367 }
13368
13369 if ((privateFlags & DRAWN) == DRAWN) {
13370 if (numFlags > 0) {
13371 output += " ";
13372 }
13373 output += "DRAWN";
13374 // USELESS HERE numFlags++;
13375 }
13376 return output;
13377 }
13378
13379 /**
13380 * <p>Indicates whether or not this view's layout will be requested during
13381 * the next hierarchy layout pass.</p>
13382 *
13383 * @return true if the layout will be forced during next layout pass
13384 */
13385 public boolean isLayoutRequested() {
13386 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
13387 }
13388
13389 /**
13390 * Assign a size and position to a view and all of its
13391 * descendants
13392 *
13393 * <p>This is the second phase of the layout mechanism.
13394 * (The first is measuring). In this phase, each parent calls
13395 * layout on all of its children to position them.
13396 * This is typically done using the child measurements
Chet Haase9c087442011-01-12 16:20:16 -080013397 * that were stored in the measure pass().</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013398 *
Chet Haase9c087442011-01-12 16:20:16 -080013399 * <p>Derived classes should not override this method.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013400 * Derived classes with children should override
13401 * onLayout. In that method, they should
Chet Haase9c087442011-01-12 16:20:16 -080013402 * call layout on each of their children.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013403 *
13404 * @param l Left position, relative to parent
13405 * @param t Top position, relative to parent
13406 * @param r Right position, relative to parent
13407 * @param b Bottom position, relative to parent
13408 */
Romain Guy5429e1d2010-09-07 12:38:00 -070013409 @SuppressWarnings({"unchecked"})
Chet Haase9c087442011-01-12 16:20:16 -080013410 public void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -070013411 int oldL = mLeft;
13412 int oldT = mTop;
13413 int oldB = mBottom;
13414 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013415 boolean changed = setFrame(l, t, r, b);
13416 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
13417 if (ViewDebug.TRACE_HIERARCHY) {
13418 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
13419 }
13420
13421 onLayout(changed, l, t, r, b);
13422 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -070013423
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070013424 ListenerInfo li = mListenerInfo;
13425 if (li != null && li.mOnLayoutChangeListeners != null) {
Chet Haase21cd1382010-09-01 17:42:29 -070013426 ArrayList<OnLayoutChangeListener> listenersCopy =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070013427 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone();
Chet Haase21cd1382010-09-01 17:42:29 -070013428 int numListeners = listenersCopy.size();
13429 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -070013430 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -070013431 }
13432 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013433 }
13434 mPrivateFlags &= ~FORCE_LAYOUT;
13435 }
13436
13437 /**
13438 * Called from layout when this view should
13439 * assign a size and position to each of its children.
13440 *
13441 * Derived classes with children should override
13442 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -070013443 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013444 * @param changed This is a new size or position for this view
13445 * @param left Left position, relative to parent
13446 * @param top Top position, relative to parent
13447 * @param right Right position, relative to parent
13448 * @param bottom Bottom position, relative to parent
13449 */
13450 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
13451 }
13452
13453 /**
13454 * Assign a size and position to this view.
13455 *
13456 * This is called from layout.
13457 *
13458 * @param left Left position, relative to parent
13459 * @param top Top position, relative to parent
13460 * @param right Right position, relative to parent
13461 * @param bottom Bottom position, relative to parent
13462 * @return true if the new size and position are different than the
13463 * previous ones
13464 * {@hide}
13465 */
13466 protected boolean setFrame(int left, int top, int right, int bottom) {
13467 boolean changed = false;
13468
13469 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -070013470 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013471 + right + "," + bottom + ")");
13472 }
13473
13474 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
13475 changed = true;
13476
13477 // Remember our drawn bit
13478 int drawn = mPrivateFlags & DRAWN;
13479
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013480 int oldWidth = mRight - mLeft;
13481 int oldHeight = mBottom - mTop;
Chet Haase75755e22011-07-18 17:48:25 -070013482 int newWidth = right - left;
13483 int newHeight = bottom - top;
13484 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight);
13485
13486 // Invalidate our old position
13487 invalidate(sizeChanged);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013488
13489 mLeft = left;
13490 mTop = top;
13491 mRight = right;
13492 mBottom = bottom;
Chet Haase1271e2c2012-04-20 09:54:27 -070013493 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080013494 mDisplayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom);
13495 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013496
13497 mPrivateFlags |= HAS_BOUNDS;
13498
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013499
Chet Haase75755e22011-07-18 17:48:25 -070013500 if (sizeChanged) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013501 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
13502 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -070013503 if (mTransformationInfo != null) {
13504 mTransformationInfo.mMatrixDirty = true;
13505 }
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013506 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013507 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
13508 }
13509
13510 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
13511 // If we are visible, force the DRAWN bit to on so that
13512 // this invalidate will go through (at least to our parent).
13513 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013514 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013515 // the DRAWN bit.
13516 mPrivateFlags |= DRAWN;
Chet Haase75755e22011-07-18 17:48:25 -070013517 invalidate(sizeChanged);
Chet Haasef28595e2011-01-31 18:52:12 -080013518 // parent display list may need to be recreated based on a change in the bounds
13519 // of any child
13520 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013521 }
13522
13523 // Reset drawn bit to original value (invalidate turns it off)
13524 mPrivateFlags |= drawn;
13525
13526 mBackgroundSizeChanged = true;
13527 }
13528 return changed;
13529 }
13530
13531 /**
13532 * Finalize inflating a view from XML. This is called as the last phase
13533 * of inflation, after all child views have been added.
13534 *
13535 * <p>Even if the subclass overrides onFinishInflate, they should always be
13536 * sure to call the super method, so that we get called.
13537 */
13538 protected void onFinishInflate() {
13539 }
13540
13541 /**
13542 * Returns the resources associated with this view.
13543 *
13544 * @return Resources object.
13545 */
13546 public Resources getResources() {
13547 return mResources;
13548 }
13549
13550 /**
13551 * Invalidates the specified Drawable.
13552 *
13553 * @param drawable the drawable to invalidate
13554 */
13555 public void invalidateDrawable(Drawable drawable) {
13556 if (verifyDrawable(drawable)) {
13557 final Rect dirty = drawable.getBounds();
13558 final int scrollX = mScrollX;
13559 final int scrollY = mScrollY;
13560
13561 invalidate(dirty.left + scrollX, dirty.top + scrollY,
13562 dirty.right + scrollX, dirty.bottom + scrollY);
13563 }
13564 }
13565
13566 /**
13567 * Schedules an action on a drawable to occur at a specified time.
13568 *
13569 * @param who the recipient of the action
13570 * @param what the action to run on the drawable
13571 * @param when the time at which the action must occur. Uses the
13572 * {@link SystemClock#uptimeMillis} timebase.
13573 */
13574 public void scheduleDrawable(Drawable who, Runnable what, long when) {
Adam Powell37419d72011-11-10 11:32:09 -080013575 if (verifyDrawable(who) && what != null) {
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080013576 final long delay = when - SystemClock.uptimeMillis();
Adam Powell37419d72011-11-10 11:32:09 -080013577 if (mAttachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013578 mAttachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed(
13579 Choreographer.CALLBACK_ANIMATION, what, who,
13580 Choreographer.subtractFrameDelay(delay));
Adam Powell37419d72011-11-10 11:32:09 -080013581 } else {
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080013582 ViewRootImpl.getRunQueue().postDelayed(what, delay);
Adam Powell37419d72011-11-10 11:32:09 -080013583 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013584 }
13585 }
13586
13587 /**
13588 * Cancels a scheduled action on a drawable.
13589 *
13590 * @param who the recipient of the action
13591 * @param what the action to cancel
13592 */
13593 public void unscheduleDrawable(Drawable who, Runnable what) {
Adam Powell37419d72011-11-10 11:32:09 -080013594 if (verifyDrawable(who) && what != null) {
13595 if (mAttachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013596 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
13597 Choreographer.CALLBACK_ANIMATION, what, who);
Adam Powell37419d72011-11-10 11:32:09 -080013598 } else {
13599 ViewRootImpl.getRunQueue().removeCallbacks(what);
13600 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013601 }
13602 }
13603
13604 /**
13605 * Unschedule any events associated with the given Drawable. This can be
13606 * used when selecting a new Drawable into a view, so that the previous
13607 * one is completely unscheduled.
13608 *
13609 * @param who The Drawable to unschedule.
13610 *
13611 * @see #drawableStateChanged
13612 */
13613 public void unscheduleDrawable(Drawable who) {
Jeff Brown43ea54b2012-03-09 14:37:48 -080013614 if (mAttachInfo != null && who != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013615 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
13616 Choreographer.CALLBACK_ANIMATION, null, who);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013617 }
13618 }
13619
Fabrice Di Meglioc0053222011-06-13 12:16:51 -070013620 /**
13621 * Return the layout direction of a given Drawable.
13622 *
13623 * @param who the Drawable to query
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070013624 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -070013625 */
13626 public int getResolvedLayoutDirection(Drawable who) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013627 return (who == mBackground) ? getResolvedLayoutDirection() : LAYOUT_DIRECTION_DEFAULT;
Fabrice Di Meglio6a036402011-05-23 14:43:23 -070013628 }
13629
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013630 /**
13631 * If your view subclass is displaying its own Drawable objects, it should
13632 * override this function and return true for any Drawable it is
13633 * displaying. This allows animations for those drawables to be
13634 * scheduled.
13635 *
13636 * <p>Be sure to call through to the super class when overriding this
13637 * function.
13638 *
13639 * @param who The Drawable to verify. Return true if it is one you are
13640 * displaying, else return the result of calling through to the
13641 * super class.
13642 *
13643 * @return boolean If true than the Drawable is being displayed in the
13644 * view; else false and it is not allowed to animate.
13645 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013646 * @see #unscheduleDrawable(android.graphics.drawable.Drawable)
13647 * @see #drawableStateChanged()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013648 */
13649 protected boolean verifyDrawable(Drawable who) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013650 return who == mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013651 }
13652
13653 /**
13654 * This function is called whenever the state of the view changes in such
13655 * a way that it impacts the state of drawables being shown.
13656 *
13657 * <p>Be sure to call through to the superclass when overriding this
13658 * function.
13659 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013660 * @see Drawable#setState(int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013661 */
13662 protected void drawableStateChanged() {
Philip Milne6c8ea062012-04-03 17:38:43 -070013663 Drawable d = mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013664 if (d != null && d.isStateful()) {
13665 d.setState(getDrawableState());
13666 }
13667 }
13668
13669 /**
13670 * Call this to force a view to update its drawable state. This will cause
13671 * drawableStateChanged to be called on this view. Views that are interested
13672 * in the new state should call getDrawableState.
13673 *
13674 * @see #drawableStateChanged
13675 * @see #getDrawableState
13676 */
13677 public void refreshDrawableState() {
13678 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
13679 drawableStateChanged();
13680
13681 ViewParent parent = mParent;
13682 if (parent != null) {
13683 parent.childDrawableStateChanged(this);
13684 }
13685 }
13686
13687 /**
13688 * Return an array of resource IDs of the drawable states representing the
13689 * current state of the view.
13690 *
13691 * @return The current drawable state
13692 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013693 * @see Drawable#setState(int[])
13694 * @see #drawableStateChanged()
13695 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013696 */
13697 public final int[] getDrawableState() {
13698 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
13699 return mDrawableState;
13700 } else {
13701 mDrawableState = onCreateDrawableState(0);
13702 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
13703 return mDrawableState;
13704 }
13705 }
13706
13707 /**
13708 * Generate the new {@link android.graphics.drawable.Drawable} state for
13709 * this view. This is called by the view
13710 * system when the cached Drawable state is determined to be invalid. To
13711 * retrieve the current state, you should use {@link #getDrawableState}.
13712 *
13713 * @param extraSpace if non-zero, this is the number of extra entries you
13714 * would like in the returned array in which you can place your own
13715 * states.
13716 *
13717 * @return Returns an array holding the current {@link Drawable} state of
13718 * the view.
13719 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013720 * @see #mergeDrawableStates(int[], int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013721 */
13722 protected int[] onCreateDrawableState(int extraSpace) {
13723 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
13724 mParent instanceof View) {
13725 return ((View) mParent).onCreateDrawableState(extraSpace);
13726 }
13727
13728 int[] drawableState;
13729
13730 int privateFlags = mPrivateFlags;
13731
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013732 int viewStateIndex = 0;
13733 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
13734 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
13735 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -070013736 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013737 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
13738 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Adam Powell5a7e94e2011-04-25 15:30:43 -070013739 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested &&
13740 HardwareRenderer.isAvailable()) {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080013741 // This is set if HW acceleration is requested, even if the current
13742 // process doesn't allow it. This is just to allow app preview
13743 // windows to better match their app.
13744 viewStateIndex |= VIEW_STATE_ACCELERATED;
13745 }
PY Laligandc33d8d49e2011-03-14 18:22:53 -070013746 if ((privateFlags & HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013747
Christopher Tate3d4bf172011-03-28 16:16:46 -070013748 final int privateFlags2 = mPrivateFlags2;
13749 if ((privateFlags2 & DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT;
13750 if ((privateFlags2 & DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED;
13751
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013752 drawableState = VIEW_STATE_SETS[viewStateIndex];
13753
13754 //noinspection ConstantIfStatement
13755 if (false) {
13756 Log.i("View", "drawableStateIndex=" + viewStateIndex);
13757 Log.i("View", toString()
13758 + " pressed=" + ((privateFlags & PRESSED) != 0)
13759 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
13760 + " fo=" + hasFocus()
13761 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013762 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013763 + ": " + Arrays.toString(drawableState));
13764 }
13765
13766 if (extraSpace == 0) {
13767 return drawableState;
13768 }
13769
13770 final int[] fullState;
13771 if (drawableState != null) {
13772 fullState = new int[drawableState.length + extraSpace];
13773 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
13774 } else {
13775 fullState = new int[extraSpace];
13776 }
13777
13778 return fullState;
13779 }
13780
13781 /**
13782 * Merge your own state values in <var>additionalState</var> into the base
13783 * state values <var>baseState</var> that were returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070013784 * {@link #onCreateDrawableState(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013785 *
13786 * @param baseState The base state values returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070013787 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013788 * own additional state values.
13789 *
13790 * @param additionalState The additional state values you would like
13791 * added to <var>baseState</var>; this array is not modified.
13792 *
13793 * @return As a convenience, the <var>baseState</var> array you originally
13794 * passed into the function is returned.
13795 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013796 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013797 */
13798 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
13799 final int N = baseState.length;
13800 int i = N - 1;
13801 while (i >= 0 && baseState[i] == 0) {
13802 i--;
13803 }
13804 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
13805 return baseState;
13806 }
13807
13808 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -070013809 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
13810 * on all Drawable objects associated with this view.
13811 */
13812 public void jumpDrawablesToCurrentState() {
Philip Milne6c8ea062012-04-03 17:38:43 -070013813 if (mBackground != null) {
13814 mBackground.jumpToCurrentState();
Dianne Hackborn079e2352010-10-18 17:02:43 -070013815 }
13816 }
13817
13818 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013819 * Sets the background color for this view.
13820 * @param color the color of the background
13821 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000013822 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013823 public void setBackgroundColor(int color) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013824 if (mBackground instanceof ColorDrawable) {
13825 ((ColorDrawable) mBackground).setColor(color);
Chet Haase70d4ba12010-10-06 09:46:45 -070013826 } else {
Philip Milne6c8ea062012-04-03 17:38:43 -070013827 setBackground(new ColorDrawable(color));
Chet Haase70d4ba12010-10-06 09:46:45 -070013828 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013829 }
13830
13831 /**
13832 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -070013833 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013834 * @param resid The identifier of the resource.
Philip Milne6c8ea062012-04-03 17:38:43 -070013835 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013836 * @attr ref android.R.styleable#View_background
13837 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000013838 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013839 public void setBackgroundResource(int resid) {
13840 if (resid != 0 && resid == mBackgroundResource) {
13841 return;
13842 }
13843
13844 Drawable d= null;
13845 if (resid != 0) {
13846 d = mResources.getDrawable(resid);
13847 }
Philip Milne6c8ea062012-04-03 17:38:43 -070013848 setBackground(d);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013849
13850 mBackgroundResource = resid;
13851 }
13852
13853 /**
13854 * Set the background to a given Drawable, or remove the background. If the
13855 * background has padding, this View's padding is set to the background's
13856 * padding. However, when a background is removed, this View's padding isn't
13857 * touched. If setting the padding is desired, please use
13858 * {@link #setPadding(int, int, int, int)}.
13859 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013860 * @param background The Drawable to use as the background, or null to remove the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013861 * background
13862 */
Philip Milne6c8ea062012-04-03 17:38:43 -070013863 public void setBackground(Drawable background) {
Romain Guyeb378892012-04-12 11:33:14 -070013864 //noinspection deprecation
Philip Milne6c8ea062012-04-03 17:38:43 -070013865 setBackgroundDrawable(background);
13866 }
13867
13868 /**
13869 * @deprecated use {@link #setBackground(Drawable)} instead
13870 */
13871 @Deprecated
13872 public void setBackgroundDrawable(Drawable background) {
13873 if (background == mBackground) {
Adam Powell4d36ec12011-07-17 16:44:16 -070013874 return;
13875 }
13876
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013877 boolean requestLayout = false;
13878
13879 mBackgroundResource = 0;
13880
13881 /*
13882 * Regardless of whether we're setting a new background or not, we want
13883 * to clear the previous drawable.
13884 */
Philip Milne6c8ea062012-04-03 17:38:43 -070013885 if (mBackground != null) {
13886 mBackground.setCallback(null);
13887 unscheduleDrawable(mBackground);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013888 }
13889
Philip Milne6c8ea062012-04-03 17:38:43 -070013890 if (background != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013891 Rect padding = sThreadLocal.get();
13892 if (padding == null) {
13893 padding = new Rect();
13894 sThreadLocal.set(padding);
13895 }
Philip Milne6c8ea062012-04-03 17:38:43 -070013896 if (background.getPadding(padding)) {
13897 switch (background.getResolvedLayoutDirectionSelf()) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070013898 case LAYOUT_DIRECTION_RTL:
13899 setPadding(padding.right, padding.top, padding.left, padding.bottom);
13900 break;
13901 case LAYOUT_DIRECTION_LTR:
13902 default:
13903 setPadding(padding.left, padding.top, padding.right, padding.bottom);
13904 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013905 }
13906
13907 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
13908 // if it has a different minimum size, we should layout again
Philip Milne6c8ea062012-04-03 17:38:43 -070013909 if (mBackground == null || mBackground.getMinimumHeight() != background.getMinimumHeight() ||
13910 mBackground.getMinimumWidth() != background.getMinimumWidth()) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013911 requestLayout = true;
13912 }
13913
Philip Milne6c8ea062012-04-03 17:38:43 -070013914 background.setCallback(this);
13915 if (background.isStateful()) {
13916 background.setState(getDrawableState());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013917 }
Philip Milne6c8ea062012-04-03 17:38:43 -070013918 background.setVisible(getVisibility() == VISIBLE, false);
13919 mBackground = background;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013920
13921 if ((mPrivateFlags & SKIP_DRAW) != 0) {
13922 mPrivateFlags &= ~SKIP_DRAW;
13923 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
13924 requestLayout = true;
13925 }
13926 } else {
13927 /* Remove the background */
Philip Milne6c8ea062012-04-03 17:38:43 -070013928 mBackground = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013929
13930 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
13931 /*
13932 * This view ONLY drew the background before and we're removing
13933 * the background, so now it won't draw anything
13934 * (hence we SKIP_DRAW)
13935 */
13936 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
13937 mPrivateFlags |= SKIP_DRAW;
13938 }
13939
13940 /*
13941 * When the background is set, we try to apply its padding to this
13942 * View. When the background is removed, we don't touch this View's
13943 * padding. This is noted in the Javadocs. Hence, we don't need to
13944 * requestLayout(), the invalidate() below is sufficient.
13945 */
13946
13947 // The old background's minimum size could have affected this
13948 // View's layout, so let's requestLayout
13949 requestLayout = true;
13950 }
13951
Romain Guy8f1344f52009-05-15 16:03:59 -070013952 computeOpaqueFlags();
13953
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013954 if (requestLayout) {
13955 requestLayout();
13956 }
13957
13958 mBackgroundSizeChanged = true;
Romain Guy0fd89bf2011-01-26 15:41:30 -080013959 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013960 }
13961
13962 /**
13963 * Gets the background drawable
Philip Milne6c8ea062012-04-03 17:38:43 -070013964 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013965 * @return The drawable used as the background for this view, if any.
Philip Milne6c8ea062012-04-03 17:38:43 -070013966 *
13967 * @see #setBackground(Drawable)
13968 *
13969 * @attr ref android.R.styleable#View_background
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013970 */
13971 public Drawable getBackground() {
Philip Milne6c8ea062012-04-03 17:38:43 -070013972 return mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013973 }
13974
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013975 /**
13976 * Sets the padding. The view may add on the space required to display
13977 * the scrollbars, depending on the style and visibility of the scrollbars.
13978 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
13979 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
13980 * from the values set in this call.
13981 *
13982 * @attr ref android.R.styleable#View_padding
13983 * @attr ref android.R.styleable#View_paddingBottom
13984 * @attr ref android.R.styleable#View_paddingLeft
13985 * @attr ref android.R.styleable#View_paddingRight
13986 * @attr ref android.R.styleable#View_paddingTop
13987 * @param left the left padding in pixels
13988 * @param top the top padding in pixels
13989 * @param right the right padding in pixels
13990 * @param bottom the bottom padding in pixels
13991 */
13992 public void setPadding(int left, int top, int right, int bottom) {
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080013993 mUserPaddingStart = -1;
13994 mUserPaddingEnd = -1;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070013995 mUserPaddingRelative = false;
13996
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080013997 internalSetPadding(left, top, right, bottom);
13998 }
13999
14000 private void internalSetPadding(int left, int top, int right, int bottom) {
Adam Powell20232d02010-12-08 21:08:53 -080014001 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014002 mUserPaddingRight = right;
14003 mUserPaddingBottom = bottom;
14004
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014005 final int viewFlags = mViewFlags;
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014006 boolean changed = false;
Romain Guy8506ab42009-06-11 17:35:47 -070014007
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014008 // Common case is there are no scroll bars.
14009 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014010 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -080014011 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014012 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -080014013 switch (mVerticalScrollbarPosition) {
14014 case SCROLLBAR_POSITION_DEFAULT:
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014015 if (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
14016 left += offset;
14017 } else {
14018 right += offset;
14019 }
14020 break;
Adam Powell20232d02010-12-08 21:08:53 -080014021 case SCROLLBAR_POSITION_RIGHT:
14022 right += offset;
14023 break;
14024 case SCROLLBAR_POSITION_LEFT:
14025 left += offset;
14026 break;
14027 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014028 }
Adam Powell20232d02010-12-08 21:08:53 -080014029 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014030 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
14031 ? 0 : getHorizontalScrollbarHeight();
14032 }
14033 }
Romain Guy8506ab42009-06-11 17:35:47 -070014034
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014035 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014036 changed = true;
14037 mPaddingLeft = left;
14038 }
14039 if (mPaddingTop != top) {
14040 changed = true;
14041 mPaddingTop = top;
14042 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014043 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014044 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014045 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014046 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014047 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014048 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014049 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014050 }
14051
14052 if (changed) {
14053 requestLayout();
14054 }
14055 }
14056
14057 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014058 * Sets the relative padding. The view may add on the space required to display
14059 * the scrollbars, depending on the style and visibility of the scrollbars.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014060 * from the values set in this call.
14061 *
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014062 * @param start the start padding in pixels
14063 * @param top the top padding in pixels
14064 * @param end the end padding in pixels
14065 * @param bottom the bottom padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014066 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014067 */
14068 public void setPaddingRelative(int start, int top, int end, int bottom) {
Fabrice Di Megliof9e36502011-06-21 18:41:48 -070014069 mUserPaddingStart = start;
14070 mUserPaddingEnd = end;
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014071 mUserPaddingRelative = true;
Fabrice Di Megliof9e36502011-06-21 18:41:48 -070014072
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014073 switch(getResolvedLayoutDirection()) {
14074 case LAYOUT_DIRECTION_RTL:
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014075 internalSetPadding(end, top, start, bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014076 break;
14077 case LAYOUT_DIRECTION_LTR:
14078 default:
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014079 internalSetPadding(start, top, end, bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014080 }
14081 }
14082
14083 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014084 * Returns the top padding of this view.
14085 *
14086 * @return the top padding in pixels
14087 */
14088 public int getPaddingTop() {
14089 return mPaddingTop;
14090 }
14091
14092 /**
14093 * Returns the bottom padding of this view. If there are inset and enabled
14094 * scrollbars, this value may include the space required to display the
14095 * scrollbars as well.
14096 *
14097 * @return the bottom padding in pixels
14098 */
14099 public int getPaddingBottom() {
14100 return mPaddingBottom;
14101 }
14102
14103 /**
14104 * Returns the left padding of this view. If there are inset and enabled
14105 * scrollbars, this value may include the space required to display the
14106 * scrollbars as well.
14107 *
14108 * @return the left padding in pixels
14109 */
14110 public int getPaddingLeft() {
14111 return mPaddingLeft;
14112 }
14113
14114 /**
Fabrice Di Meglio30a21e12012-03-12 13:12:19 -070014115 * Returns the start padding of this view depending on its resolved layout direction.
14116 * If there are inset and enabled scrollbars, this value may include the space
14117 * required to display the scrollbars as well.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014118 *
14119 * @return the start padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014120 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014121 */
14122 public int getPaddingStart() {
14123 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
14124 mPaddingRight : mPaddingLeft;
14125 }
14126
14127 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014128 * Returns the right padding of this view. If there are inset and enabled
14129 * scrollbars, this value may include the space required to display the
14130 * scrollbars as well.
14131 *
14132 * @return the right padding in pixels
14133 */
14134 public int getPaddingRight() {
14135 return mPaddingRight;
14136 }
14137
14138 /**
Fabrice Di Meglio30a21e12012-03-12 13:12:19 -070014139 * Returns the end padding of this view depending on its resolved layout direction.
14140 * If there are inset and enabled scrollbars, this value may include the space
14141 * required to display the scrollbars as well.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014142 *
14143 * @return the end padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014144 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014145 */
14146 public int getPaddingEnd() {
14147 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
14148 mPaddingLeft : mPaddingRight;
14149 }
14150
14151 /**
14152 * Return if the padding as been set thru relative values
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014153 * {@link #setPaddingRelative(int, int, int, int)}
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014154 *
14155 * @return true if the padding is relative or false if it is not.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014156 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014157 */
14158 public boolean isPaddingRelative() {
14159 return mUserPaddingRelative;
14160 }
14161
14162 /**
Philip Milne1557fd72012-04-04 23:41:34 -070014163 * @hide
14164 */
Philip Milne7a23b492012-04-24 22:12:36 -070014165 public Insets getOpticalInsets() {
Philip Milne1557fd72012-04-04 23:41:34 -070014166 if (mLayoutInsets == null) {
Philip Milnebbd51f12012-04-18 15:09:05 -070014167 mLayoutInsets = (mBackground == null) ? Insets.NONE : mBackground.getLayoutInsets();
Philip Milne1557fd72012-04-04 23:41:34 -070014168 }
14169 return mLayoutInsets;
14170 }
14171
14172 /**
14173 * @hide
14174 */
14175 public void setLayoutInsets(Insets layoutInsets) {
14176 mLayoutInsets = layoutInsets;
14177 }
14178
14179 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014180 * Changes the selection state of this view. A view can be selected or not.
14181 * Note that selection is not the same as focus. Views are typically
14182 * selected in the context of an AdapterView like ListView or GridView;
14183 * the selected view is the view that is highlighted.
14184 *
14185 * @param selected true if the view must be selected, false otherwise
14186 */
14187 public void setSelected(boolean selected) {
14188 if (((mPrivateFlags & SELECTED) != 0) != selected) {
14189 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -070014190 if (!selected) resetPressedState();
Romain Guy0fd89bf2011-01-26 15:41:30 -080014191 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014192 refreshDrawableState();
14193 dispatchSetSelected(selected);
Svetoslav Ganov42138042012-03-20 11:51:39 -070014194 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
14195 notifyAccessibilityStateChanged();
14196 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014197 }
14198 }
14199
14200 /**
14201 * Dispatch setSelected to all of this View's children.
14202 *
14203 * @see #setSelected(boolean)
14204 *
14205 * @param selected The new selected state
14206 */
14207 protected void dispatchSetSelected(boolean selected) {
14208 }
14209
14210 /**
14211 * Indicates the selection state of this view.
14212 *
14213 * @return true if the view is selected, false otherwise
14214 */
14215 @ViewDebug.ExportedProperty
14216 public boolean isSelected() {
14217 return (mPrivateFlags & SELECTED) != 0;
14218 }
14219
14220 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014221 * Changes the activated state of this view. A view can be activated or not.
14222 * Note that activation is not the same as selection. Selection is
14223 * a transient property, representing the view (hierarchy) the user is
14224 * currently interacting with. Activation is a longer-term state that the
14225 * user can move views in and out of. For example, in a list view with
14226 * single or multiple selection enabled, the views in the current selection
14227 * set are activated. (Um, yeah, we are deeply sorry about the terminology
14228 * here.) The activated state is propagated down to children of the view it
14229 * is set on.
14230 *
14231 * @param activated true if the view must be activated, false otherwise
14232 */
14233 public void setActivated(boolean activated) {
14234 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
14235 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
Romain Guy0fd89bf2011-01-26 15:41:30 -080014236 invalidate(true);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014237 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -070014238 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014239 }
14240 }
14241
14242 /**
14243 * Dispatch setActivated to all of this View's children.
14244 *
14245 * @see #setActivated(boolean)
14246 *
14247 * @param activated The new activated state
14248 */
14249 protected void dispatchSetActivated(boolean activated) {
14250 }
14251
14252 /**
14253 * Indicates the activation state of this view.
14254 *
14255 * @return true if the view is activated, false otherwise
14256 */
14257 @ViewDebug.ExportedProperty
14258 public boolean isActivated() {
14259 return (mPrivateFlags & ACTIVATED) != 0;
14260 }
14261
14262 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014263 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
14264 * observer can be used to get notifications when global events, like
14265 * layout, happen.
14266 *
14267 * The returned ViewTreeObserver observer is not guaranteed to remain
14268 * valid for the lifetime of this View. If the caller of this method keeps
14269 * a long-lived reference to ViewTreeObserver, it should always check for
14270 * the return value of {@link ViewTreeObserver#isAlive()}.
14271 *
14272 * @return The ViewTreeObserver for this view's hierarchy.
14273 */
14274 public ViewTreeObserver getViewTreeObserver() {
14275 if (mAttachInfo != null) {
14276 return mAttachInfo.mTreeObserver;
14277 }
14278 if (mFloatingTreeObserver == null) {
14279 mFloatingTreeObserver = new ViewTreeObserver();
14280 }
14281 return mFloatingTreeObserver;
14282 }
14283
14284 /**
14285 * <p>Finds the topmost view in the current view hierarchy.</p>
14286 *
14287 * @return the topmost view containing this view
14288 */
14289 public View getRootView() {
14290 if (mAttachInfo != null) {
14291 final View v = mAttachInfo.mRootView;
14292 if (v != null) {
14293 return v;
14294 }
14295 }
Romain Guy8506ab42009-06-11 17:35:47 -070014296
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014297 View parent = this;
14298
14299 while (parent.mParent != null && parent.mParent instanceof View) {
14300 parent = (View) parent.mParent;
14301 }
14302
14303 return parent;
14304 }
14305
14306 /**
14307 * <p>Computes the coordinates of this view on the screen. The argument
14308 * must be an array of two integers. After the method returns, the array
14309 * contains the x and y location in that order.</p>
14310 *
14311 * @param location an array of two integers in which to hold the coordinates
14312 */
14313 public void getLocationOnScreen(int[] location) {
14314 getLocationInWindow(location);
14315
14316 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -070014317 if (info != null) {
14318 location[0] += info.mWindowLeft;
14319 location[1] += info.mWindowTop;
14320 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014321 }
14322
14323 /**
14324 * <p>Computes the coordinates of this view in its window. The argument
14325 * must be an array of two integers. After the method returns, the array
14326 * contains the x and y location in that order.</p>
14327 *
14328 * @param location an array of two integers in which to hold the coordinates
14329 */
14330 public void getLocationInWindow(int[] location) {
14331 if (location == null || location.length < 2) {
Gilles Debunnecea45132011-11-24 02:19:27 +010014332 throw new IllegalArgumentException("location must be an array of two integers");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014333 }
14334
Gilles Debunne6583ce52011-12-06 18:09:02 -080014335 if (mAttachInfo == null) {
14336 // When the view is not attached to a window, this method does not make sense
14337 location[0] = location[1] = 0;
14338 return;
14339 }
14340
Gilles Debunnecea45132011-11-24 02:19:27 +010014341 float[] position = mAttachInfo.mTmpTransformLocation;
14342 position[0] = position[1] = 0.0f;
14343
14344 if (!hasIdentityMatrix()) {
14345 getMatrix().mapPoints(position);
Dianne Hackbornddb715b2011-09-09 14:43:39 -070014346 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014347
Gilles Debunnecea45132011-11-24 02:19:27 +010014348 position[0] += mLeft;
14349 position[1] += mTop;
14350
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014351 ViewParent viewParent = mParent;
14352 while (viewParent instanceof View) {
Gilles Debunnecea45132011-11-24 02:19:27 +010014353 final View view = (View) viewParent;
14354
14355 position[0] -= view.mScrollX;
14356 position[1] -= view.mScrollY;
14357
14358 if (!view.hasIdentityMatrix()) {
14359 view.getMatrix().mapPoints(position);
Dianne Hackbornddb715b2011-09-09 14:43:39 -070014360 }
Gilles Debunnecea45132011-11-24 02:19:27 +010014361
14362 position[0] += view.mLeft;
14363 position[1] += view.mTop;
14364
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014365 viewParent = view.mParent;
Svetoslav Ganov42138042012-03-20 11:51:39 -070014366 }
Romain Guy8506ab42009-06-11 17:35:47 -070014367
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070014368 if (viewParent instanceof ViewRootImpl) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014369 // *cough*
Gilles Debunnecea45132011-11-24 02:19:27 +010014370 final ViewRootImpl vr = (ViewRootImpl) viewParent;
14371 position[1] -= vr.mCurScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014372 }
Gilles Debunnecea45132011-11-24 02:19:27 +010014373
14374 location[0] = (int) (position[0] + 0.5f);
14375 location[1] = (int) (position[1] + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014376 }
14377
14378 /**
14379 * {@hide}
14380 * @param id the id of the view to be found
14381 * @return the view of the specified id, null if cannot be found
14382 */
14383 protected View findViewTraversal(int id) {
14384 if (id == mID) {
14385 return this;
14386 }
14387 return null;
14388 }
14389
14390 /**
14391 * {@hide}
14392 * @param tag the tag of the view to be found
14393 * @return the view of specified tag, null if cannot be found
14394 */
14395 protected View findViewWithTagTraversal(Object tag) {
14396 if (tag != null && tag.equals(mTag)) {
14397 return this;
14398 }
14399 return null;
14400 }
14401
14402 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080014403 * {@hide}
14404 * @param predicate The predicate to evaluate.
Jeff Brown4dfbec22011-08-15 14:55:37 -070014405 * @param childToSkip If not null, ignores this child during the recursive traversal.
Jeff Brown4e6319b2010-12-13 10:36:51 -080014406 * @return The first view that matches the predicate or null.
14407 */
Jeff Brown4dfbec22011-08-15 14:55:37 -070014408 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) {
Jeff Brown4e6319b2010-12-13 10:36:51 -080014409 if (predicate.apply(this)) {
14410 return this;
14411 }
14412 return null;
14413 }
14414
14415 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014416 * Look for a child view with the given id. If this view has the given
14417 * id, return this view.
14418 *
14419 * @param id The id to search for.
14420 * @return The view that has the given id in the hierarchy or null
14421 */
14422 public final View findViewById(int id) {
14423 if (id < 0) {
14424 return null;
14425 }
14426 return findViewTraversal(id);
14427 }
14428
14429 /**
Svetoslav Ganov2cdedff2011-10-03 14:18:42 -070014430 * Finds a view by its unuque and stable accessibility id.
14431 *
14432 * @param accessibilityId The searched accessibility id.
14433 * @return The found view.
14434 */
14435 final View findViewByAccessibilityId(int accessibilityId) {
14436 if (accessibilityId < 0) {
14437 return null;
14438 }
14439 return findViewByAccessibilityIdTraversal(accessibilityId);
14440 }
14441
14442 /**
14443 * Performs the traversal to find a view by its unuque and stable accessibility id.
14444 *
14445 * <strong>Note:</strong>This method does not stop at the root namespace
14446 * boundary since the user can touch the screen at an arbitrary location
14447 * potentially crossing the root namespace bounday which will send an
14448 * accessibility event to accessibility services and they should be able
14449 * to obtain the event source. Also accessibility ids are guaranteed to be
14450 * unique in the window.
14451 *
14452 * @param accessibilityId The accessibility id.
14453 * @return The found view.
14454 */
14455 View findViewByAccessibilityIdTraversal(int accessibilityId) {
14456 if (getAccessibilityViewId() == accessibilityId) {
14457 return this;
14458 }
14459 return null;
14460 }
14461
14462 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014463 * Look for a child view with the given tag. If this view has the given
14464 * tag, return this view.
14465 *
14466 * @param tag The tag to search for, using "tag.equals(getTag())".
14467 * @return The View that has the given tag in the hierarchy or null
14468 */
14469 public final View findViewWithTag(Object tag) {
14470 if (tag == null) {
14471 return null;
14472 }
14473 return findViewWithTagTraversal(tag);
14474 }
14475
14476 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080014477 * {@hide}
14478 * Look for a child view that matches the specified predicate.
14479 * If this view matches the predicate, return this view.
14480 *
14481 * @param predicate The predicate to evaluate.
14482 * @return The first view that matches the predicate or null.
14483 */
14484 public final View findViewByPredicate(Predicate<View> predicate) {
Jeff Brown4dfbec22011-08-15 14:55:37 -070014485 return findViewByPredicateTraversal(predicate, null);
14486 }
14487
14488 /**
14489 * {@hide}
14490 * Look for a child view that matches the specified predicate,
14491 * starting with the specified view and its descendents and then
14492 * recusively searching the ancestors and siblings of that view
14493 * until this view is reached.
14494 *
14495 * This method is useful in cases where the predicate does not match
14496 * a single unique view (perhaps multiple views use the same id)
14497 * and we are trying to find the view that is "closest" in scope to the
14498 * starting view.
14499 *
14500 * @param start The view to start from.
14501 * @param predicate The predicate to evaluate.
14502 * @return The first view that matches the predicate or null.
14503 */
14504 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) {
14505 View childToSkip = null;
14506 for (;;) {
14507 View view = start.findViewByPredicateTraversal(predicate, childToSkip);
14508 if (view != null || start == this) {
14509 return view;
14510 }
14511
14512 ViewParent parent = start.getParent();
14513 if (parent == null || !(parent instanceof View)) {
14514 return null;
14515 }
14516
14517 childToSkip = start;
14518 start = (View) parent;
14519 }
Jeff Brown4e6319b2010-12-13 10:36:51 -080014520 }
14521
14522 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014523 * Sets the identifier for this view. The identifier does not have to be
14524 * unique in this view's hierarchy. The identifier should be a positive
14525 * number.
14526 *
14527 * @see #NO_ID
Philip Milne6c8ea062012-04-03 17:38:43 -070014528 * @see #getId()
14529 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014530 *
14531 * @param id a number used to identify the view
14532 *
14533 * @attr ref android.R.styleable#View_id
14534 */
14535 public void setId(int id) {
14536 mID = id;
14537 }
14538
14539 /**
14540 * {@hide}
14541 *
14542 * @param isRoot true if the view belongs to the root namespace, false
14543 * otherwise
14544 */
14545 public void setIsRootNamespace(boolean isRoot) {
14546 if (isRoot) {
14547 mPrivateFlags |= IS_ROOT_NAMESPACE;
14548 } else {
14549 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
14550 }
14551 }
14552
14553 /**
14554 * {@hide}
14555 *
14556 * @return true if the view belongs to the root namespace, false otherwise
14557 */
14558 public boolean isRootNamespace() {
14559 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
14560 }
14561
14562 /**
14563 * Returns this view's identifier.
14564 *
14565 * @return a positive integer used to identify the view or {@link #NO_ID}
14566 * if the view has no ID
14567 *
Philip Milne6c8ea062012-04-03 17:38:43 -070014568 * @see #setId(int)
14569 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014570 * @attr ref android.R.styleable#View_id
14571 */
14572 @ViewDebug.CapturedViewProperty
14573 public int getId() {
14574 return mID;
14575 }
14576
14577 /**
14578 * Returns this view's tag.
14579 *
14580 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -070014581 *
14582 * @see #setTag(Object)
14583 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014584 */
14585 @ViewDebug.ExportedProperty
14586 public Object getTag() {
14587 return mTag;
14588 }
14589
14590 /**
14591 * Sets the tag associated with this view. A tag can be used to mark
14592 * a view in its hierarchy and does not have to be unique within the
14593 * hierarchy. Tags can also be used to store data within a view without
14594 * resorting to another data structure.
14595 *
14596 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -070014597 *
14598 * @see #getTag()
14599 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014600 */
14601 public void setTag(final Object tag) {
14602 mTag = tag;
14603 }
14604
14605 /**
Romain Guyd90a3312009-05-06 14:54:28 -070014606 * Returns the tag associated with this view and the specified key.
14607 *
14608 * @param key The key identifying the tag
14609 *
14610 * @return the Object stored in this view as a tag
14611 *
14612 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -070014613 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -070014614 */
14615 public Object getTag(int key) {
Adam Powell7db82ac2011-09-22 19:44:04 -070014616 if (mKeyedTags != null) return mKeyedTags.get(key);
Romain Guyd90a3312009-05-06 14:54:28 -070014617 return null;
14618 }
14619
14620 /**
14621 * Sets a tag associated with this view and a key. A tag can be used
14622 * to mark a view in its hierarchy and does not have to be unique within
14623 * the hierarchy. Tags can also be used to store data within a view
14624 * without resorting to another data structure.
14625 *
14626 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -070014627 * application to ensure it is unique (see the <a
14628 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
14629 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -070014630 * the Android framework or not associated with any package will cause
14631 * an {@link IllegalArgumentException} to be thrown.
14632 *
14633 * @param key The key identifying the tag
14634 * @param tag An Object to tag the view with
14635 *
14636 * @throws IllegalArgumentException If they specified key is not valid
14637 *
14638 * @see #setTag(Object)
14639 * @see #getTag(int)
14640 */
14641 public void setTag(int key, final Object tag) {
14642 // If the package id is 0x00 or 0x01, it's either an undefined package
14643 // or a framework id
14644 if ((key >>> 24) < 2) {
14645 throw new IllegalArgumentException("The key must be an application-specific "
14646 + "resource id.");
14647 }
14648
Adam Powell2b2f6d62011-09-23 11:15:39 -070014649 setKeyedTag(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014650 }
14651
14652 /**
14653 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
14654 * framework id.
14655 *
14656 * @hide
14657 */
14658 public void setTagInternal(int key, Object tag) {
14659 if ((key >>> 24) != 0x1) {
14660 throw new IllegalArgumentException("The key must be a framework-specific "
14661 + "resource id.");
14662 }
14663
Adam Powell2b2f6d62011-09-23 11:15:39 -070014664 setKeyedTag(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014665 }
14666
Adam Powell2b2f6d62011-09-23 11:15:39 -070014667 private void setKeyedTag(int key, Object tag) {
Adam Powell7db82ac2011-09-22 19:44:04 -070014668 if (mKeyedTags == null) {
14669 mKeyedTags = new SparseArray<Object>();
Romain Guyd90a3312009-05-06 14:54:28 -070014670 }
14671
Adam Powell7db82ac2011-09-22 19:44:04 -070014672 mKeyedTags.put(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014673 }
14674
14675 /**
Romain Guy13922e02009-05-12 17:56:14 -070014676 * @param consistency The type of consistency. See ViewDebug for more information.
14677 *
14678 * @hide
14679 */
14680 protected boolean dispatchConsistencyCheck(int consistency) {
14681 return onConsistencyCheck(consistency);
14682 }
14683
14684 /**
14685 * Method that subclasses should implement to check their consistency. The type of
14686 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -070014687 *
Romain Guy13922e02009-05-12 17:56:14 -070014688 * @param consistency The type of consistency. See ViewDebug for more information.
14689 *
14690 * @throws IllegalStateException if the view is in an inconsistent state.
14691 *
14692 * @hide
14693 */
14694 protected boolean onConsistencyCheck(int consistency) {
14695 boolean result = true;
14696
14697 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
14698 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
14699
14700 if (checkLayout) {
14701 if (getParent() == null) {
14702 result = false;
14703 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14704 "View " + this + " does not have a parent.");
14705 }
14706
14707 if (mAttachInfo == null) {
14708 result = false;
14709 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14710 "View " + this + " is not attached to a window.");
14711 }
14712 }
14713
14714 if (checkDrawing) {
14715 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
14716 // from their draw() method
14717
14718 if ((mPrivateFlags & DRAWN) != DRAWN &&
14719 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
14720 result = false;
14721 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14722 "View " + this + " was invalidated but its drawing cache is valid.");
14723 }
14724 }
14725
14726 return result;
14727 }
14728
14729 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014730 * Prints information about this view in the log output, with the tag
14731 * {@link #VIEW_LOG_TAG}.
14732 *
14733 * @hide
14734 */
14735 public void debug() {
14736 debug(0);
14737 }
14738
14739 /**
14740 * Prints information about this view in the log output, with the tag
14741 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
14742 * indentation defined by the <code>depth</code>.
14743 *
14744 * @param depth the indentation level
14745 *
14746 * @hide
14747 */
14748 protected void debug(int depth) {
14749 String output = debugIndent(depth - 1);
14750
14751 output += "+ " + this;
14752 int id = getId();
14753 if (id != -1) {
14754 output += " (id=" + id + ")";
14755 }
14756 Object tag = getTag();
14757 if (tag != null) {
14758 output += " (tag=" + tag + ")";
14759 }
14760 Log.d(VIEW_LOG_TAG, output);
14761
14762 if ((mPrivateFlags & FOCUSED) != 0) {
14763 output = debugIndent(depth) + " FOCUSED";
14764 Log.d(VIEW_LOG_TAG, output);
14765 }
14766
14767 output = debugIndent(depth);
14768 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
14769 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
14770 + "} ";
14771 Log.d(VIEW_LOG_TAG, output);
14772
14773 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
14774 || mPaddingBottom != 0) {
14775 output = debugIndent(depth);
14776 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
14777 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
14778 Log.d(VIEW_LOG_TAG, output);
14779 }
14780
14781 output = debugIndent(depth);
14782 output += "mMeasureWidth=" + mMeasuredWidth +
14783 " mMeasureHeight=" + mMeasuredHeight;
14784 Log.d(VIEW_LOG_TAG, output);
14785
14786 output = debugIndent(depth);
14787 if (mLayoutParams == null) {
14788 output += "BAD! no layout params";
14789 } else {
14790 output = mLayoutParams.debug(output);
14791 }
14792 Log.d(VIEW_LOG_TAG, output);
14793
14794 output = debugIndent(depth);
14795 output += "flags={";
14796 output += View.printFlags(mViewFlags);
14797 output += "}";
14798 Log.d(VIEW_LOG_TAG, output);
14799
14800 output = debugIndent(depth);
14801 output += "privateFlags={";
14802 output += View.printPrivateFlags(mPrivateFlags);
14803 output += "}";
14804 Log.d(VIEW_LOG_TAG, output);
14805 }
14806
14807 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +090014808 * Creates a string of whitespaces used for indentation.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014809 *
14810 * @param depth the indentation level
14811 * @return a String containing (depth * 2 + 3) * 2 white spaces
14812 *
14813 * @hide
14814 */
14815 protected static String debugIndent(int depth) {
14816 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
14817 for (int i = 0; i < (depth * 2) + 3; i++) {
14818 spaces.append(' ').append(' ');
14819 }
14820 return spaces.toString();
14821 }
14822
14823 /**
14824 * <p>Return the offset of the widget's text baseline from the widget's top
14825 * boundary. If this widget does not support baseline alignment, this
14826 * method returns -1. </p>
14827 *
14828 * @return the offset of the baseline within the widget's bounds or -1
14829 * if baseline alignment is not supported
14830 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070014831 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014832 public int getBaseline() {
14833 return -1;
14834 }
14835
14836 /**
14837 * Call this when something has changed which has invalidated the
14838 * layout of this view. This will schedule a layout pass of the view
14839 * tree.
14840 */
14841 public void requestLayout() {
14842 if (ViewDebug.TRACE_HIERARCHY) {
14843 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
14844 }
14845
14846 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080014847 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014848
Fabrice Di Meglio4a5268852012-03-30 15:56:48 -070014849 if (mLayoutParams != null) {
14850 mLayoutParams.onResolveLayoutDirection(getResolvedLayoutDirection());
14851 }
14852
14853 if (mParent != null && !mParent.isLayoutRequested()) {
14854 mParent.requestLayout();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014855 }
14856 }
14857
14858 /**
14859 * Forces this view to be laid out during the next layout pass.
14860 * This method does not call requestLayout() or forceLayout()
14861 * on the parent.
14862 */
14863 public void forceLayout() {
14864 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080014865 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014866 }
14867
14868 /**
14869 * <p>
14870 * This is called to find out how big a view should be. The parent
14871 * supplies constraint information in the width and height parameters.
14872 * </p>
14873 *
14874 * <p>
Romain Guy967e2bf2012-02-07 17:04:34 -080014875 * The actual measurement work of a view is performed in
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014876 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
Romain Guy967e2bf2012-02-07 17:04:34 -080014877 * {@link #onMeasure(int, int)} can and must be overridden by subclasses.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014878 * </p>
14879 *
14880 *
14881 * @param widthMeasureSpec Horizontal space requirements as imposed by the
14882 * parent
14883 * @param heightMeasureSpec Vertical space requirements as imposed by the
14884 * parent
14885 *
14886 * @see #onMeasure(int, int)
14887 */
14888 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
14889 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
14890 widthMeasureSpec != mOldWidthMeasureSpec ||
14891 heightMeasureSpec != mOldHeightMeasureSpec) {
14892
14893 // first clears the measured dimension flag
14894 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
14895
14896 if (ViewDebug.TRACE_HIERARCHY) {
14897 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
14898 }
14899
14900 // measure ourselves, this should set the measured dimension flag back
14901 onMeasure(widthMeasureSpec, heightMeasureSpec);
14902
14903 // flag not set, setMeasuredDimension() was not invoked, we raise
14904 // an exception to warn the developer
14905 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
14906 throw new IllegalStateException("onMeasure() did not set the"
14907 + " measured dimension by calling"
14908 + " setMeasuredDimension()");
14909 }
14910
14911 mPrivateFlags |= LAYOUT_REQUIRED;
14912 }
14913
14914 mOldWidthMeasureSpec = widthMeasureSpec;
14915 mOldHeightMeasureSpec = heightMeasureSpec;
14916 }
14917
14918 /**
14919 * <p>
14920 * Measure the view and its content to determine the measured width and the
14921 * measured height. This method is invoked by {@link #measure(int, int)} and
14922 * should be overriden by subclasses to provide accurate and efficient
14923 * measurement of their contents.
14924 * </p>
14925 *
14926 * <p>
14927 * <strong>CONTRACT:</strong> When overriding this method, you
14928 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
14929 * measured width and height of this view. Failure to do so will trigger an
14930 * <code>IllegalStateException</code>, thrown by
14931 * {@link #measure(int, int)}. Calling the superclass'
14932 * {@link #onMeasure(int, int)} is a valid use.
14933 * </p>
14934 *
14935 * <p>
14936 * The base class implementation of measure defaults to the background size,
14937 * unless a larger size is allowed by the MeasureSpec. Subclasses should
14938 * override {@link #onMeasure(int, int)} to provide better measurements of
14939 * their content.
14940 * </p>
14941 *
14942 * <p>
14943 * If this method is overridden, it is the subclass's responsibility to make
14944 * sure the measured height and width are at least the view's minimum height
14945 * and width ({@link #getSuggestedMinimumHeight()} and
14946 * {@link #getSuggestedMinimumWidth()}).
14947 * </p>
14948 *
14949 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
14950 * The requirements are encoded with
14951 * {@link android.view.View.MeasureSpec}.
14952 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
14953 * The requirements are encoded with
14954 * {@link android.view.View.MeasureSpec}.
14955 *
14956 * @see #getMeasuredWidth()
14957 * @see #getMeasuredHeight()
14958 * @see #setMeasuredDimension(int, int)
14959 * @see #getSuggestedMinimumHeight()
14960 * @see #getSuggestedMinimumWidth()
14961 * @see android.view.View.MeasureSpec#getMode(int)
14962 * @see android.view.View.MeasureSpec#getSize(int)
14963 */
14964 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
14965 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
14966 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
14967 }
14968
14969 /**
14970 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
14971 * measured width and measured height. Failing to do so will trigger an
14972 * exception at measurement time.</p>
14973 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080014974 * @param measuredWidth The measured width of this view. May be a complex
14975 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
14976 * {@link #MEASURED_STATE_TOO_SMALL}.
14977 * @param measuredHeight The measured height of this view. May be a complex
14978 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
14979 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014980 */
14981 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
14982 mMeasuredWidth = measuredWidth;
14983 mMeasuredHeight = measuredHeight;
14984
14985 mPrivateFlags |= MEASURED_DIMENSION_SET;
14986 }
14987
14988 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080014989 * Merge two states as returned by {@link #getMeasuredState()}.
14990 * @param curState The current state as returned from a view or the result
14991 * of combining multiple views.
14992 * @param newState The new view state to combine.
14993 * @return Returns a new integer reflecting the combination of the two
14994 * states.
14995 */
14996 public static int combineMeasuredStates(int curState, int newState) {
14997 return curState | newState;
14998 }
14999
15000 /**
15001 * Version of {@link #resolveSizeAndState(int, int, int)}
15002 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
15003 */
15004 public static int resolveSize(int size, int measureSpec) {
15005 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
15006 }
15007
15008 /**
15009 * Utility to reconcile a desired size and state, with constraints imposed
15010 * by a MeasureSpec. Will take the desired size, unless a different size
15011 * is imposed by the constraints. The returned value is a compound integer,
15012 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
15013 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
15014 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015015 *
15016 * @param size How big the view wants to be
15017 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080015018 * @return Size information bit mask as defined by
15019 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015020 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080015021 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015022 int result = size;
15023 int specMode = MeasureSpec.getMode(measureSpec);
15024 int specSize = MeasureSpec.getSize(measureSpec);
15025 switch (specMode) {
15026 case MeasureSpec.UNSPECIFIED:
15027 result = size;
15028 break;
15029 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080015030 if (specSize < size) {
15031 result = specSize | MEASURED_STATE_TOO_SMALL;
15032 } else {
15033 result = size;
15034 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015035 break;
15036 case MeasureSpec.EXACTLY:
15037 result = specSize;
15038 break;
15039 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080015040 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015041 }
15042
15043 /**
15044 * Utility to return a default size. Uses the supplied size if the
Romain Guy98029c82011-06-17 15:47:07 -070015045 * MeasureSpec imposed no constraints. Will get larger if allowed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015046 * by the MeasureSpec.
15047 *
15048 * @param size Default size for this view
15049 * @param measureSpec Constraints imposed by the parent
15050 * @return The size this view should be.
15051 */
15052 public static int getDefaultSize(int size, int measureSpec) {
15053 int result = size;
15054 int specMode = MeasureSpec.getMode(measureSpec);
Romain Guy98029c82011-06-17 15:47:07 -070015055 int specSize = MeasureSpec.getSize(measureSpec);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015056
15057 switch (specMode) {
15058 case MeasureSpec.UNSPECIFIED:
15059 result = size;
15060 break;
15061 case MeasureSpec.AT_MOST:
15062 case MeasureSpec.EXACTLY:
15063 result = specSize;
15064 break;
15065 }
15066 return result;
15067 }
15068
15069 /**
15070 * Returns the suggested minimum height that the view should use. This
15071 * returns the maximum of the view's minimum height
15072 * and the background's minimum height
15073 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
15074 * <p>
15075 * When being used in {@link #onMeasure(int, int)}, the caller should still
15076 * ensure the returned height is within the requirements of the parent.
15077 *
15078 * @return The suggested minimum height of the view.
15079 */
15080 protected int getSuggestedMinimumHeight() {
Philip Milne6c8ea062012-04-03 17:38:43 -070015081 return (mBackground == null) ? mMinHeight : max(mMinHeight, mBackground.getMinimumHeight());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015082
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015083 }
15084
15085 /**
15086 * Returns the suggested minimum width that the view should use. This
15087 * returns the maximum of the view's minimum width)
15088 * and the background's minimum width
15089 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
15090 * <p>
15091 * When being used in {@link #onMeasure(int, int)}, the caller should still
15092 * ensure the returned width is within the requirements of the parent.
15093 *
15094 * @return The suggested minimum width of the view.
15095 */
15096 protected int getSuggestedMinimumWidth() {
Philip Milne6c8ea062012-04-03 17:38:43 -070015097 return (mBackground == null) ? mMinWidth : max(mMinWidth, mBackground.getMinimumWidth());
15098 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015099
Philip Milne6c8ea062012-04-03 17:38:43 -070015100 /**
15101 * Returns the minimum height of the view.
15102 *
15103 * @return the minimum height the view will try to be.
15104 *
15105 * @see #setMinimumHeight(int)
15106 *
15107 * @attr ref android.R.styleable#View_minHeight
15108 */
15109 public int getMinimumHeight() {
15110 return mMinHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015111 }
15112
15113 /**
15114 * Sets the minimum height of the view. It is not guaranteed the view will
15115 * be able to achieve this minimum height (for example, if its parent layout
15116 * constrains it with less available height).
15117 *
15118 * @param minHeight The minimum height the view will try to be.
Philip Milne6c8ea062012-04-03 17:38:43 -070015119 *
15120 * @see #getMinimumHeight()
15121 *
15122 * @attr ref android.R.styleable#View_minHeight
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015123 */
15124 public void setMinimumHeight(int minHeight) {
15125 mMinHeight = minHeight;
Philip Milne6c8ea062012-04-03 17:38:43 -070015126 requestLayout();
15127 }
15128
15129 /**
15130 * Returns the minimum width of the view.
15131 *
15132 * @return the minimum width the view will try to be.
15133 *
15134 * @see #setMinimumWidth(int)
15135 *
15136 * @attr ref android.R.styleable#View_minWidth
15137 */
15138 public int getMinimumWidth() {
15139 return mMinWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015140 }
15141
15142 /**
15143 * Sets the minimum width of the view. It is not guaranteed the view will
15144 * be able to achieve this minimum width (for example, if its parent layout
15145 * constrains it with less available width).
15146 *
15147 * @param minWidth The minimum width the view will try to be.
Philip Milne6c8ea062012-04-03 17:38:43 -070015148 *
15149 * @see #getMinimumWidth()
15150 *
15151 * @attr ref android.R.styleable#View_minWidth
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015152 */
15153 public void setMinimumWidth(int minWidth) {
15154 mMinWidth = minWidth;
Philip Milne6c8ea062012-04-03 17:38:43 -070015155 requestLayout();
15156
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015157 }
15158
15159 /**
15160 * Get the animation currently associated with this view.
15161 *
15162 * @return The animation that is currently playing or
15163 * scheduled to play for this view.
15164 */
15165 public Animation getAnimation() {
15166 return mCurrentAnimation;
15167 }
15168
15169 /**
15170 * Start the specified animation now.
15171 *
15172 * @param animation the animation to start now
15173 */
15174 public void startAnimation(Animation animation) {
15175 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
15176 setAnimation(animation);
Romain Guy0fd89bf2011-01-26 15:41:30 -080015177 invalidateParentCaches();
15178 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015179 }
15180
15181 /**
15182 * Cancels any animations for this view.
15183 */
15184 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080015185 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080015186 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080015187 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015188 mCurrentAnimation = null;
Romain Guy0fd89bf2011-01-26 15:41:30 -080015189 invalidateParentIfNeeded();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015190 }
15191
15192 /**
15193 * Sets the next animation to play for this view.
15194 * If you want the animation to play immediately, use
15195 * startAnimation. This method provides allows fine-grained
15196 * control over the start time and invalidation, but you
15197 * must make sure that 1) the animation has a start time set, and
15198 * 2) the view will be invalidated when the animation is supposed to
15199 * start.
15200 *
15201 * @param animation The next animation, or null.
15202 */
15203 public void setAnimation(Animation animation) {
15204 mCurrentAnimation = animation;
Romain Guyeb378892012-04-12 11:33:14 -070015205
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015206 if (animation != null) {
Romain Guyeb378892012-04-12 11:33:14 -070015207 // If the screen is off assume the animation start time is now instead of
15208 // the next frame we draw. Keeping the START_ON_FIRST_FRAME start time
15209 // would cause the animation to start when the screen turns back on
15210 if (mAttachInfo != null && !mAttachInfo.mScreenOn &&
15211 animation.getStartTime() == Animation.START_ON_FIRST_FRAME) {
15212 animation.setStartTime(AnimationUtils.currentAnimationTimeMillis());
15213 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015214 animation.reset();
15215 }
15216 }
15217
15218 /**
15219 * Invoked by a parent ViewGroup to notify the start of the animation
15220 * currently associated with this view. If you override this method,
15221 * always call super.onAnimationStart();
15222 *
15223 * @see #setAnimation(android.view.animation.Animation)
15224 * @see #getAnimation()
15225 */
15226 protected void onAnimationStart() {
15227 mPrivateFlags |= ANIMATION_STARTED;
15228 }
15229
15230 /**
15231 * Invoked by a parent ViewGroup to notify the end of the animation
15232 * currently associated with this view. If you override this method,
15233 * always call super.onAnimationEnd();
15234 *
15235 * @see #setAnimation(android.view.animation.Animation)
15236 * @see #getAnimation()
15237 */
15238 protected void onAnimationEnd() {
15239 mPrivateFlags &= ~ANIMATION_STARTED;
15240 }
15241
15242 /**
15243 * Invoked if there is a Transform that involves alpha. Subclass that can
15244 * draw themselves with the specified alpha should return true, and then
15245 * respect that alpha when their onDraw() is called. If this returns false
15246 * then the view may be redirected to draw into an offscreen buffer to
15247 * fulfill the request, which will look fine, but may be slower than if the
15248 * subclass handles it internally. The default implementation returns false.
15249 *
15250 * @param alpha The alpha (0..255) to apply to the view's drawing
15251 * @return true if the view can draw with the specified alpha.
15252 */
15253 protected boolean onSetAlpha(int alpha) {
15254 return false;
15255 }
15256
15257 /**
15258 * This is used by the RootView to perform an optimization when
15259 * the view hierarchy contains one or several SurfaceView.
15260 * SurfaceView is always considered transparent, but its children are not,
15261 * therefore all View objects remove themselves from the global transparent
15262 * region (passed as a parameter to this function).
15263 *
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070015264 * @param region The transparent region for this ViewAncestor (window).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015265 *
15266 * @return Returns true if the effective visibility of the view at this
15267 * point is opaque, regardless of the transparent region; returns false
15268 * if it is possible for underlying windows to be seen behind the view.
15269 *
15270 * {@hide}
15271 */
15272 public boolean gatherTransparentRegion(Region region) {
15273 final AttachInfo attachInfo = mAttachInfo;
15274 if (region != null && attachInfo != null) {
15275 final int pflags = mPrivateFlags;
15276 if ((pflags & SKIP_DRAW) == 0) {
15277 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
15278 // remove it from the transparent region.
15279 final int[] location = attachInfo.mTransparentLocation;
15280 getLocationInWindow(location);
15281 region.op(location[0], location[1], location[0] + mRight - mLeft,
15282 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
Philip Milne6c8ea062012-04-03 17:38:43 -070015283 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBackground != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015284 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
15285 // exists, so we remove the background drawable's non-transparent
15286 // parts from this transparent region.
Philip Milne6c8ea062012-04-03 17:38:43 -070015287 applyDrawableToTransparentRegion(mBackground, region);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015288 }
15289 }
15290 return true;
15291 }
15292
15293 /**
15294 * Play a sound effect for this view.
15295 *
15296 * <p>The framework will play sound effects for some built in actions, such as
15297 * clicking, but you may wish to play these effects in your widget,
15298 * for instance, for internal navigation.
15299 *
15300 * <p>The sound effect will only be played if sound effects are enabled by the user, and
15301 * {@link #isSoundEffectsEnabled()} is true.
15302 *
15303 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
15304 */
15305 public void playSoundEffect(int soundConstant) {
15306 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
15307 return;
15308 }
15309 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
15310 }
15311
15312 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015313 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070015314 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015315 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015316 *
15317 * <p>The framework will provide haptic feedback for some built in actions,
15318 * such as long presses, but you may wish to provide feedback for your
15319 * own widget.
15320 *
15321 * <p>The feedback will only be performed if
15322 * {@link #isHapticFeedbackEnabled()} is true.
15323 *
15324 * @param feedbackConstant One of the constants defined in
15325 * {@link HapticFeedbackConstants}
15326 */
15327 public boolean performHapticFeedback(int feedbackConstant) {
15328 return performHapticFeedback(feedbackConstant, 0);
15329 }
15330
15331 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015332 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070015333 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015334 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015335 *
15336 * @param feedbackConstant One of the constants defined in
15337 * {@link HapticFeedbackConstants}
15338 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
15339 */
15340 public boolean performHapticFeedback(int feedbackConstant, int flags) {
15341 if (mAttachInfo == null) {
15342 return false;
15343 }
Romain Guyf607bdc2010-09-10 19:20:06 -070015344 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070015345 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015346 && !isHapticFeedbackEnabled()) {
15347 return false;
15348 }
Romain Guy812ccbe2010-06-01 14:07:24 -070015349 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
15350 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015351 }
15352
15353 /**
Dianne Hackborn98014352012-04-05 18:31:41 -070015354 * Request that the visibility of the status bar or other screen/window
15355 * decorations be changed.
15356 *
15357 * <p>This method is used to put the over device UI into temporary modes
15358 * where the user's attention is focused more on the application content,
15359 * by dimming or hiding surrounding system affordances. This is typically
15360 * used in conjunction with {@link Window#FEATURE_ACTION_BAR_OVERLAY
15361 * Window.FEATURE_ACTION_BAR_OVERLAY}, allowing the applications content
15362 * to be placed behind the action bar (and with these flags other system
15363 * affordances) so that smooth transitions between hiding and showing them
15364 * can be done.
15365 *
15366 * <p>Two representative examples of the use of system UI visibility is
15367 * implementing a content browsing application (like a magazine reader)
15368 * and a video playing application.
15369 *
15370 * <p>The first code shows a typical implementation of a View in a content
15371 * browsing application. In this implementation, the application goes
15372 * into a content-oriented mode by hiding the status bar and action bar,
15373 * and putting the navigation elements into lights out mode. The user can
15374 * then interact with content while in this mode. Such an application should
15375 * provide an easy way for the user to toggle out of the mode (such as to
15376 * check information in the status bar or access notifications). In the
15377 * implementation here, this is done simply by tapping on the content.
15378 *
15379 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/ContentBrowserActivity.java
15380 * content}
15381 *
15382 * <p>This second code sample shows a typical implementation of a View
15383 * in a video playing application. In this situation, while the video is
15384 * playing the application would like to go into a complete full-screen mode,
15385 * to use as much of the display as possible for the video. When in this state
15386 * the user can not interact with the application; the system intercepts
Dianne Hackborncf675782012-05-10 15:07:24 -070015387 * touching on the screen to pop the UI out of full screen mode. See
15388 * {@link #fitSystemWindows(Rect)} for a sample layout that goes with this code.
Dianne Hackborn98014352012-04-05 18:31:41 -070015389 *
15390 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/VideoPlayerActivity.java
15391 * content}
15392 *
15393 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
15394 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN},
15395 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION},
15396 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080015397 */
15398 public void setSystemUiVisibility(int visibility) {
Daniel Sandler70524062011-09-21 00:30:47 -040015399 if (visibility != mSystemUiVisibility) {
15400 mSystemUiVisibility = visibility;
15401 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
15402 mParent.recomputeViewAttributes(this);
15403 }
Joe Onorato664644d2011-01-23 17:53:23 -080015404 }
15405 }
15406
15407 /**
Dianne Hackborn98014352012-04-05 18:31:41 -070015408 * Returns the last {@link #setSystemUiVisibility(int) that this view has requested.
15409 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
15410 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN},
15411 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION},
15412 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080015413 */
Joe Onoratoe595cad2011-01-24 09:22:12 -080015414 public int getSystemUiVisibility() {
Joe Onorato664644d2011-01-23 17:53:23 -080015415 return mSystemUiVisibility;
15416 }
15417
Scott Mainec6331b2011-05-24 16:55:56 -070015418 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -070015419 * Returns the current system UI visibility that is currently set for
15420 * the entire window. This is the combination of the
15421 * {@link #setSystemUiVisibility(int)} values supplied by all of the
15422 * views in the window.
15423 */
15424 public int getWindowSystemUiVisibility() {
15425 return mAttachInfo != null ? mAttachInfo.mSystemUiVisibility : 0;
15426 }
15427
15428 /**
15429 * Override to find out when the window's requested system UI visibility
15430 * has changed, that is the value returned by {@link #getWindowSystemUiVisibility()}.
15431 * This is different from the callbacks recieved through
15432 * {@link #setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener)}
15433 * in that this is only telling you about the local request of the window,
15434 * not the actual values applied by the system.
15435 */
15436 public void onWindowSystemUiVisibilityChanged(int visible) {
15437 }
15438
15439 /**
15440 * Dispatch callbacks to {@link #onWindowSystemUiVisibilityChanged(int)} down
15441 * the view hierarchy.
15442 */
15443 public void dispatchWindowSystemUiVisiblityChanged(int visible) {
15444 onWindowSystemUiVisibilityChanged(visible);
15445 }
15446
15447 /**
Scott Mainec6331b2011-05-24 16:55:56 -070015448 * Set a listener to receive callbacks when the visibility of the system bar changes.
15449 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks.
15450 */
Joe Onorato664644d2011-01-23 17:53:23 -080015451 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015452 getListenerInfo().mOnSystemUiVisibilityChangeListener = l;
Joe Onorato664644d2011-01-23 17:53:23 -080015453 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
15454 mParent.recomputeViewAttributes(this);
15455 }
15456 }
15457
15458 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015459 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down
15460 * the view hierarchy.
Joe Onorato664644d2011-01-23 17:53:23 -080015461 */
15462 public void dispatchSystemUiVisibilityChanged(int visibility) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015463 ListenerInfo li = mListenerInfo;
15464 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) {
15465 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange(
Joe Onorato6ab77bd2011-01-31 11:21:10 -080015466 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK);
Joe Onorato664644d2011-01-23 17:53:23 -080015467 }
15468 }
15469
Dianne Hackborncf675782012-05-10 15:07:24 -070015470 boolean updateLocalSystemUiVisibility(int localValue, int localChanges) {
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015471 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges);
15472 if (val != mSystemUiVisibility) {
15473 setSystemUiVisibility(val);
Dianne Hackborncf675782012-05-10 15:07:24 -070015474 return true;
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015475 }
Dianne Hackborncf675782012-05-10 15:07:24 -070015476 return false;
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015477 }
15478
Dianne Hackborn139e5aa2012-05-05 20:36:38 -070015479 /** @hide */
15480 public void setDisabledSystemUiVisibility(int flags) {
15481 if (mAttachInfo != null) {
15482 if (mAttachInfo.mDisabledSystemUiVisibility != flags) {
15483 mAttachInfo.mDisabledSystemUiVisibility = flags;
15484 if (mParent != null) {
15485 mParent.recomputeViewAttributes(this);
15486 }
15487 }
15488 }
15489 }
15490
Joe Onorato664644d2011-01-23 17:53:23 -080015491 /**
Joe Malin32736f02011-01-19 16:14:20 -080015492 * Creates an image that the system displays during the drag and drop
15493 * operation. This is called a &quot;drag shadow&quot;. The default implementation
15494 * for a DragShadowBuilder based on a View returns an image that has exactly the same
15495 * appearance as the given View. The default also positions the center of the drag shadow
15496 * directly under the touch point. If no View is provided (the constructor with no parameters
15497 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and
15498 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the
15499 * default is an invisible drag shadow.
15500 * <p>
15501 * You are not required to use the View you provide to the constructor as the basis of the
15502 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw
15503 * anything you want as the drag shadow.
15504 * </p>
15505 * <p>
15506 * You pass a DragShadowBuilder object to the system when you start the drag. The system
15507 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the
15508 * size and position of the drag shadow. It uses this data to construct a
15509 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()}
15510 * so that your application can draw the shadow image in the Canvas.
15511 * </p>
Joe Fernandez558459f2011-10-13 16:47:36 -070015512 *
15513 * <div class="special reference">
15514 * <h3>Developer Guides</h3>
15515 * <p>For a guide to implementing drag and drop features, read the
15516 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p>
15517 * </div>
Christopher Tate2c095f32010-10-04 14:13:40 -070015518 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015519 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070015520 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070015521
15522 /**
Joe Malin32736f02011-01-19 16:14:20 -080015523 * Constructs a shadow image builder based on a View. By default, the resulting drag
15524 * shadow will have the same appearance and dimensions as the View, with the touch point
15525 * over the center of the View.
15526 * @param view A View. Any View in scope can be used.
Christopher Tate2c095f32010-10-04 14:13:40 -070015527 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015528 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070015529 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070015530 }
15531
Christopher Tate17ed60c2011-01-18 12:50:26 -080015532 /**
15533 * Construct a shadow builder object with no associated View. This
15534 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)}
15535 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order
15536 * to supply the drag shadow's dimensions and appearance without
Joe Malin32736f02011-01-19 16:14:20 -080015537 * reference to any View object. If they are not overridden, then the result is an
15538 * invisible drag shadow.
Christopher Tate17ed60c2011-01-18 12:50:26 -080015539 */
15540 public DragShadowBuilder() {
15541 mView = new WeakReference<View>(null);
15542 }
15543
15544 /**
15545 * Returns the View object that had been passed to the
15546 * {@link #View.DragShadowBuilder(View)}
15547 * constructor. If that View parameter was {@code null} or if the
15548 * {@link #View.DragShadowBuilder()}
15549 * constructor was used to instantiate the builder object, this method will return
15550 * null.
15551 *
15552 * @return The View object associate with this builder object.
15553 */
Romain Guy5c22a8c2011-05-13 11:48:45 -070015554 @SuppressWarnings({"JavadocReference"})
Chris Tate6b391282010-10-14 15:48:59 -070015555 final public View getView() {
15556 return mView.get();
15557 }
15558
Christopher Tate2c095f32010-10-04 14:13:40 -070015559 /**
Joe Malin32736f02011-01-19 16:14:20 -080015560 * Provides the metrics for the shadow image. These include the dimensions of
15561 * the shadow image, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070015562 * be centered under the touch location while dragging.
15563 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015564 * The default implementation sets the dimensions of the shadow to be the
Joe Malin32736f02011-01-19 16:14:20 -080015565 * same as the dimensions of the View itself and centers the shadow under
15566 * the touch point.
15567 * </p>
Christopher Tate2c095f32010-10-04 14:13:40 -070015568 *
Joe Malin32736f02011-01-19 16:14:20 -080015569 * @param shadowSize A {@link android.graphics.Point} containing the width and height
15570 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the
15571 * desired width and must set {@link android.graphics.Point#y} to the desired height of the
15572 * image.
15573 *
15574 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the
15575 * shadow image that should be underneath the touch point during the drag and drop
15576 * operation. Your application must set {@link android.graphics.Point#x} to the
15577 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position.
Christopher Tate2c095f32010-10-04 14:13:40 -070015578 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015579 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070015580 final View view = mView.get();
15581 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015582 shadowSize.set(view.getWidth(), view.getHeight());
15583 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070015584 } else {
15585 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
15586 }
Christopher Tate2c095f32010-10-04 14:13:40 -070015587 }
15588
15589 /**
Joe Malin32736f02011-01-19 16:14:20 -080015590 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object
15591 * based on the dimensions it received from the
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015592 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate2c095f32010-10-04 14:13:40 -070015593 *
Joe Malin32736f02011-01-19 16:14:20 -080015594 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image.
Christopher Tate2c095f32010-10-04 14:13:40 -070015595 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015596 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070015597 final View view = mView.get();
15598 if (view != null) {
15599 view.draw(canvas);
15600 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015601 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070015602 }
Christopher Tate2c095f32010-10-04 14:13:40 -070015603 }
15604 }
15605
15606 /**
Joe Malin32736f02011-01-19 16:14:20 -080015607 * Starts a drag and drop operation. When your application calls this method, it passes a
15608 * {@link android.view.View.DragShadowBuilder} object to the system. The
15609 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)}
15610 * to get metrics for the drag shadow, and then calls the object's
15611 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself.
15612 * <p>
15613 * Once the system has the drag shadow, it begins the drag and drop operation by sending
15614 * drag events to all the View objects in your application that are currently visible. It does
15615 * this either by calling the View object's drag listener (an implementation of
15616 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the
15617 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method.
15618 * Both are passed a {@link android.view.DragEvent} object that has a
15619 * {@link android.view.DragEvent#getAction()} value of
15620 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}.
15621 * </p>
15622 * <p>
15623 * Your application can invoke startDrag() on any attached View object. The View object does not
15624 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to
15625 * be related to the View the user selected for dragging.
15626 * </p>
15627 * @param data A {@link android.content.ClipData} object pointing to the data to be
15628 * transferred by the drag and drop operation.
15629 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the
15630 * drag shadow.
15631 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and
15632 * drop operation. This Object is put into every DragEvent object sent by the system during the
15633 * current drag.
15634 * <p>
15635 * myLocalState is a lightweight mechanism for the sending information from the dragged View
15636 * to the target Views. For example, it can contain flags that differentiate between a
15637 * a copy operation and a move operation.
15638 * </p>
15639 * @param flags Flags that control the drag and drop operation. No flags are currently defined,
15640 * so the parameter should be set to 0.
15641 * @return {@code true} if the method completes successfully, or
15642 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to
15643 * do a drag, and so no drag operation is in progress.
Christopher Tatea53146c2010-09-07 11:57:52 -070015644 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015645 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015646 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070015647 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015648 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070015649 }
15650 boolean okay = false;
15651
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015652 Point shadowSize = new Point();
15653 Point shadowTouchPoint = new Point();
15654 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070015655
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015656 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
15657 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
15658 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070015659 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015660
Chris Tatea32dcf72010-10-14 12:13:50 -070015661 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015662 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
15663 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070015664 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015665 Surface surface = new Surface();
15666 try {
15667 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015668 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070015669 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070015670 + " surface=" + surface);
15671 if (token != null) {
15672 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070015673 try {
Chris Tate6b391282010-10-14 15:48:59 -070015674 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015675 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070015676 } finally {
15677 surface.unlockCanvasAndPost(canvas);
15678 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015679
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070015680 final ViewRootImpl root = getViewRootImpl();
Christopher Tate407b4e92010-11-30 17:14:08 -080015681
15682 // Cache the local state object for delivery with DragEvents
15683 root.setLocalDragState(myLocalState);
15684
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015685 // repurpose 'shadowSize' for the last touch point
15686 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070015687
Christopher Tatea53146c2010-09-07 11:57:52 -070015688 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015689 shadowSize.x, shadowSize.y,
15690 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070015691 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tate8f73b5d2011-09-12 15:22:12 -070015692
15693 // Off and running! Release our local surface instance; the drag
15694 // shadow surface is now managed by the system process.
15695 surface.release();
Christopher Tatea53146c2010-09-07 11:57:52 -070015696 }
15697 } catch (Exception e) {
15698 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
15699 surface.destroy();
15700 }
15701
15702 return okay;
15703 }
15704
Christopher Tatea53146c2010-09-07 11:57:52 -070015705 /**
Joe Malin32736f02011-01-19 16:14:20 -080015706 * Handles drag events sent by the system following a call to
15707 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}.
15708 *<p>
15709 * When the system calls this method, it passes a
15710 * {@link android.view.DragEvent} object. A call to
15711 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined
15712 * in DragEvent. The method uses these to determine what is happening in the drag and drop
15713 * operation.
15714 * @param event The {@link android.view.DragEvent} sent by the system.
15715 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined
15716 * in DragEvent, indicating the type of drag event represented by this object.
15717 * @return {@code true} if the method was successful, otherwise {@code false}.
15718 * <p>
15719 * The method should return {@code true} in response to an action type of
15720 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current
15721 * operation.
15722 * </p>
15723 * <p>
15724 * The method should also return {@code true} in response to an action type of
15725 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or
15726 * {@code false} if it didn't.
15727 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070015728 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070015729 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070015730 return false;
15731 }
15732
15733 /**
Joe Malin32736f02011-01-19 16:14:20 -080015734 * Detects if this View is enabled and has a drag event listener.
15735 * If both are true, then it calls the drag event listener with the
15736 * {@link android.view.DragEvent} it received. If the drag event listener returns
15737 * {@code true}, then dispatchDragEvent() returns {@code true}.
15738 * <p>
15739 * For all other cases, the method calls the
15740 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler
15741 * method and returns its result.
15742 * </p>
15743 * <p>
15744 * This ensures that a drag event is always consumed, even if the View does not have a drag
15745 * event listener. However, if the View has a listener and the listener returns true, then
15746 * onDragEvent() is not called.
15747 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070015748 */
15749 public boolean dispatchDragEvent(DragEvent event) {
Romain Guy676b1732011-02-14 14:45:33 -080015750 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015751 ListenerInfo li = mListenerInfo;
15752 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
15753 && li.mOnDragListener.onDrag(this, event)) {
Chris Tate32affef2010-10-18 15:29:21 -070015754 return true;
15755 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015756 return onDragEvent(event);
15757 }
15758
Christopher Tate3d4bf172011-03-28 16:16:46 -070015759 boolean canAcceptDrag() {
15760 return (mPrivateFlags2 & DRAG_CAN_ACCEPT) != 0;
15761 }
15762
Christopher Tatea53146c2010-09-07 11:57:52 -070015763 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070015764 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
15765 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070015766 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070015767 */
15768 public void onCloseSystemDialogs(String reason) {
15769 }
Joe Malin32736f02011-01-19 16:14:20 -080015770
Dianne Hackbornffa42482009-09-23 22:20:11 -070015771 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015772 * Given a Drawable whose bounds have been set to draw into this view,
Romain Guy5c22a8c2011-05-13 11:48:45 -070015773 * update a Region being computed for
15774 * {@link #gatherTransparentRegion(android.graphics.Region)} so
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015775 * that any non-transparent parts of the Drawable are removed from the
15776 * given transparent region.
15777 *
15778 * @param dr The Drawable whose transparency is to be applied to the region.
15779 * @param region A Region holding the current transparency information,
15780 * where any parts of the region that are set are considered to be
15781 * transparent. On return, this region will be modified to have the
15782 * transparency information reduced by the corresponding parts of the
15783 * Drawable that are not transparent.
15784 * {@hide}
15785 */
15786 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
15787 if (DBG) {
15788 Log.i("View", "Getting transparent region for: " + this);
15789 }
15790 final Region r = dr.getTransparentRegion();
15791 final Rect db = dr.getBounds();
15792 final AttachInfo attachInfo = mAttachInfo;
15793 if (r != null && attachInfo != null) {
15794 final int w = getRight()-getLeft();
15795 final int h = getBottom()-getTop();
15796 if (db.left > 0) {
15797 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
15798 r.op(0, 0, db.left, h, Region.Op.UNION);
15799 }
15800 if (db.right < w) {
15801 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
15802 r.op(db.right, 0, w, h, Region.Op.UNION);
15803 }
15804 if (db.top > 0) {
15805 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
15806 r.op(0, 0, w, db.top, Region.Op.UNION);
15807 }
15808 if (db.bottom < h) {
15809 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
15810 r.op(0, db.bottom, w, h, Region.Op.UNION);
15811 }
15812 final int[] location = attachInfo.mTransparentLocation;
15813 getLocationInWindow(location);
15814 r.translate(location[0], location[1]);
15815 region.op(r, Region.Op.INTERSECT);
15816 } else {
15817 region.op(db, Region.Op.DIFFERENCE);
15818 }
15819 }
15820
Patrick Dubroye0a799a2011-05-04 16:19:22 -070015821 private void checkForLongClick(int delayOffset) {
15822 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
15823 mHasPerformedLongPress = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015824
Patrick Dubroye0a799a2011-05-04 16:19:22 -070015825 if (mPendingCheckForLongPress == null) {
15826 mPendingCheckForLongPress = new CheckForLongPress();
15827 }
15828 mPendingCheckForLongPress.rememberWindowAttachCount();
15829 postDelayed(mPendingCheckForLongPress,
15830 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015831 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015832 }
15833
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015834 /**
15835 * Inflate a view from an XML resource. This convenience method wraps the {@link
15836 * LayoutInflater} class, which provides a full range of options for view inflation.
15837 *
15838 * @param context The Context object for your activity or application.
15839 * @param resource The resource ID to inflate
15840 * @param root A view group that will be the parent. Used to properly inflate the
15841 * layout_* parameters.
15842 * @see LayoutInflater
15843 */
15844 public static View inflate(Context context, int resource, ViewGroup root) {
15845 LayoutInflater factory = LayoutInflater.from(context);
15846 return factory.inflate(resource, root);
15847 }
Romain Guy33e72ae2010-07-17 12:40:29 -070015848
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015849 /**
Adam Powell637d3372010-08-25 14:37:03 -070015850 * Scroll the view with standard behavior for scrolling beyond the normal
15851 * content boundaries. Views that call this method should override
15852 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
15853 * results of an over-scroll operation.
15854 *
15855 * Views can use this method to handle any touch or fling-based scrolling.
15856 *
15857 * @param deltaX Change in X in pixels
15858 * @param deltaY Change in Y in pixels
15859 * @param scrollX Current X scroll value in pixels before applying deltaX
15860 * @param scrollY Current Y scroll value in pixels before applying deltaY
15861 * @param scrollRangeX Maximum content scroll range along the X axis
15862 * @param scrollRangeY Maximum content scroll range along the Y axis
15863 * @param maxOverScrollX Number of pixels to overscroll by in either direction
15864 * along the X axis.
15865 * @param maxOverScrollY Number of pixels to overscroll by in either direction
15866 * along the Y axis.
15867 * @param isTouchEvent true if this scroll operation is the result of a touch event.
15868 * @return true if scrolling was clamped to an over-scroll boundary along either
15869 * axis, false otherwise.
15870 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070015871 @SuppressWarnings({"UnusedParameters"})
Adam Powell637d3372010-08-25 14:37:03 -070015872 protected boolean overScrollBy(int deltaX, int deltaY,
15873 int scrollX, int scrollY,
15874 int scrollRangeX, int scrollRangeY,
15875 int maxOverScrollX, int maxOverScrollY,
15876 boolean isTouchEvent) {
15877 final int overScrollMode = mOverScrollMode;
15878 final boolean canScrollHorizontal =
15879 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
15880 final boolean canScrollVertical =
15881 computeVerticalScrollRange() > computeVerticalScrollExtent();
15882 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
15883 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
15884 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
15885 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
15886
15887 int newScrollX = scrollX + deltaX;
15888 if (!overScrollHorizontal) {
15889 maxOverScrollX = 0;
15890 }
15891
15892 int newScrollY = scrollY + deltaY;
15893 if (!overScrollVertical) {
15894 maxOverScrollY = 0;
15895 }
15896
15897 // Clamp values if at the limits and record
15898 final int left = -maxOverScrollX;
15899 final int right = maxOverScrollX + scrollRangeX;
15900 final int top = -maxOverScrollY;
15901 final int bottom = maxOverScrollY + scrollRangeY;
15902
15903 boolean clampedX = false;
15904 if (newScrollX > right) {
15905 newScrollX = right;
15906 clampedX = true;
15907 } else if (newScrollX < left) {
15908 newScrollX = left;
15909 clampedX = true;
15910 }
15911
15912 boolean clampedY = false;
15913 if (newScrollY > bottom) {
15914 newScrollY = bottom;
15915 clampedY = true;
15916 } else if (newScrollY < top) {
15917 newScrollY = top;
15918 clampedY = true;
15919 }
15920
15921 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
15922
15923 return clampedX || clampedY;
15924 }
15925
15926 /**
15927 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
15928 * respond to the results of an over-scroll operation.
15929 *
15930 * @param scrollX New X scroll value in pixels
15931 * @param scrollY New Y scroll value in pixels
15932 * @param clampedX True if scrollX was clamped to an over-scroll boundary
15933 * @param clampedY True if scrollY was clamped to an over-scroll boundary
15934 */
15935 protected void onOverScrolled(int scrollX, int scrollY,
15936 boolean clampedX, boolean clampedY) {
15937 // Intentionally empty.
15938 }
15939
15940 /**
15941 * Returns the over-scroll mode for this view. The result will be
15942 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
15943 * (allow over-scrolling only if the view content is larger than the container),
15944 * or {@link #OVER_SCROLL_NEVER}.
15945 *
15946 * @return This view's over-scroll mode.
15947 */
15948 public int getOverScrollMode() {
15949 return mOverScrollMode;
15950 }
15951
15952 /**
15953 * Set the over-scroll mode for this view. Valid over-scroll modes are
15954 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
15955 * (allow over-scrolling only if the view content is larger than the container),
15956 * or {@link #OVER_SCROLL_NEVER}.
15957 *
15958 * Setting the over-scroll mode of a view will have an effect only if the
15959 * view is capable of scrolling.
15960 *
15961 * @param overScrollMode The new over-scroll mode for this view.
15962 */
15963 public void setOverScrollMode(int overScrollMode) {
15964 if (overScrollMode != OVER_SCROLL_ALWAYS &&
15965 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
15966 overScrollMode != OVER_SCROLL_NEVER) {
15967 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
15968 }
15969 mOverScrollMode = overScrollMode;
15970 }
15971
15972 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080015973 * Gets a scale factor that determines the distance the view should scroll
15974 * vertically in response to {@link MotionEvent#ACTION_SCROLL}.
15975 * @return The vertical scroll scale factor.
15976 * @hide
15977 */
15978 protected float getVerticalScrollFactor() {
15979 if (mVerticalScrollFactor == 0) {
15980 TypedValue outValue = new TypedValue();
15981 if (!mContext.getTheme().resolveAttribute(
15982 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) {
15983 throw new IllegalStateException(
15984 "Expected theme to define listPreferredItemHeight.");
15985 }
15986 mVerticalScrollFactor = outValue.getDimension(
15987 mContext.getResources().getDisplayMetrics());
15988 }
15989 return mVerticalScrollFactor;
15990 }
15991
15992 /**
15993 * Gets a scale factor that determines the distance the view should scroll
15994 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}.
15995 * @return The horizontal scroll scale factor.
15996 * @hide
15997 */
15998 protected float getHorizontalScrollFactor() {
15999 // TODO: Should use something else.
16000 return getVerticalScrollFactor();
16001 }
16002
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016003 /**
16004 * Return the value specifying the text direction or policy that was set with
16005 * {@link #setTextDirection(int)}.
16006 *
16007 * @return the defined text direction. It can be one of:
16008 *
16009 * {@link #TEXT_DIRECTION_INHERIT},
16010 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16011 * {@link #TEXT_DIRECTION_ANY_RTL},
16012 * {@link #TEXT_DIRECTION_LTR},
16013 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016014 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016015 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016016 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016017 @ViewDebug.ExportedProperty(category = "text", mapping = {
16018 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"),
16019 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"),
16020 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"),
16021 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"),
16022 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"),
16023 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE")
16024 })
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016025 public int getTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016026 return (mPrivateFlags2 & TEXT_DIRECTION_MASK) >> TEXT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016027 }
16028
16029 /**
16030 * Set the text direction.
16031 *
16032 * @param textDirection the direction to set. Should be one of:
16033 *
16034 * {@link #TEXT_DIRECTION_INHERIT},
16035 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16036 * {@link #TEXT_DIRECTION_ANY_RTL},
16037 * {@link #TEXT_DIRECTION_LTR},
16038 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016039 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016040 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016041 */
16042 public void setTextDirection(int textDirection) {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016043 if (getTextDirection() != textDirection) {
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016044 // Reset the current text direction and the resolved one
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016045 mPrivateFlags2 &= ~TEXT_DIRECTION_MASK;
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016046 resetResolvedTextDirection();
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016047 // Set the new text direction
16048 mPrivateFlags2 |= ((textDirection << TEXT_DIRECTION_MASK_SHIFT) & TEXT_DIRECTION_MASK);
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016049 // Refresh
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016050 requestLayout();
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016051 invalidate(true);
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016052 }
16053 }
16054
16055 /**
16056 * Return the resolved text direction.
16057 *
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016058 * This needs resolution if the value is TEXT_DIRECTION_INHERIT. The resolution matches
16059 * {@link #getTextDirection()}if it is not TEXT_DIRECTION_INHERIT, otherwise resolution proceeds
16060 * up the parent chain of the view. if there is no parent, then it will return the default
16061 * {@link #TEXT_DIRECTION_FIRST_STRONG}.
16062 *
16063 * @return the resolved text direction. Returns one of:
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016064 *
Doug Feltcb3791202011-07-07 11:57:48 -070016065 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16066 * {@link #TEXT_DIRECTION_ANY_RTL},
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016067 * {@link #TEXT_DIRECTION_LTR},
16068 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016069 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016070 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016071 */
16072 public int getResolvedTextDirection() {
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070016073 // The text direction will be resolved only if needed
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016074 if ((mPrivateFlags2 & TEXT_DIRECTION_RESOLVED) != TEXT_DIRECTION_RESOLVED) {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016075 resolveTextDirection();
16076 }
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016077 return (mPrivateFlags2 & TEXT_DIRECTION_RESOLVED_MASK) >> TEXT_DIRECTION_RESOLVED_MASK_SHIFT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016078 }
16079
16080 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016081 * Resolve the text direction. Will call {@link View#onResolvedTextDirectionChanged} when
16082 * resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016083 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016084 */
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016085 public void resolveTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016086 // Reset any previous text direction resolution
16087 mPrivateFlags2 &= ~(TEXT_DIRECTION_RESOLVED | TEXT_DIRECTION_RESOLVED_MASK);
16088
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016089 if (hasRtlSupport()) {
16090 // Set resolved text direction flag depending on text direction flag
16091 final int textDirection = getTextDirection();
16092 switch(textDirection) {
16093 case TEXT_DIRECTION_INHERIT:
16094 if (canResolveTextDirection()) {
16095 ViewGroup viewGroup = ((ViewGroup) mParent);
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016096
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016097 // Set current resolved direction to the same value as the parent's one
16098 final int parentResolvedDirection = viewGroup.getResolvedTextDirection();
16099 switch (parentResolvedDirection) {
16100 case TEXT_DIRECTION_FIRST_STRONG:
16101 case TEXT_DIRECTION_ANY_RTL:
16102 case TEXT_DIRECTION_LTR:
16103 case TEXT_DIRECTION_RTL:
16104 case TEXT_DIRECTION_LOCALE:
16105 mPrivateFlags2 |=
16106 (parentResolvedDirection << TEXT_DIRECTION_RESOLVED_MASK_SHIFT);
16107 break;
16108 default:
16109 // Default resolved direction is "first strong" heuristic
16110 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
16111 }
16112 } else {
16113 // We cannot do the resolution if there is no parent, so use the default one
16114 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016115 }
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016116 break;
16117 case TEXT_DIRECTION_FIRST_STRONG:
16118 case TEXT_DIRECTION_ANY_RTL:
16119 case TEXT_DIRECTION_LTR:
16120 case TEXT_DIRECTION_RTL:
16121 case TEXT_DIRECTION_LOCALE:
16122 // Resolved direction is the same as text direction
16123 mPrivateFlags2 |= (textDirection << TEXT_DIRECTION_RESOLVED_MASK_SHIFT);
16124 break;
16125 default:
16126 // Default resolved direction is "first strong" heuristic
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016127 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016128 }
16129 } else {
16130 // Default resolved direction is "first strong" heuristic
16131 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016132 }
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016133
16134 // Set to resolved
16135 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016136 onResolvedTextDirectionChanged();
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016137 }
16138
16139 /**
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016140 * Called when text direction has been resolved. Subclasses that care about text direction
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016141 * resolution should override this method.
16142 *
16143 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016144 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016145 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016146 public void onResolvedTextDirectionChanged() {
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016147 }
16148
16149 /**
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016150 * Check if text direction resolution can be done.
16151 *
16152 * @return true if text direction resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016153 * @hide
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016154 */
16155 public boolean canResolveTextDirection() {
16156 switch (getTextDirection()) {
16157 case TEXT_DIRECTION_INHERIT:
16158 return (mParent != null) && (mParent instanceof ViewGroup);
16159 default:
16160 return true;
16161 }
16162 }
16163
16164 /**
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016165 * Reset resolved text direction. Text direction can be resolved with a call to
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016166 * getResolvedTextDirection(). Will call {@link View#onResolvedTextDirectionReset} when
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016167 * reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016168 * @hide
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016169 */
16170 public void resetResolvedTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016171 mPrivateFlags2 &= ~(TEXT_DIRECTION_RESOLVED | TEXT_DIRECTION_RESOLVED_MASK);
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016172 onResolvedTextDirectionReset();
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016173 }
16174
16175 /**
16176 * Called when text direction is reset. Subclasses that care about text direction reset should
16177 * override this method and do a reset of the text direction of their children. The default
16178 * implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016179 * @hide
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016180 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016181 public void onResolvedTextDirectionReset() {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016182 }
16183
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016184 /**
16185 * Return the value specifying the text alignment or policy that was set with
16186 * {@link #setTextAlignment(int)}.
16187 *
16188 * @return the defined text alignment. It can be one of:
16189 *
16190 * {@link #TEXT_ALIGNMENT_INHERIT},
16191 * {@link #TEXT_ALIGNMENT_GRAVITY},
16192 * {@link #TEXT_ALIGNMENT_CENTER},
16193 * {@link #TEXT_ALIGNMENT_TEXT_START},
16194 * {@link #TEXT_ALIGNMENT_TEXT_END},
16195 * {@link #TEXT_ALIGNMENT_VIEW_START},
16196 * {@link #TEXT_ALIGNMENT_VIEW_END}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016197 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016198 */
16199 @ViewDebug.ExportedProperty(category = "text", mapping = {
16200 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"),
16201 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"),
16202 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"),
16203 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"),
16204 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"),
16205 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"),
16206 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END")
16207 })
16208 public int getTextAlignment() {
16209 return (mPrivateFlags2 & TEXT_ALIGNMENT_MASK) >> TEXT_ALIGNMENT_MASK_SHIFT;
16210 }
16211
16212 /**
16213 * Set the text alignment.
16214 *
16215 * @param textAlignment The text alignment to set. Should be one of
16216 *
16217 * {@link #TEXT_ALIGNMENT_INHERIT},
16218 * {@link #TEXT_ALIGNMENT_GRAVITY},
16219 * {@link #TEXT_ALIGNMENT_CENTER},
16220 * {@link #TEXT_ALIGNMENT_TEXT_START},
16221 * {@link #TEXT_ALIGNMENT_TEXT_END},
16222 * {@link #TEXT_ALIGNMENT_VIEW_START},
16223 * {@link #TEXT_ALIGNMENT_VIEW_END}
16224 *
16225 * @attr ref android.R.styleable#View_textAlignment
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016226 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016227 */
16228 public void setTextAlignment(int textAlignment) {
16229 if (textAlignment != getTextAlignment()) {
16230 // Reset the current and resolved text alignment
16231 mPrivateFlags2 &= ~TEXT_ALIGNMENT_MASK;
16232 resetResolvedTextAlignment();
16233 // Set the new text alignment
16234 mPrivateFlags2 |= ((textAlignment << TEXT_ALIGNMENT_MASK_SHIFT) & TEXT_ALIGNMENT_MASK);
16235 // Refresh
16236 requestLayout();
16237 invalidate(true);
16238 }
16239 }
16240
16241 /**
16242 * Return the resolved text alignment.
16243 *
16244 * The resolved text alignment. This needs resolution if the value is
16245 * TEXT_ALIGNMENT_INHERIT. The resolution matches {@link #setTextAlignment(int)} if it is
16246 * not TEXT_ALIGNMENT_INHERIT, otherwise resolution proceeds up the parent chain of the view.
16247 *
16248 * @return the resolved text alignment. Returns one of:
16249 *
16250 * {@link #TEXT_ALIGNMENT_GRAVITY},
16251 * {@link #TEXT_ALIGNMENT_CENTER},
16252 * {@link #TEXT_ALIGNMENT_TEXT_START},
16253 * {@link #TEXT_ALIGNMENT_TEXT_END},
16254 * {@link #TEXT_ALIGNMENT_VIEW_START},
16255 * {@link #TEXT_ALIGNMENT_VIEW_END}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016256 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016257 */
16258 @ViewDebug.ExportedProperty(category = "text", mapping = {
16259 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"),
16260 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"),
16261 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"),
16262 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"),
16263 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"),
16264 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"),
16265 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END")
16266 })
16267 public int getResolvedTextAlignment() {
16268 // If text alignment is not resolved, then resolve it
16269 if ((mPrivateFlags2 & TEXT_ALIGNMENT_RESOLVED) != TEXT_ALIGNMENT_RESOLVED) {
16270 resolveTextAlignment();
16271 }
16272 return (mPrivateFlags2 & TEXT_ALIGNMENT_RESOLVED_MASK) >> TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT;
16273 }
16274
16275 /**
16276 * Resolve the text alignment. Will call {@link View#onResolvedTextAlignmentChanged} when
16277 * resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016278 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016279 */
16280 public void resolveTextAlignment() {
16281 // Reset any previous text alignment resolution
16282 mPrivateFlags2 &= ~(TEXT_ALIGNMENT_RESOLVED | TEXT_ALIGNMENT_RESOLVED_MASK);
16283
16284 if (hasRtlSupport()) {
16285 // Set resolved text alignment flag depending on text alignment flag
16286 final int textAlignment = getTextAlignment();
16287 switch (textAlignment) {
16288 case TEXT_ALIGNMENT_INHERIT:
16289 // Check if we can resolve the text alignment
16290 if (canResolveLayoutDirection() && mParent instanceof View) {
16291 View view = (View) mParent;
16292
16293 final int parentResolvedTextAlignment = view.getResolvedTextAlignment();
16294 switch (parentResolvedTextAlignment) {
16295 case TEXT_ALIGNMENT_GRAVITY:
16296 case TEXT_ALIGNMENT_TEXT_START:
16297 case TEXT_ALIGNMENT_TEXT_END:
16298 case TEXT_ALIGNMENT_CENTER:
16299 case TEXT_ALIGNMENT_VIEW_START:
16300 case TEXT_ALIGNMENT_VIEW_END:
16301 // Resolved text alignment is the same as the parent resolved
16302 // text alignment
16303 mPrivateFlags2 |=
16304 (parentResolvedTextAlignment << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT);
16305 break;
16306 default:
16307 // Use default resolved text alignment
16308 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16309 }
16310 }
16311 else {
16312 // We cannot do the resolution if there is no parent so use the default
16313 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16314 }
16315 break;
16316 case TEXT_ALIGNMENT_GRAVITY:
16317 case TEXT_ALIGNMENT_TEXT_START:
16318 case TEXT_ALIGNMENT_TEXT_END:
16319 case TEXT_ALIGNMENT_CENTER:
16320 case TEXT_ALIGNMENT_VIEW_START:
16321 case TEXT_ALIGNMENT_VIEW_END:
16322 // Resolved text alignment is the same as text alignment
16323 mPrivateFlags2 |= (textAlignment << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT);
16324 break;
16325 default:
16326 // Use default resolved text alignment
16327 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16328 }
16329 } else {
16330 // Use default resolved text alignment
16331 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16332 }
16333
16334 // Set the resolved
16335 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED;
16336 onResolvedTextAlignmentChanged();
16337 }
16338
16339 /**
16340 * Check if text alignment resolution can be done.
16341 *
16342 * @return true if text alignment resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016343 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016344 */
16345 public boolean canResolveTextAlignment() {
16346 switch (getTextAlignment()) {
16347 case TEXT_DIRECTION_INHERIT:
16348 return (mParent != null);
16349 default:
16350 return true;
16351 }
16352 }
16353
16354 /**
16355 * Called when text alignment has been resolved. Subclasses that care about text alignment
16356 * resolution should override this method.
16357 *
16358 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016359 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016360 */
16361 public void onResolvedTextAlignmentChanged() {
16362 }
16363
16364 /**
16365 * Reset resolved text alignment. Text alignment can be resolved with a call to
16366 * getResolvedTextAlignment(). Will call {@link View#onResolvedTextAlignmentReset} when
16367 * reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016368 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016369 */
16370 public void resetResolvedTextAlignment() {
16371 // Reset any previous text alignment resolution
16372 mPrivateFlags2 &= ~(TEXT_ALIGNMENT_RESOLVED | TEXT_ALIGNMENT_RESOLVED_MASK);
16373 onResolvedTextAlignmentReset();
16374 }
16375
16376 /**
16377 * Called when text alignment is reset. Subclasses that care about text alignment reset should
16378 * override this method and do a reset of the text alignment of their children. The default
16379 * implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016380 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016381 */
16382 public void onResolvedTextAlignmentReset() {
16383 }
16384
Chet Haaseb39f0512011-05-24 14:36:40 -070016385 //
16386 // Properties
16387 //
16388 /**
16389 * A Property wrapper around the <code>alpha</code> functionality handled by the
16390 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods.
16391 */
Chet Haased47f1532011-12-16 11:18:52 -080016392 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016393 @Override
16394 public void setValue(View object, float value) {
16395 object.setAlpha(value);
16396 }
16397
16398 @Override
16399 public Float get(View object) {
16400 return object.getAlpha();
16401 }
16402 };
16403
16404 /**
16405 * A Property wrapper around the <code>translationX</code> functionality handled by the
16406 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods.
16407 */
Chet Haased47f1532011-12-16 11:18:52 -080016408 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016409 @Override
16410 public void setValue(View object, float value) {
16411 object.setTranslationX(value);
16412 }
16413
16414 @Override
16415 public Float get(View object) {
16416 return object.getTranslationX();
16417 }
16418 };
16419
16420 /**
16421 * A Property wrapper around the <code>translationY</code> functionality handled by the
16422 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods.
16423 */
Chet Haased47f1532011-12-16 11:18:52 -080016424 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016425 @Override
16426 public void setValue(View object, float value) {
16427 object.setTranslationY(value);
16428 }
16429
16430 @Override
16431 public Float get(View object) {
16432 return object.getTranslationY();
16433 }
16434 };
16435
16436 /**
16437 * A Property wrapper around the <code>x</code> functionality handled by the
16438 * {@link View#setX(float)} and {@link View#getX()} methods.
16439 */
Chet Haased47f1532011-12-16 11:18:52 -080016440 public static final Property<View, Float> X = new FloatProperty<View>("x") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016441 @Override
16442 public void setValue(View object, float value) {
16443 object.setX(value);
16444 }
16445
16446 @Override
16447 public Float get(View object) {
16448 return object.getX();
16449 }
16450 };
16451
16452 /**
16453 * A Property wrapper around the <code>y</code> functionality handled by the
16454 * {@link View#setY(float)} and {@link View#getY()} methods.
16455 */
Chet Haased47f1532011-12-16 11:18:52 -080016456 public static final Property<View, Float> Y = new FloatProperty<View>("y") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016457 @Override
16458 public void setValue(View object, float value) {
16459 object.setY(value);
16460 }
16461
16462 @Override
16463 public Float get(View object) {
16464 return object.getY();
16465 }
16466 };
16467
16468 /**
16469 * A Property wrapper around the <code>rotation</code> functionality handled by the
16470 * {@link View#setRotation(float)} and {@link View#getRotation()} methods.
16471 */
Chet Haased47f1532011-12-16 11:18:52 -080016472 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016473 @Override
16474 public void setValue(View object, float value) {
16475 object.setRotation(value);
16476 }
16477
16478 @Override
16479 public Float get(View object) {
16480 return object.getRotation();
16481 }
16482 };
16483
16484 /**
16485 * A Property wrapper around the <code>rotationX</code> functionality handled by the
16486 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods.
16487 */
Chet Haased47f1532011-12-16 11:18:52 -080016488 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016489 @Override
16490 public void setValue(View object, float value) {
16491 object.setRotationX(value);
16492 }
16493
16494 @Override
16495 public Float get(View object) {
16496 return object.getRotationX();
16497 }
16498 };
16499
16500 /**
16501 * A Property wrapper around the <code>rotationY</code> functionality handled by the
16502 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods.
16503 */
Chet Haased47f1532011-12-16 11:18:52 -080016504 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016505 @Override
16506 public void setValue(View object, float value) {
16507 object.setRotationY(value);
16508 }
16509
16510 @Override
16511 public Float get(View object) {
16512 return object.getRotationY();
16513 }
16514 };
16515
16516 /**
16517 * A Property wrapper around the <code>scaleX</code> functionality handled by the
16518 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods.
16519 */
Chet Haased47f1532011-12-16 11:18:52 -080016520 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016521 @Override
16522 public void setValue(View object, float value) {
16523 object.setScaleX(value);
16524 }
16525
16526 @Override
16527 public Float get(View object) {
16528 return object.getScaleX();
16529 }
16530 };
16531
16532 /**
16533 * A Property wrapper around the <code>scaleY</code> functionality handled by the
16534 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods.
16535 */
Chet Haased47f1532011-12-16 11:18:52 -080016536 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016537 @Override
16538 public void setValue(View object, float value) {
16539 object.setScaleY(value);
16540 }
16541
16542 @Override
16543 public Float get(View object) {
16544 return object.getScaleY();
16545 }
16546 };
16547
Jeff Brown33bbfd22011-02-24 20:55:35 -080016548 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016549 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
16550 * Each MeasureSpec represents a requirement for either the width or the height.
16551 * A MeasureSpec is comprised of a size and a mode. There are three possible
16552 * modes:
16553 * <dl>
16554 * <dt>UNSPECIFIED</dt>
16555 * <dd>
16556 * The parent has not imposed any constraint on the child. It can be whatever size
16557 * it wants.
16558 * </dd>
16559 *
16560 * <dt>EXACTLY</dt>
16561 * <dd>
16562 * The parent has determined an exact size for the child. The child is going to be
16563 * given those bounds regardless of how big it wants to be.
16564 * </dd>
16565 *
16566 * <dt>AT_MOST</dt>
16567 * <dd>
16568 * The child can be as large as it wants up to the specified size.
16569 * </dd>
16570 * </dl>
16571 *
16572 * MeasureSpecs are implemented as ints to reduce object allocation. This class
16573 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
16574 */
16575 public static class MeasureSpec {
16576 private static final int MODE_SHIFT = 30;
16577 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
16578
16579 /**
16580 * Measure specification mode: The parent has not imposed any constraint
16581 * on the child. It can be whatever size it wants.
16582 */
16583 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
16584
16585 /**
16586 * Measure specification mode: The parent has determined an exact size
16587 * for the child. The child is going to be given those bounds regardless
16588 * of how big it wants to be.
16589 */
16590 public static final int EXACTLY = 1 << MODE_SHIFT;
16591
16592 /**
16593 * Measure specification mode: The child can be as large as it wants up
16594 * to the specified size.
16595 */
16596 public static final int AT_MOST = 2 << MODE_SHIFT;
16597
16598 /**
16599 * Creates a measure specification based on the supplied size and mode.
16600 *
16601 * The mode must always be one of the following:
16602 * <ul>
16603 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
16604 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
16605 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
16606 * </ul>
16607 *
16608 * @param size the size of the measure specification
16609 * @param mode the mode of the measure specification
16610 * @return the measure specification based on size and mode
16611 */
16612 public static int makeMeasureSpec(int size, int mode) {
16613 return size + mode;
16614 }
16615
16616 /**
16617 * Extracts the mode from the supplied measure specification.
16618 *
16619 * @param measureSpec the measure specification to extract the mode from
16620 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
16621 * {@link android.view.View.MeasureSpec#AT_MOST} or
16622 * {@link android.view.View.MeasureSpec#EXACTLY}
16623 */
16624 public static int getMode(int measureSpec) {
16625 return (measureSpec & MODE_MASK);
16626 }
16627
16628 /**
16629 * Extracts the size from the supplied measure specification.
16630 *
16631 * @param measureSpec the measure specification to extract the size from
16632 * @return the size in pixels defined in the supplied measure specification
16633 */
16634 public static int getSize(int measureSpec) {
16635 return (measureSpec & ~MODE_MASK);
16636 }
16637
16638 /**
16639 * Returns a String representation of the specified measure
16640 * specification.
16641 *
16642 * @param measureSpec the measure specification to convert to a String
16643 * @return a String with the following format: "MeasureSpec: MODE SIZE"
16644 */
16645 public static String toString(int measureSpec) {
16646 int mode = getMode(measureSpec);
16647 int size = getSize(measureSpec);
16648
16649 StringBuilder sb = new StringBuilder("MeasureSpec: ");
16650
16651 if (mode == UNSPECIFIED)
16652 sb.append("UNSPECIFIED ");
16653 else if (mode == EXACTLY)
16654 sb.append("EXACTLY ");
16655 else if (mode == AT_MOST)
16656 sb.append("AT_MOST ");
16657 else
16658 sb.append(mode).append(" ");
16659
16660 sb.append(size);
16661 return sb.toString();
16662 }
16663 }
16664
16665 class CheckForLongPress implements Runnable {
16666
16667 private int mOriginalWindowAttachCount;
16668
16669 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070016670 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016671 && mOriginalWindowAttachCount == mWindowAttachCount) {
16672 if (performLongClick()) {
16673 mHasPerformedLongPress = true;
16674 }
16675 }
16676 }
16677
16678 public void rememberWindowAttachCount() {
16679 mOriginalWindowAttachCount = mWindowAttachCount;
16680 }
16681 }
Joe Malin32736f02011-01-19 16:14:20 -080016682
Adam Powelle14579b2009-12-16 18:39:52 -080016683 private final class CheckForTap implements Runnable {
16684 public void run() {
16685 mPrivateFlags &= ~PREPRESSED;
Adam Powell4d6f0662012-02-21 15:11:11 -080016686 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -070016687 checkForLongClick(ViewConfiguration.getTapTimeout());
Adam Powelle14579b2009-12-16 18:39:52 -080016688 }
16689 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016690
Adam Powella35d7682010-03-12 14:48:13 -080016691 private final class PerformClick implements Runnable {
16692 public void run() {
16693 performClick();
16694 }
16695 }
16696
Dianne Hackborn63042d62011-01-26 18:56:29 -080016697 /** @hide */
16698 public void hackTurnOffWindowResizeAnim(boolean off) {
16699 mAttachInfo.mTurnOffWindowResizeAnim = off;
16700 }
Joe Malin32736f02011-01-19 16:14:20 -080016701
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016702 /**
Chet Haasea00f3862011-02-22 06:34:40 -080016703 * This method returns a ViewPropertyAnimator object, which can be used to animate
16704 * specific properties on this View.
16705 *
16706 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View.
16707 */
16708 public ViewPropertyAnimator animate() {
16709 if (mAnimator == null) {
16710 mAnimator = new ViewPropertyAnimator(this);
16711 }
16712 return mAnimator;
16713 }
16714
16715 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016716 * Interface definition for a callback to be invoked when a key event is
16717 * dispatched to this view. The callback will be invoked before the key
16718 * event is given to the view.
16719 */
16720 public interface OnKeyListener {
16721 /**
16722 * Called when a key is dispatched to a view. This allows listeners to
16723 * get a chance to respond before the target view.
16724 *
16725 * @param v The view the key has been dispatched to.
16726 * @param keyCode The code for the physical key that was pressed
16727 * @param event The KeyEvent object containing full information about
16728 * the event.
16729 * @return True if the listener has consumed the event, false otherwise.
16730 */
16731 boolean onKey(View v, int keyCode, KeyEvent event);
16732 }
16733
16734 /**
16735 * Interface definition for a callback to be invoked when a touch event is
16736 * dispatched to this view. The callback will be invoked before the touch
16737 * event is given to the view.
16738 */
16739 public interface OnTouchListener {
16740 /**
16741 * Called when a touch event is dispatched to a view. This allows listeners to
16742 * get a chance to respond before the target view.
16743 *
16744 * @param v The view the touch event has been dispatched to.
16745 * @param event The MotionEvent object containing full information about
16746 * the event.
16747 * @return True if the listener has consumed the event, false otherwise.
16748 */
16749 boolean onTouch(View v, MotionEvent event);
16750 }
16751
16752 /**
Jeff Brown10b62902011-06-20 16:40:37 -070016753 * Interface definition for a callback to be invoked when a hover event is
16754 * dispatched to this view. The callback will be invoked before the hover
16755 * event is given to the view.
16756 */
16757 public interface OnHoverListener {
16758 /**
16759 * Called when a hover event is dispatched to a view. This allows listeners to
16760 * get a chance to respond before the target view.
16761 *
16762 * @param v The view the hover event has been dispatched to.
16763 * @param event The MotionEvent object containing full information about
16764 * the event.
16765 * @return True if the listener has consumed the event, false otherwise.
16766 */
16767 boolean onHover(View v, MotionEvent event);
16768 }
16769
16770 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080016771 * Interface definition for a callback to be invoked when a generic motion event is
16772 * dispatched to this view. The callback will be invoked before the generic motion
16773 * event is given to the view.
16774 */
16775 public interface OnGenericMotionListener {
16776 /**
16777 * Called when a generic motion event is dispatched to a view. This allows listeners to
16778 * get a chance to respond before the target view.
16779 *
16780 * @param v The view the generic motion event has been dispatched to.
16781 * @param event The MotionEvent object containing full information about
16782 * the event.
16783 * @return True if the listener has consumed the event, false otherwise.
16784 */
16785 boolean onGenericMotion(View v, MotionEvent event);
16786 }
16787
16788 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016789 * Interface definition for a callback to be invoked when a view has been clicked and held.
16790 */
16791 public interface OnLongClickListener {
16792 /**
16793 * Called when a view has been clicked and held.
16794 *
16795 * @param v The view that was clicked and held.
16796 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080016797 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016798 */
16799 boolean onLongClick(View v);
16800 }
16801
16802 /**
Chris Tate32affef2010-10-18 15:29:21 -070016803 * Interface definition for a callback to be invoked when a drag is being dispatched
16804 * to this view. The callback will be invoked before the hosting view's own
16805 * onDrag(event) method. If the listener wants to fall back to the hosting view's
16806 * onDrag(event) behavior, it should return 'false' from this callback.
Joe Fernandez558459f2011-10-13 16:47:36 -070016807 *
16808 * <div class="special reference">
16809 * <h3>Developer Guides</h3>
16810 * <p>For a guide to implementing drag and drop features, read the
16811 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p>
16812 * </div>
Chris Tate32affef2010-10-18 15:29:21 -070016813 */
16814 public interface OnDragListener {
16815 /**
16816 * Called when a drag event is dispatched to a view. This allows listeners
16817 * to get a chance to override base View behavior.
16818 *
Joe Malin32736f02011-01-19 16:14:20 -080016819 * @param v The View that received the drag event.
16820 * @param event The {@link android.view.DragEvent} object for the drag event.
16821 * @return {@code true} if the drag event was handled successfully, or {@code false}
16822 * if the drag event was not handled. Note that {@code false} will trigger the View
16823 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler.
Chris Tate32affef2010-10-18 15:29:21 -070016824 */
16825 boolean onDrag(View v, DragEvent event);
16826 }
16827
16828 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016829 * Interface definition for a callback to be invoked when the focus state of
16830 * a view changed.
16831 */
16832 public interface OnFocusChangeListener {
16833 /**
16834 * Called when the focus state of a view has changed.
16835 *
16836 * @param v The view whose state has changed.
16837 * @param hasFocus The new focus state of v.
16838 */
16839 void onFocusChange(View v, boolean hasFocus);
16840 }
16841
16842 /**
16843 * Interface definition for a callback to be invoked when a view is clicked.
16844 */
16845 public interface OnClickListener {
16846 /**
16847 * Called when a view has been clicked.
16848 *
16849 * @param v The view that was clicked.
16850 */
16851 void onClick(View v);
16852 }
16853
16854 /**
16855 * Interface definition for a callback to be invoked when the context menu
16856 * for this view is being built.
16857 */
16858 public interface OnCreateContextMenuListener {
16859 /**
16860 * Called when the context menu for this view is being built. It is not
16861 * safe to hold onto the menu after this method returns.
16862 *
16863 * @param menu The context menu that is being built
16864 * @param v The view for which the context menu is being built
16865 * @param menuInfo Extra information about the item for which the
16866 * context menu should be shown. This information will vary
16867 * depending on the class of v.
16868 */
16869 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
16870 }
16871
Joe Onorato664644d2011-01-23 17:53:23 -080016872 /**
16873 * Interface definition for a callback to be invoked when the status bar changes
Dianne Hackborn9a230e02011-10-06 11:51:27 -070016874 * visibility. This reports <strong>global</strong> changes to the system UI
Dianne Hackborncf675782012-05-10 15:07:24 -070016875 * state, not what the application is requesting.
Joe Onorato664644d2011-01-23 17:53:23 -080016876 *
Philip Milne6c8ea062012-04-03 17:38:43 -070016877 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener)
Joe Onorato664644d2011-01-23 17:53:23 -080016878 */
16879 public interface OnSystemUiVisibilityChangeListener {
16880 /**
16881 * Called when the status bar changes visibility because of a call to
Romain Guy5c22a8c2011-05-13 11:48:45 -070016882 * {@link View#setSystemUiVisibility(int)}.
Joe Onorato664644d2011-01-23 17:53:23 -080016883 *
Dianne Hackborncf675782012-05-10 15:07:24 -070016884 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
16885 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, and {@link #SYSTEM_UI_FLAG_FULLSCREEN}.
16886 * This tells you the <strong>global</strong> state of these UI visibility
16887 * flags, not what your app is currently applying.
Joe Onorato664644d2011-01-23 17:53:23 -080016888 */
16889 public void onSystemUiVisibilityChange(int visibility);
16890 }
16891
Adam Powell4afd62b2011-02-18 15:02:18 -080016892 /**
16893 * Interface definition for a callback to be invoked when this view is attached
16894 * or detached from its window.
16895 */
16896 public interface OnAttachStateChangeListener {
16897 /**
16898 * Called when the view is attached to a window.
16899 * @param v The view that was attached
16900 */
16901 public void onViewAttachedToWindow(View v);
16902 /**
16903 * Called when the view is detached from a window.
16904 * @param v The view that was detached
16905 */
16906 public void onViewDetachedFromWindow(View v);
16907 }
16908
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016909 private final class UnsetPressedState implements Runnable {
16910 public void run() {
16911 setPressed(false);
16912 }
16913 }
16914
16915 /**
16916 * Base class for derived classes that want to save and restore their own
16917 * state in {@link android.view.View#onSaveInstanceState()}.
16918 */
16919 public static class BaseSavedState extends AbsSavedState {
16920 /**
16921 * Constructor used when reading from a parcel. Reads the state of the superclass.
16922 *
16923 * @param source
16924 */
16925 public BaseSavedState(Parcel source) {
16926 super(source);
16927 }
16928
16929 /**
16930 * Constructor called by derived classes when creating their SavedState objects
16931 *
16932 * @param superState The state of the superclass of this view
16933 */
16934 public BaseSavedState(Parcelable superState) {
16935 super(superState);
16936 }
16937
16938 public static final Parcelable.Creator<BaseSavedState> CREATOR =
16939 new Parcelable.Creator<BaseSavedState>() {
16940 public BaseSavedState createFromParcel(Parcel in) {
16941 return new BaseSavedState(in);
16942 }
16943
16944 public BaseSavedState[] newArray(int size) {
16945 return new BaseSavedState[size];
16946 }
16947 };
16948 }
16949
16950 /**
16951 * A set of information given to a view when it is attached to its parent
16952 * window.
16953 */
16954 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016955 interface Callbacks {
16956 void playSoundEffect(int effectId);
16957 boolean performHapticFeedback(int effectId, boolean always);
16958 }
16959
16960 /**
16961 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
16962 * to a Handler. This class contains the target (View) to invalidate and
16963 * the coordinates of the dirty rectangle.
16964 *
16965 * For performance purposes, this class also implements a pool of up to
16966 * POOL_LIMIT objects that get reused. This reduces memory allocations
16967 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016968 */
Romain Guyd928d682009-03-31 17:52:16 -070016969 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016970 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070016971 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
16972 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070016973 public InvalidateInfo newInstance() {
16974 return new InvalidateInfo();
16975 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016976
Romain Guyd928d682009-03-31 17:52:16 -070016977 public void onAcquired(InvalidateInfo element) {
16978 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016979
Romain Guyd928d682009-03-31 17:52:16 -070016980 public void onReleased(InvalidateInfo element) {
Romain Guy40c18f52011-09-01 17:01:18 -070016981 element.target = null;
Romain Guyd928d682009-03-31 17:52:16 -070016982 }
16983 }, POOL_LIMIT)
16984 );
16985
16986 private InvalidateInfo mNext;
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070016987 private boolean mIsPooled;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016988
16989 View target;
16990
16991 int left;
16992 int top;
16993 int right;
16994 int bottom;
16995
Romain Guyd928d682009-03-31 17:52:16 -070016996 public void setNextPoolable(InvalidateInfo element) {
16997 mNext = element;
16998 }
16999
17000 public InvalidateInfo getNextPoolable() {
17001 return mNext;
17002 }
17003
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017004 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070017005 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017006 }
17007
17008 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070017009 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017010 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017011
17012 public boolean isPooled() {
17013 return mIsPooled;
17014 }
17015
17016 public void setPooled(boolean isPooled) {
17017 mIsPooled = isPooled;
17018 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017019 }
17020
17021 final IWindowSession mSession;
17022
17023 final IWindow mWindow;
17024
17025 final IBinder mWindowToken;
17026
17027 final Callbacks mRootCallbacks;
17028
Romain Guy59a12ca2011-06-09 17:48:21 -070017029 HardwareCanvas mHardwareCanvas;
Chet Haasedaf98e92011-01-10 14:10:36 -080017030
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017031 /**
17032 * The top view of the hierarchy.
17033 */
17034 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070017035
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017036 IBinder mPanelParentWindowToken;
17037 Surface mSurface;
17038
Romain Guyb051e892010-09-28 19:09:36 -070017039 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080017040 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070017041 HardwareRenderer mHardwareRenderer;
Joe Malin32736f02011-01-19 16:14:20 -080017042
Romain Guy7e4e5612012-03-05 14:37:29 -080017043 boolean mScreenOn;
17044
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017045 /**
Romain Guy8506ab42009-06-11 17:35:47 -070017046 * Scale factor used by the compatibility mode
17047 */
17048 float mApplicationScale;
17049
17050 /**
17051 * Indicates whether the application is in compatibility mode
17052 */
17053 boolean mScalingRequired;
17054
17055 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070017056 * If set, ViewAncestor doesn't use its lame animation for when the window resizes.
Dianne Hackborn63042d62011-01-26 18:56:29 -080017057 */
17058 boolean mTurnOffWindowResizeAnim;
Joe Malin32736f02011-01-19 16:14:20 -080017059
Dianne Hackborn63042d62011-01-26 18:56:29 -080017060 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017061 * Left position of this view's window
17062 */
17063 int mWindowLeft;
17064
17065 /**
17066 * Top position of this view's window
17067 */
17068 int mWindowTop;
17069
17070 /**
Adam Powell26153a32010-11-08 15:22:27 -080017071 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070017072 */
Adam Powell26153a32010-11-08 15:22:27 -080017073 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070017074
17075 /**
Dianne Hackborn3556c9a2012-05-04 16:31:25 -070017076 * Describes the parts of the window that are currently completely
17077 * obscured by system UI elements.
17078 */
17079 final Rect mSystemInsets = new Rect();
17080
17081 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017082 * For windows that are full-screen but using insets to layout inside
17083 * of the screen decorations, these are the current insets for the
17084 * content of the window.
17085 */
17086 final Rect mContentInsets = new Rect();
17087
17088 /**
17089 * For windows that are full-screen but using insets to layout inside
17090 * of the screen decorations, these are the current insets for the
17091 * actual visible parts of the window.
17092 */
17093 final Rect mVisibleInsets = new Rect();
17094
17095 /**
17096 * The internal insets given by this window. This value is
17097 * supplied by the client (through
17098 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
17099 * be given to the window manager when changed to be used in laying
17100 * out windows behind it.
17101 */
17102 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
17103 = new ViewTreeObserver.InternalInsetsInfo();
17104
17105 /**
17106 * All views in the window's hierarchy that serve as scroll containers,
17107 * used to determine if the window can be resized or must be panned
17108 * to adjust for a soft input area.
17109 */
17110 final ArrayList<View> mScrollContainers = new ArrayList<View>();
17111
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070017112 final KeyEvent.DispatcherState mKeyDispatchState
17113 = new KeyEvent.DispatcherState();
17114
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017115 /**
17116 * Indicates whether the view's window currently has the focus.
17117 */
17118 boolean mHasWindowFocus;
17119
17120 /**
17121 * The current visibility of the window.
17122 */
17123 int mWindowVisibility;
17124
17125 /**
17126 * Indicates the time at which drawing started to occur.
17127 */
17128 long mDrawingTime;
17129
17130 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070017131 * Indicates whether or not ignoring the DIRTY_MASK flags.
17132 */
17133 boolean mIgnoreDirtyState;
17134
17135 /**
Romain Guy02ccac62011-06-24 13:20:23 -070017136 * This flag tracks when the mIgnoreDirtyState flag is set during draw(),
17137 * to avoid clearing that flag prematurely.
17138 */
17139 boolean mSetIgnoreDirtyState = false;
17140
17141 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017142 * Indicates whether the view's window is currently in touch mode.
17143 */
17144 boolean mInTouchMode;
17145
17146 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070017147 * Indicates that ViewAncestor should trigger a global layout change
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017148 * the next time it performs a traversal
17149 */
17150 boolean mRecomputeGlobalAttributes;
17151
17152 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -070017153 * Always report new attributes at next traversal.
17154 */
17155 boolean mForceReportNewAttributes;
17156
17157 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017158 * Set during a traveral if any views want to keep the screen on.
17159 */
17160 boolean mKeepScreenOn;
17161
17162 /**
Joe Onorato664644d2011-01-23 17:53:23 -080017163 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility().
17164 */
17165 int mSystemUiVisibility;
17166
17167 /**
Dianne Hackborn139e5aa2012-05-05 20:36:38 -070017168 * Hack to force certain system UI visibility flags to be cleared.
17169 */
17170 int mDisabledSystemUiVisibility;
17171
17172 /**
Dianne Hackborncf675782012-05-10 15:07:24 -070017173 * Last global system UI visibility reported by the window manager.
17174 */
17175 int mGlobalSystemUiVisibility;
17176
17177 /**
Joe Onorato664644d2011-01-23 17:53:23 -080017178 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener
17179 * attached.
17180 */
17181 boolean mHasSystemUiListeners;
17182
17183 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017184 * Set if the visibility of any views has changed.
17185 */
17186 boolean mViewVisibilityChanged;
17187
17188 /**
17189 * Set to true if a view has been scrolled.
17190 */
17191 boolean mViewScrollChanged;
17192
17193 /**
17194 * Global to the view hierarchy used as a temporary for dealing with
17195 * x/y points in the transparent region computations.
17196 */
17197 final int[] mTransparentLocation = new int[2];
17198
17199 /**
17200 * Global to the view hierarchy used as a temporary for dealing with
17201 * x/y points in the ViewGroup.invalidateChild implementation.
17202 */
17203 final int[] mInvalidateChildLocation = new int[2];
17204
Chet Haasec3aa3612010-06-17 08:50:37 -070017205
17206 /**
17207 * Global to the view hierarchy used as a temporary for dealing with
17208 * x/y location when view is transformed.
17209 */
17210 final float[] mTmpTransformLocation = new float[2];
17211
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017212 /**
17213 * The view tree observer used to dispatch global events like
17214 * layout, pre-draw, touch mode change, etc.
17215 */
17216 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
17217
17218 /**
17219 * A Canvas used by the view hierarchy to perform bitmap caching.
17220 */
17221 Canvas mCanvas;
17222
17223 /**
Jeff Browna175a5b2012-02-15 19:18:31 -080017224 * The view root impl.
17225 */
17226 final ViewRootImpl mViewRootImpl;
17227
17228 /**
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070017229 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017230 * handler can be used to pump events in the UI events queue.
17231 */
17232 final Handler mHandler;
17233
17234 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017235 * Temporary for use in computing invalidate rectangles while
17236 * calling up the hierarchy.
17237 */
17238 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070017239
17240 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070017241 * Temporary for use in computing hit areas with transformed views
17242 */
17243 final RectF mTmpTransformRect = new RectF();
17244
17245 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070017246 * Temporary list for use in collecting focusable descendents of a view.
17247 */
Svetoslav Ganov42138042012-03-20 11:51:39 -070017248 final ArrayList<View> mTempArrayList = new ArrayList<View>(24);
svetoslavganov75986cf2009-05-14 22:28:01 -070017249
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017250 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017251 * The id of the window for accessibility purposes.
17252 */
17253 int mAccessibilityWindowId = View.NO_ID;
17254
17255 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -070017256 * Whether to ingore not exposed for accessibility Views when
17257 * reporting the view tree to accessibility services.
17258 */
17259 boolean mIncludeNotImportantViews;
17260
17261 /**
17262 * The drawable for highlighting accessibility focus.
17263 */
17264 Drawable mAccessibilityFocusDrawable;
17265
17266 /**
Philip Milne10ca24a2012-04-23 15:38:27 -070017267 * Show where the margins, bounds and layout bounds are for each view.
17268 */
Dianne Hackborna53de062012-05-08 18:53:51 -070017269 boolean mDebugLayout = SystemProperties.getBoolean(DEBUG_LAYOUT_PROPERTY, false);
Philip Milne10ca24a2012-04-23 15:38:27 -070017270
17271 /**
Romain Guyab4c4f4f2012-05-06 13:11:24 -070017272 * Point used to compute visible regions.
17273 */
17274 final Point mPoint = new Point();
17275
17276 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017277 * Creates a new set of attachment information with the specified
17278 * events handler and thread.
17279 *
17280 * @param handler the events handler the view must use
17281 */
17282 AttachInfo(IWindowSession session, IWindow window,
Jeff Browna175a5b2012-02-15 19:18:31 -080017283 ViewRootImpl viewRootImpl, Handler handler, Callbacks effectPlayer) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017284 mSession = session;
17285 mWindow = window;
17286 mWindowToken = window.asBinder();
Jeff Browna175a5b2012-02-15 19:18:31 -080017287 mViewRootImpl = viewRootImpl;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017288 mHandler = handler;
17289 mRootCallbacks = effectPlayer;
17290 }
17291 }
17292
17293 /**
17294 * <p>ScrollabilityCache holds various fields used by a View when scrolling
17295 * is supported. This avoids keeping too many unused fields in most
17296 * instances of View.</p>
17297 */
Mike Cleronf116bf82009-09-27 19:14:12 -070017298 private static class ScrollabilityCache implements Runnable {
Joe Malin32736f02011-01-19 16:14:20 -080017299
Mike Cleronf116bf82009-09-27 19:14:12 -070017300 /**
17301 * Scrollbars are not visible
17302 */
17303 public static final int OFF = 0;
17304
17305 /**
17306 * Scrollbars are visible
17307 */
17308 public static final int ON = 1;
17309
17310 /**
17311 * Scrollbars are fading away
17312 */
17313 public static final int FADING = 2;
17314
17315 public boolean fadeScrollBars;
Joe Malin32736f02011-01-19 16:14:20 -080017316
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017317 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070017318 public int scrollBarDefaultDelayBeforeFade;
17319 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017320
17321 public int scrollBarSize;
17322 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070017323 public float[] interpolatorValues;
17324 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017325
17326 public final Paint paint;
17327 public final Matrix matrix;
17328 public Shader shader;
17329
Mike Cleronf116bf82009-09-27 19:14:12 -070017330 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
17331
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017332 private static final float[] OPAQUE = { 255 };
17333 private static final float[] TRANSPARENT = { 0.0f };
Joe Malin32736f02011-01-19 16:14:20 -080017334
Mike Cleronf116bf82009-09-27 19:14:12 -070017335 /**
17336 * When fading should start. This time moves into the future every time
17337 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
17338 */
17339 public long fadeStartTime;
17340
17341
17342 /**
17343 * The current state of the scrollbars: ON, OFF, or FADING
17344 */
17345 public int state = OFF;
17346
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017347 private int mLastColor;
17348
Mike Cleronf116bf82009-09-27 19:14:12 -070017349 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017350 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
17351 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070017352 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
17353 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017354
17355 paint = new Paint();
17356 matrix = new Matrix();
17357 // use use a height of 1, and then wack the matrix each time we
17358 // actually use it.
17359 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070017360
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017361 paint.setShader(shader);
17362 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070017363 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017364 }
Romain Guy8506ab42009-06-11 17:35:47 -070017365
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017366 public void setFadeColor(int color) {
17367 if (color != 0 && color != mLastColor) {
17368 mLastColor = color;
17369 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070017370
Romain Guye55e1a72009-08-27 10:42:26 -070017371 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
17372 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070017373
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017374 paint.setShader(shader);
17375 // Restore the default transfer mode (src_over)
17376 paint.setXfermode(null);
17377 }
17378 }
Joe Malin32736f02011-01-19 16:14:20 -080017379
Mike Cleronf116bf82009-09-27 19:14:12 -070017380 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070017381 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070017382 if (now >= fadeStartTime) {
17383
17384 // the animation fades the scrollbars out by changing
17385 // the opacity (alpha) from fully opaque to fully
17386 // transparent
17387 int nextFrame = (int) now;
17388 int framesCount = 0;
17389
17390 Interpolator interpolator = scrollBarInterpolator;
17391
17392 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017393 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070017394
17395 // End transparent
17396 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017397 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070017398
17399 state = FADING;
17400
17401 // Kick off the fade animation
Romain Guy0fd89bf2011-01-26 15:41:30 -080017402 host.invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -070017403 }
17404 }
Svetoslav Ganova0156172011-06-26 17:55:44 -070017405 }
Mike Cleronf116bf82009-09-27 19:14:12 -070017406
Svetoslav Ganova0156172011-06-26 17:55:44 -070017407 /**
17408 * Resuable callback for sending
17409 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
17410 */
17411 private class SendViewScrolledAccessibilityEvent implements Runnable {
17412 public volatile boolean mIsPending;
17413
17414 public void run() {
17415 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED);
17416 mIsPending = false;
17417 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017418 }
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017419
17420 /**
17421 * <p>
17422 * This class represents a delegate that can be registered in a {@link View}
17423 * to enhance accessibility support via composition rather via inheritance.
17424 * It is specifically targeted to widget developers that extend basic View
17425 * classes i.e. classes in package android.view, that would like their
17426 * applications to be backwards compatible.
17427 * </p>
Joe Fernandeze1302ed2012-02-06 14:30:15 -080017428 * <div class="special reference">
17429 * <h3>Developer Guides</h3>
17430 * <p>For more information about making applications accessible, read the
17431 * <a href="{@docRoot}guide/topics/ui/accessibility/index.html">Accessibility</a>
17432 * developer guide.</p>
17433 * </div>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017434 * <p>
17435 * A scenario in which a developer would like to use an accessibility delegate
17436 * is overriding a method introduced in a later API version then the minimal API
17437 * version supported by the application. For example, the method
17438 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available
17439 * in API version 4 when the accessibility APIs were first introduced. If a
17440 * developer would like his application to run on API version 4 devices (assuming
17441 * all other APIs used by the application are version 4 or lower) and take advantage
17442 * of this method, instead of overriding the method which would break the application's
17443 * backwards compatibility, he can override the corresponding method in this
17444 * delegate and register the delegate in the target View if the API version of
17445 * the system is high enough i.e. the API version is same or higher to the API
17446 * version that introduced
17447 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}.
17448 * </p>
17449 * <p>
17450 * Here is an example implementation:
17451 * </p>
17452 * <code><pre><p>
17453 * if (Build.VERSION.SDK_INT >= 14) {
17454 * // If the API version is equal of higher than the version in
17455 * // which onInitializeAccessibilityNodeInfo was introduced we
17456 * // register a delegate with a customized implementation.
17457 * View view = findViewById(R.id.view_id);
17458 * view.setAccessibilityDelegate(new AccessibilityDelegate() {
17459 * public void onInitializeAccessibilityNodeInfo(View host,
17460 * AccessibilityNodeInfo info) {
17461 * // Let the default implementation populate the info.
17462 * super.onInitializeAccessibilityNodeInfo(host, info);
17463 * // Set some other information.
17464 * info.setEnabled(host.isEnabled());
17465 * }
17466 * });
17467 * }
17468 * </code></pre></p>
17469 * <p>
17470 * This delegate contains methods that correspond to the accessibility methods
17471 * in View. If a delegate has been specified the implementation in View hands
17472 * off handling to the corresponding method in this delegate. The default
17473 * implementation the delegate methods behaves exactly as the corresponding
17474 * method in View for the case of no accessibility delegate been set. Hence,
17475 * to customize the behavior of a View method, clients can override only the
17476 * corresponding delegate method without altering the behavior of the rest
17477 * accessibility related methods of the host view.
17478 * </p>
17479 */
17480 public static class AccessibilityDelegate {
17481
17482 /**
17483 * Sends an accessibility event of the given type. If accessibility is not
17484 * enabled this method has no effect.
17485 * <p>
17486 * The default implementation behaves as {@link View#sendAccessibilityEvent(int)
17487 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate
17488 * been set.
17489 * </p>
17490 *
17491 * @param host The View hosting the delegate.
17492 * @param eventType The type of the event to send.
17493 *
17494 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int)
17495 */
17496 public void sendAccessibilityEvent(View host, int eventType) {
17497 host.sendAccessibilityEventInternal(eventType);
17498 }
17499
17500 /**
alanv8eeefef2012-05-07 16:57:53 -070017501 * Performs the specified accessibility action on the view. For
17502 * possible accessibility actions look at {@link AccessibilityNodeInfo}.
17503 * <p>
17504 * The default implementation behaves as
17505 * {@link View#performAccessibilityAction(int, Bundle)
17506 * View#performAccessibilityAction(int, Bundle)} for the case of
17507 * no accessibility delegate been set.
17508 * </p>
17509 *
17510 * @param action The action to perform.
17511 * @return Whether the action was performed.
17512 *
17513 * @see View#performAccessibilityAction(int, Bundle)
17514 * View#performAccessibilityAction(int, Bundle)
17515 */
17516 public boolean performAccessibilityAction(View host, int action, Bundle args) {
17517 return host.performAccessibilityActionInternal(action, args);
17518 }
17519
17520 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017521 * Sends an accessibility event. This method behaves exactly as
17522 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an
17523 * empty {@link AccessibilityEvent} and does not perform a check whether
17524 * accessibility is enabled.
17525 * <p>
17526 * The default implementation behaves as
17527 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17528 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for
17529 * the case of no accessibility delegate been set.
17530 * </p>
17531 *
17532 * @param host The View hosting the delegate.
17533 * @param event The event to send.
17534 *
17535 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17536 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17537 */
17538 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) {
17539 host.sendAccessibilityEventUncheckedInternal(event);
17540 }
17541
17542 /**
17543 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then
17544 * to its children for adding their text content to the event.
17545 * <p>
17546 * The default implementation behaves as
17547 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17548 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for
17549 * the case of no accessibility delegate been set.
17550 * </p>
17551 *
17552 * @param host The View hosting the delegate.
17553 * @param event The event.
17554 * @return True if the event population was completed.
17555 *
17556 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17557 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17558 */
17559 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) {
17560 return host.dispatchPopulateAccessibilityEventInternal(event);
17561 }
17562
17563 /**
17564 * Gives a chance to the host View to populate the accessibility event with its
17565 * text content.
17566 * <p>
17567 * The default implementation behaves as
17568 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent)
17569 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for
17570 * the case of no accessibility delegate been set.
17571 * </p>
17572 *
17573 * @param host The View hosting the delegate.
17574 * @param event The accessibility event which to populate.
17575 *
17576 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent)
17577 * View#onPopulateAccessibilityEvent(AccessibilityEvent)
17578 */
17579 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) {
17580 host.onPopulateAccessibilityEventInternal(event);
17581 }
17582
17583 /**
17584 * Initializes an {@link AccessibilityEvent} with information about the
17585 * the host View which is the event source.
17586 * <p>
17587 * The default implementation behaves as
17588 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent)
17589 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for
17590 * the case of no accessibility delegate been set.
17591 * </p>
17592 *
17593 * @param host The View hosting the delegate.
17594 * @param event The event to initialize.
17595 *
17596 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent)
17597 * View#onInitializeAccessibilityEvent(AccessibilityEvent)
17598 */
17599 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) {
17600 host.onInitializeAccessibilityEventInternal(event);
17601 }
17602
17603 /**
17604 * Initializes an {@link AccessibilityNodeInfo} with information about the host view.
17605 * <p>
17606 * The default implementation behaves as
17607 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17608 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for
17609 * the case of no accessibility delegate been set.
17610 * </p>
17611 *
17612 * @param host The View hosting the delegate.
17613 * @param info The instance to initialize.
17614 *
17615 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17616 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17617 */
17618 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) {
17619 host.onInitializeAccessibilityNodeInfoInternal(info);
17620 }
17621
17622 /**
17623 * Called when a child of the host View has requested sending an
17624 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host)
17625 * to augment the event.
17626 * <p>
17627 * The default implementation behaves as
17628 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17629 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for
17630 * the case of no accessibility delegate been set.
17631 * </p>
17632 *
17633 * @param host The View hosting the delegate.
17634 * @param child The child which requests sending the event.
17635 * @param event The event to be sent.
17636 * @return True if the event should be sent
17637 *
17638 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17639 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17640 */
17641 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child,
17642 AccessibilityEvent event) {
17643 return host.onRequestSendAccessibilityEventInternal(child, event);
17644 }
Svetoslav Ganov02107852011-10-03 17:06:56 -070017645
17646 /**
17647 * Gets the provider for managing a virtual view hierarchy rooted at this View
17648 * and reported to {@link android.accessibilityservice.AccessibilityService}s
17649 * that explore the window content.
17650 * <p>
17651 * The default implementation behaves as
17652 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for
17653 * the case of no accessibility delegate been set.
17654 * </p>
17655 *
17656 * @return The provider.
17657 *
17658 * @see AccessibilityNodeProvider
17659 */
17660 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) {
17661 return null;
17662 }
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017663 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017664}