blob: 6d60797bf6d0aff99095ca91b7e056ba87e9e068 [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 /**
Guang Zhu0d607fb2012-05-11 19:34:56 -0700669 * When set to true, apps will draw debugging information about their layouts.
Romain Guy4b8c4f82012-04-27 15:48:35 -0700670 *
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
Chet Haaseafd5c3e2012-05-10 13:21:10 -07002131 /**
2132 * Flag indicating that view has an animation set on it. This is used to track whether an
2133 * animation is cleared between successive frames, in order to tell the associated
2134 * DisplayList to clear its animation matrix.
2135 */
2136 static final int VIEW_IS_ANIMATING_TRANSFORM = 0x10000000;
2137
Chet Haase1a3ab172012-05-11 08:41:20 -07002138 /**
2139 * Flag indicating whether a view failed the quickReject() check in draw(). This condition
2140 * is used to check whether later changes to the view's transform should invalidate the
2141 * view to force the quickReject test to run again.
2142 */
2143 static final int VIEW_QUICK_REJECTED = 0x20000000;
2144
Christopher Tate3d4bf172011-03-28 16:16:46 -07002145 /* End of masks for mPrivateFlags2 */
2146
2147 static final int DRAG_MASK = DRAG_CAN_ACCEPT | DRAG_HOVERED;
2148
Chet Haasedaf98e92011-01-10 14:10:36 -08002149 /**
Adam Powell637d3372010-08-25 14:37:03 -07002150 * Always allow a user to over-scroll this view, provided it is a
2151 * view that can scroll.
2152 *
2153 * @see #getOverScrollMode()
2154 * @see #setOverScrollMode(int)
2155 */
2156 public static final int OVER_SCROLL_ALWAYS = 0;
2157
2158 /**
2159 * Allow a user to over-scroll this view only if the content is large
2160 * enough to meaningfully scroll, provided it is a view that can scroll.
2161 *
2162 * @see #getOverScrollMode()
2163 * @see #setOverScrollMode(int)
2164 */
2165 public static final int OVER_SCROLL_IF_CONTENT_SCROLLS = 1;
2166
2167 /**
2168 * Never allow a user to over-scroll this view.
2169 *
2170 * @see #getOverScrollMode()
2171 * @see #setOverScrollMode(int)
2172 */
2173 public static final int OVER_SCROLL_NEVER = 2;
2174
2175 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002176 * Special constant for {@link #setSystemUiVisibility(int)}: View has
2177 * requested the system UI (status bar) to be visible (the default).
Joe Onorato664644d2011-01-23 17:53:23 -08002178 *
Joe Malin32736f02011-01-19 16:14:20 -08002179 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08002180 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002181 public static final int SYSTEM_UI_FLAG_VISIBLE = 0;
Joe Onorato664644d2011-01-23 17:53:23 -08002182
2183 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002184 * Flag for {@link #setSystemUiVisibility(int)}: View has requested the
2185 * system UI to enter an unobtrusive "low profile" mode.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002186 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002187 * <p>This is for use in games, book readers, video players, or any other
Philip Milne6c8ea062012-04-03 17:38:43 -07002188 * "immersive" application where the usual system chrome is deemed too distracting.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002189 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002190 * <p>In low profile mode, the status bar and/or navigation icons may dim.
Joe Onorato664644d2011-01-23 17:53:23 -08002191 *
Joe Malin32736f02011-01-19 16:14:20 -08002192 * @see #setSystemUiVisibility(int)
Joe Onorato664644d2011-01-23 17:53:23 -08002193 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002194 public static final int SYSTEM_UI_FLAG_LOW_PROFILE = 0x00000001;
2195
2196 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002197 * Flag for {@link #setSystemUiVisibility(int)}: View has requested that the
2198 * system navigation be temporarily hidden.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002199 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002200 * <p>This is an even less obtrusive state than that called for by
Daniel Sandler60ee2562011-07-22 12:34:33 -04002201 * {@link #SYSTEM_UI_FLAG_LOW_PROFILE}; on devices that draw essential navigation controls
2202 * (Home, Back, and the like) on screen, <code>SYSTEM_UI_FLAG_HIDE_NAVIGATION</code> will cause
2203 * those to disappear. This is useful (in conjunction with the
Philip Milne6c8ea062012-04-03 17:38:43 -07002204 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN FLAG_FULLSCREEN} and
Daniel Sandler60ee2562011-07-22 12:34:33 -04002205 * {@link android.view.WindowManager.LayoutParams#FLAG_LAYOUT_IN_SCREEN FLAG_LAYOUT_IN_SCREEN}
2206 * window flags) for displaying content using every last pixel on the display.
2207 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002208 * <p>There is a limitation: because navigation controls are so important, the least user
2209 * interaction will cause them to reappear immediately. When this happens, both
2210 * this flag and {@link #SYSTEM_UI_FLAG_FULLSCREEN} will be cleared automatically,
2211 * so that both elements reappear at the same time.
Daniel Sandler60ee2562011-07-22 12:34:33 -04002212 *
2213 * @see #setSystemUiVisibility(int)
2214 */
2215 public static final int SYSTEM_UI_FLAG_HIDE_NAVIGATION = 0x00000002;
2216
2217 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002218 * Flag for {@link #setSystemUiVisibility(int)}: View has requested to go
2219 * into the normal fullscreen mode so that its content can take over the screen
2220 * while still allowing the user to interact with the application.
2221 *
2222 * <p>This has the same visual effect as
2223 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN
2224 * WindowManager.LayoutParams.FLAG_FULLSCREEN},
2225 * meaning that non-critical screen decorations (such as the status bar) will be
2226 * hidden while the user is in the View's window, focusing the experience on
2227 * that content. Unlike the window flag, if you are using ActionBar in
2228 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY
2229 * Window.FEATURE_ACTION_BAR_OVERLAY}, then enabling this flag will also
2230 * hide the action bar.
2231 *
2232 * <p>This approach to going fullscreen is best used over the window flag when
2233 * it is a transient state -- that is, the application does this at certain
2234 * points in its user interaction where it wants to allow the user to focus
2235 * on content, but not as a continuous state. For situations where the application
2236 * would like to simply stay full screen the entire time (such as a game that
2237 * wants to take over the screen), the
2238 * {@link android.view.WindowManager.LayoutParams#FLAG_FULLSCREEN window flag}
2239 * is usually a better approach. The state set here will be removed by the system
2240 * in various situations (such as the user moving to another application) like
2241 * the other system UI states.
2242 *
2243 * <p>When using this flag, the application should provide some easy facility
2244 * for the user to go out of it. A common example would be in an e-book
2245 * reader, where tapping on the screen brings back whatever screen and UI
2246 * decorations that had been hidden while the user was immersed in reading
2247 * the book.
2248 *
2249 * @see #setSystemUiVisibility(int)
2250 */
2251 public static final int SYSTEM_UI_FLAG_FULLSCREEN = 0x00000004;
2252
2253 /**
2254 * Flag for {@link #setSystemUiVisibility(int)}: When using other layout
2255 * flags, we would like a stable view of the content insets given to
2256 * {@link #fitSystemWindows(Rect)}. This means that the insets seen there
2257 * will always represent the worst case that the application can expect
Dianne Hackborn5b5cc4d2012-05-16 13:15:00 -07002258 * as a continuous state. In the stock Android UI this is the space for
2259 * the system bar, nav bar, and status bar, but not more transient elements
2260 * such as an input method.
2261 *
2262 * The stable layout your UI sees is based on the system UI modes you can
2263 * switch to. That is, if you specify {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}
2264 * then you will get a stable layout for changes of the
2265 * {@link #SYSTEM_UI_FLAG_FULLSCREEN} mode; if you specify
2266 * {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN} and
2267 * {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION}, then you can transition
2268 * to {@link #SYSTEM_UI_FLAG_FULLSCREEN} and {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}
2269 * with a stable layout. (Note that you should avoid using
2270 * {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} by itself.)
2271 *
2272 * If you have set the window flag {@ WindowManager.LayoutParams#FLAG_FULLSCREEN}
2273 * to hide the status bar (instead of using {@link #SYSTEM_UI_FLAG_FULLSCREEN}),
2274 * then a hidden status bar will be considered a "stable" state for purposes
2275 * here. This allows your UI to continually hide the status bar, while still
2276 * using the system UI flags to hide the action bar while still retaining
2277 * a stable layout. Note that changing the window fullscreen flag will never
2278 * provide a stable layout for a clean transition.
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002279 *
2280 * <p>If you are using ActionBar in
2281 * overlay mode with {@link Window#FEATURE_ACTION_BAR_OVERLAY
2282 * Window.FEATURE_ACTION_BAR_OVERLAY}, this flag will also impact the
2283 * insets it adds to those given to the application.
2284 */
2285 public static final int SYSTEM_UI_FLAG_LAYOUT_STABLE = 0x00000100;
2286
2287 /**
2288 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window
2289 * to be layed out as if it has requested
2290 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, even if it currently hasn't. This
2291 * allows it to avoid artifacts when switching in and out of that mode, at
2292 * the expense that some of its user interface may be covered by screen
2293 * decorations when they are shown. You can perform layout of your inner
2294 * UI elements to account for the navagation system UI through the
2295 * {@link #fitSystemWindows(Rect)} method.
2296 */
2297 public static final int SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION = 0x00000200;
2298
2299 /**
2300 * Flag for {@link #setSystemUiVisibility(int)}: View would like its window
2301 * to be layed out as if it has requested
2302 * {@link #SYSTEM_UI_FLAG_FULLSCREEN}, even if it currently hasn't. This
2303 * allows it to avoid artifacts when switching in and out of that mode, at
2304 * the expense that some of its user interface may be covered by screen
2305 * decorations when they are shown. You can perform layout of your inner
2306 * UI elements to account for non-fullscreen system UI through the
2307 * {@link #fitSystemWindows(Rect)} method.
2308 */
2309 public static final int SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN = 0x00000400;
2310
2311 /**
Daniel Sandler60ee2562011-07-22 12:34:33 -04002312 * @deprecated Use {@link #SYSTEM_UI_FLAG_LOW_PROFILE} instead.
2313 */
2314 public static final int STATUS_BAR_HIDDEN = SYSTEM_UI_FLAG_LOW_PROFILE;
2315
2316 /**
2317 * @deprecated Use {@link #SYSTEM_UI_FLAG_VISIBLE} instead.
2318 */
2319 public static final int STATUS_BAR_VISIBLE = SYSTEM_UI_FLAG_VISIBLE;
Joe Onorato664644d2011-01-23 17:53:23 -08002320
2321 /**
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002322 * @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 make the status bar not expandable. Unless you also
2328 * set {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS}, new notifications will continue to show.
2329 */
2330 public static final int STATUS_BAR_DISABLE_EXPAND = 0x00010000;
2331
2332 /**
2333 * @hide
2334 *
2335 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2336 * out of the public fields to keep the undefined bits out of the developer's way.
2337 *
2338 * Flag to hide notification icons and scrolling ticker text.
2339 */
2340 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ICONS = 0x00020000;
2341
2342 /**
2343 * @hide
2344 *
2345 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2346 * out of the public fields to keep the undefined bits out of the developer's way.
2347 *
2348 * Flag to disable incoming notification alerts. This will not block
2349 * icons, but it will block sound, vibrating and other visual or aural notifications.
2350 */
2351 public static final int STATUS_BAR_DISABLE_NOTIFICATION_ALERTS = 0x00040000;
2352
2353 /**
2354 * @hide
2355 *
2356 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2357 * out of the public fields to keep the undefined bits out of the developer's way.
2358 *
2359 * Flag to hide only the scrolling ticker. Note that
2360 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_ICONS} implies
2361 * {@link #STATUS_BAR_DISABLE_NOTIFICATION_TICKER}.
2362 */
2363 public static final int STATUS_BAR_DISABLE_NOTIFICATION_TICKER = 0x00080000;
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 *
2371 * Flag to hide the center system info area.
2372 */
2373 public static final int STATUS_BAR_DISABLE_SYSTEM_INFO = 0x00100000;
2374
2375 /**
2376 * @hide
2377 *
2378 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2379 * out of the public fields to keep the undefined bits out of the developer's way.
2380 *
Daniel Sandlerdba93562011-10-06 16:39:58 -04002381 * Flag to hide only the home button. Don't use this
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002382 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2383 */
Daniel Sandlerdba93562011-10-06 16:39:58 -04002384 public static final int STATUS_BAR_DISABLE_HOME = 0x00200000;
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002385
2386 /**
2387 * @hide
2388 *
2389 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2390 * out of the public fields to keep the undefined bits out of the developer's way.
2391 *
Daniel Sandlerdba93562011-10-06 16:39:58 -04002392 * Flag to hide only the back button. Don't use this
Joe Onorato6478adc2011-01-27 21:15:01 -08002393 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2394 */
2395 public static final int STATUS_BAR_DISABLE_BACK = 0x00400000;
2396
2397 /**
2398 * @hide
2399 *
2400 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2401 * out of the public fields to keep the undefined bits out of the developer's way.
2402 *
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002403 * Flag to hide only the clock. You might use this if your activity has
2404 * its own clock making the status bar's clock redundant.
2405 */
Joe Onorato6478adc2011-01-27 21:15:01 -08002406 public static final int STATUS_BAR_DISABLE_CLOCK = 0x00800000;
2407
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002408 /**
2409 * @hide
Daniel Sandlerdba93562011-10-06 16:39:58 -04002410 *
2411 * NOTE: This flag may only be used in subtreeSystemUiVisibility. It is masked
2412 * out of the public fields to keep the undefined bits out of the developer's way.
2413 *
2414 * Flag to hide only the recent apps button. Don't use this
2415 * unless you're a special part of the system UI (i.e., setup wizard, keyguard).
2416 */
2417 public static final int STATUS_BAR_DISABLE_RECENT = 0x01000000;
2418
2419 /**
2420 * @hide
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002421 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002422 public static final int PUBLIC_STATUS_BAR_VISIBILITY_MASK = 0x0000FFFF;
Joe Onorato7bb8eeb2011-01-27 16:00:58 -08002423
2424 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -07002425 * These are the system UI flags that can be cleared by events outside
2426 * of an application. Currently this is just the ability to tap on the
2427 * screen while hiding the navigation bar to have it return.
2428 * @hide
2429 */
2430 public static final int SYSTEM_UI_CLEARABLE_FLAGS =
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07002431 SYSTEM_UI_FLAG_LOW_PROFILE | SYSTEM_UI_FLAG_HIDE_NAVIGATION
2432 | SYSTEM_UI_FLAG_FULLSCREEN;
2433
2434 /**
2435 * Flags that can impact the layout in relation to system UI.
2436 */
2437 public static final int SYSTEM_UI_LAYOUT_FLAGS =
2438 SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION
2439 | SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN;
Dianne Hackborn9a230e02011-10-06 11:51:27 -07002440
2441 /**
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07002442 * Find views that render the specified text.
2443 *
2444 * @see #findViewsWithText(ArrayList, CharSequence, int)
2445 */
2446 public static final int FIND_VIEWS_WITH_TEXT = 0x00000001;
2447
2448 /**
2449 * Find find views that contain the specified content description.
2450 *
2451 * @see #findViewsWithText(ArrayList, CharSequence, int)
2452 */
2453 public static final int FIND_VIEWS_WITH_CONTENT_DESCRIPTION = 0x00000002;
2454
2455 /**
Svetoslav Ganov02107852011-10-03 17:06:56 -07002456 * Find views that contain {@link AccessibilityNodeProvider}. Such
2457 * a View is a root of virtual view hierarchy and may contain the searched
2458 * text. If this flag is set Views with providers are automatically
2459 * added and it is a responsibility of the client to call the APIs of
2460 * the provider to determine whether the virtual tree rooted at this View
2461 * contains the text, i.e. getting the list of {@link AccessibilityNodeInfo}s
2462 * represeting the virtual views with this text.
2463 *
2464 * @see #findViewsWithText(ArrayList, CharSequence, int)
2465 *
2466 * @hide
2467 */
2468 public static final int FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS = 0x00000004;
2469
2470 /**
Romain Guybb9908b2012-03-08 11:14:07 -08002471 * Indicates that the screen has changed state and is now off.
2472 *
2473 * @see #onScreenStateChanged(int)
2474 */
2475 public static final int SCREEN_STATE_OFF = 0x0;
2476
2477 /**
2478 * Indicates that the screen has changed state and is now on.
2479 *
Romain Guy1e3d3132012-03-08 15:55:56 -08002480 * @see #onScreenStateChanged(int)
Romain Guybb9908b2012-03-08 11:14:07 -08002481 */
2482 public static final int SCREEN_STATE_ON = 0x1;
2483
2484 /**
Adam Powell637d3372010-08-25 14:37:03 -07002485 * Controls the over-scroll mode for this view.
2486 * See {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)},
2487 * {@link #OVER_SCROLL_ALWAYS}, {@link #OVER_SCROLL_IF_CONTENT_SCROLLS},
2488 * and {@link #OVER_SCROLL_NEVER}.
2489 */
2490 private int mOverScrollMode;
2491
2492 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002493 * The parent this view is attached to.
2494 * {@hide}
2495 *
2496 * @see #getParent()
2497 */
2498 protected ViewParent mParent;
2499
2500 /**
2501 * {@hide}
2502 */
2503 AttachInfo mAttachInfo;
2504
2505 /**
2506 * {@hide}
2507 */
Romain Guy809a7f62009-05-14 15:44:42 -07002508 @ViewDebug.ExportedProperty(flagMapping = {
2509 @ViewDebug.FlagToString(mask = FORCE_LAYOUT, equals = FORCE_LAYOUT,
2510 name = "FORCE_LAYOUT"),
2511 @ViewDebug.FlagToString(mask = LAYOUT_REQUIRED, equals = LAYOUT_REQUIRED,
2512 name = "LAYOUT_REQUIRED"),
2513 @ViewDebug.FlagToString(mask = DRAWING_CACHE_VALID, equals = DRAWING_CACHE_VALID,
Romain Guy5bcdff42009-05-14 21:27:18 -07002514 name = "DRAWING_CACHE_INVALID", outputIf = false),
Romain Guy809a7f62009-05-14 15:44:42 -07002515 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "DRAWN", outputIf = true),
2516 @ViewDebug.FlagToString(mask = DRAWN, equals = DRAWN, name = "NOT_DRAWN", outputIf = false),
2517 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY_OPAQUE, name = "DIRTY_OPAQUE"),
2518 @ViewDebug.FlagToString(mask = DIRTY_MASK, equals = DIRTY, name = "DIRTY")
2519 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002520 int mPrivateFlags;
Christopher Tate3d4bf172011-03-28 16:16:46 -07002521 int mPrivateFlags2;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002522
2523 /**
Joe Onorato664644d2011-01-23 17:53:23 -08002524 * This view's request for the visibility of the status bar.
2525 * @hide
2526 */
Daniel Sandler60ee2562011-07-22 12:34:33 -04002527 @ViewDebug.ExportedProperty(flagMapping = {
2528 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_LOW_PROFILE,
2529 equals = SYSTEM_UI_FLAG_LOW_PROFILE,
2530 name = "SYSTEM_UI_FLAG_LOW_PROFILE", outputIf = true),
2531 @ViewDebug.FlagToString(mask = SYSTEM_UI_FLAG_HIDE_NAVIGATION,
2532 equals = SYSTEM_UI_FLAG_HIDE_NAVIGATION,
2533 name = "SYSTEM_UI_FLAG_HIDE_NAVIGATION", outputIf = true),
2534 @ViewDebug.FlagToString(mask = PUBLIC_STATUS_BAR_VISIBILITY_MASK,
2535 equals = SYSTEM_UI_FLAG_VISIBLE,
2536 name = "SYSTEM_UI_FLAG_VISIBLE", outputIf = true)
2537 })
Joe Onorato664644d2011-01-23 17:53:23 -08002538 int mSystemUiVisibility;
2539
2540 /**
Chet Haase563d4f22012-04-18 16:20:08 -07002541 * Reference count for transient state.
2542 * @see #setHasTransientState(boolean)
2543 */
2544 int mTransientStateCount = 0;
2545
2546 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002547 * Count of how many windows this view has been attached to.
2548 */
2549 int mWindowAttachCount;
2550
2551 /**
2552 * The layout parameters associated with this view and used by the parent
2553 * {@link android.view.ViewGroup} to determine how this view should be
2554 * laid out.
2555 * {@hide}
2556 */
2557 protected ViewGroup.LayoutParams mLayoutParams;
2558
2559 /**
2560 * The view flags hold various views states.
2561 * {@hide}
2562 */
2563 @ViewDebug.ExportedProperty
2564 int mViewFlags;
2565
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002566 static class TransformationInfo {
2567 /**
2568 * The transform matrix for the View. This transform is calculated internally
2569 * based on the rotation, scaleX, and scaleY properties. The identity matrix
2570 * is used by default. Do *not* use this variable directly; instead call
2571 * getMatrix(), which will automatically recalculate the matrix if necessary
2572 * to get the correct matrix based on the latest rotation and scale properties.
2573 */
2574 private final Matrix mMatrix = new Matrix();
Chet Haasec3aa3612010-06-17 08:50:37 -07002575
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002576 /**
2577 * The transform matrix for the View. This transform is calculated internally
2578 * based on the rotation, scaleX, and scaleY properties. The identity matrix
2579 * is used by default. Do *not* use this variable directly; instead call
2580 * getInverseMatrix(), which will automatically recalculate the matrix if necessary
2581 * to get the correct matrix based on the latest rotation and scale properties.
2582 */
2583 private Matrix mInverseMatrix;
Chet Haasec3aa3612010-06-17 08:50:37 -07002584
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002585 /**
2586 * An internal variable that tracks whether we need to recalculate the
2587 * transform matrix, based on whether the rotation or scaleX/Y properties
2588 * have changed since the matrix was last calculated.
2589 */
2590 boolean mMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07002591
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002592 /**
2593 * An internal variable that tracks whether we need to recalculate the
2594 * transform matrix, based on whether the rotation or scaleX/Y properties
2595 * have changed since the matrix was last calculated.
2596 */
2597 private boolean mInverseMatrixDirty = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07002598
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002599 /**
2600 * A variable that tracks whether we need to recalculate the
2601 * transform matrix, based on whether the rotation or scaleX/Y properties
2602 * have changed since the matrix was last calculated. This variable
2603 * is only valid after a call to updateMatrix() or to a function that
2604 * calls it such as getMatrix(), hasIdentityMatrix() and getInverseMatrix().
2605 */
2606 private boolean mMatrixIsIdentity = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07002607
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002608 /**
2609 * The Camera object is used to compute a 3D matrix when rotationX or rotationY are set.
2610 */
2611 private Camera mCamera = null;
Chet Haasefd2b0022010-08-06 13:08:56 -07002612
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002613 /**
2614 * This matrix is used when computing the matrix for 3D rotations.
2615 */
2616 private Matrix matrix3D = null;
Chet Haasefd2b0022010-08-06 13:08:56 -07002617
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002618 /**
2619 * These prev values are used to recalculate a centered pivot point when necessary. The
2620 * pivot point is only used in matrix operations (when rotation, scale, or translation are
2621 * set), so thes values are only used then as well.
2622 */
2623 private int mPrevWidth = -1;
2624 private int mPrevHeight = -1;
Philip Milne6c8ea062012-04-03 17:38:43 -07002625
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002626 /**
2627 * The degrees rotation around the vertical axis through the pivot point.
2628 */
2629 @ViewDebug.ExportedProperty
2630 float mRotationY = 0f;
2631
2632 /**
2633 * The degrees rotation around the horizontal axis through the pivot point.
2634 */
2635 @ViewDebug.ExportedProperty
2636 float mRotationX = 0f;
2637
2638 /**
2639 * The degrees rotation around the pivot point.
2640 */
2641 @ViewDebug.ExportedProperty
2642 float mRotation = 0f;
2643
2644 /**
2645 * The amount of translation of the object away from its left property (post-layout).
2646 */
2647 @ViewDebug.ExportedProperty
2648 float mTranslationX = 0f;
2649
2650 /**
2651 * The amount of translation of the object away from its top property (post-layout).
2652 */
2653 @ViewDebug.ExportedProperty
2654 float mTranslationY = 0f;
2655
2656 /**
2657 * The amount of scale in the x direction around the pivot point. A
2658 * value of 1 means no scaling is applied.
2659 */
2660 @ViewDebug.ExportedProperty
2661 float mScaleX = 1f;
2662
2663 /**
2664 * The amount of scale in the y direction around the pivot point. A
2665 * value of 1 means no scaling is applied.
2666 */
2667 @ViewDebug.ExportedProperty
2668 float mScaleY = 1f;
2669
2670 /**
Chet Haasea33de552012-02-03 16:28:24 -08002671 * The x location of the point around which the view is rotated and scaled.
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002672 */
2673 @ViewDebug.ExportedProperty
2674 float mPivotX = 0f;
2675
2676 /**
Chet Haasea33de552012-02-03 16:28:24 -08002677 * The y location of the point around which the view is rotated and scaled.
Dianne Hackbornddb715b2011-09-09 14:43:39 -07002678 */
2679 @ViewDebug.ExportedProperty
2680 float mPivotY = 0f;
2681
2682 /**
2683 * The opacity of the View. This is a value from 0 to 1, where 0 means
2684 * completely transparent and 1 means completely opaque.
2685 */
2686 @ViewDebug.ExportedProperty
2687 float mAlpha = 1f;
2688 }
2689
2690 TransformationInfo mTransformationInfo;
Chet Haasefd2b0022010-08-06 13:08:56 -07002691
Joe Malin32736f02011-01-19 16:14:20 -08002692 private boolean mLastIsOpaque;
2693
Chet Haasefd2b0022010-08-06 13:08:56 -07002694 /**
2695 * Convenience value to check for float values that are close enough to zero to be considered
2696 * zero.
2697 */
Romain Guy2542d192010-08-18 11:47:12 -07002698 private static final float NONZERO_EPSILON = .001f;
Chet Haasefd2b0022010-08-06 13:08:56 -07002699
2700 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002701 * The distance in pixels from the left edge of this view's parent
2702 * to the left edge of this view.
2703 * {@hide}
2704 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002705 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002706 protected int mLeft;
2707 /**
2708 * The distance in pixels from the left edge of this view's parent
2709 * to the right edge of this view.
2710 * {@hide}
2711 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002712 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002713 protected int mRight;
2714 /**
2715 * The distance in pixels from the top edge of this view's parent
2716 * to the top edge of this view.
2717 * {@hide}
2718 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002719 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002720 protected int mTop;
2721 /**
2722 * The distance in pixels from the top edge of this view's parent
2723 * to the bottom edge of this view.
2724 * {@hide}
2725 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002726 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002727 protected int mBottom;
2728
2729 /**
2730 * The offset, in pixels, by which the content of this view is scrolled
2731 * horizontally.
2732 * {@hide}
2733 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002734 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002735 protected int mScrollX;
2736 /**
2737 * The offset, in pixels, by which the content of this view is scrolled
2738 * vertically.
2739 * {@hide}
2740 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002741 @ViewDebug.ExportedProperty(category = "scrolling")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002742 protected int mScrollY;
2743
2744 /**
2745 * The left padding in pixels, that is the distance in pixels between the
2746 * left edge of this view and the left edge of its content.
2747 * {@hide}
2748 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002749 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002750 protected int mPaddingLeft;
2751 /**
2752 * The right padding in pixels, that is the distance in pixels between the
2753 * right edge of this view and the right edge of its content.
2754 * {@hide}
2755 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002756 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002757 protected int mPaddingRight;
2758 /**
2759 * The top padding in pixels, that is the distance in pixels between the
2760 * top edge of this view and the top edge of its content.
2761 * {@hide}
2762 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002763 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002764 protected int mPaddingTop;
2765 /**
2766 * The bottom padding in pixels, that is the distance in pixels between the
2767 * bottom edge of this view and the bottom edge of its content.
2768 * {@hide}
2769 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002770 @ViewDebug.ExportedProperty(category = "padding")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002771 protected int mPaddingBottom;
2772
2773 /**
Philip Milne1557fd72012-04-04 23:41:34 -07002774 * The layout insets in pixels, that is the distance in pixels between the
2775 * visible edges of this view its bounds.
2776 */
2777 private Insets mLayoutInsets;
2778
2779 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07002780 * Briefly describes the view and is primarily used for accessibility support.
2781 */
2782 private CharSequence mContentDescription;
2783
2784 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002785 * Cache the paddingRight set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002786 *
2787 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002788 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002789 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002790 protected int mUserPaddingRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002791
2792 /**
2793 * Cache the paddingBottom set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002794 *
2795 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002796 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002797 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002798 protected int mUserPaddingBottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002799
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002800 /**
Adam Powell20232d02010-12-08 21:08:53 -08002801 * Cache the paddingLeft set by the user to append to the scrollbar's size.
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002802 *
2803 * @hide
Adam Powell20232d02010-12-08 21:08:53 -08002804 */
2805 @ViewDebug.ExportedProperty(category = "padding")
Fabrice Di Meglio54d69622011-07-15 16:46:44 -07002806 protected int mUserPaddingLeft;
Adam Powell20232d02010-12-08 21:08:53 -08002807
2808 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07002809 * Cache if the user padding is relative.
2810 *
2811 */
2812 @ViewDebug.ExportedProperty(category = "padding")
2813 boolean mUserPaddingRelative;
2814
2815 /**
2816 * Cache the paddingStart set by the user to append to the scrollbar's size.
2817 *
2818 */
2819 @ViewDebug.ExportedProperty(category = "padding")
2820 int mUserPaddingStart;
2821
2822 /**
2823 * Cache the paddingEnd set by the user to append to the scrollbar's size.
2824 *
2825 */
2826 @ViewDebug.ExportedProperty(category = "padding")
2827 int mUserPaddingEnd;
2828
2829 /**
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07002830 * @hide
2831 */
2832 int mOldWidthMeasureSpec = Integer.MIN_VALUE;
2833 /**
2834 * @hide
2835 */
2836 int mOldHeightMeasureSpec = Integer.MIN_VALUE;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002837
Philip Milne6c8ea062012-04-03 17:38:43 -07002838 private Drawable mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002839
2840 private int mBackgroundResource;
2841 private boolean mBackgroundSizeChanged;
2842
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002843 static class ListenerInfo {
2844 /**
2845 * Listener used to dispatch focus change events.
2846 * This field should be made private, so it is hidden from the SDK.
2847 * {@hide}
2848 */
2849 protected OnFocusChangeListener mOnFocusChangeListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002850
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002851 /**
2852 * Listeners for layout change events.
2853 */
2854 private ArrayList<OnLayoutChangeListener> mOnLayoutChangeListeners;
Chet Haase21cd1382010-09-01 17:42:29 -07002855
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002856 /**
2857 * Listeners for attach events.
2858 */
2859 private CopyOnWriteArrayList<OnAttachStateChangeListener> mOnAttachStateChangeListeners;
Adam Powell4afd62b2011-02-18 15:02:18 -08002860
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002861 /**
2862 * Listener used to dispatch click events.
2863 * This field should be made private, so it is hidden from the SDK.
2864 * {@hide}
2865 */
2866 public OnClickListener mOnClickListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002867
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002868 /**
2869 * Listener used to dispatch long click events.
2870 * This field should be made private, so it is hidden from the SDK.
2871 * {@hide}
2872 */
2873 protected OnLongClickListener mOnLongClickListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002874
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002875 /**
2876 * Listener used to build the context menu.
2877 * This field should be made private, so it is hidden from the SDK.
2878 * {@hide}
2879 */
2880 protected OnCreateContextMenuListener mOnCreateContextMenuListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002881
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002882 private OnKeyListener mOnKeyListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002883
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002884 private OnTouchListener mOnTouchListener;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002885
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002886 private OnHoverListener mOnHoverListener;
Jeff Brown10b62902011-06-20 16:40:37 -07002887
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002888 private OnGenericMotionListener mOnGenericMotionListener;
Jeff Brown33bbfd22011-02-24 20:55:35 -08002889
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002890 private OnDragListener mOnDragListener;
Chris Tate32affef2010-10-18 15:29:21 -07002891
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07002892 private OnSystemUiVisibilityChangeListener mOnSystemUiVisibilityChangeListener;
2893 }
2894
2895 ListenerInfo mListenerInfo;
Joe Onorato664644d2011-01-23 17:53:23 -08002896
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002897 /**
2898 * The application environment this view lives in.
2899 * This field should be made private, so it is hidden from the SDK.
2900 * {@hide}
2901 */
2902 protected Context mContext;
2903
Dianne Hackbornab0f4852011-09-12 16:59:06 -07002904 private final Resources mResources;
2905
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002906 private ScrollabilityCache mScrollCache;
2907
2908 private int[] mDrawableState = null;
2909
Romain Guy0211a0a2011-02-14 16:34:59 -08002910 /**
2911 * Set to true when drawing cache is enabled and cannot be created.
Philip Milne6c8ea062012-04-03 17:38:43 -07002912 *
Romain Guy0211a0a2011-02-14 16:34:59 -08002913 * @hide
2914 */
2915 public boolean mCachingFailed;
2916
Romain Guy02890fd2010-08-06 17:58:44 -07002917 private Bitmap mDrawingCache;
2918 private Bitmap mUnscaledDrawingCache;
Romain Guy6c319ca2011-01-11 14:29:25 -08002919 private HardwareLayer mHardwareLayer;
Romain Guy65b345f2011-07-27 18:51:50 -07002920 DisplayList mDisplayList;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002921
2922 /**
2923 * When this view has focus and the next focus is {@link #FOCUS_LEFT},
2924 * the user may specify which view to go to next.
2925 */
2926 private int mNextFocusLeftId = View.NO_ID;
2927
2928 /**
2929 * When this view has focus and the next focus is {@link #FOCUS_RIGHT},
2930 * the user may specify which view to go to next.
2931 */
2932 private int mNextFocusRightId = View.NO_ID;
2933
2934 /**
2935 * When this view has focus and the next focus is {@link #FOCUS_UP},
2936 * the user may specify which view to go to next.
2937 */
2938 private int mNextFocusUpId = View.NO_ID;
2939
2940 /**
2941 * When this view has focus and the next focus is {@link #FOCUS_DOWN},
2942 * the user may specify which view to go to next.
2943 */
2944 private int mNextFocusDownId = View.NO_ID;
2945
Jeff Brown4e6319b2010-12-13 10:36:51 -08002946 /**
2947 * When this view has focus and the next focus is {@link #FOCUS_FORWARD},
2948 * the user may specify which view to go to next.
2949 */
2950 int mNextFocusForwardId = View.NO_ID;
2951
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002952 private CheckForLongPress mPendingCheckForLongPress;
Adam Powelle14579b2009-12-16 18:39:52 -08002953 private CheckForTap mPendingCheckForTap = null;
Adam Powella35d7682010-03-12 14:48:13 -08002954 private PerformClick mPerformClick;
Svetoslav Ganova0156172011-06-26 17:55:44 -07002955 private SendViewScrolledAccessibilityEvent mSendViewScrolledAccessibilityEvent;
Joe Malin32736f02011-01-19 16:14:20 -08002956
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002957 private UnsetPressedState mUnsetPressedState;
2958
2959 /**
2960 * Whether the long press's action has been invoked. The tap's action is invoked on the
2961 * up event while a long press is invoked as soon as the long press duration is reached, so
2962 * a long press could be performed before the tap is checked, in which case the tap's action
2963 * should not be invoked.
2964 */
2965 private boolean mHasPerformedLongPress;
2966
2967 /**
2968 * The minimum height of the view. We'll try our best to have the height
2969 * of this view to at least this amount.
2970 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002971 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002972 private int mMinHeight;
2973
2974 /**
2975 * The minimum width of the view. We'll try our best to have the width
2976 * of this view to at least this amount.
2977 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07002978 @ViewDebug.ExportedProperty(category = "measurement")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002979 private int mMinWidth;
2980
2981 /**
2982 * The delegate to handle touch events that are physically in this view
2983 * but should be handled by another view.
2984 */
2985 private TouchDelegate mTouchDelegate = null;
2986
2987 /**
2988 * Solid color to use as a background when creating the drawing cache. Enables
2989 * the cache to use 16 bit bitmaps instead of 32 bit.
2990 */
2991 private int mDrawingCacheBackgroundColor = 0;
2992
2993 /**
2994 * Special tree observer used when mAttachInfo is null.
2995 */
2996 private ViewTreeObserver mFloatingTreeObserver;
Joe Malin32736f02011-01-19 16:14:20 -08002997
Adam Powelle14579b2009-12-16 18:39:52 -08002998 /**
2999 * Cache the touch slop from the context that created the view.
3000 */
3001 private int mTouchSlop;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003002
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003003 /**
Chet Haasea00f3862011-02-22 06:34:40 -08003004 * Object that handles automatic animation of view properties.
3005 */
3006 private ViewPropertyAnimator mAnimator = null;
3007
3008 /**
Christopher Tate251602f2011-01-28 17:54:12 -08003009 * Flag indicating that a drag can cross window boundaries. When
3010 * {@link #startDrag(ClipData, DragShadowBuilder, Object, int)} is called
3011 * with this flag set, all visible applications will be able to participate
3012 * in the drag operation and receive the dragged content.
Christopher Tate7f9ff9d2011-02-14 17:31:13 -08003013 *
3014 * @hide
Christopher Tate02d2b3b2011-01-10 20:43:53 -08003015 */
3016 public static final int DRAG_FLAG_GLOBAL = 1;
3017
3018 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08003019 * Vertical scroll factor cached by {@link #getVerticalScrollFactor}.
3020 */
3021 private float mVerticalScrollFactor;
3022
3023 /**
Adam Powell20232d02010-12-08 21:08:53 -08003024 * Position of the vertical scroll bar.
3025 */
3026 private int mVerticalScrollbarPosition;
3027
3028 /**
3029 * Position the scroll bar at the default position as determined by the system.
3030 */
3031 public static final int SCROLLBAR_POSITION_DEFAULT = 0;
3032
3033 /**
3034 * Position the scroll bar along the left edge.
3035 */
3036 public static final int SCROLLBAR_POSITION_LEFT = 1;
3037
3038 /**
3039 * Position the scroll bar along the right edge.
3040 */
3041 public static final int SCROLLBAR_POSITION_RIGHT = 2;
3042
3043 /**
Romain Guy171c5922011-01-06 10:04:23 -08003044 * Indicates that the view does not have a layer.
Joe Malin32736f02011-01-19 16:14:20 -08003045 *
3046 * @see #getLayerType()
3047 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08003048 * @see #LAYER_TYPE_SOFTWARE
Joe Malin32736f02011-01-19 16:14:20 -08003049 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08003050 */
3051 public static final int LAYER_TYPE_NONE = 0;
3052
3053 /**
3054 * <p>Indicates that the view has a software layer. A software layer is backed
3055 * by a bitmap and causes the view to be rendered using Android's software
3056 * rendering pipeline, even if hardware acceleration is enabled.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003057 *
Romain Guy171c5922011-01-06 10:04:23 -08003058 * <p>Software layers have various usages:</p>
3059 * <p>When the application is not using hardware acceleration, a software layer
3060 * is useful to apply a specific color filter and/or blending mode and/or
3061 * translucency to a view and all its children.</p>
3062 * <p>When the application is using hardware acceleration, a software layer
3063 * is useful to render drawing primitives not supported by the hardware
3064 * accelerated pipeline. It can also be used to cache a complex view tree
3065 * into a texture and reduce the complexity of drawing operations. For instance,
3066 * when animating a complex view tree with a translation, a software layer can
3067 * be used to render the view tree only once.</p>
3068 * <p>Software layers should be avoided when the affected view tree updates
3069 * often. Every update will require to re-render the software layer, which can
3070 * potentially be slow (particularly when hardware acceleration is turned on
3071 * since the layer will have to be uploaded into a hardware texture after every
3072 * update.)</p>
Joe Malin32736f02011-01-19 16:14:20 -08003073 *
3074 * @see #getLayerType()
3075 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy171c5922011-01-06 10:04:23 -08003076 * @see #LAYER_TYPE_NONE
Joe Malin32736f02011-01-19 16:14:20 -08003077 * @see #LAYER_TYPE_HARDWARE
Romain Guy171c5922011-01-06 10:04:23 -08003078 */
3079 public static final int LAYER_TYPE_SOFTWARE = 1;
3080
3081 /**
3082 * <p>Indicates that the view has a hardware layer. A hardware layer is backed
3083 * by a hardware specific texture (generally Frame Buffer Objects or FBO on
3084 * OpenGL hardware) and causes the view to be rendered using Android's hardware
3085 * rendering pipeline, but only if hardware acceleration is turned on for the
3086 * view hierarchy. When hardware acceleration is turned off, hardware layers
3087 * behave exactly as {@link #LAYER_TYPE_SOFTWARE software layers}.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003088 *
Romain Guy171c5922011-01-06 10:04:23 -08003089 * <p>A hardware layer is useful to apply a specific color filter and/or
3090 * blending mode and/or translucency to a view and all its children.</p>
Romain Guy6c319ca2011-01-11 14:29:25 -08003091 * <p>A hardware layer can be used to cache a complex view tree into a
3092 * texture and reduce the complexity of drawing operations. For instance,
3093 * when animating a complex view tree with a translation, a hardware layer can
3094 * be used to render the view tree only once.</p>
Romain Guy171c5922011-01-06 10:04:23 -08003095 * <p>A hardware layer can also be used to increase the rendering quality when
3096 * rotation transformations are applied on a view. It can also be used to
3097 * prevent potential clipping issues when applying 3D transforms on a view.</p>
Joe Malin32736f02011-01-19 16:14:20 -08003098 *
3099 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -08003100 * @see #setLayerType(int, android.graphics.Paint)
3101 * @see #LAYER_TYPE_NONE
3102 * @see #LAYER_TYPE_SOFTWARE
3103 */
3104 public static final int LAYER_TYPE_HARDWARE = 2;
Joe Malin32736f02011-01-19 16:14:20 -08003105
Romain Guy3aaff3a2011-01-12 14:18:47 -08003106 @ViewDebug.ExportedProperty(category = "drawing", mapping = {
3107 @ViewDebug.IntToString(from = LAYER_TYPE_NONE, to = "NONE"),
3108 @ViewDebug.IntToString(from = LAYER_TYPE_SOFTWARE, to = "SOFTWARE"),
3109 @ViewDebug.IntToString(from = LAYER_TYPE_HARDWARE, to = "HARDWARE")
3110 })
Romain Guy171c5922011-01-06 10:04:23 -08003111 int mLayerType = LAYER_TYPE_NONE;
3112 Paint mLayerPaint;
Romain Guy3a3133d2011-02-01 22:59:58 -08003113 Rect mLocalDirtyRect;
Romain Guy171c5922011-01-06 10:04:23 -08003114
3115 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07003116 * Set to true when the view is sending hover accessibility events because it
3117 * is the innermost hovered view.
3118 */
3119 private boolean mSendingHoverAccessibilityEvents;
3120
3121 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003122 * Simple constructor to use when creating a view from code.
3123 *
3124 * @param context The Context the view is running in, through which it can
3125 * access the current theme, resources, etc.
3126 */
3127 public View(Context context) {
3128 mContext = context;
3129 mResources = context != null ? context.getResources() : null;
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003130 mViewFlags = SOUND_EFFECTS_ENABLED | HAPTIC_FEEDBACK_ENABLED;
Fabrice Di Megliob934db72012-03-20 14:33:01 -07003131 // Set layout and text direction defaults
3132 mPrivateFlags2 = (LAYOUT_DIRECTION_DEFAULT << LAYOUT_DIRECTION_MASK_SHIFT) |
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07003133 (TEXT_DIRECTION_DEFAULT << TEXT_DIRECTION_MASK_SHIFT) |
Svetoslav Ganov42138042012-03-20 11:51:39 -07003134 (TEXT_ALIGNMENT_DEFAULT << TEXT_ALIGNMENT_MASK_SHIFT) |
3135 (IMPORTANT_FOR_ACCESSIBILITY_DEFAULT << IMPORTANT_FOR_ACCESSIBILITY_SHIFT);
Adam Powelle14579b2009-12-16 18:39:52 -08003136 mTouchSlop = ViewConfiguration.get(context).getScaledTouchSlop();
Adam Powell637d3372010-08-25 14:37:03 -07003137 setOverScrollMode(OVER_SCROLL_IF_CONTENT_SCROLLS);
Fabrice Di Megliof9e36502011-06-21 18:41:48 -07003138 mUserPaddingStart = -1;
3139 mUserPaddingEnd = -1;
3140 mUserPaddingRelative = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003141 }
3142
3143 /**
Chet Haasedb8c9a62012-03-21 18:54:18 -07003144 * Delegate for injecting accessiblity functionality.
3145 */
3146 AccessibilityDelegate mAccessibilityDelegate;
3147
3148 /**
3149 * Consistency verifier for debugging purposes.
3150 * @hide
3151 */
3152 protected final InputEventConsistencyVerifier mInputEventConsistencyVerifier =
3153 InputEventConsistencyVerifier.isInstrumentationEnabled() ?
3154 new InputEventConsistencyVerifier(this, 0) : null;
3155
3156 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003157 * Constructor that is called when inflating a view from XML. This is called
3158 * when a view is being constructed from an XML file, supplying attributes
3159 * that were specified in the XML file. This version uses a default style of
3160 * 0, so the only attribute values applied are those in the Context's Theme
3161 * and the given AttributeSet.
3162 *
3163 * <p>
3164 * The method onFinishInflate() will be called after all children have been
3165 * added.
3166 *
3167 * @param context The Context the view is running in, through which it can
3168 * access the current theme, resources, etc.
3169 * @param attrs The attributes of the XML tag that is inflating the view.
3170 * @see #View(Context, AttributeSet, int)
3171 */
3172 public View(Context context, AttributeSet attrs) {
3173 this(context, attrs, 0);
3174 }
3175
3176 /**
3177 * Perform inflation from XML and apply a class-specific base style. This
3178 * constructor of View allows subclasses to use their own base style when
3179 * they are inflating. For example, a Button class's constructor would call
3180 * this version of the super class constructor and supply
3181 * <code>R.attr.buttonStyle</code> for <var>defStyle</var>; this allows
3182 * the theme's button style to modify all of the base view attributes (in
3183 * particular its background) as well as the Button class's attributes.
3184 *
3185 * @param context The Context the view is running in, through which it can
3186 * access the current theme, resources, etc.
3187 * @param attrs The attributes of the XML tag that is inflating the view.
3188 * @param defStyle The default style to apply to this view. If 0, no style
3189 * will be applied (beyond what is included in the theme). This may
3190 * either be an attribute resource, whose value will be retrieved
3191 * from the current theme, or an explicit style resource.
3192 * @see #View(Context, AttributeSet)
3193 */
3194 public View(Context context, AttributeSet attrs, int defStyle) {
3195 this(context);
3196
3197 TypedArray a = context.obtainStyledAttributes(attrs, com.android.internal.R.styleable.View,
3198 defStyle, 0);
3199
3200 Drawable background = null;
3201
3202 int leftPadding = -1;
3203 int topPadding = -1;
3204 int rightPadding = -1;
3205 int bottomPadding = -1;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003206 int startPadding = -1;
3207 int endPadding = -1;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003208
3209 int padding = -1;
3210
3211 int viewFlagValues = 0;
3212 int viewFlagMasks = 0;
3213
3214 boolean setScrollContainer = false;
Romain Guy8506ab42009-06-11 17:35:47 -07003215
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003216 int x = 0;
3217 int y = 0;
3218
Chet Haase73066682010-11-29 15:55:32 -08003219 float tx = 0;
3220 float ty = 0;
3221 float rotation = 0;
3222 float rotationX = 0;
3223 float rotationY = 0;
3224 float sx = 1f;
3225 float sy = 1f;
3226 boolean transformSet = false;
3227
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003228 int scrollbarStyle = SCROLLBARS_INSIDE_OVERLAY;
3229
Adam Powell637d3372010-08-25 14:37:03 -07003230 int overScrollMode = mOverScrollMode;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003231 final int N = a.getIndexCount();
3232 for (int i = 0; i < N; i++) {
3233 int attr = a.getIndex(i);
3234 switch (attr) {
3235 case com.android.internal.R.styleable.View_background:
3236 background = a.getDrawable(attr);
3237 break;
3238 case com.android.internal.R.styleable.View_padding:
3239 padding = a.getDimensionPixelSize(attr, -1);
3240 break;
3241 case com.android.internal.R.styleable.View_paddingLeft:
3242 leftPadding = a.getDimensionPixelSize(attr, -1);
3243 break;
3244 case com.android.internal.R.styleable.View_paddingTop:
3245 topPadding = a.getDimensionPixelSize(attr, -1);
3246 break;
3247 case com.android.internal.R.styleable.View_paddingRight:
3248 rightPadding = a.getDimensionPixelSize(attr, -1);
3249 break;
3250 case com.android.internal.R.styleable.View_paddingBottom:
3251 bottomPadding = a.getDimensionPixelSize(attr, -1);
3252 break;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003253 case com.android.internal.R.styleable.View_paddingStart:
3254 startPadding = a.getDimensionPixelSize(attr, -1);
3255 break;
3256 case com.android.internal.R.styleable.View_paddingEnd:
3257 endPadding = a.getDimensionPixelSize(attr, -1);
3258 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003259 case com.android.internal.R.styleable.View_scrollX:
3260 x = a.getDimensionPixelOffset(attr, 0);
3261 break;
3262 case com.android.internal.R.styleable.View_scrollY:
3263 y = a.getDimensionPixelOffset(attr, 0);
3264 break;
Chet Haase73066682010-11-29 15:55:32 -08003265 case com.android.internal.R.styleable.View_alpha:
3266 setAlpha(a.getFloat(attr, 1f));
3267 break;
3268 case com.android.internal.R.styleable.View_transformPivotX:
3269 setPivotX(a.getDimensionPixelOffset(attr, 0));
3270 break;
3271 case com.android.internal.R.styleable.View_transformPivotY:
3272 setPivotY(a.getDimensionPixelOffset(attr, 0));
3273 break;
3274 case com.android.internal.R.styleable.View_translationX:
3275 tx = a.getDimensionPixelOffset(attr, 0);
3276 transformSet = true;
3277 break;
3278 case com.android.internal.R.styleable.View_translationY:
3279 ty = a.getDimensionPixelOffset(attr, 0);
3280 transformSet = true;
3281 break;
3282 case com.android.internal.R.styleable.View_rotation:
3283 rotation = a.getFloat(attr, 0);
3284 transformSet = true;
3285 break;
3286 case com.android.internal.R.styleable.View_rotationX:
3287 rotationX = a.getFloat(attr, 0);
3288 transformSet = true;
3289 break;
3290 case com.android.internal.R.styleable.View_rotationY:
3291 rotationY = a.getFloat(attr, 0);
3292 transformSet = true;
3293 break;
3294 case com.android.internal.R.styleable.View_scaleX:
3295 sx = a.getFloat(attr, 1f);
3296 transformSet = true;
3297 break;
3298 case com.android.internal.R.styleable.View_scaleY:
3299 sy = a.getFloat(attr, 1f);
3300 transformSet = true;
3301 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003302 case com.android.internal.R.styleable.View_id:
3303 mID = a.getResourceId(attr, NO_ID);
3304 break;
3305 case com.android.internal.R.styleable.View_tag:
3306 mTag = a.getText(attr);
3307 break;
3308 case com.android.internal.R.styleable.View_fitsSystemWindows:
3309 if (a.getBoolean(attr, false)) {
3310 viewFlagValues |= FITS_SYSTEM_WINDOWS;
3311 viewFlagMasks |= FITS_SYSTEM_WINDOWS;
3312 }
3313 break;
3314 case com.android.internal.R.styleable.View_focusable:
3315 if (a.getBoolean(attr, false)) {
3316 viewFlagValues |= FOCUSABLE;
3317 viewFlagMasks |= FOCUSABLE_MASK;
3318 }
3319 break;
3320 case com.android.internal.R.styleable.View_focusableInTouchMode:
3321 if (a.getBoolean(attr, false)) {
3322 viewFlagValues |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE;
3323 viewFlagMasks |= FOCUSABLE_IN_TOUCH_MODE | FOCUSABLE_MASK;
3324 }
3325 break;
3326 case com.android.internal.R.styleable.View_clickable:
3327 if (a.getBoolean(attr, false)) {
3328 viewFlagValues |= CLICKABLE;
3329 viewFlagMasks |= CLICKABLE;
3330 }
3331 break;
3332 case com.android.internal.R.styleable.View_longClickable:
3333 if (a.getBoolean(attr, false)) {
3334 viewFlagValues |= LONG_CLICKABLE;
3335 viewFlagMasks |= LONG_CLICKABLE;
3336 }
3337 break;
3338 case com.android.internal.R.styleable.View_saveEnabled:
3339 if (!a.getBoolean(attr, true)) {
3340 viewFlagValues |= SAVE_DISABLED;
3341 viewFlagMasks |= SAVE_DISABLED_MASK;
3342 }
3343 break;
3344 case com.android.internal.R.styleable.View_duplicateParentState:
3345 if (a.getBoolean(attr, false)) {
3346 viewFlagValues |= DUPLICATE_PARENT_STATE;
3347 viewFlagMasks |= DUPLICATE_PARENT_STATE;
3348 }
3349 break;
3350 case com.android.internal.R.styleable.View_visibility:
3351 final int visibility = a.getInt(attr, 0);
3352 if (visibility != 0) {
3353 viewFlagValues |= VISIBILITY_FLAGS[visibility];
3354 viewFlagMasks |= VISIBILITY_MASK;
3355 }
3356 break;
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07003357 case com.android.internal.R.styleable.View_layoutDirection:
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003358 // Clear any layout direction flags (included resolved bits) already set
3359 mPrivateFlags2 &= ~(LAYOUT_DIRECTION_MASK | LAYOUT_DIRECTION_RESOLVED_MASK);
3360 // Set the layout direction flags depending on the value of the attribute
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07003361 final int layoutDirection = a.getInt(attr, -1);
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07003362 final int value = (layoutDirection != -1) ?
3363 LAYOUT_DIRECTION_FLAGS[layoutDirection] : LAYOUT_DIRECTION_DEFAULT;
3364 mPrivateFlags2 |= (value << LAYOUT_DIRECTION_MASK_SHIFT);
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -07003365 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003366 case com.android.internal.R.styleable.View_drawingCacheQuality:
3367 final int cacheQuality = a.getInt(attr, 0);
3368 if (cacheQuality != 0) {
3369 viewFlagValues |= DRAWING_CACHE_QUALITY_FLAGS[cacheQuality];
3370 viewFlagMasks |= DRAWING_CACHE_QUALITY_MASK;
3371 }
3372 break;
svetoslavganov75986cf2009-05-14 22:28:01 -07003373 case com.android.internal.R.styleable.View_contentDescription:
3374 mContentDescription = a.getString(attr);
3375 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003376 case com.android.internal.R.styleable.View_soundEffectsEnabled:
3377 if (!a.getBoolean(attr, true)) {
3378 viewFlagValues &= ~SOUND_EFFECTS_ENABLED;
3379 viewFlagMasks |= SOUND_EFFECTS_ENABLED;
3380 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07003381 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003382 case com.android.internal.R.styleable.View_hapticFeedbackEnabled:
3383 if (!a.getBoolean(attr, true)) {
3384 viewFlagValues &= ~HAPTIC_FEEDBACK_ENABLED;
3385 viewFlagMasks |= HAPTIC_FEEDBACK_ENABLED;
3386 }
Karl Rosaen61ab2702009-06-23 11:10:25 -07003387 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003388 case R.styleable.View_scrollbars:
3389 final int scrollbars = a.getInt(attr, SCROLLBARS_NONE);
3390 if (scrollbars != SCROLLBARS_NONE) {
3391 viewFlagValues |= scrollbars;
3392 viewFlagMasks |= SCROLLBARS_MASK;
3393 initializeScrollbars(a);
3394 }
3395 break;
Romain Guy2a9fa892011-09-28 16:50:02 -07003396 //noinspection deprecation
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003397 case R.styleable.View_fadingEdge:
Romain Guy1ef3fdb2011-09-09 15:30:30 -07003398 if (context.getApplicationInfo().targetSdkVersion >= ICE_CREAM_SANDWICH) {
3399 // Ignore the attribute starting with ICS
3400 break;
3401 }
3402 // With builds < ICS, fall through and apply fading edges
3403 case R.styleable.View_requiresFadingEdge:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003404 final int fadingEdge = a.getInt(attr, FADING_EDGE_NONE);
3405 if (fadingEdge != FADING_EDGE_NONE) {
3406 viewFlagValues |= fadingEdge;
3407 viewFlagMasks |= FADING_EDGE_MASK;
3408 initializeFadingEdge(a);
3409 }
3410 break;
3411 case R.styleable.View_scrollbarStyle:
3412 scrollbarStyle = a.getInt(attr, SCROLLBARS_INSIDE_OVERLAY);
3413 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
3414 viewFlagValues |= scrollbarStyle & SCROLLBARS_STYLE_MASK;
3415 viewFlagMasks |= SCROLLBARS_STYLE_MASK;
3416 }
3417 break;
3418 case R.styleable.View_isScrollContainer:
3419 setScrollContainer = true;
3420 if (a.getBoolean(attr, false)) {
3421 setScrollContainer(true);
3422 }
3423 break;
3424 case com.android.internal.R.styleable.View_keepScreenOn:
3425 if (a.getBoolean(attr, false)) {
3426 viewFlagValues |= KEEP_SCREEN_ON;
3427 viewFlagMasks |= KEEP_SCREEN_ON;
3428 }
3429 break;
Jeff Brown85a31762010-09-01 17:01:00 -07003430 case R.styleable.View_filterTouchesWhenObscured:
3431 if (a.getBoolean(attr, false)) {
3432 viewFlagValues |= FILTER_TOUCHES_WHEN_OBSCURED;
3433 viewFlagMasks |= FILTER_TOUCHES_WHEN_OBSCURED;
3434 }
3435 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003436 case R.styleable.View_nextFocusLeft:
3437 mNextFocusLeftId = a.getResourceId(attr, View.NO_ID);
3438 break;
3439 case R.styleable.View_nextFocusRight:
3440 mNextFocusRightId = a.getResourceId(attr, View.NO_ID);
3441 break;
3442 case R.styleable.View_nextFocusUp:
3443 mNextFocusUpId = a.getResourceId(attr, View.NO_ID);
3444 break;
3445 case R.styleable.View_nextFocusDown:
3446 mNextFocusDownId = a.getResourceId(attr, View.NO_ID);
3447 break;
Jeff Brown4e6319b2010-12-13 10:36:51 -08003448 case R.styleable.View_nextFocusForward:
3449 mNextFocusForwardId = a.getResourceId(attr, View.NO_ID);
3450 break;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003451 case R.styleable.View_minWidth:
3452 mMinWidth = a.getDimensionPixelSize(attr, 0);
3453 break;
3454 case R.styleable.View_minHeight:
3455 mMinHeight = a.getDimensionPixelSize(attr, 0);
3456 break;
Romain Guy9a817362009-05-01 10:57:14 -07003457 case R.styleable.View_onClick:
Romain Guy870e09f2009-07-06 16:35:25 -07003458 if (context.isRestricted()) {
Joe Malin32736f02011-01-19 16:14:20 -08003459 throw new IllegalStateException("The android:onClick attribute cannot "
Romain Guy870e09f2009-07-06 16:35:25 -07003460 + "be used within a restricted context");
3461 }
3462
Romain Guy9a817362009-05-01 10:57:14 -07003463 final String handlerName = a.getString(attr);
3464 if (handlerName != null) {
3465 setOnClickListener(new OnClickListener() {
3466 private Method mHandler;
3467
3468 public void onClick(View v) {
3469 if (mHandler == null) {
3470 try {
3471 mHandler = getContext().getClass().getMethod(handlerName,
3472 View.class);
3473 } catch (NoSuchMethodException e) {
Joe Onorato42e14d72010-03-11 14:51:17 -08003474 int id = getId();
3475 String idText = id == NO_ID ? "" : " with id '"
3476 + getContext().getResources().getResourceEntryName(
3477 id) + "'";
Romain Guy9a817362009-05-01 10:57:14 -07003478 throw new IllegalStateException("Could not find a method " +
Joe Onorato42e14d72010-03-11 14:51:17 -08003479 handlerName + "(View) in the activity "
3480 + getContext().getClass() + " for onClick handler"
3481 + " on view " + View.this.getClass() + idText, e);
Romain Guy9a817362009-05-01 10:57:14 -07003482 }
3483 }
3484
3485 try {
3486 mHandler.invoke(getContext(), View.this);
3487 } catch (IllegalAccessException e) {
3488 throw new IllegalStateException("Could not execute non "
3489 + "public method of the activity", e);
3490 } catch (InvocationTargetException e) {
3491 throw new IllegalStateException("Could not execute "
3492 + "method of the activity", e);
3493 }
3494 }
3495 });
3496 }
3497 break;
Adam Powell637d3372010-08-25 14:37:03 -07003498 case R.styleable.View_overScrollMode:
3499 overScrollMode = a.getInt(attr, OVER_SCROLL_IF_CONTENT_SCROLLS);
3500 break;
Adam Powell20232d02010-12-08 21:08:53 -08003501 case R.styleable.View_verticalScrollbarPosition:
3502 mVerticalScrollbarPosition = a.getInt(attr, SCROLLBAR_POSITION_DEFAULT);
3503 break;
Romain Guy171c5922011-01-06 10:04:23 -08003504 case R.styleable.View_layerType:
3505 setLayerType(a.getInt(attr, LAYER_TYPE_NONE), null);
3506 break;
Fabrice Di Meglio22268862011-06-27 18:13:18 -07003507 case R.styleable.View_textDirection:
Fabrice Di Megliob934db72012-03-20 14:33:01 -07003508 // Clear any text direction flag already set
3509 mPrivateFlags2 &= ~TEXT_DIRECTION_MASK;
3510 // Set the text direction flags depending on the value of the attribute
3511 final int textDirection = a.getInt(attr, -1);
3512 if (textDirection != -1) {
3513 mPrivateFlags2 |= TEXT_DIRECTION_FLAGS[textDirection];
3514 }
Fabrice Di Meglio22268862011-06-27 18:13:18 -07003515 break;
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -07003516 case R.styleable.View_textAlignment:
3517 // Clear any text alignment flag already set
3518 mPrivateFlags2 &= ~TEXT_ALIGNMENT_MASK;
3519 // Set the text alignment flag depending on the value of the attribute
3520 final int textAlignment = a.getInt(attr, TEXT_ALIGNMENT_DEFAULT);
3521 mPrivateFlags2 |= TEXT_ALIGNMENT_FLAGS[textAlignment];
3522 break;
Svetoslav Ganov42138042012-03-20 11:51:39 -07003523 case R.styleable.View_importantForAccessibility:
3524 setImportantForAccessibility(a.getInt(attr,
3525 IMPORTANT_FOR_ACCESSIBILITY_DEFAULT));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003526 }
3527 }
3528
Dianne Hackbornab0f4852011-09-12 16:59:06 -07003529 a.recycle();
3530
Adam Powell637d3372010-08-25 14:37:03 -07003531 setOverScrollMode(overScrollMode);
3532
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003533 if (background != null) {
Philip Milne6c8ea062012-04-03 17:38:43 -07003534 setBackground(background);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003535 }
3536
Fabrice Di Megliof9e36502011-06-21 18:41:48 -07003537 // Cache user padding as we cannot fully resolve padding here (we dont have yet the resolved
3538 // layout direction). Those cached values will be used later during padding resolution.
3539 mUserPaddingStart = startPadding;
3540 mUserPaddingEnd = endPadding;
3541
Fabrice Di Meglio509708d2012-03-06 15:41:11 -08003542 updateUserPaddingRelative();
3543
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003544 if (padding >= 0) {
3545 leftPadding = padding;
3546 topPadding = padding;
3547 rightPadding = padding;
3548 bottomPadding = padding;
3549 }
3550
3551 // If the user specified the padding (either with android:padding or
3552 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
3553 // use the default padding or the padding from the background drawable
3554 // (stored at this point in mPadding*)
3555 setPadding(leftPadding >= 0 ? leftPadding : mPaddingLeft,
3556 topPadding >= 0 ? topPadding : mPaddingTop,
3557 rightPadding >= 0 ? rightPadding : mPaddingRight,
3558 bottomPadding >= 0 ? bottomPadding : mPaddingBottom);
3559
3560 if (viewFlagMasks != 0) {
3561 setFlags(viewFlagValues, viewFlagMasks);
3562 }
3563
3564 // Needs to be called after mViewFlags is set
3565 if (scrollbarStyle != SCROLLBARS_INSIDE_OVERLAY) {
3566 recomputePadding();
3567 }
3568
3569 if (x != 0 || y != 0) {
3570 scrollTo(x, y);
3571 }
3572
Chet Haase73066682010-11-29 15:55:32 -08003573 if (transformSet) {
3574 setTranslationX(tx);
3575 setTranslationY(ty);
3576 setRotation(rotation);
3577 setRotationX(rotationX);
3578 setRotationY(rotationY);
3579 setScaleX(sx);
3580 setScaleY(sy);
3581 }
3582
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003583 if (!setScrollContainer && (viewFlagValues&SCROLLBARS_VERTICAL) != 0) {
3584 setScrollContainer(true);
3585 }
Romain Guy8f1344f52009-05-15 16:03:59 -07003586
3587 computeOpaqueFlags();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003588 }
3589
Fabrice Di Meglio509708d2012-03-06 15:41:11 -08003590 private void updateUserPaddingRelative() {
3591 mUserPaddingRelative = (mUserPaddingStart >= 0 || mUserPaddingEnd >= 0);
3592 }
3593
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003594 /**
3595 * Non-public constructor for use in testing
3596 */
3597 View() {
Dianne Hackbornab0f4852011-09-12 16:59:06 -07003598 mResources = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003599 }
3600
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003601 /**
3602 * <p>
3603 * Initializes the fading edges from a given set of styled attributes. This
3604 * method should be called by subclasses that need fading edges and when an
3605 * instance of these subclasses is created programmatically rather than
3606 * being inflated from XML. This method is automatically called when the XML
3607 * is inflated.
3608 * </p>
3609 *
3610 * @param a the styled attributes set to initialize the fading edges from
3611 */
3612 protected void initializeFadingEdge(TypedArray a) {
3613 initScrollCache();
3614
3615 mScrollCache.fadingEdgeLength = a.getDimensionPixelSize(
3616 R.styleable.View_fadingEdgeLength,
3617 ViewConfiguration.get(mContext).getScaledFadingEdgeLength());
3618 }
3619
3620 /**
3621 * Returns the size of the vertical faded edges used to indicate that more
3622 * content in this view is visible.
3623 *
3624 * @return The size in pixels of the vertical faded edge or 0 if vertical
3625 * faded edges are not enabled for this view.
3626 * @attr ref android.R.styleable#View_fadingEdgeLength
3627 */
3628 public int getVerticalFadingEdgeLength() {
3629 if (isVerticalFadingEdgeEnabled()) {
3630 ScrollabilityCache cache = mScrollCache;
3631 if (cache != null) {
3632 return cache.fadingEdgeLength;
3633 }
3634 }
3635 return 0;
3636 }
3637
3638 /**
3639 * Set the size of the faded edge used to indicate that more content in this
3640 * view is available. Will not change whether the fading edge is enabled; use
Romain Guy5c22a8c2011-05-13 11:48:45 -07003641 * {@link #setVerticalFadingEdgeEnabled(boolean)} or
3642 * {@link #setHorizontalFadingEdgeEnabled(boolean)} to enable the fading edge
3643 * for the vertical or horizontal fading edges.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003644 *
3645 * @param length The size in pixels of the faded edge used to indicate that more
3646 * content in this view is visible.
3647 */
3648 public void setFadingEdgeLength(int length) {
3649 initScrollCache();
3650 mScrollCache.fadingEdgeLength = length;
3651 }
3652
3653 /**
3654 * Returns the size of the horizontal faded edges used to indicate that more
3655 * content in this view is visible.
3656 *
3657 * @return The size in pixels of the horizontal faded edge or 0 if horizontal
3658 * faded edges are not enabled for this view.
3659 * @attr ref android.R.styleable#View_fadingEdgeLength
3660 */
3661 public int getHorizontalFadingEdgeLength() {
3662 if (isHorizontalFadingEdgeEnabled()) {
3663 ScrollabilityCache cache = mScrollCache;
3664 if (cache != null) {
3665 return cache.fadingEdgeLength;
3666 }
3667 }
3668 return 0;
3669 }
3670
3671 /**
3672 * Returns the width of the vertical scrollbar.
3673 *
3674 * @return The width in pixels of the vertical scrollbar or 0 if there
3675 * is no vertical scrollbar.
3676 */
3677 public int getVerticalScrollbarWidth() {
3678 ScrollabilityCache cache = mScrollCache;
3679 if (cache != null) {
3680 ScrollBarDrawable scrollBar = cache.scrollBar;
3681 if (scrollBar != null) {
3682 int size = scrollBar.getSize(true);
3683 if (size <= 0) {
3684 size = cache.scrollBarSize;
3685 }
3686 return size;
3687 }
3688 return 0;
3689 }
3690 return 0;
3691 }
3692
3693 /**
3694 * Returns the height of the horizontal scrollbar.
3695 *
3696 * @return The height in pixels of the horizontal scrollbar or 0 if
3697 * there is no horizontal scrollbar.
3698 */
3699 protected int getHorizontalScrollbarHeight() {
3700 ScrollabilityCache cache = mScrollCache;
3701 if (cache != null) {
3702 ScrollBarDrawable scrollBar = cache.scrollBar;
3703 if (scrollBar != null) {
3704 int size = scrollBar.getSize(false);
3705 if (size <= 0) {
3706 size = cache.scrollBarSize;
3707 }
3708 return size;
3709 }
3710 return 0;
3711 }
3712 return 0;
3713 }
3714
3715 /**
3716 * <p>
3717 * Initializes the scrollbars from a given set of styled attributes. This
3718 * method should be called by subclasses that need scrollbars and when an
3719 * instance of these subclasses is created programmatically rather than
3720 * being inflated from XML. This method is automatically called when the XML
3721 * is inflated.
3722 * </p>
3723 *
3724 * @param a the styled attributes set to initialize the scrollbars from
3725 */
3726 protected void initializeScrollbars(TypedArray a) {
3727 initScrollCache();
3728
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003729 final ScrollabilityCache scrollabilityCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08003730
Mike Cleronf116bf82009-09-27 19:14:12 -07003731 if (scrollabilityCache.scrollBar == null) {
3732 scrollabilityCache.scrollBar = new ScrollBarDrawable();
3733 }
Joe Malin32736f02011-01-19 16:14:20 -08003734
Romain Guy8bda2482010-03-02 11:42:11 -08003735 final boolean fadeScrollbars = a.getBoolean(R.styleable.View_fadeScrollbars, true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003736
Mike Cleronf116bf82009-09-27 19:14:12 -07003737 if (!fadeScrollbars) {
3738 scrollabilityCache.state = ScrollabilityCache.ON;
3739 }
3740 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Joe Malin32736f02011-01-19 16:14:20 -08003741
3742
Mike Cleronf116bf82009-09-27 19:14:12 -07003743 scrollabilityCache.scrollBarFadeDuration = a.getInt(
3744 R.styleable.View_scrollbarFadeDuration, ViewConfiguration
3745 .getScrollBarFadeDuration());
3746 scrollabilityCache.scrollBarDefaultDelayBeforeFade = a.getInt(
3747 R.styleable.View_scrollbarDefaultDelayBeforeFade,
3748 ViewConfiguration.getScrollDefaultDelay());
3749
Joe Malin32736f02011-01-19 16:14:20 -08003750
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003751 scrollabilityCache.scrollBarSize = a.getDimensionPixelSize(
3752 com.android.internal.R.styleable.View_scrollbarSize,
3753 ViewConfiguration.get(mContext).getScaledScrollBarSize());
3754
3755 Drawable track = a.getDrawable(R.styleable.View_scrollbarTrackHorizontal);
3756 scrollabilityCache.scrollBar.setHorizontalTrackDrawable(track);
3757
3758 Drawable thumb = a.getDrawable(R.styleable.View_scrollbarThumbHorizontal);
3759 if (thumb != null) {
3760 scrollabilityCache.scrollBar.setHorizontalThumbDrawable(thumb);
3761 }
3762
3763 boolean alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawHorizontalTrack,
3764 false);
3765 if (alwaysDraw) {
3766 scrollabilityCache.scrollBar.setAlwaysDrawHorizontalTrack(true);
3767 }
3768
3769 track = a.getDrawable(R.styleable.View_scrollbarTrackVertical);
3770 scrollabilityCache.scrollBar.setVerticalTrackDrawable(track);
3771
3772 thumb = a.getDrawable(R.styleable.View_scrollbarThumbVertical);
3773 if (thumb != null) {
3774 scrollabilityCache.scrollBar.setVerticalThumbDrawable(thumb);
3775 }
3776
3777 alwaysDraw = a.getBoolean(R.styleable.View_scrollbarAlwaysDrawVerticalTrack,
3778 false);
3779 if (alwaysDraw) {
3780 scrollabilityCache.scrollBar.setAlwaysDrawVerticalTrack(true);
3781 }
3782
3783 // Re-apply user/background padding so that scrollbar(s) get added
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003784 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003785 }
3786
3787 /**
3788 * <p>
3789 * Initalizes the scrollability cache if necessary.
3790 * </p>
3791 */
3792 private void initScrollCache() {
3793 if (mScrollCache == null) {
Mike Cleronf116bf82009-09-27 19:14:12 -07003794 mScrollCache = new ScrollabilityCache(ViewConfiguration.get(mContext), this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003795 }
3796 }
3797
Philip Milne6c8ea062012-04-03 17:38:43 -07003798 private ScrollabilityCache getScrollCache() {
3799 initScrollCache();
3800 return mScrollCache;
3801 }
3802
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003803 /**
Adam Powell20232d02010-12-08 21:08:53 -08003804 * Set the position of the vertical scroll bar. Should be one of
3805 * {@link #SCROLLBAR_POSITION_DEFAULT}, {@link #SCROLLBAR_POSITION_LEFT} or
3806 * {@link #SCROLLBAR_POSITION_RIGHT}.
3807 *
3808 * @param position Where the vertical scroll bar should be positioned.
3809 */
3810 public void setVerticalScrollbarPosition(int position) {
3811 if (mVerticalScrollbarPosition != position) {
3812 mVerticalScrollbarPosition = position;
3813 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07003814 resolvePadding();
Adam Powell20232d02010-12-08 21:08:53 -08003815 }
3816 }
3817
3818 /**
3819 * @return The position where the vertical scroll bar will show, if applicable.
3820 * @see #setVerticalScrollbarPosition(int)
3821 */
3822 public int getVerticalScrollbarPosition() {
3823 return mVerticalScrollbarPosition;
3824 }
3825
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003826 ListenerInfo getListenerInfo() {
3827 if (mListenerInfo != null) {
3828 return mListenerInfo;
3829 }
3830 mListenerInfo = new ListenerInfo();
3831 return mListenerInfo;
3832 }
3833
Adam Powell20232d02010-12-08 21:08:53 -08003834 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003835 * Register a callback to be invoked when focus of this view changed.
3836 *
3837 * @param l The callback that will run.
3838 */
3839 public void setOnFocusChangeListener(OnFocusChangeListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003840 getListenerInfo().mOnFocusChangeListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003841 }
3842
3843 /**
Chet Haase21cd1382010-09-01 17:42:29 -07003844 * Add a listener that will be called when the bounds of the view change due to
3845 * layout processing.
3846 *
3847 * @param listener The listener that will be called when layout bounds change.
3848 */
3849 public void addOnLayoutChangeListener(OnLayoutChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003850 ListenerInfo li = getListenerInfo();
3851 if (li.mOnLayoutChangeListeners == null) {
3852 li.mOnLayoutChangeListeners = new ArrayList<OnLayoutChangeListener>();
Chet Haase21cd1382010-09-01 17:42:29 -07003853 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003854 if (!li.mOnLayoutChangeListeners.contains(listener)) {
3855 li.mOnLayoutChangeListeners.add(listener);
Chet Haase1a76dcd2011-10-06 11:16:40 -07003856 }
Chet Haase21cd1382010-09-01 17:42:29 -07003857 }
3858
3859 /**
3860 * Remove a listener for layout changes.
3861 *
3862 * @param listener The listener for layout bounds change.
3863 */
3864 public void removeOnLayoutChangeListener(OnLayoutChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003865 ListenerInfo li = mListenerInfo;
3866 if (li == null || li.mOnLayoutChangeListeners == null) {
Chet Haase21cd1382010-09-01 17:42:29 -07003867 return;
3868 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003869 li.mOnLayoutChangeListeners.remove(listener);
Chet Haase21cd1382010-09-01 17:42:29 -07003870 }
3871
3872 /**
Adam Powell4afd62b2011-02-18 15:02:18 -08003873 * Add a listener for attach state changes.
3874 *
3875 * This listener will be called whenever this view is attached or detached
3876 * from a window. Remove the listener using
3877 * {@link #removeOnAttachStateChangeListener(OnAttachStateChangeListener)}.
3878 *
3879 * @param listener Listener to attach
3880 * @see #removeOnAttachStateChangeListener(OnAttachStateChangeListener)
3881 */
3882 public void addOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003883 ListenerInfo li = getListenerInfo();
3884 if (li.mOnAttachStateChangeListeners == null) {
3885 li.mOnAttachStateChangeListeners
3886 = new CopyOnWriteArrayList<OnAttachStateChangeListener>();
Adam Powell4afd62b2011-02-18 15:02:18 -08003887 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003888 li.mOnAttachStateChangeListeners.add(listener);
Adam Powell4afd62b2011-02-18 15:02:18 -08003889 }
3890
3891 /**
3892 * Remove a listener for attach state changes. The listener will receive no further
3893 * notification of window attach/detach events.
3894 *
3895 * @param listener Listener to remove
3896 * @see #addOnAttachStateChangeListener(OnAttachStateChangeListener)
3897 */
3898 public void removeOnAttachStateChangeListener(OnAttachStateChangeListener listener) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003899 ListenerInfo li = mListenerInfo;
3900 if (li == null || li.mOnAttachStateChangeListeners == null) {
Adam Powell4afd62b2011-02-18 15:02:18 -08003901 return;
3902 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003903 li.mOnAttachStateChangeListeners.remove(listener);
Adam Powell4afd62b2011-02-18 15:02:18 -08003904 }
3905
3906 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003907 * Returns the focus-change callback registered for this view.
3908 *
3909 * @return The callback, or null if one is not registered.
3910 */
3911 public OnFocusChangeListener getOnFocusChangeListener() {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003912 ListenerInfo li = mListenerInfo;
3913 return li != null ? li.mOnFocusChangeListener : null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003914 }
3915
3916 /**
3917 * Register a callback to be invoked when this view is clicked. If this view is not
3918 * clickable, it becomes clickable.
3919 *
3920 * @param l The callback that will run
3921 *
3922 * @see #setClickable(boolean)
3923 */
3924 public void setOnClickListener(OnClickListener l) {
3925 if (!isClickable()) {
3926 setClickable(true);
3927 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003928 getListenerInfo().mOnClickListener = l;
3929 }
3930
3931 /**
3932 * Return whether this view has an attached OnClickListener. Returns
3933 * true if there is a listener, false if there is none.
3934 */
3935 public boolean hasOnClickListeners() {
3936 ListenerInfo li = mListenerInfo;
3937 return (li != null && li.mOnClickListener != null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003938 }
3939
3940 /**
3941 * Register a callback to be invoked when this view is clicked and held. If this view is not
3942 * long clickable, it becomes long clickable.
3943 *
3944 * @param l The callback that will run
3945 *
3946 * @see #setLongClickable(boolean)
3947 */
3948 public void setOnLongClickListener(OnLongClickListener l) {
3949 if (!isLongClickable()) {
3950 setLongClickable(true);
3951 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003952 getListenerInfo().mOnLongClickListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003953 }
3954
3955 /**
3956 * Register a callback to be invoked when the context menu for this view is
3957 * being built. If this view is not long clickable, it becomes long clickable.
3958 *
3959 * @param l The callback that will run
3960 *
3961 */
3962 public void setOnCreateContextMenuListener(OnCreateContextMenuListener l) {
3963 if (!isLongClickable()) {
3964 setLongClickable(true);
3965 }
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003966 getListenerInfo().mOnCreateContextMenuListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003967 }
3968
3969 /**
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003970 * Call this view's OnClickListener, if it is defined. Performs all normal
3971 * actions associated with clicking: reporting accessibility event, playing
3972 * a sound, etc.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003973 *
3974 * @return True there was an assigned OnClickListener that was called, false
3975 * otherwise is returned.
3976 */
3977 public boolean performClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07003978 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
3979
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003980 ListenerInfo li = mListenerInfo;
3981 if (li != null && li.mOnClickListener != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003982 playSoundEffect(SoundEffectConstants.CLICK);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003983 li.mOnClickListener.onClick(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003984 return true;
3985 }
3986
3987 return false;
3988 }
3989
3990 /**
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07003991 * Directly call any attached OnClickListener. Unlike {@link #performClick()},
3992 * this only calls the listener, and does not do any associated clicking
3993 * actions like reporting an accessibility event.
3994 *
3995 * @return True there was an assigned OnClickListener that was called, false
3996 * otherwise is returned.
3997 */
3998 public boolean callOnClick() {
3999 ListenerInfo li = mListenerInfo;
4000 if (li != null && li.mOnClickListener != null) {
4001 li.mOnClickListener.onClick(this);
4002 return true;
4003 }
4004 return false;
4005 }
4006
4007 /**
Gilles Debunnef788a9f2010-07-22 10:17:23 -07004008 * Call this view's OnLongClickListener, if it is defined. Invokes the context menu if the
4009 * OnLongClickListener did not consume the event.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004010 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07004011 * @return True if one of the above receivers consumed the event, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004012 */
4013 public boolean performLongClick() {
svetoslavganov75986cf2009-05-14 22:28:01 -07004014 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);
4015
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004016 boolean handled = false;
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004017 ListenerInfo li = mListenerInfo;
4018 if (li != null && li.mOnLongClickListener != null) {
4019 handled = li.mOnLongClickListener.onLongClick(View.this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004020 }
4021 if (!handled) {
4022 handled = showContextMenu();
4023 }
4024 if (handled) {
4025 performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
4026 }
4027 return handled;
4028 }
4029
4030 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07004031 * Performs button-related actions during a touch down event.
4032 *
4033 * @param event The event.
4034 * @return True if the down was consumed.
4035 *
4036 * @hide
4037 */
4038 protected boolean performButtonActionOnTouchDown(MotionEvent event) {
4039 if ((event.getButtonState() & MotionEvent.BUTTON_SECONDARY) != 0) {
4040 if (showContextMenu(event.getX(), event.getY(), event.getMetaState())) {
4041 return true;
4042 }
4043 }
4044 return false;
4045 }
4046
4047 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004048 * Bring up the context menu for this view.
4049 *
4050 * @return Whether a context menu was displayed.
4051 */
4052 public boolean showContextMenu() {
4053 return getParent().showContextMenuForChild(this);
4054 }
4055
4056 /**
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07004057 * Bring up the context menu for this view, referring to the item under the specified point.
4058 *
4059 * @param x The referenced x coordinate.
4060 * @param y The referenced y coordinate.
4061 * @param metaState The keyboard modifiers that were pressed.
4062 * @return Whether a context menu was displayed.
4063 *
4064 * @hide
4065 */
4066 public boolean showContextMenu(float x, float y, int metaState) {
4067 return showContextMenu();
4068 }
4069
4070 /**
Adam Powell6e346362010-07-23 10:18:23 -07004071 * Start an action mode.
4072 *
4073 * @param callback Callback that will control the lifecycle of the action mode
4074 * @return The new action mode if it is started, null otherwise
4075 *
4076 * @see ActionMode
4077 */
4078 public ActionMode startActionMode(ActionMode.Callback callback) {
John Reck5160e2a2012-02-22 09:35:12 -08004079 ViewParent parent = getParent();
4080 if (parent == null) return null;
4081 return parent.startActionModeForChild(this, callback);
Adam Powell6e346362010-07-23 10:18:23 -07004082 }
4083
4084 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004085 * Register a callback to be invoked when a key is pressed in this view.
4086 * @param l the key listener to attach to this view
4087 */
4088 public void setOnKeyListener(OnKeyListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004089 getListenerInfo().mOnKeyListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004090 }
4091
4092 /**
4093 * Register a callback to be invoked when a touch event is sent to this view.
4094 * @param l the touch listener to attach to this view
4095 */
4096 public void setOnTouchListener(OnTouchListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004097 getListenerInfo().mOnTouchListener = l;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004098 }
4099
4100 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08004101 * Register a callback to be invoked when a generic motion event is sent to this view.
4102 * @param l the generic motion listener to attach to this view
4103 */
4104 public void setOnGenericMotionListener(OnGenericMotionListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004105 getListenerInfo().mOnGenericMotionListener = l;
Jeff Brown33bbfd22011-02-24 20:55:35 -08004106 }
4107
4108 /**
Jeff Brown53ca3f12011-06-27 18:36:00 -07004109 * Register a callback to be invoked when a hover event is sent to this view.
4110 * @param l the hover listener to attach to this view
4111 */
4112 public void setOnHoverListener(OnHoverListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004113 getListenerInfo().mOnHoverListener = l;
Jeff Brown53ca3f12011-06-27 18:36:00 -07004114 }
4115
4116 /**
Joe Malin32736f02011-01-19 16:14:20 -08004117 * Register a drag event listener callback object for this View. The parameter is
4118 * an implementation of {@link android.view.View.OnDragListener}. To send a drag event to a
4119 * View, the system calls the
4120 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent)} method.
4121 * @param l An implementation of {@link android.view.View.OnDragListener}.
Chris Tate32affef2010-10-18 15:29:21 -07004122 */
4123 public void setOnDragListener(OnDragListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004124 getListenerInfo().mOnDragListener = l;
Chris Tate32affef2010-10-18 15:29:21 -07004125 }
4126
4127 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07004128 * Give this view focus. This will cause
4129 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} to be called.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004130 *
4131 * Note: this does not check whether this {@link View} should get focus, it just
4132 * gives it focus no matter what. It should only be called internally by framework
4133 * code that knows what it is doing, namely {@link #requestFocus(int, Rect)}.
4134 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08004135 * @param direction values are {@link View#FOCUS_UP}, {@link View#FOCUS_DOWN},
4136 * {@link View#FOCUS_LEFT} or {@link View#FOCUS_RIGHT}. This is the direction which
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004137 * focus moved when requestFocus() is called. It may not always
4138 * apply, in which case use the default View.FOCUS_DOWN.
4139 * @param previouslyFocusedRect The rectangle of the view that had focus
4140 * prior in this View's coordinate system.
4141 */
4142 void handleFocusGainInternal(int direction, Rect previouslyFocusedRect) {
4143 if (DBG) {
4144 System.out.println(this + " requestFocus()");
4145 }
4146
4147 if ((mPrivateFlags & FOCUSED) == 0) {
4148 mPrivateFlags |= FOCUSED;
4149
4150 if (mParent != null) {
4151 mParent.requestChildFocus(this, this);
4152 }
4153
4154 onFocusChanged(true, direction, previouslyFocusedRect);
4155 refreshDrawableState();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004156
4157 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4158 notifyAccessibilityStateChanged();
4159 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004160 }
4161 }
4162
4163 /**
4164 * Request that a rectangle of this view be visible on the screen,
4165 * scrolling if necessary just enough.
4166 *
4167 * <p>A View should call this if it maintains some notion of which part
4168 * of its content is interesting. For example, a text editing view
4169 * should call this when its cursor moves.
4170 *
4171 * @param rectangle The rectangle.
4172 * @return Whether any parent scrolled.
4173 */
4174 public boolean requestRectangleOnScreen(Rect rectangle) {
4175 return requestRectangleOnScreen(rectangle, false);
4176 }
4177
4178 /**
4179 * Request that a rectangle of this view be visible on the screen,
4180 * scrolling if necessary just enough.
4181 *
4182 * <p>A View should call this if it maintains some notion of which part
4183 * of its content is interesting. For example, a text editing view
4184 * should call this when its cursor moves.
4185 *
4186 * <p>When <code>immediate</code> is set to true, scrolling will not be
4187 * animated.
4188 *
4189 * @param rectangle The rectangle.
4190 * @param immediate True to forbid animated scrolling, false otherwise
4191 * @return Whether any parent scrolled.
4192 */
4193 public boolean requestRectangleOnScreen(Rect rectangle, boolean immediate) {
4194 View child = this;
4195 ViewParent parent = mParent;
4196 boolean scrolled = false;
4197 while (parent != null) {
4198 scrolled |= parent.requestChildRectangleOnScreen(child,
4199 rectangle, immediate);
4200
4201 // offset rect so next call has the rectangle in the
4202 // coordinate system of its direct child.
4203 rectangle.offset(child.getLeft(), child.getTop());
4204 rectangle.offset(-child.getScrollX(), -child.getScrollY());
4205
4206 if (!(parent instanceof View)) {
4207 break;
4208 }
Romain Guy8506ab42009-06-11 17:35:47 -07004209
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004210 child = (View) parent;
4211 parent = child.getParent();
4212 }
4213 return scrolled;
4214 }
4215
4216 /**
Svetoslav Ganov13fd5612012-02-01 17:01:12 -08004217 * Called when this view wants to give up focus. If focus is cleared
4218 * {@link #onFocusChanged(boolean, int, android.graphics.Rect)} is called.
4219 * <p>
4220 * <strong>Note:</strong> When a View clears focus the framework is trying
4221 * to give focus to the first focusable View from the top. Hence, if this
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004222 * View is the first from the top that can take focus, then all callbacks
4223 * related to clearing focus will be invoked after wich the framework will
4224 * give focus to this view.
Svetoslav Ganov13fd5612012-02-01 17:01:12 -08004225 * </p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004226 */
4227 public void clearFocus() {
4228 if (DBG) {
4229 System.out.println(this + " clearFocus()");
4230 }
4231
4232 if ((mPrivateFlags & FOCUSED) != 0) {
4233 mPrivateFlags &= ~FOCUSED;
4234
4235 if (mParent != null) {
4236 mParent.clearChildFocus(this);
4237 }
4238
4239 onFocusChanged(false, 0, null);
Svetoslav Ganov42138042012-03-20 11:51:39 -07004240
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004241 refreshDrawableState();
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004242
4243 ensureInputFocusOnFirstFocusable();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004244
4245 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4246 notifyAccessibilityStateChanged();
4247 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004248 }
4249 }
4250
Svetoslav Ganov57cadf22012-04-04 16:44:39 -07004251 void ensureInputFocusOnFirstFocusable() {
4252 View root = getRootView();
4253 if (root != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004254 root.requestFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004255 }
4256 }
4257
4258 /**
4259 * Called internally by the view system when a new view is getting focus.
4260 * This is what clears the old focus.
4261 */
4262 void unFocus() {
4263 if (DBG) {
4264 System.out.println(this + " unFocus()");
4265 }
4266
4267 if ((mPrivateFlags & FOCUSED) != 0) {
4268 mPrivateFlags &= ~FOCUSED;
4269
4270 onFocusChanged(false, 0, null);
4271 refreshDrawableState();
Svetoslav Ganov42138042012-03-20 11:51:39 -07004272
4273 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4274 notifyAccessibilityStateChanged();
4275 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004276 }
4277 }
4278
4279 /**
4280 * Returns true if this view has focus iteself, or is the ancestor of the
4281 * view that has focus.
4282 *
4283 * @return True if this view has or contains focus, false otherwise.
4284 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004285 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004286 public boolean hasFocus() {
4287 return (mPrivateFlags & FOCUSED) != 0;
4288 }
4289
4290 /**
4291 * Returns true if this view is focusable or if it contains a reachable View
4292 * for which {@link #hasFocusable()} returns true. A "reachable hasFocusable()"
4293 * is a View whose parents do not block descendants focus.
4294 *
4295 * Only {@link #VISIBLE} views are considered focusable.
4296 *
4297 * @return True if the view is focusable or if the view contains a focusable
4298 * View, false otherwise.
4299 *
4300 * @see ViewGroup#FOCUS_BLOCK_DESCENDANTS
4301 */
4302 public boolean hasFocusable() {
4303 return (mViewFlags & VISIBILITY_MASK) == VISIBLE && isFocusable();
4304 }
4305
4306 /**
4307 * Called by the view system when the focus state of this view changes.
4308 * When the focus change event is caused by directional navigation, direction
4309 * and previouslyFocusedRect provide insight into where the focus is coming from.
4310 * When overriding, be sure to call up through to the super class so that
4311 * the standard focus handling will occur.
Romain Guy8506ab42009-06-11 17:35:47 -07004312 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004313 * @param gainFocus True if the View has focus; false otherwise.
4314 * @param direction The direction focus has moved when requestFocus()
4315 * is called to give this view focus. Values are
Jeff Brown4e6319b2010-12-13 10:36:51 -08004316 * {@link #FOCUS_UP}, {@link #FOCUS_DOWN}, {@link #FOCUS_LEFT},
4317 * {@link #FOCUS_RIGHT}, {@link #FOCUS_FORWARD}, or {@link #FOCUS_BACKWARD}.
4318 * It may not always apply, in which case use the default.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004319 * @param previouslyFocusedRect The rectangle, in this view's coordinate
4320 * system, of the previously focused view. If applicable, this will be
4321 * passed in as finer grained information about where the focus is coming
4322 * from (in addition to direction). Will be <code>null</code> otherwise.
4323 */
4324 protected void onFocusChanged(boolean gainFocus, int direction, Rect previouslyFocusedRect) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004325 if (gainFocus) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004326 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4327 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_FOCUSED);
4328 requestAccessibilityFocus();
4329 }
svetoslavganov75986cf2009-05-14 22:28:01 -07004330 }
4331
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004332 InputMethodManager imm = InputMethodManager.peekInstance();
4333 if (!gainFocus) {
4334 if (isPressed()) {
4335 setPressed(false);
4336 }
4337 if (imm != null && mAttachInfo != null
4338 && mAttachInfo.mHasWindowFocus) {
4339 imm.focusOut(this);
4340 }
Romain Guya2431d02009-04-30 16:30:00 -07004341 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004342 } else if (imm != null && mAttachInfo != null
4343 && mAttachInfo.mHasWindowFocus) {
4344 imm.focusIn(this);
4345 }
Romain Guy8506ab42009-06-11 17:35:47 -07004346
Romain Guy0fd89bf2011-01-26 15:41:30 -08004347 invalidate(true);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07004348 ListenerInfo li = mListenerInfo;
4349 if (li != null && li.mOnFocusChangeListener != null) {
4350 li.mOnFocusChangeListener.onFocusChange(this, gainFocus);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004351 }
Joe Malin32736f02011-01-19 16:14:20 -08004352
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07004353 if (mAttachInfo != null) {
4354 mAttachInfo.mKeyDispatchState.reset(this);
4355 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004356 }
4357
4358 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004359 * Sends an accessibility event of the given type. If accessiiblity is
4360 * not enabled this method has no effect. The default implementation calls
4361 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)} first
4362 * to populate information about the event source (this View), then calls
4363 * {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)} to
4364 * populate the text content of the event source including its descendants,
4365 * and last calls
4366 * {@link ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)}
4367 * on its parent to resuest sending of the event to interested parties.
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004368 * <p>
4369 * If an {@link AccessibilityDelegate} has been specified via calling
4370 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4371 * {@link AccessibilityDelegate#sendAccessibilityEvent(View, int)} is
4372 * responsible for handling this call.
4373 * </p>
Svetoslav Ganov30401322011-05-12 18:53:45 -07004374 *
Scott Mainb303d832011-10-12 16:45:18 -07004375 * @param eventType The type of the event to send, as defined by several types from
4376 * {@link android.view.accessibility.AccessibilityEvent}, such as
4377 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_CLICKED} or
4378 * {@link android.view.accessibility.AccessibilityEvent#TYPE_VIEW_HOVER_ENTER}.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004379 *
4380 * @see #onInitializeAccessibilityEvent(AccessibilityEvent)
4381 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4382 * @see ViewParent#requestSendAccessibilityEvent(View, AccessibilityEvent)
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004383 * @see AccessibilityDelegate
svetoslavganov75986cf2009-05-14 22:28:01 -07004384 */
4385 public void sendAccessibilityEvent(int eventType) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004386 if (mAccessibilityDelegate != null) {
4387 mAccessibilityDelegate.sendAccessibilityEvent(this, eventType);
4388 } else {
4389 sendAccessibilityEventInternal(eventType);
4390 }
4391 }
4392
4393 /**
Svetoslav Ganov51ab90c2012-03-09 10:54:49 -08004394 * Convenience method for sending a {@link AccessibilityEvent#TYPE_ANNOUNCEMENT}
4395 * {@link AccessibilityEvent} to make an announcement which is related to some
4396 * sort of a context change for which none of the events representing UI transitions
4397 * is a good fit. For example, announcing a new page in a book. If accessibility
4398 * is not enabled this method does nothing.
4399 *
4400 * @param text The announcement text.
4401 */
4402 public void announceForAccessibility(CharSequence text) {
4403 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4404 AccessibilityEvent event = AccessibilityEvent.obtain(
4405 AccessibilityEvent.TYPE_ANNOUNCEMENT);
4406 event.getText().add(text);
4407 sendAccessibilityEventUnchecked(event);
4408 }
4409 }
4410
4411 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004412 * @see #sendAccessibilityEvent(int)
4413 *
4414 * Note: Called from the default {@link AccessibilityDelegate}.
4415 */
4416 void sendAccessibilityEventInternal(int eventType) {
svetoslavganov75986cf2009-05-14 22:28:01 -07004417 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
4418 sendAccessibilityEventUnchecked(AccessibilityEvent.obtain(eventType));
4419 }
4420 }
4421
4422 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004423 * This method behaves exactly as {@link #sendAccessibilityEvent(int)} but
4424 * takes as an argument an empty {@link AccessibilityEvent} and does not
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004425 * perform a check whether accessibility is enabled.
4426 * <p>
4427 * If an {@link AccessibilityDelegate} has been specified via calling
4428 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4429 * {@link AccessibilityDelegate#sendAccessibilityEventUnchecked(View, AccessibilityEvent)}
4430 * is responsible for handling this call.
4431 * </p>
Svetoslav Ganov30401322011-05-12 18:53:45 -07004432 *
4433 * @param event The event to send.
4434 *
4435 * @see #sendAccessibilityEvent(int)
svetoslavganov75986cf2009-05-14 22:28:01 -07004436 */
4437 public void sendAccessibilityEventUnchecked(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004438 if (mAccessibilityDelegate != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004439 mAccessibilityDelegate.sendAccessibilityEventUnchecked(this, event);
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004440 } else {
4441 sendAccessibilityEventUncheckedInternal(event);
4442 }
4443 }
4444
4445 /**
4446 * @see #sendAccessibilityEventUnchecked(AccessibilityEvent)
4447 *
4448 * Note: Called from the default {@link AccessibilityDelegate}.
4449 */
4450 void sendAccessibilityEventUncheckedInternal(AccessibilityEvent event) {
Svetoslav Ganov9cd1eca2011-01-13 14:24:02 -08004451 if (!isShown()) {
4452 return;
4453 }
Svetoslav Ganov30401322011-05-12 18:53:45 -07004454 onInitializeAccessibilityEvent(event);
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07004455 // Only a subset of accessibility events populates text content.
4456 if ((event.getEventType() & POPULATING_ACCESSIBILITY_EVENT_TYPES) != 0) {
4457 dispatchPopulateAccessibilityEvent(event);
4458 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07004459 // Intercept accessibility focus events fired by virtual nodes to keep
4460 // track of accessibility focus position in such nodes.
4461 final int eventType = event.getEventType();
4462 switch (eventType) {
4463 case AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED: {
4464 final long virtualNodeId = AccessibilityNodeInfo.getVirtualDescendantId(
4465 event.getSourceNodeId());
4466 if (virtualNodeId != AccessibilityNodeInfo.UNDEFINED) {
4467 ViewRootImpl viewRootImpl = getViewRootImpl();
4468 if (viewRootImpl != null) {
4469 viewRootImpl.setAccessibilityFocusedHost(this);
4470 }
4471 }
4472 } break;
4473 case AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED: {
4474 final long virtualNodeId = AccessibilityNodeInfo.getVirtualDescendantId(
4475 event.getSourceNodeId());
4476 if (virtualNodeId != AccessibilityNodeInfo.UNDEFINED) {
4477 ViewRootImpl viewRootImpl = getViewRootImpl();
4478 if (viewRootImpl != null) {
4479 viewRootImpl.setAccessibilityFocusedHost(null);
4480 }
4481 }
4482 } break;
4483 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004484 // In the beginning we called #isShown(), so we know that getParent() is not null.
4485 getParent().requestSendAccessibilityEvent(this, event);
svetoslavganov75986cf2009-05-14 22:28:01 -07004486 }
4487
4488 /**
Svetoslav Ganov30401322011-05-12 18:53:45 -07004489 * Dispatches an {@link AccessibilityEvent} to the {@link View} first and then
4490 * to its children for adding their text content to the event. Note that the
4491 * event text is populated in a separate dispatch path since we add to the
4492 * event not only the text of the source but also the text of all its descendants.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004493 * A typical implementation will call
4494 * {@link #onPopulateAccessibilityEvent(AccessibilityEvent)} on the this view
4495 * and then call the {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
4496 * on each child. Override this method if custom population of the event text
4497 * content is required.
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004498 * <p>
4499 * If an {@link AccessibilityDelegate} has been specified via calling
4500 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4501 * {@link AccessibilityDelegate#dispatchPopulateAccessibilityEvent(View, AccessibilityEvent)}
4502 * is responsible for handling this call.
4503 * </p>
Svetoslav Ganov82e236d2011-09-29 19:31:06 -07004504 * <p>
4505 * <em>Note:</em> Accessibility events of certain types are not dispatched for
4506 * populating the event text via this method. For details refer to {@link AccessibilityEvent}.
4507 * </p>
svetoslavganov75986cf2009-05-14 22:28:01 -07004508 *
4509 * @param event The event.
4510 *
4511 * @return True if the event population was completed.
4512 */
4513 public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004514 if (mAccessibilityDelegate != null) {
4515 return mAccessibilityDelegate.dispatchPopulateAccessibilityEvent(this, event);
4516 } else {
4517 return dispatchPopulateAccessibilityEventInternal(event);
4518 }
4519 }
4520
4521 /**
4522 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4523 *
4524 * Note: Called from the default {@link AccessibilityDelegate}.
4525 */
4526 boolean dispatchPopulateAccessibilityEventInternal(AccessibilityEvent event) {
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004527 onPopulateAccessibilityEvent(event);
svetoslavganov75986cf2009-05-14 22:28:01 -07004528 return false;
4529 }
4530
4531 /**
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004532 * Called from {@link #dispatchPopulateAccessibilityEvent(AccessibilityEvent)}
Svetoslav Ganov30401322011-05-12 18:53:45 -07004533 * giving a chance to this View to populate the accessibility event with its
Scott Mainb303d832011-10-12 16:45:18 -07004534 * text content. While this method is free to modify event
4535 * attributes other than text content, doing so should normally be performed in
Svetoslav Ganov30401322011-05-12 18:53:45 -07004536 * {@link #onInitializeAccessibilityEvent(AccessibilityEvent)}.
4537 * <p>
4538 * Example: Adding formatted date string to an accessibility event in addition
Scott Mainb303d832011-10-12 16:45:18 -07004539 * to the text added by the super implementation:
4540 * <pre> public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov30401322011-05-12 18:53:45 -07004541 * super.onPopulateAccessibilityEvent(event);
4542 * final int flags = DateUtils.FORMAT_SHOW_DATE | DateUtils.FORMAT_SHOW_WEEKDAY;
4543 * String selectedDateUtterance = DateUtils.formatDateTime(mContext,
4544 * mCurrentDate.getTimeInMillis(), flags);
4545 * event.getText().add(selectedDateUtterance);
Scott Mainb303d832011-10-12 16:45:18 -07004546 * }</pre>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004547 * <p>
4548 * If an {@link AccessibilityDelegate} has been specified via calling
4549 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4550 * {@link AccessibilityDelegate#onPopulateAccessibilityEvent(View, AccessibilityEvent)}
4551 * is responsible for handling this call.
4552 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07004553 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding
4554 * information to the event, in case the default implementation has basic information to add.
4555 * </p>
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004556 *
4557 * @param event The accessibility event which to populate.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004558 *
4559 * @see #sendAccessibilityEvent(int)
4560 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004561 */
4562 public void onPopulateAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004563 if (mAccessibilityDelegate != null) {
4564 mAccessibilityDelegate.onPopulateAccessibilityEvent(this, event);
4565 } else {
4566 onPopulateAccessibilityEventInternal(event);
4567 }
Svetoslav Ganov736c2752011-04-22 18:30:36 -07004568 }
4569
4570 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004571 * @see #onPopulateAccessibilityEvent(AccessibilityEvent)
4572 *
4573 * Note: Called from the default {@link AccessibilityDelegate}.
4574 */
4575 void onPopulateAccessibilityEventInternal(AccessibilityEvent event) {
4576
4577 }
4578
4579 /**
4580 * Initializes an {@link AccessibilityEvent} with information about
4581 * this View which is the event source. In other words, the source of
4582 * an accessibility event is the view whose state change triggered firing
4583 * the event.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004584 * <p>
4585 * Example: Setting the password property of an event in addition
Scott Mainb303d832011-10-12 16:45:18 -07004586 * to properties set by the super implementation:
4587 * <pre> public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
4588 * super.onInitializeAccessibilityEvent(event);
4589 * event.setPassword(true);
4590 * }</pre>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004591 * <p>
4592 * If an {@link AccessibilityDelegate} has been specified via calling
4593 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4594 * {@link AccessibilityDelegate#onInitializeAccessibilityEvent(View, AccessibilityEvent)}
4595 * is responsible for handling this call.
4596 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07004597 * <p class="note"><strong>Note:</strong> Always call the super implementation before adding
4598 * information to the event, in case the default implementation has basic information to add.
4599 * </p>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004600 * @param event The event to initialize.
Svetoslav Ganov30401322011-05-12 18:53:45 -07004601 *
4602 * @see #sendAccessibilityEvent(int)
4603 * @see #dispatchPopulateAccessibilityEvent(AccessibilityEvent)
4604 */
4605 public void onInitializeAccessibilityEvent(AccessibilityEvent event) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004606 if (mAccessibilityDelegate != null) {
4607 mAccessibilityDelegate.onInitializeAccessibilityEvent(this, event);
4608 } else {
4609 onInitializeAccessibilityEventInternal(event);
4610 }
4611 }
4612
4613 /**
4614 * @see #onInitializeAccessibilityEvent(AccessibilityEvent)
4615 *
4616 * Note: Called from the default {@link AccessibilityDelegate}.
4617 */
4618 void onInitializeAccessibilityEventInternal(AccessibilityEvent event) {
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004619 event.setSource(this);
Svetoslav Ganov8a78fd42012-01-17 14:36:46 -08004620 event.setClassName(View.class.getName());
Svetoslav Ganov30401322011-05-12 18:53:45 -07004621 event.setPackageName(getContext().getPackageName());
4622 event.setEnabled(isEnabled());
4623 event.setContentDescription(mContentDescription);
4624
Svetoslav Ganovd9ee72f2011-10-05 22:26:05 -07004625 if (event.getEventType() == AccessibilityEvent.TYPE_VIEW_FOCUSED && mAttachInfo != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07004626 ArrayList<View> focusablesTempList = mAttachInfo.mTempArrayList;
Svetoslav Ganovd9ee72f2011-10-05 22:26:05 -07004627 getRootView().addFocusables(focusablesTempList, View.FOCUS_FORWARD,
4628 FOCUSABLES_ALL);
4629 event.setItemCount(focusablesTempList.size());
4630 event.setCurrentItemIndex(focusablesTempList.indexOf(this));
4631 focusablesTempList.clear();
Svetoslav Ganov30401322011-05-12 18:53:45 -07004632 }
4633 }
4634
4635 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004636 * Returns an {@link AccessibilityNodeInfo} representing this view from the
4637 * point of view of an {@link android.accessibilityservice.AccessibilityService}.
4638 * This method is responsible for obtaining an accessibility node info from a
4639 * pool of reusable instances and calling
4640 * {@link #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} on this view to
4641 * initialize the former.
4642 * <p>
4643 * Note: The client is responsible for recycling the obtained instance by calling
4644 * {@link AccessibilityNodeInfo#recycle()} to minimize object creation.
4645 * </p>
Svetoslav Ganov02107852011-10-03 17:06:56 -07004646 *
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004647 * @return A populated {@link AccessibilityNodeInfo}.
4648 *
4649 * @see AccessibilityNodeInfo
4650 */
4651 public AccessibilityNodeInfo createAccessibilityNodeInfo() {
Svetoslav Ganov02107852011-10-03 17:06:56 -07004652 AccessibilityNodeProvider provider = getAccessibilityNodeProvider();
4653 if (provider != null) {
4654 return provider.createAccessibilityNodeInfo(View.NO_ID);
4655 } else {
4656 AccessibilityNodeInfo info = AccessibilityNodeInfo.obtain(this);
4657 onInitializeAccessibilityNodeInfo(info);
4658 return info;
4659 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004660 }
4661
4662 /**
4663 * Initializes an {@link AccessibilityNodeInfo} with information about this view.
4664 * The base implementation sets:
4665 * <ul>
4666 * <li>{@link AccessibilityNodeInfo#setParent(View)},</li>
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004667 * <li>{@link AccessibilityNodeInfo#setBoundsInParent(Rect)},</li>
4668 * <li>{@link AccessibilityNodeInfo#setBoundsInScreen(Rect)},</li>
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004669 * <li>{@link AccessibilityNodeInfo#setPackageName(CharSequence)},</li>
4670 * <li>{@link AccessibilityNodeInfo#setClassName(CharSequence)},</li>
4671 * <li>{@link AccessibilityNodeInfo#setContentDescription(CharSequence)},</li>
4672 * <li>{@link AccessibilityNodeInfo#setEnabled(boolean)},</li>
4673 * <li>{@link AccessibilityNodeInfo#setClickable(boolean)},</li>
4674 * <li>{@link AccessibilityNodeInfo#setFocusable(boolean)},</li>
4675 * <li>{@link AccessibilityNodeInfo#setFocused(boolean)},</li>
4676 * <li>{@link AccessibilityNodeInfo#setLongClickable(boolean)},</li>
4677 * <li>{@link AccessibilityNodeInfo#setSelected(boolean)},</li>
4678 * </ul>
4679 * <p>
4680 * Subclasses should override this method, call the super implementation,
4681 * and set additional attributes.
4682 * </p>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004683 * <p>
4684 * If an {@link AccessibilityDelegate} has been specified via calling
4685 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4686 * {@link AccessibilityDelegate#onInitializeAccessibilityNodeInfo(View, AccessibilityNodeInfo)}
4687 * is responsible for handling this call.
4688 * </p>
4689 *
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004690 * @param info The instance to initialize.
4691 */
4692 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004693 if (mAccessibilityDelegate != null) {
4694 mAccessibilityDelegate.onInitializeAccessibilityNodeInfo(this, info);
4695 } else {
4696 onInitializeAccessibilityNodeInfoInternal(info);
4697 }
4698 }
4699
4700 /**
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004701 * Gets the location of this view in screen coordintates.
4702 *
4703 * @param outRect The output location
4704 */
4705 private void getBoundsOnScreen(Rect outRect) {
4706 if (mAttachInfo == null) {
4707 return;
4708 }
4709
4710 RectF position = mAttachInfo.mTmpTransformRect;
Svetoslav Ganov14b2b742012-05-08 16:36:34 -07004711 position.set(0, 0, mRight - mLeft, mBottom - mTop);
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004712
4713 if (!hasIdentityMatrix()) {
4714 getMatrix().mapRect(position);
4715 }
4716
Svetoslav Ganov14b2b742012-05-08 16:36:34 -07004717 position.offset(mLeft, mTop);
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004718
4719 ViewParent parent = mParent;
4720 while (parent instanceof View) {
4721 View parentView = (View) parent;
4722
4723 position.offset(-parentView.mScrollX, -parentView.mScrollY);
4724
4725 if (!parentView.hasIdentityMatrix()) {
4726 parentView.getMatrix().mapRect(position);
4727 }
4728
4729 position.offset(parentView.mLeft, parentView.mTop);
4730
4731 parent = parentView.mParent;
4732 }
4733
4734 if (parent instanceof ViewRootImpl) {
4735 ViewRootImpl viewRootImpl = (ViewRootImpl) parent;
4736 position.offset(0, -viewRootImpl.mCurScrollY);
4737 }
4738
4739 position.offset(mAttachInfo.mWindowLeft, mAttachInfo.mWindowTop);
4740
4741 outRect.set((int) (position.left + 0.5f), (int) (position.top + 0.5f),
4742 (int) (position.right + 0.5f), (int) (position.bottom + 0.5f));
4743 }
4744
4745 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004746 * @see #onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
4747 *
4748 * Note: Called from the default {@link AccessibilityDelegate}.
4749 */
4750 void onInitializeAccessibilityNodeInfoInternal(AccessibilityNodeInfo info) {
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004751 Rect bounds = mAttachInfo.mTmpInvalRect;
4752 getDrawingRect(bounds);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004753 info.setBoundsInParent(bounds);
4754
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004755 getBoundsOnScreen(bounds);
Svetoslav Ganoveeee4d22011-06-10 20:51:30 -07004756 info.setBoundsInScreen(bounds);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004757
Svetoslav Ganovc406be92012-05-11 16:12:32 -07004758 ViewParent parent = getParentForAccessibility();
4759 if (parent instanceof View) {
4760 info.setParent((View) parent);
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004761 }
4762
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004763 info.setVisibleToUser(isVisibleToUser());
4764
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004765 info.setPackageName(mContext.getPackageName());
Svetoslav Ganov8a78fd42012-01-17 14:36:46 -08004766 info.setClassName(View.class.getName());
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004767 info.setContentDescription(getContentDescription());
4768
4769 info.setEnabled(isEnabled());
4770 info.setClickable(isClickable());
4771 info.setFocusable(isFocusable());
4772 info.setFocused(isFocused());
Svetoslav Ganov42138042012-03-20 11:51:39 -07004773 info.setAccessibilityFocused(isAccessibilityFocused());
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004774 info.setSelected(isSelected());
4775 info.setLongClickable(isLongClickable());
4776
4777 // TODO: These make sense only if we are in an AdapterView but all
4778 // views can be selected. Maybe from accessiiblity perspective
4779 // we should report as selectable view in an AdapterView.
4780 info.addAction(AccessibilityNodeInfo.ACTION_SELECT);
4781 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_SELECTION);
4782
4783 if (isFocusable()) {
4784 if (isFocused()) {
4785 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_FOCUS);
4786 } else {
4787 info.addAction(AccessibilityNodeInfo.ACTION_FOCUS);
4788 }
4789 }
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004790
Svetoslav Ganov02afe2c2012-05-07 17:51:59 -07004791 if (!isAccessibilityFocused()) {
4792 info.addAction(AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS);
4793 } else {
4794 info.addAction(AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS);
4795 }
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004796
Svetoslav Ganovfb1e80a2012-05-16 17:33:19 -07004797 if (isClickable() && isEnabled()) {
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004798 info.addAction(AccessibilityNodeInfo.ACTION_CLICK);
4799 }
4800
Svetoslav Ganovfb1e80a2012-05-16 17:33:19 -07004801 if (isLongClickable() && isEnabled()) {
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004802 info.addAction(AccessibilityNodeInfo.ACTION_LONG_CLICK);
4803 }
4804
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07004805 if (mContentDescription != null && mContentDescription.length() > 0) {
Svetoslav Ganov2b435aa2012-05-04 17:16:37 -07004806 info.addAction(AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY);
4807 info.addAction(AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY);
4808 info.setMovementGranularities(AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07004809 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD
4810 | AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH);
Svetoslav Ganovcfcff982012-04-28 15:31:09 -07004811 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004812 }
4813
4814 /**
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07004815 * Computes whether this view is visible to the user. Such a view is
4816 * attached, visible, all its predecessors are visible, it is not clipped
4817 * entirely by its predecessors, and has an alpha greater than zero.
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004818 *
4819 * @return Whether the view is visible on the screen.
Guang Zhu0d607fb2012-05-11 19:34:56 -07004820 *
4821 * @hide
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004822 */
Guang Zhu0d607fb2012-05-11 19:34:56 -07004823 protected boolean isVisibleToUser() {
4824 return isVisibleToUser(null);
4825 }
4826
4827 /**
4828 * Computes whether the given portion of this view is visible to the user. Such a view is
4829 * attached, visible, all its predecessors are visible, has an alpha greater than zero, and
4830 * the specified portion is not clipped entirely by its predecessors.
4831 *
4832 * @param boundInView the portion of the view to test; coordinates should be relative; may be
4833 * <code>null</code>, and the entire view will be tested in this case.
4834 * When <code>true</code> is returned by the function, the actual visible
4835 * region will be stored in this parameter; that is, if boundInView is fully
4836 * contained within the view, no modification will be made, otherwise regions
4837 * outside of the visible area of the view will be clipped.
4838 *
4839 * @return Whether the specified portion of the view is visible on the screen.
4840 *
4841 * @hide
4842 */
4843 protected boolean isVisibleToUser(Rect boundInView) {
4844 Rect visibleRect = mAttachInfo.mTmpInvalRect;
4845 Point offset = mAttachInfo.mPoint;
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004846 // The first two checks are made also made by isShown() which
4847 // however traverses the tree up to the parent to catch that.
4848 // Therefore, we do some fail fast check to minimize the up
4849 // tree traversal.
Guang Zhu0d607fb2012-05-11 19:34:56 -07004850 boolean isVisible = mAttachInfo != null
4851 && mAttachInfo.mWindowVisibility == View.VISIBLE
4852 && getAlpha() > 0
4853 && isShown()
4854 && getGlobalVisibleRect(visibleRect, offset);
4855 if (isVisible && boundInView != null) {
4856 visibleRect.offset(-offset.x, -offset.y);
4857 isVisible &= boundInView.intersect(visibleRect);
4858 }
4859 return isVisible;
Svetoslav Ganov749e7962012-04-19 17:13:46 -07004860 }
4861
4862 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -07004863 * Sets a delegate for implementing accessibility support via compositon as
4864 * opposed to inheritance. The delegate's primary use is for implementing
4865 * backwards compatible widgets. For more details see {@link AccessibilityDelegate}.
4866 *
4867 * @param delegate The delegate instance.
4868 *
4869 * @see AccessibilityDelegate
4870 */
4871 public void setAccessibilityDelegate(AccessibilityDelegate delegate) {
4872 mAccessibilityDelegate = delegate;
4873 }
4874
4875 /**
Svetoslav Ganov02107852011-10-03 17:06:56 -07004876 * Gets the provider for managing a virtual view hierarchy rooted at this View
4877 * and reported to {@link android.accessibilityservice.AccessibilityService}s
4878 * that explore the window content.
4879 * <p>
4880 * If this method returns an instance, this instance is responsible for managing
4881 * {@link AccessibilityNodeInfo}s describing the virtual sub-tree rooted at this
4882 * View including the one representing the View itself. Similarly the returned
4883 * instance is responsible for performing accessibility actions on any virtual
4884 * view or the root view itself.
4885 * </p>
4886 * <p>
4887 * If an {@link AccessibilityDelegate} has been specified via calling
4888 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
4889 * {@link AccessibilityDelegate#getAccessibilityNodeProvider(View)}
4890 * is responsible for handling this call.
4891 * </p>
4892 *
4893 * @return The provider.
4894 *
4895 * @see AccessibilityNodeProvider
4896 */
4897 public AccessibilityNodeProvider getAccessibilityNodeProvider() {
4898 if (mAccessibilityDelegate != null) {
4899 return mAccessibilityDelegate.getAccessibilityNodeProvider(this);
4900 } else {
4901 return null;
4902 }
4903 }
4904
4905 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07004906 * Gets the unique identifier of this view on the screen for accessibility purposes.
4907 * If this {@link View} is not attached to any window, {@value #NO_ID} is returned.
4908 *
4909 * @return The view accessibility id.
4910 *
4911 * @hide
4912 */
4913 public int getAccessibilityViewId() {
4914 if (mAccessibilityViewId == NO_ID) {
4915 mAccessibilityViewId = sNextAccessibilityViewId++;
4916 }
4917 return mAccessibilityViewId;
4918 }
4919
4920 /**
4921 * Gets the unique identifier of the window in which this View reseides.
4922 *
4923 * @return The window accessibility id.
4924 *
4925 * @hide
4926 */
4927 public int getAccessibilityWindowId() {
4928 return mAttachInfo != null ? mAttachInfo.mAccessibilityWindowId : NO_ID;
4929 }
4930
4931 /**
svetoslavganov75986cf2009-05-14 22:28:01 -07004932 * Gets the {@link View} description. It briefly describes the view and is
4933 * primarily used for accessibility support. Set this property to enable
4934 * better accessibility support for your application. This is especially
4935 * true for views that do not have textual representation (For example,
4936 * ImageButton).
4937 *
Svetoslav Ganov42138042012-03-20 11:51:39 -07004938 * @return The content description.
svetoslavganov75986cf2009-05-14 22:28:01 -07004939 *
4940 * @attr ref android.R.styleable#View_contentDescription
4941 */
Svetoslav Ganov42138042012-03-20 11:51:39 -07004942 @ViewDebug.ExportedProperty(category = "accessibility")
svetoslavganov75986cf2009-05-14 22:28:01 -07004943 public CharSequence getContentDescription() {
4944 return mContentDescription;
4945 }
4946
4947 /**
4948 * Sets the {@link View} description. It briefly describes the view and is
4949 * primarily used for accessibility support. Set this property to enable
4950 * better accessibility support for your application. This is especially
4951 * true for views that do not have textual representation (For example,
4952 * ImageButton).
4953 *
4954 * @param contentDescription The content description.
4955 *
4956 * @attr ref android.R.styleable#View_contentDescription
4957 */
Svetoslav Ganove261e282011-10-18 17:47:04 -07004958 @RemotableViewMethod
svetoslavganov75986cf2009-05-14 22:28:01 -07004959 public void setContentDescription(CharSequence contentDescription) {
4960 mContentDescription = contentDescription;
4961 }
4962
4963 /**
Romain Guya2431d02009-04-30 16:30:00 -07004964 * Invoked whenever this view loses focus, either by losing window focus or by losing
4965 * focus within its window. This method can be used to clear any state tied to the
4966 * focus. For instance, if a button is held pressed with the trackball and the window
4967 * loses focus, this method can be used to cancel the press.
4968 *
4969 * Subclasses of View overriding this method should always call super.onFocusLost().
4970 *
4971 * @see #onFocusChanged(boolean, int, android.graphics.Rect)
Romain Guy8506ab42009-06-11 17:35:47 -07004972 * @see #onWindowFocusChanged(boolean)
Romain Guya2431d02009-04-30 16:30:00 -07004973 *
4974 * @hide pending API council approval
4975 */
4976 protected void onFocusLost() {
4977 resetPressedState();
4978 }
4979
4980 private void resetPressedState() {
4981 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
4982 return;
4983 }
4984
4985 if (isPressed()) {
4986 setPressed(false);
4987
4988 if (!mHasPerformedLongPress) {
Maryam Garrett1549dd12009-12-15 16:06:36 -05004989 removeLongPressCallback();
Romain Guya2431d02009-04-30 16:30:00 -07004990 }
4991 }
4992 }
4993
4994 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004995 * Returns true if this view has focus
4996 *
4997 * @return True if this view has focus, false otherwise.
4998 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07004999 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005000 public boolean isFocused() {
5001 return (mPrivateFlags & FOCUSED) != 0;
5002 }
5003
5004 /**
5005 * Find the view in the hierarchy rooted at this view that currently has
5006 * focus.
5007 *
5008 * @return The view that currently has focus, or null if no focused view can
5009 * be found.
5010 */
5011 public View findFocus() {
5012 return (mPrivateFlags & FOCUSED) != 0 ? this : null;
5013 }
5014
5015 /**
Philip Milne6c8ea062012-04-03 17:38:43 -07005016 * Indicates whether this view is one of the set of scrollable containers in
5017 * its window.
5018 *
5019 * @return whether this view is one of the set of scrollable containers in
5020 * its window
5021 *
5022 * @attr ref android.R.styleable#View_isScrollContainer
5023 */
5024 public boolean isScrollContainer() {
5025 return (mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0;
5026 }
5027
5028 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005029 * Change whether this view is one of the set of scrollable containers in
5030 * its window. This will be used to determine whether the window can
5031 * resize or must pan when a soft input area is open -- scrollable
5032 * containers allow the window to use resize mode since the container
5033 * will appropriately shrink.
Philip Milne6c8ea062012-04-03 17:38:43 -07005034 *
5035 * @attr ref android.R.styleable#View_isScrollContainer
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005036 */
5037 public void setScrollContainer(boolean isScrollContainer) {
5038 if (isScrollContainer) {
5039 if (mAttachInfo != null && (mPrivateFlags&SCROLL_CONTAINER_ADDED) == 0) {
5040 mAttachInfo.mScrollContainers.add(this);
5041 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
5042 }
5043 mPrivateFlags |= SCROLL_CONTAINER;
5044 } else {
5045 if ((mPrivateFlags&SCROLL_CONTAINER_ADDED) != 0) {
5046 mAttachInfo.mScrollContainers.remove(this);
5047 }
5048 mPrivateFlags &= ~(SCROLL_CONTAINER|SCROLL_CONTAINER_ADDED);
5049 }
5050 }
5051
5052 /**
5053 * Returns the quality of the drawing cache.
5054 *
5055 * @return One of {@link #DRAWING_CACHE_QUALITY_AUTO},
5056 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
5057 *
5058 * @see #setDrawingCacheQuality(int)
5059 * @see #setDrawingCacheEnabled(boolean)
5060 * @see #isDrawingCacheEnabled()
5061 *
5062 * @attr ref android.R.styleable#View_drawingCacheQuality
5063 */
5064 public int getDrawingCacheQuality() {
5065 return mViewFlags & DRAWING_CACHE_QUALITY_MASK;
5066 }
5067
5068 /**
5069 * Set the drawing cache quality of this view. This value is used only when the
5070 * drawing cache is enabled
5071 *
5072 * @param quality One of {@link #DRAWING_CACHE_QUALITY_AUTO},
5073 * {@link #DRAWING_CACHE_QUALITY_LOW}, or {@link #DRAWING_CACHE_QUALITY_HIGH}
5074 *
5075 * @see #getDrawingCacheQuality()
5076 * @see #setDrawingCacheEnabled(boolean)
5077 * @see #isDrawingCacheEnabled()
5078 *
5079 * @attr ref android.R.styleable#View_drawingCacheQuality
5080 */
5081 public void setDrawingCacheQuality(int quality) {
5082 setFlags(quality, DRAWING_CACHE_QUALITY_MASK);
5083 }
5084
5085 /**
5086 * Returns whether the screen should remain on, corresponding to the current
5087 * value of {@link #KEEP_SCREEN_ON}.
5088 *
5089 * @return Returns true if {@link #KEEP_SCREEN_ON} is set.
5090 *
5091 * @see #setKeepScreenOn(boolean)
5092 *
5093 * @attr ref android.R.styleable#View_keepScreenOn
5094 */
5095 public boolean getKeepScreenOn() {
5096 return (mViewFlags & KEEP_SCREEN_ON) != 0;
5097 }
5098
5099 /**
5100 * Controls whether the screen should remain on, modifying the
5101 * value of {@link #KEEP_SCREEN_ON}.
5102 *
5103 * @param keepScreenOn Supply true to set {@link #KEEP_SCREEN_ON}.
5104 *
5105 * @see #getKeepScreenOn()
5106 *
5107 * @attr ref android.R.styleable#View_keepScreenOn
5108 */
5109 public void setKeepScreenOn(boolean keepScreenOn) {
5110 setFlags(keepScreenOn ? KEEP_SCREEN_ON : 0, KEEP_SCREEN_ON);
5111 }
5112
5113 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005114 * Gets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
5115 * @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 -08005116 *
5117 * @attr ref android.R.styleable#View_nextFocusLeft
5118 */
5119 public int getNextFocusLeftId() {
5120 return mNextFocusLeftId;
5121 }
5122
5123 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005124 * Sets the id of the view to use when the next focus is {@link #FOCUS_LEFT}.
5125 * @param nextFocusLeftId The next focus ID, or {@link #NO_ID} if the framework should
5126 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005127 *
5128 * @attr ref android.R.styleable#View_nextFocusLeft
5129 */
5130 public void setNextFocusLeftId(int nextFocusLeftId) {
5131 mNextFocusLeftId = nextFocusLeftId;
5132 }
5133
5134 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005135 * Gets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
5136 * @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 -08005137 *
5138 * @attr ref android.R.styleable#View_nextFocusRight
5139 */
5140 public int getNextFocusRightId() {
5141 return mNextFocusRightId;
5142 }
5143
5144 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005145 * Sets the id of the view to use when the next focus is {@link #FOCUS_RIGHT}.
5146 * @param nextFocusRightId The next focus ID, or {@link #NO_ID} if the framework should
5147 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005148 *
5149 * @attr ref android.R.styleable#View_nextFocusRight
5150 */
5151 public void setNextFocusRightId(int nextFocusRightId) {
5152 mNextFocusRightId = nextFocusRightId;
5153 }
5154
5155 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005156 * Gets the id of the view to use when the next focus is {@link #FOCUS_UP}.
5157 * @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 -08005158 *
5159 * @attr ref android.R.styleable#View_nextFocusUp
5160 */
5161 public int getNextFocusUpId() {
5162 return mNextFocusUpId;
5163 }
5164
5165 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005166 * Sets the id of the view to use when the next focus is {@link #FOCUS_UP}.
5167 * @param nextFocusUpId The next focus ID, or {@link #NO_ID} if the framework should
5168 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005169 *
5170 * @attr ref android.R.styleable#View_nextFocusUp
5171 */
5172 public void setNextFocusUpId(int nextFocusUpId) {
5173 mNextFocusUpId = nextFocusUpId;
5174 }
5175
5176 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005177 * Gets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
5178 * @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 -08005179 *
5180 * @attr ref android.R.styleable#View_nextFocusDown
5181 */
5182 public int getNextFocusDownId() {
5183 return mNextFocusDownId;
5184 }
5185
5186 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005187 * Sets the id of the view to use when the next focus is {@link #FOCUS_DOWN}.
5188 * @param nextFocusDownId The next focus ID, or {@link #NO_ID} if the framework should
5189 * decide automatically.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005190 *
5191 * @attr ref android.R.styleable#View_nextFocusDown
5192 */
5193 public void setNextFocusDownId(int nextFocusDownId) {
5194 mNextFocusDownId = nextFocusDownId;
5195 }
5196
5197 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -08005198 * Gets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
5199 * @return The next focus ID, or {@link #NO_ID} if the framework should decide automatically.
5200 *
5201 * @attr ref android.R.styleable#View_nextFocusForward
5202 */
5203 public int getNextFocusForwardId() {
5204 return mNextFocusForwardId;
5205 }
5206
5207 /**
5208 * Sets the id of the view to use when the next focus is {@link #FOCUS_FORWARD}.
5209 * @param nextFocusForwardId The next focus ID, or {@link #NO_ID} if the framework should
5210 * decide automatically.
5211 *
5212 * @attr ref android.R.styleable#View_nextFocusForward
5213 */
5214 public void setNextFocusForwardId(int nextFocusForwardId) {
5215 mNextFocusForwardId = nextFocusForwardId;
5216 }
5217
5218 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005219 * Returns the visibility of this view and all of its ancestors
5220 *
5221 * @return True if this view and all of its ancestors are {@link #VISIBLE}
5222 */
5223 public boolean isShown() {
5224 View current = this;
5225 //noinspection ConstantConditions
5226 do {
5227 if ((current.mViewFlags & VISIBILITY_MASK) != VISIBLE) {
5228 return false;
5229 }
5230 ViewParent parent = current.mParent;
5231 if (parent == null) {
5232 return false; // We are not attached to the view root
5233 }
5234 if (!(parent instanceof View)) {
5235 return true;
5236 }
5237 current = (View) parent;
5238 } while (current != null);
5239
5240 return false;
5241 }
5242
5243 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005244 * Called by the view hierarchy when the content insets for a window have
5245 * changed, to allow it to adjust its content to fit within those windows.
5246 * The content insets tell you the space that the status bar, input method,
5247 * and other system windows infringe on the application's window.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005248 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005249 * <p>You do not normally need to deal with this function, since the default
5250 * window decoration given to applications takes care of applying it to the
5251 * content of the window. If you use {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}
5252 * or {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION} this will not be the case,
5253 * and your content can be placed under those system elements. You can then
5254 * use this method within your view hierarchy if you have parts of your UI
5255 * which you would like to ensure are not being covered.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005256 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005257 * <p>The default implementation of this method simply applies the content
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005258 * inset's to the view's padding, consuming that content (modifying the
5259 * insets to be 0), and returning true. This behavior is off by default, but can
5260 * be enabled through {@link #setFitsSystemWindows(boolean)}.
5261 *
5262 * <p>This function's traversal down the hierarchy is depth-first. The same content
5263 * insets object is propagated down the hierarchy, so any changes made to it will
5264 * be seen by all following views (including potentially ones above in
5265 * the hierarchy since this is a depth-first traversal). The first view
5266 * that returns true will abort the entire traversal.
5267 *
5268 * <p>The default implementation works well for a situation where it is
5269 * used with a container that covers the entire window, allowing it to
5270 * apply the appropriate insets to its content on all edges. If you need
5271 * a more complicated layout (such as two different views fitting system
5272 * windows, one on the top of the window, and one on the bottom),
5273 * you can override the method and handle the insets however you would like.
5274 * Note that the insets provided by the framework are always relative to the
5275 * far edges of the window, not accounting for the location of the called view
5276 * within that window. (In fact when this method is called you do not yet know
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005277 * where the layout will place the view, as it is done before layout happens.)
5278 *
5279 * <p>Note: unlike many View methods, there is no dispatch phase to this
5280 * call. If you are overriding it in a ViewGroup and want to allow the
5281 * call to continue to your children, you must be sure to call the super
5282 * implementation.
5283 *
Dianne Hackborncf675782012-05-10 15:07:24 -07005284 * <p>Here is a sample layout that makes use of fitting system windows
5285 * to have controls for a video view placed inside of the window decorations
5286 * that it hides and shows. This can be used with code like the second
5287 * sample (video player) shown in {@link #setSystemUiVisibility(int)}.
5288 *
5289 * {@sample development/samples/ApiDemos/res/layout/video_player.xml complete}
5290 *
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005291 * @param insets Current content insets of the window. Prior to
5292 * {@link android.os.Build.VERSION_CODES#JELLY_BEAN} you must not modify
5293 * the insets or else you and Android will be unhappy.
5294 *
5295 * @return Return true if this view applied the insets and it should not
5296 * continue propagating further down the hierarchy, false otherwise.
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005297 * @see #getFitsSystemWindows()
5298 * @see #setFitsSystemWindows()
5299 * @see #setSystemUiVisibility(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005300 */
5301 protected boolean fitSystemWindows(Rect insets) {
5302 if ((mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005303 mUserPaddingStart = -1;
5304 mUserPaddingEnd = -1;
5305 mUserPaddingRelative = false;
5306 if ((mViewFlags & OPTIONAL_FITS_SYSTEM_WINDOWS) == 0
5307 || mAttachInfo == null
5308 || (mAttachInfo.mSystemUiVisibility & SYSTEM_UI_LAYOUT_FLAGS) == 0) {
5309 internalSetPadding(insets.left, insets.top, insets.right, insets.bottom);
5310 return true;
5311 } else {
5312 internalSetPadding(0, 0, 0, 0);
5313 return false;
5314 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005315 }
5316 return false;
5317 }
5318
5319 /**
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005320 * Sets whether or not this view should account for system screen decorations
5321 * such as the status bar and inset its content; that is, controlling whether
5322 * the default implementation of {@link #fitSystemWindows(Rect)} will be
5323 * executed. See that method for more details.
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005324 *
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005325 * <p>Note that if you are providing your own implementation of
5326 * {@link #fitSystemWindows(Rect)}, then there is no need to set this
5327 * flag to true -- your implementation will be overriding the default
5328 * implementation that checks this flag.
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005329 *
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005330 * @param fitSystemWindows If true, then the default implementation of
5331 * {@link #fitSystemWindows(Rect)} will be executed.
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005332 *
5333 * @attr ref android.R.styleable#View_fitsSystemWindows
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005334 * @see #getFitsSystemWindows()
5335 * @see #fitSystemWindows(Rect)
5336 * @see #setSystemUiVisibility(int)
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005337 */
5338 public void setFitsSystemWindows(boolean fitSystemWindows) {
5339 setFlags(fitSystemWindows ? FITS_SYSTEM_WINDOWS : 0, FITS_SYSTEM_WINDOWS);
5340 }
5341
5342 /**
Dianne Hackborncf675782012-05-10 15:07:24 -07005343 * Check for state of {@link #setFitsSystemWindows(boolean). If this method
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005344 * returns true, the default implementation of {@link #fitSystemWindows(Rect)}
5345 * will be executed.
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005346 *
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005347 * @return Returns true if the default implementation of
5348 * {@link #fitSystemWindows(Rect)} will be executed.
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005349 *
5350 * @attr ref android.R.styleable#View_fitsSystemWindows
Dianne Hackbornd5333f92012-05-18 10:51:35 -07005351 * @see #setFitsSystemWindows()
5352 * @see #fitSystemWindows(Rect)
5353 * @see #setSystemUiVisibility(int)
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005354 */
Dianne Hackborncf675782012-05-10 15:07:24 -07005355 public boolean getFitsSystemWindows() {
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005356 return (mViewFlags & FITS_SYSTEM_WINDOWS) == FITS_SYSTEM_WINDOWS;
5357 }
5358
Dianne Hackbornb1b55e62012-05-10 16:25:54 -07005359 /** @hide */
5360 public boolean fitsSystemWindows() {
5361 return getFitsSystemWindows();
5362 }
5363
Adam Powell0bd1d0a2011-07-22 19:35:06 -07005364 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07005365 * Ask that a new dispatch of {@link #fitSystemWindows(Rect)} be performed.
5366 */
5367 public void requestFitSystemWindows() {
5368 if (mParent != null) {
5369 mParent.requestFitSystemWindows();
5370 }
5371 }
5372
5373 /**
5374 * For use by PhoneWindow to make its own system window fitting optional.
5375 * @hide
5376 */
5377 public void makeOptionalFitsSystemWindows() {
5378 setFlags(OPTIONAL_FITS_SYSTEM_WINDOWS, OPTIONAL_FITS_SYSTEM_WINDOWS);
5379 }
5380
5381 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005382 * Returns the visibility status for this view.
5383 *
5384 * @return One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
5385 * @attr ref android.R.styleable#View_visibility
5386 */
5387 @ViewDebug.ExportedProperty(mapping = {
The Android Open Source Projectc39a6e02009-03-11 12:11:56 -07005388 @ViewDebug.IntToString(from = VISIBLE, to = "VISIBLE"),
5389 @ViewDebug.IntToString(from = INVISIBLE, to = "INVISIBLE"),
5390 @ViewDebug.IntToString(from = GONE, to = "GONE")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005391 })
5392 public int getVisibility() {
5393 return mViewFlags & VISIBILITY_MASK;
5394 }
5395
5396 /**
5397 * Set the enabled state of this view.
5398 *
5399 * @param visibility One of {@link #VISIBLE}, {@link #INVISIBLE}, or {@link #GONE}.
5400 * @attr ref android.R.styleable#View_visibility
5401 */
5402 @RemotableViewMethod
5403 public void setVisibility(int visibility) {
5404 setFlags(visibility, VISIBILITY_MASK);
Philip Milne6c8ea062012-04-03 17:38:43 -07005405 if (mBackground != null) mBackground.setVisible(visibility == VISIBLE, false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005406 }
5407
5408 /**
5409 * Returns the enabled status for this view. The interpretation of the
5410 * enabled state varies by subclass.
5411 *
5412 * @return True if this view is enabled, false otherwise.
5413 */
5414 @ViewDebug.ExportedProperty
5415 public boolean isEnabled() {
5416 return (mViewFlags & ENABLED_MASK) == ENABLED;
5417 }
5418
5419 /**
5420 * Set the enabled state of this view. The interpretation of the enabled
5421 * state varies by subclass.
5422 *
5423 * @param enabled True if this view is enabled, false otherwise.
5424 */
Jeff Sharkey2b95c242010-02-08 17:40:30 -08005425 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005426 public void setEnabled(boolean enabled) {
Amith Yamasania2ef00b2009-07-30 16:14:34 -07005427 if (enabled == isEnabled()) return;
5428
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005429 setFlags(enabled ? ENABLED : DISABLED, ENABLED_MASK);
5430
5431 /*
5432 * The View most likely has to change its appearance, so refresh
5433 * the drawable state.
5434 */
5435 refreshDrawableState();
5436
5437 // Invalidate too, since the default behavior for views is to be
5438 // be drawn at 50% alpha rather than to change the drawable.
Romain Guy0fd89bf2011-01-26 15:41:30 -08005439 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005440 }
5441
5442 /**
5443 * Set whether this view can receive the focus.
5444 *
5445 * Setting this to false will also ensure that this view is not focusable
5446 * in touch mode.
5447 *
5448 * @param focusable If true, this view can receive the focus.
5449 *
5450 * @see #setFocusableInTouchMode(boolean)
5451 * @attr ref android.R.styleable#View_focusable
5452 */
5453 public void setFocusable(boolean focusable) {
5454 if (!focusable) {
5455 setFlags(0, FOCUSABLE_IN_TOUCH_MODE);
5456 }
5457 setFlags(focusable ? FOCUSABLE : NOT_FOCUSABLE, FOCUSABLE_MASK);
5458 }
5459
5460 /**
5461 * Set whether this view can receive focus while in touch mode.
5462 *
5463 * Setting this to true will also ensure that this view is focusable.
5464 *
5465 * @param focusableInTouchMode If true, this view can receive the focus while
5466 * in touch mode.
5467 *
5468 * @see #setFocusable(boolean)
5469 * @attr ref android.R.styleable#View_focusableInTouchMode
5470 */
5471 public void setFocusableInTouchMode(boolean focusableInTouchMode) {
5472 // Focusable in touch mode should always be set before the focusable flag
5473 // otherwise, setting the focusable flag will trigger a focusableViewAvailable()
5474 // which, in touch mode, will not successfully request focus on this view
5475 // because the focusable in touch mode flag is not set
5476 setFlags(focusableInTouchMode ? FOCUSABLE_IN_TOUCH_MODE : 0, FOCUSABLE_IN_TOUCH_MODE);
5477 if (focusableInTouchMode) {
5478 setFlags(FOCUSABLE, FOCUSABLE_MASK);
5479 }
5480 }
5481
5482 /**
5483 * Set whether this view should have sound effects enabled for events such as
5484 * clicking and touching.
5485 *
5486 * <p>You may wish to disable sound effects for a view if you already play sounds,
5487 * for instance, a dial key that plays dtmf tones.
5488 *
5489 * @param soundEffectsEnabled whether sound effects are enabled for this view.
5490 * @see #isSoundEffectsEnabled()
5491 * @see #playSoundEffect(int)
5492 * @attr ref android.R.styleable#View_soundEffectsEnabled
5493 */
5494 public void setSoundEffectsEnabled(boolean soundEffectsEnabled) {
5495 setFlags(soundEffectsEnabled ? SOUND_EFFECTS_ENABLED: 0, SOUND_EFFECTS_ENABLED);
5496 }
5497
5498 /**
5499 * @return whether this view should have sound effects enabled for events such as
5500 * clicking and touching.
5501 *
5502 * @see #setSoundEffectsEnabled(boolean)
5503 * @see #playSoundEffect(int)
5504 * @attr ref android.R.styleable#View_soundEffectsEnabled
5505 */
5506 @ViewDebug.ExportedProperty
5507 public boolean isSoundEffectsEnabled() {
5508 return SOUND_EFFECTS_ENABLED == (mViewFlags & SOUND_EFFECTS_ENABLED);
5509 }
5510
5511 /**
5512 * Set whether this view should have haptic feedback for events such as
5513 * long presses.
5514 *
5515 * <p>You may wish to disable haptic feedback if your view already controls
5516 * its own haptic feedback.
5517 *
5518 * @param hapticFeedbackEnabled whether haptic feedback enabled for this view.
5519 * @see #isHapticFeedbackEnabled()
5520 * @see #performHapticFeedback(int)
5521 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
5522 */
5523 public void setHapticFeedbackEnabled(boolean hapticFeedbackEnabled) {
5524 setFlags(hapticFeedbackEnabled ? HAPTIC_FEEDBACK_ENABLED: 0, HAPTIC_FEEDBACK_ENABLED);
5525 }
5526
5527 /**
5528 * @return whether this view should have haptic feedback enabled for events
5529 * long presses.
5530 *
5531 * @see #setHapticFeedbackEnabled(boolean)
5532 * @see #performHapticFeedback(int)
5533 * @attr ref android.R.styleable#View_hapticFeedbackEnabled
5534 */
5535 @ViewDebug.ExportedProperty
5536 public boolean isHapticFeedbackEnabled() {
5537 return HAPTIC_FEEDBACK_ENABLED == (mViewFlags & HAPTIC_FEEDBACK_ENABLED);
5538 }
5539
5540 /**
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005541 * Returns the layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08005542 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005543 * @return One of {@link #LAYOUT_DIRECTION_LTR},
5544 * {@link #LAYOUT_DIRECTION_RTL},
5545 * {@link #LAYOUT_DIRECTION_INHERIT} or
5546 * {@link #LAYOUT_DIRECTION_LOCALE}.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005547 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005548 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005549 * @hide
Cibu Johny7632cb92010-02-22 13:01:02 -08005550 */
Fabrice Di Megliobce84d22011-06-02 15:57:01 -07005551 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005552 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "LTR"),
5553 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RTL"),
5554 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_INHERIT, to = "INHERIT"),
5555 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LOCALE, to = "LOCALE")
Cibu Johny7632cb92010-02-22 13:01:02 -08005556 })
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005557 public int getLayoutDirection() {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005558 return (mPrivateFlags2 & LAYOUT_DIRECTION_MASK) >> LAYOUT_DIRECTION_MASK_SHIFT;
Cibu Johny7632cb92010-02-22 13:01:02 -08005559 }
5560
5561 /**
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005562 * Set the layout direction for this view. This will propagate a reset of layout direction
5563 * resolution to the view's children and resolve layout direction for this view.
Cibu Johny7632cb92010-02-22 13:01:02 -08005564 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005565 * @param layoutDirection One of {@link #LAYOUT_DIRECTION_LTR},
5566 * {@link #LAYOUT_DIRECTION_RTL},
5567 * {@link #LAYOUT_DIRECTION_INHERIT} or
5568 * {@link #LAYOUT_DIRECTION_LOCALE}.
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005569 *
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005570 * @attr ref android.R.styleable#View_layoutDirection
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005571 * @hide
Cibu Johny7632cb92010-02-22 13:01:02 -08005572 */
5573 @RemotableViewMethod
Fabrice Di Meglioc46f7ff2011-06-06 18:23:10 -07005574 public void setLayoutDirection(int layoutDirection) {
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005575 if (getLayoutDirection() != layoutDirection) {
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -07005576 // Reset the current layout direction and the resolved one
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005577 mPrivateFlags2 &= ~LAYOUT_DIRECTION_MASK;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -07005578 resetResolvedLayoutDirection();
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005579 // Set the new layout direction (filtered) and ask for a layout pass
5580 mPrivateFlags2 |=
5581 ((layoutDirection << LAYOUT_DIRECTION_MASK_SHIFT) & LAYOUT_DIRECTION_MASK);
5582 requestLayout();
Fabrice Di Meglio80dc53d2011-06-21 18:36:33 -07005583 }
Cibu Johny7632cb92010-02-22 13:01:02 -08005584 }
5585
5586 /**
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005587 * Returns the resolved layout direction for this view.
5588 *
5589 * @return {@link #LAYOUT_DIRECTION_RTL} if the layout direction is RTL or returns
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005590 * {@link #LAYOUT_DIRECTION_LTR} if the layout direction is not RTL.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005591 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005592 */
5593 @ViewDebug.ExportedProperty(category = "layout", mapping = {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005594 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_LTR, to = "RESOLVED_DIRECTION_LTR"),
5595 @ViewDebug.IntToString(from = LAYOUT_DIRECTION_RTL, to = "RESOLVED_DIRECTION_RTL")
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005596 })
5597 public int getResolvedLayoutDirection() {
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -07005598 // The layout diretion will be resolved only if needed
5599 if ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED) != LAYOUT_DIRECTION_RESOLVED) {
5600 resolveLayoutDirection();
5601 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -07005602 return ((mPrivateFlags2 & LAYOUT_DIRECTION_RESOLVED_RTL) == LAYOUT_DIRECTION_RESOLVED_RTL) ?
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005603 LAYOUT_DIRECTION_RTL : LAYOUT_DIRECTION_LTR;
5604 }
5605
5606 /**
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -07005607 * Indicates whether or not this view's layout is right-to-left. This is resolved from
5608 * layout attribute and/or the inherited value from the parent
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005609 *
5610 * @return true if the layout is right-to-left.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -07005611 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -07005612 */
5613 @ViewDebug.ExportedProperty(category = "layout")
5614 public boolean isLayoutRtl() {
5615 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL);
5616 }
5617
5618 /**
Adam Powell539ee872012-02-03 19:00:49 -08005619 * Indicates whether the view is currently tracking transient state that the
5620 * app should not need to concern itself with saving and restoring, but that
5621 * the framework should take special note to preserve when possible.
5622 *
Adam Powell785c4472012-05-02 21:25:39 -07005623 * <p>A view with transient state cannot be trivially rebound from an external
5624 * data source, such as an adapter binding item views in a list. This may be
5625 * because the view is performing an animation, tracking user selection
5626 * of content, or similar.</p>
5627 *
Adam Powell539ee872012-02-03 19:00:49 -08005628 * @return true if the view has transient state
Adam Powell539ee872012-02-03 19:00:49 -08005629 */
5630 @ViewDebug.ExportedProperty(category = "layout")
5631 public boolean hasTransientState() {
5632 return (mPrivateFlags2 & HAS_TRANSIENT_STATE) == HAS_TRANSIENT_STATE;
5633 }
5634
5635 /**
5636 * Set whether this view is currently tracking transient state that the
Chet Haase563d4f22012-04-18 16:20:08 -07005637 * framework should attempt to preserve when possible. This flag is reference counted,
5638 * so every call to setHasTransientState(true) should be paired with a later call
5639 * to setHasTransientState(false).
Adam Powell539ee872012-02-03 19:00:49 -08005640 *
Adam Powell785c4472012-05-02 21:25:39 -07005641 * <p>A view with transient state cannot be trivially rebound from an external
5642 * data source, such as an adapter binding item views in a list. This may be
5643 * because the view is performing an animation, tracking user selection
5644 * of content, or similar.</p>
5645 *
Adam Powell539ee872012-02-03 19:00:49 -08005646 * @param hasTransientState true if this view has transient state
Adam Powell539ee872012-02-03 19:00:49 -08005647 */
5648 public void setHasTransientState(boolean hasTransientState) {
Chet Haase563d4f22012-04-18 16:20:08 -07005649 mTransientStateCount = hasTransientState ? mTransientStateCount + 1 :
5650 mTransientStateCount - 1;
5651 if (mTransientStateCount < 0) {
5652 mTransientStateCount = 0;
5653 Log.e(VIEW_LOG_TAG, "hasTransientState decremented below 0: " +
5654 "unmatched pair of setHasTransientState calls");
5655 }
5656 if ((hasTransientState && mTransientStateCount == 1) ||
Adam Powell057a5852012-05-11 10:28:38 -07005657 (!hasTransientState && mTransientStateCount == 0)) {
Chet Haase563d4f22012-04-18 16:20:08 -07005658 // update flag if we've just incremented up from 0 or decremented down to 0
5659 mPrivateFlags2 = (mPrivateFlags2 & ~HAS_TRANSIENT_STATE) |
5660 (hasTransientState ? HAS_TRANSIENT_STATE : 0);
5661 if (mParent != null) {
5662 try {
5663 mParent.childHasTransientStateChanged(this, hasTransientState);
5664 } catch (AbstractMethodError e) {
5665 Log.e(VIEW_LOG_TAG, mParent.getClass().getSimpleName() +
5666 " does not fully implement ViewParent", e);
5667 }
Adam Powell539ee872012-02-03 19:00:49 -08005668 }
5669 }
5670 }
5671
5672 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005673 * If this view doesn't do any drawing on its own, set this flag to
5674 * allow further optimizations. By default, this flag is not set on
5675 * View, but could be set on some View subclasses such as ViewGroup.
5676 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07005677 * Typically, if you override {@link #onDraw(android.graphics.Canvas)}
5678 * you should clear this flag.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005679 *
5680 * @param willNotDraw whether or not this View draw on its own
5681 */
5682 public void setWillNotDraw(boolean willNotDraw) {
5683 setFlags(willNotDraw ? WILL_NOT_DRAW : 0, DRAW_MASK);
5684 }
5685
5686 /**
5687 * Returns whether or not this View draws on its own.
5688 *
5689 * @return true if this view has nothing to draw, false otherwise
5690 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005691 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005692 public boolean willNotDraw() {
5693 return (mViewFlags & DRAW_MASK) == WILL_NOT_DRAW;
5694 }
5695
5696 /**
5697 * When a View's drawing cache is enabled, drawing is redirected to an
5698 * offscreen bitmap. Some views, like an ImageView, must be able to
5699 * bypass this mechanism if they already draw a single bitmap, to avoid
5700 * unnecessary usage of the memory.
5701 *
5702 * @param willNotCacheDrawing true if this view does not cache its
5703 * drawing, false otherwise
5704 */
5705 public void setWillNotCacheDrawing(boolean willNotCacheDrawing) {
5706 setFlags(willNotCacheDrawing ? WILL_NOT_CACHE_DRAWING : 0, WILL_NOT_CACHE_DRAWING);
5707 }
5708
5709 /**
5710 * Returns whether or not this View can cache its drawing or not.
5711 *
5712 * @return true if this view does not cache its drawing, false otherwise
5713 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005714 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005715 public boolean willNotCacheDrawing() {
5716 return (mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING;
5717 }
5718
5719 /**
5720 * Indicates whether this view reacts to click events or not.
5721 *
5722 * @return true if the view is clickable, false otherwise
5723 *
5724 * @see #setClickable(boolean)
5725 * @attr ref android.R.styleable#View_clickable
5726 */
5727 @ViewDebug.ExportedProperty
5728 public boolean isClickable() {
5729 return (mViewFlags & CLICKABLE) == CLICKABLE;
5730 }
5731
5732 /**
5733 * Enables or disables click events for this view. When a view
5734 * is clickable it will change its state to "pressed" on every click.
5735 * Subclasses should set the view clickable to visually react to
5736 * user's clicks.
5737 *
5738 * @param clickable true to make the view clickable, false otherwise
5739 *
5740 * @see #isClickable()
5741 * @attr ref android.R.styleable#View_clickable
5742 */
5743 public void setClickable(boolean clickable) {
5744 setFlags(clickable ? CLICKABLE : 0, CLICKABLE);
5745 }
5746
5747 /**
5748 * Indicates whether this view reacts to long click events or not.
5749 *
5750 * @return true if the view is long clickable, false otherwise
5751 *
5752 * @see #setLongClickable(boolean)
5753 * @attr ref android.R.styleable#View_longClickable
5754 */
5755 public boolean isLongClickable() {
5756 return (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
5757 }
5758
5759 /**
5760 * Enables or disables long click events for this view. When a view is long
5761 * clickable it reacts to the user holding down the button for a longer
5762 * duration than a tap. This event can either launch the listener or a
5763 * context menu.
5764 *
5765 * @param longClickable true to make the view long clickable, false otherwise
5766 * @see #isLongClickable()
5767 * @attr ref android.R.styleable#View_longClickable
5768 */
5769 public void setLongClickable(boolean longClickable) {
5770 setFlags(longClickable ? LONG_CLICKABLE : 0, LONG_CLICKABLE);
5771 }
5772
5773 /**
Chet Haase49afa5b2010-08-23 11:39:53 -07005774 * Sets the pressed state for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005775 *
5776 * @see #isClickable()
5777 * @see #setClickable(boolean)
5778 *
5779 * @param pressed Pass true to set the View's internal state to "pressed", or false to reverts
5780 * the View's internal state from a previously set "pressed" state.
5781 */
5782 public void setPressed(boolean pressed) {
Adam Powell035a1fc2012-02-27 15:23:50 -08005783 final boolean needsRefresh = pressed != ((mPrivateFlags & PRESSED) == PRESSED);
Adam Powell4d6f0662012-02-21 15:11:11 -08005784
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005785 if (pressed) {
5786 mPrivateFlags |= PRESSED;
5787 } else {
5788 mPrivateFlags &= ~PRESSED;
5789 }
Adam Powell035a1fc2012-02-27 15:23:50 -08005790
5791 if (needsRefresh) {
5792 refreshDrawableState();
5793 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005794 dispatchSetPressed(pressed);
5795 }
5796
5797 /**
5798 * Dispatch setPressed to all of this View's children.
5799 *
5800 * @see #setPressed(boolean)
5801 *
5802 * @param pressed The new pressed state
5803 */
5804 protected void dispatchSetPressed(boolean pressed) {
5805 }
5806
5807 /**
5808 * Indicates whether the view is currently in pressed state. Unless
5809 * {@link #setPressed(boolean)} is explicitly called, only clickable views can enter
5810 * the pressed state.
5811 *
Philip Milne6c8ea062012-04-03 17:38:43 -07005812 * @see #setPressed(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005813 * @see #isClickable()
5814 * @see #setClickable(boolean)
5815 *
5816 * @return true if the view is currently pressed, false otherwise
5817 */
5818 public boolean isPressed() {
5819 return (mPrivateFlags & PRESSED) == PRESSED;
5820 }
5821
5822 /**
5823 * Indicates whether this view will save its state (that is,
5824 * whether its {@link #onSaveInstanceState} method will be called).
5825 *
5826 * @return Returns true if the view state saving is enabled, else false.
5827 *
5828 * @see #setSaveEnabled(boolean)
5829 * @attr ref android.R.styleable#View_saveEnabled
5830 */
5831 public boolean isSaveEnabled() {
5832 return (mViewFlags & SAVE_DISABLED_MASK) != SAVE_DISABLED;
5833 }
5834
5835 /**
5836 * Controls whether the saving of this view's state is
5837 * enabled (that is, whether its {@link #onSaveInstanceState} method
5838 * will be called). Note that even if freezing is enabled, the
Romain Guy5c22a8c2011-05-13 11:48:45 -07005839 * view still must have an id assigned to it (via {@link #setId(int)})
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005840 * for its state to be saved. This flag can only disable the
5841 * saving of this view; any child views may still have their state saved.
5842 *
5843 * @param enabled Set to false to <em>disable</em> state saving, or true
5844 * (the default) to allow it.
5845 *
5846 * @see #isSaveEnabled()
5847 * @see #setId(int)
5848 * @see #onSaveInstanceState()
5849 * @attr ref android.R.styleable#View_saveEnabled
5850 */
5851 public void setSaveEnabled(boolean enabled) {
5852 setFlags(enabled ? 0 : SAVE_DISABLED, SAVE_DISABLED_MASK);
5853 }
5854
Jeff Brown85a31762010-09-01 17:01:00 -07005855 /**
5856 * Gets whether the framework should discard touches when the view's
5857 * window is obscured by another visible window.
5858 * Refer to the {@link View} security documentation for more details.
5859 *
5860 * @return True if touch filtering is enabled.
5861 *
5862 * @see #setFilterTouchesWhenObscured(boolean)
5863 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
5864 */
5865 @ViewDebug.ExportedProperty
5866 public boolean getFilterTouchesWhenObscured() {
5867 return (mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0;
5868 }
5869
5870 /**
5871 * Sets whether the framework should discard touches when the view's
5872 * window is obscured by another visible window.
5873 * Refer to the {@link View} security documentation for more details.
5874 *
5875 * @param enabled True if touch filtering should be enabled.
5876 *
5877 * @see #getFilterTouchesWhenObscured
5878 * @attr ref android.R.styleable#View_filterTouchesWhenObscured
5879 */
5880 public void setFilterTouchesWhenObscured(boolean enabled) {
5881 setFlags(enabled ? 0 : FILTER_TOUCHES_WHEN_OBSCURED,
5882 FILTER_TOUCHES_WHEN_OBSCURED);
5883 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005884
5885 /**
Dianne Hackbornb4bc78b2010-05-12 18:59:50 -07005886 * Indicates whether the entire hierarchy under this view will save its
5887 * state when a state saving traversal occurs from its parent. The default
5888 * is true; if false, these views will not be saved unless
5889 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
5890 *
5891 * @return Returns true if the view state saving from parent is enabled, else false.
5892 *
5893 * @see #setSaveFromParentEnabled(boolean)
5894 */
5895 public boolean isSaveFromParentEnabled() {
5896 return (mViewFlags & PARENT_SAVE_DISABLED_MASK) != PARENT_SAVE_DISABLED;
5897 }
5898
5899 /**
5900 * Controls whether the entire hierarchy under this view will save its
5901 * state when a state saving traversal occurs from its parent. The default
5902 * is true; if false, these views will not be saved unless
5903 * {@link #saveHierarchyState(SparseArray)} is called directly on this view.
5904 *
5905 * @param enabled Set to false to <em>disable</em> state saving, or true
5906 * (the default) to allow it.
5907 *
5908 * @see #isSaveFromParentEnabled()
5909 * @see #setId(int)
5910 * @see #onSaveInstanceState()
5911 */
5912 public void setSaveFromParentEnabled(boolean enabled) {
5913 setFlags(enabled ? 0 : PARENT_SAVE_DISABLED, PARENT_SAVE_DISABLED_MASK);
5914 }
5915
5916
5917 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005918 * Returns whether this View is able to take focus.
5919 *
5920 * @return True if this view can take focus, or false otherwise.
5921 * @attr ref android.R.styleable#View_focusable
5922 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07005923 @ViewDebug.ExportedProperty(category = "focus")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005924 public final boolean isFocusable() {
5925 return FOCUSABLE == (mViewFlags & FOCUSABLE_MASK);
5926 }
5927
5928 /**
5929 * When a view is focusable, it may not want to take focus when in touch mode.
5930 * For example, a button would like focus when the user is navigating via a D-pad
5931 * so that the user can click on it, but once the user starts touching the screen,
5932 * the button shouldn't take focus
5933 * @return Whether the view is focusable in touch mode.
5934 * @attr ref android.R.styleable#View_focusableInTouchMode
5935 */
5936 @ViewDebug.ExportedProperty
5937 public final boolean isFocusableInTouchMode() {
5938 return FOCUSABLE_IN_TOUCH_MODE == (mViewFlags & FOCUSABLE_IN_TOUCH_MODE);
5939 }
5940
5941 /**
5942 * Find the nearest view in the specified direction that can take focus.
5943 * This does not actually give focus to that view.
5944 *
5945 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
5946 *
5947 * @return The nearest focusable in the specified direction, or null if none
5948 * can be found.
5949 */
5950 public View focusSearch(int direction) {
5951 if (mParent != null) {
5952 return mParent.focusSearch(this, direction);
5953 } else {
5954 return null;
5955 }
5956 }
5957
5958 /**
5959 * This method is the last chance for the focused view and its ancestors to
5960 * respond to an arrow key. This is called when the focused view did not
5961 * consume the key internally, nor could the view system find a new view in
5962 * the requested direction to give focus to.
5963 *
5964 * @param focused The currently focused view.
5965 * @param direction The direction focus wants to move. One of FOCUS_UP,
5966 * FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT.
5967 * @return True if the this view consumed this unhandled move.
5968 */
5969 public boolean dispatchUnhandledMove(View focused, int direction) {
5970 return false;
5971 }
5972
5973 /**
5974 * If a user manually specified the next view id for a particular direction,
Jeff Brown4e6319b2010-12-13 10:36:51 -08005975 * use the root to look up the view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005976 * @param root The root view of the hierarchy containing this view.
Jeff Brown4e6319b2010-12-13 10:36:51 -08005977 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_FORWARD,
5978 * or FOCUS_BACKWARD.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005979 * @return The user specified next view, or null if there is none.
5980 */
5981 View findUserSetNextFocus(View root, int direction) {
5982 switch (direction) {
5983 case FOCUS_LEFT:
5984 if (mNextFocusLeftId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005985 return findViewInsideOutShouldExist(root, mNextFocusLeftId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005986 case FOCUS_RIGHT:
5987 if (mNextFocusRightId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005988 return findViewInsideOutShouldExist(root, mNextFocusRightId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005989 case FOCUS_UP:
5990 if (mNextFocusUpId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005991 return findViewInsideOutShouldExist(root, mNextFocusUpId);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005992 case FOCUS_DOWN:
5993 if (mNextFocusDownId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005994 return findViewInsideOutShouldExist(root, mNextFocusDownId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08005995 case FOCUS_FORWARD:
5996 if (mNextFocusForwardId == View.NO_ID) return null;
Jeff Brown4dfbec22011-08-15 14:55:37 -07005997 return findViewInsideOutShouldExist(root, mNextFocusForwardId);
Jeff Brown4e6319b2010-12-13 10:36:51 -08005998 case FOCUS_BACKWARD: {
John Reck1ecebbb2012-03-06 16:08:54 -08005999 if (mID == View.NO_ID) return null;
Jeff Brown4e6319b2010-12-13 10:36:51 -08006000 final int id = mID;
Jeff Brown4dfbec22011-08-15 14:55:37 -07006001 return root.findViewByPredicateInsideOut(this, new Predicate<View>() {
Jeff Brown4e6319b2010-12-13 10:36:51 -08006002 @Override
6003 public boolean apply(View t) {
6004 return t.mNextFocusForwardId == id;
6005 }
6006 });
6007 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006008 }
6009 return null;
6010 }
6011
Jeff Brown4dfbec22011-08-15 14:55:37 -07006012 private View findViewInsideOutShouldExist(View root, final int childViewId) {
6013 View result = root.findViewByPredicateInsideOut(this, new Predicate<View>() {
6014 @Override
6015 public boolean apply(View t) {
6016 return t.mID == childViewId;
6017 }
6018 });
6019
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006020 if (result == null) {
6021 Log.w(VIEW_LOG_TAG, "couldn't find next focus view specified "
6022 + "by user for id " + childViewId);
6023 }
6024 return result;
6025 }
6026
6027 /**
6028 * Find and return all focusable views that are descendants of this view,
6029 * possibly including this view if it is focusable itself.
6030 *
6031 * @param direction The direction of the focus
6032 * @return A list of focusable views
6033 */
6034 public ArrayList<View> getFocusables(int direction) {
6035 ArrayList<View> result = new ArrayList<View>(24);
6036 addFocusables(result, direction);
6037 return result;
6038 }
6039
6040 /**
6041 * Add any focusable views that are descendants of this view (possibly
6042 * including this view if it is focusable itself) to views. If we are in touch mode,
6043 * only add views that are also focusable in touch mode.
6044 *
6045 * @param views Focusable views found so far
6046 * @param direction The direction of the focus
6047 */
6048 public void addFocusables(ArrayList<View> views, int direction) {
svetoslavganov75986cf2009-05-14 22:28:01 -07006049 addFocusables(views, direction, FOCUSABLES_TOUCH_MODE);
6050 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006051
svetoslavganov75986cf2009-05-14 22:28:01 -07006052 /**
6053 * Adds any focusable views that are descendants of this view (possibly
6054 * including this view if it is focusable itself) to views. This method
6055 * adds all focusable views regardless if we are in touch mode or
Svetoslav Ganov42138042012-03-20 11:51:39 -07006056 * only views focusable in touch mode if we are in touch mode or
6057 * only views that can take accessibility focus if accessibility is enabeld
6058 * depending on the focusable mode paramater.
svetoslavganov75986cf2009-05-14 22:28:01 -07006059 *
6060 * @param views Focusable views found so far or null if all we are interested is
6061 * the number of focusables.
6062 * @param direction The direction of the focus.
6063 * @param focusableMode The type of focusables to be added.
6064 *
6065 * @see #FOCUSABLES_ALL
6066 * @see #FOCUSABLES_TOUCH_MODE
6067 */
6068 public void addFocusables(ArrayList<View> views, int direction, int focusableMode) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006069 if (views == null) {
svetoslavganov75986cf2009-05-14 22:28:01 -07006070 return;
6071 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006072 if ((focusableMode & FOCUSABLES_ACCESSIBILITY) == FOCUSABLES_ACCESSIBILITY) {
Svetoslav Ganov791fd312012-05-14 15:12:30 -07006073 if (canTakeAccessibilityFocusFromHover() || getAccessibilityNodeProvider() != null) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006074 views.add(this);
6075 return;
6076 }
6077 }
Svetoslav Ganov3cb889c2012-04-16 19:10:30 -07006078 if (!isFocusable()) {
6079 return;
svetoslavganov75986cf2009-05-14 22:28:01 -07006080 }
Svetoslav Ganov3cb889c2012-04-16 19:10:30 -07006081 if ((focusableMode & FOCUSABLES_TOUCH_MODE) == FOCUSABLES_TOUCH_MODE
6082 && isInTouchMode() && !isFocusableInTouchMode()) {
6083 return;
6084 }
6085 views.add(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006086 }
6087
6088 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006089 * Finds the Views that contain given text. The containment is case insensitive.
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006090 * The search is performed by either the text that the View renders or the content
6091 * description that describes the view for accessibility purposes and the view does
6092 * not render or both. Clients can specify how the search is to be performed via
6093 * passing the {@link #FIND_VIEWS_WITH_TEXT} and
6094 * {@link #FIND_VIEWS_WITH_CONTENT_DESCRIPTION} flags.
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006095 *
6096 * @param outViews The output list of matching Views.
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006097 * @param searched The text to match against.
Svetoslav Ganov02107852011-10-03 17:06:56 -07006098 *
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006099 * @see #FIND_VIEWS_WITH_TEXT
6100 * @see #FIND_VIEWS_WITH_CONTENT_DESCRIPTION
6101 * @see #setContentDescription(CharSequence)
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006102 */
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006103 public void findViewsWithText(ArrayList<View> outViews, CharSequence searched, int flags) {
Svetoslav Ganov02107852011-10-03 17:06:56 -07006104 if (getAccessibilityNodeProvider() != null) {
6105 if ((flags & FIND_VIEWS_WITH_ACCESSIBILITY_NODE_PROVIDERS) != 0) {
6106 outViews.add(this);
6107 }
6108 } else if ((flags & FIND_VIEWS_WITH_CONTENT_DESCRIPTION) != 0
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006109 && (searched != null && searched.length() > 0)
6110 && (mContentDescription != null && mContentDescription.length() > 0)) {
Svetoslav Ganovea515ae2011-09-14 18:15:32 -07006111 String searchedLowerCase = searched.toString().toLowerCase();
6112 String contentDescriptionLowerCase = mContentDescription.toString().toLowerCase();
6113 if (contentDescriptionLowerCase.contains(searchedLowerCase)) {
6114 outViews.add(this);
6115 }
6116 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006117 }
6118
6119 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006120 * Find and return all touchable views that are descendants of this view,
6121 * possibly including this view if it is touchable itself.
6122 *
6123 * @return A list of touchable views
6124 */
6125 public ArrayList<View> getTouchables() {
6126 ArrayList<View> result = new ArrayList<View>();
6127 addTouchables(result);
6128 return result;
6129 }
6130
6131 /**
6132 * Add any touchable views that are descendants of this view (possibly
6133 * including this view if it is touchable itself) to views.
6134 *
6135 * @param views Touchable views found so far
6136 */
6137 public void addTouchables(ArrayList<View> views) {
6138 final int viewFlags = mViewFlags;
6139
6140 if (((viewFlags & CLICKABLE) == CLICKABLE || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
6141 && (viewFlags & ENABLED_MASK) == ENABLED) {
6142 views.add(this);
6143 }
6144 }
6145
6146 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006147 * Returns whether this View is accessibility focused.
6148 *
6149 * @return True if this View is accessibility focused.
6150 */
6151 boolean isAccessibilityFocused() {
6152 return (mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0;
6153 }
6154
6155 /**
6156 * Call this to try to give accessibility focus to this view.
6157 *
6158 * A view will not actually take focus if {@link AccessibilityManager#isEnabled()}
6159 * returns false or the view is no visible or the view already has accessibility
6160 * focus.
6161 *
6162 * See also {@link #focusSearch(int)}, which is what you call to say that you
6163 * have focus, and you want your parent to look for the next one.
6164 *
6165 * @return Whether this view actually took accessibility focus.
6166 *
6167 * @hide
6168 */
6169 public boolean requestAccessibilityFocus() {
Svetoslav Ganov07b726c2012-04-30 12:24:57 -07006170 AccessibilityManager manager = AccessibilityManager.getInstance(mContext);
6171 if (!manager.isEnabled() || !manager.isTouchExplorationEnabled()) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006172 return false;
6173 }
6174 if ((mViewFlags & VISIBILITY_MASK) != VISIBLE) {
6175 return false;
6176 }
6177 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) == 0) {
6178 mPrivateFlags2 |= ACCESSIBILITY_FOCUSED;
6179 ViewRootImpl viewRootImpl = getViewRootImpl();
6180 if (viewRootImpl != null) {
6181 viewRootImpl.setAccessibilityFocusedHost(this);
6182 }
6183 invalidate();
6184 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUSED);
6185 notifyAccessibilityStateChanged();
6186 // Try to give input focus to this view - not a descendant.
6187 requestFocusNoSearch(View.FOCUS_DOWN, null);
6188 return true;
6189 }
6190 return false;
6191 }
6192
6193 /**
6194 * Call this to try to clear accessibility focus of this view.
6195 *
6196 * See also {@link #focusSearch(int)}, which is what you call to say that you
6197 * have focus, and you want your parent to look for the next one.
6198 *
6199 * @hide
6200 */
6201 public void clearAccessibilityFocus() {
Svetoslav Ganov791fd312012-05-14 15:12:30 -07006202 ViewRootImpl viewRootImpl = getViewRootImpl();
6203 if (viewRootImpl != null) {
6204 View focusHost = viewRootImpl.getAccessibilityFocusedHost();
Svetoslav Ganov64899e52012-05-15 21:09:30 -07006205 if (focusHost != null && focusHost != this
6206 && ViewRootImpl.isViewDescendantOf(focusHost, this)) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006207 viewRootImpl.setAccessibilityFocusedHost(null);
6208 }
Svetoslav Ganov791fd312012-05-14 15:12:30 -07006209 }
6210 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0) {
6211 mPrivateFlags2 &= ~ACCESSIBILITY_FOCUSED;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006212 invalidate();
6213 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_ACCESSIBILITY_FOCUS_CLEARED);
6214 notifyAccessibilityStateChanged();
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006215
6216 // Clear the text navigation state.
6217 setAccessibilityCursorPosition(-1);
6218
Svetoslav Ganov42138042012-03-20 11:51:39 -07006219 // Try to move accessibility focus to the input focus.
6220 View rootView = getRootView();
6221 if (rootView != null) {
6222 View inputFocus = rootView.findFocus();
6223 if (inputFocus != null) {
6224 inputFocus.requestAccessibilityFocus();
6225 }
6226 }
6227 }
6228 }
6229
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006230 private void requestAccessibilityFocusFromHover() {
6231 if (includeForAccessibility() && isActionableForAccessibility()) {
6232 requestAccessibilityFocus();
6233 } else {
6234 if (mParent != null) {
6235 View nextFocus = mParent.findViewToTakeAccessibilityFocusFromHover(this, this);
6236 if (nextFocus != null) {
6237 nextFocus.requestAccessibilityFocus();
6238 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006239 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006240 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006241 }
6242
6243 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006244 * @hide
6245 */
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006246 public boolean canTakeAccessibilityFocusFromHover() {
6247 if (includeForAccessibility() && isActionableForAccessibility()) {
6248 return true;
6249 }
6250 if (mParent != null) {
6251 return (mParent.findViewToTakeAccessibilityFocusFromHover(this, this) == this);
Svetoslav Ganov42138042012-03-20 11:51:39 -07006252 }
6253 return false;
6254 }
6255
6256 /**
6257 * Clears accessibility focus without calling any callback methods
6258 * normally invoked in {@link #clearAccessibilityFocus()}. This method
6259 * is used for clearing accessibility focus when giving this focus to
6260 * another view.
6261 */
6262 void clearAccessibilityFocusNoCallbacks() {
6263 if ((mPrivateFlags2 & ACCESSIBILITY_FOCUSED) != 0) {
6264 mPrivateFlags2 &= ~ACCESSIBILITY_FOCUSED;
6265 invalidate();
6266 }
6267 }
6268
6269 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006270 * Call this to try to give focus to a specific view or to one of its
6271 * descendants.
6272 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006273 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6274 * false), or if it is focusable and it is not focusable in touch mode
6275 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006276 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006277 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006278 * have focus, and you want your parent to look for the next one.
6279 *
6280 * This is equivalent to calling {@link #requestFocus(int, Rect)} with arguments
6281 * {@link #FOCUS_DOWN} and <code>null</code>.
6282 *
6283 * @return Whether this view or one of its descendants actually took focus.
6284 */
6285 public final boolean requestFocus() {
6286 return requestFocus(View.FOCUS_DOWN);
6287 }
6288
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006289 /**
6290 * Call this to try to give focus to a specific view or to one of its
6291 * descendants and give it a hint about what direction focus is heading.
6292 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006293 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6294 * false), or if it is focusable and it is not focusable in touch mode
6295 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006296 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006297 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006298 * have focus, and you want your parent to look for the next one.
6299 *
6300 * This is equivalent to calling {@link #requestFocus(int, Rect)} with
6301 * <code>null</code> set for the previously focused rectangle.
6302 *
6303 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
6304 * @return Whether this view or one of its descendants actually took focus.
6305 */
6306 public final boolean requestFocus(int direction) {
6307 return requestFocus(direction, null);
6308 }
6309
6310 /**
6311 * Call this to try to give focus to a specific view or to one of its descendants
6312 * and give it hints about the direction and a specific rectangle that the focus
6313 * is coming from. The rectangle can help give larger views a finer grained hint
6314 * about where focus is coming from, and therefore, where to show selection, or
6315 * forward focus change internally.
6316 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006317 * A view will not actually take focus if it is not focusable ({@link #isFocusable} returns
6318 * false), or if it is focusable and it is not focusable in touch mode
6319 * ({@link #isFocusableInTouchMode}) while the device is in touch mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006320 *
6321 * A View will not take focus if it is not visible.
6322 *
Gilles Debunne2ed2eac2011-02-24 16:29:48 -08006323 * A View will not take focus if one of its parents has
6324 * {@link android.view.ViewGroup#getDescendantFocusability()} equal to
6325 * {@link ViewGroup#FOCUS_BLOCK_DESCENDANTS}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006326 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07006327 * See also {@link #focusSearch(int)}, which is what you call to say that you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006328 * have focus, and you want your parent to look for the next one.
6329 *
6330 * You may wish to override this method if your custom {@link View} has an internal
6331 * {@link View} that it wishes to forward the request to.
6332 *
6333 * @param direction One of FOCUS_UP, FOCUS_DOWN, FOCUS_LEFT, and FOCUS_RIGHT
6334 * @param previouslyFocusedRect The rectangle (in this View's coordinate system)
6335 * to give a finer grained hint about where focus is coming from. May be null
6336 * if there is no hint.
6337 * @return Whether this view or one of its descendants actually took focus.
6338 */
6339 public boolean requestFocus(int direction, Rect previouslyFocusedRect) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006340 return requestFocusNoSearch(direction, previouslyFocusedRect);
6341 }
6342
6343 private boolean requestFocusNoSearch(int direction, Rect previouslyFocusedRect) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006344 // need to be focusable
6345 if ((mViewFlags & FOCUSABLE_MASK) != FOCUSABLE ||
6346 (mViewFlags & VISIBILITY_MASK) != VISIBLE) {
6347 return false;
6348 }
6349
6350 // need to be focusable in touch mode if in touch mode
6351 if (isInTouchMode() &&
Svetoslav Ganov8643aa02011-04-20 12:12:33 -07006352 (FOCUSABLE_IN_TOUCH_MODE != (mViewFlags & FOCUSABLE_IN_TOUCH_MODE))) {
6353 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006354 }
6355
6356 // need to not have any parents blocking us
6357 if (hasAncestorThatBlocksDescendantFocus()) {
6358 return false;
6359 }
6360
6361 handleFocusGainInternal(direction, previouslyFocusedRect);
6362 return true;
6363 }
6364
6365 /**
6366 * Call this to try to give focus to a specific view or to one of its descendants. This is a
6367 * special variant of {@link #requestFocus() } that will allow views that are not focuable in
6368 * touch mode to request focus when they are touched.
6369 *
6370 * @return Whether this view or one of its descendants actually took focus.
6371 *
6372 * @see #isInTouchMode()
6373 *
6374 */
6375 public final boolean requestFocusFromTouch() {
6376 // Leave touch mode if we need to
6377 if (isInTouchMode()) {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07006378 ViewRootImpl viewRoot = getViewRootImpl();
Christopher Tate2c095f32010-10-04 14:13:40 -07006379 if (viewRoot != null) {
6380 viewRoot.ensureTouchMode(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006381 }
6382 }
6383 return requestFocus(View.FOCUS_DOWN);
6384 }
6385
6386 /**
6387 * @return Whether any ancestor of this view blocks descendant focus.
6388 */
6389 private boolean hasAncestorThatBlocksDescendantFocus() {
6390 ViewParent ancestor = mParent;
6391 while (ancestor instanceof ViewGroup) {
6392 final ViewGroup vgAncestor = (ViewGroup) ancestor;
6393 if (vgAncestor.getDescendantFocusability() == ViewGroup.FOCUS_BLOCK_DESCENDANTS) {
6394 return true;
6395 } else {
6396 ancestor = vgAncestor.getParent();
6397 }
6398 }
6399 return false;
6400 }
6401
6402 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -07006403 * Gets the mode for determining whether this View is important for accessibility
6404 * which is if it fires accessibility events and if it is reported to
6405 * accessibility services that query the screen.
6406 *
6407 * @return The mode for determining whether a View is important for accessibility.
6408 *
6409 * @attr ref android.R.styleable#View_importantForAccessibility
6410 *
6411 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES
6412 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO
6413 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO
6414 */
6415 @ViewDebug.ExportedProperty(category = "accessibility", mapping = {
6416 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_AUTO,
6417 to = "IMPORTANT_FOR_ACCESSIBILITY_AUTO"),
6418 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_YES,
6419 to = "IMPORTANT_FOR_ACCESSIBILITY_YES"),
6420 @ViewDebug.IntToString(from = IMPORTANT_FOR_ACCESSIBILITY_NO,
6421 to = "IMPORTANT_FOR_ACCESSIBILITY_NO")
6422 })
6423 public int getImportantForAccessibility() {
6424 return (mPrivateFlags2 & IMPORTANT_FOR_ACCESSIBILITY_MASK)
6425 >> IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
6426 }
6427
6428 /**
6429 * Sets how to determine whether this view is important for accessibility
6430 * which is if it fires accessibility events and if it is reported to
6431 * accessibility services that query the screen.
6432 *
6433 * @param mode How to determine whether this view is important for accessibility.
6434 *
6435 * @attr ref android.R.styleable#View_importantForAccessibility
6436 *
6437 * @see #IMPORTANT_FOR_ACCESSIBILITY_YES
6438 * @see #IMPORTANT_FOR_ACCESSIBILITY_NO
6439 * @see #IMPORTANT_FOR_ACCESSIBILITY_AUTO
6440 */
6441 public void setImportantForAccessibility(int mode) {
6442 if (mode != getImportantForAccessibility()) {
6443 mPrivateFlags2 &= ~IMPORTANT_FOR_ACCESSIBILITY_MASK;
6444 mPrivateFlags2 |= (mode << IMPORTANT_FOR_ACCESSIBILITY_SHIFT)
6445 & IMPORTANT_FOR_ACCESSIBILITY_MASK;
6446 notifyAccessibilityStateChanged();
6447 }
6448 }
6449
6450 /**
6451 * Gets whether this view should be exposed for accessibility.
6452 *
6453 * @return Whether the view is exposed for accessibility.
6454 *
6455 * @hide
6456 */
6457 public boolean isImportantForAccessibility() {
6458 final int mode = (mPrivateFlags2 & IMPORTANT_FOR_ACCESSIBILITY_MASK)
6459 >> IMPORTANT_FOR_ACCESSIBILITY_SHIFT;
6460 switch (mode) {
6461 case IMPORTANT_FOR_ACCESSIBILITY_YES:
6462 return true;
6463 case IMPORTANT_FOR_ACCESSIBILITY_NO:
6464 return false;
6465 case IMPORTANT_FOR_ACCESSIBILITY_AUTO:
6466 return isActionableForAccessibility() || hasListenersForAccessibility();
6467 default:
6468 throw new IllegalArgumentException("Unknow important for accessibility mode: "
6469 + mode);
6470 }
6471 }
6472
6473 /**
6474 * Gets the parent for accessibility purposes. Note that the parent for
6475 * accessibility is not necessary the immediate parent. It is the first
6476 * predecessor that is important for accessibility.
6477 *
6478 * @return The parent for accessibility purposes.
6479 */
6480 public ViewParent getParentForAccessibility() {
6481 if (mParent instanceof View) {
6482 View parentView = (View) mParent;
6483 if (parentView.includeForAccessibility()) {
6484 return mParent;
6485 } else {
6486 return mParent.getParentForAccessibility();
6487 }
6488 }
6489 return null;
6490 }
6491
6492 /**
6493 * Adds the children of a given View for accessibility. Since some Views are
6494 * not important for accessibility the children for accessibility are not
6495 * necessarily direct children of the riew, rather they are the first level of
6496 * descendants important for accessibility.
6497 *
6498 * @param children The list of children for accessibility.
6499 */
6500 public void addChildrenForAccessibility(ArrayList<View> children) {
6501 if (includeForAccessibility()) {
6502 children.add(this);
6503 }
6504 }
6505
6506 /**
6507 * Whether to regard this view for accessibility. A view is regarded for
6508 * accessibility if it is important for accessibility or the querying
6509 * accessibility service has explicitly requested that view not
6510 * important for accessibility are regarded.
6511 *
6512 * @return Whether to regard the view for accessibility.
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006513 *
6514 * @hide
Svetoslav Ganov42138042012-03-20 11:51:39 -07006515 */
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006516 public boolean includeForAccessibility() {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006517 if (mAttachInfo != null) {
6518 if (!mAttachInfo.mIncludeNotImportantViews) {
Svetoslav Ganov0a1bb6d2012-05-07 11:54:39 -07006519 return isImportantForAccessibility();
Svetoslav Ganov42138042012-03-20 11:51:39 -07006520 }
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006521 return true;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006522 }
6523 return false;
6524 }
6525
6526 /**
6527 * Returns whether the View is considered actionable from
6528 * accessibility perspective. Such view are important for
6529 * accessiiblity.
6530 *
6531 * @return True if the view is actionable for accessibility.
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006532 *
6533 * @hide
Svetoslav Ganov42138042012-03-20 11:51:39 -07006534 */
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07006535 public boolean isActionableForAccessibility() {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006536 return (isClickable() || isLongClickable() || isFocusable());
6537 }
6538
6539 /**
6540 * Returns whether the View has registered callbacks wich makes it
6541 * important for accessiiblity.
6542 *
6543 * @return True if the view is actionable for accessibility.
6544 */
6545 private boolean hasListenersForAccessibility() {
6546 ListenerInfo info = getListenerInfo();
6547 return mTouchDelegate != null || info.mOnKeyListener != null
6548 || info.mOnTouchListener != null || info.mOnGenericMotionListener != null
6549 || info.mOnHoverListener != null || info.mOnDragListener != null;
6550 }
6551
6552 /**
6553 * Notifies accessibility services that some view's important for
6554 * accessibility state has changed. Note that such notifications
6555 * are made at most once every
6556 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}
6557 * to avoid unnecessary load to the system. Also once a view has
6558 * made a notifucation this method is a NOP until the notification has
6559 * been sent to clients.
6560 *
6561 * @hide
6562 *
6563 * TODO: Makse sure this method is called for any view state change
6564 * that is interesting for accessilility purposes.
6565 */
6566 public void notifyAccessibilityStateChanged() {
Svetoslav Ganovc406be92012-05-11 16:12:32 -07006567 if (!AccessibilityManager.getInstance(mContext).isEnabled()) {
6568 return;
6569 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006570 if ((mPrivateFlags2 & ACCESSIBILITY_STATE_CHANGED) == 0) {
6571 mPrivateFlags2 |= ACCESSIBILITY_STATE_CHANGED;
6572 if (mParent != null) {
6573 mParent.childAccessibilityStateChanged(this);
6574 }
6575 }
6576 }
6577
6578 /**
6579 * Reset the state indicating the this view has requested clients
6580 * interested in its accessiblity state to be notified.
6581 *
6582 * @hide
6583 */
6584 public void resetAccessibilityStateChanged() {
6585 mPrivateFlags2 &= ~ACCESSIBILITY_STATE_CHANGED;
6586 }
6587
6588 /**
6589 * Performs the specified accessibility action on the view. For
6590 * possible accessibility actions look at {@link AccessibilityNodeInfo}.
alanv8eeefef2012-05-07 16:57:53 -07006591 * <p>
6592 * If an {@link AccessibilityDelegate} has been specified via calling
6593 * {@link #setAccessibilityDelegate(AccessibilityDelegate)} its
6594 * {@link AccessibilityDelegate#performAccessibilityAction(View, int, Bundle)}
6595 * is responsible for handling this call.
6596 * </p>
Svetoslav Ganov42138042012-03-20 11:51:39 -07006597 *
6598 * @param action The action to perform.
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006599 * @param arguments Optional action arguments.
Svetoslav Ganov42138042012-03-20 11:51:39 -07006600 * @return Whether the action was performed.
6601 */
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006602 public boolean performAccessibilityAction(int action, Bundle arguments) {
alanv8eeefef2012-05-07 16:57:53 -07006603 if (mAccessibilityDelegate != null) {
6604 return mAccessibilityDelegate.performAccessibilityAction(this, action, arguments);
6605 } else {
6606 return performAccessibilityActionInternal(action, arguments);
6607 }
6608 }
6609
6610 /**
6611 * @see #performAccessibilityAction(int, Bundle)
6612 *
6613 * Note: Called from the default {@link AccessibilityDelegate}.
6614 */
6615 boolean performAccessibilityActionInternal(int action, Bundle arguments) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07006616 switch (action) {
6617 case AccessibilityNodeInfo.ACTION_CLICK: {
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006618 if (isClickable()) {
Svetoslav Ganov773f2622012-05-05 19:59:42 -07006619 return performClick();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006620 }
6621 } break;
6622 case AccessibilityNodeInfo.ACTION_LONG_CLICK: {
6623 if (isLongClickable()) {
Svetoslav Ganov773f2622012-05-05 19:59:42 -07006624 return performLongClick();
Svetoslav Ganov005b83b2012-04-16 18:17:17 -07006625 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07006626 } break;
6627 case AccessibilityNodeInfo.ACTION_FOCUS: {
6628 if (!hasFocus()) {
6629 // Get out of touch mode since accessibility
6630 // wants to move focus around.
6631 getViewRootImpl().ensureTouchMode(false);
6632 return requestFocus();
6633 }
6634 } break;
6635 case AccessibilityNodeInfo.ACTION_CLEAR_FOCUS: {
6636 if (hasFocus()) {
6637 clearFocus();
6638 return !isFocused();
6639 }
6640 } break;
6641 case AccessibilityNodeInfo.ACTION_SELECT: {
6642 if (!isSelected()) {
6643 setSelected(true);
6644 return isSelected();
6645 }
6646 } break;
6647 case AccessibilityNodeInfo.ACTION_CLEAR_SELECTION: {
6648 if (isSelected()) {
6649 setSelected(false);
6650 return !isSelected();
6651 }
6652 } break;
6653 case AccessibilityNodeInfo.ACTION_ACCESSIBILITY_FOCUS: {
6654 if (!isAccessibilityFocused()) {
6655 return requestAccessibilityFocus();
6656 }
6657 } break;
6658 case AccessibilityNodeInfo.ACTION_CLEAR_ACCESSIBILITY_FOCUS: {
6659 if (isAccessibilityFocused()) {
6660 clearAccessibilityFocus();
6661 return true;
6662 }
6663 } break;
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006664 case AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY: {
6665 if (arguments != null) {
6666 final int granularity = arguments.getInt(
6667 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT);
6668 return nextAtGranularity(granularity);
6669 }
6670 } break;
6671 case AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY: {
6672 if (arguments != null) {
6673 final int granularity = arguments.getInt(
6674 AccessibilityNodeInfo.ACTION_ARGUMENT_MOVEMENT_GRANULARITY_INT);
6675 return previousAtGranularity(granularity);
6676 }
6677 } break;
Svetoslav Ganov42138042012-03-20 11:51:39 -07006678 }
6679 return false;
6680 }
6681
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006682 private boolean nextAtGranularity(int granularity) {
6683 CharSequence text = getIterableTextForAccessibility();
Svetoslav Ganov64899e52012-05-15 21:09:30 -07006684 if (text == null || text.length() == 0) {
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006685 return false;
6686 }
6687 TextSegmentIterator iterator = getIteratorForGranularity(granularity);
6688 if (iterator == null) {
6689 return false;
6690 }
6691 final int current = getAccessibilityCursorPosition();
6692 final int[] range = iterator.following(current);
6693 if (range == null) {
6694 setAccessibilityCursorPosition(-1);
6695 return false;
6696 }
6697 final int start = range[0];
6698 final int end = range[1];
6699 setAccessibilityCursorPosition(start);
6700 sendViewTextTraversedAtGranularityEvent(
6701 AccessibilityNodeInfo.ACTION_NEXT_AT_MOVEMENT_GRANULARITY,
6702 granularity, start, end);
6703 return true;
6704 }
6705
6706 private boolean previousAtGranularity(int granularity) {
6707 CharSequence text = getIterableTextForAccessibility();
Svetoslav Ganov64899e52012-05-15 21:09:30 -07006708 if (text == null || text.length() == 0) {
Svetoslav Ganov6d17a932012-04-27 19:30:38 -07006709 return false;
6710 }
6711 TextSegmentIterator iterator = getIteratorForGranularity(granularity);
6712 if (iterator == null) {
6713 return false;
6714 }
6715 final int selectionStart = getAccessibilityCursorPosition();
6716 final int current = selectionStart >= 0 ? selectionStart : text.length() + 1;
6717 final int[] range = iterator.preceding(current);
6718 if (range == null) {
6719 setAccessibilityCursorPosition(-1);
6720 return false;
6721 }
6722 final int start = range[0];
6723 final int end = range[1];
6724 setAccessibilityCursorPosition(end);
6725 sendViewTextTraversedAtGranularityEvent(
6726 AccessibilityNodeInfo.ACTION_PREVIOUS_AT_MOVEMENT_GRANULARITY,
6727 granularity, start, end);
6728 return true;
6729 }
6730
6731 /**
6732 * Gets the text reported for accessibility purposes.
6733 *
6734 * @return The accessibility text.
6735 *
6736 * @hide
6737 */
6738 public CharSequence getIterableTextForAccessibility() {
6739 return mContentDescription;
6740 }
6741
6742 /**
6743 * @hide
6744 */
6745 public int getAccessibilityCursorPosition() {
6746 return mAccessibilityCursorPosition;
6747 }
6748
6749 /**
6750 * @hide
6751 */
6752 public void setAccessibilityCursorPosition(int position) {
6753 mAccessibilityCursorPosition = position;
6754 }
6755
6756 private void sendViewTextTraversedAtGranularityEvent(int action, int granularity,
6757 int fromIndex, int toIndex) {
6758 if (mParent == null) {
6759 return;
6760 }
6761 AccessibilityEvent event = AccessibilityEvent.obtain(
6762 AccessibilityEvent.TYPE_VIEW_TEXT_TRAVERSED_AT_MOVEMENT_GRANULARITY);
6763 onInitializeAccessibilityEvent(event);
6764 onPopulateAccessibilityEvent(event);
6765 event.setFromIndex(fromIndex);
6766 event.setToIndex(toIndex);
6767 event.setAction(action);
6768 event.setMovementGranularity(granularity);
6769 mParent.requestSendAccessibilityEvent(this, event);
6770 }
6771
6772 /**
6773 * @hide
6774 */
6775 public TextSegmentIterator getIteratorForGranularity(int granularity) {
6776 switch (granularity) {
6777 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_CHARACTER: {
6778 CharSequence text = getIterableTextForAccessibility();
6779 if (text != null && text.length() > 0) {
6780 CharacterTextSegmentIterator iterator =
6781 CharacterTextSegmentIterator.getInstance(mContext);
6782 iterator.initialize(text.toString());
6783 return iterator;
6784 }
6785 } break;
6786 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_WORD: {
6787 CharSequence text = getIterableTextForAccessibility();
6788 if (text != null && text.length() > 0) {
6789 WordTextSegmentIterator iterator =
6790 WordTextSegmentIterator.getInstance(mContext);
6791 iterator.initialize(text.toString());
6792 return iterator;
6793 }
6794 } break;
6795 case AccessibilityNodeInfo.MOVEMENT_GRANULARITY_PARAGRAPH: {
6796 CharSequence text = getIterableTextForAccessibility();
6797 if (text != null && text.length() > 0) {
6798 ParagraphTextSegmentIterator iterator =
6799 ParagraphTextSegmentIterator.getInstance();
6800 iterator.initialize(text.toString());
6801 return iterator;
6802 }
6803 } break;
6804 }
6805 return null;
6806 }
6807
Svetoslav Ganov42138042012-03-20 11:51:39 -07006808 /**
Romain Guya440b002010-02-24 15:57:54 -08006809 * @hide
6810 */
6811 public void dispatchStartTemporaryDetach() {
Svetoslav Ganov961bf0e2012-05-08 09:40:03 -07006812 clearAccessibilityFocus();
Romain Guya440b002010-02-24 15:57:54 -08006813 onStartTemporaryDetach();
6814 }
6815
6816 /**
6817 * This is called when a container is going to temporarily detach a child, with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006818 * {@link ViewGroup#detachViewFromParent(View) ViewGroup.detachViewFromParent}.
6819 * It will either be followed by {@link #onFinishTemporaryDetach()} or
Romain Guya440b002010-02-24 15:57:54 -08006820 * {@link #onDetachedFromWindow()} when the container is done.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006821 */
6822 public void onStartTemporaryDetach() {
Romain Guya440b002010-02-24 15:57:54 -08006823 removeUnsetPressCallback();
Romain Guy8afa5152010-02-26 11:56:30 -08006824 mPrivateFlags |= CANCEL_NEXT_UP_EVENT;
Romain Guya440b002010-02-24 15:57:54 -08006825 }
6826
6827 /**
6828 * @hide
6829 */
6830 public void dispatchFinishTemporaryDetach() {
6831 onFinishTemporaryDetach();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006832 }
Romain Guy8506ab42009-06-11 17:35:47 -07006833
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006834 /**
6835 * Called after {@link #onStartTemporaryDetach} when the container is done
6836 * changing the view.
6837 */
6838 public void onFinishTemporaryDetach() {
6839 }
Romain Guy8506ab42009-06-11 17:35:47 -07006840
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006841 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006842 * Return the global {@link KeyEvent.DispatcherState KeyEvent.DispatcherState}
6843 * for this view's window. Returns null if the view is not currently attached
6844 * to the window. Normally you will not need to use this directly, but
Romain Guy5c22a8c2011-05-13 11:48:45 -07006845 * just use the standard high-level event callbacks like
6846 * {@link #onKeyDown(int, KeyEvent)}.
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006847 */
6848 public KeyEvent.DispatcherState getKeyDispatcherState() {
6849 return mAttachInfo != null ? mAttachInfo.mKeyDispatchState : null;
6850 }
Joe Malin32736f02011-01-19 16:14:20 -08006851
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07006852 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006853 * Dispatch a key event before it is processed by any input method
6854 * associated with the view hierarchy. This can be used to intercept
6855 * key events in special situations before the IME consumes them; a
6856 * typical example would be handling the BACK key to update the application's
6857 * UI instead of allowing the IME to see it and close itself.
6858 *
6859 * @param event The key event to be dispatched.
6860 * @return True if the event was handled, false otherwise.
6861 */
6862 public boolean dispatchKeyEventPreIme(KeyEvent event) {
6863 return onKeyPreIme(event.getKeyCode(), event);
6864 }
6865
6866 /**
6867 * Dispatch a key event to the next view on the focus path. This path runs
6868 * from the top of the view tree down to the currently focused view. If this
6869 * view has focus, it will dispatch to itself. Otherwise it will dispatch
6870 * the next node down the focus path. This method also fires any key
6871 * listeners.
6872 *
6873 * @param event The key event to be dispatched.
6874 * @return True if the event was handled, false otherwise.
6875 */
6876 public boolean dispatchKeyEvent(KeyEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006877 if (mInputEventConsistencyVerifier != null) {
6878 mInputEventConsistencyVerifier.onKeyEvent(event, 0);
6879 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006880
Jeff Brown21bc5c92011-02-28 18:27:14 -08006881 // Give any attached key listener a first crack at the event.
Romain Guyf607bdc2010-09-10 19:20:06 -07006882 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006883 ListenerInfo li = mListenerInfo;
6884 if (li != null && li.mOnKeyListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
6885 && li.mOnKeyListener.onKey(this, event.getKeyCode(), event)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006886 return true;
6887 }
6888
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006889 if (event.dispatch(this, mAttachInfo != null
6890 ? mAttachInfo.mKeyDispatchState : null, this)) {
6891 return true;
6892 }
6893
6894 if (mInputEventConsistencyVerifier != null) {
6895 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
6896 }
6897 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006898 }
6899
6900 /**
6901 * Dispatches a key shortcut event.
6902 *
6903 * @param event The key event to be dispatched.
6904 * @return True if the event was handled by the view, false otherwise.
6905 */
6906 public boolean dispatchKeyShortcutEvent(KeyEvent event) {
6907 return onKeyShortcut(event.getKeyCode(), event);
6908 }
6909
6910 /**
6911 * Pass the touch screen motion event down to the target view, or this
6912 * view if it is the target.
6913 *
6914 * @param event The motion event to be dispatched.
6915 * @return True if the event was handled by the view, false otherwise.
6916 */
6917 public boolean dispatchTouchEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006918 if (mInputEventConsistencyVerifier != null) {
6919 mInputEventConsistencyVerifier.onTouchEvent(event, 0);
6920 }
6921
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006922 if (onFilterTouchEventForSecurity(event)) {
6923 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07006924 ListenerInfo li = mListenerInfo;
6925 if (li != null && li.mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
6926 && li.mOnTouchListener.onTouch(this, event)) {
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006927 return true;
6928 }
6929
6930 if (onTouchEvent(event)) {
6931 return true;
6932 }
Jeff Brown85a31762010-09-01 17:01:00 -07006933 }
6934
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006935 if (mInputEventConsistencyVerifier != null) {
6936 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006937 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07006938 return false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006939 }
6940
6941 /**
Jeff Brown85a31762010-09-01 17:01:00 -07006942 * Filter the touch event to apply security policies.
6943 *
6944 * @param event The motion event to be filtered.
6945 * @return True if the event should be dispatched, false if the event should be dropped.
Joe Malin32736f02011-01-19 16:14:20 -08006946 *
Jeff Brown85a31762010-09-01 17:01:00 -07006947 * @see #getFilterTouchesWhenObscured
6948 */
6949 public boolean onFilterTouchEventForSecurity(MotionEvent event) {
Romain Guyf607bdc2010-09-10 19:20:06 -07006950 //noinspection RedundantIfStatement
Jeff Brown85a31762010-09-01 17:01:00 -07006951 if ((mViewFlags & FILTER_TOUCHES_WHEN_OBSCURED) != 0
6952 && (event.getFlags() & MotionEvent.FLAG_WINDOW_IS_OBSCURED) != 0) {
6953 // Window is obscured, drop this touch.
6954 return false;
6955 }
6956 return true;
6957 }
6958
6959 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006960 * Pass a trackball motion event down to the focused view.
6961 *
6962 * @param event The motion event to be dispatched.
6963 * @return True if the event was handled by the view, false otherwise.
6964 */
6965 public boolean dispatchTrackballEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006966 if (mInputEventConsistencyVerifier != null) {
6967 mInputEventConsistencyVerifier.onTrackballEvent(event, 0);
6968 }
6969
Romain Guy02ccac62011-06-24 13:20:23 -07006970 return onTrackballEvent(event);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006971 }
6972
6973 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08006974 * Dispatch a generic motion event.
6975 * <p>
6976 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
6977 * are delivered to the view under the pointer. All other generic motion events are
Jeff Browna032cc02011-03-07 16:56:21 -08006978 * delivered to the focused view. Hover events are handled specially and are delivered
Romain Guy5c22a8c2011-05-13 11:48:45 -07006979 * to {@link #onHoverEvent(MotionEvent)}.
Jeff Brown33bbfd22011-02-24 20:55:35 -08006980 * </p>
Jeff Browncb1404e2011-01-15 18:14:15 -08006981 *
6982 * @param event The motion event to be dispatched.
6983 * @return True if the event was handled by the view, false otherwise.
6984 */
6985 public boolean dispatchGenericMotionEvent(MotionEvent event) {
Jeff Brown21bc5c92011-02-28 18:27:14 -08006986 if (mInputEventConsistencyVerifier != null) {
6987 mInputEventConsistencyVerifier.onGenericMotionEvent(event, 0);
6988 }
6989
Jeff Browna032cc02011-03-07 16:56:21 -08006990 final int source = event.getSource();
6991 if ((source & InputDevice.SOURCE_CLASS_POINTER) != 0) {
6992 final int action = event.getAction();
6993 if (action == MotionEvent.ACTION_HOVER_ENTER
6994 || action == MotionEvent.ACTION_HOVER_MOVE
6995 || action == MotionEvent.ACTION_HOVER_EXIT) {
6996 if (dispatchHoverEvent(event)) {
6997 return true;
6998 }
6999 } else if (dispatchGenericPointerEvent(event)) {
7000 return true;
7001 }
7002 } else if (dispatchGenericFocusedEvent(event)) {
7003 return true;
7004 }
7005
Jeff Brown10b62902011-06-20 16:40:37 -07007006 if (dispatchGenericMotionEventInternal(event)) {
7007 return true;
7008 }
7009
7010 if (mInputEventConsistencyVerifier != null) {
7011 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
7012 }
7013 return false;
7014 }
7015
7016 private boolean dispatchGenericMotionEventInternal(MotionEvent event) {
Romain Guy7b5b6ab2011-03-14 18:05:08 -07007017 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007018 ListenerInfo li = mListenerInfo;
7019 if (li != null && li.mOnGenericMotionListener != null
7020 && (mViewFlags & ENABLED_MASK) == ENABLED
7021 && li.mOnGenericMotionListener.onGenericMotion(this, event)) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08007022 return true;
7023 }
Jeff Brownbbdc50b2011-04-19 23:46:52 -07007024
7025 if (onGenericMotionEvent(event)) {
7026 return true;
7027 }
7028
7029 if (mInputEventConsistencyVerifier != null) {
7030 mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
7031 }
7032 return false;
Jeff Browncb1404e2011-01-15 18:14:15 -08007033 }
7034
7035 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007036 * Dispatch a hover event.
7037 * <p>
Philip Milne6c8ea062012-04-03 17:38:43 -07007038 * Do not call this method directly.
Romain Guy5c22a8c2011-05-13 11:48:45 -07007039 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08007040 * </p>
7041 *
7042 * @param event The motion event to be dispatched.
7043 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08007044 */
7045 protected boolean dispatchHoverEvent(MotionEvent event) {
Romain Guy02ccac62011-06-24 13:20:23 -07007046 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007047 ListenerInfo li = mListenerInfo;
7048 if (li != null && li.mOnHoverListener != null
7049 && (mViewFlags & ENABLED_MASK) == ENABLED
7050 && li.mOnHoverListener.onHover(this, event)) {
Jeff Brown10b62902011-06-20 16:40:37 -07007051 return true;
7052 }
7053
Jeff Browna032cc02011-03-07 16:56:21 -08007054 return onHoverEvent(event);
7055 }
7056
7057 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07007058 * Returns true if the view has a child to which it has recently sent
7059 * {@link MotionEvent#ACTION_HOVER_ENTER}. If this view is hovered and
7060 * it does not have a hovered child, then it must be the innermost hovered view.
7061 * @hide
7062 */
7063 protected boolean hasHoveredChild() {
7064 return false;
7065 }
7066
7067 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007068 * Dispatch a generic motion event to the view under the first pointer.
7069 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007070 * Do not call this method directly.
7071 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08007072 * </p>
7073 *
7074 * @param event The motion event to be dispatched.
7075 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08007076 */
7077 protected boolean dispatchGenericPointerEvent(MotionEvent event) {
7078 return false;
7079 }
7080
7081 /**
7082 * Dispatch a generic motion event to the currently focused view.
7083 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007084 * Do not call this method directly.
7085 * Call {@link #dispatchGenericMotionEvent(MotionEvent)} instead.
Jeff Browna032cc02011-03-07 16:56:21 -08007086 * </p>
7087 *
7088 * @param event The motion event to be dispatched.
7089 * @return True if the event was handled by the view, false otherwise.
Jeff Browna032cc02011-03-07 16:56:21 -08007090 */
7091 protected boolean dispatchGenericFocusedEvent(MotionEvent event) {
7092 return false;
7093 }
7094
7095 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -08007096 * Dispatch a pointer event.
7097 * <p>
Romain Guy5c22a8c2011-05-13 11:48:45 -07007098 * Dispatches touch related pointer events to {@link #onTouchEvent(MotionEvent)} and all
7099 * other events to {@link #onGenericMotionEvent(MotionEvent)}. This separation of concerns
7100 * reinforces the invariant that {@link #onTouchEvent(MotionEvent)} is really about touches
Jeff Brown33bbfd22011-02-24 20:55:35 -08007101 * and should not be expected to handle other pointing device features.
7102 * </p>
7103 *
7104 * @param event The motion event to be dispatched.
7105 * @return True if the event was handled by the view, false otherwise.
7106 * @hide
7107 */
7108 public final boolean dispatchPointerEvent(MotionEvent event) {
7109 if (event.isTouchEvent()) {
7110 return dispatchTouchEvent(event);
7111 } else {
7112 return dispatchGenericMotionEvent(event);
7113 }
7114 }
7115
7116 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007117 * Called when the window containing this view gains or loses window focus.
7118 * ViewGroups should override to route to their children.
7119 *
7120 * @param hasFocus True if the window containing this view now has focus,
7121 * false otherwise.
7122 */
7123 public void dispatchWindowFocusChanged(boolean hasFocus) {
7124 onWindowFocusChanged(hasFocus);
7125 }
7126
7127 /**
7128 * Called when the window containing this view gains or loses focus. Note
7129 * that this is separate from view focus: to receive key events, both
7130 * your view and its window must have focus. If a window is displayed
7131 * on top of yours that takes input focus, then your own window will lose
7132 * focus but the view focus will remain unchanged.
7133 *
7134 * @param hasWindowFocus True if the window containing this view now has
7135 * focus, false otherwise.
7136 */
7137 public void onWindowFocusChanged(boolean hasWindowFocus) {
7138 InputMethodManager imm = InputMethodManager.peekInstance();
7139 if (!hasWindowFocus) {
7140 if (isPressed()) {
7141 setPressed(false);
7142 }
7143 if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
7144 imm.focusOut(this);
7145 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05007146 removeLongPressCallback();
Tony Wu26edf202010-09-13 19:54:00 +08007147 removeTapCallback();
Romain Guya2431d02009-04-30 16:30:00 -07007148 onFocusLost();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007149 } else if (imm != null && (mPrivateFlags & FOCUSED) != 0) {
7150 imm.focusIn(this);
7151 }
7152 refreshDrawableState();
7153 }
7154
7155 /**
7156 * Returns true if this view is in a window that currently has window focus.
7157 * Note that this is not the same as the view itself having focus.
7158 *
7159 * @return True if this view is in a window that currently has window focus.
7160 */
7161 public boolean hasWindowFocus() {
7162 return mAttachInfo != null && mAttachInfo.mHasWindowFocus;
7163 }
7164
7165 /**
Adam Powell326d8082009-12-09 15:10:07 -08007166 * Dispatch a view visibility change down the view hierarchy.
7167 * ViewGroups should override to route to their children.
7168 * @param changedView The view whose visibility changed. Could be 'this' or
7169 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08007170 * @param visibility The new visibility of changedView: {@link #VISIBLE},
7171 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08007172 */
7173 protected void dispatchVisibilityChanged(View changedView, int visibility) {
7174 onVisibilityChanged(changedView, visibility);
7175 }
7176
7177 /**
7178 * Called when the visibility of the view or an ancestor of the view is changed.
7179 * @param changedView The view whose visibility changed. Could be 'this' or
7180 * an ancestor view.
Romain Guy43c9cdf2010-01-27 13:53:55 -08007181 * @param visibility The new visibility of changedView: {@link #VISIBLE},
7182 * {@link #INVISIBLE} or {@link #GONE}.
Adam Powell326d8082009-12-09 15:10:07 -08007183 */
7184 protected void onVisibilityChanged(View changedView, int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07007185 if (visibility == VISIBLE) {
7186 if (mAttachInfo != null) {
7187 initialAwakenScrollBars();
7188 } else {
7189 mPrivateFlags |= AWAKEN_SCROLL_BARS_ON_ATTACH;
7190 }
7191 }
Adam Powell326d8082009-12-09 15:10:07 -08007192 }
7193
7194 /**
Romain Guy43c9cdf2010-01-27 13:53:55 -08007195 * Dispatch a hint about whether this view is displayed. For instance, when
7196 * a View moves out of the screen, it might receives a display hint indicating
7197 * the view is not displayed. Applications should not <em>rely</em> on this hint
7198 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08007199 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08007200 * @param hint A hint about whether or not this view is displayed:
7201 * {@link #VISIBLE} or {@link #INVISIBLE}.
7202 */
7203 public void dispatchDisplayHint(int hint) {
7204 onDisplayHint(hint);
7205 }
7206
7207 /**
7208 * Gives this view a hint about whether is displayed or not. For instance, when
7209 * a View moves out of the screen, it might receives a display hint indicating
7210 * the view is not displayed. Applications should not <em>rely</em> on this hint
7211 * as there is no guarantee that they will receive one.
Joe Malin32736f02011-01-19 16:14:20 -08007212 *
Romain Guy43c9cdf2010-01-27 13:53:55 -08007213 * @param hint A hint about whether or not this view is displayed:
7214 * {@link #VISIBLE} or {@link #INVISIBLE}.
7215 */
7216 protected void onDisplayHint(int hint) {
7217 }
7218
7219 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007220 * Dispatch a window visibility change down the view hierarchy.
7221 * ViewGroups should override to route to their children.
7222 *
7223 * @param visibility The new visibility of the window.
7224 *
Philip Milne6c8ea062012-04-03 17:38:43 -07007225 * @see #onWindowVisibilityChanged(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007226 */
7227 public void dispatchWindowVisibilityChanged(int visibility) {
7228 onWindowVisibilityChanged(visibility);
7229 }
7230
7231 /**
7232 * Called when the window containing has change its visibility
7233 * (between {@link #GONE}, {@link #INVISIBLE}, and {@link #VISIBLE}). Note
7234 * that this tells you whether or not your window is being made visible
7235 * to the window manager; this does <em>not</em> tell you whether or not
7236 * your window is obscured by other windows on the screen, even if it
7237 * is itself visible.
7238 *
7239 * @param visibility The new visibility of the window.
7240 */
7241 protected void onWindowVisibilityChanged(int visibility) {
Adam Powell8568c3a2010-04-19 14:26:11 -07007242 if (visibility == VISIBLE) {
7243 initialAwakenScrollBars();
7244 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007245 }
7246
7247 /**
7248 * Returns the current visibility of the window this view is attached to
7249 * (either {@link #GONE}, {@link #INVISIBLE}, or {@link #VISIBLE}).
7250 *
7251 * @return Returns the current visibility of the view's window.
7252 */
7253 public int getWindowVisibility() {
7254 return mAttachInfo != null ? mAttachInfo.mWindowVisibility : GONE;
7255 }
7256
7257 /**
7258 * Retrieve the overall visible display size in which the window this view is
7259 * attached to has been positioned in. This takes into account screen
7260 * decorations above the window, for both cases where the window itself
7261 * is being position inside of them or the window is being placed under
7262 * then and covered insets are used for the window to position its content
7263 * inside. In effect, this tells you the available area where content can
7264 * be placed and remain visible to users.
7265 *
7266 * <p>This function requires an IPC back to the window manager to retrieve
7267 * the requested information, so should not be used in performance critical
7268 * code like drawing.
7269 *
7270 * @param outRect Filled in with the visible display frame. If the view
7271 * is not attached to a window, this is simply the raw display size.
7272 */
7273 public void getWindowVisibleDisplayFrame(Rect outRect) {
7274 if (mAttachInfo != null) {
7275 try {
7276 mAttachInfo.mSession.getDisplayFrame(mAttachInfo.mWindow, outRect);
7277 } catch (RemoteException e) {
7278 return;
7279 }
7280 // XXX This is really broken, and probably all needs to be done
7281 // in the window manager, and we need to know more about whether
7282 // we want the area behind or in front of the IME.
7283 final Rect insets = mAttachInfo.mVisibleInsets;
7284 outRect.left += insets.left;
7285 outRect.top += insets.top;
7286 outRect.right -= insets.right;
7287 outRect.bottom -= insets.bottom;
7288 return;
7289 }
7290 Display d = WindowManagerImpl.getDefault().getDefaultDisplay();
Dianne Hackborn44bc17c2011-04-20 18:18:51 -07007291 d.getRectSize(outRect);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007292 }
7293
7294 /**
Dianne Hackborne36d6e22010-02-17 19:46:25 -08007295 * Dispatch a notification about a resource configuration change down
7296 * the view hierarchy.
7297 * ViewGroups should override to route to their children.
7298 *
7299 * @param newConfig The new resource configuration.
7300 *
Philip Milne6c8ea062012-04-03 17:38:43 -07007301 * @see #onConfigurationChanged(android.content.res.Configuration)
Dianne Hackborne36d6e22010-02-17 19:46:25 -08007302 */
7303 public void dispatchConfigurationChanged(Configuration newConfig) {
7304 onConfigurationChanged(newConfig);
7305 }
7306
7307 /**
7308 * Called when the current configuration of the resources being used
7309 * by the application have changed. You can use this to decide when
7310 * to reload resources that can changed based on orientation and other
7311 * configuration characterstics. You only need to use this if you are
7312 * not relying on the normal {@link android.app.Activity} mechanism of
7313 * recreating the activity instance upon a configuration change.
7314 *
7315 * @param newConfig The new resource configuration.
7316 */
7317 protected void onConfigurationChanged(Configuration newConfig) {
7318 }
7319
7320 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007321 * Private function to aggregate all per-view attributes in to the view
7322 * root.
7323 */
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007324 void dispatchCollectViewAttributes(AttachInfo attachInfo, int visibility) {
7325 performCollectViewAttributes(attachInfo, visibility);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007326 }
7327
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007328 void performCollectViewAttributes(AttachInfo attachInfo, int visibility) {
7329 if ((visibility & VISIBILITY_MASK) == VISIBLE) {
Joe Onorato664644d2011-01-23 17:53:23 -08007330 if ((mViewFlags & KEEP_SCREEN_ON) == KEEP_SCREEN_ON) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007331 attachInfo.mKeepScreenOn = true;
Joe Onorato664644d2011-01-23 17:53:23 -08007332 }
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007333 attachInfo.mSystemUiVisibility |= mSystemUiVisibility;
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007334 ListenerInfo li = mListenerInfo;
7335 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) {
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -07007336 attachInfo.mHasSystemUiListeners = true;
Joe Onorato664644d2011-01-23 17:53:23 -08007337 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007338 }
7339 }
7340
7341 void needGlobalAttributesUpdate(boolean force) {
Joe Onorato664644d2011-01-23 17:53:23 -08007342 final AttachInfo ai = mAttachInfo;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007343 if (ai != null) {
Joe Onorato664644d2011-01-23 17:53:23 -08007344 if (force || ai.mKeepScreenOn || (ai.mSystemUiVisibility != 0)
7345 || ai.mHasSystemUiListeners) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007346 ai.mRecomputeGlobalAttributes = true;
7347 }
7348 }
7349 }
7350
7351 /**
7352 * Returns whether the device is currently in touch mode. Touch mode is entered
7353 * once the user begins interacting with the device by touch, and affects various
7354 * things like whether focus is always visible to the user.
7355 *
7356 * @return Whether the device is in touch mode.
7357 */
7358 @ViewDebug.ExportedProperty
7359 public boolean isInTouchMode() {
7360 if (mAttachInfo != null) {
7361 return mAttachInfo.mInTouchMode;
7362 } else {
Dianne Hackborn6dd005b2011-07-18 13:22:50 -07007363 return ViewRootImpl.isInTouchMode();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007364 }
7365 }
7366
7367 /**
7368 * Returns the context the view is running in, through which it can
7369 * access the current theme, resources, etc.
7370 *
7371 * @return The view's Context.
7372 */
7373 @ViewDebug.CapturedViewProperty
7374 public final Context getContext() {
7375 return mContext;
7376 }
7377
7378 /**
7379 * Handle a key event before it is processed by any input method
7380 * associated with the view hierarchy. This can be used to intercept
7381 * key events in special situations before the IME consumes them; a
7382 * typical example would be handling the BACK key to update the application's
7383 * UI instead of allowing the IME to see it and close itself.
7384 *
7385 * @param keyCode The value in event.getKeyCode().
7386 * @param event Description of the key event.
7387 * @return If you handled the event, return true. If you want to allow the
7388 * event to be handled by the next receiver, return false.
7389 */
7390 public boolean onKeyPreIme(int keyCode, KeyEvent event) {
7391 return false;
7392 }
7393
7394 /**
Jeff Brown995e7742010-12-22 16:59:36 -08007395 * Default implementation of {@link KeyEvent.Callback#onKeyDown(int, KeyEvent)
7396 * KeyEvent.Callback.onKeyDown()}: perform press of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007397 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or {@link KeyEvent#KEYCODE_ENTER}
7398 * is released, if the view is enabled and clickable.
7399 *
7400 * @param keyCode A key code that represents the button pressed, from
7401 * {@link android.view.KeyEvent}.
7402 * @param event The KeyEvent object that defines the button action.
7403 */
7404 public boolean onKeyDown(int keyCode, KeyEvent event) {
7405 boolean result = false;
7406
7407 switch (keyCode) {
7408 case KeyEvent.KEYCODE_DPAD_CENTER:
7409 case KeyEvent.KEYCODE_ENTER: {
7410 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
7411 return true;
7412 }
7413 // Long clickable items don't necessarily have to be clickable
7414 if (((mViewFlags & CLICKABLE) == CLICKABLE ||
7415 (mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) &&
7416 (event.getRepeatCount() == 0)) {
7417 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007418 checkForLongClick(0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007419 return true;
7420 }
7421 break;
7422 }
7423 }
7424 return result;
7425 }
7426
7427 /**
Dianne Hackborn83fe3f52009-09-12 23:38:30 -07007428 * Default implementation of {@link KeyEvent.Callback#onKeyLongPress(int, KeyEvent)
7429 * KeyEvent.Callback.onKeyLongPress()}: always returns false (doesn't handle
7430 * the event).
7431 */
7432 public boolean onKeyLongPress(int keyCode, KeyEvent event) {
7433 return false;
7434 }
7435
7436 /**
Jeff Brown995e7742010-12-22 16:59:36 -08007437 * Default implementation of {@link KeyEvent.Callback#onKeyUp(int, KeyEvent)
7438 * KeyEvent.Callback.onKeyUp()}: perform clicking of the view
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007439 * when {@link KeyEvent#KEYCODE_DPAD_CENTER} or
7440 * {@link KeyEvent#KEYCODE_ENTER} is released.
7441 *
7442 * @param keyCode A key code that represents the button pressed, from
7443 * {@link android.view.KeyEvent}.
7444 * @param event The KeyEvent object that defines the button action.
7445 */
7446 public boolean onKeyUp(int keyCode, KeyEvent event) {
7447 boolean result = false;
7448
7449 switch (keyCode) {
7450 case KeyEvent.KEYCODE_DPAD_CENTER:
7451 case KeyEvent.KEYCODE_ENTER: {
7452 if ((mViewFlags & ENABLED_MASK) == DISABLED) {
7453 return true;
7454 }
7455 if ((mViewFlags & CLICKABLE) == CLICKABLE && isPressed()) {
7456 setPressed(false);
7457
7458 if (!mHasPerformedLongPress) {
7459 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05007460 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007461
7462 result = performClick();
7463 }
7464 }
7465 break;
7466 }
7467 }
7468 return result;
7469 }
7470
7471 /**
7472 * Default implementation of {@link KeyEvent.Callback#onKeyMultiple(int, int, KeyEvent)
7473 * KeyEvent.Callback.onKeyMultiple()}: always returns false (doesn't handle
7474 * the event).
7475 *
7476 * @param keyCode A key code that represents the button pressed, from
7477 * {@link android.view.KeyEvent}.
7478 * @param repeatCount The number of times the action was made.
7479 * @param event The KeyEvent object that defines the button action.
7480 */
7481 public boolean onKeyMultiple(int keyCode, int repeatCount, KeyEvent event) {
7482 return false;
7483 }
7484
7485 /**
Jeff Brown64da12a2011-01-04 19:57:47 -08007486 * Called on the focused view when a key shortcut event is not handled.
7487 * Override this method to implement local key shortcuts for the View.
7488 * Key shortcuts can also be implemented by setting the
7489 * {@link MenuItem#setShortcut(char, char) shortcut} property of menu items.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007490 *
7491 * @param keyCode The value in event.getKeyCode().
7492 * @param event Description of the key event.
7493 * @return If you handled the event, return true. If you want to allow the
7494 * event to be handled by the next receiver, return false.
7495 */
7496 public boolean onKeyShortcut(int keyCode, KeyEvent event) {
7497 return false;
7498 }
7499
7500 /**
7501 * Check whether the called view is a text editor, in which case it
7502 * would make sense to automatically display a soft input window for
7503 * it. Subclasses should override this if they implement
7504 * {@link #onCreateInputConnection(EditorInfo)} to return true if
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007505 * a call on that method would return a non-null InputConnection, and
7506 * they are really a first-class editor that the user would normally
7507 * start typing on when the go into a window containing your view.
Romain Guy8506ab42009-06-11 17:35:47 -07007508 *
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007509 * <p>The default implementation always returns false. This does
7510 * <em>not</em> mean that its {@link #onCreateInputConnection(EditorInfo)}
7511 * will not be called or the user can not otherwise perform edits on your
7512 * view; it is just a hint to the system that this is not the primary
7513 * purpose of this view.
Romain Guy8506ab42009-06-11 17:35:47 -07007514 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007515 * @return Returns true if this view is a text editor, else false.
7516 */
7517 public boolean onCheckIsTextEditor() {
7518 return false;
7519 }
Romain Guy8506ab42009-06-11 17:35:47 -07007520
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007521 /**
7522 * Create a new InputConnection for an InputMethod to interact
7523 * with the view. The default implementation returns null, since it doesn't
7524 * support input methods. You can override this to implement such support.
7525 * This is only needed for views that take focus and text input.
Romain Guy8506ab42009-06-11 17:35:47 -07007526 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007527 * <p>When implementing this, you probably also want to implement
7528 * {@link #onCheckIsTextEditor()} to indicate you will return a
7529 * non-null InputConnection.
7530 *
7531 * @param outAttrs Fill in with attribute information about the connection.
7532 */
7533 public InputConnection onCreateInputConnection(EditorInfo outAttrs) {
7534 return null;
7535 }
7536
7537 /**
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007538 * Called by the {@link android.view.inputmethod.InputMethodManager}
7539 * when a view who is not the current
7540 * input connection target is trying to make a call on the manager. The
7541 * default implementation returns false; you can override this to return
7542 * true for certain views if you are performing InputConnection proxying
7543 * to them.
7544 * @param view The View that is making the InputMethodManager call.
7545 * @return Return true to allow the call, false to reject.
7546 */
7547 public boolean checkInputConnectionProxy(View view) {
7548 return false;
7549 }
Romain Guy8506ab42009-06-11 17:35:47 -07007550
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07007551 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007552 * Show the context menu for this view. It is not safe to hold on to the
7553 * menu after returning from this method.
7554 *
Gilles Debunnef788a9f2010-07-22 10:17:23 -07007555 * You should normally not overload this method. Overload
7556 * {@link #onCreateContextMenu(ContextMenu)} or define an
7557 * {@link OnCreateContextMenuListener} to add items to the context menu.
7558 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007559 * @param menu The context menu to populate
7560 */
7561 public void createContextMenu(ContextMenu menu) {
7562 ContextMenuInfo menuInfo = getContextMenuInfo();
7563
7564 // Sets the current menu info so all items added to menu will have
7565 // my extra info set.
7566 ((MenuBuilder)menu).setCurrentMenuInfo(menuInfo);
7567
7568 onCreateContextMenu(menu);
Dianne Hackborn0500b3c2011-11-01 15:28:43 -07007569 ListenerInfo li = mListenerInfo;
7570 if (li != null && li.mOnCreateContextMenuListener != null) {
7571 li.mOnCreateContextMenuListener.onCreateContextMenu(menu, this, menuInfo);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007572 }
7573
7574 // Clear the extra information so subsequent items that aren't mine don't
7575 // have my extra info.
7576 ((MenuBuilder)menu).setCurrentMenuInfo(null);
7577
7578 if (mParent != null) {
7579 mParent.createContextMenu(menu);
7580 }
7581 }
7582
7583 /**
7584 * Views should implement this if they have extra information to associate
7585 * with the context menu. The return result is supplied as a parameter to
7586 * the {@link OnCreateContextMenuListener#onCreateContextMenu(ContextMenu, View, ContextMenuInfo)}
7587 * callback.
7588 *
7589 * @return Extra information about the item for which the context menu
7590 * should be shown. This information will vary across different
7591 * subclasses of View.
7592 */
7593 protected ContextMenuInfo getContextMenuInfo() {
7594 return null;
7595 }
7596
7597 /**
7598 * Views should implement this if the view itself is going to add items to
7599 * the context menu.
7600 *
7601 * @param menu the context menu to populate
7602 */
7603 protected void onCreateContextMenu(ContextMenu menu) {
7604 }
7605
7606 /**
7607 * Implement this method to handle trackball motion events. The
7608 * <em>relative</em> movement of the trackball since the last event
7609 * can be retrieve with {@link MotionEvent#getX MotionEvent.getX()} and
7610 * {@link MotionEvent#getY MotionEvent.getY()}. These are normalized so
7611 * that a movement of 1 corresponds to the user pressing one DPAD key (so
7612 * they will often be fractional values, representing the more fine-grained
7613 * movement information available from a trackball).
7614 *
7615 * @param event The motion event.
7616 * @return True if the event was handled, false otherwise.
7617 */
7618 public boolean onTrackballEvent(MotionEvent event) {
7619 return false;
7620 }
7621
7622 /**
Jeff Browncb1404e2011-01-15 18:14:15 -08007623 * Implement this method to handle generic motion events.
7624 * <p>
Jeff Brown33bbfd22011-02-24 20:55:35 -08007625 * Generic motion events describe joystick movements, mouse hovers, track pad
7626 * touches, scroll wheel movements and other input events. The
Jeff Browncb1404e2011-01-15 18:14:15 -08007627 * {@link MotionEvent#getSource() source} of the motion event specifies
7628 * the class of input that was received. Implementations of this method
7629 * must examine the bits in the source before processing the event.
7630 * The following code example shows how this is done.
Jeff Brown33bbfd22011-02-24 20:55:35 -08007631 * </p><p>
7632 * Generic motion events with source class {@link InputDevice#SOURCE_CLASS_POINTER}
7633 * are delivered to the view under the pointer. All other generic motion events are
7634 * delivered to the focused view.
Jeff Browncb1404e2011-01-15 18:14:15 -08007635 * </p>
Scott Mainb303d832011-10-12 16:45:18 -07007636 * <pre> public boolean onGenericMotionEvent(MotionEvent event) {
Jeff Browncb1404e2011-01-15 18:14:15 -08007637 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_JOYSTICK) != 0) {
Jeff Brown33bbfd22011-02-24 20:55:35 -08007638 * if (event.getAction() == MotionEvent.ACTION_MOVE) {
7639 * // process the joystick movement...
7640 * return true;
7641 * }
7642 * }
7643 * if ((event.getSource() &amp; InputDevice.SOURCE_CLASS_POINTER) != 0) {
7644 * switch (event.getAction()) {
7645 * case MotionEvent.ACTION_HOVER_MOVE:
7646 * // process the mouse hover movement...
7647 * return true;
7648 * case MotionEvent.ACTION_SCROLL:
7649 * // process the scroll wheel movement...
7650 * return true;
7651 * }
Jeff Browncb1404e2011-01-15 18:14:15 -08007652 * }
7653 * return super.onGenericMotionEvent(event);
Scott Mainb303d832011-10-12 16:45:18 -07007654 * }</pre>
Jeff Browncb1404e2011-01-15 18:14:15 -08007655 *
7656 * @param event The generic motion event being processed.
Jeff Browna032cc02011-03-07 16:56:21 -08007657 * @return True if the event was handled, false otherwise.
Jeff Browncb1404e2011-01-15 18:14:15 -08007658 */
7659 public boolean onGenericMotionEvent(MotionEvent event) {
7660 return false;
7661 }
7662
7663 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007664 * Implement this method to handle hover events.
7665 * <p>
Jeff Brown10b62902011-06-20 16:40:37 -07007666 * This method is called whenever a pointer is hovering into, over, or out of the
7667 * bounds of a view and the view is not currently being touched.
7668 * Hover events are represented as pointer events with action
7669 * {@link MotionEvent#ACTION_HOVER_ENTER}, {@link MotionEvent#ACTION_HOVER_MOVE},
7670 * or {@link MotionEvent#ACTION_HOVER_EXIT}.
7671 * </p>
7672 * <ul>
7673 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_ENTER}
7674 * when the pointer enters the bounds of the view.</li>
7675 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_MOVE}
7676 * when the pointer has already entered the bounds of the view and has moved.</li>
7677 * <li>The view receives a hover event with action {@link MotionEvent#ACTION_HOVER_EXIT}
7678 * when the pointer has exited the bounds of the view or when the pointer is
7679 * about to go down due to a button click, tap, or similar user action that
7680 * causes the view to be touched.</li>
7681 * </ul>
7682 * <p>
7683 * The view should implement this method to return true to indicate that it is
7684 * handling the hover event, such as by changing its drawable state.
Jeff Browna032cc02011-03-07 16:56:21 -08007685 * </p><p>
Jeff Brown10b62902011-06-20 16:40:37 -07007686 * The default implementation calls {@link #setHovered} to update the hovered state
7687 * of the view when a hover enter or hover exit event is received, if the view
Jeff Browna1b24182011-07-28 13:38:24 -07007688 * is enabled and is clickable. The default implementation also sends hover
7689 * accessibility events.
Jeff Browna032cc02011-03-07 16:56:21 -08007690 * </p>
7691 *
7692 * @param event The motion event that describes the hover.
Jeff Brown10b62902011-06-20 16:40:37 -07007693 * @return True if the view handled the hover event.
7694 *
7695 * @see #isHovered
7696 * @see #setHovered
7697 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007698 */
7699 public boolean onHoverEvent(MotionEvent event) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007700 // The root view may receive hover (or touch) events that are outside the bounds of
7701 // the window. This code ensures that we only send accessibility events for
7702 // hovers that are actually within the bounds of the root view.
Svetoslav Ganov42138042012-03-20 11:51:39 -07007703 final int action = event.getActionMasked();
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007704 if (!mSendingHoverAccessibilityEvents) {
7705 if ((action == MotionEvent.ACTION_HOVER_ENTER
7706 || action == MotionEvent.ACTION_HOVER_MOVE)
7707 && !hasHoveredChild()
7708 && pointInView(event.getX(), event.getY())) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007709 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_ENTER);
Svetoslav Ganov42138042012-03-20 11:51:39 -07007710 mSendingHoverAccessibilityEvents = true;
Svetoslav Ganove5dfa47d2012-05-08 15:58:32 -07007711 requestAccessibilityFocusFromHover();
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007712 }
7713 } else {
7714 if (action == MotionEvent.ACTION_HOVER_EXIT
Svetoslav Ganov42138042012-03-20 11:51:39 -07007715 || (action == MotionEvent.ACTION_MOVE
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007716 && !pointInView(event.getX(), event.getY()))) {
7717 mSendingHoverAccessibilityEvents = false;
7718 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_HOVER_EXIT);
Svetoslav Ganov42138042012-03-20 11:51:39 -07007719 // If the window does not have input focus we take away accessibility
7720 // focus as soon as the user stop hovering over the view.
Jeff Brown59a422e2012-04-19 15:19:19 -07007721 if (mAttachInfo != null && !mAttachInfo.mHasWindowFocus) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07007722 getViewRootImpl().setAccessibilityFocusedHost(null);
7723 }
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007724 }
Jeff Browna1b24182011-07-28 13:38:24 -07007725 }
7726
Jeff Brown87b7f802011-06-21 18:35:45 -07007727 if (isHoverable()) {
Svetoslav Ganov4c1c1012011-08-31 18:39:18 -07007728 switch (action) {
Jeff Brown10b62902011-06-20 16:40:37 -07007729 case MotionEvent.ACTION_HOVER_ENTER:
7730 setHovered(true);
7731 break;
7732 case MotionEvent.ACTION_HOVER_EXIT:
7733 setHovered(false);
7734 break;
7735 }
Jeff Browna1b24182011-07-28 13:38:24 -07007736
7737 // Dispatch the event to onGenericMotionEvent before returning true.
7738 // This is to provide compatibility with existing applications that
7739 // handled HOVER_MOVE events in onGenericMotionEvent and that would
7740 // break because of the new default handling for hoverable views
7741 // in onHoverEvent.
7742 // Note that onGenericMotionEvent will be called by default when
7743 // onHoverEvent returns false (refer to dispatchGenericMotionEvent).
7744 dispatchGenericMotionEventInternal(event);
Jeff Brown10b62902011-06-20 16:40:37 -07007745 return true;
Jeff Browna032cc02011-03-07 16:56:21 -08007746 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07007747
Svetoslav Ganov736c2752011-04-22 18:30:36 -07007748 return false;
Jeff Browna032cc02011-03-07 16:56:21 -08007749 }
7750
7751 /**
Jeff Brown87b7f802011-06-21 18:35:45 -07007752 * Returns true if the view should handle {@link #onHoverEvent}
7753 * by calling {@link #setHovered} to change its hovered state.
7754 *
7755 * @return True if the view is hoverable.
7756 */
7757 private boolean isHoverable() {
7758 final int viewFlags = mViewFlags;
7759 if ((viewFlags & ENABLED_MASK) == DISABLED) {
7760 return false;
7761 }
7762
7763 return (viewFlags & CLICKABLE) == CLICKABLE
7764 || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE;
7765 }
7766
7767 /**
Jeff Browna032cc02011-03-07 16:56:21 -08007768 * Returns true if the view is currently hovered.
7769 *
7770 * @return True if the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007771 *
7772 * @see #setHovered
7773 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007774 */
Jeff Brown10b62902011-06-20 16:40:37 -07007775 @ViewDebug.ExportedProperty
Jeff Browna032cc02011-03-07 16:56:21 -08007776 public boolean isHovered() {
7777 return (mPrivateFlags & HOVERED) != 0;
7778 }
7779
7780 /**
7781 * Sets whether the view is currently hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007782 * <p>
7783 * Calling this method also changes the drawable state of the view. This
7784 * enables the view to react to hover by using different drawable resources
7785 * to change its appearance.
7786 * </p><p>
7787 * The {@link #onHoverChanged} method is called when the hovered state changes.
7788 * </p>
Jeff Browna032cc02011-03-07 16:56:21 -08007789 *
7790 * @param hovered True if the view is hovered.
Jeff Brown10b62902011-06-20 16:40:37 -07007791 *
7792 * @see #isHovered
7793 * @see #onHoverChanged
Jeff Browna032cc02011-03-07 16:56:21 -08007794 */
7795 public void setHovered(boolean hovered) {
7796 if (hovered) {
7797 if ((mPrivateFlags & HOVERED) == 0) {
7798 mPrivateFlags |= HOVERED;
7799 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07007800 onHoverChanged(true);
Jeff Browna032cc02011-03-07 16:56:21 -08007801 }
7802 } else {
7803 if ((mPrivateFlags & HOVERED) != 0) {
7804 mPrivateFlags &= ~HOVERED;
7805 refreshDrawableState();
Jeff Brown10b62902011-06-20 16:40:37 -07007806 onHoverChanged(false);
Jeff Browna032cc02011-03-07 16:56:21 -08007807 }
7808 }
7809 }
7810
7811 /**
Jeff Brown10b62902011-06-20 16:40:37 -07007812 * Implement this method to handle hover state changes.
7813 * <p>
7814 * This method is called whenever the hover state changes as a result of a
7815 * call to {@link #setHovered}.
7816 * </p>
7817 *
7818 * @param hovered The current hover state, as returned by {@link #isHovered}.
7819 *
7820 * @see #isHovered
7821 * @see #setHovered
7822 */
7823 public void onHoverChanged(boolean hovered) {
Jeff Brown10b62902011-06-20 16:40:37 -07007824 }
7825
7826 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007827 * Implement this method to handle touch screen motion events.
7828 *
7829 * @param event The motion event.
7830 * @return True if the event was handled, false otherwise.
7831 */
7832 public boolean onTouchEvent(MotionEvent event) {
7833 final int viewFlags = mViewFlags;
7834
7835 if ((viewFlags & ENABLED_MASK) == DISABLED) {
Svetoslav Ganov77b80c02011-03-15 20:52:58 -07007836 if (event.getAction() == MotionEvent.ACTION_UP && (mPrivateFlags & PRESSED) != 0) {
Adam Powell4d6f0662012-02-21 15:11:11 -08007837 setPressed(false);
Svetoslav Ganov77b80c02011-03-15 20:52:58 -07007838 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007839 // A disabled view that is clickable still consumes the touch
7840 // events, it just doesn't respond to them.
7841 return (((viewFlags & CLICKABLE) == CLICKABLE ||
7842 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
7843 }
7844
7845 if (mTouchDelegate != null) {
7846 if (mTouchDelegate.onTouchEvent(event)) {
7847 return true;
7848 }
7849 }
7850
7851 if (((viewFlags & CLICKABLE) == CLICKABLE ||
7852 (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
7853 switch (event.getAction()) {
7854 case MotionEvent.ACTION_UP:
Adam Powelle14579b2009-12-16 18:39:52 -08007855 boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
7856 if ((mPrivateFlags & PRESSED) != 0 || prepressed) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007857 // take focus if we don't have it already and we should in
7858 // touch mode.
7859 boolean focusTaken = false;
7860 if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
7861 focusTaken = requestFocus();
7862 }
7863
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08007864 if (prepressed) {
7865 // The button is being released before we actually
7866 // showed it as pressed. Make it show the pressed
7867 // state now (before scheduling the click) to ensure
7868 // the user sees it.
Adam Powell4d6f0662012-02-21 15:11:11 -08007869 setPressed(true);
Dianne Hackbornbe1f6222011-01-20 15:24:28 -08007870 }
Joe Malin32736f02011-01-19 16:14:20 -08007871
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007872 if (!mHasPerformedLongPress) {
7873 // This is a tap, so remove the longpress check
Maryam Garrett1549dd12009-12-15 16:06:36 -05007874 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007875
7876 // Only perform take click actions if we were in the pressed state
7877 if (!focusTaken) {
Adam Powella35d7682010-03-12 14:48:13 -08007878 // Use a Runnable and post this rather than calling
7879 // performClick directly. This lets other visual state
7880 // of the view update before click actions start.
7881 if (mPerformClick == null) {
7882 mPerformClick = new PerformClick();
7883 }
7884 if (!post(mPerformClick)) {
7885 performClick();
7886 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007887 }
7888 }
7889
7890 if (mUnsetPressedState == null) {
7891 mUnsetPressedState = new UnsetPressedState();
7892 }
7893
Adam Powelle14579b2009-12-16 18:39:52 -08007894 if (prepressed) {
Adam Powelle14579b2009-12-16 18:39:52 -08007895 postDelayed(mUnsetPressedState,
7896 ViewConfiguration.getPressedStateDuration());
7897 } else if (!post(mUnsetPressedState)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007898 // If the post failed, unpress right now
7899 mUnsetPressedState.run();
7900 }
Adam Powelle14579b2009-12-16 18:39:52 -08007901 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007902 }
7903 break;
7904
7905 case MotionEvent.ACTION_DOWN:
Adam Powell3b023392010-03-11 16:30:28 -08007906 mHasPerformedLongPress = false;
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007907
Jeff Brownfe9f8ab2011-05-06 18:20:01 -07007908 if (performButtonActionOnTouchDown(event)) {
7909 break;
7910 }
7911
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007912 // Walk up the hierarchy to determine if we're inside a scrolling container.
Adam Powell10298662011-08-14 18:26:30 -07007913 boolean isInScrollingContainer = isInScrollingContainer();
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007914
7915 // For views inside a scrolling container, delay the pressed feedback for
7916 // a short period in case this is a scroll.
7917 if (isInScrollingContainer) {
7918 mPrivateFlags |= PREPRESSED;
7919 if (mPendingCheckForTap == null) {
7920 mPendingCheckForTap = new CheckForTap();
7921 }
7922 postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
7923 } else {
7924 // Not inside a scrolling container, so show the feedback right away
Adam Powell4d6f0662012-02-21 15:11:11 -08007925 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -07007926 checkForLongClick(0);
7927 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007928 break;
7929
7930 case MotionEvent.ACTION_CANCEL:
Adam Powell4d6f0662012-02-21 15:11:11 -08007931 setPressed(false);
Adam Powelle14579b2009-12-16 18:39:52 -08007932 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007933 break;
7934
7935 case MotionEvent.ACTION_MOVE:
7936 final int x = (int) event.getX();
7937 final int y = (int) event.getY();
7938
7939 // Be lenient about moving outside of buttons
Chet Haasec3aa3612010-06-17 08:50:37 -07007940 if (!pointInView(x, y, mTouchSlop)) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007941 // Outside button
Adam Powelle14579b2009-12-16 18:39:52 -08007942 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007943 if ((mPrivateFlags & PRESSED) != 0) {
Adam Powelle14579b2009-12-16 18:39:52 -08007944 // Remove any future long press/tap checks
Maryam Garrett1549dd12009-12-15 16:06:36 -05007945 removeLongPressCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007946
Adam Powell4d6f0662012-02-21 15:11:11 -08007947 setPressed(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007948 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08007949 }
7950 break;
7951 }
7952 return true;
7953 }
7954
7955 return false;
7956 }
7957
7958 /**
Adam Powell10298662011-08-14 18:26:30 -07007959 * @hide
7960 */
7961 public boolean isInScrollingContainer() {
7962 ViewParent p = getParent();
7963 while (p != null && p instanceof ViewGroup) {
7964 if (((ViewGroup) p).shouldDelayChildPressedState()) {
7965 return true;
7966 }
7967 p = p.getParent();
7968 }
7969 return false;
7970 }
7971
7972 /**
Maryam Garrett1549dd12009-12-15 16:06:36 -05007973 * Remove the longpress detection timer.
7974 */
7975 private void removeLongPressCallback() {
7976 if (mPendingCheckForLongPress != null) {
7977 removeCallbacks(mPendingCheckForLongPress);
7978 }
7979 }
Adam Powell3cb8b632011-01-21 15:34:14 -08007980
7981 /**
7982 * Remove the pending click action
7983 */
7984 private void removePerformClickCallback() {
7985 if (mPerformClick != null) {
7986 removeCallbacks(mPerformClick);
7987 }
7988 }
7989
Adam Powelle14579b2009-12-16 18:39:52 -08007990 /**
Romain Guya440b002010-02-24 15:57:54 -08007991 * Remove the prepress detection timer.
7992 */
7993 private void removeUnsetPressCallback() {
7994 if ((mPrivateFlags & PRESSED) != 0 && mUnsetPressedState != null) {
7995 setPressed(false);
7996 removeCallbacks(mUnsetPressedState);
7997 }
7998 }
7999
8000 /**
Adam Powelle14579b2009-12-16 18:39:52 -08008001 * Remove the tap detection timer.
8002 */
8003 private void removeTapCallback() {
8004 if (mPendingCheckForTap != null) {
8005 mPrivateFlags &= ~PREPRESSED;
8006 removeCallbacks(mPendingCheckForTap);
8007 }
8008 }
Maryam Garrett1549dd12009-12-15 16:06:36 -05008009
8010 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008011 * Cancels a pending long press. Your subclass can use this if you
8012 * want the context menu to come up if the user presses and holds
8013 * at the same place, but you don't want it to come up if they press
8014 * and then move around enough to cause scrolling.
8015 */
8016 public void cancelLongPress() {
Maryam Garrett1549dd12009-12-15 16:06:36 -05008017 removeLongPressCallback();
Adam Powell732ebb12010-02-02 15:28:14 -08008018
8019 /*
8020 * The prepressed state handled by the tap callback is a display
8021 * construct, but the tap callback will post a long press callback
8022 * less its own timeout. Remove it here.
8023 */
8024 removeTapCallback();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008025 }
8026
8027 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -07008028 * Remove the pending callback for sending a
8029 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
8030 */
8031 private void removeSendViewScrolledAccessibilityEventCallback() {
8032 if (mSendViewScrolledAccessibilityEvent != null) {
8033 removeCallbacks(mSendViewScrolledAccessibilityEvent);
8034 }
8035 }
8036
8037 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008038 * Sets the TouchDelegate for this View.
8039 */
8040 public void setTouchDelegate(TouchDelegate delegate) {
8041 mTouchDelegate = delegate;
8042 }
8043
8044 /**
8045 * Gets the TouchDelegate for this View.
8046 */
8047 public TouchDelegate getTouchDelegate() {
8048 return mTouchDelegate;
8049 }
8050
8051 /**
8052 * Set flags controlling behavior of this view.
8053 *
8054 * @param flags Constant indicating the value which should be set
8055 * @param mask Constant indicating the bit range that should be changed
8056 */
8057 void setFlags(int flags, int mask) {
8058 int old = mViewFlags;
8059 mViewFlags = (mViewFlags & ~mask) | (flags & mask);
8060
8061 int changed = mViewFlags ^ old;
8062 if (changed == 0) {
8063 return;
8064 }
8065 int privateFlags = mPrivateFlags;
8066
8067 /* Check if the FOCUSABLE bit has changed */
8068 if (((changed & FOCUSABLE_MASK) != 0) &&
8069 ((privateFlags & HAS_BOUNDS) !=0)) {
8070 if (((old & FOCUSABLE_MASK) == FOCUSABLE)
8071 && ((privateFlags & FOCUSED) != 0)) {
8072 /* Give up focus if we are no longer focusable */
8073 clearFocus();
8074 } else if (((old & FOCUSABLE_MASK) == NOT_FOCUSABLE)
8075 && ((privateFlags & FOCUSED) == 0)) {
8076 /*
8077 * Tell the view system that we are now available to take focus
8078 * if no one else already has it.
8079 */
8080 if (mParent != null) mParent.focusableViewAvailable(this);
8081 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07008082 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
8083 notifyAccessibilityStateChanged();
8084 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008085 }
8086
8087 if ((flags & VISIBILITY_MASK) == VISIBLE) {
8088 if ((changed & VISIBILITY_MASK) != 0) {
8089 /*
Chet Haase4324ead2011-08-24 21:31:03 -07008090 * If this view is becoming visible, invalidate it in case it changed while
Chet Haaseaceafe62011-08-26 15:44:33 -07008091 * it was not visible. Marking it drawn ensures that the invalidation will
8092 * go through.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008093 */
Chet Haaseaceafe62011-08-26 15:44:33 -07008094 mPrivateFlags |= DRAWN;
Chet Haase4324ead2011-08-24 21:31:03 -07008095 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008096
8097 needGlobalAttributesUpdate(true);
8098
8099 // a view becoming visible is worth notifying the parent
8100 // about in case nothing has focus. even if this specific view
8101 // isn't focusable, it may contain something that is, so let
8102 // the root view try to give this focus if nothing else does.
8103 if ((mParent != null) && (mBottom > mTop) && (mRight > mLeft)) {
8104 mParent.focusableViewAvailable(this);
8105 }
8106 }
8107 }
8108
8109 /* Check if the GONE bit has changed */
8110 if ((changed & GONE) != 0) {
8111 needGlobalAttributesUpdate(false);
8112 requestLayout();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008113
Romain Guyecd80ee2009-12-03 17:13:02 -08008114 if (((mViewFlags & VISIBILITY_MASK) == GONE)) {
8115 if (hasFocus()) clearFocus();
Svetoslav Ganov42138042012-03-20 11:51:39 -07008116 clearAccessibilityFocus();
Romain Guyecd80ee2009-12-03 17:13:02 -08008117 destroyDrawingCache();
Chet Haaseaceafe62011-08-26 15:44:33 -07008118 if (mParent instanceof View) {
8119 // GONE views noop invalidation, so invalidate the parent
8120 ((View) mParent).invalidate(true);
8121 }
8122 // Mark the view drawn to ensure that it gets invalidated properly the next
8123 // time it is visible and gets invalidated
8124 mPrivateFlags |= DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008125 }
8126 if (mAttachInfo != null) {
8127 mAttachInfo.mViewVisibilityChanged = true;
8128 }
8129 }
8130
8131 /* Check if the VISIBLE bit has changed */
8132 if ((changed & INVISIBLE) != 0) {
8133 needGlobalAttributesUpdate(false);
Chet Haasec8a9a702011-06-17 12:13:42 -07008134 /*
8135 * If this view is becoming invisible, set the DRAWN flag so that
8136 * the next invalidate() will not be skipped.
8137 */
8138 mPrivateFlags |= DRAWN;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008139
8140 if (((mViewFlags & VISIBILITY_MASK) == INVISIBLE) && hasFocus()) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07008141 // root view becoming invisible shouldn't clear focus and accessibility focus
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008142 if (getRootView() != this) {
8143 clearFocus();
Svetoslav Ganov42138042012-03-20 11:51:39 -07008144 clearAccessibilityFocus();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008145 }
8146 }
8147 if (mAttachInfo != null) {
8148 mAttachInfo.mViewVisibilityChanged = true;
8149 }
8150 }
8151
Adam Powell326d8082009-12-09 15:10:07 -08008152 if ((changed & VISIBILITY_MASK) != 0) {
Chet Haase5e25c2c2010-09-16 11:15:56 -07008153 if (mParent instanceof ViewGroup) {
Romain Guyfe455af2012-02-15 16:40:20 -08008154 ((ViewGroup) mParent).onChildVisibilityChanged(this,
8155 (changed & VISIBILITY_MASK), (flags & VISIBILITY_MASK));
Romain Guy0fd89bf2011-01-26 15:41:30 -08008156 ((View) mParent).invalidate(true);
Chet Haasee4e6e202011-08-29 14:34:30 -07008157 } else if (mParent != null) {
8158 mParent.invalidateChild(this, null);
Chet Haase5e25c2c2010-09-16 11:15:56 -07008159 }
Adam Powell326d8082009-12-09 15:10:07 -08008160 dispatchVisibilityChanged(this, (flags & VISIBILITY_MASK));
8161 }
8162
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008163 if ((changed & WILL_NOT_CACHE_DRAWING) != 0) {
8164 destroyDrawingCache();
8165 }
8166
8167 if ((changed & DRAWING_CACHE_ENABLED) != 0) {
8168 destroyDrawingCache();
8169 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Romain Guy0fd89bf2011-01-26 15:41:30 -08008170 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008171 }
8172
8173 if ((changed & DRAWING_CACHE_QUALITY_MASK) != 0) {
8174 destroyDrawingCache();
8175 mPrivateFlags &= ~DRAWING_CACHE_VALID;
8176 }
8177
8178 if ((changed & DRAW_MASK) != 0) {
8179 if ((mViewFlags & WILL_NOT_DRAW) != 0) {
Philip Milne6c8ea062012-04-03 17:38:43 -07008180 if (mBackground != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008181 mPrivateFlags &= ~SKIP_DRAW;
8182 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
8183 } else {
8184 mPrivateFlags |= SKIP_DRAW;
8185 }
8186 } else {
8187 mPrivateFlags &= ~SKIP_DRAW;
8188 }
8189 requestLayout();
Romain Guy0fd89bf2011-01-26 15:41:30 -08008190 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008191 }
8192
8193 if ((changed & KEEP_SCREEN_ON) != 0) {
Joe Onorato664644d2011-01-23 17:53:23 -08008194 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008195 mParent.recomputeViewAttributes(this);
8196 }
8197 }
Svetoslav Ganov42138042012-03-20 11:51:39 -07008198
8199 if (AccessibilityManager.getInstance(mContext).isEnabled()
8200 && ((changed & FOCUSABLE) != 0 || (changed & CLICKABLE) != 0
8201 || (changed & LONG_CLICKABLE) != 0 || (changed & ENABLED) != 0)) {
8202 notifyAccessibilityStateChanged();
8203 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008204 }
8205
8206 /**
8207 * Change the view's z order in the tree, so it's on top of other sibling
8208 * views
8209 */
8210 public void bringToFront() {
8211 if (mParent != null) {
8212 mParent.bringChildToFront(this);
8213 }
8214 }
8215
8216 /**
8217 * This is called in response to an internal scroll in this view (i.e., the
8218 * view scrolled its own contents). This is typically as a result of
8219 * {@link #scrollBy(int, int)} or {@link #scrollTo(int, int)} having been
8220 * called.
8221 *
8222 * @param l Current horizontal scroll origin.
8223 * @param t Current vertical scroll origin.
8224 * @param oldl Previous horizontal scroll origin.
8225 * @param oldt Previous vertical scroll origin.
8226 */
8227 protected void onScrollChanged(int l, int t, int oldl, int oldt) {
Svetoslav Ganova0156172011-06-26 17:55:44 -07008228 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
8229 postSendViewScrolledAccessibilityEventCallback();
8230 }
8231
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008232 mBackgroundSizeChanged = true;
8233
8234 final AttachInfo ai = mAttachInfo;
8235 if (ai != null) {
8236 ai.mViewScrollChanged = true;
8237 }
8238 }
8239
8240 /**
Chet Haase21cd1382010-09-01 17:42:29 -07008241 * Interface definition for a callback to be invoked when the layout bounds of a view
8242 * changes due to layout processing.
8243 */
8244 public interface OnLayoutChangeListener {
8245 /**
8246 * Called when the focus state of a view has changed.
8247 *
8248 * @param v The view whose state has changed.
8249 * @param left The new value of the view's left property.
8250 * @param top The new value of the view's top property.
8251 * @param right The new value of the view's right property.
8252 * @param bottom The new value of the view's bottom property.
8253 * @param oldLeft The previous value of the view's left property.
8254 * @param oldTop The previous value of the view's top property.
8255 * @param oldRight The previous value of the view's right property.
8256 * @param oldBottom The previous value of the view's bottom property.
8257 */
8258 void onLayoutChange(View v, int left, int top, int right, int bottom,
8259 int oldLeft, int oldTop, int oldRight, int oldBottom);
8260 }
8261
8262 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008263 * This is called during layout when the size of this view has changed. If
8264 * you were just added to the view hierarchy, you're called with the old
8265 * values of 0.
8266 *
8267 * @param w Current width of this view.
8268 * @param h Current height of this view.
8269 * @param oldw Old width of this view.
8270 * @param oldh Old height of this view.
8271 */
8272 protected void onSizeChanged(int w, int h, int oldw, int oldh) {
8273 }
8274
8275 /**
8276 * Called by draw to draw the child views. This may be overridden
8277 * by derived classes to gain control just before its children are drawn
8278 * (but after its own view has been drawn).
8279 * @param canvas the canvas on which to draw the view
8280 */
8281 protected void dispatchDraw(Canvas canvas) {
Svetoslav Ganov42138042012-03-20 11:51:39 -07008282
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008283 }
8284
8285 /**
8286 * Gets the parent of this view. Note that the parent is a
8287 * ViewParent and not necessarily a View.
8288 *
8289 * @return Parent of this view.
8290 */
8291 public final ViewParent getParent() {
8292 return mParent;
8293 }
8294
8295 /**
Chet Haasecca2c982011-05-20 14:34:18 -07008296 * Set the horizontal scrolled position of your view. This will cause a call to
8297 * {@link #onScrollChanged(int, int, int, int)} and the view will be
8298 * invalidated.
8299 * @param value the x position to scroll to
8300 */
8301 public void setScrollX(int value) {
8302 scrollTo(value, mScrollY);
8303 }
8304
8305 /**
8306 * Set the vertical scrolled position of your view. This will cause a call to
8307 * {@link #onScrollChanged(int, int, int, int)} and the view will be
8308 * invalidated.
8309 * @param value the y position to scroll to
8310 */
8311 public void setScrollY(int value) {
8312 scrollTo(mScrollX, value);
8313 }
8314
8315 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008316 * Return the scrolled left position of this view. This is the left edge of
8317 * the displayed part of your view. You do not need to draw any pixels
8318 * farther left, since those are outside of the frame of your view on
8319 * screen.
8320 *
8321 * @return The left edge of the displayed part of your view, in pixels.
8322 */
8323 public final int getScrollX() {
8324 return mScrollX;
8325 }
8326
8327 /**
8328 * Return the scrolled top position of this view. This is the top edge of
8329 * the displayed part of your view. You do not need to draw any pixels above
8330 * it, since those are outside of the frame of your view on screen.
8331 *
8332 * @return The top edge of the displayed part of your view, in pixels.
8333 */
8334 public final int getScrollY() {
8335 return mScrollY;
8336 }
8337
8338 /**
8339 * Return the width of the your view.
8340 *
8341 * @return The width of your view, in pixels.
8342 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008343 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008344 public final int getWidth() {
8345 return mRight - mLeft;
8346 }
8347
8348 /**
8349 * Return the height of your view.
8350 *
8351 * @return The height of your view, in pixels.
8352 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -07008353 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008354 public final int getHeight() {
8355 return mBottom - mTop;
8356 }
8357
8358 /**
8359 * Return the visible drawing bounds of your view. Fills in the output
8360 * rectangle with the values from getScrollX(), getScrollY(),
8361 * getWidth(), and getHeight().
8362 *
8363 * @param outRect The (scrolled) drawing bounds of the view.
8364 */
8365 public void getDrawingRect(Rect outRect) {
8366 outRect.left = mScrollX;
8367 outRect.top = mScrollY;
8368 outRect.right = mScrollX + (mRight - mLeft);
8369 outRect.bottom = mScrollY + (mBottom - mTop);
8370 }
8371
8372 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008373 * Like {@link #getMeasuredWidthAndState()}, but only returns the
8374 * raw width component (that is the result is masked by
8375 * {@link #MEASURED_SIZE_MASK}).
8376 *
8377 * @return The raw measured width of this view.
8378 */
8379 public final int getMeasuredWidth() {
8380 return mMeasuredWidth & MEASURED_SIZE_MASK;
8381 }
8382
8383 /**
8384 * Return the full width measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07008385 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08008386 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008387 * This should be used during measurement and layout calculations only. Use
8388 * {@link #getWidth()} to see how wide a view is after layout.
8389 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08008390 * @return The measured width of this view as a bit mask.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008391 */
Dianne Hackborn189ee182010-12-02 21:48:53 -08008392 public final int getMeasuredWidthAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008393 return mMeasuredWidth;
8394 }
8395
8396 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008397 * Like {@link #getMeasuredHeightAndState()}, but only returns the
8398 * raw width component (that is the result is masked by
8399 * {@link #MEASURED_SIZE_MASK}).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008400 *
Dianne Hackborn189ee182010-12-02 21:48:53 -08008401 * @return The raw measured height of this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008402 */
8403 public final int getMeasuredHeight() {
Dianne Hackborn189ee182010-12-02 21:48:53 -08008404 return mMeasuredHeight & MEASURED_SIZE_MASK;
8405 }
8406
8407 /**
8408 * Return the full height measurement information for this view as computed
Romain Guy5c22a8c2011-05-13 11:48:45 -07008409 * by the most recent call to {@link #measure(int, int)}. This result is a bit mask
Dianne Hackborn189ee182010-12-02 21:48:53 -08008410 * as defined by {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
8411 * This should be used during measurement and layout calculations only. Use
8412 * {@link #getHeight()} to see how wide a view is after layout.
8413 *
8414 * @return The measured width of this view as a bit mask.
8415 */
8416 public final int getMeasuredHeightAndState() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08008417 return mMeasuredHeight;
8418 }
8419
8420 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -08008421 * Return only the state bits of {@link #getMeasuredWidthAndState()}
8422 * and {@link #getMeasuredHeightAndState()}, combined into one integer.
8423 * The width component is in the regular bits {@link #MEASURED_STATE_MASK}
8424 * and the height component is at the shifted bits
8425 * {@link #MEASURED_HEIGHT_STATE_SHIFT}>>{@link #MEASURED_STATE_MASK}.
8426 */
8427 public final int getMeasuredState() {
8428 return (mMeasuredWidth&MEASURED_STATE_MASK)
8429 | ((mMeasuredHeight>>MEASURED_HEIGHT_STATE_SHIFT)
8430 & (MEASURED_STATE_MASK>>MEASURED_HEIGHT_STATE_SHIFT));
8431 }
8432
8433 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008434 * The transform matrix of this view, which is calculated based on the current
8435 * roation, scale, and pivot properties.
8436 *
8437 * @see #getRotation()
8438 * @see #getScaleX()
8439 * @see #getScaleY()
8440 * @see #getPivotX()
8441 * @see #getPivotY()
8442 * @return The current transform matrix for the view
8443 */
8444 public Matrix getMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008445 if (mTransformationInfo != null) {
8446 updateMatrix();
8447 return mTransformationInfo.mMatrix;
8448 }
8449 return Matrix.IDENTITY_MATRIX;
Romain Guy33e72ae2010-07-17 12:40:29 -07008450 }
8451
8452 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07008453 * Utility function to determine if the value is far enough away from zero to be
8454 * considered non-zero.
8455 * @param value A floating point value to check for zero-ness
8456 * @return whether the passed-in value is far enough away from zero to be considered non-zero
8457 */
8458 private static boolean nonzero(float value) {
8459 return (value < -NONZERO_EPSILON || value > NONZERO_EPSILON);
8460 }
8461
8462 /**
Jeff Brown86671742010-09-30 20:00:15 -07008463 * Returns true if the transform matrix is the identity matrix.
8464 * Recomputes the matrix if necessary.
Joe Malin32736f02011-01-19 16:14:20 -08008465 *
Romain Guy33e72ae2010-07-17 12:40:29 -07008466 * @return True if the transform matrix is the identity matrix, false otherwise.
8467 */
Jeff Brown86671742010-09-30 20:00:15 -07008468 final boolean hasIdentityMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008469 if (mTransformationInfo != null) {
8470 updateMatrix();
8471 return mTransformationInfo.mMatrixIsIdentity;
8472 }
8473 return true;
8474 }
8475
8476 void ensureTransformationInfo() {
8477 if (mTransformationInfo == null) {
8478 mTransformationInfo = new TransformationInfo();
8479 }
Jeff Brown86671742010-09-30 20:00:15 -07008480 }
8481
8482 /**
8483 * Recomputes the transform matrix if necessary.
8484 */
Romain Guy2fe9a8f2010-10-04 20:17:01 -07008485 private void updateMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008486 final TransformationInfo info = mTransformationInfo;
8487 if (info == null) {
8488 return;
8489 }
8490 if (info.mMatrixDirty) {
Chet Haasec3aa3612010-06-17 08:50:37 -07008491 // transform-related properties have changed since the last time someone
8492 // asked for the matrix; recalculate it with the current values
Chet Haasefd2b0022010-08-06 13:08:56 -07008493
8494 // Figure out if we need to update the pivot point
8495 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008496 if ((mRight - mLeft) != info.mPrevWidth || (mBottom - mTop) != info.mPrevHeight) {
8497 info.mPrevWidth = mRight - mLeft;
8498 info.mPrevHeight = mBottom - mTop;
8499 info.mPivotX = info.mPrevWidth / 2f;
8500 info.mPivotY = info.mPrevHeight / 2f;
Chet Haasefd2b0022010-08-06 13:08:56 -07008501 }
8502 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008503 info.mMatrix.reset();
8504 if (!nonzero(info.mRotationX) && !nonzero(info.mRotationY)) {
8505 info.mMatrix.setTranslate(info.mTranslationX, info.mTranslationY);
8506 info.mMatrix.preRotate(info.mRotation, info.mPivotX, info.mPivotY);
8507 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY);
Chet Haase897247b2010-09-09 14:54:47 -07008508 } else {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008509 if (info.mCamera == null) {
8510 info.mCamera = new Camera();
8511 info.matrix3D = new Matrix();
Chet Haasefd2b0022010-08-06 13:08:56 -07008512 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008513 info.mCamera.save();
8514 info.mMatrix.preScale(info.mScaleX, info.mScaleY, info.mPivotX, info.mPivotY);
8515 info.mCamera.rotate(info.mRotationX, info.mRotationY, -info.mRotation);
8516 info.mCamera.getMatrix(info.matrix3D);
8517 info.matrix3D.preTranslate(-info.mPivotX, -info.mPivotY);
8518 info.matrix3D.postTranslate(info.mPivotX + info.mTranslationX,
8519 info.mPivotY + info.mTranslationY);
8520 info.mMatrix.postConcat(info.matrix3D);
8521 info.mCamera.restore();
Chet Haasefd2b0022010-08-06 13:08:56 -07008522 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008523 info.mMatrixDirty = false;
8524 info.mMatrixIsIdentity = info.mMatrix.isIdentity();
8525 info.mInverseMatrixDirty = true;
Chet Haasec3aa3612010-06-17 08:50:37 -07008526 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008527 }
8528
8529 /**
8530 * Utility method to retrieve the inverse of the current mMatrix property.
8531 * We cache the matrix to avoid recalculating it when transform properties
8532 * have not changed.
8533 *
8534 * @return The inverse of the current matrix of this view.
8535 */
Jeff Brown86671742010-09-30 20:00:15 -07008536 final Matrix getInverseMatrix() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008537 final TransformationInfo info = mTransformationInfo;
8538 if (info != null) {
8539 updateMatrix();
8540 if (info.mInverseMatrixDirty) {
8541 if (info.mInverseMatrix == null) {
8542 info.mInverseMatrix = new Matrix();
8543 }
8544 info.mMatrix.invert(info.mInverseMatrix);
8545 info.mInverseMatrixDirty = false;
Chet Haasec3aa3612010-06-17 08:50:37 -07008546 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008547 return info.mInverseMatrix;
Chet Haasec3aa3612010-06-17 08:50:37 -07008548 }
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008549 return Matrix.IDENTITY_MATRIX;
Chet Haasec3aa3612010-06-17 08:50:37 -07008550 }
8551
8552 /**
Chet Haasea1cff502012-02-21 13:43:44 -08008553 * Gets the distance along the Z axis from the camera to this view.
8554 *
8555 * @see #setCameraDistance(float)
8556 *
8557 * @return The distance along the Z axis.
8558 */
8559 public float getCameraDistance() {
8560 ensureTransformationInfo();
8561 final float dpi = mResources.getDisplayMetrics().densityDpi;
8562 final TransformationInfo info = mTransformationInfo;
8563 if (info.mCamera == null) {
8564 info.mCamera = new Camera();
8565 info.matrix3D = new Matrix();
8566 }
8567 return -(info.mCamera.getLocationZ() * dpi);
8568 }
8569
8570 /**
Romain Guya5364ee2011-02-24 14:46:04 -08008571 * <p>Sets the distance along the Z axis (orthogonal to the X/Y plane on which
8572 * views are drawn) from the camera to this view. The camera's distance
8573 * affects 3D transformations, for instance rotations around the X and Y
8574 * axis. If the rotationX or rotationY properties are changed and this view is
Philip Milne6c8ea062012-04-03 17:38:43 -07008575 * large (more than half the size of the screen), it is recommended to always
Romain Guya5364ee2011-02-24 14:46:04 -08008576 * use a camera distance that's greater than the height (X axis rotation) or
8577 * the width (Y axis rotation) of this view.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008578 *
Romain Guya5364ee2011-02-24 14:46:04 -08008579 * <p>The distance of the camera from the view plane can have an affect on the
8580 * perspective distortion of the view when it is rotated around the x or y axis.
8581 * For example, a large distance will result in a large viewing angle, and there
8582 * will not be much perspective distortion of the view as it rotates. A short
Philip Milne6c8ea062012-04-03 17:38:43 -07008583 * distance may cause much more perspective distortion upon rotation, and can
Romain Guya5364ee2011-02-24 14:46:04 -08008584 * also result in some drawing artifacts if the rotated view ends up partially
8585 * behind the camera (which is why the recommendation is to use a distance at
8586 * least as far as the size of the view, if the view is to be rotated.)</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008587 *
Romain Guya5364ee2011-02-24 14:46:04 -08008588 * <p>The distance is expressed in "depth pixels." The default distance depends
8589 * on the screen density. For instance, on a medium density display, the
8590 * default distance is 1280. On a high density display, the default distance
8591 * is 1920.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008592 *
Romain Guya5364ee2011-02-24 14:46:04 -08008593 * <p>If you want to specify a distance that leads to visually consistent
8594 * results across various densities, use the following formula:</p>
8595 * <pre>
8596 * float scale = context.getResources().getDisplayMetrics().density;
8597 * view.setCameraDistance(distance * scale);
8598 * </pre>
Philip Milne6c8ea062012-04-03 17:38:43 -07008599 *
Romain Guya5364ee2011-02-24 14:46:04 -08008600 * <p>The density scale factor of a high density display is 1.5,
8601 * and 1920 = 1280 * 1.5.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -07008602 *
Romain Guya5364ee2011-02-24 14:46:04 -08008603 * @param distance The distance in "depth pixels", if negative the opposite
8604 * value is used
Philip Milne6c8ea062012-04-03 17:38:43 -07008605 *
8606 * @see #setRotationX(float)
8607 * @see #setRotationY(float)
Romain Guya5364ee2011-02-24 14:46:04 -08008608 */
8609 public void setCameraDistance(float distance) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008610 invalidateViewProperty(true, false);
Romain Guya5364ee2011-02-24 14:46:04 -08008611
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008612 ensureTransformationInfo();
Romain Guya5364ee2011-02-24 14:46:04 -08008613 final float dpi = mResources.getDisplayMetrics().densityDpi;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008614 final TransformationInfo info = mTransformationInfo;
8615 if (info.mCamera == null) {
8616 info.mCamera = new Camera();
8617 info.matrix3D = new Matrix();
Romain Guya5364ee2011-02-24 14:46:04 -08008618 }
8619
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008620 info.mCamera.setLocation(0.0f, 0.0f, -Math.abs(distance) / dpi);
8621 info.mMatrixDirty = true;
Romain Guya5364ee2011-02-24 14:46:04 -08008622
Chet Haase9d1992d2012-03-13 11:03:25 -07008623 invalidateViewProperty(false, false);
Chet Haase1271e2c2012-04-20 09:54:27 -07008624 if (mDisplayList != null) {
Chet Haaseb85967b2012-03-26 14:37:51 -07008625 mDisplayList.setCameraDistance(-Math.abs(distance) / dpi);
Chet Haasea1cff502012-02-21 13:43:44 -08008626 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008627 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8628 // View was rejected last time it was drawn by its parent; this may have changed
8629 invalidateParentIfNeeded();
8630 }
Romain Guya5364ee2011-02-24 14:46:04 -08008631 }
8632
8633 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008634 * The degrees that the view is rotated around the pivot point.
8635 *
Philip Milne6c8ea062012-04-03 17:38:43 -07008636 * @see #setRotation(float)
Chet Haasec3aa3612010-06-17 08:50:37 -07008637 * @see #getPivotX()
8638 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008639 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008640 * @return The degrees of rotation.
8641 */
Chet Haasea5531132012-02-02 13:41:44 -08008642 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008643 public float getRotation() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008644 return mTransformationInfo != null ? mTransformationInfo.mRotation : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008645 }
8646
8647 /**
Chet Haase897247b2010-09-09 14:54:47 -07008648 * Sets the degrees that the view is rotated around the pivot point. Increasing values
8649 * result in clockwise rotation.
Chet Haasec3aa3612010-06-17 08:50:37 -07008650 *
8651 * @param rotation The degrees of rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008652 *
8653 * @see #getRotation()
Chet Haasec3aa3612010-06-17 08:50:37 -07008654 * @see #getPivotX()
8655 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008656 * @see #setRotationX(float)
8657 * @see #setRotationY(float)
Chet Haase73066682010-11-29 15:55:32 -08008658 *
8659 * @attr ref android.R.styleable#View_rotation
Chet Haasec3aa3612010-06-17 08:50:37 -07008660 */
8661 public void setRotation(float rotation) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008662 ensureTransformationInfo();
8663 final TransformationInfo info = mTransformationInfo;
8664 if (info.mRotation != rotation) {
Chet Haasec3aa3612010-06-17 08:50:37 -07008665 // Double-invalidation is necessary to capture view's old and new areas
Chet Haase9d1992d2012-03-13 11:03:25 -07008666 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008667 info.mRotation = rotation;
8668 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008669 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008670 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008671 mDisplayList.setRotation(rotation);
8672 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008673 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8674 // View was rejected last time it was drawn by its parent; this may have changed
8675 invalidateParentIfNeeded();
8676 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008677 }
8678 }
8679
8680 /**
Chet Haasefd2b0022010-08-06 13:08:56 -07008681 * The degrees that the view is rotated around the vertical axis through the pivot point.
8682 *
8683 * @see #getPivotX()
8684 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008685 * @see #setRotationY(float)
8686 *
Chet Haasefd2b0022010-08-06 13:08:56 -07008687 * @return The degrees of Y rotation.
8688 */
Chet Haasea5531132012-02-02 13:41:44 -08008689 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasefd2b0022010-08-06 13:08:56 -07008690 public float getRotationY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008691 return mTransformationInfo != null ? mTransformationInfo.mRotationY : 0;
Chet Haasefd2b0022010-08-06 13:08:56 -07008692 }
8693
8694 /**
Chet Haase897247b2010-09-09 14:54:47 -07008695 * Sets the degrees that the view is rotated around the vertical axis through the pivot point.
8696 * Increasing values result in counter-clockwise rotation from the viewpoint of looking
8697 * down the y axis.
Philip Milne6c8ea062012-04-03 17:38:43 -07008698 *
Romain Guya5364ee2011-02-24 14:46:04 -08008699 * When rotating large views, it is recommended to adjust the camera distance
8700 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07008701 *
8702 * @param rotationY The degrees of Y rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008703 *
8704 * @see #getRotationY()
Chet Haasefd2b0022010-08-06 13:08:56 -07008705 * @see #getPivotX()
8706 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08008707 * @see #setRotation(float)
Philip Milne6c8ea062012-04-03 17:38:43 -07008708 * @see #setRotationX(float)
8709 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08008710 *
8711 * @attr ref android.R.styleable#View_rotationY
Chet Haasefd2b0022010-08-06 13:08:56 -07008712 */
8713 public void setRotationY(float rotationY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008714 ensureTransformationInfo();
8715 final TransformationInfo info = mTransformationInfo;
8716 if (info.mRotationY != rotationY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008717 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008718 info.mRotationY = rotationY;
8719 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008720 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008721 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008722 mDisplayList.setRotationY(rotationY);
8723 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008724 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8725 // View was rejected last time it was drawn by its parent; this may have changed
8726 invalidateParentIfNeeded();
8727 }
Chet Haasefd2b0022010-08-06 13:08:56 -07008728 }
8729 }
8730
8731 /**
8732 * The degrees that the view is rotated around the horizontal axis through the pivot point.
8733 *
8734 * @see #getPivotX()
8735 * @see #getPivotY()
Philip Milne6c8ea062012-04-03 17:38:43 -07008736 * @see #setRotationX(float)
8737 *
Chet Haasefd2b0022010-08-06 13:08:56 -07008738 * @return The degrees of X rotation.
8739 */
Chet Haasea5531132012-02-02 13:41:44 -08008740 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasefd2b0022010-08-06 13:08:56 -07008741 public float getRotationX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008742 return mTransformationInfo != null ? mTransformationInfo.mRotationX : 0;
Chet Haasefd2b0022010-08-06 13:08:56 -07008743 }
8744
8745 /**
Chet Haase897247b2010-09-09 14:54:47 -07008746 * Sets the degrees that the view is rotated around the horizontal axis through the pivot point.
8747 * Increasing values result in clockwise rotation from the viewpoint of looking down the
8748 * x axis.
Philip Milne6c8ea062012-04-03 17:38:43 -07008749 *
Romain Guya5364ee2011-02-24 14:46:04 -08008750 * When rotating large views, it is recommended to adjust the camera distance
8751 * accordingly. Refer to {@link #setCameraDistance(float)} for more information.
Chet Haasefd2b0022010-08-06 13:08:56 -07008752 *
8753 * @param rotationX The degrees of X rotation.
Philip Milne6c8ea062012-04-03 17:38:43 -07008754 *
8755 * @see #getRotationX()
Chet Haasefd2b0022010-08-06 13:08:56 -07008756 * @see #getPivotX()
8757 * @see #getPivotY()
Romain Guya5364ee2011-02-24 14:46:04 -08008758 * @see #setRotation(float)
Philip Milne6c8ea062012-04-03 17:38:43 -07008759 * @see #setRotationY(float)
8760 * @see #setCameraDistance(float)
Chet Haase73066682010-11-29 15:55:32 -08008761 *
8762 * @attr ref android.R.styleable#View_rotationX
Chet Haasefd2b0022010-08-06 13:08:56 -07008763 */
8764 public void setRotationX(float rotationX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008765 ensureTransformationInfo();
8766 final TransformationInfo info = mTransformationInfo;
8767 if (info.mRotationX != rotationX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008768 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008769 info.mRotationX = rotationX;
8770 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008771 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008772 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008773 mDisplayList.setRotationX(rotationX);
8774 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008775 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8776 // View was rejected last time it was drawn by its parent; this may have changed
8777 invalidateParentIfNeeded();
8778 }
Chet Haasefd2b0022010-08-06 13:08:56 -07008779 }
8780 }
8781
8782 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07008783 * The amount that the view is scaled in x around the pivot point, as a proportion of
8784 * the view's unscaled width. A value of 1, the default, means that no scaling is applied.
8785 *
Joe Onorato93162322010-09-16 15:42:01 -04008786 * <p>By default, this is 1.0f.
8787 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008788 * @see #getPivotX()
8789 * @see #getPivotY()
8790 * @return The scaling factor.
8791 */
Chet Haasea5531132012-02-02 13:41:44 -08008792 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008793 public float getScaleX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008794 return mTransformationInfo != null ? mTransformationInfo.mScaleX : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008795 }
8796
8797 /**
8798 * Sets the amount that the view is scaled in x around the pivot point, as a proportion of
8799 * the view's unscaled width. A value of 1 means that no scaling is applied.
8800 *
8801 * @param scaleX The scaling factor.
8802 * @see #getPivotX()
8803 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008804 *
8805 * @attr ref android.R.styleable#View_scaleX
Chet Haasec3aa3612010-06-17 08:50:37 -07008806 */
8807 public void setScaleX(float scaleX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008808 ensureTransformationInfo();
8809 final TransformationInfo info = mTransformationInfo;
8810 if (info.mScaleX != scaleX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008811 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008812 info.mScaleX = scaleX;
8813 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008814 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008815 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008816 mDisplayList.setScaleX(scaleX);
8817 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008818 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8819 // View was rejected last time it was drawn by its parent; this may have changed
8820 invalidateParentIfNeeded();
8821 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008822 }
8823 }
8824
8825 /**
8826 * The amount that the view is scaled in y around the pivot point, as a proportion of
8827 * the view's unscaled height. A value of 1, the default, means that no scaling is applied.
8828 *
Joe Onorato93162322010-09-16 15:42:01 -04008829 * <p>By default, this is 1.0f.
8830 *
Chet Haasec3aa3612010-06-17 08:50:37 -07008831 * @see #getPivotX()
8832 * @see #getPivotY()
8833 * @return The scaling factor.
8834 */
Chet Haasea5531132012-02-02 13:41:44 -08008835 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008836 public float getScaleY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008837 return mTransformationInfo != null ? mTransformationInfo.mScaleY : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008838 }
8839
8840 /**
8841 * Sets the amount that the view is scaled in Y around the pivot point, as a proportion of
8842 * the view's unscaled width. A value of 1 means that no scaling is applied.
8843 *
8844 * @param scaleY The scaling factor.
8845 * @see #getPivotX()
8846 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008847 *
8848 * @attr ref android.R.styleable#View_scaleY
Chet Haasec3aa3612010-06-17 08:50:37 -07008849 */
8850 public void setScaleY(float scaleY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008851 ensureTransformationInfo();
8852 final TransformationInfo info = mTransformationInfo;
8853 if (info.mScaleY != scaleY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008854 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008855 info.mScaleY = scaleY;
8856 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008857 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008858 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008859 mDisplayList.setScaleY(scaleY);
8860 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008861 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8862 // View was rejected last time it was drawn by its parent; this may have changed
8863 invalidateParentIfNeeded();
8864 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008865 }
8866 }
8867
8868 /**
8869 * The x location of the point around which the view is {@link #setRotation(float) rotated}
8870 * and {@link #setScaleX(float) scaled}.
8871 *
8872 * @see #getRotation()
8873 * @see #getScaleX()
8874 * @see #getScaleY()
8875 * @see #getPivotY()
8876 * @return The x location of the pivot point.
Philip Milne6c8ea062012-04-03 17:38:43 -07008877 *
8878 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07008879 */
Chet Haasea5531132012-02-02 13:41:44 -08008880 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008881 public float getPivotX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008882 return mTransformationInfo != null ? mTransformationInfo.mPivotX : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008883 }
8884
8885 /**
8886 * Sets the x location of the point around which the view is
8887 * {@link #setRotation(float) rotated} and {@link #setScaleX(float) scaled}.
Chet Haasefd2b0022010-08-06 13:08:56 -07008888 * By default, the pivot point is centered on the object.
8889 * Setting this property disables this behavior and causes the view to use only the
8890 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07008891 *
8892 * @param pivotX The x location of the pivot point.
8893 * @see #getRotation()
8894 * @see #getScaleX()
8895 * @see #getScaleY()
8896 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008897 *
8898 * @attr ref android.R.styleable#View_transformPivotX
Chet Haasec3aa3612010-06-17 08:50:37 -07008899 */
8900 public void setPivotX(float pivotX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008901 ensureTransformationInfo();
Chet Haasefd2b0022010-08-06 13:08:56 -07008902 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008903 final TransformationInfo info = mTransformationInfo;
8904 if (info.mPivotX != pivotX) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008905 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008906 info.mPivotX = pivotX;
8907 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008908 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008909 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008910 mDisplayList.setPivotX(pivotX);
8911 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008912 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8913 // View was rejected last time it was drawn by its parent; this may have changed
8914 invalidateParentIfNeeded();
8915 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008916 }
8917 }
8918
8919 /**
8920 * The y location of the point around which the view is {@link #setRotation(float) rotated}
8921 * and {@link #setScaleY(float) scaled}.
8922 *
8923 * @see #getRotation()
8924 * @see #getScaleX()
8925 * @see #getScaleY()
8926 * @see #getPivotY()
8927 * @return The y location of the pivot point.
Philip Milne6c8ea062012-04-03 17:38:43 -07008928 *
8929 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07008930 */
Chet Haasea5531132012-02-02 13:41:44 -08008931 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008932 public float getPivotY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008933 return mTransformationInfo != null ? mTransformationInfo.mPivotY : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07008934 }
8935
8936 /**
8937 * Sets the y location of the point around which the view is {@link #setRotation(float) rotated}
Chet Haasefd2b0022010-08-06 13:08:56 -07008938 * and {@link #setScaleY(float) scaled}. By default, the pivot point is centered on the object.
8939 * Setting this property disables this behavior and causes the view to use only the
8940 * explicitly set pivotX and pivotY values.
Chet Haasec3aa3612010-06-17 08:50:37 -07008941 *
8942 * @param pivotY The y location of the pivot point.
8943 * @see #getRotation()
8944 * @see #getScaleX()
8945 * @see #getScaleY()
8946 * @see #getPivotY()
Chet Haase73066682010-11-29 15:55:32 -08008947 *
8948 * @attr ref android.R.styleable#View_transformPivotY
Chet Haasec3aa3612010-06-17 08:50:37 -07008949 */
8950 public void setPivotY(float pivotY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008951 ensureTransformationInfo();
Chet Haasefd2b0022010-08-06 13:08:56 -07008952 mPrivateFlags |= PIVOT_EXPLICITLY_SET;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008953 final TransformationInfo info = mTransformationInfo;
8954 if (info.mPivotY != pivotY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07008955 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008956 info.mPivotY = pivotY;
8957 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07008958 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07008959 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08008960 mDisplayList.setPivotY(pivotY);
8961 }
Chet Haase1a3ab172012-05-11 08:41:20 -07008962 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
8963 // View was rejected last time it was drawn by its parent; this may have changed
8964 invalidateParentIfNeeded();
8965 }
Chet Haasec3aa3612010-06-17 08:50:37 -07008966 }
8967 }
8968
8969 /**
8970 * The opacity of the view. This is a value from 0 to 1, where 0 means the view is
8971 * completely transparent and 1 means the view is completely opaque.
8972 *
Joe Onorato93162322010-09-16 15:42:01 -04008973 * <p>By default this is 1.0f.
Chet Haasec3aa3612010-06-17 08:50:37 -07008974 * @return The opacity of the view.
8975 */
Chet Haasea5531132012-02-02 13:41:44 -08008976 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasec3aa3612010-06-17 08:50:37 -07008977 public float getAlpha() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07008978 return mTransformationInfo != null ? mTransformationInfo.mAlpha : 1;
Chet Haasec3aa3612010-06-17 08:50:37 -07008979 }
8980
8981 /**
Chet Haasedb8c9a62012-03-21 18:54:18 -07008982 * Returns whether this View has content which overlaps. This function, intended to be
8983 * overridden by specific View types, is an optimization when alpha is set on a view. If
8984 * rendering overlaps in a view with alpha < 1, that view is drawn to an offscreen buffer
8985 * and then composited it into place, which can be expensive. If the view has no overlapping
8986 * rendering, the view can draw each primitive with the appropriate alpha value directly.
8987 * An example of overlapping rendering is a TextView with a background image, such as a
8988 * Button. An example of non-overlapping rendering is a TextView with no background, or
8989 * an ImageView with only the foreground image. The default implementation returns true;
8990 * subclasses should override if they have cases which can be optimized.
8991 *
8992 * @return true if the content in this view might overlap, false otherwise.
8993 */
8994 public boolean hasOverlappingRendering() {
8995 return true;
8996 }
8997
8998 /**
Romain Guy171c5922011-01-06 10:04:23 -08008999 * <p>Sets the opacity of the view. This is a value from 0 to 1, where 0 means the view is
9000 * completely transparent and 1 means the view is completely opaque.</p>
Joe Malin32736f02011-01-19 16:14:20 -08009001 *
Romain Guy171c5922011-01-06 10:04:23 -08009002 * <p>If this view overrides {@link #onSetAlpha(int)} to return true, then this view is
9003 * responsible for applying the opacity itself. Otherwise, calling this method is
9004 * equivalent to calling {@link #setLayerType(int, android.graphics.Paint)} and
Joe Malin32736f02011-01-19 16:14:20 -08009005 * setting a hardware layer.</p>
Chet Haasec3aa3612010-06-17 08:50:37 -07009006 *
Chet Haasea5531132012-02-02 13:41:44 -08009007 * <p>Note that setting alpha to a translucent value (0 < alpha < 1) may have
9008 * performance implications. It is generally best to use the alpha property sparingly and
9009 * transiently, as in the case of fading animations.</p>
9010 *
Chet Haasec3aa3612010-06-17 08:50:37 -07009011 * @param alpha The opacity of the view.
Chet Haase73066682010-11-29 15:55:32 -08009012 *
Joe Malin32736f02011-01-19 16:14:20 -08009013 * @see #setLayerType(int, android.graphics.Paint)
9014 *
Chet Haase73066682010-11-29 15:55:32 -08009015 * @attr ref android.R.styleable#View_alpha
Chet Haasec3aa3612010-06-17 08:50:37 -07009016 */
9017 public void setAlpha(float alpha) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009018 ensureTransformationInfo();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009019 if (mTransformationInfo.mAlpha != alpha) {
9020 mTransformationInfo.mAlpha = alpha;
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009021 if (onSetAlpha((int) (alpha * 255))) {
9022 mPrivateFlags |= ALPHA_SET;
9023 // subclass is handling alpha - don't optimize rendering cache invalidation
Chet Haase9d1992d2012-03-13 11:03:25 -07009024 invalidateParentCaches();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009025 invalidate(true);
9026 } else {
9027 mPrivateFlags &= ~ALPHA_SET;
Chet Haase9d1992d2012-03-13 11:03:25 -07009028 invalidateViewProperty(true, false);
Chet Haase1271e2c2012-04-20 09:54:27 -07009029 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009030 mDisplayList.setAlpha(alpha);
9031 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009032 }
Chet Haaseed032702010-10-01 14:05:54 -07009033 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009034 }
9035
9036 /**
Chet Haasea00f3862011-02-22 06:34:40 -08009037 * Faster version of setAlpha() which performs the same steps except there are
9038 * no calls to invalidate(). The caller of this function should perform proper invalidation
9039 * on the parent and this object. The return value indicates whether the subclass handles
9040 * alpha (the return value for onSetAlpha()).
9041 *
9042 * @param alpha The new value for the alpha property
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009043 * @return true if the View subclass handles alpha (the return value for onSetAlpha()) and
9044 * the new value for the alpha property is different from the old value
Chet Haasea00f3862011-02-22 06:34:40 -08009045 */
9046 boolean setAlphaNoInvalidation(float alpha) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009047 ensureTransformationInfo();
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009048 if (mTransformationInfo.mAlpha != alpha) {
9049 mTransformationInfo.mAlpha = alpha;
9050 boolean subclassHandlesAlpha = onSetAlpha((int) (alpha * 255));
9051 if (subclassHandlesAlpha) {
9052 mPrivateFlags |= ALPHA_SET;
9053 return true;
9054 } else {
9055 mPrivateFlags &= ~ALPHA_SET;
Chet Haase1271e2c2012-04-20 09:54:27 -07009056 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009057 mDisplayList.setAlpha(alpha);
9058 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009059 }
Chet Haasea00f3862011-02-22 06:34:40 -08009060 }
Michael Jurkaa7a7eed2012-01-17 06:06:17 -08009061 return false;
Chet Haasea00f3862011-02-22 06:34:40 -08009062 }
9063
9064 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009065 * Top position of this view relative to its parent.
9066 *
9067 * @return The top of this view, in pixels.
9068 */
9069 @ViewDebug.CapturedViewProperty
9070 public final int getTop() {
9071 return mTop;
9072 }
9073
9074 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009075 * Sets the top position of this view relative to its parent. This method is meant to be called
9076 * by the layout system and should not generally be called otherwise, because the property
9077 * may be changed at any time by the layout.
9078 *
9079 * @param top The top of this view, in pixels.
9080 */
9081 public final void setTop(int top) {
9082 if (top != mTop) {
Jeff Brown86671742010-09-30 20:00:15 -07009083 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009084 final boolean matrixIsIdentity = mTransformationInfo == null
9085 || mTransformationInfo.mMatrixIsIdentity;
9086 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009087 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009088 int minTop;
9089 int yLoc;
9090 if (top < mTop) {
9091 minTop = top;
9092 yLoc = top - mTop;
9093 } else {
9094 minTop = mTop;
9095 yLoc = 0;
9096 }
Chet Haasee9140a72011-02-16 16:23:29 -08009097 invalidate(0, yLoc, mRight - mLeft, mBottom - minTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009098 }
9099 } else {
9100 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009101 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009102 }
9103
Chet Haaseed032702010-10-01 14:05:54 -07009104 int width = mRight - mLeft;
9105 int oldHeight = mBottom - mTop;
9106
Chet Haase21cd1382010-09-01 17:42:29 -07009107 mTop = top;
Chet Haase1271e2c2012-04-20 09:54:27 -07009108 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009109 mDisplayList.setTop(mTop);
9110 }
Chet Haase21cd1382010-09-01 17:42:29 -07009111
Chet Haaseed032702010-10-01 14:05:54 -07009112 onSizeChanged(width, mBottom - mTop, width, oldHeight);
9113
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009114 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009115 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9116 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009117 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009118 }
Chet Haase21cd1382010-09-01 17:42:29 -07009119 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009120 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009121 }
Chet Haase55dbb652010-12-21 20:15:08 -08009122 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009123 invalidateParentIfNeeded();
Chet Haase1a3ab172012-05-11 08:41:20 -07009124 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9125 // View was rejected last time it was drawn by its parent; this may have changed
9126 invalidateParentIfNeeded();
9127 }
Chet Haase21cd1382010-09-01 17:42:29 -07009128 }
9129 }
9130
9131 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009132 * Bottom position of this view relative to its parent.
9133 *
9134 * @return The bottom of this view, in pixels.
9135 */
9136 @ViewDebug.CapturedViewProperty
9137 public final int getBottom() {
9138 return mBottom;
9139 }
9140
9141 /**
Michael Jurkadab559a2011-01-04 20:31:51 -08009142 * True if this view has changed since the last time being drawn.
9143 *
9144 * @return The dirty state of this view.
9145 */
9146 public boolean isDirty() {
9147 return (mPrivateFlags & DIRTY_MASK) != 0;
9148 }
9149
9150 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009151 * Sets the bottom position of this view relative to its parent. This method is meant to be
9152 * called by the layout system and should not generally be called otherwise, because the
9153 * property may be changed at any time by the layout.
9154 *
9155 * @param bottom The bottom of this view, in pixels.
9156 */
9157 public final void setBottom(int bottom) {
9158 if (bottom != mBottom) {
Jeff Brown86671742010-09-30 20:00:15 -07009159 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009160 final boolean matrixIsIdentity = mTransformationInfo == null
9161 || mTransformationInfo.mMatrixIsIdentity;
9162 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009163 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009164 int maxBottom;
9165 if (bottom < mBottom) {
9166 maxBottom = mBottom;
9167 } else {
9168 maxBottom = bottom;
9169 }
Chet Haasee9140a72011-02-16 16:23:29 -08009170 invalidate(0, 0, mRight - mLeft, maxBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009171 }
9172 } else {
9173 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009174 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009175 }
9176
Chet Haaseed032702010-10-01 14:05:54 -07009177 int width = mRight - mLeft;
9178 int oldHeight = mBottom - mTop;
9179
Chet Haase21cd1382010-09-01 17:42:29 -07009180 mBottom = bottom;
Chet Haase1271e2c2012-04-20 09:54:27 -07009181 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009182 mDisplayList.setBottom(mBottom);
9183 }
Chet Haase21cd1382010-09-01 17:42:29 -07009184
Chet Haaseed032702010-10-01 14:05:54 -07009185 onSizeChanged(width, mBottom - mTop, width, oldHeight);
9186
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009187 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009188 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9189 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009190 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009191 }
Chet Haase21cd1382010-09-01 17:42:29 -07009192 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009193 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009194 }
Chet Haase55dbb652010-12-21 20:15:08 -08009195 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009196 invalidateParentIfNeeded();
Chet Haase1a3ab172012-05-11 08:41:20 -07009197 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9198 // View was rejected last time it was drawn by its parent; this may have changed
9199 invalidateParentIfNeeded();
9200 }
Chet Haase21cd1382010-09-01 17:42:29 -07009201 }
9202 }
9203
9204 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009205 * Left position of this view relative to its parent.
9206 *
9207 * @return The left edge of this view, in pixels.
9208 */
9209 @ViewDebug.CapturedViewProperty
9210 public final int getLeft() {
9211 return mLeft;
9212 }
9213
9214 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009215 * Sets the left position of this view relative to its parent. This method is meant to be called
9216 * by the layout system and should not generally be called otherwise, because the property
9217 * may be changed at any time by the layout.
9218 *
9219 * @param left The bottom of this view, in pixels.
9220 */
9221 public final void setLeft(int left) {
9222 if (left != mLeft) {
Jeff Brown86671742010-09-30 20:00:15 -07009223 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009224 final boolean matrixIsIdentity = mTransformationInfo == null
9225 || mTransformationInfo.mMatrixIsIdentity;
9226 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009227 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009228 int minLeft;
9229 int xLoc;
9230 if (left < mLeft) {
9231 minLeft = left;
9232 xLoc = left - mLeft;
9233 } else {
9234 minLeft = mLeft;
9235 xLoc = 0;
9236 }
Chet Haasee9140a72011-02-16 16:23:29 -08009237 invalidate(xLoc, 0, mRight - minLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009238 }
9239 } else {
9240 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009241 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009242 }
9243
Chet Haaseed032702010-10-01 14:05:54 -07009244 int oldWidth = mRight - mLeft;
9245 int height = mBottom - mTop;
9246
Chet Haase21cd1382010-09-01 17:42:29 -07009247 mLeft = left;
Chet Haase1271e2c2012-04-20 09:54:27 -07009248 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009249 mDisplayList.setLeft(left);
9250 }
Chet Haase21cd1382010-09-01 17:42:29 -07009251
Chet Haaseed032702010-10-01 14:05:54 -07009252 onSizeChanged(mRight - mLeft, height, oldWidth, height);
9253
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009254 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009255 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9256 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009257 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009258 }
Chet Haase21cd1382010-09-01 17:42:29 -07009259 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009260 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009261 }
Chet Haase55dbb652010-12-21 20:15:08 -08009262 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009263 invalidateParentIfNeeded();
Chet Haase1a3ab172012-05-11 08:41:20 -07009264 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9265 // View was rejected last time it was drawn by its parent; this may have changed
9266 invalidateParentIfNeeded();
9267 }
Chet Haase21cd1382010-09-01 17:42:29 -07009268 }
9269 }
9270
9271 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009272 * Right position of this view relative to its parent.
9273 *
9274 * @return The right edge of this view, in pixels.
9275 */
9276 @ViewDebug.CapturedViewProperty
9277 public final int getRight() {
9278 return mRight;
9279 }
9280
9281 /**
Chet Haase21cd1382010-09-01 17:42:29 -07009282 * Sets the right position of this view relative to its parent. This method is meant to be called
9283 * by the layout system and should not generally be called otherwise, because the property
9284 * may be changed at any time by the layout.
9285 *
9286 * @param right The bottom of this view, in pixels.
9287 */
9288 public final void setRight(int right) {
9289 if (right != mRight) {
Jeff Brown86671742010-09-30 20:00:15 -07009290 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009291 final boolean matrixIsIdentity = mTransformationInfo == null
9292 || mTransformationInfo.mMatrixIsIdentity;
9293 if (matrixIsIdentity) {
Chet Haasee9140a72011-02-16 16:23:29 -08009294 if (mAttachInfo != null) {
Chet Haase21cd1382010-09-01 17:42:29 -07009295 int maxRight;
9296 if (right < mRight) {
9297 maxRight = mRight;
9298 } else {
9299 maxRight = right;
9300 }
Chet Haasee9140a72011-02-16 16:23:29 -08009301 invalidate(0, 0, maxRight - mLeft, mBottom - mTop);
Chet Haase21cd1382010-09-01 17:42:29 -07009302 }
9303 } else {
9304 // Double-invalidation is necessary to capture view's old and new areas
Romain Guy0fd89bf2011-01-26 15:41:30 -08009305 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009306 }
9307
Chet Haaseed032702010-10-01 14:05:54 -07009308 int oldWidth = mRight - mLeft;
9309 int height = mBottom - mTop;
9310
Chet Haase21cd1382010-09-01 17:42:29 -07009311 mRight = right;
Chet Haase1271e2c2012-04-20 09:54:27 -07009312 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009313 mDisplayList.setRight(mRight);
9314 }
Chet Haase21cd1382010-09-01 17:42:29 -07009315
Chet Haaseed032702010-10-01 14:05:54 -07009316 onSizeChanged(mRight - mLeft, height, oldWidth, height);
9317
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009318 if (!matrixIsIdentity) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009319 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
9320 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009321 mTransformationInfo.mMatrixDirty = true;
Chet Haase6c7ad5d2010-12-28 08:40:00 -08009322 }
Chet Haase21cd1382010-09-01 17:42:29 -07009323 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
Romain Guy0fd89bf2011-01-26 15:41:30 -08009324 invalidate(true);
Chet Haase21cd1382010-09-01 17:42:29 -07009325 }
Chet Haase55dbb652010-12-21 20:15:08 -08009326 mBackgroundSizeChanged = true;
Chet Haase678e0ad2011-01-25 09:37:18 -08009327 invalidateParentIfNeeded();
Chet Haase1a3ab172012-05-11 08:41:20 -07009328 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9329 // View was rejected last time it was drawn by its parent; this may have changed
9330 invalidateParentIfNeeded();
9331 }
Chet Haase21cd1382010-09-01 17:42:29 -07009332 }
9333 }
9334
9335 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009336 * The visual x position of this view, in pixels. This is equivalent to the
9337 * {@link #setTranslationX(float) translationX} property plus the current
Joe Malin32736f02011-01-19 16:14:20 -08009338 * {@link #getLeft() left} property.
Chet Haasec3aa3612010-06-17 08:50:37 -07009339 *
Chet Haasedf030d22010-07-30 17:22:38 -07009340 * @return The visual x position of this view, in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07009341 */
Chet Haasea5531132012-02-02 13:41:44 -08009342 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009343 public float getX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009344 return mLeft + (mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0);
Chet Haasedf030d22010-07-30 17:22:38 -07009345 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009346
Chet Haasedf030d22010-07-30 17:22:38 -07009347 /**
9348 * Sets the visual x position of this view, in pixels. This is equivalent to setting the
9349 * {@link #setTranslationX(float) translationX} property to be the difference between
9350 * the x value passed in and the current {@link #getLeft() left} property.
9351 *
9352 * @param x The visual x position of this view, in pixels.
9353 */
9354 public void setX(float x) {
9355 setTranslationX(x - mLeft);
9356 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009357
Chet Haasedf030d22010-07-30 17:22:38 -07009358 /**
9359 * The visual y position of this view, in pixels. This is equivalent to the
9360 * {@link #setTranslationY(float) translationY} property plus the current
9361 * {@link #getTop() top} property.
9362 *
9363 * @return The visual y position of this view, in pixels.
9364 */
Chet Haasea5531132012-02-02 13:41:44 -08009365 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009366 public float getY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009367 return mTop + (mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0);
Chet Haasedf030d22010-07-30 17:22:38 -07009368 }
9369
9370 /**
9371 * Sets the visual y position of this view, in pixels. This is equivalent to setting the
9372 * {@link #setTranslationY(float) translationY} property to be the difference between
9373 * the y value passed in and the current {@link #getTop() top} property.
9374 *
9375 * @param y The visual y position of this view, in pixels.
9376 */
9377 public void setY(float y) {
9378 setTranslationY(y - mTop);
9379 }
9380
9381
9382 /**
9383 * The horizontal location of this view relative to its {@link #getLeft() left} position.
9384 * This position is post-layout, in addition to wherever the object's
9385 * layout placed it.
9386 *
9387 * @return The horizontal position of this view relative to its left position, in pixels.
9388 */
Chet Haasea5531132012-02-02 13:41:44 -08009389 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009390 public float getTranslationX() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009391 return mTransformationInfo != null ? mTransformationInfo.mTranslationX : 0;
Chet Haasedf030d22010-07-30 17:22:38 -07009392 }
9393
9394 /**
9395 * Sets the horizontal location of this view relative to its {@link #getLeft() left} position.
9396 * This effectively positions the object post-layout, in addition to wherever the object's
9397 * layout placed it.
9398 *
9399 * @param translationX The horizontal position of this view relative to its left position,
9400 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08009401 *
9402 * @attr ref android.R.styleable#View_translationX
Chet Haasedf030d22010-07-30 17:22:38 -07009403 */
9404 public void setTranslationX(float translationX) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009405 ensureTransformationInfo();
9406 final TransformationInfo info = mTransformationInfo;
9407 if (info.mTranslationX != translationX) {
Chet Haasedf030d22010-07-30 17:22:38 -07009408 // Double-invalidation is necessary to capture view's old and new areas
Chet Haase9d1992d2012-03-13 11:03:25 -07009409 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009410 info.mTranslationX = translationX;
9411 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009412 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009413 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009414 mDisplayList.setTranslationX(translationX);
9415 }
Chet Haase1a3ab172012-05-11 08:41:20 -07009416 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9417 // View was rejected last time it was drawn by its parent; this may have changed
9418 invalidateParentIfNeeded();
9419 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009420 }
9421 }
9422
9423 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009424 * The horizontal location of this view relative to its {@link #getTop() top} position.
9425 * This position is post-layout, in addition to wherever the object's
9426 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07009427 *
Chet Haasedf030d22010-07-30 17:22:38 -07009428 * @return The vertical position of this view relative to its top position,
9429 * in pixels.
Chet Haasec3aa3612010-06-17 08:50:37 -07009430 */
Chet Haasea5531132012-02-02 13:41:44 -08009431 @ViewDebug.ExportedProperty(category = "drawing")
Chet Haasedf030d22010-07-30 17:22:38 -07009432 public float getTranslationY() {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009433 return mTransformationInfo != null ? mTransformationInfo.mTranslationY : 0;
Chet Haasec3aa3612010-06-17 08:50:37 -07009434 }
9435
9436 /**
Chet Haasedf030d22010-07-30 17:22:38 -07009437 * Sets the vertical location of this view relative to its {@link #getTop() top} position.
9438 * This effectively positions the object post-layout, in addition to wherever the object's
9439 * layout placed it.
Chet Haasec3aa3612010-06-17 08:50:37 -07009440 *
Chet Haasedf030d22010-07-30 17:22:38 -07009441 * @param translationY The vertical position of this view relative to its top position,
9442 * in pixels.
Chet Haase73066682010-11-29 15:55:32 -08009443 *
9444 * @attr ref android.R.styleable#View_translationY
Chet Haasec3aa3612010-06-17 08:50:37 -07009445 */
Chet Haasedf030d22010-07-30 17:22:38 -07009446 public void setTranslationY(float translationY) {
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009447 ensureTransformationInfo();
9448 final TransformationInfo info = mTransformationInfo;
9449 if (info.mTranslationY != translationY) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009450 invalidateViewProperty(true, false);
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009451 info.mTranslationY = translationY;
9452 info.mMatrixDirty = true;
Chet Haase9d1992d2012-03-13 11:03:25 -07009453 invalidateViewProperty(false, true);
Chet Haase1271e2c2012-04-20 09:54:27 -07009454 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009455 mDisplayList.setTranslationY(translationY);
9456 }
Chet Haase1a3ab172012-05-11 08:41:20 -07009457 if ((mPrivateFlags2 & VIEW_QUICK_REJECTED) == VIEW_QUICK_REJECTED) {
9458 // View was rejected last time it was drawn by its parent; this may have changed
9459 invalidateParentIfNeeded();
9460 }
Chet Haasedf030d22010-07-30 17:22:38 -07009461 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009462 }
9463
9464 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009465 * Hit rectangle in parent's coordinates
9466 *
9467 * @param outRect The hit rectangle of the view.
9468 */
9469 public void getHitRect(Rect outRect) {
Jeff Brown86671742010-09-30 20:00:15 -07009470 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009471 final TransformationInfo info = mTransformationInfo;
9472 if (info == null || info.mMatrixIsIdentity || mAttachInfo == null) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009473 outRect.set(mLeft, mTop, mRight, mBottom);
9474 } else {
9475 final RectF tmpRect = mAttachInfo.mTmpTransformRect;
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009476 tmpRect.set(-info.mPivotX, -info.mPivotY,
9477 getWidth() - info.mPivotX, getHeight() - info.mPivotY);
9478 info.mMatrix.mapRect(tmpRect);
Romain Guy33e72ae2010-07-17 12:40:29 -07009479 outRect.set((int) tmpRect.left + mLeft, (int) tmpRect.top + mTop,
9480 (int) tmpRect.right + mLeft, (int) tmpRect.bottom + mTop);
Chet Haasec3aa3612010-06-17 08:50:37 -07009481 }
9482 }
9483
9484 /**
Jeff Brown20e987b2010-08-23 12:01:02 -07009485 * Determines whether the given point, in local coordinates is inside the view.
9486 */
9487 /*package*/ final boolean pointInView(float localX, float localY) {
9488 return localX >= 0 && localX < (mRight - mLeft)
9489 && localY >= 0 && localY < (mBottom - mTop);
9490 }
9491
9492 /**
Chet Haasec3aa3612010-06-17 08:50:37 -07009493 * Utility method to determine whether the given point, in local coordinates,
9494 * is inside the view, where the area of the view is expanded by the slop factor.
9495 * This method is called while processing touch-move events to determine if the event
9496 * is still within the view.
9497 */
9498 private boolean pointInView(float localX, float localY, float slop) {
Jeff Brown20e987b2010-08-23 12:01:02 -07009499 return localX >= -slop && localY >= -slop && localX < ((mRight - mLeft) + slop) &&
Romain Guy33e72ae2010-07-17 12:40:29 -07009500 localY < ((mBottom - mTop) + slop);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009501 }
9502
9503 /**
9504 * When a view has focus and the user navigates away from it, the next view is searched for
9505 * starting from the rectangle filled in by this method.
9506 *
Romain Guy5c22a8c2011-05-13 11:48:45 -07009507 * By default, the rectange is the {@link #getDrawingRect(android.graphics.Rect)})
9508 * of the view. However, if your view maintains some idea of internal selection,
9509 * such as a cursor, or a selected row or column, you should override this method and
9510 * fill in a more specific rectangle.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009511 *
9512 * @param r The rectangle to fill in, in this view's coordinates.
9513 */
9514 public void getFocusedRect(Rect r) {
9515 getDrawingRect(r);
9516 }
9517
9518 /**
9519 * If some part of this view is not clipped by any of its parents, then
9520 * return that area in r in global (root) coordinates. To convert r to local
Gilles Debunnecea45132011-11-24 02:19:27 +01009521 * coordinates (without taking possible View rotations into account), offset
9522 * it by -globalOffset (e.g. r.offset(-globalOffset.x, -globalOffset.y)).
9523 * If the view is completely clipped or translated out, return false.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009524 *
9525 * @param r If true is returned, r holds the global coordinates of the
9526 * visible portion of this view.
9527 * @param globalOffset If true is returned, globalOffset holds the dx,dy
9528 * between this view and its root. globalOffet may be null.
9529 * @return true if r is non-empty (i.e. part of the view is visible at the
9530 * root level.
9531 */
9532 public boolean getGlobalVisibleRect(Rect r, Point globalOffset) {
9533 int width = mRight - mLeft;
9534 int height = mBottom - mTop;
9535 if (width > 0 && height > 0) {
9536 r.set(0, 0, width, height);
9537 if (globalOffset != null) {
9538 globalOffset.set(-mScrollX, -mScrollY);
9539 }
9540 return mParent == null || mParent.getChildVisibleRect(this, r, globalOffset);
9541 }
9542 return false;
9543 }
9544
9545 public final boolean getGlobalVisibleRect(Rect r) {
9546 return getGlobalVisibleRect(r, null);
9547 }
9548
9549 public final boolean getLocalVisibleRect(Rect r) {
Romain Guyab4c4f4f2012-05-06 13:11:24 -07009550 final Point offset = mAttachInfo != null ? mAttachInfo.mPoint : new Point();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009551 if (getGlobalVisibleRect(r, offset)) {
9552 r.offset(-offset.x, -offset.y); // make r local
9553 return true;
9554 }
9555 return false;
9556 }
9557
9558 /**
9559 * Offset this view's vertical location by the specified number of pixels.
9560 *
9561 * @param offset the number of pixels to offset the view by
9562 */
9563 public void offsetTopAndBottom(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009564 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07009565 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009566 final boolean matrixIsIdentity = mTransformationInfo == null
9567 || mTransformationInfo.mMatrixIsIdentity;
9568 if (matrixIsIdentity) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009569 if (mDisplayList != null) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009570 invalidateViewProperty(false, false);
9571 } else {
9572 final ViewParent p = mParent;
9573 if (p != null && mAttachInfo != null) {
9574 final Rect r = mAttachInfo.mTmpInvalRect;
9575 int minTop;
9576 int maxBottom;
9577 int yLoc;
9578 if (offset < 0) {
9579 minTop = mTop + offset;
9580 maxBottom = mBottom;
9581 yLoc = offset;
9582 } else {
9583 minTop = mTop;
9584 maxBottom = mBottom + offset;
9585 yLoc = 0;
9586 }
9587 r.set(0, yLoc, mRight - mLeft, maxBottom - minTop);
9588 p.invalidateChild(this, r);
Chet Haase8fbf8d22010-07-30 15:01:32 -07009589 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009590 }
9591 } else {
Chet Haase9d1992d2012-03-13 11:03:25 -07009592 invalidateViewProperty(false, false);
Chet Haasec3aa3612010-06-17 08:50:37 -07009593 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009594
Chet Haasec3aa3612010-06-17 08:50:37 -07009595 mTop += offset;
9596 mBottom += offset;
Chet Haase1271e2c2012-04-20 09:54:27 -07009597 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009598 mDisplayList.offsetTopBottom(offset);
Chet Haase9d1992d2012-03-13 11:03:25 -07009599 invalidateViewProperty(false, false);
9600 } else {
9601 if (!matrixIsIdentity) {
9602 invalidateViewProperty(false, true);
9603 }
9604 invalidateParentIfNeeded();
Chet Haasea1cff502012-02-21 13:43:44 -08009605 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009606 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009607 }
9608
9609 /**
9610 * Offset this view's horizontal location by the specified amount of pixels.
9611 *
9612 * @param offset the numer of pixels to offset the view by
9613 */
9614 public void offsetLeftAndRight(int offset) {
Chet Haasec3aa3612010-06-17 08:50:37 -07009615 if (offset != 0) {
Jeff Brown86671742010-09-30 20:00:15 -07009616 updateMatrix();
Dianne Hackbornddb715b2011-09-09 14:43:39 -07009617 final boolean matrixIsIdentity = mTransformationInfo == null
9618 || mTransformationInfo.mMatrixIsIdentity;
9619 if (matrixIsIdentity) {
Chet Haase1271e2c2012-04-20 09:54:27 -07009620 if (mDisplayList != null) {
Chet Haase9d1992d2012-03-13 11:03:25 -07009621 invalidateViewProperty(false, false);
9622 } else {
9623 final ViewParent p = mParent;
9624 if (p != null && mAttachInfo != null) {
9625 final Rect r = mAttachInfo.mTmpInvalRect;
9626 int minLeft;
9627 int maxRight;
9628 if (offset < 0) {
9629 minLeft = mLeft + offset;
9630 maxRight = mRight;
9631 } else {
9632 minLeft = mLeft;
9633 maxRight = mRight + offset;
9634 }
9635 r.set(0, 0, maxRight - minLeft, mBottom - mTop);
9636 p.invalidateChild(this, r);
Chet Haase8fbf8d22010-07-30 15:01:32 -07009637 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009638 }
9639 } else {
Chet Haase9d1992d2012-03-13 11:03:25 -07009640 invalidateViewProperty(false, false);
Chet Haasec3aa3612010-06-17 08:50:37 -07009641 }
Romain Guy33e72ae2010-07-17 12:40:29 -07009642
Chet Haasec3aa3612010-06-17 08:50:37 -07009643 mLeft += offset;
9644 mRight += offset;
Chet Haase1271e2c2012-04-20 09:54:27 -07009645 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -08009646 mDisplayList.offsetLeftRight(offset);
Chet Haase9d1992d2012-03-13 11:03:25 -07009647 invalidateViewProperty(false, false);
9648 } else {
9649 if (!matrixIsIdentity) {
9650 invalidateViewProperty(false, true);
9651 }
9652 invalidateParentIfNeeded();
Chet Haasea1cff502012-02-21 13:43:44 -08009653 }
Chet Haasec3aa3612010-06-17 08:50:37 -07009654 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009655 }
9656
9657 /**
9658 * Get the LayoutParams associated with this view. All views should have
9659 * layout parameters. These supply parameters to the <i>parent</i> of this
9660 * view specifying how it should be arranged. There are many subclasses of
9661 * ViewGroup.LayoutParams, and these correspond to the different subclasses
9662 * of ViewGroup that are responsible for arranging their children.
Romain Guy01c174b2011-02-22 11:51:06 -08009663 *
9664 * This method may return null if this View is not attached to a parent
9665 * ViewGroup or {@link #setLayoutParams(android.view.ViewGroup.LayoutParams)}
9666 * was not invoked successfully. When a View is attached to a parent
9667 * ViewGroup, this method must not return null.
9668 *
9669 * @return The LayoutParams associated with this view, or null if no
9670 * parameters have been set yet
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009671 */
Konstantin Lopyrev91a7f5f2010-08-10 18:54:54 -07009672 @ViewDebug.ExportedProperty(deepExport = true, prefix = "layout_")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009673 public ViewGroup.LayoutParams getLayoutParams() {
9674 return mLayoutParams;
9675 }
9676
9677 /**
9678 * Set the layout parameters associated with this view. These supply
9679 * parameters to the <i>parent</i> of this view specifying how it should be
9680 * arranged. There are many subclasses of ViewGroup.LayoutParams, and these
9681 * correspond to the different subclasses of ViewGroup that are responsible
9682 * for arranging their children.
9683 *
Romain Guy01c174b2011-02-22 11:51:06 -08009684 * @param params The layout parameters for this view, cannot be null
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009685 */
9686 public void setLayoutParams(ViewGroup.LayoutParams params) {
9687 if (params == null) {
Romain Guy01c174b2011-02-22 11:51:06 -08009688 throw new NullPointerException("Layout parameters cannot be null");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009689 }
9690 mLayoutParams = params;
Philip Milned7dd8902012-01-26 16:55:30 -08009691 if (mParent instanceof ViewGroup) {
9692 ((ViewGroup) mParent).onSetLayoutParams(this, params);
9693 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009694 requestLayout();
9695 }
9696
9697 /**
9698 * Set the scrolled position of your view. This will cause a call to
9699 * {@link #onScrollChanged(int, int, int, int)} and the view will be
9700 * invalidated.
9701 * @param x the x position to scroll to
9702 * @param y the y position to scroll to
9703 */
9704 public void scrollTo(int x, int y) {
9705 if (mScrollX != x || mScrollY != y) {
9706 int oldX = mScrollX;
9707 int oldY = mScrollY;
9708 mScrollX = x;
9709 mScrollY = y;
Romain Guy0fd89bf2011-01-26 15:41:30 -08009710 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009711 onScrollChanged(mScrollX, mScrollY, oldX, oldY);
Mike Cleronf116bf82009-09-27 19:14:12 -07009712 if (!awakenScrollBars()) {
Adam Powelldf3ae4f2012-04-10 18:55:22 -07009713 postInvalidateOnAnimation();
Mike Cleronf116bf82009-09-27 19:14:12 -07009714 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009715 }
9716 }
9717
9718 /**
9719 * Move the scrolled position of your view. This will cause a call to
9720 * {@link #onScrollChanged(int, int, int, int)} and the view will be
9721 * invalidated.
9722 * @param x the amount of pixels to scroll by horizontally
9723 * @param y the amount of pixels to scroll by vertically
9724 */
9725 public void scrollBy(int x, int y) {
9726 scrollTo(mScrollX + x, mScrollY + y);
9727 }
9728
9729 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07009730 * <p>Trigger the scrollbars to draw. When invoked this method starts an
9731 * animation to fade the scrollbars out after a default delay. If a subclass
9732 * provides animated scrolling, the start delay should equal the duration
9733 * of the scrolling animation.</p>
9734 *
9735 * <p>The animation starts only if at least one of the scrollbars is
9736 * enabled, as specified by {@link #isHorizontalScrollBarEnabled()} and
9737 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9738 * this method returns true, and false otherwise. If the animation is
9739 * started, this method calls {@link #invalidate()}; in that case the
9740 * caller should not call {@link #invalidate()}.</p>
9741 *
9742 * <p>This method should be invoked every time a subclass directly updates
Mike Cleronfe81d382009-09-28 14:22:16 -07009743 * the scroll parameters.</p>
Mike Cleronf116bf82009-09-27 19:14:12 -07009744 *
9745 * <p>This method is automatically invoked by {@link #scrollBy(int, int)}
9746 * and {@link #scrollTo(int, int)}.</p>
9747 *
9748 * @return true if the animation is played, false otherwise
9749 *
9750 * @see #awakenScrollBars(int)
Mike Cleronf116bf82009-09-27 19:14:12 -07009751 * @see #scrollBy(int, int)
9752 * @see #scrollTo(int, int)
9753 * @see #isHorizontalScrollBarEnabled()
9754 * @see #isVerticalScrollBarEnabled()
9755 * @see #setHorizontalScrollBarEnabled(boolean)
9756 * @see #setVerticalScrollBarEnabled(boolean)
9757 */
9758 protected boolean awakenScrollBars() {
9759 return mScrollCache != null &&
Mike Cleron290947b2009-09-29 18:34:32 -07009760 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade, true);
Mike Cleronf116bf82009-09-27 19:14:12 -07009761 }
9762
9763 /**
Adam Powell8568c3a2010-04-19 14:26:11 -07009764 * Trigger the scrollbars to draw.
9765 * This method differs from awakenScrollBars() only in its default duration.
9766 * initialAwakenScrollBars() will show the scroll bars for longer than
9767 * usual to give the user more of a chance to notice them.
9768 *
9769 * @return true if the animation is played, false otherwise.
9770 */
9771 private boolean initialAwakenScrollBars() {
9772 return mScrollCache != null &&
9773 awakenScrollBars(mScrollCache.scrollBarDefaultDelayBeforeFade * 4, true);
9774 }
9775
9776 /**
Mike Cleronf116bf82009-09-27 19:14:12 -07009777 * <p>
9778 * Trigger the scrollbars to draw. When invoked this method starts an
9779 * animation to fade the scrollbars out after a fixed delay. If a subclass
9780 * provides animated scrolling, the start delay should equal the duration of
9781 * the scrolling animation.
9782 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009783 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009784 * <p>
9785 * The animation starts only if at least one of the scrollbars is enabled,
9786 * as specified by {@link #isHorizontalScrollBarEnabled()} and
9787 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9788 * this method returns true, and false otherwise. If the animation is
9789 * started, this method calls {@link #invalidate()}; in that case the caller
9790 * should not call {@link #invalidate()}.
9791 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009792 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009793 * <p>
9794 * This method should be invoked everytime a subclass directly updates the
Mike Cleronfe81d382009-09-28 14:22:16 -07009795 * scroll parameters.
Mike Cleronf116bf82009-09-27 19:14:12 -07009796 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009797 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009798 * @param startDelay the delay, in milliseconds, after which the animation
9799 * should start; when the delay is 0, the animation starts
9800 * immediately
9801 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08009802 *
Mike Cleronf116bf82009-09-27 19:14:12 -07009803 * @see #scrollBy(int, int)
9804 * @see #scrollTo(int, int)
9805 * @see #isHorizontalScrollBarEnabled()
9806 * @see #isVerticalScrollBarEnabled()
9807 * @see #setHorizontalScrollBarEnabled(boolean)
9808 * @see #setVerticalScrollBarEnabled(boolean)
9809 */
9810 protected boolean awakenScrollBars(int startDelay) {
Mike Cleron290947b2009-09-29 18:34:32 -07009811 return awakenScrollBars(startDelay, true);
9812 }
Joe Malin32736f02011-01-19 16:14:20 -08009813
Mike Cleron290947b2009-09-29 18:34:32 -07009814 /**
9815 * <p>
9816 * Trigger the scrollbars to draw. When invoked this method starts an
9817 * animation to fade the scrollbars out after a fixed delay. If a subclass
9818 * provides animated scrolling, the start delay should equal the duration of
9819 * the scrolling animation.
9820 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009821 *
Mike Cleron290947b2009-09-29 18:34:32 -07009822 * <p>
9823 * The animation starts only if at least one of the scrollbars is enabled,
9824 * as specified by {@link #isHorizontalScrollBarEnabled()} and
9825 * {@link #isVerticalScrollBarEnabled()}. When the animation is started,
9826 * this method returns true, and false otherwise. If the animation is
Joe Malin32736f02011-01-19 16:14:20 -08009827 * started, this method calls {@link #invalidate()} if the invalidate parameter
Mike Cleron290947b2009-09-29 18:34:32 -07009828 * is set to true; in that case the caller
9829 * should not call {@link #invalidate()}.
9830 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009831 *
Mike Cleron290947b2009-09-29 18:34:32 -07009832 * <p>
9833 * This method should be invoked everytime a subclass directly updates the
9834 * scroll parameters.
9835 * </p>
Joe Malin32736f02011-01-19 16:14:20 -08009836 *
Mike Cleron290947b2009-09-29 18:34:32 -07009837 * @param startDelay the delay, in milliseconds, after which the animation
9838 * should start; when the delay is 0, the animation starts
9839 * immediately
Joe Malin32736f02011-01-19 16:14:20 -08009840 *
Mike Cleron290947b2009-09-29 18:34:32 -07009841 * @param invalidate Wheter this method should call invalidate
Joe Malin32736f02011-01-19 16:14:20 -08009842 *
Mike Cleron290947b2009-09-29 18:34:32 -07009843 * @return true if the animation is played, false otherwise
Joe Malin32736f02011-01-19 16:14:20 -08009844 *
Mike Cleron290947b2009-09-29 18:34:32 -07009845 * @see #scrollBy(int, int)
9846 * @see #scrollTo(int, int)
9847 * @see #isHorizontalScrollBarEnabled()
9848 * @see #isVerticalScrollBarEnabled()
9849 * @see #setHorizontalScrollBarEnabled(boolean)
9850 * @see #setVerticalScrollBarEnabled(boolean)
9851 */
9852 protected boolean awakenScrollBars(int startDelay, boolean invalidate) {
Mike Cleronf116bf82009-09-27 19:14:12 -07009853 final ScrollabilityCache scrollCache = mScrollCache;
Joe Malin32736f02011-01-19 16:14:20 -08009854
Mike Cleronf116bf82009-09-27 19:14:12 -07009855 if (scrollCache == null || !scrollCache.fadeScrollBars) {
9856 return false;
9857 }
9858
9859 if (scrollCache.scrollBar == null) {
9860 scrollCache.scrollBar = new ScrollBarDrawable();
9861 }
9862
9863 if (isHorizontalScrollBarEnabled() || isVerticalScrollBarEnabled()) {
9864
Mike Cleron290947b2009-09-29 18:34:32 -07009865 if (invalidate) {
9866 // Invalidate to show the scrollbars
Adam Powelldf3ae4f2012-04-10 18:55:22 -07009867 postInvalidateOnAnimation();
Mike Cleron290947b2009-09-29 18:34:32 -07009868 }
Mike Cleronf116bf82009-09-27 19:14:12 -07009869
9870 if (scrollCache.state == ScrollabilityCache.OFF) {
9871 // FIXME: this is copied from WindowManagerService.
9872 // We should get this value from the system when it
9873 // is possible to do so.
9874 final int KEY_REPEAT_FIRST_DELAY = 750;
9875 startDelay = Math.max(KEY_REPEAT_FIRST_DELAY, startDelay);
9876 }
9877
9878 // Tell mScrollCache when we should start fading. This may
9879 // extend the fade start time if one was already scheduled
Mike Cleron3ecd58c2009-09-28 11:39:02 -07009880 long fadeStartTime = AnimationUtils.currentAnimationTimeMillis() + startDelay;
Mike Cleronf116bf82009-09-27 19:14:12 -07009881 scrollCache.fadeStartTime = fadeStartTime;
9882 scrollCache.state = ScrollabilityCache.ON;
9883
9884 // Schedule our fader to run, unscheduling any old ones first
9885 if (mAttachInfo != null) {
9886 mAttachInfo.mHandler.removeCallbacks(scrollCache);
9887 mAttachInfo.mHandler.postAtTime(scrollCache, fadeStartTime);
9888 }
9889
9890 return true;
9891 }
9892
9893 return false;
9894 }
9895
9896 /**
Chet Haaseaceafe62011-08-26 15:44:33 -07009897 * Do not invalidate views which are not visible and which are not running an animation. They
9898 * will not get drawn and they should not set dirty flags as if they will be drawn
9899 */
9900 private boolean skipInvalidate() {
9901 return (mViewFlags & VISIBILITY_MASK) != VISIBLE && mCurrentAnimation == null &&
9902 (!(mParent instanceof ViewGroup) ||
9903 !((ViewGroup) mParent).isViewTransitioning(this));
9904 }
9905 /**
Joe Fernandez558459f2011-10-13 16:47:36 -07009906 * Mark the area defined by dirty as needing to be drawn. If the view is
Romain Guy5c22a8c2011-05-13 11:48:45 -07009907 * visible, {@link #onDraw(android.graphics.Canvas)} will be called at some point
9908 * in the future. This must be called from a UI thread. To call from a non-UI
9909 * thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009910 *
9911 * WARNING: This method is destructive to dirty.
9912 * @param dirty the rectangle representing the bounds of the dirty region
9913 */
9914 public void invalidate(Rect dirty) {
9915 if (ViewDebug.TRACE_HIERARCHY) {
9916 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
9917 }
9918
Chet Haaseaceafe62011-08-26 15:44:33 -07009919 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -07009920 return;
9921 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009922 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08009923 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
9924 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009925 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08009926 mPrivateFlags |= INVALIDATED;
Chet Haasef186f302011-09-11 11:06:06 -07009927 mPrivateFlags |= DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009928 final ViewParent p = mParent;
9929 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08009930 //noinspection PointlessBooleanExpression,ConstantConditions
9931 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
9932 if (p != null && ai != null && ai.mHardwareAccelerated) {
9933 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07009934 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08009935 p.invalidateChild(this, null);
9936 return;
9937 }
Romain Guyaf636eb2010-12-09 17:47:21 -08009938 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009939 if (p != null && ai != null) {
9940 final int scrollX = mScrollX;
9941 final int scrollY = mScrollY;
9942 final Rect r = ai.mTmpInvalRect;
9943 r.set(dirty.left - scrollX, dirty.top - scrollY,
9944 dirty.right - scrollX, dirty.bottom - scrollY);
9945 mParent.invalidateChild(this, r);
9946 }
9947 }
9948 }
9949
9950 /**
Joe Fernandez558459f2011-10-13 16:47:36 -07009951 * 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 -08009952 * The coordinates of the dirty rect are relative to the view.
Romain Guy5c22a8c2011-05-13 11:48:45 -07009953 * If the view is visible, {@link #onDraw(android.graphics.Canvas)}
9954 * will be called at some point in the future. This must be called from
9955 * a UI thread. To call from a non-UI thread, call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009956 * @param l the left position of the dirty region
9957 * @param t the top position of the dirty region
9958 * @param r the right position of the dirty region
9959 * @param b the bottom position of the dirty region
9960 */
9961 public void invalidate(int l, int t, int r, int b) {
9962 if (ViewDebug.TRACE_HIERARCHY) {
9963 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
9964 }
9965
Chet Haaseaceafe62011-08-26 15:44:33 -07009966 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -07009967 return;
9968 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -07009969 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Chet Haasedaf98e92011-01-10 14:10:36 -08009970 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID ||
9971 (mPrivateFlags & INVALIDATED) != INVALIDATED) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009972 mPrivateFlags &= ~DRAWING_CACHE_VALID;
Chet Haasedaf98e92011-01-10 14:10:36 -08009973 mPrivateFlags |= INVALIDATED;
Chet Haasef186f302011-09-11 11:06:06 -07009974 mPrivateFlags |= DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009975 final ViewParent p = mParent;
9976 final AttachInfo ai = mAttachInfo;
Romain Guy7d7b5492011-01-24 16:33:45 -08009977 //noinspection PointlessBooleanExpression,ConstantConditions
9978 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
9979 if (p != null && ai != null && ai.mHardwareAccelerated) {
9980 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -07009981 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -08009982 p.invalidateChild(this, null);
9983 return;
9984 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -08009985 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08009986 if (p != null && ai != null && l < r && t < b) {
9987 final int scrollX = mScrollX;
9988 final int scrollY = mScrollY;
9989 final Rect tmpr = ai.mTmpInvalRect;
9990 tmpr.set(l - scrollX, t - scrollY, r - scrollX, b - scrollY);
9991 p.invalidateChild(this, tmpr);
9992 }
9993 }
9994 }
9995
9996 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -07009997 * Invalidate the whole view. If the view is visible,
9998 * {@link #onDraw(android.graphics.Canvas)} will be called at some point in
9999 * the future. This must be called from a UI thread. To call from a non-UI thread,
10000 * call {@link #postInvalidate()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010001 */
10002 public void invalidate() {
Chet Haaseed032702010-10-01 14:05:54 -070010003 invalidate(true);
10004 }
Joe Malin32736f02011-01-19 16:14:20 -080010005
Chet Haaseed032702010-10-01 14:05:54 -070010006 /**
10007 * This is where the invalidate() work actually happens. A full invalidate()
10008 * causes the drawing cache to be invalidated, but this function can be called with
10009 * invalidateCache set to false to skip that invalidation step for cases that do not
10010 * need it (for example, a component that remains at the same dimensions with the same
10011 * content).
10012 *
10013 * @param invalidateCache Whether the drawing cache for this view should be invalidated as
10014 * well. This is usually true for a full invalidate, but may be set to false if the
10015 * View's contents or dimensions have not changed.
10016 */
Romain Guy849d0a32011-02-01 17:20:48 -080010017 void invalidate(boolean invalidateCache) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010018 if (ViewDebug.TRACE_HIERARCHY) {
10019 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.INVALIDATE);
10020 }
10021
Chet Haaseaceafe62011-08-26 15:44:33 -070010022 if (skipInvalidate()) {
Chet Haasea68c5cf2011-08-22 14:27:51 -070010023 return;
10024 }
Romain Guy2fe9a8f2010-10-04 20:17:01 -070010025 if ((mPrivateFlags & (DRAWN | HAS_BOUNDS)) == (DRAWN | HAS_BOUNDS) ||
Romain Guyc5d55862011-01-21 19:01:46 -080010026 (invalidateCache && (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) ||
Romain Guy0fd89bf2011-01-26 15:41:30 -080010027 (mPrivateFlags & INVALIDATED) != INVALIDATED || isOpaque() != mLastIsOpaque) {
10028 mLastIsOpaque = isOpaque();
Chet Haaseed032702010-10-01 14:05:54 -070010029 mPrivateFlags &= ~DRAWN;
Chet Haasef186f302011-09-11 11:06:06 -070010030 mPrivateFlags |= DIRTY;
Chet Haaseed032702010-10-01 14:05:54 -070010031 if (invalidateCache) {
Chet Haasedaf98e92011-01-10 14:10:36 -080010032 mPrivateFlags |= INVALIDATED;
Chet Haaseed032702010-10-01 14:05:54 -070010033 mPrivateFlags &= ~DRAWING_CACHE_VALID;
10034 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010035 final AttachInfo ai = mAttachInfo;
Chet Haase70d4ba12010-10-06 09:46:45 -070010036 final ViewParent p = mParent;
Romain Guy7d7b5492011-01-24 16:33:45 -080010037 //noinspection PointlessBooleanExpression,ConstantConditions
10038 if (!HardwareRenderer.RENDER_DIRTY_REGIONS) {
10039 if (p != null && ai != null && ai.mHardwareAccelerated) {
10040 // fast-track for GL-enabled applications; just invalidate the whole hierarchy
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070010041 // with a null dirty rect, which tells the ViewAncestor to redraw everything
Romain Guy7d7b5492011-01-24 16:33:45 -080010042 p.invalidateChild(this, null);
10043 return;
10044 }
Chet Haasef2f7d8f2010-12-03 14:08:14 -080010045 }
Michael Jurkaebefea42010-11-15 16:04:01 -080010046
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010047 if (p != null && ai != null) {
10048 final Rect r = ai.mTmpInvalRect;
10049 r.set(0, 0, mRight - mLeft, mBottom - mTop);
10050 // Don't call invalidate -- we don't want to internally scroll
10051 // our own bounds
10052 p.invalidateChild(this, r);
10053 }
10054 }
10055 }
10056
10057 /**
Chet Haase9d1992d2012-03-13 11:03:25 -070010058 * Quick invalidation for View property changes (alpha, translationXY, etc.). We don't want to
10059 * set any flags or handle all of the cases handled by the default invalidation methods.
10060 * Instead, we just want to schedule a traversal in ViewRootImpl with the appropriate
10061 * dirty rect. This method calls into fast invalidation methods in ViewGroup that
10062 * walk up the hierarchy, transforming the dirty rect as necessary.
10063 *
10064 * The method also handles normal invalidation logic if display list properties are not
10065 * being used in this view. The invalidateParent and forceRedraw flags are used by that
10066 * backup approach, to handle these cases used in the various property-setting methods.
10067 *
10068 * @param invalidateParent Force a call to invalidateParentCaches() if display list properties
10069 * are not being used in this view
10070 * @param forceRedraw Mark the view as DRAWN to force the invalidation to propagate, if display
10071 * list properties are not being used in this view
10072 */
10073 void invalidateViewProperty(boolean invalidateParent, boolean forceRedraw) {
Chet Haase1271e2c2012-04-20 09:54:27 -070010074 if (mDisplayList == null || (mPrivateFlags & DRAW_ANIMATION) == DRAW_ANIMATION) {
Chet Haase9d1992d2012-03-13 11:03:25 -070010075 if (invalidateParent) {
10076 invalidateParentCaches();
10077 }
10078 if (forceRedraw) {
10079 mPrivateFlags |= DRAWN; // force another invalidation with the new orientation
10080 }
10081 invalidate(false);
10082 } else {
10083 final AttachInfo ai = mAttachInfo;
10084 final ViewParent p = mParent;
10085 if (p != null && ai != null) {
10086 final Rect r = ai.mTmpInvalRect;
10087 r.set(0, 0, mRight - mLeft, mBottom - mTop);
10088 if (mParent instanceof ViewGroup) {
10089 ((ViewGroup) mParent).invalidateChildFast(this, r);
10090 } else {
10091 mParent.invalidateChild(this, r);
10092 }
10093 }
10094 }
10095 }
10096
10097 /**
10098 * Utility method to transform a given Rect by the current matrix of this view.
10099 */
10100 void transformRect(final Rect rect) {
10101 if (!getMatrix().isIdentity()) {
10102 RectF boundingRect = mAttachInfo.mTmpTransformRect;
10103 boundingRect.set(rect);
10104 getMatrix().mapRect(boundingRect);
10105 rect.set((int) (boundingRect.left - 0.5f),
10106 (int) (boundingRect.top - 0.5f),
10107 (int) (boundingRect.right + 0.5f),
10108 (int) (boundingRect.bottom + 0.5f));
10109 }
10110 }
10111
10112 /**
Romain Guy0fd89bf2011-01-26 15:41:30 -080010113 * Used to indicate that the parent of this view should clear its caches. This functionality
Chet Haasedaf98e92011-01-10 14:10:36 -080010114 * is used to force the parent to rebuild its display list (when hardware-accelerated),
10115 * which is necessary when various parent-managed properties of the view change, such as
Romain Guy0fd89bf2011-01-26 15:41:30 -080010116 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method only
10117 * clears the parent caches and does not causes an invalidate event.
Chet Haasedaf98e92011-01-10 14:10:36 -080010118 *
10119 * @hide
10120 */
Romain Guy0fd89bf2011-01-26 15:41:30 -080010121 protected void invalidateParentCaches() {
10122 if (mParent instanceof View) {
10123 ((View) mParent).mPrivateFlags |= INVALIDATED;
10124 }
10125 }
Joe Malin32736f02011-01-19 16:14:20 -080010126
Romain Guy0fd89bf2011-01-26 15:41:30 -080010127 /**
10128 * Used to indicate that the parent of this view should be invalidated. This functionality
10129 * is used to force the parent to rebuild its display list (when hardware-accelerated),
10130 * which is necessary when various parent-managed properties of the view change, such as
10131 * alpha, translationX/Y, scrollX/Y, scaleX/Y, and rotation/X/Y. This method will propagate
10132 * an invalidation event to the parent.
10133 *
10134 * @hide
10135 */
10136 protected void invalidateParentIfNeeded() {
Chet Haasedaf98e92011-01-10 14:10:36 -080010137 if (isHardwareAccelerated() && mParent instanceof View) {
Romain Guy0fd89bf2011-01-26 15:41:30 -080010138 ((View) mParent).invalidate(true);
Chet Haasedaf98e92011-01-10 14:10:36 -080010139 }
10140 }
10141
10142 /**
Romain Guy24443ea2009-05-11 11:56:30 -070010143 * Indicates whether this View is opaque. An opaque View guarantees that it will
10144 * draw all the pixels overlapping its bounds using a fully opaque color.
10145 *
10146 * Subclasses of View should override this method whenever possible to indicate
10147 * whether an instance is opaque. Opaque Views are treated in a special way by
10148 * the View hierarchy, possibly allowing it to perform optimizations during
10149 * invalidate/draw passes.
Romain Guy8506ab42009-06-11 17:35:47 -070010150 *
Romain Guy24443ea2009-05-11 11:56:30 -070010151 * @return True if this View is guaranteed to be fully opaque, false otherwise.
Romain Guy24443ea2009-05-11 11:56:30 -070010152 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070010153 @ViewDebug.ExportedProperty(category = "drawing")
Romain Guy24443ea2009-05-11 11:56:30 -070010154 public boolean isOpaque() {
Chet Haase70d4ba12010-10-06 09:46:45 -070010155 return (mPrivateFlags & OPAQUE_MASK) == OPAQUE_MASK &&
Dianne Hackbornddb715b2011-09-09 14:43:39 -070010156 ((mTransformationInfo != null ? mTransformationInfo.mAlpha : 1)
10157 >= 1.0f - ViewConfiguration.ALPHA_THRESHOLD);
Romain Guy8f1344f52009-05-15 16:03:59 -070010158 }
10159
Adam Powell20232d02010-12-08 21:08:53 -080010160 /**
10161 * @hide
10162 */
10163 protected void computeOpaqueFlags() {
Romain Guy8f1344f52009-05-15 16:03:59 -070010164 // Opaque if:
10165 // - Has a background
10166 // - Background is opaque
10167 // - Doesn't have scrollbars or scrollbars are inside overlay
10168
Philip Milne6c8ea062012-04-03 17:38:43 -070010169 if (mBackground != null && mBackground.getOpacity() == PixelFormat.OPAQUE) {
Romain Guy8f1344f52009-05-15 16:03:59 -070010170 mPrivateFlags |= OPAQUE_BACKGROUND;
10171 } else {
10172 mPrivateFlags &= ~OPAQUE_BACKGROUND;
10173 }
10174
10175 final int flags = mViewFlags;
10176 if (((flags & SCROLLBARS_VERTICAL) == 0 && (flags & SCROLLBARS_HORIZONTAL) == 0) ||
10177 (flags & SCROLLBARS_STYLE_MASK) == SCROLLBARS_INSIDE_OVERLAY) {
10178 mPrivateFlags |= OPAQUE_SCROLLBARS;
10179 } else {
10180 mPrivateFlags &= ~OPAQUE_SCROLLBARS;
10181 }
10182 }
10183
10184 /**
10185 * @hide
10186 */
10187 protected boolean hasOpaqueScrollbars() {
10188 return (mPrivateFlags & OPAQUE_SCROLLBARS) == OPAQUE_SCROLLBARS;
Romain Guy24443ea2009-05-11 11:56:30 -070010189 }
10190
10191 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010192 * @return A handler associated with the thread running the View. This
10193 * handler can be used to pump events in the UI events queue.
10194 */
10195 public Handler getHandler() {
10196 if (mAttachInfo != null) {
10197 return mAttachInfo.mHandler;
10198 }
10199 return null;
10200 }
10201
10202 /**
Jeff Browna175a5b2012-02-15 19:18:31 -080010203 * Gets the view root associated with the View.
10204 * @return The view root, or null if none.
10205 * @hide
10206 */
10207 public ViewRootImpl getViewRootImpl() {
10208 if (mAttachInfo != null) {
10209 return mAttachInfo.mViewRootImpl;
10210 }
10211 return null;
10212 }
10213
10214 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010215 * <p>Causes the Runnable to be added to the message queue.
10216 * The runnable will be run on the user interface thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010217 *
Romain Guye63a4f32011-08-11 11:33:31 -070010218 * <p>This method can be invoked from outside of the UI thread
10219 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010220 *
10221 * @param action The Runnable that will be executed.
10222 *
10223 * @return Returns true if the Runnable was successfully placed in to the
10224 * message queue. Returns false on failure, usually because the
10225 * looper processing the message queue is exiting.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010226 *
10227 * @see #postDelayed
10228 * @see #removeCallbacks
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010229 */
10230 public boolean post(Runnable action) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010231 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010232 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010233 return attachInfo.mHandler.post(action);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010234 }
Jeff Browna175a5b2012-02-15 19:18:31 -080010235 // Assume that post will succeed later
10236 ViewRootImpl.getRunQueue().post(action);
10237 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010238 }
10239
10240 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010241 * <p>Causes the Runnable to be added to the message queue, to be run
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010242 * after the specified amount of time elapses.
Romain Guye63a4f32011-08-11 11:33:31 -070010243 * The runnable will be run on the user interface thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010244 *
Romain Guye63a4f32011-08-11 11:33:31 -070010245 * <p>This method can be invoked from outside of the UI thread
10246 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010247 *
10248 * @param action The Runnable that will be executed.
10249 * @param delayMillis The delay (in milliseconds) until the Runnable
10250 * will be executed.
10251 *
10252 * @return true if the Runnable was successfully placed in to the
10253 * message queue. Returns false on failure, usually because the
10254 * looper processing the message queue is exiting. Note that a
10255 * result of true does not mean the Runnable will be processed --
10256 * if the looper is quit before the delivery time of the message
10257 * occurs then the message will be dropped.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010258 *
10259 * @see #post
10260 * @see #removeCallbacks
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010261 */
10262 public boolean postDelayed(Runnable action, long delayMillis) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010263 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010264 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010265 return attachInfo.mHandler.postDelayed(action, delayMillis);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010266 }
Jeff Browna175a5b2012-02-15 19:18:31 -080010267 // Assume that post will succeed later
10268 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
10269 return true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010270 }
10271
10272 /**
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010273 * <p>Causes the Runnable to execute on the next animation time step.
10274 * The runnable will be run on the user interface thread.</p>
10275 *
10276 * <p>This method can be invoked from outside of the UI thread
10277 * only when this View is attached to a window.</p>
10278 *
10279 * @param action The Runnable that will be executed.
10280 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010281 * @see #postOnAnimationDelayed
10282 * @see #removeCallbacks
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010283 */
10284 public void postOnAnimation(Runnable action) {
10285 final AttachInfo attachInfo = mAttachInfo;
10286 if (attachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010287 attachInfo.mViewRootImpl.mChoreographer.postCallback(
10288 Choreographer.CALLBACK_ANIMATION, action, null);
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010289 } else {
10290 // Assume that post will succeed later
10291 ViewRootImpl.getRunQueue().post(action);
10292 }
10293 }
10294
10295 /**
10296 * <p>Causes the Runnable to execute on the next animation time step,
10297 * after the specified amount of time elapses.
10298 * The runnable will be run on the user interface thread.</p>
10299 *
10300 * <p>This method can be invoked from outside of the UI thread
10301 * only when this View is attached to a window.</p>
10302 *
10303 * @param action The Runnable that will be executed.
10304 * @param delayMillis The delay (in milliseconds) until the Runnable
10305 * will be executed.
10306 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010307 * @see #postOnAnimation
10308 * @see #removeCallbacks
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010309 */
10310 public void postOnAnimationDelayed(Runnable action, long delayMillis) {
10311 final AttachInfo attachInfo = mAttachInfo;
10312 if (attachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010313 attachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed(
10314 Choreographer.CALLBACK_ANIMATION, action, null, delayMillis);
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080010315 } else {
10316 // Assume that post will succeed later
10317 ViewRootImpl.getRunQueue().postDelayed(action, delayMillis);
10318 }
10319 }
10320
10321 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010322 * <p>Removes the specified Runnable from the message queue.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010323 *
Romain Guye63a4f32011-08-11 11:33:31 -070010324 * <p>This method can be invoked from outside of the UI thread
10325 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010326 *
10327 * @param action The Runnable to remove from the message handling queue
10328 *
10329 * @return true if this view could ask the Handler to remove the Runnable,
10330 * false otherwise. When the returned value is true, the Runnable
10331 * may or may not have been actually removed from the message queue
10332 * (for instance, if the Runnable was not in the queue already.)
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010333 *
10334 * @see #post
10335 * @see #postDelayed
10336 * @see #postOnAnimation
10337 * @see #postOnAnimationDelayed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010338 */
10339 public boolean removeCallbacks(Runnable action) {
Jeff Brown43ea54b2012-03-09 14:37:48 -080010340 if (action != null) {
10341 final AttachInfo attachInfo = mAttachInfo;
10342 if (attachInfo != null) {
10343 attachInfo.mHandler.removeCallbacks(action);
Jeff Brownebb2d8d2012-03-23 17:14:34 -070010344 attachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
10345 Choreographer.CALLBACK_ANIMATION, action, null);
Jeff Brown43ea54b2012-03-09 14:37:48 -080010346 } else {
10347 // Assume that post will succeed later
10348 ViewRootImpl.getRunQueue().removeCallbacks(action);
10349 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010350 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010351 return true;
10352 }
10353
10354 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010355 * <p>Cause an invalidate to happen on a subsequent cycle through the event loop.
10356 * Use this to invalidate the View from a non-UI thread.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010357 *
Romain Guye63a4f32011-08-11 11:33:31 -070010358 * <p>This method can be invoked from outside of the UI thread
10359 * only when this View is attached to a window.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010360 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010361 * @see #invalidate()
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010362 * @see #postInvalidateDelayed(long)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010363 */
10364 public void postInvalidate() {
10365 postInvalidateDelayed(0);
10366 }
10367
10368 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010369 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
10370 * through the event loop. Use this to invalidate the View from a non-UI thread.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010371 *
Romain Guye63a4f32011-08-11 11:33:31 -070010372 * <p>This method can be invoked from outside of the UI thread
10373 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010374 *
10375 * @param left The left coordinate of the rectangle to invalidate.
10376 * @param top The top coordinate of the rectangle to invalidate.
10377 * @param right The right coordinate of the rectangle to invalidate.
10378 * @param bottom The bottom coordinate of the rectangle to invalidate.
10379 *
10380 * @see #invalidate(int, int, int, int)
10381 * @see #invalidate(Rect)
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010382 * @see #postInvalidateDelayed(long, int, int, int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010383 */
10384 public void postInvalidate(int left, int top, int right, int bottom) {
10385 postInvalidateDelayed(0, left, top, right, bottom);
10386 }
10387
10388 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010389 * <p>Cause an invalidate to happen on a subsequent cycle through the event
10390 * loop. Waits for the specified amount of time.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010391 *
Romain Guye63a4f32011-08-11 11:33:31 -070010392 * <p>This method can be invoked from outside of the UI thread
10393 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010394 *
10395 * @param delayMilliseconds the duration in milliseconds to delay the
10396 * invalidation by
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010397 *
10398 * @see #invalidate()
10399 * @see #postInvalidate()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010400 */
10401 public void postInvalidateDelayed(long delayMilliseconds) {
10402 // We try only with the AttachInfo because there's no point in invalidating
10403 // if we are not attached to our window
Jeff Browna175a5b2012-02-15 19:18:31 -080010404 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010405 if (attachInfo != null) {
Jeff Browna175a5b2012-02-15 19:18:31 -080010406 attachInfo.mViewRootImpl.dispatchInvalidateDelayed(this, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010407 }
10408 }
10409
10410 /**
Romain Guye63a4f32011-08-11 11:33:31 -070010411 * <p>Cause an invalidate of the specified area to happen on a subsequent cycle
10412 * through the event loop. Waits for the specified amount of time.</p>
Philip Milne6c8ea062012-04-03 17:38:43 -070010413 *
Romain Guye63a4f32011-08-11 11:33:31 -070010414 * <p>This method can be invoked from outside of the UI thread
10415 * only when this View is attached to a window.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010416 *
10417 * @param delayMilliseconds the duration in milliseconds to delay the
10418 * invalidation by
10419 * @param left The left coordinate of the rectangle to invalidate.
10420 * @param top The top coordinate of the rectangle to invalidate.
10421 * @param right The right coordinate of the rectangle to invalidate.
10422 * @param bottom The bottom coordinate of the rectangle to invalidate.
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010423 *
10424 * @see #invalidate(int, int, int, int)
10425 * @see #invalidate(Rect)
10426 * @see #postInvalidate(int, int, int, int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010427 */
10428 public void postInvalidateDelayed(long delayMilliseconds, int left, int top,
10429 int right, int bottom) {
10430
10431 // We try only with the AttachInfo because there's no point in invalidating
10432 // if we are not attached to our window
Jeff Browna175a5b2012-02-15 19:18:31 -080010433 final AttachInfo attachInfo = mAttachInfo;
Romain Guyc5a43a22011-03-24 13:28:56 -070010434 if (attachInfo != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010435 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
10436 info.target = this;
10437 info.left = left;
10438 info.top = top;
10439 info.right = right;
10440 info.bottom = bottom;
10441
Jeff Browna175a5b2012-02-15 19:18:31 -080010442 attachInfo.mViewRootImpl.dispatchInvalidateRectDelayed(info, delayMilliseconds);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010443 }
10444 }
10445
10446 /**
Jeff Brown6cb7b462012-03-05 13:21:17 -080010447 * <p>Cause an invalidate to happen on the next animation time step, typically the
10448 * next display frame.</p>
10449 *
10450 * <p>This method can be invoked from outside of the UI thread
10451 * only when this View is attached to a window.</p>
10452 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010453 * @see #invalidate()
Jeff Brown6cb7b462012-03-05 13:21:17 -080010454 */
10455 public void postInvalidateOnAnimation() {
10456 // We try only with the AttachInfo because there's no point in invalidating
10457 // if we are not attached to our window
10458 final AttachInfo attachInfo = mAttachInfo;
10459 if (attachInfo != null) {
10460 attachInfo.mViewRootImpl.dispatchInvalidateOnAnimation(this);
10461 }
10462 }
10463
10464 /**
10465 * <p>Cause an invalidate of the specified area to happen on the next animation
10466 * time step, typically the next display frame.</p>
10467 *
10468 * <p>This method can be invoked from outside of the UI thread
10469 * only when this View is attached to a window.</p>
10470 *
10471 * @param left The left coordinate of the rectangle to invalidate.
10472 * @param top The top coordinate of the rectangle to invalidate.
10473 * @param right The right coordinate of the rectangle to invalidate.
10474 * @param bottom The bottom coordinate of the rectangle to invalidate.
10475 *
Jeff Brown4d6a82d2012-04-11 14:23:51 -070010476 * @see #invalidate(int, int, int, int)
10477 * @see #invalidate(Rect)
Jeff Brown6cb7b462012-03-05 13:21:17 -080010478 */
10479 public void postInvalidateOnAnimation(int left, int top, int right, int bottom) {
10480 // We try only with the AttachInfo because there's no point in invalidating
10481 // if we are not attached to our window
10482 final AttachInfo attachInfo = mAttachInfo;
10483 if (attachInfo != null) {
10484 final AttachInfo.InvalidateInfo info = AttachInfo.InvalidateInfo.acquire();
10485 info.target = this;
10486 info.left = left;
10487 info.top = top;
10488 info.right = right;
10489 info.bottom = bottom;
10490
10491 attachInfo.mViewRootImpl.dispatchInvalidateRectOnAnimation(info);
10492 }
10493 }
10494
10495 /**
Svetoslav Ganova0156172011-06-26 17:55:44 -070010496 * Post a callback to send a {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} event.
10497 * This event is sent at most once every
10498 * {@link ViewConfiguration#getSendRecurringAccessibilityEventsInterval()}.
10499 */
10500 private void postSendViewScrolledAccessibilityEventCallback() {
10501 if (mSendViewScrolledAccessibilityEvent == null) {
10502 mSendViewScrolledAccessibilityEvent = new SendViewScrolledAccessibilityEvent();
10503 }
10504 if (!mSendViewScrolledAccessibilityEvent.mIsPending) {
10505 mSendViewScrolledAccessibilityEvent.mIsPending = true;
10506 postDelayed(mSendViewScrolledAccessibilityEvent,
10507 ViewConfiguration.getSendRecurringAccessibilityEventsInterval());
10508 }
10509 }
10510
10511 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010512 * Called by a parent to request that a child update its values for mScrollX
10513 * and mScrollY if necessary. This will typically be done if the child is
10514 * animating a scroll using a {@link android.widget.Scroller Scroller}
10515 * object.
10516 */
10517 public void computeScroll() {
10518 }
10519
10520 /**
10521 * <p>Indicate whether the horizontal edges are faded when the view is
10522 * scrolled horizontally.</p>
10523 *
10524 * @return true if the horizontal edges should are faded on scroll, false
10525 * otherwise
10526 *
10527 * @see #setHorizontalFadingEdgeEnabled(boolean)
Philip Milne6c8ea062012-04-03 17:38:43 -070010528 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010529 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010530 */
10531 public boolean isHorizontalFadingEdgeEnabled() {
10532 return (mViewFlags & FADING_EDGE_HORIZONTAL) == FADING_EDGE_HORIZONTAL;
10533 }
10534
10535 /**
10536 * <p>Define whether the horizontal edges should be faded when this view
10537 * is scrolled horizontally.</p>
10538 *
10539 * @param horizontalFadingEdgeEnabled true if the horizontal edges should
10540 * be faded when the view is scrolled
10541 * horizontally
10542 *
10543 * @see #isHorizontalFadingEdgeEnabled()
Philip Milne6c8ea062012-04-03 17:38:43 -070010544 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010545 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010546 */
10547 public void setHorizontalFadingEdgeEnabled(boolean horizontalFadingEdgeEnabled) {
10548 if (isHorizontalFadingEdgeEnabled() != horizontalFadingEdgeEnabled) {
10549 if (horizontalFadingEdgeEnabled) {
10550 initScrollCache();
10551 }
10552
10553 mViewFlags ^= FADING_EDGE_HORIZONTAL;
10554 }
10555 }
10556
10557 /**
10558 * <p>Indicate whether the vertical edges are faded when the view is
10559 * scrolled horizontally.</p>
10560 *
10561 * @return true if the vertical edges should are faded on scroll, false
10562 * otherwise
10563 *
10564 * @see #setVerticalFadingEdgeEnabled(boolean)
Philip Milne6c8ea062012-04-03 17:38:43 -070010565 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010566 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010567 */
10568 public boolean isVerticalFadingEdgeEnabled() {
10569 return (mViewFlags & FADING_EDGE_VERTICAL) == FADING_EDGE_VERTICAL;
10570 }
10571
10572 /**
10573 * <p>Define whether the vertical edges should be faded when this view
10574 * is scrolled vertically.</p>
10575 *
10576 * @param verticalFadingEdgeEnabled true if the vertical edges should
10577 * be faded when the view is scrolled
10578 * vertically
10579 *
10580 * @see #isVerticalFadingEdgeEnabled()
Philip Milne6c8ea062012-04-03 17:38:43 -070010581 *
Romain Guy1ef3fdb2011-09-09 15:30:30 -070010582 * @attr ref android.R.styleable#View_requiresFadingEdge
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010583 */
10584 public void setVerticalFadingEdgeEnabled(boolean verticalFadingEdgeEnabled) {
10585 if (isVerticalFadingEdgeEnabled() != verticalFadingEdgeEnabled) {
10586 if (verticalFadingEdgeEnabled) {
10587 initScrollCache();
10588 }
10589
10590 mViewFlags ^= FADING_EDGE_VERTICAL;
10591 }
10592 }
10593
10594 /**
10595 * Returns the strength, or intensity, of the top faded edge. The strength is
10596 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10597 * returns 0.0 or 1.0 but no value in between.
10598 *
10599 * Subclasses should override this method to provide a smoother fade transition
10600 * when scrolling occurs.
10601 *
10602 * @return the intensity of the top fade as a float between 0.0f and 1.0f
10603 */
10604 protected float getTopFadingEdgeStrength() {
10605 return computeVerticalScrollOffset() > 0 ? 1.0f : 0.0f;
10606 }
10607
10608 /**
10609 * Returns the strength, or intensity, of the bottom faded edge. The strength is
10610 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10611 * returns 0.0 or 1.0 but no value in between.
10612 *
10613 * Subclasses should override this method to provide a smoother fade transition
10614 * when scrolling occurs.
10615 *
10616 * @return the intensity of the bottom fade as a float between 0.0f and 1.0f
10617 */
10618 protected float getBottomFadingEdgeStrength() {
10619 return computeVerticalScrollOffset() + computeVerticalScrollExtent() <
10620 computeVerticalScrollRange() ? 1.0f : 0.0f;
10621 }
10622
10623 /**
10624 * Returns the strength, or intensity, of the left faded edge. The strength is
10625 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10626 * returns 0.0 or 1.0 but no value in between.
10627 *
10628 * Subclasses should override this method to provide a smoother fade transition
10629 * when scrolling occurs.
10630 *
10631 * @return the intensity of the left fade as a float between 0.0f and 1.0f
10632 */
10633 protected float getLeftFadingEdgeStrength() {
10634 return computeHorizontalScrollOffset() > 0 ? 1.0f : 0.0f;
10635 }
10636
10637 /**
10638 * Returns the strength, or intensity, of the right faded edge. The strength is
10639 * a value between 0.0 (no fade) and 1.0 (full fade). The default implementation
10640 * returns 0.0 or 1.0 but no value in between.
10641 *
10642 * Subclasses should override this method to provide a smoother fade transition
10643 * when scrolling occurs.
10644 *
10645 * @return the intensity of the right fade as a float between 0.0f and 1.0f
10646 */
10647 protected float getRightFadingEdgeStrength() {
10648 return computeHorizontalScrollOffset() + computeHorizontalScrollExtent() <
10649 computeHorizontalScrollRange() ? 1.0f : 0.0f;
10650 }
10651
10652 /**
10653 * <p>Indicate whether the horizontal scrollbar should be drawn or not. The
10654 * scrollbar is not drawn by default.</p>
10655 *
10656 * @return true if the horizontal scrollbar should be painted, false
10657 * otherwise
10658 *
10659 * @see #setHorizontalScrollBarEnabled(boolean)
10660 */
10661 public boolean isHorizontalScrollBarEnabled() {
10662 return (mViewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
10663 }
10664
10665 /**
10666 * <p>Define whether the horizontal scrollbar should be drawn or not. The
10667 * scrollbar is not drawn by default.</p>
10668 *
10669 * @param horizontalScrollBarEnabled true if the horizontal scrollbar should
10670 * be painted
10671 *
10672 * @see #isHorizontalScrollBarEnabled()
10673 */
10674 public void setHorizontalScrollBarEnabled(boolean horizontalScrollBarEnabled) {
10675 if (isHorizontalScrollBarEnabled() != horizontalScrollBarEnabled) {
10676 mViewFlags ^= SCROLLBARS_HORIZONTAL;
Romain Guy8f1344f52009-05-15 16:03:59 -070010677 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010678 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010679 }
10680 }
10681
10682 /**
10683 * <p>Indicate whether the vertical scrollbar should be drawn or not. The
10684 * scrollbar is not drawn by default.</p>
10685 *
10686 * @return true if the vertical scrollbar should be painted, false
10687 * otherwise
10688 *
10689 * @see #setVerticalScrollBarEnabled(boolean)
10690 */
10691 public boolean isVerticalScrollBarEnabled() {
10692 return (mViewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL;
10693 }
10694
10695 /**
10696 * <p>Define whether the vertical scrollbar should be drawn or not. The
10697 * scrollbar is not drawn by default.</p>
10698 *
10699 * @param verticalScrollBarEnabled true if the vertical scrollbar should
10700 * be painted
10701 *
10702 * @see #isVerticalScrollBarEnabled()
10703 */
10704 public void setVerticalScrollBarEnabled(boolean verticalScrollBarEnabled) {
10705 if (isVerticalScrollBarEnabled() != verticalScrollBarEnabled) {
10706 mViewFlags ^= SCROLLBARS_VERTICAL;
Romain Guy8f1344f52009-05-15 16:03:59 -070010707 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010708 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010709 }
10710 }
10711
Adam Powell20232d02010-12-08 21:08:53 -080010712 /**
10713 * @hide
10714 */
10715 protected void recomputePadding() {
10716 setPadding(mUserPaddingLeft, mPaddingTop, mUserPaddingRight, mUserPaddingBottom);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010717 }
Joe Malin32736f02011-01-19 16:14:20 -080010718
Mike Cleronfe81d382009-09-28 14:22:16 -070010719 /**
10720 * Define whether scrollbars will fade when the view is not scrolling.
Joe Malin32736f02011-01-19 16:14:20 -080010721 *
Mike Cleronfe81d382009-09-28 14:22:16 -070010722 * @param fadeScrollbars wheter to enable fading
Joe Malin32736f02011-01-19 16:14:20 -080010723 *
Philip Milne6c8ea062012-04-03 17:38:43 -070010724 * @attr ref android.R.styleable#View_fadeScrollbars
Mike Cleronfe81d382009-09-28 14:22:16 -070010725 */
10726 public void setScrollbarFadingEnabled(boolean fadeScrollbars) {
10727 initScrollCache();
10728 final ScrollabilityCache scrollabilityCache = mScrollCache;
10729 scrollabilityCache.fadeScrollBars = fadeScrollbars;
Mike Cleron52f0a642009-09-28 18:21:37 -070010730 if (fadeScrollbars) {
10731 scrollabilityCache.state = ScrollabilityCache.OFF;
10732 } else {
Mike Cleronfe81d382009-09-28 14:22:16 -070010733 scrollabilityCache.state = ScrollabilityCache.ON;
10734 }
10735 }
Joe Malin32736f02011-01-19 16:14:20 -080010736
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010737 /**
Joe Malin32736f02011-01-19 16:14:20 -080010738 *
Mike Cleron52f0a642009-09-28 18:21:37 -070010739 * Returns true if scrollbars will fade when this view is not scrolling
Joe Malin32736f02011-01-19 16:14:20 -080010740 *
Mike Cleron52f0a642009-09-28 18:21:37 -070010741 * @return true if scrollbar fading is enabled
Philip Milne6c8ea062012-04-03 17:38:43 -070010742 *
10743 * @attr ref android.R.styleable#View_fadeScrollbars
Mike Cleron52f0a642009-09-28 18:21:37 -070010744 */
10745 public boolean isScrollbarFadingEnabled() {
Joe Malin32736f02011-01-19 16:14:20 -080010746 return mScrollCache != null && mScrollCache.fadeScrollBars;
Mike Cleron52f0a642009-09-28 18:21:37 -070010747 }
Joe Malin32736f02011-01-19 16:14:20 -080010748
Mike Cleron52f0a642009-09-28 18:21:37 -070010749 /**
Philip Milne6c8ea062012-04-03 17:38:43 -070010750 *
10751 * Returns the delay before scrollbars fade.
10752 *
10753 * @return the delay before scrollbars fade
10754 *
10755 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
10756 */
10757 public int getScrollBarDefaultDelayBeforeFade() {
10758 return mScrollCache == null ? ViewConfiguration.getScrollDefaultDelay() :
10759 mScrollCache.scrollBarDefaultDelayBeforeFade;
10760 }
10761
10762 /**
10763 * Define the delay before scrollbars fade.
10764 *
10765 * @param scrollBarDefaultDelayBeforeFade - the delay before scrollbars fade
10766 *
10767 * @attr ref android.R.styleable#View_scrollbarDefaultDelayBeforeFade
10768 */
10769 public void setScrollBarDefaultDelayBeforeFade(int scrollBarDefaultDelayBeforeFade) {
10770 getScrollCache().scrollBarDefaultDelayBeforeFade = scrollBarDefaultDelayBeforeFade;
10771 }
10772
10773 /**
10774 *
10775 * Returns the scrollbar fade duration.
10776 *
10777 * @return the scrollbar fade duration
10778 *
10779 * @attr ref android.R.styleable#View_scrollbarFadeDuration
10780 */
10781 public int getScrollBarFadeDuration() {
10782 return mScrollCache == null ? ViewConfiguration.getScrollBarFadeDuration() :
10783 mScrollCache.scrollBarFadeDuration;
10784 }
10785
10786 /**
10787 * Define the scrollbar fade duration.
10788 *
10789 * @param scrollBarFadeDuration - the scrollbar fade duration
10790 *
10791 * @attr ref android.R.styleable#View_scrollbarFadeDuration
10792 */
10793 public void setScrollBarFadeDuration(int scrollBarFadeDuration) {
10794 getScrollCache().scrollBarFadeDuration = scrollBarFadeDuration;
10795 }
10796
10797 /**
10798 *
10799 * Returns the scrollbar size.
10800 *
10801 * @return the scrollbar size
10802 *
10803 * @attr ref android.R.styleable#View_scrollbarSize
10804 */
10805 public int getScrollBarSize() {
Romain Guyeb378892012-04-12 11:33:14 -070010806 return mScrollCache == null ? ViewConfiguration.get(mContext).getScaledScrollBarSize() :
Philip Milne6c8ea062012-04-03 17:38:43 -070010807 mScrollCache.scrollBarSize;
10808 }
10809
10810 /**
10811 * Define the scrollbar size.
10812 *
10813 * @param scrollBarSize - the scrollbar size
10814 *
10815 * @attr ref android.R.styleable#View_scrollbarSize
10816 */
10817 public void setScrollBarSize(int scrollBarSize) {
10818 getScrollCache().scrollBarSize = scrollBarSize;
10819 }
10820
10821 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010822 * <p>Specify the style of the scrollbars. The scrollbars can be overlaid or
10823 * inset. When inset, they add to the padding of the view. And the scrollbars
10824 * can be drawn inside the padding area or on the edge of the view. For example,
10825 * if a view has a background drawable and you want to draw the scrollbars
10826 * inside the padding specified by the drawable, you can use
10827 * SCROLLBARS_INSIDE_OVERLAY or SCROLLBARS_INSIDE_INSET. If you want them to
10828 * appear at the edge of the view, ignoring the padding, then you can use
10829 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.</p>
10830 * @param style the style of the scrollbars. Should be one of
10831 * SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_INSIDE_INSET,
10832 * SCROLLBARS_OUTSIDE_OVERLAY or SCROLLBARS_OUTSIDE_INSET.
10833 * @see #SCROLLBARS_INSIDE_OVERLAY
10834 * @see #SCROLLBARS_INSIDE_INSET
10835 * @see #SCROLLBARS_OUTSIDE_OVERLAY
10836 * @see #SCROLLBARS_OUTSIDE_INSET
Philip Milne6c8ea062012-04-03 17:38:43 -070010837 *
10838 * @attr ref android.R.styleable#View_scrollbarStyle
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010839 */
10840 public void setScrollBarStyle(int style) {
10841 if (style != (mViewFlags & SCROLLBARS_STYLE_MASK)) {
10842 mViewFlags = (mViewFlags & ~SCROLLBARS_STYLE_MASK) | (style & SCROLLBARS_STYLE_MASK);
Romain Guy8f1344f52009-05-15 16:03:59 -070010843 computeOpaqueFlags();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070010844 resolvePadding();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010845 }
10846 }
10847
10848 /**
10849 * <p>Returns the current scrollbar style.</p>
10850 * @return the current scrollbar style
10851 * @see #SCROLLBARS_INSIDE_OVERLAY
10852 * @see #SCROLLBARS_INSIDE_INSET
10853 * @see #SCROLLBARS_OUTSIDE_OVERLAY
10854 * @see #SCROLLBARS_OUTSIDE_INSET
Philip Milne6c8ea062012-04-03 17:38:43 -070010855 *
10856 * @attr ref android.R.styleable#View_scrollbarStyle
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010857 */
Jeff Sharkey010d7e52011-08-08 21:05:02 -070010858 @ViewDebug.ExportedProperty(mapping = {
10859 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_OVERLAY, to = "INSIDE_OVERLAY"),
10860 @ViewDebug.IntToString(from = SCROLLBARS_INSIDE_INSET, to = "INSIDE_INSET"),
10861 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_OVERLAY, to = "OUTSIDE_OVERLAY"),
10862 @ViewDebug.IntToString(from = SCROLLBARS_OUTSIDE_INSET, to = "OUTSIDE_INSET")
10863 })
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010864 public int getScrollBarStyle() {
10865 return mViewFlags & SCROLLBARS_STYLE_MASK;
10866 }
10867
10868 /**
10869 * <p>Compute the horizontal range that the horizontal scrollbar
10870 * represents.</p>
10871 *
10872 * <p>The range is expressed in arbitrary units that must be the same as the
10873 * units used by {@link #computeHorizontalScrollExtent()} and
10874 * {@link #computeHorizontalScrollOffset()}.</p>
10875 *
10876 * <p>The default range is the drawing width of this view.</p>
10877 *
10878 * @return the total horizontal range represented by the horizontal
10879 * scrollbar
10880 *
10881 * @see #computeHorizontalScrollExtent()
10882 * @see #computeHorizontalScrollOffset()
10883 * @see android.widget.ScrollBarDrawable
10884 */
10885 protected int computeHorizontalScrollRange() {
10886 return getWidth();
10887 }
10888
10889 /**
10890 * <p>Compute the horizontal offset of the horizontal scrollbar's thumb
10891 * within the horizontal range. This value is used to compute the position
10892 * of the thumb within the scrollbar's track.</p>
10893 *
10894 * <p>The range is expressed in arbitrary units that must be the same as the
10895 * units used by {@link #computeHorizontalScrollRange()} and
10896 * {@link #computeHorizontalScrollExtent()}.</p>
10897 *
10898 * <p>The default offset is the scroll offset of this view.</p>
10899 *
10900 * @return the horizontal offset of the scrollbar's thumb
10901 *
10902 * @see #computeHorizontalScrollRange()
10903 * @see #computeHorizontalScrollExtent()
10904 * @see android.widget.ScrollBarDrawable
10905 */
10906 protected int computeHorizontalScrollOffset() {
10907 return mScrollX;
10908 }
10909
10910 /**
10911 * <p>Compute the horizontal extent of the horizontal scrollbar's thumb
10912 * within the horizontal range. This value is used to compute the length
10913 * of the thumb within the scrollbar's track.</p>
10914 *
10915 * <p>The range is expressed in arbitrary units that must be the same as the
10916 * units used by {@link #computeHorizontalScrollRange()} and
10917 * {@link #computeHorizontalScrollOffset()}.</p>
10918 *
10919 * <p>The default extent is the drawing width of this view.</p>
10920 *
10921 * @return the horizontal extent of the scrollbar's thumb
10922 *
10923 * @see #computeHorizontalScrollRange()
10924 * @see #computeHorizontalScrollOffset()
10925 * @see android.widget.ScrollBarDrawable
10926 */
10927 protected int computeHorizontalScrollExtent() {
10928 return getWidth();
10929 }
10930
10931 /**
10932 * <p>Compute the vertical range that the vertical scrollbar represents.</p>
10933 *
10934 * <p>The range is expressed in arbitrary units that must be the same as the
10935 * units used by {@link #computeVerticalScrollExtent()} and
10936 * {@link #computeVerticalScrollOffset()}.</p>
10937 *
10938 * @return the total vertical range represented by the vertical scrollbar
10939 *
10940 * <p>The default range is the drawing height of this view.</p>
10941 *
10942 * @see #computeVerticalScrollExtent()
10943 * @see #computeVerticalScrollOffset()
10944 * @see android.widget.ScrollBarDrawable
10945 */
10946 protected int computeVerticalScrollRange() {
10947 return getHeight();
10948 }
10949
10950 /**
10951 * <p>Compute the vertical offset of the vertical scrollbar's thumb
10952 * within the horizontal range. This value is used to compute the position
10953 * of the thumb within the scrollbar's track.</p>
10954 *
10955 * <p>The range is expressed in arbitrary units that must be the same as the
10956 * units used by {@link #computeVerticalScrollRange()} and
10957 * {@link #computeVerticalScrollExtent()}.</p>
10958 *
10959 * <p>The default offset is the scroll offset of this view.</p>
10960 *
10961 * @return the vertical offset of the scrollbar's thumb
10962 *
10963 * @see #computeVerticalScrollRange()
10964 * @see #computeVerticalScrollExtent()
10965 * @see android.widget.ScrollBarDrawable
10966 */
10967 protected int computeVerticalScrollOffset() {
10968 return mScrollY;
10969 }
10970
10971 /**
10972 * <p>Compute the vertical extent of the horizontal scrollbar's thumb
10973 * within the vertical range. This value is used to compute the length
10974 * of the thumb within the scrollbar's track.</p>
10975 *
10976 * <p>The range is expressed in arbitrary units that must be the same as the
Gilles Debunne52964242010-02-24 11:05:19 -080010977 * units used by {@link #computeVerticalScrollRange()} and
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080010978 * {@link #computeVerticalScrollOffset()}.</p>
10979 *
10980 * <p>The default extent is the drawing height of this view.</p>
10981 *
10982 * @return the vertical extent of the scrollbar's thumb
10983 *
10984 * @see #computeVerticalScrollRange()
10985 * @see #computeVerticalScrollOffset()
10986 * @see android.widget.ScrollBarDrawable
10987 */
10988 protected int computeVerticalScrollExtent() {
10989 return getHeight();
10990 }
10991
10992 /**
Adam Powell69159442011-06-13 17:53:06 -070010993 * Check if this view can be scrolled horizontally in a certain direction.
10994 *
10995 * @param direction Negative to check scrolling left, positive to check scrolling right.
10996 * @return true if this view can be scrolled in the specified direction, false otherwise.
10997 */
10998 public boolean canScrollHorizontally(int direction) {
10999 final int offset = computeHorizontalScrollOffset();
11000 final int range = computeHorizontalScrollRange() - computeHorizontalScrollExtent();
11001 if (range == 0) return false;
11002 if (direction < 0) {
11003 return offset > 0;
11004 } else {
11005 return offset < range - 1;
11006 }
11007 }
11008
11009 /**
11010 * Check if this view can be scrolled vertically in a certain direction.
11011 *
11012 * @param direction Negative to check scrolling up, positive to check scrolling down.
11013 * @return true if this view can be scrolled in the specified direction, false otherwise.
11014 */
11015 public boolean canScrollVertically(int direction) {
11016 final int offset = computeVerticalScrollOffset();
11017 final int range = computeVerticalScrollRange() - computeVerticalScrollExtent();
11018 if (range == 0) return false;
11019 if (direction < 0) {
11020 return offset > 0;
11021 } else {
11022 return offset < range - 1;
11023 }
11024 }
11025
11026 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011027 * <p>Request the drawing of the horizontal and the vertical scrollbar. The
11028 * scrollbars are painted only if they have been awakened first.</p>
11029 *
11030 * @param canvas the canvas on which to draw the scrollbars
Joe Malin32736f02011-01-19 16:14:20 -080011031 *
Mike Cleronf116bf82009-09-27 19:14:12 -070011032 * @see #awakenScrollBars(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011033 */
Romain Guy1d5b3a62009-11-05 18:44:12 -080011034 protected final void onDrawScrollBars(Canvas canvas) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011035 // scrollbars are drawn only when the animation is running
11036 final ScrollabilityCache cache = mScrollCache;
11037 if (cache != null) {
Joe Malin32736f02011-01-19 16:14:20 -080011038
Mike Cleronf116bf82009-09-27 19:14:12 -070011039 int state = cache.state;
Joe Malin32736f02011-01-19 16:14:20 -080011040
Mike Cleronf116bf82009-09-27 19:14:12 -070011041 if (state == ScrollabilityCache.OFF) {
11042 return;
11043 }
Joe Malin32736f02011-01-19 16:14:20 -080011044
Mike Cleronf116bf82009-09-27 19:14:12 -070011045 boolean invalidate = false;
Joe Malin32736f02011-01-19 16:14:20 -080011046
Mike Cleronf116bf82009-09-27 19:14:12 -070011047 if (state == ScrollabilityCache.FADING) {
11048 // We're fading -- get our fade interpolation
11049 if (cache.interpolatorValues == null) {
11050 cache.interpolatorValues = new float[1];
11051 }
Joe Malin32736f02011-01-19 16:14:20 -080011052
Mike Cleronf116bf82009-09-27 19:14:12 -070011053 float[] values = cache.interpolatorValues;
Joe Malin32736f02011-01-19 16:14:20 -080011054
Mike Cleronf116bf82009-09-27 19:14:12 -070011055 // Stops the animation if we're done
11056 if (cache.scrollBarInterpolator.timeToValues(values) ==
11057 Interpolator.Result.FREEZE_END) {
11058 cache.state = ScrollabilityCache.OFF;
11059 } else {
11060 cache.scrollBar.setAlpha(Math.round(values[0]));
11061 }
Joe Malin32736f02011-01-19 16:14:20 -080011062
11063 // This will make the scroll bars inval themselves after
Mike Cleronf116bf82009-09-27 19:14:12 -070011064 // drawing. We only want this when we're fading so that
11065 // we prevent excessive redraws
11066 invalidate = true;
11067 } else {
11068 // We're just on -- but we may have been fading before so
11069 // reset alpha
11070 cache.scrollBar.setAlpha(255);
11071 }
11072
Joe Malin32736f02011-01-19 16:14:20 -080011073
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011074 final int viewFlags = mViewFlags;
11075
11076 final boolean drawHorizontalScrollBar =
11077 (viewFlags & SCROLLBARS_HORIZONTAL) == SCROLLBARS_HORIZONTAL;
11078 final boolean drawVerticalScrollBar =
11079 (viewFlags & SCROLLBARS_VERTICAL) == SCROLLBARS_VERTICAL
11080 && !isVerticalScrollBarHidden();
11081
11082 if (drawVerticalScrollBar || drawHorizontalScrollBar) {
11083 final int width = mRight - mLeft;
11084 final int height = mBottom - mTop;
11085
11086 final ScrollBarDrawable scrollBar = cache.scrollBar;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011087
Mike Reede8853fc2009-09-04 14:01:48 -040011088 final int scrollX = mScrollX;
11089 final int scrollY = mScrollY;
11090 final int inside = (viewFlags & SCROLLBARS_OUTSIDE_MASK) == 0 ? ~0 : 0;
11091
Mike Cleronf116bf82009-09-27 19:14:12 -070011092 int left, top, right, bottom;
Joe Malin32736f02011-01-19 16:14:20 -080011093
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011094 if (drawHorizontalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -080011095 int size = scrollBar.getSize(false);
11096 if (size <= 0) {
11097 size = cache.scrollBarSize;
11098 }
11099
Mike Cleronf116bf82009-09-27 19:14:12 -070011100 scrollBar.setParameters(computeHorizontalScrollRange(),
Mike Reede8853fc2009-09-04 14:01:48 -040011101 computeHorizontalScrollOffset(),
11102 computeHorizontalScrollExtent(), false);
Mike Reede8853fc2009-09-04 14:01:48 -040011103 final int verticalScrollBarGap = drawVerticalScrollBar ?
Mike Cleronf116bf82009-09-27 19:14:12 -070011104 getVerticalScrollbarWidth() : 0;
Joe Malin32736f02011-01-19 16:14:20 -080011105 top = scrollY + height - size - (mUserPaddingBottom & inside);
Mike Cleronf116bf82009-09-27 19:14:12 -070011106 left = scrollX + (mPaddingLeft & inside);
11107 right = scrollX + width - (mUserPaddingRight & inside) - verticalScrollBarGap;
11108 bottom = top + size;
11109 onDrawHorizontalScrollBar(canvas, scrollBar, left, top, right, bottom);
11110 if (invalidate) {
11111 invalidate(left, top, right, bottom);
11112 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011113 }
11114
11115 if (drawVerticalScrollBar) {
Adam Powell3ba67742011-01-27 14:16:55 -080011116 int size = scrollBar.getSize(true);
11117 if (size <= 0) {
11118 size = cache.scrollBarSize;
11119 }
11120
Mike Reede8853fc2009-09-04 14:01:48 -040011121 scrollBar.setParameters(computeVerticalScrollRange(),
11122 computeVerticalScrollOffset(),
11123 computeVerticalScrollExtent(), true);
Adam Powell20232d02010-12-08 21:08:53 -080011124 switch (mVerticalScrollbarPosition) {
11125 default:
11126 case SCROLLBAR_POSITION_DEFAULT:
11127 case SCROLLBAR_POSITION_RIGHT:
11128 left = scrollX + width - size - (mUserPaddingRight & inside);
11129 break;
11130 case SCROLLBAR_POSITION_LEFT:
11131 left = scrollX + (mUserPaddingLeft & inside);
11132 break;
11133 }
Mike Cleronf116bf82009-09-27 19:14:12 -070011134 top = scrollY + (mPaddingTop & inside);
11135 right = left + size;
11136 bottom = scrollY + height - (mUserPaddingBottom & inside);
11137 onDrawVerticalScrollBar(canvas, scrollBar, left, top, right, bottom);
11138 if (invalidate) {
11139 invalidate(left, top, right, bottom);
11140 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011141 }
11142 }
11143 }
11144 }
Romain Guy8506ab42009-06-11 17:35:47 -070011145
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011146 /**
Romain Guy8506ab42009-06-11 17:35:47 -070011147 * 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 -080011148 * FastScroller is visible.
11149 * @return whether to temporarily hide the vertical scrollbar
11150 * @hide
11151 */
11152 protected boolean isVerticalScrollBarHidden() {
11153 return false;
11154 }
11155
11156 /**
11157 * <p>Draw the horizontal scrollbar if
11158 * {@link #isHorizontalScrollBarEnabled()} returns true.</p>
11159 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011160 * @param canvas the canvas on which to draw the scrollbar
11161 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011162 *
11163 * @see #isHorizontalScrollBarEnabled()
11164 * @see #computeHorizontalScrollRange()
11165 * @see #computeHorizontalScrollExtent()
11166 * @see #computeHorizontalScrollOffset()
11167 * @see android.widget.ScrollBarDrawable
Mike Cleronf116bf82009-09-27 19:14:12 -070011168 * @hide
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011169 */
Romain Guy8fb95422010-08-17 18:38:51 -070011170 protected void onDrawHorizontalScrollBar(Canvas canvas, Drawable scrollBar,
11171 int l, int t, int r, int b) {
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011172 scrollBar.setBounds(l, t, r, b);
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011173 scrollBar.draw(canvas);
11174 }
Mike Reede8853fc2009-09-04 14:01:48 -040011175
Mike Reed4d6fe5f2009-09-03 13:29:05 -040011176 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011177 * <p>Draw the vertical scrollbar if {@link #isVerticalScrollBarEnabled()}
11178 * returns true.</p>
11179 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011180 * @param canvas the canvas on which to draw the scrollbar
11181 * @param scrollBar the scrollbar's drawable
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011182 *
11183 * @see #isVerticalScrollBarEnabled()
11184 * @see #computeVerticalScrollRange()
11185 * @see #computeVerticalScrollExtent()
11186 * @see #computeVerticalScrollOffset()
11187 * @see android.widget.ScrollBarDrawable
Mike Reede8853fc2009-09-04 14:01:48 -040011188 * @hide
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011189 */
Romain Guy8fb95422010-08-17 18:38:51 -070011190 protected void onDrawVerticalScrollBar(Canvas canvas, Drawable scrollBar,
11191 int l, int t, int r, int b) {
Mike Reede8853fc2009-09-04 14:01:48 -040011192 scrollBar.setBounds(l, t, r, b);
11193 scrollBar.draw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011194 }
11195
11196 /**
11197 * Implement this to do your drawing.
11198 *
11199 * @param canvas the canvas on which the background will be drawn
11200 */
11201 protected void onDraw(Canvas canvas) {
11202 }
11203
11204 /*
11205 * Caller is responsible for calling requestLayout if necessary.
11206 * (This allows addViewInLayout to not request a new layout.)
11207 */
11208 void assignParent(ViewParent parent) {
11209 if (mParent == null) {
11210 mParent = parent;
11211 } else if (parent == null) {
11212 mParent = null;
11213 } else {
11214 throw new RuntimeException("view " + this + " being added, but"
11215 + " it already has a parent");
11216 }
11217 }
11218
11219 /**
11220 * This is called when the view is attached to a window. At this point it
11221 * has a Surface and will start drawing. Note that this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070011222 * guaranteed to be called before {@link #onDraw(android.graphics.Canvas)},
11223 * however it may be called any time before the first onDraw -- including
11224 * before or after {@link #onMeasure(int, int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011225 *
11226 * @see #onDetachedFromWindow()
11227 */
11228 protected void onAttachedToWindow() {
11229 if ((mPrivateFlags & REQUEST_TRANSPARENT_REGIONS) != 0) {
11230 mParent.requestTransparentRegion(this);
11231 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011232
Adam Powell8568c3a2010-04-19 14:26:11 -070011233 if ((mPrivateFlags & AWAKEN_SCROLL_BARS_ON_ATTACH) != 0) {
11234 initialAwakenScrollBars();
11235 mPrivateFlags &= ~AWAKEN_SCROLL_BARS_ON_ATTACH;
11236 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011237
Chet Haasea9b61ac2010-12-20 07:40:25 -080011238 jumpDrawablesToCurrentState();
Romain Guy2a0f2282012-05-08 14:43:12 -070011239
Fabrice Di Meglioa6461452011-08-19 15:42:04 -070011240 // Order is important here: LayoutDirection MUST be resolved before Padding
11241 // and TextDirection
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011242 resolveLayoutDirection();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011243 resolvePadding();
Fabrice Di Meglio22268862011-06-27 18:13:18 -070011244 resolveTextDirection();
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070011245 resolveTextAlignment();
Romain Guy2a0f2282012-05-08 14:43:12 -070011246
Svetoslav Ganov42138042012-03-20 11:51:39 -070011247 clearAccessibilityFocus();
Amith Yamasani4503c8d2011-06-17 12:36:14 -070011248 if (isFocused()) {
11249 InputMethodManager imm = InputMethodManager.peekInstance();
11250 imm.focusIn(this);
11251 }
Romain Guy2a0f2282012-05-08 14:43:12 -070011252
11253 if (mAttachInfo != null && mDisplayList != null) {
11254 mAttachInfo.mViewRootImpl.dequeueDisplayList(mDisplayList);
11255 }
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011256 }
Cibu Johny86666632010-02-22 13:01:02 -080011257
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011258 /**
Romain Guybb9908b2012-03-08 11:14:07 -080011259 * @see #onScreenStateChanged(int)
11260 */
11261 void dispatchScreenStateChanged(int screenState) {
11262 onScreenStateChanged(screenState);
11263 }
11264
11265 /**
11266 * This method is called whenever the state of the screen this view is
11267 * attached to changes. A state change will usually occurs when the screen
11268 * turns on or off (whether it happens automatically or the user does it
11269 * manually.)
11270 *
11271 * @param screenState The new state of the screen. Can be either
11272 * {@link #SCREEN_STATE_ON} or {@link #SCREEN_STATE_OFF}
11273 */
11274 public void onScreenStateChanged(int screenState) {
11275 }
11276
11277 /**
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011278 * Return true if the application tag in the AndroidManifest has set "supportRtl" to true
11279 */
11280 private boolean hasRtlSupport() {
11281 return mContext.getApplicationInfo().hasRtlSupport();
11282 }
11283
11284 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011285 * Resolve and cache the layout direction. LTR is set initially. This is implicitly supposing
11286 * that the parent directionality can and will be resolved before its children.
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011287 * Will call {@link View#onResolvedLayoutDirectionChanged} when resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011288 * @hide
Fabrice Di Meglio4f5aa912011-05-31 15:20:50 -070011289 */
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011290 public void resolveLayoutDirection() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011291 // Clear any previous layout direction resolution
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -070011292 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_MASK;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011293
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011294 if (hasRtlSupport()) {
11295 // Set resolved depending on layout direction
11296 switch (getLayoutDirection()) {
11297 case LAYOUT_DIRECTION_INHERIT:
11298 // If this is root view, no need to look at parent's layout dir.
11299 if (canResolveLayoutDirection()) {
11300 ViewGroup viewGroup = ((ViewGroup) mParent);
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011301
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011302 if (viewGroup.getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
11303 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11304 }
11305 } else {
11306 // Nothing to do, LTR by default
11307 }
11308 break;
11309 case LAYOUT_DIRECTION_RTL:
11310 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11311 break;
11312 case LAYOUT_DIRECTION_LOCALE:
11313 if(isLayoutDirectionRtl(Locale.getDefault())) {
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011314 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED_RTL;
11315 }
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011316 break;
11317 default:
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011318 // Nothing to do, LTR by default
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070011319 }
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011320 }
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011321
11322 // Set to resolved
11323 mPrivateFlags2 |= LAYOUT_DIRECTION_RESOLVED;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011324 onResolvedLayoutDirectionChanged();
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080011325 // Resolve padding
11326 resolvePadding();
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011327 }
11328
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -070011329 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011330 * Called when layout direction has been resolved.
11331 *
11332 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011333 * @hide
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011334 */
11335 public void onResolvedLayoutDirectionChanged() {
11336 }
11337
11338 /**
11339 * Resolve padding depending on layout direction.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011340 * @hide
Fabrice Di Meglioaff599b2011-07-20 19:05:01 -070011341 */
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011342 public void resolvePadding() {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011343 // If the user specified the absolute padding (either with android:padding or
11344 // android:paddingLeft/Top/Right/Bottom), use this padding, otherwise
11345 // use the default padding or the padding from the background drawable
11346 // (stored at this point in mPadding*)
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011347 int resolvedLayoutDirection = getResolvedLayoutDirection();
11348 switch (resolvedLayoutDirection) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011349 case LAYOUT_DIRECTION_RTL:
11350 // Start user padding override Right user padding. Otherwise, if Right user
11351 // padding is not defined, use the default Right padding. If Right user padding
11352 // is defined, just use it.
11353 if (mUserPaddingStart >= 0) {
11354 mUserPaddingRight = mUserPaddingStart;
11355 } else if (mUserPaddingRight < 0) {
11356 mUserPaddingRight = mPaddingRight;
11357 }
11358 if (mUserPaddingEnd >= 0) {
11359 mUserPaddingLeft = mUserPaddingEnd;
11360 } else if (mUserPaddingLeft < 0) {
11361 mUserPaddingLeft = mPaddingLeft;
11362 }
11363 break;
11364 case LAYOUT_DIRECTION_LTR:
11365 default:
11366 // Start user padding override Left user padding. Otherwise, if Left user
11367 // padding is not defined, use the default left padding. If Left user padding
11368 // is defined, just use it.
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -070011369 if (mUserPaddingStart >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011370 mUserPaddingLeft = mUserPaddingStart;
11371 } else if (mUserPaddingLeft < 0) {
11372 mUserPaddingLeft = mPaddingLeft;
11373 }
Fabrice Di Megliof3e1a932011-07-15 17:15:39 -070011374 if (mUserPaddingEnd >= 0) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011375 mUserPaddingRight = mUserPaddingEnd;
11376 } else if (mUserPaddingRight < 0) {
11377 mUserPaddingRight = mPaddingRight;
11378 }
11379 }
11380
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011381 mUserPaddingBottom = (mUserPaddingBottom >= 0) ? mUserPaddingBottom : mPaddingBottom;
11382
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080011383 if(isPaddingRelative()) {
11384 setPaddingRelative(mUserPaddingStart, mPaddingTop, mUserPaddingEnd, mUserPaddingBottom);
11385 } else {
11386 recomputePadding();
11387 }
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011388 onPaddingChanged(resolvedLayoutDirection);
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011389 }
11390
11391 /**
11392 * Resolve padding depending on the layout direction. Subclasses that care about
11393 * padding resolution should override this method. The default implementation does
11394 * nothing.
11395 *
11396 * @param layoutDirection the direction of the layout
11397 *
Fabrice Di Meglioe8dc07d2012-03-09 17:10:19 -080011398 * @see {@link #LAYOUT_DIRECTION_LTR}
11399 * @see {@link #LAYOUT_DIRECTION_RTL}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011400 * @hide
Fabrice Di Meglioccb15622012-02-15 15:52:19 -080011401 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011402 public void onPaddingChanged(int layoutDirection) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011403 }
11404
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011405 /**
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011406 * Check if layout direction resolution can be done.
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011407 *
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011408 * @return true if layout direction resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011409 * @hide
Fabrice Di Meglio2273b1e2011-09-07 15:17:40 -070011410 */
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011411 public boolean canResolveLayoutDirection() {
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011412 switch (getLayoutDirection()) {
11413 case LAYOUT_DIRECTION_INHERIT:
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070011414 return (mParent != null) && (mParent instanceof ViewGroup);
Fabrice Di Megliofe7e40d2011-07-13 12:47:36 -070011415 default:
11416 return true;
11417 }
11418 }
11419
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011420 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011421 * Reset the resolved layout direction. Will call {@link View#onResolvedLayoutDirectionReset}
11422 * when reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011423 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070011424 */
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011425 public void resetResolvedLayoutDirection() {
Fabrice Di Meglioedc1e592012-03-15 17:28:47 -070011426 // Reset the current resolved bits
11427 mPrivateFlags2 &= ~LAYOUT_DIRECTION_RESOLVED_MASK;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011428 onResolvedLayoutDirectionReset();
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080011429 // Reset also the text direction
11430 resetResolvedTextDirection();
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011431 }
11432
11433 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011434 * Called during reset of resolved layout direction.
11435 *
11436 * Subclasses need to override this method to clear cached information that depends on the
11437 * resolved layout direction, or to inform child views that inherit their layout direction.
11438 *
11439 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011440 * @hide
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080011441 */
11442 public void onResolvedLayoutDirectionReset() {
11443 }
11444
11445 /**
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011446 * Check if a Locale uses an RTL script.
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011447 *
11448 * @param locale Locale to check
Fabrice Di Meglio98aec1c2012-02-13 16:54:05 -080011449 * @return true if the Locale uses an RTL script.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070011450 * @hide
Fabrice Di Meglio26e432d2011-06-10 14:19:18 -070011451 */
Fabrice Di Meglio22268862011-06-27 18:13:18 -070011452 protected static boolean isLayoutDirectionRtl(Locale locale) {
Fabrice Di Meglio3fb824b2012-02-28 17:58:31 -080011453 return (LAYOUT_DIRECTION_RTL == LocaleUtil.getLayoutDirectionFromLocale(locale));
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011454 }
11455
11456 /**
11457 * This is called when the view is detached from a window. At this point it
11458 * no longer has a surface for drawing.
11459 *
11460 * @see #onAttachedToWindow()
11461 */
11462 protected void onDetachedFromWindow() {
Romain Guy8afa5152010-02-26 11:56:30 -080011463 mPrivateFlags &= ~CANCEL_NEXT_UP_EVENT;
Romain Guy6c319ca2011-01-11 14:29:25 -080011464
Romain Guya440b002010-02-24 15:57:54 -080011465 removeUnsetPressCallback();
Maryam Garrett1549dd12009-12-15 16:06:36 -050011466 removeLongPressCallback();
Adam Powell3cb8b632011-01-21 15:34:14 -080011467 removePerformClickCallback();
Svetoslav Ganova0156172011-06-26 17:55:44 -070011468 removeSendViewScrolledAccessibilityEventCallback();
Romain Guy6c319ca2011-01-11 14:29:25 -080011469
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011470 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -080011471
Romain Guya998dff2012-03-23 18:58:36 -070011472 destroyLayer(false);
Romain Guy8dd5b1e2011-01-14 17:28:51 -080011473
11474 if (mAttachInfo != null) {
Romain Guy51e4d4d2012-03-15 18:30:47 -070011475 if (mDisplayList != null) {
Romain Guy2a0f2282012-05-08 14:43:12 -070011476 mAttachInfo.mViewRootImpl.enqueueDisplayList(mDisplayList);
Romain Guy51e4d4d2012-03-15 18:30:47 -070011477 }
Jeff Browna175a5b2012-02-15 19:18:31 -080011478 mAttachInfo.mViewRootImpl.cancelInvalidate(this);
Romain Guy51e4d4d2012-03-15 18:30:47 -070011479 } else {
11480 if (mDisplayList != null) {
11481 // Should never happen
11482 mDisplayList.invalidate();
11483 }
Romain Guy8dd5b1e2011-01-14 17:28:51 -080011484 }
11485
Patrick Dubroyec84c3a2011-01-13 17:55:37 -080011486 mCurrentAnimation = null;
Fabrice Di Meglio7f86c802011-07-01 15:09:24 -070011487
11488 resetResolvedLayoutDirection();
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070011489 resetResolvedTextAlignment();
Svetoslav Ganov42138042012-03-20 11:51:39 -070011490 resetAccessibilityStateChanged();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011491 }
11492
11493 /**
11494 * @return The number of times this view has been attached to a window
11495 */
11496 protected int getWindowAttachCount() {
11497 return mWindowAttachCount;
11498 }
11499
11500 /**
11501 * Retrieve a unique token identifying the window this view is attached to.
11502 * @return Return the window's token for use in
11503 * {@link WindowManager.LayoutParams#token WindowManager.LayoutParams.token}.
11504 */
11505 public IBinder getWindowToken() {
11506 return mAttachInfo != null ? mAttachInfo.mWindowToken : null;
11507 }
11508
11509 /**
11510 * Retrieve a unique token identifying the top-level "real" window of
11511 * the window that this view is attached to. That is, this is like
11512 * {@link #getWindowToken}, except if the window this view in is a panel
11513 * window (attached to another containing window), then the token of
11514 * the containing window is returned instead.
11515 *
11516 * @return Returns the associated window token, either
11517 * {@link #getWindowToken()} or the containing window's token.
11518 */
11519 public IBinder getApplicationWindowToken() {
11520 AttachInfo ai = mAttachInfo;
11521 if (ai != null) {
11522 IBinder appWindowToken = ai.mPanelParentWindowToken;
11523 if (appWindowToken == null) {
11524 appWindowToken = ai.mWindowToken;
11525 }
11526 return appWindowToken;
11527 }
11528 return null;
11529 }
11530
11531 /**
11532 * Retrieve private session object this view hierarchy is using to
11533 * communicate with the window manager.
11534 * @return the session object to communicate with the window manager
11535 */
11536 /*package*/ IWindowSession getWindowSession() {
11537 return mAttachInfo != null ? mAttachInfo.mSession : null;
11538 }
11539
11540 /**
11541 * @param info the {@link android.view.View.AttachInfo} to associated with
11542 * this view
11543 */
11544 void dispatchAttachedToWindow(AttachInfo info, int visibility) {
11545 //System.out.println("Attached! " + this);
11546 mAttachInfo = info;
11547 mWindowAttachCount++;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011548 // We will need to evaluate the drawable state at least once.
11549 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011550 if (mFloatingTreeObserver != null) {
11551 info.mTreeObserver.merge(mFloatingTreeObserver);
11552 mFloatingTreeObserver = null;
11553 }
11554 if ((mPrivateFlags&SCROLL_CONTAINER) != 0) {
11555 mAttachInfo.mScrollContainers.add(this);
11556 mPrivateFlags |= SCROLL_CONTAINER_ADDED;
11557 }
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -070011558 performCollectViewAttributes(mAttachInfo, visibility);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011559 onAttachedToWindow();
Adam Powell4afd62b2011-02-18 15:02:18 -080011560
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011561 ListenerInfo li = mListenerInfo;
Adam Powell4afd62b2011-02-18 15:02:18 -080011562 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011563 li != null ? li.mOnAttachStateChangeListeners : null;
Adam Powell4afd62b2011-02-18 15:02:18 -080011564 if (listeners != null && listeners.size() > 0) {
11565 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
11566 // perform the dispatching. The iterator is a safe guard against listeners that
11567 // could mutate the list by calling the various add/remove methods. This prevents
11568 // the array from being modified while we iterate it.
11569 for (OnAttachStateChangeListener listener : listeners) {
11570 listener.onViewAttachedToWindow(this);
11571 }
11572 }
11573
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011574 int vis = info.mWindowVisibility;
11575 if (vis != GONE) {
11576 onWindowVisibilityChanged(vis);
11577 }
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080011578 if ((mPrivateFlags&DRAWABLE_STATE_DIRTY) != 0) {
11579 // If nobody has evaluated the drawable state yet, then do it now.
11580 refreshDrawableState();
11581 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011582 }
11583
11584 void dispatchDetachedFromWindow() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011585 AttachInfo info = mAttachInfo;
11586 if (info != null) {
11587 int vis = info.mWindowVisibility;
11588 if (vis != GONE) {
11589 onWindowVisibilityChanged(GONE);
11590 }
11591 }
11592
11593 onDetachedFromWindow();
Romain Guy01d5edc2011-01-28 11:28:53 -080011594
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011595 ListenerInfo li = mListenerInfo;
Adam Powell4afd62b2011-02-18 15:02:18 -080011596 final CopyOnWriteArrayList<OnAttachStateChangeListener> listeners =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070011597 li != null ? li.mOnAttachStateChangeListeners : null;
Adam Powell4afd62b2011-02-18 15:02:18 -080011598 if (listeners != null && listeners.size() > 0) {
11599 // NOTE: because of the use of CopyOnWriteArrayList, we *must* use an iterator to
11600 // perform the dispatching. The iterator is a safe guard against listeners that
11601 // could mutate the list by calling the various add/remove methods. This prevents
11602 // the array from being modified while we iterate it.
11603 for (OnAttachStateChangeListener listener : listeners) {
11604 listener.onViewDetachedFromWindow(this);
11605 }
11606 }
11607
Romain Guy01d5edc2011-01-28 11:28:53 -080011608 if ((mPrivateFlags & SCROLL_CONTAINER_ADDED) != 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011609 mAttachInfo.mScrollContainers.remove(this);
11610 mPrivateFlags &= ~SCROLL_CONTAINER_ADDED;
11611 }
Romain Guy01d5edc2011-01-28 11:28:53 -080011612
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011613 mAttachInfo = null;
11614 }
11615
11616 /**
11617 * Store this view hierarchy's frozen state into the given container.
11618 *
11619 * @param container The SparseArray in which to save the view's state.
11620 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011621 * @see #restoreHierarchyState(android.util.SparseArray)
11622 * @see #dispatchSaveInstanceState(android.util.SparseArray)
11623 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011624 */
11625 public void saveHierarchyState(SparseArray<Parcelable> container) {
11626 dispatchSaveInstanceState(container);
11627 }
11628
11629 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -070011630 * Called by {@link #saveHierarchyState(android.util.SparseArray)} to store the state for
11631 * this view and its children. May be overridden to modify how freezing happens to a
11632 * 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 -080011633 *
11634 * @param container The SparseArray in which to save the view's state.
11635 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011636 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
11637 * @see #saveHierarchyState(android.util.SparseArray)
11638 * @see #onSaveInstanceState()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011639 */
11640 protected void dispatchSaveInstanceState(SparseArray<Parcelable> container) {
11641 if (mID != NO_ID && (mViewFlags & SAVE_DISABLED_MASK) == 0) {
11642 mPrivateFlags &= ~SAVE_STATE_CALLED;
11643 Parcelable state = onSaveInstanceState();
11644 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
11645 throw new IllegalStateException(
11646 "Derived class did not call super.onSaveInstanceState()");
11647 }
11648 if (state != null) {
11649 // Log.i("View", "Freezing #" + Integer.toHexString(mID)
11650 // + ": " + state);
11651 container.put(mID, state);
11652 }
11653 }
11654 }
11655
11656 /**
11657 * Hook allowing a view to generate a representation of its internal state
11658 * that can later be used to create a new instance with that same state.
11659 * This state should only contain information that is not persistent or can
11660 * not be reconstructed later. For example, you will never store your
11661 * current position on screen because that will be computed again when a
11662 * new instance of the view is placed in its view hierarchy.
11663 * <p>
11664 * Some examples of things you may store here: the current cursor position
11665 * in a text view (but usually not the text itself since that is stored in a
11666 * content provider or other persistent storage), the currently selected
11667 * item in a list view.
11668 *
11669 * @return Returns a Parcelable object containing the view's current dynamic
11670 * state, or null if there is nothing interesting to save. The
11671 * default implementation returns null.
Philip Milne6c8ea062012-04-03 17:38:43 -070011672 * @see #onRestoreInstanceState(android.os.Parcelable)
11673 * @see #saveHierarchyState(android.util.SparseArray)
11674 * @see #dispatchSaveInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011675 * @see #setSaveEnabled(boolean)
11676 */
11677 protected Parcelable onSaveInstanceState() {
11678 mPrivateFlags |= SAVE_STATE_CALLED;
11679 return BaseSavedState.EMPTY_STATE;
11680 }
11681
11682 /**
11683 * Restore this view hierarchy's frozen state from the given container.
11684 *
11685 * @param container The SparseArray which holds previously frozen states.
11686 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011687 * @see #saveHierarchyState(android.util.SparseArray)
11688 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
11689 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011690 */
11691 public void restoreHierarchyState(SparseArray<Parcelable> container) {
11692 dispatchRestoreInstanceState(container);
11693 }
11694
11695 /**
Romain Guy5c22a8c2011-05-13 11:48:45 -070011696 * Called by {@link #restoreHierarchyState(android.util.SparseArray)} to retrieve the
11697 * state for this view and its children. May be overridden to modify how restoring
11698 * happens to a view's children; for example, some views may want to not store state
11699 * for their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011700 *
11701 * @param container The SparseArray which holds previously saved state.
11702 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011703 * @see #dispatchSaveInstanceState(android.util.SparseArray)
11704 * @see #restoreHierarchyState(android.util.SparseArray)
11705 * @see #onRestoreInstanceState(android.os.Parcelable)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011706 */
11707 protected void dispatchRestoreInstanceState(SparseArray<Parcelable> container) {
11708 if (mID != NO_ID) {
11709 Parcelable state = container.get(mID);
11710 if (state != null) {
11711 // Log.i("View", "Restoreing #" + Integer.toHexString(mID)
11712 // + ": " + state);
11713 mPrivateFlags &= ~SAVE_STATE_CALLED;
11714 onRestoreInstanceState(state);
11715 if ((mPrivateFlags & SAVE_STATE_CALLED) == 0) {
11716 throw new IllegalStateException(
11717 "Derived class did not call super.onRestoreInstanceState()");
11718 }
11719 }
11720 }
11721 }
11722
11723 /**
11724 * Hook allowing a view to re-apply a representation of its internal state that had previously
11725 * been generated by {@link #onSaveInstanceState}. This function will never be called with a
11726 * null state.
11727 *
11728 * @param state The frozen state that had previously been returned by
11729 * {@link #onSaveInstanceState}.
11730 *
Philip Milne6c8ea062012-04-03 17:38:43 -070011731 * @see #onSaveInstanceState()
11732 * @see #restoreHierarchyState(android.util.SparseArray)
11733 * @see #dispatchRestoreInstanceState(android.util.SparseArray)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011734 */
11735 protected void onRestoreInstanceState(Parcelable state) {
11736 mPrivateFlags |= SAVE_STATE_CALLED;
11737 if (state != BaseSavedState.EMPTY_STATE && state != null) {
Romain Guy237c1ce2009-12-08 11:30:25 -080011738 throw new IllegalArgumentException("Wrong state class, expecting View State but "
11739 + "received " + state.getClass().toString() + " instead. This usually happens "
Joe Malin32736f02011-01-19 16:14:20 -080011740 + "when two views of different type have the same id in the same hierarchy. "
11741 + "This view's id is " + ViewDebug.resolveId(mContext, getId()) + ". Make sure "
Romain Guy237c1ce2009-12-08 11:30:25 -080011742 + "other views do not use the same id.");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011743 }
11744 }
11745
11746 /**
11747 * <p>Return the time at which the drawing of the view hierarchy started.</p>
11748 *
11749 * @return the drawing start time in milliseconds
11750 */
11751 public long getDrawingTime() {
11752 return mAttachInfo != null ? mAttachInfo.mDrawingTime : 0;
11753 }
11754
11755 /**
11756 * <p>Enables or disables the duplication of the parent's state into this view. When
11757 * duplication is enabled, this view gets its drawable state from its parent rather
11758 * than from its own internal properties.</p>
11759 *
11760 * <p>Note: in the current implementation, setting this property to true after the
11761 * view was added to a ViewGroup might have no effect at all. This property should
11762 * always be used from XML or set to true before adding this view to a ViewGroup.</p>
11763 *
11764 * <p>Note: if this view's parent addStateFromChildren property is enabled and this
11765 * property is enabled, an exception will be thrown.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011766 *
Gilles Debunnefb817032011-01-13 13:52:49 -080011767 * <p>Note: if the child view uses and updates additionnal states which are unknown to the
11768 * parent, these states should not be affected by this method.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080011769 *
11770 * @param enabled True to enable duplication of the parent's drawable state, false
11771 * to disable it.
11772 *
11773 * @see #getDrawableState()
11774 * @see #isDuplicateParentStateEnabled()
11775 */
11776 public void setDuplicateParentStateEnabled(boolean enabled) {
11777 setFlags(enabled ? DUPLICATE_PARENT_STATE : 0, DUPLICATE_PARENT_STATE);
11778 }
11779
11780 /**
11781 * <p>Indicates whether this duplicates its drawable state from its parent.</p>
11782 *
11783 * @return True if this view's drawable state is duplicated from the parent,
11784 * false otherwise
11785 *
11786 * @see #getDrawableState()
11787 * @see #setDuplicateParentStateEnabled(boolean)
11788 */
11789 public boolean isDuplicateParentStateEnabled() {
11790 return (mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE;
11791 }
11792
11793 /**
Romain Guy171c5922011-01-06 10:04:23 -080011794 * <p>Specifies the type of layer backing this view. The layer can be
11795 * {@link #LAYER_TYPE_NONE disabled}, {@link #LAYER_TYPE_SOFTWARE software} or
11796 * {@link #LAYER_TYPE_HARDWARE hardware}.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011797 *
Romain Guy171c5922011-01-06 10:04:23 -080011798 * <p>A layer is associated with an optional {@link android.graphics.Paint}
11799 * instance that controls how the layer is composed on screen. The following
11800 * properties of the paint are taken into account when composing the layer:</p>
11801 * <ul>
11802 * <li>{@link android.graphics.Paint#getAlpha() Translucency (alpha)}</li>
11803 * <li>{@link android.graphics.Paint#getXfermode() Blending mode}</li>
11804 * <li>{@link android.graphics.Paint#getColorFilter() Color filter}</li>
11805 * </ul>
Joe Malin32736f02011-01-19 16:14:20 -080011806 *
Romain Guy171c5922011-01-06 10:04:23 -080011807 * <p>If this view has an alpha value set to < 1.0 by calling
11808 * {@link #setAlpha(float)}, the alpha value of the layer's paint is replaced by
11809 * this view's alpha value. Calling {@link #setAlpha(float)} is therefore
11810 * equivalent to setting a hardware layer on this view and providing a paint with
11811 * the desired alpha value.<p>
Joe Malin32736f02011-01-19 16:14:20 -080011812 *
Romain Guy171c5922011-01-06 10:04:23 -080011813 * <p>Refer to the documentation of {@link #LAYER_TYPE_NONE disabled},
11814 * {@link #LAYER_TYPE_SOFTWARE software} and {@link #LAYER_TYPE_HARDWARE hardware}
11815 * for more information on when and how to use layers.</p>
Joe Malin32736f02011-01-19 16:14:20 -080011816 *
Romain Guy171c5922011-01-06 10:04:23 -080011817 * @param layerType The ype of layer to use with this view, must be one of
11818 * {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
11819 * {@link #LAYER_TYPE_HARDWARE}
11820 * @param paint The paint used to compose the layer. This argument is optional
11821 * and can be null. It is ignored when the layer type is
11822 * {@link #LAYER_TYPE_NONE}
Joe Malin32736f02011-01-19 16:14:20 -080011823 *
11824 * @see #getLayerType()
Romain Guy171c5922011-01-06 10:04:23 -080011825 * @see #LAYER_TYPE_NONE
11826 * @see #LAYER_TYPE_SOFTWARE
11827 * @see #LAYER_TYPE_HARDWARE
Joe Malin32736f02011-01-19 16:14:20 -080011828 * @see #setAlpha(float)
11829 *
Romain Guy171c5922011-01-06 10:04:23 -080011830 * @attr ref android.R.styleable#View_layerType
11831 */
11832 public void setLayerType(int layerType, Paint paint) {
11833 if (layerType < LAYER_TYPE_NONE || layerType > LAYER_TYPE_HARDWARE) {
Joe Malin32736f02011-01-19 16:14:20 -080011834 throw new IllegalArgumentException("Layer type can only be one of: LAYER_TYPE_NONE, "
Romain Guy171c5922011-01-06 10:04:23 -080011835 + "LAYER_TYPE_SOFTWARE or LAYER_TYPE_HARDWARE");
11836 }
Chet Haasedaf98e92011-01-10 14:10:36 -080011837
Romain Guyd6cd5722011-01-17 14:42:41 -080011838 if (layerType == mLayerType) {
11839 if (layerType != LAYER_TYPE_NONE && paint != mLayerPaint) {
11840 mLayerPaint = paint == null ? new Paint() : paint;
Romain Guy0fd89bf2011-01-26 15:41:30 -080011841 invalidateParentCaches();
11842 invalidate(true);
Romain Guyd6cd5722011-01-17 14:42:41 -080011843 }
11844 return;
11845 }
Romain Guy171c5922011-01-06 10:04:23 -080011846
11847 // Destroy any previous software drawing cache if needed
Romain Guy6c319ca2011-01-11 14:29:25 -080011848 switch (mLayerType) {
Chet Haase6f33e812011-05-17 12:42:19 -070011849 case LAYER_TYPE_HARDWARE:
Romain Guya998dff2012-03-23 18:58:36 -070011850 destroyLayer(false);
Romain Guy31f2c2e2011-11-21 10:55:41 -080011851 // fall through - non-accelerated views may use software layer mechanism instead
Romain Guy6c319ca2011-01-11 14:29:25 -080011852 case LAYER_TYPE_SOFTWARE:
Romain Guy6d7475d2011-07-27 16:28:21 -070011853 destroyDrawingCache();
Romain Guy6c319ca2011-01-11 14:29:25 -080011854 break;
Romain Guy6c319ca2011-01-11 14:29:25 -080011855 default:
11856 break;
Romain Guy171c5922011-01-06 10:04:23 -080011857 }
11858
11859 mLayerType = layerType;
Romain Guy3a3133d2011-02-01 22:59:58 -080011860 final boolean layerDisabled = mLayerType == LAYER_TYPE_NONE;
11861 mLayerPaint = layerDisabled ? null : (paint == null ? new Paint() : paint);
11862 mLocalDirtyRect = layerDisabled ? null : new Rect();
Romain Guy171c5922011-01-06 10:04:23 -080011863
Romain Guy0fd89bf2011-01-26 15:41:30 -080011864 invalidateParentCaches();
11865 invalidate(true);
Romain Guy171c5922011-01-06 10:04:23 -080011866 }
11867
11868 /**
Romain Guy59c7f802011-09-29 17:21:45 -070011869 * Indicates whether this view has a static layer. A view with layer type
11870 * {@link #LAYER_TYPE_NONE} is a static layer. Other types of layers are
11871 * dynamic.
11872 */
11873 boolean hasStaticLayer() {
Romain Guy2bf68f02012-03-02 13:37:47 -080011874 return true;
Romain Guy59c7f802011-09-29 17:21:45 -070011875 }
11876
11877 /**
Romain Guy171c5922011-01-06 10:04:23 -080011878 * Indicates what type of layer is currently associated with this view. By default
11879 * a view does not have a layer, and the layer type is {@link #LAYER_TYPE_NONE}.
11880 * Refer to the documentation of {@link #setLayerType(int, android.graphics.Paint)}
11881 * for more information on the different types of layers.
Joe Malin32736f02011-01-19 16:14:20 -080011882 *
Romain Guy171c5922011-01-06 10:04:23 -080011883 * @return {@link #LAYER_TYPE_NONE}, {@link #LAYER_TYPE_SOFTWARE} or
11884 * {@link #LAYER_TYPE_HARDWARE}
Joe Malin32736f02011-01-19 16:14:20 -080011885 *
11886 * @see #setLayerType(int, android.graphics.Paint)
Philip Milne6c8ea062012-04-03 17:38:43 -070011887 * @see #buildLayer()
Romain Guy171c5922011-01-06 10:04:23 -080011888 * @see #LAYER_TYPE_NONE
11889 * @see #LAYER_TYPE_SOFTWARE
11890 * @see #LAYER_TYPE_HARDWARE
11891 */
11892 public int getLayerType() {
11893 return mLayerType;
11894 }
Joe Malin32736f02011-01-19 16:14:20 -080011895
Romain Guy6c319ca2011-01-11 14:29:25 -080011896 /**
Romain Guyf1ae1062011-03-02 18:16:04 -080011897 * Forces this view's layer to be created and this view to be rendered
11898 * into its layer. If this view's layer type is set to {@link #LAYER_TYPE_NONE},
11899 * invoking this method will have no effect.
Philip Milne6c8ea062012-04-03 17:38:43 -070011900 *
Romain Guyf1ae1062011-03-02 18:16:04 -080011901 * This method can for instance be used to render a view into its layer before
11902 * starting an animation. If this view is complex, rendering into the layer
11903 * before starting the animation will avoid skipping frames.
Philip Milne6c8ea062012-04-03 17:38:43 -070011904 *
Romain Guyf1ae1062011-03-02 18:16:04 -080011905 * @throws IllegalStateException If this view is not attached to a window
Philip Milne6c8ea062012-04-03 17:38:43 -070011906 *
11907 * @see #setLayerType(int, android.graphics.Paint)
Romain Guyf1ae1062011-03-02 18:16:04 -080011908 */
11909 public void buildLayer() {
11910 if (mLayerType == LAYER_TYPE_NONE) return;
11911
11912 if (mAttachInfo == null) {
11913 throw new IllegalStateException("This view must be attached to a window first");
11914 }
11915
11916 switch (mLayerType) {
11917 case LAYER_TYPE_HARDWARE:
Romain Guyd0609e42011-11-21 17:21:15 -080011918 if (mAttachInfo.mHardwareRenderer != null &&
11919 mAttachInfo.mHardwareRenderer.isEnabled() &&
11920 mAttachInfo.mHardwareRenderer.validate()) {
Michael Jurka7e52caf2012-03-06 15:57:06 -080011921 getHardwareLayer();
Romain Guyd0609e42011-11-21 17:21:15 -080011922 }
Romain Guyf1ae1062011-03-02 18:16:04 -080011923 break;
11924 case LAYER_TYPE_SOFTWARE:
11925 buildDrawingCache(true);
11926 break;
11927 }
11928 }
Philip Milne6c8ea062012-04-03 17:38:43 -070011929
Romain Guy9c4b79a2011-11-10 19:23:58 -080011930 // Make sure the HardwareRenderer.validate() was invoked before calling this method
11931 void flushLayer() {
11932 if (mLayerType == LAYER_TYPE_HARDWARE && mHardwareLayer != null) {
11933 mHardwareLayer.flush();
11934 }
11935 }
Romain Guyf1ae1062011-03-02 18:16:04 -080011936
11937 /**
Romain Guy6c319ca2011-01-11 14:29:25 -080011938 * <p>Returns a hardware layer that can be used to draw this view again
11939 * without executing its draw method.</p>
11940 *
11941 * @return A HardwareLayer ready to render, or null if an error occurred.
11942 */
Michael Jurka7e52caf2012-03-06 15:57:06 -080011943 HardwareLayer getHardwareLayer() {
Romain Guyea835032011-07-28 19:24:37 -070011944 if (mAttachInfo == null || mAttachInfo.mHardwareRenderer == null ||
11945 !mAttachInfo.mHardwareRenderer.isEnabled()) {
Romain Guy6c319ca2011-01-11 14:29:25 -080011946 return null;
11947 }
Philip Milne6c8ea062012-04-03 17:38:43 -070011948
Romain Guy9c4b79a2011-11-10 19:23:58 -080011949 if (!mAttachInfo.mHardwareRenderer.validate()) return null;
Romain Guy6c319ca2011-01-11 14:29:25 -080011950
11951 final int width = mRight - mLeft;
11952 final int height = mBottom - mTop;
Joe Malin32736f02011-01-19 16:14:20 -080011953
Romain Guy6c319ca2011-01-11 14:29:25 -080011954 if (width == 0 || height == 0) {
11955 return null;
11956 }
11957
11958 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || mHardwareLayer == null) {
11959 if (mHardwareLayer == null) {
11960 mHardwareLayer = mAttachInfo.mHardwareRenderer.createHardwareLayer(
11961 width, height, isOpaque());
Michael Jurka952e02b2012-03-13 18:34:35 -070011962 mLocalDirtyRect.set(0, 0, width, height);
Romain Guy6c319ca2011-01-11 14:29:25 -080011963 } else if (mHardwareLayer.getWidth() != width || mHardwareLayer.getHeight() != height) {
11964 mHardwareLayer.resize(width, height);
Michael Jurka952e02b2012-03-13 18:34:35 -070011965 mLocalDirtyRect.set(0, 0, width, height);
Romain Guy6c319ca2011-01-11 14:29:25 -080011966 }
11967
Romain Guy5cd5c3f2011-10-17 17:10:02 -070011968 // The layer is not valid if the underlying GPU resources cannot be allocated
11969 if (!mHardwareLayer.isValid()) {
11970 return null;
11971 }
11972
Chet Haasea1cff502012-02-21 13:43:44 -080011973 mHardwareLayer.redraw(getHardwareLayerDisplayList(mHardwareLayer), mLocalDirtyRect);
Michael Jurka7e52caf2012-03-06 15:57:06 -080011974 mLocalDirtyRect.setEmpty();
Romain Guy6c319ca2011-01-11 14:29:25 -080011975 }
11976
11977 return mHardwareLayer;
11978 }
Romain Guy171c5922011-01-06 10:04:23 -080011979
Romain Guy589b0bb2011-10-10 13:57:47 -070011980 /**
11981 * Destroys this View's hardware layer if possible.
Philip Milne6c8ea062012-04-03 17:38:43 -070011982 *
Romain Guy589b0bb2011-10-10 13:57:47 -070011983 * @return True if the layer was destroyed, false otherwise.
Philip Milne6c8ea062012-04-03 17:38:43 -070011984 *
11985 * @see #setLayerType(int, android.graphics.Paint)
Romain Guy589b0bb2011-10-10 13:57:47 -070011986 * @see #LAYER_TYPE_HARDWARE
11987 */
Romain Guya998dff2012-03-23 18:58:36 -070011988 boolean destroyLayer(boolean valid) {
Romain Guy6d7475d2011-07-27 16:28:21 -070011989 if (mHardwareLayer != null) {
Romain Guy9c4b79a2011-11-10 19:23:58 -080011990 AttachInfo info = mAttachInfo;
11991 if (info != null && info.mHardwareRenderer != null &&
Romain Guya998dff2012-03-23 18:58:36 -070011992 info.mHardwareRenderer.isEnabled() &&
11993 (valid || info.mHardwareRenderer.validate())) {
Romain Guy9c4b79a2011-11-10 19:23:58 -080011994 mHardwareLayer.destroy();
11995 mHardwareLayer = null;
Romain Guy31f2c2e2011-11-21 10:55:41 -080011996
Romain Guy9c4b79a2011-11-10 19:23:58 -080011997 invalidate(true);
11998 invalidateParentCaches();
11999 }
Romain Guy65b345f2011-07-27 18:51:50 -070012000 return true;
Romain Guy6d7475d2011-07-27 16:28:21 -070012001 }
Romain Guy65b345f2011-07-27 18:51:50 -070012002 return false;
Romain Guy6d7475d2011-07-27 16:28:21 -070012003 }
12004
Romain Guy171c5922011-01-06 10:04:23 -080012005 /**
Romain Guy31f2c2e2011-11-21 10:55:41 -080012006 * Destroys all hardware rendering resources. This method is invoked
12007 * when the system needs to reclaim resources. Upon execution of this
12008 * method, you should free any OpenGL resources created by the view.
Philip Milne6c8ea062012-04-03 17:38:43 -070012009 *
Romain Guy31f2c2e2011-11-21 10:55:41 -080012010 * Note: you <strong>must</strong> call
12011 * <code>super.destroyHardwareResources()</code> when overriding
12012 * this method.
Philip Milne6c8ea062012-04-03 17:38:43 -070012013 *
Romain Guy31f2c2e2011-11-21 10:55:41 -080012014 * @hide
12015 */
12016 protected void destroyHardwareResources() {
Romain Guya998dff2012-03-23 18:58:36 -070012017 destroyLayer(true);
Romain Guy31f2c2e2011-11-21 10:55:41 -080012018 }
12019
12020 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012021 * <p>Enables or disables the drawing cache. When the drawing cache is enabled, the next call
12022 * to {@link #getDrawingCache()} or {@link #buildDrawingCache()} will draw the view in a
12023 * bitmap. Calling {@link #draw(android.graphics.Canvas)} will not draw from the cache when
12024 * the cache is enabled. To benefit from the cache, you must request the drawing cache by
12025 * calling {@link #getDrawingCache()} and draw it on screen if the returned bitmap is not
12026 * null.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012027 *
Romain Guy171c5922011-01-06 10:04:23 -080012028 * <p>Enabling the drawing cache is similar to
12029 * {@link #setLayerType(int, android.graphics.Paint) setting a layer} when hardware
Chet Haasedaf98e92011-01-10 14:10:36 -080012030 * acceleration is turned off. When hardware acceleration is turned on, enabling the
12031 * drawing cache has no effect on rendering because the system uses a different mechanism
12032 * for acceleration which ignores the flag. If you want to use a Bitmap for the view, even
12033 * when hardware acceleration is enabled, see {@link #setLayerType(int, android.graphics.Paint)}
12034 * for information on how to enable software and hardware layers.</p>
12035 *
12036 * <p>This API can be used to manually generate
12037 * a bitmap copy of this view, by setting the flag to <code>true</code> and calling
12038 * {@link #getDrawingCache()}.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012039 *
12040 * @param enabled true to enable the drawing cache, false otherwise
12041 *
12042 * @see #isDrawingCacheEnabled()
12043 * @see #getDrawingCache()
12044 * @see #buildDrawingCache()
Joe Malin32736f02011-01-19 16:14:20 -080012045 * @see #setLayerType(int, android.graphics.Paint)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012046 */
12047 public void setDrawingCacheEnabled(boolean enabled) {
Romain Guy0211a0a2011-02-14 16:34:59 -080012048 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012049 setFlags(enabled ? DRAWING_CACHE_ENABLED : 0, DRAWING_CACHE_ENABLED);
12050 }
12051
12052 /**
12053 * <p>Indicates whether the drawing cache is enabled for this view.</p>
12054 *
12055 * @return true if the drawing cache is enabled
12056 *
12057 * @see #setDrawingCacheEnabled(boolean)
12058 * @see #getDrawingCache()
12059 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070012060 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012061 public boolean isDrawingCacheEnabled() {
12062 return (mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED;
12063 }
12064
12065 /**
Chet Haasedaf98e92011-01-10 14:10:36 -080012066 * Debugging utility which recursively outputs the dirty state of a view and its
12067 * descendants.
Joe Malin32736f02011-01-19 16:14:20 -080012068 *
Chet Haasedaf98e92011-01-10 14:10:36 -080012069 * @hide
12070 */
Romain Guy676b1732011-02-14 14:45:33 -080012071 @SuppressWarnings({"UnusedDeclaration"})
Chet Haasedaf98e92011-01-10 14:10:36 -080012072 public void outputDirtyFlags(String indent, boolean clear, int clearMask) {
12073 Log.d("View", indent + this + " DIRTY(" + (mPrivateFlags & View.DIRTY_MASK) +
12074 ") DRAWN(" + (mPrivateFlags & DRAWN) + ")" + " CACHE_VALID(" +
12075 (mPrivateFlags & View.DRAWING_CACHE_VALID) +
12076 ") INVALIDATED(" + (mPrivateFlags & INVALIDATED) + ")");
12077 if (clear) {
12078 mPrivateFlags &= clearMask;
12079 }
12080 if (this instanceof ViewGroup) {
12081 ViewGroup parent = (ViewGroup) this;
12082 final int count = parent.getChildCount();
12083 for (int i = 0; i < count; i++) {
Romain Guy7d7b5492011-01-24 16:33:45 -080012084 final View child = parent.getChildAt(i);
Chet Haasedaf98e92011-01-10 14:10:36 -080012085 child.outputDirtyFlags(indent + " ", clear, clearMask);
12086 }
12087 }
12088 }
12089
12090 /**
12091 * This method is used by ViewGroup to cause its children to restore or recreate their
12092 * display lists. It is called by getDisplayList() when the parent ViewGroup does not need
12093 * to recreate its own display list, which would happen if it went through the normal
12094 * draw/dispatchDraw mechanisms.
12095 *
12096 * @hide
12097 */
12098 protected void dispatchGetDisplayList() {}
Chet Haasef4ac5472011-01-27 10:30:25 -080012099
12100 /**
12101 * A view that is not attached or hardware accelerated cannot create a display list.
12102 * This method checks these conditions and returns the appropriate result.
12103 *
12104 * @return true if view has the ability to create a display list, false otherwise.
12105 *
12106 * @hide
12107 */
12108 public boolean canHaveDisplayList() {
Romain Guy676b1732011-02-14 14:45:33 -080012109 return !(mAttachInfo == null || mAttachInfo.mHardwareRenderer == null);
Chet Haasef4ac5472011-01-27 10:30:25 -080012110 }
Joe Malin32736f02011-01-19 16:14:20 -080012111
Chet Haasedaf98e92011-01-10 14:10:36 -080012112 /**
Gilles Debunneb35ab7b2011-12-05 15:54:00 -080012113 * @return The HardwareRenderer associated with that view or null if hardware rendering
12114 * is not supported or this this has not been attached to a window.
12115 *
12116 * @hide
12117 */
12118 public HardwareRenderer getHardwareRenderer() {
12119 if (mAttachInfo != null) {
12120 return mAttachInfo.mHardwareRenderer;
12121 }
12122 return null;
12123 }
12124
12125 /**
Chet Haasea1cff502012-02-21 13:43:44 -080012126 * Returns a DisplayList. If the incoming displayList is null, one will be created.
12127 * Otherwise, the same display list will be returned (after having been rendered into
12128 * along the way, depending on the invalidation state of the view).
12129 *
12130 * @param displayList The previous version of this displayList, could be null.
12131 * @param isLayer Whether the requester of the display list is a layer. If so,
12132 * the view will avoid creating a layer inside the resulting display list.
12133 * @return A new or reused DisplayList object.
12134 */
12135 private DisplayList getDisplayList(DisplayList displayList, boolean isLayer) {
12136 if (!canHaveDisplayList()) {
12137 return null;
12138 }
12139
12140 if (((mPrivateFlags & DRAWING_CACHE_VALID) == 0 ||
12141 displayList == null || !displayList.isValid() ||
12142 (!isLayer && mRecreateDisplayList))) {
12143 // Don't need to recreate the display list, just need to tell our
12144 // children to restore/recreate theirs
12145 if (displayList != null && displayList.isValid() &&
12146 !isLayer && !mRecreateDisplayList) {
12147 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
12148 mPrivateFlags &= ~DIRTY_MASK;
12149 dispatchGetDisplayList();
12150
12151 return displayList;
12152 }
12153
12154 if (!isLayer) {
12155 // If we got here, we're recreating it. Mark it as such to ensure that
12156 // we copy in child display lists into ours in drawChild()
12157 mRecreateDisplayList = true;
12158 }
12159 if (displayList == null) {
12160 final String name = getClass().getSimpleName();
12161 displayList = mAttachInfo.mHardwareRenderer.createDisplayList(name);
12162 // If we're creating a new display list, make sure our parent gets invalidated
12163 // since they will need to recreate their display list to account for this
12164 // new child display list.
12165 invalidateParentCaches();
12166 }
12167
12168 boolean caching = false;
12169 final HardwareCanvas canvas = displayList.start();
Chet Haasea1cff502012-02-21 13:43:44 -080012170 int width = mRight - mLeft;
12171 int height = mBottom - mTop;
12172
12173 try {
12174 canvas.setViewport(width, height);
12175 // The dirty rect should always be null for a display list
12176 canvas.onPreDraw(null);
12177 int layerType = (
12178 !(mParent instanceof ViewGroup) || ((ViewGroup)mParent).mDrawLayers) ?
12179 getLayerType() : LAYER_TYPE_NONE;
Chet Haase1271e2c2012-04-20 09:54:27 -070012180 if (!isLayer && layerType != LAYER_TYPE_NONE) {
Chet Haaseb85967b2012-03-26 14:37:51 -070012181 if (layerType == LAYER_TYPE_HARDWARE) {
12182 final HardwareLayer layer = getHardwareLayer();
12183 if (layer != null && layer.isValid()) {
12184 canvas.drawHardwareLayer(layer, 0, 0, mLayerPaint);
12185 } else {
12186 canvas.saveLayer(0, 0, mRight - mLeft, mBottom - mTop, mLayerPaint,
12187 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG |
12188 Canvas.CLIP_TO_LAYER_SAVE_FLAG);
12189 }
12190 caching = true;
Chet Haasea1cff502012-02-21 13:43:44 -080012191 } else {
Chet Haaseb85967b2012-03-26 14:37:51 -070012192 buildDrawingCache(true);
12193 Bitmap cache = getDrawingCache(true);
12194 if (cache != null) {
12195 canvas.drawBitmap(cache, 0, 0, mLayerPaint);
12196 caching = true;
12197 }
Chet Haasea1cff502012-02-21 13:43:44 -080012198 }
Chet Haasea1cff502012-02-21 13:43:44 -080012199 } else {
12200
12201 computeScroll();
12202
Chet Haasea1cff502012-02-21 13:43:44 -080012203 canvas.translate(-mScrollX, -mScrollY);
12204 if (!isLayer) {
12205 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
12206 mPrivateFlags &= ~DIRTY_MASK;
12207 }
12208
12209 // Fast path for layouts with no backgrounds
12210 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12211 dispatchDraw(canvas);
12212 } else {
12213 draw(canvas);
12214 }
12215 }
12216 } finally {
Chet Haasea1cff502012-02-21 13:43:44 -080012217 canvas.onPostDraw();
12218
12219 displayList.end();
Chet Haase1271e2c2012-04-20 09:54:27 -070012220 displayList.setCaching(caching);
12221 if (isLayer) {
Chet Haasea1cff502012-02-21 13:43:44 -080012222 displayList.setLeftTopRightBottom(0, 0, width, height);
12223 } else {
12224 setDisplayListProperties(displayList);
12225 }
12226 }
12227 } else if (!isLayer) {
12228 mPrivateFlags |= DRAWN | DRAWING_CACHE_VALID;
12229 mPrivateFlags &= ~DIRTY_MASK;
12230 }
12231
12232 return displayList;
12233 }
12234
12235 /**
12236 * Get the DisplayList for the HardwareLayer
12237 *
12238 * @param layer The HardwareLayer whose DisplayList we want
12239 * @return A DisplayList fopr the specified HardwareLayer
12240 */
12241 private DisplayList getHardwareLayerDisplayList(HardwareLayer layer) {
12242 DisplayList displayList = getDisplayList(layer.getDisplayList(), true);
12243 layer.setDisplayList(displayList);
12244 return displayList;
12245 }
12246
12247
12248 /**
Romain Guyb051e892010-09-28 19:09:36 -070012249 * <p>Returns a display list that can be used to draw this view again
12250 * without executing its draw method.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012251 *
Romain Guyb051e892010-09-28 19:09:36 -070012252 * @return A DisplayList ready to replay, or null if caching is not enabled.
Chet Haasedaf98e92011-01-10 14:10:36 -080012253 *
12254 * @hide
Romain Guyb051e892010-09-28 19:09:36 -070012255 */
Chet Haasedaf98e92011-01-10 14:10:36 -080012256 public DisplayList getDisplayList() {
Chet Haasea1cff502012-02-21 13:43:44 -080012257 mDisplayList = getDisplayList(mDisplayList, false);
Romain Guyb051e892010-09-28 19:09:36 -070012258 return mDisplayList;
12259 }
12260
12261 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070012262 * <p>Calling this method is equivalent to calling <code>getDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012263 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012264 * @return A non-scaled bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -080012265 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012266 * @see #getDrawingCache(boolean)
12267 */
12268 public Bitmap getDrawingCache() {
12269 return getDrawingCache(false);
12270 }
12271
12272 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012273 * <p>Returns the bitmap in which this view drawing is cached. The returned bitmap
12274 * is null when caching is disabled. If caching is enabled and the cache is not ready,
12275 * this method will create it. Calling {@link #draw(android.graphics.Canvas)} will not
12276 * draw from the cache when the cache is enabled. To benefit from the cache, you must
12277 * request the drawing cache by calling this method and draw it on screen if the
12278 * returned bitmap is not null.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012279 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012280 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
12281 * this method will create a bitmap of the same size as this view. Because this bitmap
12282 * will be drawn scaled by the parent ViewGroup, the result on screen might show
12283 * scaling artifacts. To avoid such artifacts, you should call this method by setting
12284 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
12285 * size than the view. This implies that your application must be able to handle this
12286 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012287 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012288 * @param autoScale Indicates whether the generated bitmap should be scaled based on
12289 * the current density of the screen when the application is in compatibility
12290 * mode.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012291 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012292 * @return A bitmap representing this view or null if cache is disabled.
Joe Malin32736f02011-01-19 16:14:20 -080012293 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012294 * @see #setDrawingCacheEnabled(boolean)
12295 * @see #isDrawingCacheEnabled()
Romain Guyfbd8f692009-06-26 14:51:58 -070012296 * @see #buildDrawingCache(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012297 * @see #destroyDrawingCache()
12298 */
Romain Guyfbd8f692009-06-26 14:51:58 -070012299 public Bitmap getDrawingCache(boolean autoScale) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012300 if ((mViewFlags & WILL_NOT_CACHE_DRAWING) == WILL_NOT_CACHE_DRAWING) {
12301 return null;
12302 }
12303 if ((mViewFlags & DRAWING_CACHE_ENABLED) == DRAWING_CACHE_ENABLED) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012304 buildDrawingCache(autoScale);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012305 }
Romain Guy02890fd2010-08-06 17:58:44 -070012306 return autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012307 }
12308
12309 /**
12310 * <p>Frees the resources used by the drawing cache. If you call
12311 * {@link #buildDrawingCache()} manually without calling
12312 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
12313 * should cleanup the cache with this method afterwards.</p>
12314 *
12315 * @see #setDrawingCacheEnabled(boolean)
12316 * @see #buildDrawingCache()
12317 * @see #getDrawingCache()
12318 */
12319 public void destroyDrawingCache() {
12320 if (mDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070012321 mDrawingCache.recycle();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012322 mDrawingCache = null;
12323 }
Romain Guyfbd8f692009-06-26 14:51:58 -070012324 if (mUnscaledDrawingCache != null) {
Romain Guy02890fd2010-08-06 17:58:44 -070012325 mUnscaledDrawingCache.recycle();
Romain Guyfbd8f692009-06-26 14:51:58 -070012326 mUnscaledDrawingCache = null;
12327 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012328 }
12329
12330 /**
12331 * Setting a solid background color for the drawing cache's bitmaps will improve
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070012332 * performance and memory usage. Note, though that this should only be used if this
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012333 * view will always be drawn on top of a solid color.
12334 *
12335 * @param color The background color to use for the drawing cache's bitmap
12336 *
12337 * @see #setDrawingCacheEnabled(boolean)
12338 * @see #buildDrawingCache()
12339 * @see #getDrawingCache()
12340 */
12341 public void setDrawingCacheBackgroundColor(int color) {
Romain Guy52e2ef82010-01-14 12:11:48 -080012342 if (color != mDrawingCacheBackgroundColor) {
12343 mDrawingCacheBackgroundColor = color;
12344 mPrivateFlags &= ~DRAWING_CACHE_VALID;
12345 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012346 }
12347
12348 /**
12349 * @see #setDrawingCacheBackgroundColor(int)
12350 *
12351 * @return The background color to used for the drawing cache's bitmap
12352 */
12353 public int getDrawingCacheBackgroundColor() {
12354 return mDrawingCacheBackgroundColor;
12355 }
12356
12357 /**
Romain Guyfbd8f692009-06-26 14:51:58 -070012358 * <p>Calling this method is equivalent to calling <code>buildDrawingCache(false)</code>.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012359 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012360 * @see #buildDrawingCache(boolean)
12361 */
12362 public void buildDrawingCache() {
12363 buildDrawingCache(false);
12364 }
Gilles Debunne2ed2eac2011-02-24 16:29:48 -080012365
Romain Guyfbd8f692009-06-26 14:51:58 -070012366 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012367 * <p>Forces the drawing cache to be built if the drawing cache is invalid.</p>
12368 *
12369 * <p>If you call {@link #buildDrawingCache()} manually without calling
12370 * {@link #setDrawingCacheEnabled(boolean) setDrawingCacheEnabled(true)}, you
12371 * should cleanup the cache by calling {@link #destroyDrawingCache()} afterwards.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012372 *
Romain Guyfbd8f692009-06-26 14:51:58 -070012373 * <p>Note about auto scaling in compatibility mode: When auto scaling is not enabled,
12374 * this method will create a bitmap of the same size as this view. Because this bitmap
12375 * will be drawn scaled by the parent ViewGroup, the result on screen might show
12376 * scaling artifacts. To avoid such artifacts, you should call this method by setting
12377 * the auto scaling to true. Doing so, however, will generate a bitmap of a different
12378 * size than the view. This implies that your application must be able to handle this
12379 * size.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012380 *
Romain Guy0d9275e2010-10-26 14:22:30 -070012381 * <p>You should avoid calling this method when hardware acceleration is enabled. If
12382 * you do not need the drawing cache bitmap, calling this method will increase memory
Joe Malin32736f02011-01-19 16:14:20 -080012383 * usage and cause the view to be rendered in software once, thus negatively impacting
Romain Guy0d9275e2010-10-26 14:22:30 -070012384 * performance.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012385 *
12386 * @see #getDrawingCache()
12387 * @see #destroyDrawingCache()
12388 */
Romain Guyfbd8f692009-06-26 14:51:58 -070012389 public void buildDrawingCache(boolean autoScale) {
12390 if ((mPrivateFlags & DRAWING_CACHE_VALID) == 0 || (autoScale ?
Romain Guy02890fd2010-08-06 17:58:44 -070012391 mDrawingCache == null : mUnscaledDrawingCache == null)) {
Romain Guy0211a0a2011-02-14 16:34:59 -080012392 mCachingFailed = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012393
12394 if (ViewDebug.TRACE_HIERARCHY) {
12395 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.BUILD_CACHE);
12396 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012397
Romain Guy8506ab42009-06-11 17:35:47 -070012398 int width = mRight - mLeft;
12399 int height = mBottom - mTop;
12400
12401 final AttachInfo attachInfo = mAttachInfo;
Romain Guye1123222009-06-29 14:24:56 -070012402 final boolean scalingRequired = attachInfo != null && attachInfo.mScalingRequired;
Romain Guyfbd8f692009-06-26 14:51:58 -070012403
Romain Guye1123222009-06-29 14:24:56 -070012404 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012405 width = (int) ((width * attachInfo.mApplicationScale) + 0.5f);
12406 height = (int) ((height * attachInfo.mApplicationScale) + 0.5f);
Romain Guy8506ab42009-06-11 17:35:47 -070012407 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012408
12409 final int drawingCacheBackgroundColor = mDrawingCacheBackgroundColor;
Romain Guy35b38ce2009-10-07 13:38:55 -070012410 final boolean opaque = drawingCacheBackgroundColor != 0 || isOpaque();
Adam Powell26153a32010-11-08 15:22:27 -080012411 final boolean use32BitCache = attachInfo != null && attachInfo.mUse32BitDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012412
12413 if (width <= 0 || height <= 0 ||
Romain Guy35b38ce2009-10-07 13:38:55 -070012414 // Projected bitmap size in bytes
Adam Powell26153a32010-11-08 15:22:27 -080012415 (width * height * (opaque && !use32BitCache ? 2 : 4) >
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012416 ViewConfiguration.get(mContext).getScaledMaximumDrawingCacheSize())) {
12417 destroyDrawingCache();
Romain Guy0211a0a2011-02-14 16:34:59 -080012418 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012419 return;
12420 }
12421
12422 boolean clear = true;
Romain Guy02890fd2010-08-06 17:58:44 -070012423 Bitmap bitmap = autoScale ? mDrawingCache : mUnscaledDrawingCache;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012424
12425 if (bitmap == null || bitmap.getWidth() != width || bitmap.getHeight() != height) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012426 Bitmap.Config quality;
12427 if (!opaque) {
Romain Guy676b1732011-02-14 14:45:33 -080012428 // Never pick ARGB_4444 because it looks awful
12429 // Keep the DRAWING_CACHE_QUALITY_LOW flag just in case
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012430 switch (mViewFlags & DRAWING_CACHE_QUALITY_MASK) {
12431 case DRAWING_CACHE_QUALITY_AUTO:
12432 quality = Bitmap.Config.ARGB_8888;
12433 break;
12434 case DRAWING_CACHE_QUALITY_LOW:
Romain Guy676b1732011-02-14 14:45:33 -080012435 quality = Bitmap.Config.ARGB_8888;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012436 break;
12437 case DRAWING_CACHE_QUALITY_HIGH:
12438 quality = Bitmap.Config.ARGB_8888;
12439 break;
12440 default:
12441 quality = Bitmap.Config.ARGB_8888;
12442 break;
12443 }
12444 } else {
Romain Guy35b38ce2009-10-07 13:38:55 -070012445 // Optimization for translucent windows
12446 // If the window is translucent, use a 32 bits bitmap to benefit from memcpy()
Adam Powell26153a32010-11-08 15:22:27 -080012447 quality = use32BitCache ? Bitmap.Config.ARGB_8888 : Bitmap.Config.RGB_565;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012448 }
12449
12450 // Try to cleanup memory
12451 if (bitmap != null) bitmap.recycle();
12452
12453 try {
12454 bitmap = Bitmap.createBitmap(width, height, quality);
Dianne Hackborn11ea3342009-07-22 21:48:55 -070012455 bitmap.setDensity(getResources().getDisplayMetrics().densityDpi);
Romain Guyfbd8f692009-06-26 14:51:58 -070012456 if (autoScale) {
Romain Guy02890fd2010-08-06 17:58:44 -070012457 mDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070012458 } else {
Romain Guy02890fd2010-08-06 17:58:44 -070012459 mUnscaledDrawingCache = bitmap;
Romain Guyfbd8f692009-06-26 14:51:58 -070012460 }
Adam Powell26153a32010-11-08 15:22:27 -080012461 if (opaque && use32BitCache) bitmap.setHasAlpha(false);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012462 } catch (OutOfMemoryError e) {
12463 // If there is not enough memory to create the bitmap cache, just
12464 // ignore the issue as bitmap caches are not required to draw the
12465 // view hierarchy
Romain Guyfbd8f692009-06-26 14:51:58 -070012466 if (autoScale) {
12467 mDrawingCache = null;
12468 } else {
12469 mUnscaledDrawingCache = null;
12470 }
Romain Guy0211a0a2011-02-14 16:34:59 -080012471 mCachingFailed = true;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012472 return;
12473 }
12474
12475 clear = drawingCacheBackgroundColor != 0;
12476 }
12477
12478 Canvas canvas;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012479 if (attachInfo != null) {
12480 canvas = attachInfo.mCanvas;
12481 if (canvas == null) {
12482 canvas = new Canvas();
12483 }
12484 canvas.setBitmap(bitmap);
12485 // Temporarily clobber the cached Canvas in case one of our children
12486 // is also using a drawing cache. Without this, the children would
12487 // steal the canvas by attaching their own bitmap to it and bad, bad
12488 // thing would happen (invisible views, corrupted drawings, etc.)
12489 attachInfo.mCanvas = null;
12490 } else {
12491 // This case should hopefully never or seldom happen
12492 canvas = new Canvas(bitmap);
12493 }
12494
12495 if (clear) {
12496 bitmap.eraseColor(drawingCacheBackgroundColor);
12497 }
12498
12499 computeScroll();
12500 final int restoreCount = canvas.save();
Joe Malin32736f02011-01-19 16:14:20 -080012501
Romain Guye1123222009-06-29 14:24:56 -070012502 if (autoScale && scalingRequired) {
Romain Guyfbd8f692009-06-26 14:51:58 -070012503 final float scale = attachInfo.mApplicationScale;
12504 canvas.scale(scale, scale);
12505 }
Joe Malin32736f02011-01-19 16:14:20 -080012506
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012507 canvas.translate(-mScrollX, -mScrollY);
12508
Romain Guy5bcdff42009-05-14 21:27:18 -070012509 mPrivateFlags |= DRAWN;
Romain Guy171c5922011-01-06 10:04:23 -080012510 if (mAttachInfo == null || !mAttachInfo.mHardwareAccelerated ||
12511 mLayerType != LAYER_TYPE_NONE) {
Romain Guy0d9275e2010-10-26 14:22:30 -070012512 mPrivateFlags |= DRAWING_CACHE_VALID;
12513 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012514
12515 // Fast path for layouts with no backgrounds
12516 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12517 if (ViewDebug.TRACE_HIERARCHY) {
12518 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
12519 }
Romain Guy5bcdff42009-05-14 21:27:18 -070012520 mPrivateFlags &= ~DIRTY_MASK;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012521 dispatchDraw(canvas);
12522 } else {
12523 draw(canvas);
12524 }
12525
12526 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070012527 canvas.setBitmap(null);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012528
12529 if (attachInfo != null) {
12530 // Restore the cached Canvas for our siblings
12531 attachInfo.mCanvas = canvas;
12532 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012533 }
12534 }
12535
12536 /**
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012537 * Create a snapshot of the view into a bitmap. We should probably make
12538 * some form of this public, but should think about the API.
12539 */
Romain Guy223ff5c2010-03-02 17:07:47 -080012540 Bitmap createSnapshot(Bitmap.Config quality, int backgroundColor, boolean skipChildren) {
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012541 int width = mRight - mLeft;
12542 int height = mBottom - mTop;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012543
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012544 final AttachInfo attachInfo = mAttachInfo;
Romain Guy8c11e312009-09-14 15:15:30 -070012545 final float scale = attachInfo != null ? attachInfo.mApplicationScale : 1.0f;
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012546 width = (int) ((width * scale) + 0.5f);
12547 height = (int) ((height * scale) + 0.5f);
Joe Malin32736f02011-01-19 16:14:20 -080012548
Romain Guy8c11e312009-09-14 15:15:30 -070012549 Bitmap bitmap = Bitmap.createBitmap(width > 0 ? width : 1, height > 0 ? height : 1, quality);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012550 if (bitmap == null) {
12551 throw new OutOfMemoryError();
12552 }
12553
Romain Guyc529d8d2011-09-06 15:01:39 -070012554 Resources resources = getResources();
12555 if (resources != null) {
12556 bitmap.setDensity(resources.getDisplayMetrics().densityDpi);
12557 }
Joe Malin32736f02011-01-19 16:14:20 -080012558
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012559 Canvas canvas;
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012560 if (attachInfo != null) {
12561 canvas = attachInfo.mCanvas;
12562 if (canvas == null) {
12563 canvas = new Canvas();
12564 }
12565 canvas.setBitmap(bitmap);
12566 // Temporarily clobber the cached Canvas in case one of our children
12567 // is also using a drawing cache. Without this, the children would
12568 // steal the canvas by attaching their own bitmap to it and bad, bad
12569 // things would happen (invisible views, corrupted drawings, etc.)
12570 attachInfo.mCanvas = null;
12571 } else {
12572 // This case should hopefully never or seldom happen
12573 canvas = new Canvas(bitmap);
12574 }
12575
Romain Guy5bcdff42009-05-14 21:27:18 -070012576 if ((backgroundColor & 0xff000000) != 0) {
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012577 bitmap.eraseColor(backgroundColor);
12578 }
12579
12580 computeScroll();
12581 final int restoreCount = canvas.save();
Dianne Hackborn8cae1242009-09-10 14:32:16 -070012582 canvas.scale(scale, scale);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012583 canvas.translate(-mScrollX, -mScrollY);
12584
Romain Guy5bcdff42009-05-14 21:27:18 -070012585 // Temporarily remove the dirty mask
12586 int flags = mPrivateFlags;
12587 mPrivateFlags &= ~DIRTY_MASK;
12588
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012589 // Fast path for layouts with no backgrounds
12590 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
12591 dispatchDraw(canvas);
12592 } else {
12593 draw(canvas);
12594 }
12595
Romain Guy5bcdff42009-05-14 21:27:18 -070012596 mPrivateFlags = flags;
12597
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012598 canvas.restoreToCount(restoreCount);
Dianne Hackborn6311d0a2011-08-02 16:37:58 -070012599 canvas.setBitmap(null);
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012600
12601 if (attachInfo != null) {
12602 // Restore the cached Canvas for our siblings
12603 attachInfo.mCanvas = canvas;
12604 }
Romain Guy8506ab42009-06-11 17:35:47 -070012605
Dianne Hackborn958b9ad2009-03-31 18:00:36 -070012606 return bitmap;
12607 }
12608
12609 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080012610 * Indicates whether this View is currently in edit mode. A View is usually
12611 * in edit mode when displayed within a developer tool. For instance, if
12612 * this View is being drawn by a visual user interface builder, this method
12613 * should return true.
12614 *
12615 * Subclasses should check the return value of this method to provide
12616 * different behaviors if their normal behavior might interfere with the
12617 * host environment. For instance: the class spawns a thread in its
12618 * constructor, the drawing code relies on device-specific features, etc.
12619 *
12620 * This method is usually checked in the drawing code of custom widgets.
12621 *
12622 * @return True if this View is in edit mode, false otherwise.
12623 */
12624 public boolean isInEditMode() {
12625 return false;
12626 }
12627
12628 /**
12629 * If the View draws content inside its padding and enables fading edges,
12630 * it needs to support padding offsets. Padding offsets are added to the
12631 * fading edges to extend the length of the fade so that it covers pixels
12632 * drawn inside the padding.
12633 *
12634 * Subclasses of this class should override this method if they need
12635 * to draw content inside the padding.
12636 *
12637 * @return True if padding offset must be applied, false otherwise.
12638 *
12639 * @see #getLeftPaddingOffset()
12640 * @see #getRightPaddingOffset()
12641 * @see #getTopPaddingOffset()
12642 * @see #getBottomPaddingOffset()
12643 *
12644 * @since CURRENT
12645 */
12646 protected boolean isPaddingOffsetRequired() {
12647 return false;
12648 }
12649
12650 /**
12651 * Amount by which to extend the left fading region. Called only when
12652 * {@link #isPaddingOffsetRequired()} returns true.
12653 *
12654 * @return The left padding offset in pixels.
12655 *
12656 * @see #isPaddingOffsetRequired()
12657 *
12658 * @since CURRENT
12659 */
12660 protected int getLeftPaddingOffset() {
12661 return 0;
12662 }
12663
12664 /**
12665 * Amount by which to extend the right fading region. Called only when
12666 * {@link #isPaddingOffsetRequired()} returns true.
12667 *
12668 * @return The right padding offset in pixels.
12669 *
12670 * @see #isPaddingOffsetRequired()
12671 *
12672 * @since CURRENT
12673 */
12674 protected int getRightPaddingOffset() {
12675 return 0;
12676 }
12677
12678 /**
12679 * Amount by which to extend the top fading region. Called only when
12680 * {@link #isPaddingOffsetRequired()} returns true.
12681 *
12682 * @return The top padding offset in pixels.
12683 *
12684 * @see #isPaddingOffsetRequired()
12685 *
12686 * @since CURRENT
12687 */
12688 protected int getTopPaddingOffset() {
12689 return 0;
12690 }
12691
12692 /**
12693 * Amount by which to extend the bottom fading region. Called only when
12694 * {@link #isPaddingOffsetRequired()} returns true.
12695 *
12696 * @return The bottom padding offset in pixels.
12697 *
12698 * @see #isPaddingOffsetRequired()
12699 *
12700 * @since CURRENT
12701 */
12702 protected int getBottomPaddingOffset() {
12703 return 0;
12704 }
12705
12706 /**
Romain Guyf2fc4602011-07-19 15:20:03 -070012707 * @hide
12708 * @param offsetRequired
12709 */
12710 protected int getFadeTop(boolean offsetRequired) {
12711 int top = mPaddingTop;
12712 if (offsetRequired) top += getTopPaddingOffset();
12713 return top;
12714 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012715
Romain Guyf2fc4602011-07-19 15:20:03 -070012716 /**
12717 * @hide
12718 * @param offsetRequired
12719 */
12720 protected int getFadeHeight(boolean offsetRequired) {
12721 int padding = mPaddingTop;
Philip Milne6c8ea062012-04-03 17:38:43 -070012722 if (offsetRequired) padding += getTopPaddingOffset();
Romain Guyf2fc4602011-07-19 15:20:03 -070012723 return mBottom - mTop - mPaddingBottom - padding;
12724 }
Philip Milne6c8ea062012-04-03 17:38:43 -070012725
Romain Guyf2fc4602011-07-19 15:20:03 -070012726 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +090012727 * <p>Indicates whether this view is attached to a hardware accelerated
Romain Guy2bffd262010-09-12 17:40:02 -070012728 * window or not.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012729 *
Romain Guy2bffd262010-09-12 17:40:02 -070012730 * <p>Even if this method returns true, it does not mean that every call
12731 * to {@link #draw(android.graphics.Canvas)} will be made with an hardware
12732 * accelerated {@link android.graphics.Canvas}. For instance, if this view
Ken Wakasaf76a50c2012-03-09 19:56:35 +090012733 * is drawn onto an offscreen {@link android.graphics.Bitmap} and its
Romain Guy2bffd262010-09-12 17:40:02 -070012734 * window is hardware accelerated,
12735 * {@link android.graphics.Canvas#isHardwareAccelerated()} will likely
12736 * return false, and this method will return true.</p>
Joe Malin32736f02011-01-19 16:14:20 -080012737 *
Romain Guy2bffd262010-09-12 17:40:02 -070012738 * @return True if the view is attached to a window and the window is
12739 * hardware accelerated; false in any other case.
12740 */
12741 public boolean isHardwareAccelerated() {
12742 return mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
12743 }
Joe Malin32736f02011-01-19 16:14:20 -080012744
Romain Guy2bffd262010-09-12 17:40:02 -070012745 /**
Chet Haasebcca79a2012-02-14 08:45:14 -080012746 * Utility function, called by draw(canvas, parent, drawingTime) to handle the less common
12747 * case of an active Animation being run on the view.
12748 */
12749 private boolean drawAnimation(ViewGroup parent, long drawingTime,
12750 Animation a, boolean scalingRequired) {
12751 Transformation invalidationTransform;
12752 final int flags = parent.mGroupFlags;
12753 final boolean initialized = a.isInitialized();
12754 if (!initialized) {
Chet Haase1fb8a9e2012-04-19 09:22:34 -070012755 a.initialize(mRight - mLeft, mBottom - mTop, parent.getWidth(), parent.getHeight());
Chet Haasebcca79a2012-02-14 08:45:14 -080012756 a.initializeInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop);
12757 onAnimationStart();
12758 }
12759
12760 boolean more = a.getTransformation(drawingTime, parent.mChildTransformation, 1f);
12761 if (scalingRequired && mAttachInfo.mApplicationScale != 1f) {
12762 if (parent.mInvalidationTransformation == null) {
12763 parent.mInvalidationTransformation = new Transformation();
12764 }
12765 invalidationTransform = parent.mInvalidationTransformation;
12766 a.getTransformation(drawingTime, invalidationTransform, 1f);
12767 } else {
12768 invalidationTransform = parent.mChildTransformation;
12769 }
12770 if (more) {
12771 if (!a.willChangeBounds()) {
12772 if ((flags & (parent.FLAG_OPTIMIZE_INVALIDATE | parent.FLAG_ANIMATION_DONE)) ==
12773 parent.FLAG_OPTIMIZE_INVALIDATE) {
12774 parent.mGroupFlags |= parent.FLAG_INVALIDATE_REQUIRED;
12775 } else if ((flags & parent.FLAG_INVALIDATE_REQUIRED) == 0) {
12776 // The child need to draw an animation, potentially offscreen, so
12777 // make sure we do not cancel invalidate requests
12778 parent.mPrivateFlags |= DRAW_ANIMATION;
12779 parent.invalidate(mLeft, mTop, mRight, mBottom);
12780 }
12781 } else {
12782 if (parent.mInvalidateRegion == null) {
12783 parent.mInvalidateRegion = new RectF();
12784 }
12785 final RectF region = parent.mInvalidateRegion;
12786 a.getInvalidateRegion(0, 0, mRight - mLeft, mBottom - mTop, region,
12787 invalidationTransform);
12788
12789 // The child need to draw an animation, potentially offscreen, so
12790 // make sure we do not cancel invalidate requests
12791 parent.mPrivateFlags |= DRAW_ANIMATION;
12792
12793 final int left = mLeft + (int) region.left;
12794 final int top = mTop + (int) region.top;
12795 parent.invalidate(left, top, left + (int) (region.width() + .5f),
12796 top + (int) (region.height() + .5f));
12797 }
12798 }
12799 return more;
12800 }
12801
Chet Haasea1cff502012-02-21 13:43:44 -080012802 /**
12803 * This method is called by getDisplayList() when a display list is created or re-rendered.
12804 * It sets or resets the current value of all properties on that display list (resetting is
12805 * necessary when a display list is being re-created, because we need to make sure that
12806 * previously-set transform values
12807 */
12808 void setDisplayListProperties(DisplayList displayList) {
Chet Haase1271e2c2012-04-20 09:54:27 -070012809 if (displayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080012810 displayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom);
Chet Haasedb8c9a62012-03-21 18:54:18 -070012811 displayList.setHasOverlappingRendering(hasOverlappingRendering());
Chet Haasea1cff502012-02-21 13:43:44 -080012812 if (mParent instanceof ViewGroup) {
12813 displayList.setClipChildren(
12814 (((ViewGroup)mParent).mGroupFlags & ViewGroup.FLAG_CLIP_CHILDREN) != 0);
12815 }
Chet Haase9420abd2012-03-29 16:28:32 -070012816 float alpha = 1;
12817 if (mParent instanceof ViewGroup && (((ViewGroup) mParent).mGroupFlags &
12818 ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
12819 ViewGroup parentVG = (ViewGroup) mParent;
12820 final boolean hasTransform =
12821 parentVG.getChildStaticTransformation(this, parentVG.mChildTransformation);
12822 if (hasTransform) {
12823 Transformation transform = parentVG.mChildTransformation;
12824 final int transformType = parentVG.mChildTransformation.getTransformationType();
12825 if (transformType != Transformation.TYPE_IDENTITY) {
12826 if ((transformType & Transformation.TYPE_ALPHA) != 0) {
12827 alpha = transform.getAlpha();
12828 }
12829 if ((transformType & Transformation.TYPE_MATRIX) != 0) {
12830 displayList.setStaticMatrix(transform.getMatrix());
12831 }
12832 }
12833 }
Chet Haasea1cff502012-02-21 13:43:44 -080012834 }
12835 if (mTransformationInfo != null) {
Chet Haase9420abd2012-03-29 16:28:32 -070012836 alpha *= mTransformationInfo.mAlpha;
12837 if (alpha < 1) {
12838 final int multipliedAlpha = (int) (255 * alpha);
12839 if (onSetAlpha(multipliedAlpha)) {
12840 alpha = 1;
12841 }
12842 }
12843 displayList.setTransformationInfo(alpha,
Chet Haasea1cff502012-02-21 13:43:44 -080012844 mTransformationInfo.mTranslationX, mTransformationInfo.mTranslationY,
12845 mTransformationInfo.mRotation, mTransformationInfo.mRotationX,
12846 mTransformationInfo.mRotationY, mTransformationInfo.mScaleX,
12847 mTransformationInfo.mScaleY);
Chet Haaseb85967b2012-03-26 14:37:51 -070012848 if (mTransformationInfo.mCamera == null) {
12849 mTransformationInfo.mCamera = new Camera();
12850 mTransformationInfo.matrix3D = new Matrix();
12851 }
12852 displayList.setCameraDistance(mTransformationInfo.mCamera.getLocationZ());
Chet Haasea1cff502012-02-21 13:43:44 -080012853 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == PIVOT_EXPLICITLY_SET) {
12854 displayList.setPivotX(getPivotX());
12855 displayList.setPivotY(getPivotY());
12856 }
Chet Haase9420abd2012-03-29 16:28:32 -070012857 } else if (alpha < 1) {
12858 displayList.setAlpha(alpha);
Chet Haasea1cff502012-02-21 13:43:44 -080012859 }
12860 }
12861 }
12862
Chet Haasebcca79a2012-02-14 08:45:14 -080012863 /**
Chet Haase64a48c12012-02-13 16:33:29 -080012864 * This method is called by ViewGroup.drawChild() to have each child view draw itself.
12865 * This draw() method is an implementation detail and is not intended to be overridden or
12866 * to be called from anywhere else other than ViewGroup.drawChild().
12867 */
12868 boolean draw(Canvas canvas, ViewGroup parent, long drawingTime) {
Chet Haase1271e2c2012-04-20 09:54:27 -070012869 boolean useDisplayListProperties = mAttachInfo != null && mAttachInfo.mHardwareAccelerated;
Chet Haase64a48c12012-02-13 16:33:29 -080012870 boolean more = false;
Chet Haase64a48c12012-02-13 16:33:29 -080012871 final boolean childHasIdentityMatrix = hasIdentityMatrix();
Chet Haase64a48c12012-02-13 16:33:29 -080012872 final int flags = parent.mGroupFlags;
12873
Chet Haasea1cff502012-02-21 13:43:44 -080012874 if ((flags & ViewGroup.FLAG_CLEAR_TRANSFORMATION) == ViewGroup.FLAG_CLEAR_TRANSFORMATION) {
Chet Haase64a48c12012-02-13 16:33:29 -080012875 parent.mChildTransformation.clear();
Chet Haasea1cff502012-02-21 13:43:44 -080012876 parent.mGroupFlags &= ~ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080012877 }
12878
12879 Transformation transformToApply = null;
Chet Haase64a48c12012-02-13 16:33:29 -080012880 boolean concatMatrix = false;
12881
12882 boolean scalingRequired = false;
12883 boolean caching;
12884 int layerType = parent.mDrawLayers ? getLayerType() : LAYER_TYPE_NONE;
12885
12886 final boolean hardwareAccelerated = canvas.isHardwareAccelerated();
Chet Haasea1cff502012-02-21 13:43:44 -080012887 if ((flags & ViewGroup.FLAG_CHILDREN_DRAWN_WITH_CACHE) != 0 ||
12888 (flags & ViewGroup.FLAG_ALWAYS_DRAWN_WITH_CACHE) != 0) {
Chet Haase64a48c12012-02-13 16:33:29 -080012889 caching = true;
Chet Haase9420abd2012-03-29 16:28:32 -070012890 // Auto-scaled apps are not hw-accelerated, no need to set scaling flag on DisplayList
Chet Haase64a48c12012-02-13 16:33:29 -080012891 if (mAttachInfo != null) scalingRequired = mAttachInfo.mScalingRequired;
12892 } else {
12893 caching = (layerType != LAYER_TYPE_NONE) || hardwareAccelerated;
12894 }
12895
Chet Haasebcca79a2012-02-14 08:45:14 -080012896 final Animation a = getAnimation();
Chet Haase64a48c12012-02-13 16:33:29 -080012897 if (a != null) {
Chet Haasebcca79a2012-02-14 08:45:14 -080012898 more = drawAnimation(parent, drawingTime, a, scalingRequired);
Chet Haase64a48c12012-02-13 16:33:29 -080012899 concatMatrix = a.willChangeTransformationMatrix();
Chet Haaseafd5c3e2012-05-10 13:21:10 -070012900 if (concatMatrix) {
12901 mPrivateFlags2 |= VIEW_IS_ANIMATING_TRANSFORM;
12902 }
Chet Haasebcca79a2012-02-14 08:45:14 -080012903 transformToApply = parent.mChildTransformation;
Chet Haaseafd5c3e2012-05-10 13:21:10 -070012904 } else {
12905 if ((mPrivateFlags2 & VIEW_IS_ANIMATING_TRANSFORM) == VIEW_IS_ANIMATING_TRANSFORM &&
12906 mDisplayList != null) {
12907 // No longer animating: clear out old animation matrix
12908 mDisplayList.setAnimationMatrix(null);
12909 mPrivateFlags2 &= ~VIEW_IS_ANIMATING_TRANSFORM;
12910 }
12911 if (!useDisplayListProperties &&
12912 (flags & ViewGroup.FLAG_SUPPORT_STATIC_TRANSFORMATIONS) != 0) {
12913 final boolean hasTransform =
12914 parent.getChildStaticTransformation(this, parent.mChildTransformation);
12915 if (hasTransform) {
12916 final int transformType = parent.mChildTransformation.getTransformationType();
12917 transformToApply = transformType != Transformation.TYPE_IDENTITY ?
12918 parent.mChildTransformation : null;
12919 concatMatrix = (transformType & Transformation.TYPE_MATRIX) != 0;
12920 }
Chet Haase64a48c12012-02-13 16:33:29 -080012921 }
12922 }
12923
12924 concatMatrix |= !childHasIdentityMatrix;
12925
12926 // Sets the flag as early as possible to allow draw() implementations
12927 // to call invalidate() successfully when doing animations
12928 mPrivateFlags |= DRAWN;
12929
Chet Haasebcca79a2012-02-14 08:45:14 -080012930 if (!concatMatrix && canvas.quickReject(mLeft, mTop, mRight, mBottom, Canvas.EdgeType.BW) &&
Chet Haase64a48c12012-02-13 16:33:29 -080012931 (mPrivateFlags & DRAW_ANIMATION) == 0) {
Chet Haase1a3ab172012-05-11 08:41:20 -070012932 mPrivateFlags2 |= VIEW_QUICK_REJECTED;
Chet Haase64a48c12012-02-13 16:33:29 -080012933 return more;
12934 }
Chet Haase1a3ab172012-05-11 08:41:20 -070012935 mPrivateFlags2 &= ~VIEW_QUICK_REJECTED;
Chet Haase64a48c12012-02-13 16:33:29 -080012936
12937 if (hardwareAccelerated) {
12938 // Clear INVALIDATED flag to allow invalidation to occur during rendering, but
12939 // retain the flag's value temporarily in the mRecreateDisplayList flag
12940 mRecreateDisplayList = (mPrivateFlags & INVALIDATED) == INVALIDATED;
12941 mPrivateFlags &= ~INVALIDATED;
12942 }
12943
12944 computeScroll();
12945
12946 final int sx = mScrollX;
12947 final int sy = mScrollY;
12948
12949 DisplayList displayList = null;
12950 Bitmap cache = null;
12951 boolean hasDisplayList = false;
12952 if (caching) {
12953 if (!hardwareAccelerated) {
12954 if (layerType != LAYER_TYPE_NONE) {
12955 layerType = LAYER_TYPE_SOFTWARE;
12956 buildDrawingCache(true);
12957 }
12958 cache = getDrawingCache(true);
12959 } else {
12960 switch (layerType) {
12961 case LAYER_TYPE_SOFTWARE:
Chet Haaseb85967b2012-03-26 14:37:51 -070012962 if (useDisplayListProperties) {
12963 hasDisplayList = canHaveDisplayList();
12964 } else {
12965 buildDrawingCache(true);
12966 cache = getDrawingCache(true);
12967 }
Chet Haase64a48c12012-02-13 16:33:29 -080012968 break;
Chet Haasea1cff502012-02-21 13:43:44 -080012969 case LAYER_TYPE_HARDWARE:
12970 if (useDisplayListProperties) {
12971 hasDisplayList = canHaveDisplayList();
12972 }
12973 break;
Chet Haase64a48c12012-02-13 16:33:29 -080012974 case LAYER_TYPE_NONE:
12975 // Delay getting the display list until animation-driven alpha values are
12976 // set up and possibly passed on to the view
12977 hasDisplayList = canHaveDisplayList();
12978 break;
12979 }
12980 }
12981 }
Chet Haasea1cff502012-02-21 13:43:44 -080012982 useDisplayListProperties &= hasDisplayList;
Chet Haase9420abd2012-03-29 16:28:32 -070012983 if (useDisplayListProperties) {
12984 displayList = getDisplayList();
12985 if (!displayList.isValid()) {
12986 // Uncommon, but possible. If a view is removed from the hierarchy during the call
12987 // to getDisplayList(), the display list will be marked invalid and we should not
12988 // try to use it again.
12989 displayList = null;
12990 hasDisplayList = false;
12991 useDisplayListProperties = false;
12992 }
12993 }
Chet Haase64a48c12012-02-13 16:33:29 -080012994
12995 final boolean hasNoCache = cache == null || hasDisplayList;
12996 final boolean offsetForScroll = cache == null && !hasDisplayList &&
12997 layerType != LAYER_TYPE_HARDWARE;
12998
Chet Haasea1cff502012-02-21 13:43:44 -080012999 int restoreTo = -1;
Chet Haase89b7f2e2012-03-21 11:15:37 -070013000 if (!useDisplayListProperties || transformToApply != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080013001 restoreTo = canvas.save();
13002 }
Chet Haase64a48c12012-02-13 16:33:29 -080013003 if (offsetForScroll) {
Chet Haasebcca79a2012-02-14 08:45:14 -080013004 canvas.translate(mLeft - sx, mTop - sy);
Chet Haase64a48c12012-02-13 16:33:29 -080013005 } else {
Chet Haasea1cff502012-02-21 13:43:44 -080013006 if (!useDisplayListProperties) {
13007 canvas.translate(mLeft, mTop);
13008 }
Chet Haase64a48c12012-02-13 16:33:29 -080013009 if (scalingRequired) {
Chet Haasea1cff502012-02-21 13:43:44 -080013010 if (useDisplayListProperties) {
Chet Haase9420abd2012-03-29 16:28:32 -070013011 // TODO: Might not need this if we put everything inside the DL
Chet Haasea1cff502012-02-21 13:43:44 -080013012 restoreTo = canvas.save();
13013 }
Chet Haase64a48c12012-02-13 16:33:29 -080013014 // mAttachInfo cannot be null, otherwise scalingRequired == false
13015 final float scale = 1.0f / mAttachInfo.mApplicationScale;
13016 canvas.scale(scale, scale);
13017 }
13018 }
13019
Chet Haasea1cff502012-02-21 13:43:44 -080013020 float alpha = useDisplayListProperties ? 1 : getAlpha();
Chet Haase9420abd2012-03-29 16:28:32 -070013021 if (transformToApply != null || alpha < 1 || !hasIdentityMatrix()) {
Chet Haase64a48c12012-02-13 16:33:29 -080013022 if (transformToApply != null || !childHasIdentityMatrix) {
13023 int transX = 0;
13024 int transY = 0;
13025
13026 if (offsetForScroll) {
13027 transX = -sx;
13028 transY = -sy;
13029 }
13030
13031 if (transformToApply != null) {
13032 if (concatMatrix) {
Chet Haase9420abd2012-03-29 16:28:32 -070013033 if (useDisplayListProperties) {
13034 displayList.setAnimationMatrix(transformToApply.getMatrix());
13035 } else {
13036 // Undo the scroll translation, apply the transformation matrix,
13037 // then redo the scroll translate to get the correct result.
13038 canvas.translate(-transX, -transY);
13039 canvas.concat(transformToApply.getMatrix());
13040 canvas.translate(transX, transY);
13041 }
Chet Haasea1cff502012-02-21 13:43:44 -080013042 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080013043 }
13044
13045 float transformAlpha = transformToApply.getAlpha();
Chet Haase9420abd2012-03-29 16:28:32 -070013046 if (transformAlpha < 1) {
Chet Haase64a48c12012-02-13 16:33:29 -080013047 alpha *= transformToApply.getAlpha();
Chet Haasea1cff502012-02-21 13:43:44 -080013048 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080013049 }
13050 }
13051
Chet Haasea1cff502012-02-21 13:43:44 -080013052 if (!childHasIdentityMatrix && !useDisplayListProperties) {
Chet Haase64a48c12012-02-13 16:33:29 -080013053 canvas.translate(-transX, -transY);
13054 canvas.concat(getMatrix());
13055 canvas.translate(transX, transY);
13056 }
13057 }
13058
Chet Haase9420abd2012-03-29 16:28:32 -070013059 if (alpha < 1) {
Chet Haasea1cff502012-02-21 13:43:44 -080013060 parent.mGroupFlags |= ViewGroup.FLAG_CLEAR_TRANSFORMATION;
Chet Haase64a48c12012-02-13 16:33:29 -080013061 if (hasNoCache) {
13062 final int multipliedAlpha = (int) (255 * alpha);
13063 if (!onSetAlpha(multipliedAlpha)) {
13064 int layerFlags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
Chet Haasea1cff502012-02-21 13:43:44 -080013065 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) != 0 ||
Chet Haase64a48c12012-02-13 16:33:29 -080013066 layerType != LAYER_TYPE_NONE) {
13067 layerFlags |= Canvas.CLIP_TO_LAYER_SAVE_FLAG;
13068 }
Chet Haase9420abd2012-03-29 16:28:32 -070013069 if (useDisplayListProperties) {
13070 displayList.setAlpha(alpha * getAlpha());
13071 } else if (layerType == LAYER_TYPE_NONE) {
Chet Haase89b7f2e2012-03-21 11:15:37 -070013072 final int scrollX = hasDisplayList ? 0 : sx;
13073 final int scrollY = hasDisplayList ? 0 : sy;
13074 canvas.saveLayerAlpha(scrollX, scrollY, scrollX + mRight - mLeft,
13075 scrollY + mBottom - mTop, multipliedAlpha, layerFlags);
Chet Haase64a48c12012-02-13 16:33:29 -080013076 }
13077 } else {
13078 // Alpha is handled by the child directly, clobber the layer's alpha
13079 mPrivateFlags |= ALPHA_SET;
13080 }
13081 }
13082 }
13083 } else if ((mPrivateFlags & ALPHA_SET) == ALPHA_SET) {
13084 onSetAlpha(255);
13085 mPrivateFlags &= ~ALPHA_SET;
13086 }
13087
Chet Haasea1cff502012-02-21 13:43:44 -080013088 if ((flags & ViewGroup.FLAG_CLIP_CHILDREN) == ViewGroup.FLAG_CLIP_CHILDREN &&
13089 !useDisplayListProperties) {
Chet Haase64a48c12012-02-13 16:33:29 -080013090 if (offsetForScroll) {
Chet Haasebcca79a2012-02-14 08:45:14 -080013091 canvas.clipRect(sx, sy, sx + (mRight - mLeft), sy + (mBottom - mTop));
Chet Haase64a48c12012-02-13 16:33:29 -080013092 } else {
13093 if (!scalingRequired || cache == null) {
Chet Haasebcca79a2012-02-14 08:45:14 -080013094 canvas.clipRect(0, 0, mRight - mLeft, mBottom - mTop);
Chet Haase64a48c12012-02-13 16:33:29 -080013095 } else {
13096 canvas.clipRect(0, 0, cache.getWidth(), cache.getHeight());
13097 }
13098 }
13099 }
13100
Chet Haase9420abd2012-03-29 16:28:32 -070013101 if (!useDisplayListProperties && hasDisplayList) {
Chet Haase64a48c12012-02-13 16:33:29 -080013102 displayList = getDisplayList();
13103 if (!displayList.isValid()) {
13104 // Uncommon, but possible. If a view is removed from the hierarchy during the call
13105 // to getDisplayList(), the display list will be marked invalid and we should not
13106 // try to use it again.
13107 displayList = null;
13108 hasDisplayList = false;
13109 }
13110 }
13111
13112 if (hasNoCache) {
13113 boolean layerRendered = false;
Chet Haasea1cff502012-02-21 13:43:44 -080013114 if (layerType == LAYER_TYPE_HARDWARE && !useDisplayListProperties) {
Michael Jurka7e52caf2012-03-06 15:57:06 -080013115 final HardwareLayer layer = getHardwareLayer();
Chet Haase64a48c12012-02-13 16:33:29 -080013116 if (layer != null && layer.isValid()) {
13117 mLayerPaint.setAlpha((int) (alpha * 255));
13118 ((HardwareCanvas) canvas).drawHardwareLayer(layer, 0, 0, mLayerPaint);
13119 layerRendered = true;
13120 } else {
13121 final int scrollX = hasDisplayList ? 0 : sx;
13122 final int scrollY = hasDisplayList ? 0 : sy;
13123 canvas.saveLayer(scrollX, scrollY,
Chet Haasebcca79a2012-02-14 08:45:14 -080013124 scrollX + mRight - mLeft, scrollY + mBottom - mTop, mLayerPaint,
Chet Haase64a48c12012-02-13 16:33:29 -080013125 Canvas.HAS_ALPHA_LAYER_SAVE_FLAG | Canvas.CLIP_TO_LAYER_SAVE_FLAG);
13126 }
13127 }
13128
13129 if (!layerRendered) {
13130 if (!hasDisplayList) {
13131 // Fast path for layouts with no backgrounds
13132 if ((mPrivateFlags & SKIP_DRAW) == SKIP_DRAW) {
13133 if (ViewDebug.TRACE_HIERARCHY) {
13134 ViewDebug.trace(parent, ViewDebug.HierarchyTraceType.DRAW);
13135 }
13136 mPrivateFlags &= ~DIRTY_MASK;
13137 dispatchDraw(canvas);
13138 } else {
13139 draw(canvas);
13140 }
13141 } else {
13142 mPrivateFlags &= ~DIRTY_MASK;
Chet Haase1271e2c2012-04-20 09:54:27 -070013143 ((HardwareCanvas) canvas).drawDisplayList(displayList, null, flags);
Chet Haase64a48c12012-02-13 16:33:29 -080013144 }
13145 }
13146 } else if (cache != null) {
13147 mPrivateFlags &= ~DIRTY_MASK;
13148 Paint cachePaint;
13149
13150 if (layerType == LAYER_TYPE_NONE) {
13151 cachePaint = parent.mCachePaint;
13152 if (cachePaint == null) {
13153 cachePaint = new Paint();
13154 cachePaint.setDither(false);
13155 parent.mCachePaint = cachePaint;
13156 }
Chet Haase9420abd2012-03-29 16:28:32 -070013157 if (alpha < 1) {
Chet Haase64a48c12012-02-13 16:33:29 -080013158 cachePaint.setAlpha((int) (alpha * 255));
Chet Haasea1cff502012-02-21 13:43:44 -080013159 parent.mGroupFlags |= ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE;
13160 } else if ((flags & ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE) != 0) {
Chet Haase64a48c12012-02-13 16:33:29 -080013161 cachePaint.setAlpha(255);
Chet Haasea1cff502012-02-21 13:43:44 -080013162 parent.mGroupFlags &= ~ViewGroup.FLAG_ALPHA_LOWER_THAN_ONE;
Chet Haase64a48c12012-02-13 16:33:29 -080013163 }
13164 } else {
13165 cachePaint = mLayerPaint;
13166 cachePaint.setAlpha((int) (alpha * 255));
13167 }
13168 canvas.drawBitmap(cache, 0.0f, 0.0f, cachePaint);
13169 }
13170
Chet Haasea1cff502012-02-21 13:43:44 -080013171 if (restoreTo >= 0) {
13172 canvas.restoreToCount(restoreTo);
13173 }
Chet Haase64a48c12012-02-13 16:33:29 -080013174
13175 if (a != null && !more) {
13176 if (!hardwareAccelerated && !a.getFillAfter()) {
13177 onSetAlpha(255);
13178 }
13179 parent.finishAnimatingView(this, a);
13180 }
13181
13182 if (more && hardwareAccelerated) {
13183 // invalidation is the trigger to recreate display lists, so if we're using
13184 // display lists to render, force an invalidate to allow the animation to
13185 // continue drawing another frame
13186 parent.invalidate(true);
13187 if (a.hasAlpha() && (mPrivateFlags & ALPHA_SET) == ALPHA_SET) {
13188 // alpha animations should cause the child to recreate its display list
13189 invalidate(true);
13190 }
13191 }
13192
13193 mRecreateDisplayList = false;
13194
13195 return more;
13196 }
13197
13198 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013199 * Manually render this view (and all of its children) to the given Canvas.
13200 * The view must have already done a full layout before this function is
Romain Guy5c22a8c2011-05-13 11:48:45 -070013201 * called. When implementing a view, implement
13202 * {@link #onDraw(android.graphics.Canvas)} instead of overriding this method.
13203 * If you do need to override this method, call the superclass version.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013204 *
13205 * @param canvas The Canvas to which the View is rendered.
13206 */
13207 public void draw(Canvas canvas) {
13208 if (ViewDebug.TRACE_HIERARCHY) {
13209 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.DRAW);
13210 }
13211
Romain Guy5bcdff42009-05-14 21:27:18 -070013212 final int privateFlags = mPrivateFlags;
13213 final boolean dirtyOpaque = (privateFlags & DIRTY_MASK) == DIRTY_OPAQUE &&
13214 (mAttachInfo == null || !mAttachInfo.mIgnoreDirtyState);
13215 mPrivateFlags = (privateFlags & ~DIRTY_MASK) | DRAWN;
Romain Guy24443ea2009-05-11 11:56:30 -070013216
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013217 /*
13218 * Draw traversal performs several drawing steps which must be executed
13219 * in the appropriate order:
13220 *
13221 * 1. Draw the background
13222 * 2. If necessary, save the canvas' layers to prepare for fading
13223 * 3. Draw view's content
13224 * 4. Draw children
13225 * 5. If necessary, draw the fading edges and restore layers
13226 * 6. Draw decorations (scrollbars for instance)
13227 */
13228
13229 // Step 1, draw the background, if needed
13230 int saveCount;
13231
Romain Guy24443ea2009-05-11 11:56:30 -070013232 if (!dirtyOpaque) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013233 final Drawable background = mBackground;
Romain Guy24443ea2009-05-11 11:56:30 -070013234 if (background != null) {
13235 final int scrollX = mScrollX;
13236 final int scrollY = mScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013237
Romain Guy24443ea2009-05-11 11:56:30 -070013238 if (mBackgroundSizeChanged) {
13239 background.setBounds(0, 0, mRight - mLeft, mBottom - mTop);
13240 mBackgroundSizeChanged = false;
13241 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013242
Romain Guy24443ea2009-05-11 11:56:30 -070013243 if ((scrollX | scrollY) == 0) {
13244 background.draw(canvas);
13245 } else {
13246 canvas.translate(scrollX, scrollY);
13247 background.draw(canvas);
13248 canvas.translate(-scrollX, -scrollY);
13249 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013250 }
13251 }
13252
13253 // skip step 2 & 5 if possible (common case)
13254 final int viewFlags = mViewFlags;
13255 boolean horizontalEdges = (viewFlags & FADING_EDGE_HORIZONTAL) != 0;
13256 boolean verticalEdges = (viewFlags & FADING_EDGE_VERTICAL) != 0;
13257 if (!verticalEdges && !horizontalEdges) {
13258 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070013259 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013260
13261 // Step 4, draw the children
13262 dispatchDraw(canvas);
13263
13264 // Step 6, draw decorations (scrollbars)
13265 onDrawScrollBars(canvas);
13266
13267 // we're done...
13268 return;
13269 }
13270
13271 /*
13272 * Here we do the full fledged routine...
13273 * (this is an uncommon case where speed matters less,
13274 * this is why we repeat some of the tests that have been
13275 * done above)
13276 */
13277
13278 boolean drawTop = false;
13279 boolean drawBottom = false;
13280 boolean drawLeft = false;
13281 boolean drawRight = false;
13282
13283 float topFadeStrength = 0.0f;
13284 float bottomFadeStrength = 0.0f;
13285 float leftFadeStrength = 0.0f;
13286 float rightFadeStrength = 0.0f;
13287
13288 // Step 2, save the canvas' layers
13289 int paddingLeft = mPaddingLeft;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013290
13291 final boolean offsetRequired = isPaddingOffsetRequired();
13292 if (offsetRequired) {
13293 paddingLeft += getLeftPaddingOffset();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013294 }
13295
13296 int left = mScrollX + paddingLeft;
13297 int right = left + mRight - mLeft - mPaddingRight - paddingLeft;
Romain Guyf2fc4602011-07-19 15:20:03 -070013298 int top = mScrollY + getFadeTop(offsetRequired);
13299 int bottom = top + getFadeHeight(offsetRequired);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013300
13301 if (offsetRequired) {
13302 right += getRightPaddingOffset();
13303 bottom += getBottomPaddingOffset();
13304 }
13305
13306 final ScrollabilityCache scrollabilityCache = mScrollCache;
Philip Milne6c8ea062012-04-03 17:38:43 -070013307 final float fadeHeight = scrollabilityCache.fadingEdgeLength;
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013308 int length = (int) fadeHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013309
13310 // clip the fade length if top and bottom fades overlap
13311 // overlapping fades produce odd-looking artifacts
13312 if (verticalEdges && (top + length > bottom - length)) {
13313 length = (bottom - top) / 2;
13314 }
13315
13316 // also clip horizontal fades if necessary
13317 if (horizontalEdges && (left + length > right - length)) {
13318 length = (right - left) / 2;
13319 }
13320
13321 if (verticalEdges) {
13322 topFadeStrength = Math.max(0.0f, Math.min(1.0f, getTopFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013323 drawTop = topFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013324 bottomFadeStrength = Math.max(0.0f, Math.min(1.0f, getBottomFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013325 drawBottom = bottomFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013326 }
13327
13328 if (horizontalEdges) {
13329 leftFadeStrength = Math.max(0.0f, Math.min(1.0f, getLeftFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013330 drawLeft = leftFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013331 rightFadeStrength = Math.max(0.0f, Math.min(1.0f, getRightFadingEdgeStrength()));
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013332 drawRight = rightFadeStrength * fadeHeight > 1.0f;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013333 }
13334
13335 saveCount = canvas.getSaveCount();
13336
13337 int solidColor = getSolidColor();
Romain Guyf607bdc2010-09-10 19:20:06 -070013338 if (solidColor == 0) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013339 final int flags = Canvas.HAS_ALPHA_LAYER_SAVE_FLAG;
13340
13341 if (drawTop) {
13342 canvas.saveLayer(left, top, right, top + length, null, flags);
13343 }
13344
13345 if (drawBottom) {
13346 canvas.saveLayer(left, bottom - length, right, bottom, null, flags);
13347 }
13348
13349 if (drawLeft) {
13350 canvas.saveLayer(left, top, left + length, bottom, null, flags);
13351 }
13352
13353 if (drawRight) {
13354 canvas.saveLayer(right - length, top, right, bottom, null, flags);
13355 }
13356 } else {
13357 scrollabilityCache.setFadeColor(solidColor);
13358 }
13359
13360 // Step 3, draw the content
Romain Guy24443ea2009-05-11 11:56:30 -070013361 if (!dirtyOpaque) onDraw(canvas);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013362
13363 // Step 4, draw the children
13364 dispatchDraw(canvas);
13365
13366 // Step 5, draw the fade effect and restore layers
13367 final Paint p = scrollabilityCache.paint;
13368 final Matrix matrix = scrollabilityCache.matrix;
13369 final Shader fade = scrollabilityCache.shader;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013370
13371 if (drawTop) {
13372 matrix.setScale(1, fadeHeight * topFadeStrength);
13373 matrix.postTranslate(left, top);
13374 fade.setLocalMatrix(matrix);
13375 canvas.drawRect(left, top, right, top + length, p);
13376 }
13377
13378 if (drawBottom) {
13379 matrix.setScale(1, fadeHeight * bottomFadeStrength);
13380 matrix.postRotate(180);
13381 matrix.postTranslate(left, bottom);
13382 fade.setLocalMatrix(matrix);
13383 canvas.drawRect(left, bottom - length, right, bottom, p);
13384 }
13385
13386 if (drawLeft) {
13387 matrix.setScale(1, fadeHeight * leftFadeStrength);
13388 matrix.postRotate(-90);
13389 matrix.postTranslate(left, top);
13390 fade.setLocalMatrix(matrix);
13391 canvas.drawRect(left, top, left + length, bottom, p);
13392 }
13393
13394 if (drawRight) {
13395 matrix.setScale(1, fadeHeight * rightFadeStrength);
13396 matrix.postRotate(90);
13397 matrix.postTranslate(right, top);
13398 fade.setLocalMatrix(matrix);
13399 canvas.drawRect(right - length, top, right, bottom, p);
13400 }
13401
13402 canvas.restoreToCount(saveCount);
13403
13404 // Step 6, draw decorations (scrollbars)
13405 onDrawScrollBars(canvas);
13406 }
13407
13408 /**
13409 * Override this if your view is known to always be drawn on top of a solid color background,
13410 * and needs to draw fading edges. Returning a non-zero color enables the view system to
13411 * optimize the drawing of the fading edges. If you do return a non-zero color, the alpha
13412 * should be set to 0xFF.
13413 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013414 * @see #setVerticalFadingEdgeEnabled(boolean)
13415 * @see #setHorizontalFadingEdgeEnabled(boolean)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013416 *
13417 * @return The known solid color background for this view, or 0 if the color may vary
13418 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070013419 @ViewDebug.ExportedProperty(category = "drawing")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013420 public int getSolidColor() {
13421 return 0;
13422 }
13423
13424 /**
13425 * Build a human readable string representation of the specified view flags.
13426 *
13427 * @param flags the view flags to convert to a string
13428 * @return a String representing the supplied flags
13429 */
13430 private static String printFlags(int flags) {
13431 String output = "";
13432 int numFlags = 0;
13433 if ((flags & FOCUSABLE_MASK) == FOCUSABLE) {
13434 output += "TAKES_FOCUS";
13435 numFlags++;
13436 }
13437
13438 switch (flags & VISIBILITY_MASK) {
13439 case INVISIBLE:
13440 if (numFlags > 0) {
13441 output += " ";
13442 }
13443 output += "INVISIBLE";
13444 // USELESS HERE numFlags++;
13445 break;
13446 case GONE:
13447 if (numFlags > 0) {
13448 output += " ";
13449 }
13450 output += "GONE";
13451 // USELESS HERE numFlags++;
13452 break;
13453 default:
13454 break;
13455 }
13456 return output;
13457 }
13458
13459 /**
13460 * Build a human readable string representation of the specified private
13461 * view flags.
13462 *
13463 * @param privateFlags the private view flags to convert to a string
13464 * @return a String representing the supplied flags
13465 */
13466 private static String printPrivateFlags(int privateFlags) {
13467 String output = "";
13468 int numFlags = 0;
13469
13470 if ((privateFlags & WANTS_FOCUS) == WANTS_FOCUS) {
13471 output += "WANTS_FOCUS";
13472 numFlags++;
13473 }
13474
13475 if ((privateFlags & FOCUSED) == FOCUSED) {
13476 if (numFlags > 0) {
13477 output += " ";
13478 }
13479 output += "FOCUSED";
13480 numFlags++;
13481 }
13482
13483 if ((privateFlags & SELECTED) == SELECTED) {
13484 if (numFlags > 0) {
13485 output += " ";
13486 }
13487 output += "SELECTED";
13488 numFlags++;
13489 }
13490
13491 if ((privateFlags & IS_ROOT_NAMESPACE) == IS_ROOT_NAMESPACE) {
13492 if (numFlags > 0) {
13493 output += " ";
13494 }
13495 output += "IS_ROOT_NAMESPACE";
13496 numFlags++;
13497 }
13498
13499 if ((privateFlags & HAS_BOUNDS) == HAS_BOUNDS) {
13500 if (numFlags > 0) {
13501 output += " ";
13502 }
13503 output += "HAS_BOUNDS";
13504 numFlags++;
13505 }
13506
13507 if ((privateFlags & DRAWN) == DRAWN) {
13508 if (numFlags > 0) {
13509 output += " ";
13510 }
13511 output += "DRAWN";
13512 // USELESS HERE numFlags++;
13513 }
13514 return output;
13515 }
13516
13517 /**
13518 * <p>Indicates whether or not this view's layout will be requested during
13519 * the next hierarchy layout pass.</p>
13520 *
13521 * @return true if the layout will be forced during next layout pass
13522 */
13523 public boolean isLayoutRequested() {
13524 return (mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT;
13525 }
13526
13527 /**
13528 * Assign a size and position to a view and all of its
13529 * descendants
13530 *
13531 * <p>This is the second phase of the layout mechanism.
13532 * (The first is measuring). In this phase, each parent calls
13533 * layout on all of its children to position them.
13534 * This is typically done using the child measurements
Chet Haase9c087442011-01-12 16:20:16 -080013535 * that were stored in the measure pass().</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013536 *
Chet Haase9c087442011-01-12 16:20:16 -080013537 * <p>Derived classes should not override this method.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013538 * Derived classes with children should override
13539 * onLayout. In that method, they should
Chet Haase9c087442011-01-12 16:20:16 -080013540 * call layout on each of their children.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013541 *
13542 * @param l Left position, relative to parent
13543 * @param t Top position, relative to parent
13544 * @param r Right position, relative to parent
13545 * @param b Bottom position, relative to parent
13546 */
Romain Guy5429e1d2010-09-07 12:38:00 -070013547 @SuppressWarnings({"unchecked"})
Chet Haase9c087442011-01-12 16:20:16 -080013548 public void layout(int l, int t, int r, int b) {
Chet Haase21cd1382010-09-01 17:42:29 -070013549 int oldL = mLeft;
13550 int oldT = mTop;
13551 int oldB = mBottom;
13552 int oldR = mRight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013553 boolean changed = setFrame(l, t, r, b);
13554 if (changed || (mPrivateFlags & LAYOUT_REQUIRED) == LAYOUT_REQUIRED) {
13555 if (ViewDebug.TRACE_HIERARCHY) {
13556 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_LAYOUT);
13557 }
13558
13559 onLayout(changed, l, t, r, b);
13560 mPrivateFlags &= ~LAYOUT_REQUIRED;
Chet Haase21cd1382010-09-01 17:42:29 -070013561
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070013562 ListenerInfo li = mListenerInfo;
13563 if (li != null && li.mOnLayoutChangeListeners != null) {
Chet Haase21cd1382010-09-01 17:42:29 -070013564 ArrayList<OnLayoutChangeListener> listenersCopy =
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070013565 (ArrayList<OnLayoutChangeListener>)li.mOnLayoutChangeListeners.clone();
Chet Haase21cd1382010-09-01 17:42:29 -070013566 int numListeners = listenersCopy.size();
13567 for (int i = 0; i < numListeners; ++i) {
Chet Haase7c608f22010-10-22 17:54:04 -070013568 listenersCopy.get(i).onLayoutChange(this, l, t, r, b, oldL, oldT, oldR, oldB);
Chet Haase21cd1382010-09-01 17:42:29 -070013569 }
13570 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013571 }
13572 mPrivateFlags &= ~FORCE_LAYOUT;
13573 }
13574
13575 /**
13576 * Called from layout when this view should
13577 * assign a size and position to each of its children.
13578 *
13579 * Derived classes with children should override
13580 * this method and call layout on each of
Chet Haase21cd1382010-09-01 17:42:29 -070013581 * their children.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013582 * @param changed This is a new size or position for this view
13583 * @param left Left position, relative to parent
13584 * @param top Top position, relative to parent
13585 * @param right Right position, relative to parent
13586 * @param bottom Bottom position, relative to parent
13587 */
13588 protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
13589 }
13590
13591 /**
13592 * Assign a size and position to this view.
13593 *
13594 * This is called from layout.
13595 *
13596 * @param left Left position, relative to parent
13597 * @param top Top position, relative to parent
13598 * @param right Right position, relative to parent
13599 * @param bottom Bottom position, relative to parent
13600 * @return true if the new size and position are different than the
13601 * previous ones
13602 * {@hide}
13603 */
13604 protected boolean setFrame(int left, int top, int right, int bottom) {
13605 boolean changed = false;
13606
13607 if (DBG) {
Mitsuru Oshima64f59342009-06-21 00:03:11 -070013608 Log.d("View", this + " View.setFrame(" + left + "," + top + ","
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013609 + right + "," + bottom + ")");
13610 }
13611
13612 if (mLeft != left || mRight != right || mTop != top || mBottom != bottom) {
13613 changed = true;
13614
13615 // Remember our drawn bit
13616 int drawn = mPrivateFlags & DRAWN;
13617
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013618 int oldWidth = mRight - mLeft;
13619 int oldHeight = mBottom - mTop;
Chet Haase75755e22011-07-18 17:48:25 -070013620 int newWidth = right - left;
13621 int newHeight = bottom - top;
13622 boolean sizeChanged = (newWidth != oldWidth) || (newHeight != oldHeight);
13623
13624 // Invalidate our old position
13625 invalidate(sizeChanged);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013626
13627 mLeft = left;
13628 mTop = top;
13629 mRight = right;
13630 mBottom = bottom;
Chet Haase1271e2c2012-04-20 09:54:27 -070013631 if (mDisplayList != null) {
Chet Haasea1cff502012-02-21 13:43:44 -080013632 mDisplayList.setLeftTopRightBottom(mLeft, mTop, mRight, mBottom);
13633 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013634
13635 mPrivateFlags |= HAS_BOUNDS;
13636
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013637
Chet Haase75755e22011-07-18 17:48:25 -070013638 if (sizeChanged) {
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013639 if ((mPrivateFlags & PIVOT_EXPLICITLY_SET) == 0) {
13640 // A change in dimension means an auto-centered pivot point changes, too
Dianne Hackbornddb715b2011-09-09 14:43:39 -070013641 if (mTransformationInfo != null) {
13642 mTransformationInfo.mMatrixDirty = true;
13643 }
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013644 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013645 onSizeChanged(newWidth, newHeight, oldWidth, oldHeight);
13646 }
13647
13648 if ((mViewFlags & VISIBILITY_MASK) == VISIBLE) {
13649 // If we are visible, force the DRAWN bit to on so that
13650 // this invalidate will go through (at least to our parent).
13651 // This is because someone may have invalidated this view
Chet Haase6c7ad5d2010-12-28 08:40:00 -080013652 // before this call to setFrame came in, thereby clearing
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013653 // the DRAWN bit.
13654 mPrivateFlags |= DRAWN;
Chet Haase75755e22011-07-18 17:48:25 -070013655 invalidate(sizeChanged);
Chet Haasef28595e2011-01-31 18:52:12 -080013656 // parent display list may need to be recreated based on a change in the bounds
13657 // of any child
13658 invalidateParentCaches();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013659 }
13660
13661 // Reset drawn bit to original value (invalidate turns it off)
13662 mPrivateFlags |= drawn;
13663
13664 mBackgroundSizeChanged = true;
13665 }
13666 return changed;
13667 }
13668
13669 /**
13670 * Finalize inflating a view from XML. This is called as the last phase
13671 * of inflation, after all child views have been added.
13672 *
13673 * <p>Even if the subclass overrides onFinishInflate, they should always be
13674 * sure to call the super method, so that we get called.
13675 */
13676 protected void onFinishInflate() {
13677 }
13678
13679 /**
13680 * Returns the resources associated with this view.
13681 *
13682 * @return Resources object.
13683 */
13684 public Resources getResources() {
13685 return mResources;
13686 }
13687
13688 /**
13689 * Invalidates the specified Drawable.
13690 *
13691 * @param drawable the drawable to invalidate
13692 */
13693 public void invalidateDrawable(Drawable drawable) {
13694 if (verifyDrawable(drawable)) {
13695 final Rect dirty = drawable.getBounds();
13696 final int scrollX = mScrollX;
13697 final int scrollY = mScrollY;
13698
13699 invalidate(dirty.left + scrollX, dirty.top + scrollY,
13700 dirty.right + scrollX, dirty.bottom + scrollY);
13701 }
13702 }
13703
13704 /**
13705 * Schedules an action on a drawable to occur at a specified time.
13706 *
13707 * @param who the recipient of the action
13708 * @param what the action to run on the drawable
13709 * @param when the time at which the action must occur. Uses the
13710 * {@link SystemClock#uptimeMillis} timebase.
13711 */
13712 public void scheduleDrawable(Drawable who, Runnable what, long when) {
Adam Powell37419d72011-11-10 11:32:09 -080013713 if (verifyDrawable(who) && what != null) {
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080013714 final long delay = when - SystemClock.uptimeMillis();
Adam Powell37419d72011-11-10 11:32:09 -080013715 if (mAttachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013716 mAttachInfo.mViewRootImpl.mChoreographer.postCallbackDelayed(
13717 Choreographer.CALLBACK_ANIMATION, what, who,
13718 Choreographer.subtractFrameDelay(delay));
Adam Powell37419d72011-11-10 11:32:09 -080013719 } else {
Jeff Brown7ae9d5f2012-03-05 19:33:49 -080013720 ViewRootImpl.getRunQueue().postDelayed(what, delay);
Adam Powell37419d72011-11-10 11:32:09 -080013721 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013722 }
13723 }
13724
13725 /**
13726 * Cancels a scheduled action on a drawable.
13727 *
13728 * @param who the recipient of the action
13729 * @param what the action to cancel
13730 */
13731 public void unscheduleDrawable(Drawable who, Runnable what) {
Adam Powell37419d72011-11-10 11:32:09 -080013732 if (verifyDrawable(who) && what != null) {
13733 if (mAttachInfo != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013734 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
13735 Choreographer.CALLBACK_ANIMATION, what, who);
Adam Powell37419d72011-11-10 11:32:09 -080013736 } else {
13737 ViewRootImpl.getRunQueue().removeCallbacks(what);
13738 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013739 }
13740 }
13741
13742 /**
13743 * Unschedule any events associated with the given Drawable. This can be
13744 * used when selecting a new Drawable into a view, so that the previous
13745 * one is completely unscheduled.
13746 *
13747 * @param who The Drawable to unschedule.
13748 *
13749 * @see #drawableStateChanged
13750 */
13751 public void unscheduleDrawable(Drawable who) {
Jeff Brown43ea54b2012-03-09 14:37:48 -080013752 if (mAttachInfo != null && who != null) {
Jeff Brownebb2d8d2012-03-23 17:14:34 -070013753 mAttachInfo.mViewRootImpl.mChoreographer.removeCallbacks(
13754 Choreographer.CALLBACK_ANIMATION, null, who);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013755 }
13756 }
13757
Fabrice Di Meglioc0053222011-06-13 12:16:51 -070013758 /**
13759 * Return the layout direction of a given Drawable.
13760 *
13761 * @param who the Drawable to query
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070013762 * @hide
Fabrice Di Meglioc0053222011-06-13 12:16:51 -070013763 */
13764 public int getResolvedLayoutDirection(Drawable who) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013765 return (who == mBackground) ? getResolvedLayoutDirection() : LAYOUT_DIRECTION_DEFAULT;
Fabrice Di Meglio6a036402011-05-23 14:43:23 -070013766 }
13767
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013768 /**
13769 * If your view subclass is displaying its own Drawable objects, it should
13770 * override this function and return true for any Drawable it is
13771 * displaying. This allows animations for those drawables to be
13772 * scheduled.
13773 *
13774 * <p>Be sure to call through to the super class when overriding this
13775 * function.
13776 *
13777 * @param who The Drawable to verify. Return true if it is one you are
13778 * displaying, else return the result of calling through to the
13779 * super class.
13780 *
13781 * @return boolean If true than the Drawable is being displayed in the
13782 * view; else false and it is not allowed to animate.
13783 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013784 * @see #unscheduleDrawable(android.graphics.drawable.Drawable)
13785 * @see #drawableStateChanged()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013786 */
13787 protected boolean verifyDrawable(Drawable who) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013788 return who == mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013789 }
13790
13791 /**
13792 * This function is called whenever the state of the view changes in such
13793 * a way that it impacts the state of drawables being shown.
13794 *
13795 * <p>Be sure to call through to the superclass when overriding this
13796 * function.
13797 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013798 * @see Drawable#setState(int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013799 */
13800 protected void drawableStateChanged() {
Philip Milne6c8ea062012-04-03 17:38:43 -070013801 Drawable d = mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013802 if (d != null && d.isStateful()) {
13803 d.setState(getDrawableState());
13804 }
13805 }
13806
13807 /**
13808 * Call this to force a view to update its drawable state. This will cause
13809 * drawableStateChanged to be called on this view. Views that are interested
13810 * in the new state should call getDrawableState.
13811 *
13812 * @see #drawableStateChanged
13813 * @see #getDrawableState
13814 */
13815 public void refreshDrawableState() {
13816 mPrivateFlags |= DRAWABLE_STATE_DIRTY;
13817 drawableStateChanged();
13818
13819 ViewParent parent = mParent;
13820 if (parent != null) {
13821 parent.childDrawableStateChanged(this);
13822 }
13823 }
13824
13825 /**
13826 * Return an array of resource IDs of the drawable states representing the
13827 * current state of the view.
13828 *
13829 * @return The current drawable state
13830 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013831 * @see Drawable#setState(int[])
13832 * @see #drawableStateChanged()
13833 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013834 */
13835 public final int[] getDrawableState() {
13836 if ((mDrawableState != null) && ((mPrivateFlags & DRAWABLE_STATE_DIRTY) == 0)) {
13837 return mDrawableState;
13838 } else {
13839 mDrawableState = onCreateDrawableState(0);
13840 mPrivateFlags &= ~DRAWABLE_STATE_DIRTY;
13841 return mDrawableState;
13842 }
13843 }
13844
13845 /**
13846 * Generate the new {@link android.graphics.drawable.Drawable} state for
13847 * this view. This is called by the view
13848 * system when the cached Drawable state is determined to be invalid. To
13849 * retrieve the current state, you should use {@link #getDrawableState}.
13850 *
13851 * @param extraSpace if non-zero, this is the number of extra entries you
13852 * would like in the returned array in which you can place your own
13853 * states.
13854 *
13855 * @return Returns an array holding the current {@link Drawable} state of
13856 * the view.
13857 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013858 * @see #mergeDrawableStates(int[], int[])
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013859 */
13860 protected int[] onCreateDrawableState(int extraSpace) {
13861 if ((mViewFlags & DUPLICATE_PARENT_STATE) == DUPLICATE_PARENT_STATE &&
13862 mParent instanceof View) {
13863 return ((View) mParent).onCreateDrawableState(extraSpace);
13864 }
13865
13866 int[] drawableState;
13867
13868 int privateFlags = mPrivateFlags;
13869
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013870 int viewStateIndex = 0;
13871 if ((privateFlags & PRESSED) != 0) viewStateIndex |= VIEW_STATE_PRESSED;
13872 if ((mViewFlags & ENABLED_MASK) == ENABLED) viewStateIndex |= VIEW_STATE_ENABLED;
13873 if (isFocused()) viewStateIndex |= VIEW_STATE_FOCUSED;
Neel Parekhe5378582010-10-06 11:36:50 -070013874 if ((privateFlags & SELECTED) != 0) viewStateIndex |= VIEW_STATE_SELECTED;
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013875 if (hasWindowFocus()) viewStateIndex |= VIEW_STATE_WINDOW_FOCUSED;
13876 if ((privateFlags & ACTIVATED) != 0) viewStateIndex |= VIEW_STATE_ACTIVATED;
Adam Powell5a7e94e2011-04-25 15:30:43 -070013877 if (mAttachInfo != null && mAttachInfo.mHardwareAccelerationRequested &&
13878 HardwareRenderer.isAvailable()) {
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080013879 // This is set if HW acceleration is requested, even if the current
13880 // process doesn't allow it. This is just to allow app preview
13881 // windows to better match their app.
13882 viewStateIndex |= VIEW_STATE_ACCELERATED;
13883 }
PY Laligandc33d8d49e2011-03-14 18:22:53 -070013884 if ((privateFlags & HOVERED) != 0) viewStateIndex |= VIEW_STATE_HOVERED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013885
Christopher Tate3d4bf172011-03-28 16:16:46 -070013886 final int privateFlags2 = mPrivateFlags2;
13887 if ((privateFlags2 & DRAG_CAN_ACCEPT) != 0) viewStateIndex |= VIEW_STATE_DRAG_CAN_ACCEPT;
13888 if ((privateFlags2 & DRAG_HOVERED) != 0) viewStateIndex |= VIEW_STATE_DRAG_HOVERED;
13889
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013890 drawableState = VIEW_STATE_SETS[viewStateIndex];
13891
13892 //noinspection ConstantIfStatement
13893 if (false) {
13894 Log.i("View", "drawableStateIndex=" + viewStateIndex);
13895 Log.i("View", toString()
13896 + " pressed=" + ((privateFlags & PRESSED) != 0)
13897 + " en=" + ((mViewFlags & ENABLED_MASK) == ENABLED)
13898 + " fo=" + hasFocus()
13899 + " sl=" + ((privateFlags & SELECTED) != 0)
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070013900 + " wf=" + hasWindowFocus()
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013901 + ": " + Arrays.toString(drawableState));
13902 }
13903
13904 if (extraSpace == 0) {
13905 return drawableState;
13906 }
13907
13908 final int[] fullState;
13909 if (drawableState != null) {
13910 fullState = new int[drawableState.length + extraSpace];
13911 System.arraycopy(drawableState, 0, fullState, 0, drawableState.length);
13912 } else {
13913 fullState = new int[extraSpace];
13914 }
13915
13916 return fullState;
13917 }
13918
13919 /**
13920 * Merge your own state values in <var>additionalState</var> into the base
13921 * state values <var>baseState</var> that were returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070013922 * {@link #onCreateDrawableState(int)}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013923 *
13924 * @param baseState The base state values returned by
Romain Guy5c22a8c2011-05-13 11:48:45 -070013925 * {@link #onCreateDrawableState(int)}, which will be modified to also hold your
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013926 * own additional state values.
13927 *
13928 * @param additionalState The additional state values you would like
13929 * added to <var>baseState</var>; this array is not modified.
13930 *
13931 * @return As a convenience, the <var>baseState</var> array you originally
13932 * passed into the function is returned.
13933 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013934 * @see #onCreateDrawableState(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013935 */
13936 protected static int[] mergeDrawableStates(int[] baseState, int[] additionalState) {
13937 final int N = baseState.length;
13938 int i = N - 1;
13939 while (i >= 0 && baseState[i] == 0) {
13940 i--;
13941 }
13942 System.arraycopy(additionalState, 0, baseState, i + 1, additionalState.length);
13943 return baseState;
13944 }
13945
13946 /**
Dianne Hackborn079e2352010-10-18 17:02:43 -070013947 * Call {@link Drawable#jumpToCurrentState() Drawable.jumpToCurrentState()}
13948 * on all Drawable objects associated with this view.
13949 */
13950 public void jumpDrawablesToCurrentState() {
Philip Milne6c8ea062012-04-03 17:38:43 -070013951 if (mBackground != null) {
13952 mBackground.jumpToCurrentState();
Dianne Hackborn079e2352010-10-18 17:02:43 -070013953 }
13954 }
13955
13956 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013957 * Sets the background color for this view.
13958 * @param color the color of the background
13959 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000013960 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013961 public void setBackgroundColor(int color) {
Philip Milne6c8ea062012-04-03 17:38:43 -070013962 if (mBackground instanceof ColorDrawable) {
13963 ((ColorDrawable) mBackground).setColor(color);
Chet Haase70d4ba12010-10-06 09:46:45 -070013964 } else {
Philip Milne6c8ea062012-04-03 17:38:43 -070013965 setBackground(new ColorDrawable(color));
Chet Haase70d4ba12010-10-06 09:46:45 -070013966 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013967 }
13968
13969 /**
13970 * Set the background to a given resource. The resource should refer to
Wink Saville7cd88e12009-08-04 14:45:10 -070013971 * a Drawable object or 0 to remove the background.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013972 * @param resid The identifier of the resource.
Philip Milne6c8ea062012-04-03 17:38:43 -070013973 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013974 * @attr ref android.R.styleable#View_background
13975 */
Bjorn Bringert8354fa62010-02-24 23:54:29 +000013976 @RemotableViewMethod
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013977 public void setBackgroundResource(int resid) {
13978 if (resid != 0 && resid == mBackgroundResource) {
13979 return;
13980 }
13981
13982 Drawable d= null;
13983 if (resid != 0) {
13984 d = mResources.getDrawable(resid);
13985 }
Philip Milne6c8ea062012-04-03 17:38:43 -070013986 setBackground(d);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013987
13988 mBackgroundResource = resid;
13989 }
13990
13991 /**
13992 * Set the background to a given Drawable, or remove the background. If the
13993 * background has padding, this View's padding is set to the background's
13994 * padding. However, when a background is removed, this View's padding isn't
13995 * touched. If setting the padding is desired, please use
13996 * {@link #setPadding(int, int, int, int)}.
13997 *
Philip Milne6c8ea062012-04-03 17:38:43 -070013998 * @param background The Drawable to use as the background, or null to remove the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080013999 * background
14000 */
Philip Milne6c8ea062012-04-03 17:38:43 -070014001 public void setBackground(Drawable background) {
Romain Guyeb378892012-04-12 11:33:14 -070014002 //noinspection deprecation
Philip Milne6c8ea062012-04-03 17:38:43 -070014003 setBackgroundDrawable(background);
14004 }
14005
14006 /**
14007 * @deprecated use {@link #setBackground(Drawable)} instead
14008 */
14009 @Deprecated
14010 public void setBackgroundDrawable(Drawable background) {
14011 if (background == mBackground) {
Adam Powell4d36ec12011-07-17 16:44:16 -070014012 return;
14013 }
14014
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014015 boolean requestLayout = false;
14016
14017 mBackgroundResource = 0;
14018
14019 /*
14020 * Regardless of whether we're setting a new background or not, we want
14021 * to clear the previous drawable.
14022 */
Philip Milne6c8ea062012-04-03 17:38:43 -070014023 if (mBackground != null) {
14024 mBackground.setCallback(null);
14025 unscheduleDrawable(mBackground);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014026 }
14027
Philip Milne6c8ea062012-04-03 17:38:43 -070014028 if (background != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014029 Rect padding = sThreadLocal.get();
14030 if (padding == null) {
14031 padding = new Rect();
14032 sThreadLocal.set(padding);
14033 }
Philip Milne6c8ea062012-04-03 17:38:43 -070014034 if (background.getPadding(padding)) {
14035 switch (background.getResolvedLayoutDirectionSelf()) {
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014036 case LAYOUT_DIRECTION_RTL:
14037 setPadding(padding.right, padding.top, padding.left, padding.bottom);
14038 break;
14039 case LAYOUT_DIRECTION_LTR:
14040 default:
14041 setPadding(padding.left, padding.top, padding.right, padding.bottom);
14042 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014043 }
14044
14045 // Compare the minimum sizes of the old Drawable and the new. If there isn't an old or
14046 // if it has a different minimum size, we should layout again
Philip Milne6c8ea062012-04-03 17:38:43 -070014047 if (mBackground == null || mBackground.getMinimumHeight() != background.getMinimumHeight() ||
14048 mBackground.getMinimumWidth() != background.getMinimumWidth()) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014049 requestLayout = true;
14050 }
14051
Philip Milne6c8ea062012-04-03 17:38:43 -070014052 background.setCallback(this);
14053 if (background.isStateful()) {
14054 background.setState(getDrawableState());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014055 }
Philip Milne6c8ea062012-04-03 17:38:43 -070014056 background.setVisible(getVisibility() == VISIBLE, false);
14057 mBackground = background;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014058
14059 if ((mPrivateFlags & SKIP_DRAW) != 0) {
14060 mPrivateFlags &= ~SKIP_DRAW;
14061 mPrivateFlags |= ONLY_DRAWS_BACKGROUND;
14062 requestLayout = true;
14063 }
14064 } else {
14065 /* Remove the background */
Philip Milne6c8ea062012-04-03 17:38:43 -070014066 mBackground = null;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014067
14068 if ((mPrivateFlags & ONLY_DRAWS_BACKGROUND) != 0) {
14069 /*
14070 * This view ONLY drew the background before and we're removing
14071 * the background, so now it won't draw anything
14072 * (hence we SKIP_DRAW)
14073 */
14074 mPrivateFlags &= ~ONLY_DRAWS_BACKGROUND;
14075 mPrivateFlags |= SKIP_DRAW;
14076 }
14077
14078 /*
14079 * When the background is set, we try to apply its padding to this
14080 * View. When the background is removed, we don't touch this View's
14081 * padding. This is noted in the Javadocs. Hence, we don't need to
14082 * requestLayout(), the invalidate() below is sufficient.
14083 */
14084
14085 // The old background's minimum size could have affected this
14086 // View's layout, so let's requestLayout
14087 requestLayout = true;
14088 }
14089
Romain Guy8f1344f52009-05-15 16:03:59 -070014090 computeOpaqueFlags();
14091
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014092 if (requestLayout) {
14093 requestLayout();
14094 }
14095
14096 mBackgroundSizeChanged = true;
Romain Guy0fd89bf2011-01-26 15:41:30 -080014097 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014098 }
14099
14100 /**
14101 * Gets the background drawable
Philip Milne6c8ea062012-04-03 17:38:43 -070014102 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014103 * @return The drawable used as the background for this view, if any.
Philip Milne6c8ea062012-04-03 17:38:43 -070014104 *
14105 * @see #setBackground(Drawable)
14106 *
14107 * @attr ref android.R.styleable#View_background
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014108 */
14109 public Drawable getBackground() {
Philip Milne6c8ea062012-04-03 17:38:43 -070014110 return mBackground;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014111 }
14112
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014113 /**
14114 * Sets the padding. The view may add on the space required to display
14115 * the scrollbars, depending on the style and visibility of the scrollbars.
14116 * So the values returned from {@link #getPaddingLeft}, {@link #getPaddingTop},
14117 * {@link #getPaddingRight} and {@link #getPaddingBottom} may be different
14118 * from the values set in this call.
14119 *
14120 * @attr ref android.R.styleable#View_padding
14121 * @attr ref android.R.styleable#View_paddingBottom
14122 * @attr ref android.R.styleable#View_paddingLeft
14123 * @attr ref android.R.styleable#View_paddingRight
14124 * @attr ref android.R.styleable#View_paddingTop
14125 * @param left the left padding in pixels
14126 * @param top the top padding in pixels
14127 * @param right the right padding in pixels
14128 * @param bottom the bottom padding in pixels
14129 */
14130 public void setPadding(int left, int top, int right, int bottom) {
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014131 mUserPaddingStart = -1;
14132 mUserPaddingEnd = -1;
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014133 mUserPaddingRelative = false;
14134
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014135 internalSetPadding(left, top, right, bottom);
14136 }
14137
14138 private void internalSetPadding(int left, int top, int right, int bottom) {
Adam Powell20232d02010-12-08 21:08:53 -080014139 mUserPaddingLeft = left;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014140 mUserPaddingRight = right;
14141 mUserPaddingBottom = bottom;
14142
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014143 final int viewFlags = mViewFlags;
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014144 boolean changed = false;
Romain Guy8506ab42009-06-11 17:35:47 -070014145
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014146 // Common case is there are no scroll bars.
14147 if ((viewFlags & (SCROLLBARS_VERTICAL|SCROLLBARS_HORIZONTAL)) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014148 if ((viewFlags & SCROLLBARS_VERTICAL) != 0) {
Adam Powell20232d02010-12-08 21:08:53 -080014149 final int offset = (viewFlags & SCROLLBARS_INSET_MASK) == 0
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014150 ? 0 : getVerticalScrollbarWidth();
Adam Powell20232d02010-12-08 21:08:53 -080014151 switch (mVerticalScrollbarPosition) {
14152 case SCROLLBAR_POSITION_DEFAULT:
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014153 if (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) {
14154 left += offset;
14155 } else {
14156 right += offset;
14157 }
14158 break;
Adam Powell20232d02010-12-08 21:08:53 -080014159 case SCROLLBAR_POSITION_RIGHT:
14160 right += offset;
14161 break;
14162 case SCROLLBAR_POSITION_LEFT:
14163 left += offset;
14164 break;
14165 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014166 }
Adam Powell20232d02010-12-08 21:08:53 -080014167 if ((viewFlags & SCROLLBARS_HORIZONTAL) != 0) {
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014168 bottom += (viewFlags & SCROLLBARS_INSET_MASK) == 0
14169 ? 0 : getHorizontalScrollbarHeight();
14170 }
14171 }
Romain Guy8506ab42009-06-11 17:35:47 -070014172
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014173 if (mPaddingLeft != left) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014174 changed = true;
14175 mPaddingLeft = left;
14176 }
14177 if (mPaddingTop != top) {
14178 changed = true;
14179 mPaddingTop = top;
14180 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014181 if (mPaddingRight != right) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014182 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014183 mPaddingRight = right;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014184 }
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014185 if (mPaddingBottom != bottom) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014186 changed = true;
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -070014187 mPaddingBottom = bottom;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014188 }
14189
14190 if (changed) {
14191 requestLayout();
14192 }
14193 }
14194
14195 /**
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014196 * Sets the relative padding. The view may add on the space required to display
14197 * the scrollbars, depending on the style and visibility of the scrollbars.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014198 * from the values set in this call.
14199 *
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014200 * @param start the start padding in pixels
14201 * @param top the top padding in pixels
14202 * @param end the end padding in pixels
14203 * @param bottom the bottom padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014204 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014205 */
14206 public void setPaddingRelative(int start, int top, int end, int bottom) {
Fabrice Di Megliof9e36502011-06-21 18:41:48 -070014207 mUserPaddingStart = start;
14208 mUserPaddingEnd = end;
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014209 mUserPaddingRelative = true;
Fabrice Di Megliof9e36502011-06-21 18:41:48 -070014210
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014211 switch(getResolvedLayoutDirection()) {
14212 case LAYOUT_DIRECTION_RTL:
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014213 internalSetPadding(end, top, start, bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014214 break;
14215 case LAYOUT_DIRECTION_LTR:
14216 default:
Fabrice Di Meglio509708d2012-03-06 15:41:11 -080014217 internalSetPadding(start, top, end, bottom);
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014218 }
14219 }
14220
14221 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014222 * Returns the top padding of this view.
14223 *
14224 * @return the top padding in pixels
14225 */
14226 public int getPaddingTop() {
14227 return mPaddingTop;
14228 }
14229
14230 /**
14231 * Returns the bottom padding of this view. If there are inset and enabled
14232 * scrollbars, this value may include the space required to display the
14233 * scrollbars as well.
14234 *
14235 * @return the bottom padding in pixels
14236 */
14237 public int getPaddingBottom() {
14238 return mPaddingBottom;
14239 }
14240
14241 /**
14242 * Returns the left padding of this view. If there are inset and enabled
14243 * scrollbars, this value may include the space required to display the
14244 * scrollbars as well.
14245 *
14246 * @return the left padding in pixels
14247 */
14248 public int getPaddingLeft() {
14249 return mPaddingLeft;
14250 }
14251
14252 /**
Fabrice Di Meglio30a21e12012-03-12 13:12:19 -070014253 * Returns the start padding of this view depending on its resolved layout direction.
14254 * If there are inset and enabled scrollbars, this value may include the space
14255 * required to display the scrollbars as well.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014256 *
14257 * @return the start padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014258 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014259 */
14260 public int getPaddingStart() {
14261 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
14262 mPaddingRight : mPaddingLeft;
14263 }
14264
14265 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014266 * Returns the right padding of this view. If there are inset and enabled
14267 * scrollbars, this value may include the space required to display the
14268 * scrollbars as well.
14269 *
14270 * @return the right padding in pixels
14271 */
14272 public int getPaddingRight() {
14273 return mPaddingRight;
14274 }
14275
14276 /**
Fabrice Di Meglio30a21e12012-03-12 13:12:19 -070014277 * Returns the end padding of this view depending on its resolved layout direction.
14278 * If there are inset and enabled scrollbars, this value may include the space
14279 * required to display the scrollbars as well.
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014280 *
14281 * @return the end padding in pixels
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014282 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014283 */
14284 public int getPaddingEnd() {
14285 return (getResolvedLayoutDirection() == LAYOUT_DIRECTION_RTL) ?
14286 mPaddingLeft : mPaddingRight;
14287 }
14288
14289 /**
14290 * Return if the padding as been set thru relative values
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014291 * {@link #setPaddingRelative(int, int, int, int)}
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014292 *
14293 * @return true if the padding is relative or false if it is not.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070014294 * @hide
Fabrice Di Megliod8703a92011-06-16 18:54:08 -070014295 */
14296 public boolean isPaddingRelative() {
14297 return mUserPaddingRelative;
14298 }
14299
14300 /**
Philip Milne1557fd72012-04-04 23:41:34 -070014301 * @hide
14302 */
Philip Milne7a23b492012-04-24 22:12:36 -070014303 public Insets getOpticalInsets() {
Philip Milne1557fd72012-04-04 23:41:34 -070014304 if (mLayoutInsets == null) {
Philip Milnebbd51f12012-04-18 15:09:05 -070014305 mLayoutInsets = (mBackground == null) ? Insets.NONE : mBackground.getLayoutInsets();
Philip Milne1557fd72012-04-04 23:41:34 -070014306 }
14307 return mLayoutInsets;
14308 }
14309
14310 /**
14311 * @hide
14312 */
14313 public void setLayoutInsets(Insets layoutInsets) {
14314 mLayoutInsets = layoutInsets;
14315 }
14316
14317 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014318 * Changes the selection state of this view. A view can be selected or not.
14319 * Note that selection is not the same as focus. Views are typically
14320 * selected in the context of an AdapterView like ListView or GridView;
14321 * the selected view is the view that is highlighted.
14322 *
14323 * @param selected true if the view must be selected, false otherwise
14324 */
14325 public void setSelected(boolean selected) {
14326 if (((mPrivateFlags & SELECTED) != 0) != selected) {
14327 mPrivateFlags = (mPrivateFlags & ~SELECTED) | (selected ? SELECTED : 0);
Romain Guya2431d02009-04-30 16:30:00 -070014328 if (!selected) resetPressedState();
Romain Guy0fd89bf2011-01-26 15:41:30 -080014329 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014330 refreshDrawableState();
14331 dispatchSetSelected(selected);
Svetoslav Ganov42138042012-03-20 11:51:39 -070014332 if (AccessibilityManager.getInstance(mContext).isEnabled()) {
14333 notifyAccessibilityStateChanged();
14334 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014335 }
14336 }
14337
14338 /**
14339 * Dispatch setSelected to all of this View's children.
14340 *
14341 * @see #setSelected(boolean)
14342 *
14343 * @param selected The new selected state
14344 */
14345 protected void dispatchSetSelected(boolean selected) {
14346 }
14347
14348 /**
14349 * Indicates the selection state of this view.
14350 *
14351 * @return true if the view is selected, false otherwise
14352 */
14353 @ViewDebug.ExportedProperty
14354 public boolean isSelected() {
14355 return (mPrivateFlags & SELECTED) != 0;
14356 }
14357
14358 /**
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014359 * Changes the activated state of this view. A view can be activated or not.
14360 * Note that activation is not the same as selection. Selection is
14361 * a transient property, representing the view (hierarchy) the user is
14362 * currently interacting with. Activation is a longer-term state that the
14363 * user can move views in and out of. For example, in a list view with
14364 * single or multiple selection enabled, the views in the current selection
14365 * set are activated. (Um, yeah, we are deeply sorry about the terminology
14366 * here.) The activated state is propagated down to children of the view it
14367 * is set on.
14368 *
14369 * @param activated true if the view must be activated, false otherwise
14370 */
14371 public void setActivated(boolean activated) {
14372 if (((mPrivateFlags & ACTIVATED) != 0) != activated) {
14373 mPrivateFlags = (mPrivateFlags & ~ACTIVATED) | (activated ? ACTIVATED : 0);
Romain Guy0fd89bf2011-01-26 15:41:30 -080014374 invalidate(true);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014375 refreshDrawableState();
Dianne Hackbornc6669ca2010-09-16 01:33:24 -070014376 dispatchSetActivated(activated);
Dianne Hackbornd0fa3712010-09-14 18:57:14 -070014377 }
14378 }
14379
14380 /**
14381 * Dispatch setActivated to all of this View's children.
14382 *
14383 * @see #setActivated(boolean)
14384 *
14385 * @param activated The new activated state
14386 */
14387 protected void dispatchSetActivated(boolean activated) {
14388 }
14389
14390 /**
14391 * Indicates the activation state of this view.
14392 *
14393 * @return true if the view is activated, false otherwise
14394 */
14395 @ViewDebug.ExportedProperty
14396 public boolean isActivated() {
14397 return (mPrivateFlags & ACTIVATED) != 0;
14398 }
14399
14400 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014401 * Returns the ViewTreeObserver for this view's hierarchy. The view tree
14402 * observer can be used to get notifications when global events, like
14403 * layout, happen.
14404 *
14405 * The returned ViewTreeObserver observer is not guaranteed to remain
14406 * valid for the lifetime of this View. If the caller of this method keeps
14407 * a long-lived reference to ViewTreeObserver, it should always check for
14408 * the return value of {@link ViewTreeObserver#isAlive()}.
14409 *
14410 * @return The ViewTreeObserver for this view's hierarchy.
14411 */
14412 public ViewTreeObserver getViewTreeObserver() {
14413 if (mAttachInfo != null) {
14414 return mAttachInfo.mTreeObserver;
14415 }
14416 if (mFloatingTreeObserver == null) {
14417 mFloatingTreeObserver = new ViewTreeObserver();
14418 }
14419 return mFloatingTreeObserver;
14420 }
14421
14422 /**
14423 * <p>Finds the topmost view in the current view hierarchy.</p>
14424 *
14425 * @return the topmost view containing this view
14426 */
14427 public View getRootView() {
14428 if (mAttachInfo != null) {
14429 final View v = mAttachInfo.mRootView;
14430 if (v != null) {
14431 return v;
14432 }
14433 }
Romain Guy8506ab42009-06-11 17:35:47 -070014434
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014435 View parent = this;
14436
14437 while (parent.mParent != null && parent.mParent instanceof View) {
14438 parent = (View) parent.mParent;
14439 }
14440
14441 return parent;
14442 }
14443
14444 /**
14445 * <p>Computes the coordinates of this view on the screen. The argument
14446 * must be an array of two integers. After the method returns, the array
14447 * contains the x and y location in that order.</p>
14448 *
14449 * @param location an array of two integers in which to hold the coordinates
14450 */
14451 public void getLocationOnScreen(int[] location) {
14452 getLocationInWindow(location);
14453
14454 final AttachInfo info = mAttachInfo;
Romain Guy779398e2009-06-16 13:17:50 -070014455 if (info != null) {
14456 location[0] += info.mWindowLeft;
14457 location[1] += info.mWindowTop;
14458 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014459 }
14460
14461 /**
14462 * <p>Computes the coordinates of this view in its window. The argument
14463 * must be an array of two integers. After the method returns, the array
14464 * contains the x and y location in that order.</p>
14465 *
14466 * @param location an array of two integers in which to hold the coordinates
14467 */
14468 public void getLocationInWindow(int[] location) {
14469 if (location == null || location.length < 2) {
Gilles Debunnecea45132011-11-24 02:19:27 +010014470 throw new IllegalArgumentException("location must be an array of two integers");
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014471 }
14472
Gilles Debunne6583ce52011-12-06 18:09:02 -080014473 if (mAttachInfo == null) {
14474 // When the view is not attached to a window, this method does not make sense
14475 location[0] = location[1] = 0;
14476 return;
14477 }
14478
Gilles Debunnecea45132011-11-24 02:19:27 +010014479 float[] position = mAttachInfo.mTmpTransformLocation;
14480 position[0] = position[1] = 0.0f;
14481
14482 if (!hasIdentityMatrix()) {
14483 getMatrix().mapPoints(position);
Dianne Hackbornddb715b2011-09-09 14:43:39 -070014484 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014485
Gilles Debunnecea45132011-11-24 02:19:27 +010014486 position[0] += mLeft;
14487 position[1] += mTop;
14488
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014489 ViewParent viewParent = mParent;
14490 while (viewParent instanceof View) {
Gilles Debunnecea45132011-11-24 02:19:27 +010014491 final View view = (View) viewParent;
14492
14493 position[0] -= view.mScrollX;
14494 position[1] -= view.mScrollY;
14495
14496 if (!view.hasIdentityMatrix()) {
14497 view.getMatrix().mapPoints(position);
Dianne Hackbornddb715b2011-09-09 14:43:39 -070014498 }
Gilles Debunnecea45132011-11-24 02:19:27 +010014499
14500 position[0] += view.mLeft;
14501 position[1] += view.mTop;
14502
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014503 viewParent = view.mParent;
Svetoslav Ganov42138042012-03-20 11:51:39 -070014504 }
Romain Guy8506ab42009-06-11 17:35:47 -070014505
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070014506 if (viewParent instanceof ViewRootImpl) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014507 // *cough*
Gilles Debunnecea45132011-11-24 02:19:27 +010014508 final ViewRootImpl vr = (ViewRootImpl) viewParent;
14509 position[1] -= vr.mCurScrollY;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014510 }
Gilles Debunnecea45132011-11-24 02:19:27 +010014511
14512 location[0] = (int) (position[0] + 0.5f);
14513 location[1] = (int) (position[1] + 0.5f);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014514 }
14515
14516 /**
14517 * {@hide}
14518 * @param id the id of the view to be found
14519 * @return the view of the specified id, null if cannot be found
14520 */
14521 protected View findViewTraversal(int id) {
14522 if (id == mID) {
14523 return this;
14524 }
14525 return null;
14526 }
14527
14528 /**
14529 * {@hide}
14530 * @param tag the tag of the view to be found
14531 * @return the view of specified tag, null if cannot be found
14532 */
14533 protected View findViewWithTagTraversal(Object tag) {
14534 if (tag != null && tag.equals(mTag)) {
14535 return this;
14536 }
14537 return null;
14538 }
14539
14540 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080014541 * {@hide}
14542 * @param predicate The predicate to evaluate.
Jeff Brown4dfbec22011-08-15 14:55:37 -070014543 * @param childToSkip If not null, ignores this child during the recursive traversal.
Jeff Brown4e6319b2010-12-13 10:36:51 -080014544 * @return The first view that matches the predicate or null.
14545 */
Jeff Brown4dfbec22011-08-15 14:55:37 -070014546 protected View findViewByPredicateTraversal(Predicate<View> predicate, View childToSkip) {
Jeff Brown4e6319b2010-12-13 10:36:51 -080014547 if (predicate.apply(this)) {
14548 return this;
14549 }
14550 return null;
14551 }
14552
14553 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014554 * Look for a child view with the given id. If this view has the given
14555 * id, return this view.
14556 *
14557 * @param id The id to search for.
14558 * @return The view that has the given id in the hierarchy or null
14559 */
14560 public final View findViewById(int id) {
14561 if (id < 0) {
14562 return null;
14563 }
14564 return findViewTraversal(id);
14565 }
14566
14567 /**
Svetoslav Ganov2cdedff2011-10-03 14:18:42 -070014568 * Finds a view by its unuque and stable accessibility id.
14569 *
14570 * @param accessibilityId The searched accessibility id.
14571 * @return The found view.
14572 */
14573 final View findViewByAccessibilityId(int accessibilityId) {
14574 if (accessibilityId < 0) {
14575 return null;
14576 }
14577 return findViewByAccessibilityIdTraversal(accessibilityId);
14578 }
14579
14580 /**
14581 * Performs the traversal to find a view by its unuque and stable accessibility id.
14582 *
14583 * <strong>Note:</strong>This method does not stop at the root namespace
14584 * boundary since the user can touch the screen at an arbitrary location
14585 * potentially crossing the root namespace bounday which will send an
14586 * accessibility event to accessibility services and they should be able
14587 * to obtain the event source. Also accessibility ids are guaranteed to be
14588 * unique in the window.
14589 *
14590 * @param accessibilityId The accessibility id.
14591 * @return The found view.
14592 */
14593 View findViewByAccessibilityIdTraversal(int accessibilityId) {
14594 if (getAccessibilityViewId() == accessibilityId) {
14595 return this;
14596 }
14597 return null;
14598 }
14599
14600 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014601 * Look for a child view with the given tag. If this view has the given
14602 * tag, return this view.
14603 *
14604 * @param tag The tag to search for, using "tag.equals(getTag())".
14605 * @return The View that has the given tag in the hierarchy or null
14606 */
14607 public final View findViewWithTag(Object tag) {
14608 if (tag == null) {
14609 return null;
14610 }
14611 return findViewWithTagTraversal(tag);
14612 }
14613
14614 /**
Jeff Brown4e6319b2010-12-13 10:36:51 -080014615 * {@hide}
14616 * Look for a child view that matches the specified predicate.
14617 * If this view matches the predicate, return this view.
14618 *
14619 * @param predicate The predicate to evaluate.
14620 * @return The first view that matches the predicate or null.
14621 */
14622 public final View findViewByPredicate(Predicate<View> predicate) {
Jeff Brown4dfbec22011-08-15 14:55:37 -070014623 return findViewByPredicateTraversal(predicate, null);
14624 }
14625
14626 /**
14627 * {@hide}
14628 * Look for a child view that matches the specified predicate,
14629 * starting with the specified view and its descendents and then
14630 * recusively searching the ancestors and siblings of that view
14631 * until this view is reached.
14632 *
14633 * This method is useful in cases where the predicate does not match
14634 * a single unique view (perhaps multiple views use the same id)
14635 * and we are trying to find the view that is "closest" in scope to the
14636 * starting view.
14637 *
14638 * @param start The view to start from.
14639 * @param predicate The predicate to evaluate.
14640 * @return The first view that matches the predicate or null.
14641 */
14642 public final View findViewByPredicateInsideOut(View start, Predicate<View> predicate) {
14643 View childToSkip = null;
14644 for (;;) {
14645 View view = start.findViewByPredicateTraversal(predicate, childToSkip);
14646 if (view != null || start == this) {
14647 return view;
14648 }
14649
14650 ViewParent parent = start.getParent();
14651 if (parent == null || !(parent instanceof View)) {
14652 return null;
14653 }
14654
14655 childToSkip = start;
14656 start = (View) parent;
14657 }
Jeff Brown4e6319b2010-12-13 10:36:51 -080014658 }
14659
14660 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014661 * Sets the identifier for this view. The identifier does not have to be
14662 * unique in this view's hierarchy. The identifier should be a positive
14663 * number.
14664 *
14665 * @see #NO_ID
Philip Milne6c8ea062012-04-03 17:38:43 -070014666 * @see #getId()
14667 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014668 *
14669 * @param id a number used to identify the view
14670 *
14671 * @attr ref android.R.styleable#View_id
14672 */
14673 public void setId(int id) {
14674 mID = id;
14675 }
14676
14677 /**
14678 * {@hide}
14679 *
14680 * @param isRoot true if the view belongs to the root namespace, false
14681 * otherwise
14682 */
14683 public void setIsRootNamespace(boolean isRoot) {
14684 if (isRoot) {
14685 mPrivateFlags |= IS_ROOT_NAMESPACE;
14686 } else {
14687 mPrivateFlags &= ~IS_ROOT_NAMESPACE;
14688 }
14689 }
14690
14691 /**
14692 * {@hide}
14693 *
14694 * @return true if the view belongs to the root namespace, false otherwise
14695 */
14696 public boolean isRootNamespace() {
14697 return (mPrivateFlags&IS_ROOT_NAMESPACE) != 0;
14698 }
14699
14700 /**
14701 * Returns this view's identifier.
14702 *
14703 * @return a positive integer used to identify the view or {@link #NO_ID}
14704 * if the view has no ID
14705 *
Philip Milne6c8ea062012-04-03 17:38:43 -070014706 * @see #setId(int)
14707 * @see #findViewById(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014708 * @attr ref android.R.styleable#View_id
14709 */
14710 @ViewDebug.CapturedViewProperty
14711 public int getId() {
14712 return mID;
14713 }
14714
14715 /**
14716 * Returns this view's tag.
14717 *
14718 * @return the Object stored in this view as a tag
Romain Guyd90a3312009-05-06 14:54:28 -070014719 *
14720 * @see #setTag(Object)
14721 * @see #getTag(int)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014722 */
14723 @ViewDebug.ExportedProperty
14724 public Object getTag() {
14725 return mTag;
14726 }
14727
14728 /**
14729 * Sets the tag associated with this view. A tag can be used to mark
14730 * a view in its hierarchy and does not have to be unique within the
14731 * hierarchy. Tags can also be used to store data within a view without
14732 * resorting to another data structure.
14733 *
14734 * @param tag an Object to tag the view with
Romain Guyd90a3312009-05-06 14:54:28 -070014735 *
14736 * @see #getTag()
14737 * @see #setTag(int, Object)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014738 */
14739 public void setTag(final Object tag) {
14740 mTag = tag;
14741 }
14742
14743 /**
Romain Guyd90a3312009-05-06 14:54:28 -070014744 * Returns the tag associated with this view and the specified key.
14745 *
14746 * @param key The key identifying the tag
14747 *
14748 * @return the Object stored in this view as a tag
14749 *
14750 * @see #setTag(int, Object)
Romain Guy8506ab42009-06-11 17:35:47 -070014751 * @see #getTag()
Romain Guyd90a3312009-05-06 14:54:28 -070014752 */
14753 public Object getTag(int key) {
Adam Powell7db82ac2011-09-22 19:44:04 -070014754 if (mKeyedTags != null) return mKeyedTags.get(key);
Romain Guyd90a3312009-05-06 14:54:28 -070014755 return null;
14756 }
14757
14758 /**
14759 * Sets a tag associated with this view and a key. A tag can be used
14760 * to mark a view in its hierarchy and does not have to be unique within
14761 * the hierarchy. Tags can also be used to store data within a view
14762 * without resorting to another data structure.
14763 *
14764 * The specified key should be an id declared in the resources of the
Scott Maindfe5c202010-06-08 15:54:52 -070014765 * application to ensure it is unique (see the <a
14766 * href={@docRoot}guide/topics/resources/more-resources.html#Id">ID resource type</a>).
14767 * Keys identified as belonging to
Romain Guyd90a3312009-05-06 14:54:28 -070014768 * the Android framework or not associated with any package will cause
14769 * an {@link IllegalArgumentException} to be thrown.
14770 *
14771 * @param key The key identifying the tag
14772 * @param tag An Object to tag the view with
14773 *
14774 * @throws IllegalArgumentException If they specified key is not valid
14775 *
14776 * @see #setTag(Object)
14777 * @see #getTag(int)
14778 */
14779 public void setTag(int key, final Object tag) {
14780 // If the package id is 0x00 or 0x01, it's either an undefined package
14781 // or a framework id
14782 if ((key >>> 24) < 2) {
14783 throw new IllegalArgumentException("The key must be an application-specific "
14784 + "resource id.");
14785 }
14786
Adam Powell2b2f6d62011-09-23 11:15:39 -070014787 setKeyedTag(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014788 }
14789
14790 /**
14791 * Variation of {@link #setTag(int, Object)} that enforces the key to be a
14792 * framework id.
14793 *
14794 * @hide
14795 */
14796 public void setTagInternal(int key, Object tag) {
14797 if ((key >>> 24) != 0x1) {
14798 throw new IllegalArgumentException("The key must be a framework-specific "
14799 + "resource id.");
14800 }
14801
Adam Powell2b2f6d62011-09-23 11:15:39 -070014802 setKeyedTag(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014803 }
14804
Adam Powell2b2f6d62011-09-23 11:15:39 -070014805 private void setKeyedTag(int key, Object tag) {
Adam Powell7db82ac2011-09-22 19:44:04 -070014806 if (mKeyedTags == null) {
14807 mKeyedTags = new SparseArray<Object>();
Romain Guyd90a3312009-05-06 14:54:28 -070014808 }
14809
Adam Powell7db82ac2011-09-22 19:44:04 -070014810 mKeyedTags.put(key, tag);
Romain Guyd90a3312009-05-06 14:54:28 -070014811 }
14812
14813 /**
Romain Guy13922e02009-05-12 17:56:14 -070014814 * @param consistency The type of consistency. See ViewDebug for more information.
14815 *
14816 * @hide
14817 */
14818 protected boolean dispatchConsistencyCheck(int consistency) {
14819 return onConsistencyCheck(consistency);
14820 }
14821
14822 /**
14823 * Method that subclasses should implement to check their consistency. The type of
14824 * consistency check is indicated by the bit field passed as a parameter.
Romain Guy8506ab42009-06-11 17:35:47 -070014825 *
Romain Guy13922e02009-05-12 17:56:14 -070014826 * @param consistency The type of consistency. See ViewDebug for more information.
14827 *
14828 * @throws IllegalStateException if the view is in an inconsistent state.
14829 *
14830 * @hide
14831 */
14832 protected boolean onConsistencyCheck(int consistency) {
14833 boolean result = true;
14834
14835 final boolean checkLayout = (consistency & ViewDebug.CONSISTENCY_LAYOUT) != 0;
14836 final boolean checkDrawing = (consistency & ViewDebug.CONSISTENCY_DRAWING) != 0;
14837
14838 if (checkLayout) {
14839 if (getParent() == null) {
14840 result = false;
14841 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14842 "View " + this + " does not have a parent.");
14843 }
14844
14845 if (mAttachInfo == null) {
14846 result = false;
14847 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14848 "View " + this + " is not attached to a window.");
14849 }
14850 }
14851
14852 if (checkDrawing) {
14853 // Do not check the DIRTY/DRAWN flags because views can call invalidate()
14854 // from their draw() method
14855
14856 if ((mPrivateFlags & DRAWN) != DRAWN &&
14857 (mPrivateFlags & DRAWING_CACHE_VALID) == DRAWING_CACHE_VALID) {
14858 result = false;
14859 android.util.Log.d(ViewDebug.CONSISTENCY_LOG_TAG,
14860 "View " + this + " was invalidated but its drawing cache is valid.");
14861 }
14862 }
14863
14864 return result;
14865 }
14866
14867 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014868 * Prints information about this view in the log output, with the tag
14869 * {@link #VIEW_LOG_TAG}.
14870 *
14871 * @hide
14872 */
14873 public void debug() {
14874 debug(0);
14875 }
14876
14877 /**
14878 * Prints information about this view in the log output, with the tag
14879 * {@link #VIEW_LOG_TAG}. Each line in the output is preceded with an
14880 * indentation defined by the <code>depth</code>.
14881 *
14882 * @param depth the indentation level
14883 *
14884 * @hide
14885 */
14886 protected void debug(int depth) {
14887 String output = debugIndent(depth - 1);
14888
14889 output += "+ " + this;
14890 int id = getId();
14891 if (id != -1) {
14892 output += " (id=" + id + ")";
14893 }
14894 Object tag = getTag();
14895 if (tag != null) {
14896 output += " (tag=" + tag + ")";
14897 }
14898 Log.d(VIEW_LOG_TAG, output);
14899
14900 if ((mPrivateFlags & FOCUSED) != 0) {
14901 output = debugIndent(depth) + " FOCUSED";
14902 Log.d(VIEW_LOG_TAG, output);
14903 }
14904
14905 output = debugIndent(depth);
14906 output += "frame={" + mLeft + ", " + mTop + ", " + mRight
14907 + ", " + mBottom + "} scroll={" + mScrollX + ", " + mScrollY
14908 + "} ";
14909 Log.d(VIEW_LOG_TAG, output);
14910
14911 if (mPaddingLeft != 0 || mPaddingTop != 0 || mPaddingRight != 0
14912 || mPaddingBottom != 0) {
14913 output = debugIndent(depth);
14914 output += "padding={" + mPaddingLeft + ", " + mPaddingTop
14915 + ", " + mPaddingRight + ", " + mPaddingBottom + "}";
14916 Log.d(VIEW_LOG_TAG, output);
14917 }
14918
14919 output = debugIndent(depth);
14920 output += "mMeasureWidth=" + mMeasuredWidth +
14921 " mMeasureHeight=" + mMeasuredHeight;
14922 Log.d(VIEW_LOG_TAG, output);
14923
14924 output = debugIndent(depth);
14925 if (mLayoutParams == null) {
14926 output += "BAD! no layout params";
14927 } else {
14928 output = mLayoutParams.debug(output);
14929 }
14930 Log.d(VIEW_LOG_TAG, output);
14931
14932 output = debugIndent(depth);
14933 output += "flags={";
14934 output += View.printFlags(mViewFlags);
14935 output += "}";
14936 Log.d(VIEW_LOG_TAG, output);
14937
14938 output = debugIndent(depth);
14939 output += "privateFlags={";
14940 output += View.printPrivateFlags(mPrivateFlags);
14941 output += "}";
14942 Log.d(VIEW_LOG_TAG, output);
14943 }
14944
14945 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +090014946 * Creates a string of whitespaces used for indentation.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014947 *
14948 * @param depth the indentation level
14949 * @return a String containing (depth * 2 + 3) * 2 white spaces
14950 *
14951 * @hide
14952 */
14953 protected static String debugIndent(int depth) {
14954 StringBuilder spaces = new StringBuilder((depth * 2 + 3) * 2);
14955 for (int i = 0; i < (depth * 2) + 3; i++) {
14956 spaces.append(' ').append(' ');
14957 }
14958 return spaces.toString();
14959 }
14960
14961 /**
14962 * <p>Return the offset of the widget's text baseline from the widget's top
14963 * boundary. If this widget does not support baseline alignment, this
14964 * method returns -1. </p>
14965 *
14966 * @return the offset of the baseline within the widget's bounds or -1
14967 * if baseline alignment is not supported
14968 */
Konstantin Lopyrevbea95162010-08-10 17:02:18 -070014969 @ViewDebug.ExportedProperty(category = "layout")
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014970 public int getBaseline() {
14971 return -1;
14972 }
14973
14974 /**
14975 * Call this when something has changed which has invalidated the
14976 * layout of this view. This will schedule a layout pass of the view
14977 * tree.
14978 */
14979 public void requestLayout() {
14980 if (ViewDebug.TRACE_HIERARCHY) {
14981 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.REQUEST_LAYOUT);
14982 }
14983
14984 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080014985 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014986
Fabrice Di Meglio4a5268852012-03-30 15:56:48 -070014987 if (mLayoutParams != null) {
14988 mLayoutParams.onResolveLayoutDirection(getResolvedLayoutDirection());
14989 }
14990
14991 if (mParent != null && !mParent.isLayoutRequested()) {
14992 mParent.requestLayout();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080014993 }
14994 }
14995
14996 /**
14997 * Forces this view to be laid out during the next layout pass.
14998 * This method does not call requestLayout() or forceLayout()
14999 * on the parent.
15000 */
15001 public void forceLayout() {
15002 mPrivateFlags |= FORCE_LAYOUT;
Chet Haase5af048c2011-01-24 17:00:32 -080015003 mPrivateFlags |= INVALIDATED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015004 }
15005
15006 /**
15007 * <p>
15008 * This is called to find out how big a view should be. The parent
15009 * supplies constraint information in the width and height parameters.
15010 * </p>
15011 *
15012 * <p>
Romain Guy967e2bf2012-02-07 17:04:34 -080015013 * The actual measurement work of a view is performed in
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015014 * {@link #onMeasure(int, int)}, called by this method. Therefore, only
Romain Guy967e2bf2012-02-07 17:04:34 -080015015 * {@link #onMeasure(int, int)} can and must be overridden by subclasses.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015016 * </p>
15017 *
15018 *
15019 * @param widthMeasureSpec Horizontal space requirements as imposed by the
15020 * parent
15021 * @param heightMeasureSpec Vertical space requirements as imposed by the
15022 * parent
15023 *
15024 * @see #onMeasure(int, int)
15025 */
15026 public final void measure(int widthMeasureSpec, int heightMeasureSpec) {
15027 if ((mPrivateFlags & FORCE_LAYOUT) == FORCE_LAYOUT ||
15028 widthMeasureSpec != mOldWidthMeasureSpec ||
15029 heightMeasureSpec != mOldHeightMeasureSpec) {
15030
15031 // first clears the measured dimension flag
15032 mPrivateFlags &= ~MEASURED_DIMENSION_SET;
15033
15034 if (ViewDebug.TRACE_HIERARCHY) {
15035 ViewDebug.trace(this, ViewDebug.HierarchyTraceType.ON_MEASURE);
15036 }
15037
15038 // measure ourselves, this should set the measured dimension flag back
15039 onMeasure(widthMeasureSpec, heightMeasureSpec);
15040
15041 // flag not set, setMeasuredDimension() was not invoked, we raise
15042 // an exception to warn the developer
15043 if ((mPrivateFlags & MEASURED_DIMENSION_SET) != MEASURED_DIMENSION_SET) {
15044 throw new IllegalStateException("onMeasure() did not set the"
15045 + " measured dimension by calling"
15046 + " setMeasuredDimension()");
15047 }
15048
15049 mPrivateFlags |= LAYOUT_REQUIRED;
15050 }
15051
15052 mOldWidthMeasureSpec = widthMeasureSpec;
15053 mOldHeightMeasureSpec = heightMeasureSpec;
15054 }
15055
15056 /**
15057 * <p>
15058 * Measure the view and its content to determine the measured width and the
15059 * measured height. This method is invoked by {@link #measure(int, int)} and
15060 * should be overriden by subclasses to provide accurate and efficient
15061 * measurement of their contents.
15062 * </p>
15063 *
15064 * <p>
15065 * <strong>CONTRACT:</strong> When overriding this method, you
15066 * <em>must</em> call {@link #setMeasuredDimension(int, int)} to store the
15067 * measured width and height of this view. Failure to do so will trigger an
15068 * <code>IllegalStateException</code>, thrown by
15069 * {@link #measure(int, int)}. Calling the superclass'
15070 * {@link #onMeasure(int, int)} is a valid use.
15071 * </p>
15072 *
15073 * <p>
15074 * The base class implementation of measure defaults to the background size,
15075 * unless a larger size is allowed by the MeasureSpec. Subclasses should
15076 * override {@link #onMeasure(int, int)} to provide better measurements of
15077 * their content.
15078 * </p>
15079 *
15080 * <p>
15081 * If this method is overridden, it is the subclass's responsibility to make
15082 * sure the measured height and width are at least the view's minimum height
15083 * and width ({@link #getSuggestedMinimumHeight()} and
15084 * {@link #getSuggestedMinimumWidth()}).
15085 * </p>
15086 *
15087 * @param widthMeasureSpec horizontal space requirements as imposed by the parent.
15088 * The requirements are encoded with
15089 * {@link android.view.View.MeasureSpec}.
15090 * @param heightMeasureSpec vertical space requirements as imposed by the parent.
15091 * The requirements are encoded with
15092 * {@link android.view.View.MeasureSpec}.
15093 *
15094 * @see #getMeasuredWidth()
15095 * @see #getMeasuredHeight()
15096 * @see #setMeasuredDimension(int, int)
15097 * @see #getSuggestedMinimumHeight()
15098 * @see #getSuggestedMinimumWidth()
15099 * @see android.view.View.MeasureSpec#getMode(int)
15100 * @see android.view.View.MeasureSpec#getSize(int)
15101 */
15102 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
15103 setMeasuredDimension(getDefaultSize(getSuggestedMinimumWidth(), widthMeasureSpec),
15104 getDefaultSize(getSuggestedMinimumHeight(), heightMeasureSpec));
15105 }
15106
15107 /**
15108 * <p>This mehod must be called by {@link #onMeasure(int, int)} to store the
15109 * measured width and measured height. Failing to do so will trigger an
15110 * exception at measurement time.</p>
15111 *
Dianne Hackborn189ee182010-12-02 21:48:53 -080015112 * @param measuredWidth The measured width of this view. May be a complex
15113 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
15114 * {@link #MEASURED_STATE_TOO_SMALL}.
15115 * @param measuredHeight The measured height of this view. May be a complex
15116 * bit mask as defined by {@link #MEASURED_SIZE_MASK} and
15117 * {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015118 */
15119 protected final void setMeasuredDimension(int measuredWidth, int measuredHeight) {
15120 mMeasuredWidth = measuredWidth;
15121 mMeasuredHeight = measuredHeight;
15122
15123 mPrivateFlags |= MEASURED_DIMENSION_SET;
15124 }
15125
15126 /**
Dianne Hackborn189ee182010-12-02 21:48:53 -080015127 * Merge two states as returned by {@link #getMeasuredState()}.
15128 * @param curState The current state as returned from a view or the result
15129 * of combining multiple views.
15130 * @param newState The new view state to combine.
15131 * @return Returns a new integer reflecting the combination of the two
15132 * states.
15133 */
15134 public static int combineMeasuredStates(int curState, int newState) {
15135 return curState | newState;
15136 }
15137
15138 /**
15139 * Version of {@link #resolveSizeAndState(int, int, int)}
15140 * returning only the {@link #MEASURED_SIZE_MASK} bits of the result.
15141 */
15142 public static int resolveSize(int size, int measureSpec) {
15143 return resolveSizeAndState(size, measureSpec, 0) & MEASURED_SIZE_MASK;
15144 }
15145
15146 /**
15147 * Utility to reconcile a desired size and state, with constraints imposed
15148 * by a MeasureSpec. Will take the desired size, unless a different size
15149 * is imposed by the constraints. The returned value is a compound integer,
15150 * with the resolved size in the {@link #MEASURED_SIZE_MASK} bits and
15151 * optionally the bit {@link #MEASURED_STATE_TOO_SMALL} set if the resulting
15152 * size is smaller than the size the view wants to be.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015153 *
15154 * @param size How big the view wants to be
15155 * @param measureSpec Constraints imposed by the parent
Dianne Hackborn189ee182010-12-02 21:48:53 -080015156 * @return Size information bit mask as defined by
15157 * {@link #MEASURED_SIZE_MASK} and {@link #MEASURED_STATE_TOO_SMALL}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015158 */
Dianne Hackborn189ee182010-12-02 21:48:53 -080015159 public static int resolveSizeAndState(int size, int measureSpec, int childMeasuredState) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015160 int result = size;
15161 int specMode = MeasureSpec.getMode(measureSpec);
15162 int specSize = MeasureSpec.getSize(measureSpec);
15163 switch (specMode) {
15164 case MeasureSpec.UNSPECIFIED:
15165 result = size;
15166 break;
15167 case MeasureSpec.AT_MOST:
Dianne Hackborn189ee182010-12-02 21:48:53 -080015168 if (specSize < size) {
15169 result = specSize | MEASURED_STATE_TOO_SMALL;
15170 } else {
15171 result = size;
15172 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015173 break;
15174 case MeasureSpec.EXACTLY:
15175 result = specSize;
15176 break;
15177 }
Dianne Hackborn189ee182010-12-02 21:48:53 -080015178 return result | (childMeasuredState&MEASURED_STATE_MASK);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015179 }
15180
15181 /**
15182 * Utility to return a default size. Uses the supplied size if the
Romain Guy98029c82011-06-17 15:47:07 -070015183 * MeasureSpec imposed no constraints. Will get larger if allowed
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015184 * by the MeasureSpec.
15185 *
15186 * @param size Default size for this view
15187 * @param measureSpec Constraints imposed by the parent
15188 * @return The size this view should be.
15189 */
15190 public static int getDefaultSize(int size, int measureSpec) {
15191 int result = size;
15192 int specMode = MeasureSpec.getMode(measureSpec);
Romain Guy98029c82011-06-17 15:47:07 -070015193 int specSize = MeasureSpec.getSize(measureSpec);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015194
15195 switch (specMode) {
15196 case MeasureSpec.UNSPECIFIED:
15197 result = size;
15198 break;
15199 case MeasureSpec.AT_MOST:
15200 case MeasureSpec.EXACTLY:
15201 result = specSize;
15202 break;
15203 }
15204 return result;
15205 }
15206
15207 /**
15208 * Returns the suggested minimum height that the view should use. This
15209 * returns the maximum of the view's minimum height
15210 * and the background's minimum height
15211 * ({@link android.graphics.drawable.Drawable#getMinimumHeight()}).
15212 * <p>
15213 * When being used in {@link #onMeasure(int, int)}, the caller should still
15214 * ensure the returned height is within the requirements of the parent.
15215 *
15216 * @return The suggested minimum height of the view.
15217 */
15218 protected int getSuggestedMinimumHeight() {
Philip Milne6c8ea062012-04-03 17:38:43 -070015219 return (mBackground == null) ? mMinHeight : max(mMinHeight, mBackground.getMinimumHeight());
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015220
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015221 }
15222
15223 /**
15224 * Returns the suggested minimum width that the view should use. This
15225 * returns the maximum of the view's minimum width)
15226 * and the background's minimum width
15227 * ({@link android.graphics.drawable.Drawable#getMinimumWidth()}).
15228 * <p>
15229 * When being used in {@link #onMeasure(int, int)}, the caller should still
15230 * ensure the returned width is within the requirements of the parent.
15231 *
15232 * @return The suggested minimum width of the view.
15233 */
15234 protected int getSuggestedMinimumWidth() {
Philip Milne6c8ea062012-04-03 17:38:43 -070015235 return (mBackground == null) ? mMinWidth : max(mMinWidth, mBackground.getMinimumWidth());
15236 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015237
Philip Milne6c8ea062012-04-03 17:38:43 -070015238 /**
15239 * Returns the minimum height of the view.
15240 *
15241 * @return the minimum height the view will try to be.
15242 *
15243 * @see #setMinimumHeight(int)
15244 *
15245 * @attr ref android.R.styleable#View_minHeight
15246 */
15247 public int getMinimumHeight() {
15248 return mMinHeight;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015249 }
15250
15251 /**
15252 * Sets the minimum height of the view. It is not guaranteed the view will
15253 * be able to achieve this minimum height (for example, if its parent layout
15254 * constrains it with less available height).
15255 *
15256 * @param minHeight The minimum height the view will try to be.
Philip Milne6c8ea062012-04-03 17:38:43 -070015257 *
15258 * @see #getMinimumHeight()
15259 *
15260 * @attr ref android.R.styleable#View_minHeight
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015261 */
15262 public void setMinimumHeight(int minHeight) {
15263 mMinHeight = minHeight;
Philip Milne6c8ea062012-04-03 17:38:43 -070015264 requestLayout();
15265 }
15266
15267 /**
15268 * Returns the minimum width of the view.
15269 *
15270 * @return the minimum width the view will try to be.
15271 *
15272 * @see #setMinimumWidth(int)
15273 *
15274 * @attr ref android.R.styleable#View_minWidth
15275 */
15276 public int getMinimumWidth() {
15277 return mMinWidth;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015278 }
15279
15280 /**
15281 * Sets the minimum width of the view. It is not guaranteed the view will
15282 * be able to achieve this minimum width (for example, if its parent layout
15283 * constrains it with less available width).
15284 *
15285 * @param minWidth The minimum width the view will try to be.
Philip Milne6c8ea062012-04-03 17:38:43 -070015286 *
15287 * @see #getMinimumWidth()
15288 *
15289 * @attr ref android.R.styleable#View_minWidth
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015290 */
15291 public void setMinimumWidth(int minWidth) {
15292 mMinWidth = minWidth;
Philip Milne6c8ea062012-04-03 17:38:43 -070015293 requestLayout();
15294
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015295 }
15296
15297 /**
15298 * Get the animation currently associated with this view.
15299 *
15300 * @return The animation that is currently playing or
15301 * scheduled to play for this view.
15302 */
15303 public Animation getAnimation() {
15304 return mCurrentAnimation;
15305 }
15306
15307 /**
15308 * Start the specified animation now.
15309 *
15310 * @param animation the animation to start now
15311 */
15312 public void startAnimation(Animation animation) {
15313 animation.setStartTime(Animation.START_ON_FIRST_FRAME);
15314 setAnimation(animation);
Romain Guy0fd89bf2011-01-26 15:41:30 -080015315 invalidateParentCaches();
15316 invalidate(true);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015317 }
15318
15319 /**
15320 * Cancels any animations for this view.
15321 */
15322 public void clearAnimation() {
Romain Guy305a2eb2010-02-09 11:30:44 -080015323 if (mCurrentAnimation != null) {
Romain Guyb4a107d2010-02-09 18:50:08 -080015324 mCurrentAnimation.detach();
Romain Guy305a2eb2010-02-09 11:30:44 -080015325 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015326 mCurrentAnimation = null;
Romain Guy0fd89bf2011-01-26 15:41:30 -080015327 invalidateParentIfNeeded();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015328 }
15329
15330 /**
15331 * Sets the next animation to play for this view.
15332 * If you want the animation to play immediately, use
Chet Haase42428932012-05-11 15:39:07 -070015333 * {@link #startAnimation(android.view.animation.Animation)} instead.
15334 * This method provides allows fine-grained
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015335 * control over the start time and invalidation, but you
15336 * must make sure that 1) the animation has a start time set, and
Chet Haase42428932012-05-11 15:39:07 -070015337 * 2) the view's parent (which controls animations on its children)
15338 * will be invalidated when the animation is supposed to
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015339 * start.
15340 *
15341 * @param animation The next animation, or null.
15342 */
15343 public void setAnimation(Animation animation) {
15344 mCurrentAnimation = animation;
Romain Guyeb378892012-04-12 11:33:14 -070015345
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015346 if (animation != null) {
Romain Guyeb378892012-04-12 11:33:14 -070015347 // If the screen is off assume the animation start time is now instead of
15348 // the next frame we draw. Keeping the START_ON_FIRST_FRAME start time
15349 // would cause the animation to start when the screen turns back on
15350 if (mAttachInfo != null && !mAttachInfo.mScreenOn &&
15351 animation.getStartTime() == Animation.START_ON_FIRST_FRAME) {
15352 animation.setStartTime(AnimationUtils.currentAnimationTimeMillis());
15353 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015354 animation.reset();
15355 }
15356 }
15357
15358 /**
15359 * Invoked by a parent ViewGroup to notify the start of the animation
15360 * currently associated with this view. If you override this method,
15361 * always call super.onAnimationStart();
15362 *
15363 * @see #setAnimation(android.view.animation.Animation)
15364 * @see #getAnimation()
15365 */
15366 protected void onAnimationStart() {
15367 mPrivateFlags |= ANIMATION_STARTED;
15368 }
15369
15370 /**
15371 * Invoked by a parent ViewGroup to notify the end of the animation
15372 * currently associated with this view. If you override this method,
15373 * always call super.onAnimationEnd();
15374 *
15375 * @see #setAnimation(android.view.animation.Animation)
15376 * @see #getAnimation()
15377 */
15378 protected void onAnimationEnd() {
15379 mPrivateFlags &= ~ANIMATION_STARTED;
15380 }
15381
15382 /**
15383 * Invoked if there is a Transform that involves alpha. Subclass that can
15384 * draw themselves with the specified alpha should return true, and then
15385 * respect that alpha when their onDraw() is called. If this returns false
15386 * then the view may be redirected to draw into an offscreen buffer to
15387 * fulfill the request, which will look fine, but may be slower than if the
15388 * subclass handles it internally. The default implementation returns false.
15389 *
15390 * @param alpha The alpha (0..255) to apply to the view's drawing
15391 * @return true if the view can draw with the specified alpha.
15392 */
15393 protected boolean onSetAlpha(int alpha) {
15394 return false;
15395 }
15396
15397 /**
15398 * This is used by the RootView to perform an optimization when
15399 * the view hierarchy contains one or several SurfaceView.
15400 * SurfaceView is always considered transparent, but its children are not,
15401 * therefore all View objects remove themselves from the global transparent
15402 * region (passed as a parameter to this function).
15403 *
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070015404 * @param region The transparent region for this ViewAncestor (window).
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015405 *
15406 * @return Returns true if the effective visibility of the view at this
15407 * point is opaque, regardless of the transparent region; returns false
15408 * if it is possible for underlying windows to be seen behind the view.
15409 *
15410 * {@hide}
15411 */
15412 public boolean gatherTransparentRegion(Region region) {
15413 final AttachInfo attachInfo = mAttachInfo;
15414 if (region != null && attachInfo != null) {
15415 final int pflags = mPrivateFlags;
15416 if ((pflags & SKIP_DRAW) == 0) {
15417 // The SKIP_DRAW flag IS NOT set, so this view draws. We need to
15418 // remove it from the transparent region.
15419 final int[] location = attachInfo.mTransparentLocation;
15420 getLocationInWindow(location);
15421 region.op(location[0], location[1], location[0] + mRight - mLeft,
15422 location[1] + mBottom - mTop, Region.Op.DIFFERENCE);
Philip Milne6c8ea062012-04-03 17:38:43 -070015423 } else if ((pflags & ONLY_DRAWS_BACKGROUND) != 0 && mBackground != null) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015424 // The ONLY_DRAWS_BACKGROUND flag IS set and the background drawable
15425 // exists, so we remove the background drawable's non-transparent
15426 // parts from this transparent region.
Philip Milne6c8ea062012-04-03 17:38:43 -070015427 applyDrawableToTransparentRegion(mBackground, region);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015428 }
15429 }
15430 return true;
15431 }
15432
15433 /**
15434 * Play a sound effect for this view.
15435 *
15436 * <p>The framework will play sound effects for some built in actions, such as
15437 * clicking, but you may wish to play these effects in your widget,
15438 * for instance, for internal navigation.
15439 *
15440 * <p>The sound effect will only be played if sound effects are enabled by the user, and
15441 * {@link #isSoundEffectsEnabled()} is true.
15442 *
15443 * @param soundConstant One of the constants defined in {@link SoundEffectConstants}
15444 */
15445 public void playSoundEffect(int soundConstant) {
15446 if (mAttachInfo == null || mAttachInfo.mRootCallbacks == null || !isSoundEffectsEnabled()) {
15447 return;
15448 }
15449 mAttachInfo.mRootCallbacks.playSoundEffect(soundConstant);
15450 }
15451
15452 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015453 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070015454 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015455 * <p>Provide haptic feedback to the user for this view.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015456 *
15457 * <p>The framework will provide haptic feedback for some built in actions,
15458 * such as long presses, but you may wish to provide feedback for your
15459 * own widget.
15460 *
15461 * <p>The feedback will only be performed if
15462 * {@link #isHapticFeedbackEnabled()} is true.
15463 *
15464 * @param feedbackConstant One of the constants defined in
15465 * {@link HapticFeedbackConstants}
15466 */
15467 public boolean performHapticFeedback(int feedbackConstant) {
15468 return performHapticFeedback(feedbackConstant, 0);
15469 }
15470
15471 /**
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015472 * BZZZTT!!1!
Romain Guy8506ab42009-06-11 17:35:47 -070015473 *
Andy Stadlerf8a7cea2009-04-10 16:24:47 -070015474 * <p>Like {@link #performHapticFeedback(int)}, with additional options.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015475 *
15476 * @param feedbackConstant One of the constants defined in
15477 * {@link HapticFeedbackConstants}
15478 * @param flags Additional flags as per {@link HapticFeedbackConstants}.
15479 */
15480 public boolean performHapticFeedback(int feedbackConstant, int flags) {
15481 if (mAttachInfo == null) {
15482 return false;
15483 }
Romain Guyf607bdc2010-09-10 19:20:06 -070015484 //noinspection SimplifiableIfStatement
Romain Guy812ccbe2010-06-01 14:07:24 -070015485 if ((flags & HapticFeedbackConstants.FLAG_IGNORE_VIEW_SETTING) == 0
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015486 && !isHapticFeedbackEnabled()) {
15487 return false;
15488 }
Romain Guy812ccbe2010-06-01 14:07:24 -070015489 return mAttachInfo.mRootCallbacks.performHapticFeedback(feedbackConstant,
15490 (flags & HapticFeedbackConstants.FLAG_IGNORE_GLOBAL_SETTING) != 0);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015491 }
15492
15493 /**
Dianne Hackborn98014352012-04-05 18:31:41 -070015494 * Request that the visibility of the status bar or other screen/window
15495 * decorations be changed.
15496 *
15497 * <p>This method is used to put the over device UI into temporary modes
15498 * where the user's attention is focused more on the application content,
15499 * by dimming or hiding surrounding system affordances. This is typically
15500 * used in conjunction with {@link Window#FEATURE_ACTION_BAR_OVERLAY
15501 * Window.FEATURE_ACTION_BAR_OVERLAY}, allowing the applications content
15502 * to be placed behind the action bar (and with these flags other system
15503 * affordances) so that smooth transitions between hiding and showing them
15504 * can be done.
15505 *
15506 * <p>Two representative examples of the use of system UI visibility is
15507 * implementing a content browsing application (like a magazine reader)
15508 * and a video playing application.
15509 *
15510 * <p>The first code shows a typical implementation of a View in a content
15511 * browsing application. In this implementation, the application goes
15512 * into a content-oriented mode by hiding the status bar and action bar,
15513 * and putting the navigation elements into lights out mode. The user can
15514 * then interact with content while in this mode. Such an application should
15515 * provide an easy way for the user to toggle out of the mode (such as to
15516 * check information in the status bar or access notifications). In the
15517 * implementation here, this is done simply by tapping on the content.
15518 *
15519 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/ContentBrowserActivity.java
15520 * content}
15521 *
15522 * <p>This second code sample shows a typical implementation of a View
15523 * in a video playing application. In this situation, while the video is
15524 * playing the application would like to go into a complete full-screen mode,
15525 * to use as much of the display as possible for the video. When in this state
15526 * the user can not interact with the application; the system intercepts
Dianne Hackborncf675782012-05-10 15:07:24 -070015527 * touching on the screen to pop the UI out of full screen mode. See
15528 * {@link #fitSystemWindows(Rect)} for a sample layout that goes with this code.
Dianne Hackborn98014352012-04-05 18:31:41 -070015529 *
15530 * {@sample development/samples/ApiDemos/src/com/example/android/apis/view/VideoPlayerActivity.java
15531 * content}
15532 *
15533 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
15534 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN},
15535 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION},
15536 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080015537 */
15538 public void setSystemUiVisibility(int visibility) {
Daniel Sandler70524062011-09-21 00:30:47 -040015539 if (visibility != mSystemUiVisibility) {
15540 mSystemUiVisibility = visibility;
15541 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
15542 mParent.recomputeViewAttributes(this);
15543 }
Joe Onorato664644d2011-01-23 17:53:23 -080015544 }
15545 }
15546
15547 /**
Dianne Hackborn98014352012-04-05 18:31:41 -070015548 * Returns the last {@link #setSystemUiVisibility(int) that this view has requested.
15549 * @return Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
15550 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, {@link #SYSTEM_UI_FLAG_FULLSCREEN},
15551 * {@link #SYSTEM_UI_FLAG_LAYOUT_STABLE}, {@link #SYSTEM_UI_FLAG_LAYOUT_HIDE_NAVIGATION},
15552 * and {@link #SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN}.
Joe Onorato664644d2011-01-23 17:53:23 -080015553 */
Joe Onoratoe595cad2011-01-24 09:22:12 -080015554 public int getSystemUiVisibility() {
Joe Onorato664644d2011-01-23 17:53:23 -080015555 return mSystemUiVisibility;
15556 }
15557
Scott Mainec6331b2011-05-24 16:55:56 -070015558 /**
Dianne Hackborn3a3a6cf2012-03-26 10:24:04 -070015559 * Returns the current system UI visibility that is currently set for
15560 * the entire window. This is the combination of the
15561 * {@link #setSystemUiVisibility(int)} values supplied by all of the
15562 * views in the window.
15563 */
15564 public int getWindowSystemUiVisibility() {
15565 return mAttachInfo != null ? mAttachInfo.mSystemUiVisibility : 0;
15566 }
15567
15568 /**
15569 * Override to find out when the window's requested system UI visibility
15570 * has changed, that is the value returned by {@link #getWindowSystemUiVisibility()}.
15571 * This is different from the callbacks recieved through
15572 * {@link #setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener)}
15573 * in that this is only telling you about the local request of the window,
15574 * not the actual values applied by the system.
15575 */
15576 public void onWindowSystemUiVisibilityChanged(int visible) {
15577 }
15578
15579 /**
15580 * Dispatch callbacks to {@link #onWindowSystemUiVisibilityChanged(int)} down
15581 * the view hierarchy.
15582 */
15583 public void dispatchWindowSystemUiVisiblityChanged(int visible) {
15584 onWindowSystemUiVisibilityChanged(visible);
15585 }
15586
15587 /**
Scott Mainec6331b2011-05-24 16:55:56 -070015588 * Set a listener to receive callbacks when the visibility of the system bar changes.
15589 * @param l The {@link OnSystemUiVisibilityChangeListener} to receive callbacks.
15590 */
Joe Onorato664644d2011-01-23 17:53:23 -080015591 public void setOnSystemUiVisibilityChangeListener(OnSystemUiVisibilityChangeListener l) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015592 getListenerInfo().mOnSystemUiVisibilityChangeListener = l;
Joe Onorato664644d2011-01-23 17:53:23 -080015593 if (mParent != null && mAttachInfo != null && !mAttachInfo.mRecomputeGlobalAttributes) {
15594 mParent.recomputeViewAttributes(this);
15595 }
15596 }
15597
15598 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015599 * Dispatch callbacks to {@link #setOnSystemUiVisibilityChangeListener} down
15600 * the view hierarchy.
Joe Onorato664644d2011-01-23 17:53:23 -080015601 */
15602 public void dispatchSystemUiVisibilityChanged(int visibility) {
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015603 ListenerInfo li = mListenerInfo;
15604 if (li != null && li.mOnSystemUiVisibilityChangeListener != null) {
15605 li.mOnSystemUiVisibilityChangeListener.onSystemUiVisibilityChange(
Joe Onorato6ab77bd2011-01-31 11:21:10 -080015606 visibility & PUBLIC_STATUS_BAR_VISIBILITY_MASK);
Joe Onorato664644d2011-01-23 17:53:23 -080015607 }
15608 }
15609
Dianne Hackborncf675782012-05-10 15:07:24 -070015610 boolean updateLocalSystemUiVisibility(int localValue, int localChanges) {
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015611 int val = (mSystemUiVisibility&~localChanges) | (localValue&localChanges);
15612 if (val != mSystemUiVisibility) {
15613 setSystemUiVisibility(val);
Dianne Hackborncf675782012-05-10 15:07:24 -070015614 return true;
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015615 }
Dianne Hackborncf675782012-05-10 15:07:24 -070015616 return false;
Dianne Hackborn9a230e02011-10-06 11:51:27 -070015617 }
15618
Dianne Hackborn139e5aa2012-05-05 20:36:38 -070015619 /** @hide */
15620 public void setDisabledSystemUiVisibility(int flags) {
15621 if (mAttachInfo != null) {
15622 if (mAttachInfo.mDisabledSystemUiVisibility != flags) {
15623 mAttachInfo.mDisabledSystemUiVisibility = flags;
15624 if (mParent != null) {
15625 mParent.recomputeViewAttributes(this);
15626 }
15627 }
15628 }
15629 }
15630
Joe Onorato664644d2011-01-23 17:53:23 -080015631 /**
Joe Malin32736f02011-01-19 16:14:20 -080015632 * Creates an image that the system displays during the drag and drop
15633 * operation. This is called a &quot;drag shadow&quot;. The default implementation
15634 * for a DragShadowBuilder based on a View returns an image that has exactly the same
15635 * appearance as the given View. The default also positions the center of the drag shadow
15636 * directly under the touch point. If no View is provided (the constructor with no parameters
15637 * is used), and {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} and
15638 * {@link #onDrawShadow(Canvas) onDrawShadow()} are not overriden, then the
15639 * default is an invisible drag shadow.
15640 * <p>
15641 * You are not required to use the View you provide to the constructor as the basis of the
15642 * drag shadow. The {@link #onDrawShadow(Canvas) onDrawShadow()} method allows you to draw
15643 * anything you want as the drag shadow.
15644 * </p>
15645 * <p>
15646 * You pass a DragShadowBuilder object to the system when you start the drag. The system
15647 * calls {@link #onProvideShadowMetrics(Point,Point) onProvideShadowMetrics()} to get the
15648 * size and position of the drag shadow. It uses this data to construct a
15649 * {@link android.graphics.Canvas} object, then it calls {@link #onDrawShadow(Canvas) onDrawShadow()}
15650 * so that your application can draw the shadow image in the Canvas.
15651 * </p>
Joe Fernandez558459f2011-10-13 16:47:36 -070015652 *
15653 * <div class="special reference">
15654 * <h3>Developer Guides</h3>
15655 * <p>For a guide to implementing drag and drop features, read the
15656 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p>
15657 * </div>
Christopher Tate2c095f32010-10-04 14:13:40 -070015658 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015659 public static class DragShadowBuilder {
Christopher Tatea0374192010-10-05 13:06:41 -070015660 private final WeakReference<View> mView;
Christopher Tate2c095f32010-10-04 14:13:40 -070015661
15662 /**
Joe Malin32736f02011-01-19 16:14:20 -080015663 * Constructs a shadow image builder based on a View. By default, the resulting drag
15664 * shadow will have the same appearance and dimensions as the View, with the touch point
15665 * over the center of the View.
15666 * @param view A View. Any View in scope can be used.
Christopher Tate2c095f32010-10-04 14:13:40 -070015667 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015668 public DragShadowBuilder(View view) {
Christopher Tatea0374192010-10-05 13:06:41 -070015669 mView = new WeakReference<View>(view);
Christopher Tate2c095f32010-10-04 14:13:40 -070015670 }
15671
Christopher Tate17ed60c2011-01-18 12:50:26 -080015672 /**
15673 * Construct a shadow builder object with no associated View. This
15674 * constructor variant is only useful when the {@link #onProvideShadowMetrics(Point, Point)}
15675 * and {@link #onDrawShadow(Canvas)} methods are also overridden in order
15676 * to supply the drag shadow's dimensions and appearance without
Joe Malin32736f02011-01-19 16:14:20 -080015677 * reference to any View object. If they are not overridden, then the result is an
15678 * invisible drag shadow.
Christopher Tate17ed60c2011-01-18 12:50:26 -080015679 */
15680 public DragShadowBuilder() {
15681 mView = new WeakReference<View>(null);
15682 }
15683
15684 /**
15685 * Returns the View object that had been passed to the
15686 * {@link #View.DragShadowBuilder(View)}
15687 * constructor. If that View parameter was {@code null} or if the
15688 * {@link #View.DragShadowBuilder()}
15689 * constructor was used to instantiate the builder object, this method will return
15690 * null.
15691 *
15692 * @return The View object associate with this builder object.
15693 */
Romain Guy5c22a8c2011-05-13 11:48:45 -070015694 @SuppressWarnings({"JavadocReference"})
Chris Tate6b391282010-10-14 15:48:59 -070015695 final public View getView() {
15696 return mView.get();
15697 }
15698
Christopher Tate2c095f32010-10-04 14:13:40 -070015699 /**
Joe Malin32736f02011-01-19 16:14:20 -080015700 * Provides the metrics for the shadow image. These include the dimensions of
15701 * the shadow image, and the point within that shadow that should
Christopher Tate2c095f32010-10-04 14:13:40 -070015702 * be centered under the touch location while dragging.
15703 * <p>
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015704 * The default implementation sets the dimensions of the shadow to be the
Joe Malin32736f02011-01-19 16:14:20 -080015705 * same as the dimensions of the View itself and centers the shadow under
15706 * the touch point.
15707 * </p>
Christopher Tate2c095f32010-10-04 14:13:40 -070015708 *
Joe Malin32736f02011-01-19 16:14:20 -080015709 * @param shadowSize A {@link android.graphics.Point} containing the width and height
15710 * of the shadow image. Your application must set {@link android.graphics.Point#x} to the
15711 * desired width and must set {@link android.graphics.Point#y} to the desired height of the
15712 * image.
15713 *
15714 * @param shadowTouchPoint A {@link android.graphics.Point} for the position within the
15715 * shadow image that should be underneath the touch point during the drag and drop
15716 * operation. Your application must set {@link android.graphics.Point#x} to the
15717 * X coordinate and {@link android.graphics.Point#y} to the Y coordinate of this position.
Christopher Tate2c095f32010-10-04 14:13:40 -070015718 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015719 public void onProvideShadowMetrics(Point shadowSize, Point shadowTouchPoint) {
Christopher Tatea0374192010-10-05 13:06:41 -070015720 final View view = mView.get();
15721 if (view != null) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015722 shadowSize.set(view.getWidth(), view.getHeight());
15723 shadowTouchPoint.set(shadowSize.x / 2, shadowSize.y / 2);
Christopher Tatea0374192010-10-05 13:06:41 -070015724 } else {
15725 Log.e(View.VIEW_LOG_TAG, "Asked for drag thumb metrics but no view");
15726 }
Christopher Tate2c095f32010-10-04 14:13:40 -070015727 }
15728
15729 /**
Joe Malin32736f02011-01-19 16:14:20 -080015730 * Draws the shadow image. The system creates the {@link android.graphics.Canvas} object
15731 * based on the dimensions it received from the
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015732 * {@link #onProvideShadowMetrics(Point, Point)} callback.
Christopher Tate2c095f32010-10-04 14:13:40 -070015733 *
Joe Malin32736f02011-01-19 16:14:20 -080015734 * @param canvas A {@link android.graphics.Canvas} object in which to draw the shadow image.
Christopher Tate2c095f32010-10-04 14:13:40 -070015735 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015736 public void onDrawShadow(Canvas canvas) {
Christopher Tatea0374192010-10-05 13:06:41 -070015737 final View view = mView.get();
15738 if (view != null) {
15739 view.draw(canvas);
15740 } else {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015741 Log.e(View.VIEW_LOG_TAG, "Asked to draw drag shadow but no view");
Christopher Tatea0374192010-10-05 13:06:41 -070015742 }
Christopher Tate2c095f32010-10-04 14:13:40 -070015743 }
15744 }
15745
15746 /**
Joe Malin32736f02011-01-19 16:14:20 -080015747 * Starts a drag and drop operation. When your application calls this method, it passes a
15748 * {@link android.view.View.DragShadowBuilder} object to the system. The
15749 * system calls this object's {@link DragShadowBuilder#onProvideShadowMetrics(Point, Point)}
15750 * to get metrics for the drag shadow, and then calls the object's
15751 * {@link DragShadowBuilder#onDrawShadow(Canvas)} to draw the drag shadow itself.
15752 * <p>
15753 * Once the system has the drag shadow, it begins the drag and drop operation by sending
15754 * drag events to all the View objects in your application that are currently visible. It does
15755 * this either by calling the View object's drag listener (an implementation of
15756 * {@link android.view.View.OnDragListener#onDrag(View,DragEvent) onDrag()} or by calling the
15757 * View object's {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} method.
15758 * Both are passed a {@link android.view.DragEvent} object that has a
15759 * {@link android.view.DragEvent#getAction()} value of
15760 * {@link android.view.DragEvent#ACTION_DRAG_STARTED}.
15761 * </p>
15762 * <p>
15763 * Your application can invoke startDrag() on any attached View object. The View object does not
15764 * need to be the one used in {@link android.view.View.DragShadowBuilder}, nor does it need to
15765 * be related to the View the user selected for dragging.
15766 * </p>
15767 * @param data A {@link android.content.ClipData} object pointing to the data to be
15768 * transferred by the drag and drop operation.
15769 * @param shadowBuilder A {@link android.view.View.DragShadowBuilder} object for building the
15770 * drag shadow.
15771 * @param myLocalState An {@link java.lang.Object} containing local data about the drag and
15772 * drop operation. This Object is put into every DragEvent object sent by the system during the
15773 * current drag.
15774 * <p>
15775 * myLocalState is a lightweight mechanism for the sending information from the dragged View
15776 * to the target Views. For example, it can contain flags that differentiate between a
15777 * a copy operation and a move operation.
15778 * </p>
15779 * @param flags Flags that control the drag and drop operation. No flags are currently defined,
15780 * so the parameter should be set to 0.
15781 * @return {@code true} if the method completes successfully, or
15782 * {@code false} if it fails anywhere. Returning {@code false} means the system was unable to
15783 * do a drag, and so no drag operation is in progress.
Christopher Tatea53146c2010-09-07 11:57:52 -070015784 */
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015785 public final boolean startDrag(ClipData data, DragShadowBuilder shadowBuilder,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015786 Object myLocalState, int flags) {
Christopher Tate2c095f32010-10-04 14:13:40 -070015787 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015788 Log.d(VIEW_LOG_TAG, "startDrag: data=" + data + " flags=" + flags);
Christopher Tatea53146c2010-09-07 11:57:52 -070015789 }
15790 boolean okay = false;
15791
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015792 Point shadowSize = new Point();
15793 Point shadowTouchPoint = new Point();
15794 shadowBuilder.onProvideShadowMetrics(shadowSize, shadowTouchPoint);
Christopher Tate2c095f32010-10-04 14:13:40 -070015795
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015796 if ((shadowSize.x < 0) || (shadowSize.y < 0) ||
15797 (shadowTouchPoint.x < 0) || (shadowTouchPoint.y < 0)) {
15798 throw new IllegalStateException("Drag shadow dimensions must not be negative");
Christopher Tate2c095f32010-10-04 14:13:40 -070015799 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015800
Chris Tatea32dcf72010-10-14 12:13:50 -070015801 if (ViewDebug.DEBUG_DRAG) {
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015802 Log.d(VIEW_LOG_TAG, "drag shadow: width=" + shadowSize.x + " height=" + shadowSize.y
15803 + " shadowX=" + shadowTouchPoint.x + " shadowY=" + shadowTouchPoint.y);
Chris Tatea32dcf72010-10-14 12:13:50 -070015804 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015805 Surface surface = new Surface();
15806 try {
15807 IBinder token = mAttachInfo.mSession.prepareDrag(mAttachInfo.mWindow,
Christopher Tate02d2b3b2011-01-10 20:43:53 -080015808 flags, shadowSize.x, shadowSize.y, surface);
Christopher Tate2c095f32010-10-04 14:13:40 -070015809 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "prepareDrag returned token=" + token
Christopher Tatea53146c2010-09-07 11:57:52 -070015810 + " surface=" + surface);
15811 if (token != null) {
15812 Canvas canvas = surface.lockCanvas(null);
Romain Guy0bb56672010-10-01 00:25:02 -070015813 try {
Chris Tate6b391282010-10-14 15:48:59 -070015814 canvas.drawColor(0, PorterDuff.Mode.CLEAR);
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015815 shadowBuilder.onDrawShadow(canvas);
Romain Guy0bb56672010-10-01 00:25:02 -070015816 } finally {
15817 surface.unlockCanvasAndPost(canvas);
15818 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015819
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070015820 final ViewRootImpl root = getViewRootImpl();
Christopher Tate407b4e92010-11-30 17:14:08 -080015821
15822 // Cache the local state object for delivery with DragEvents
15823 root.setLocalDragState(myLocalState);
15824
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015825 // repurpose 'shadowSize' for the last touch point
15826 root.getLastTouchPoint(shadowSize);
Christopher Tate2c095f32010-10-04 14:13:40 -070015827
Christopher Tatea53146c2010-09-07 11:57:52 -070015828 okay = mAttachInfo.mSession.performDrag(mAttachInfo.mWindow, token,
Christopher Tate36d4c3f2011-01-07 13:34:24 -080015829 shadowSize.x, shadowSize.y,
15830 shadowTouchPoint.x, shadowTouchPoint.y, data);
Christopher Tate2c095f32010-10-04 14:13:40 -070015831 if (ViewDebug.DEBUG_DRAG) Log.d(VIEW_LOG_TAG, "performDrag returned " + okay);
Christopher Tate8f73b5d2011-09-12 15:22:12 -070015832
15833 // Off and running! Release our local surface instance; the drag
15834 // shadow surface is now managed by the system process.
15835 surface.release();
Christopher Tatea53146c2010-09-07 11:57:52 -070015836 }
15837 } catch (Exception e) {
15838 Log.e(VIEW_LOG_TAG, "Unable to initiate drag", e);
15839 surface.destroy();
15840 }
15841
15842 return okay;
15843 }
15844
Christopher Tatea53146c2010-09-07 11:57:52 -070015845 /**
Joe Malin32736f02011-01-19 16:14:20 -080015846 * Handles drag events sent by the system following a call to
15847 * {@link android.view.View#startDrag(ClipData,DragShadowBuilder,Object,int) startDrag()}.
15848 *<p>
15849 * When the system calls this method, it passes a
15850 * {@link android.view.DragEvent} object. A call to
15851 * {@link android.view.DragEvent#getAction()} returns one of the action type constants defined
15852 * in DragEvent. The method uses these to determine what is happening in the drag and drop
15853 * operation.
15854 * @param event The {@link android.view.DragEvent} sent by the system.
15855 * The {@link android.view.DragEvent#getAction()} method returns an action type constant defined
15856 * in DragEvent, indicating the type of drag event represented by this object.
15857 * @return {@code true} if the method was successful, otherwise {@code false}.
15858 * <p>
15859 * The method should return {@code true} in response to an action type of
15860 * {@link android.view.DragEvent#ACTION_DRAG_STARTED} to receive drag events for the current
15861 * operation.
15862 * </p>
15863 * <p>
15864 * The method should also return {@code true} in response to an action type of
15865 * {@link android.view.DragEvent#ACTION_DROP} if it consumed the drop, or
15866 * {@code false} if it didn't.
15867 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070015868 */
Christopher Tate5ada6cb2010-10-05 14:15:29 -070015869 public boolean onDragEvent(DragEvent event) {
Christopher Tatea53146c2010-09-07 11:57:52 -070015870 return false;
15871 }
15872
15873 /**
Joe Malin32736f02011-01-19 16:14:20 -080015874 * Detects if this View is enabled and has a drag event listener.
15875 * If both are true, then it calls the drag event listener with the
15876 * {@link android.view.DragEvent} it received. If the drag event listener returns
15877 * {@code true}, then dispatchDragEvent() returns {@code true}.
15878 * <p>
15879 * For all other cases, the method calls the
15880 * {@link android.view.View#onDragEvent(DragEvent) onDragEvent()} drag event handler
15881 * method and returns its result.
15882 * </p>
15883 * <p>
15884 * This ensures that a drag event is always consumed, even if the View does not have a drag
15885 * event listener. However, if the View has a listener and the listener returns true, then
15886 * onDragEvent() is not called.
15887 * </p>
Christopher Tatea53146c2010-09-07 11:57:52 -070015888 */
15889 public boolean dispatchDragEvent(DragEvent event) {
Romain Guy676b1732011-02-14 14:45:33 -080015890 //noinspection SimplifiableIfStatement
Dianne Hackborn0500b3c2011-11-01 15:28:43 -070015891 ListenerInfo li = mListenerInfo;
15892 if (li != null && li.mOnDragListener != null && (mViewFlags & ENABLED_MASK) == ENABLED
15893 && li.mOnDragListener.onDrag(this, event)) {
Chris Tate32affef2010-10-18 15:29:21 -070015894 return true;
15895 }
Christopher Tatea53146c2010-09-07 11:57:52 -070015896 return onDragEvent(event);
15897 }
15898
Christopher Tate3d4bf172011-03-28 16:16:46 -070015899 boolean canAcceptDrag() {
15900 return (mPrivateFlags2 & DRAG_CAN_ACCEPT) != 0;
15901 }
15902
Christopher Tatea53146c2010-09-07 11:57:52 -070015903 /**
Dianne Hackbornffa42482009-09-23 22:20:11 -070015904 * This needs to be a better API (NOT ON VIEW) before it is exposed. If
15905 * it is ever exposed at all.
Dianne Hackborn29e4a3c2009-09-30 22:35:40 -070015906 * @hide
Dianne Hackbornffa42482009-09-23 22:20:11 -070015907 */
15908 public void onCloseSystemDialogs(String reason) {
15909 }
Joe Malin32736f02011-01-19 16:14:20 -080015910
Dianne Hackbornffa42482009-09-23 22:20:11 -070015911 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015912 * Given a Drawable whose bounds have been set to draw into this view,
Romain Guy5c22a8c2011-05-13 11:48:45 -070015913 * update a Region being computed for
15914 * {@link #gatherTransparentRegion(android.graphics.Region)} so
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015915 * that any non-transparent parts of the Drawable are removed from the
15916 * given transparent region.
15917 *
15918 * @param dr The Drawable whose transparency is to be applied to the region.
15919 * @param region A Region holding the current transparency information,
15920 * where any parts of the region that are set are considered to be
15921 * transparent. On return, this region will be modified to have the
15922 * transparency information reduced by the corresponding parts of the
15923 * Drawable that are not transparent.
15924 * {@hide}
15925 */
15926 public void applyDrawableToTransparentRegion(Drawable dr, Region region) {
15927 if (DBG) {
15928 Log.i("View", "Getting transparent region for: " + this);
15929 }
15930 final Region r = dr.getTransparentRegion();
15931 final Rect db = dr.getBounds();
15932 final AttachInfo attachInfo = mAttachInfo;
15933 if (r != null && attachInfo != null) {
15934 final int w = getRight()-getLeft();
15935 final int h = getBottom()-getTop();
15936 if (db.left > 0) {
15937 //Log.i("VIEW", "Drawable left " + db.left + " > view 0");
15938 r.op(0, 0, db.left, h, Region.Op.UNION);
15939 }
15940 if (db.right < w) {
15941 //Log.i("VIEW", "Drawable right " + db.right + " < view " + w);
15942 r.op(db.right, 0, w, h, Region.Op.UNION);
15943 }
15944 if (db.top > 0) {
15945 //Log.i("VIEW", "Drawable top " + db.top + " > view 0");
15946 r.op(0, 0, w, db.top, Region.Op.UNION);
15947 }
15948 if (db.bottom < h) {
15949 //Log.i("VIEW", "Drawable bottom " + db.bottom + " < view " + h);
15950 r.op(0, db.bottom, w, h, Region.Op.UNION);
15951 }
15952 final int[] location = attachInfo.mTransparentLocation;
15953 getLocationInWindow(location);
15954 r.translate(location[0], location[1]);
15955 region.op(r, Region.Op.INTERSECT);
15956 } else {
15957 region.op(db, Region.Op.DIFFERENCE);
15958 }
15959 }
15960
Patrick Dubroye0a799a2011-05-04 16:19:22 -070015961 private void checkForLongClick(int delayOffset) {
15962 if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
15963 mHasPerformedLongPress = false;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015964
Patrick Dubroye0a799a2011-05-04 16:19:22 -070015965 if (mPendingCheckForLongPress == null) {
15966 mPendingCheckForLongPress = new CheckForLongPress();
15967 }
15968 mPendingCheckForLongPress.rememberWindowAttachCount();
15969 postDelayed(mPendingCheckForLongPress,
15970 ViewConfiguration.getLongPressTimeout() - delayOffset);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015971 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015972 }
15973
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015974 /**
15975 * Inflate a view from an XML resource. This convenience method wraps the {@link
15976 * LayoutInflater} class, which provides a full range of options for view inflation.
15977 *
15978 * @param context The Context object for your activity or application.
15979 * @param resource The resource ID to inflate
15980 * @param root A view group that will be the parent. Used to properly inflate the
15981 * layout_* parameters.
15982 * @see LayoutInflater
15983 */
15984 public static View inflate(Context context, int resource, ViewGroup root) {
15985 LayoutInflater factory = LayoutInflater.from(context);
15986 return factory.inflate(resource, root);
15987 }
Romain Guy33e72ae2010-07-17 12:40:29 -070015988
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080015989 /**
Adam Powell637d3372010-08-25 14:37:03 -070015990 * Scroll the view with standard behavior for scrolling beyond the normal
15991 * content boundaries. Views that call this method should override
15992 * {@link #onOverScrolled(int, int, boolean, boolean)} to respond to the
15993 * results of an over-scroll operation.
15994 *
15995 * Views can use this method to handle any touch or fling-based scrolling.
15996 *
15997 * @param deltaX Change in X in pixels
15998 * @param deltaY Change in Y in pixels
15999 * @param scrollX Current X scroll value in pixels before applying deltaX
16000 * @param scrollY Current Y scroll value in pixels before applying deltaY
16001 * @param scrollRangeX Maximum content scroll range along the X axis
16002 * @param scrollRangeY Maximum content scroll range along the Y axis
16003 * @param maxOverScrollX Number of pixels to overscroll by in either direction
16004 * along the X axis.
16005 * @param maxOverScrollY Number of pixels to overscroll by in either direction
16006 * along the Y axis.
16007 * @param isTouchEvent true if this scroll operation is the result of a touch event.
16008 * @return true if scrolling was clamped to an over-scroll boundary along either
16009 * axis, false otherwise.
16010 */
Romain Guy7b5b6ab2011-03-14 18:05:08 -070016011 @SuppressWarnings({"UnusedParameters"})
Adam Powell637d3372010-08-25 14:37:03 -070016012 protected boolean overScrollBy(int deltaX, int deltaY,
16013 int scrollX, int scrollY,
16014 int scrollRangeX, int scrollRangeY,
16015 int maxOverScrollX, int maxOverScrollY,
16016 boolean isTouchEvent) {
16017 final int overScrollMode = mOverScrollMode;
16018 final boolean canScrollHorizontal =
16019 computeHorizontalScrollRange() > computeHorizontalScrollExtent();
16020 final boolean canScrollVertical =
16021 computeVerticalScrollRange() > computeVerticalScrollExtent();
16022 final boolean overScrollHorizontal = overScrollMode == OVER_SCROLL_ALWAYS ||
16023 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollHorizontal);
16024 final boolean overScrollVertical = overScrollMode == OVER_SCROLL_ALWAYS ||
16025 (overScrollMode == OVER_SCROLL_IF_CONTENT_SCROLLS && canScrollVertical);
16026
16027 int newScrollX = scrollX + deltaX;
16028 if (!overScrollHorizontal) {
16029 maxOverScrollX = 0;
16030 }
16031
16032 int newScrollY = scrollY + deltaY;
16033 if (!overScrollVertical) {
16034 maxOverScrollY = 0;
16035 }
16036
16037 // Clamp values if at the limits and record
16038 final int left = -maxOverScrollX;
16039 final int right = maxOverScrollX + scrollRangeX;
16040 final int top = -maxOverScrollY;
16041 final int bottom = maxOverScrollY + scrollRangeY;
16042
16043 boolean clampedX = false;
16044 if (newScrollX > right) {
16045 newScrollX = right;
16046 clampedX = true;
16047 } else if (newScrollX < left) {
16048 newScrollX = left;
16049 clampedX = true;
16050 }
16051
16052 boolean clampedY = false;
16053 if (newScrollY > bottom) {
16054 newScrollY = bottom;
16055 clampedY = true;
16056 } else if (newScrollY < top) {
16057 newScrollY = top;
16058 clampedY = true;
16059 }
16060
16061 onOverScrolled(newScrollX, newScrollY, clampedX, clampedY);
16062
16063 return clampedX || clampedY;
16064 }
16065
16066 /**
16067 * Called by {@link #overScrollBy(int, int, int, int, int, int, int, int, boolean)} to
16068 * respond to the results of an over-scroll operation.
16069 *
16070 * @param scrollX New X scroll value in pixels
16071 * @param scrollY New Y scroll value in pixels
16072 * @param clampedX True if scrollX was clamped to an over-scroll boundary
16073 * @param clampedY True if scrollY was clamped to an over-scroll boundary
16074 */
16075 protected void onOverScrolled(int scrollX, int scrollY,
16076 boolean clampedX, boolean clampedY) {
16077 // Intentionally empty.
16078 }
16079
16080 /**
16081 * Returns the over-scroll mode for this view. The result will be
16082 * one of {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
16083 * (allow over-scrolling only if the view content is larger than the container),
16084 * or {@link #OVER_SCROLL_NEVER}.
16085 *
16086 * @return This view's over-scroll mode.
16087 */
16088 public int getOverScrollMode() {
16089 return mOverScrollMode;
16090 }
16091
16092 /**
16093 * Set the over-scroll mode for this view. Valid over-scroll modes are
16094 * {@link #OVER_SCROLL_ALWAYS} (default), {@link #OVER_SCROLL_IF_CONTENT_SCROLLS}
16095 * (allow over-scrolling only if the view content is larger than the container),
16096 * or {@link #OVER_SCROLL_NEVER}.
16097 *
16098 * Setting the over-scroll mode of a view will have an effect only if the
16099 * view is capable of scrolling.
16100 *
16101 * @param overScrollMode The new over-scroll mode for this view.
16102 */
16103 public void setOverScrollMode(int overScrollMode) {
16104 if (overScrollMode != OVER_SCROLL_ALWAYS &&
16105 overScrollMode != OVER_SCROLL_IF_CONTENT_SCROLLS &&
16106 overScrollMode != OVER_SCROLL_NEVER) {
16107 throw new IllegalArgumentException("Invalid overscroll mode " + overScrollMode);
16108 }
16109 mOverScrollMode = overScrollMode;
16110 }
16111
16112 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080016113 * Gets a scale factor that determines the distance the view should scroll
16114 * vertically in response to {@link MotionEvent#ACTION_SCROLL}.
16115 * @return The vertical scroll scale factor.
16116 * @hide
16117 */
16118 protected float getVerticalScrollFactor() {
16119 if (mVerticalScrollFactor == 0) {
16120 TypedValue outValue = new TypedValue();
16121 if (!mContext.getTheme().resolveAttribute(
16122 com.android.internal.R.attr.listPreferredItemHeight, outValue, true)) {
16123 throw new IllegalStateException(
16124 "Expected theme to define listPreferredItemHeight.");
16125 }
16126 mVerticalScrollFactor = outValue.getDimension(
16127 mContext.getResources().getDisplayMetrics());
16128 }
16129 return mVerticalScrollFactor;
16130 }
16131
16132 /**
16133 * Gets a scale factor that determines the distance the view should scroll
16134 * horizontally in response to {@link MotionEvent#ACTION_SCROLL}.
16135 * @return The horizontal scroll scale factor.
16136 * @hide
16137 */
16138 protected float getHorizontalScrollFactor() {
16139 // TODO: Should use something else.
16140 return getVerticalScrollFactor();
16141 }
16142
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016143 /**
16144 * Return the value specifying the text direction or policy that was set with
16145 * {@link #setTextDirection(int)}.
16146 *
16147 * @return the defined text direction. It can be one of:
16148 *
16149 * {@link #TEXT_DIRECTION_INHERIT},
16150 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16151 * {@link #TEXT_DIRECTION_ANY_RTL},
16152 * {@link #TEXT_DIRECTION_LTR},
16153 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016154 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016155 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016156 */
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016157 @ViewDebug.ExportedProperty(category = "text", mapping = {
16158 @ViewDebug.IntToString(from = TEXT_DIRECTION_INHERIT, to = "INHERIT"),
16159 @ViewDebug.IntToString(from = TEXT_DIRECTION_FIRST_STRONG, to = "FIRST_STRONG"),
16160 @ViewDebug.IntToString(from = TEXT_DIRECTION_ANY_RTL, to = "ANY_RTL"),
16161 @ViewDebug.IntToString(from = TEXT_DIRECTION_LTR, to = "LTR"),
16162 @ViewDebug.IntToString(from = TEXT_DIRECTION_RTL, to = "RTL"),
16163 @ViewDebug.IntToString(from = TEXT_DIRECTION_LOCALE, to = "LOCALE")
16164 })
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016165 public int getTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016166 return (mPrivateFlags2 & TEXT_DIRECTION_MASK) >> TEXT_DIRECTION_MASK_SHIFT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016167 }
16168
16169 /**
16170 * Set the text direction.
16171 *
16172 * @param textDirection the direction to set. Should be one of:
16173 *
16174 * {@link #TEXT_DIRECTION_INHERIT},
16175 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16176 * {@link #TEXT_DIRECTION_ANY_RTL},
16177 * {@link #TEXT_DIRECTION_LTR},
16178 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016179 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016180 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016181 */
16182 public void setTextDirection(int textDirection) {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016183 if (getTextDirection() != textDirection) {
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016184 // Reset the current text direction and the resolved one
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016185 mPrivateFlags2 &= ~TEXT_DIRECTION_MASK;
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016186 resetResolvedTextDirection();
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016187 // Set the new text direction
16188 mPrivateFlags2 |= ((textDirection << TEXT_DIRECTION_MASK_SHIFT) & TEXT_DIRECTION_MASK);
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016189 // Refresh
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016190 requestLayout();
Fabrice Di Meglio827d5c02012-03-23 15:13:41 -070016191 invalidate(true);
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016192 }
16193 }
16194
16195 /**
16196 * Return the resolved text direction.
16197 *
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016198 * This needs resolution if the value is TEXT_DIRECTION_INHERIT. The resolution matches
16199 * {@link #getTextDirection()}if it is not TEXT_DIRECTION_INHERIT, otherwise resolution proceeds
16200 * up the parent chain of the view. if there is no parent, then it will return the default
16201 * {@link #TEXT_DIRECTION_FIRST_STRONG}.
16202 *
16203 * @return the resolved text direction. Returns one of:
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016204 *
Doug Feltcb3791202011-07-07 11:57:48 -070016205 * {@link #TEXT_DIRECTION_FIRST_STRONG}
16206 * {@link #TEXT_DIRECTION_ANY_RTL},
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016207 * {@link #TEXT_DIRECTION_LTR},
16208 * {@link #TEXT_DIRECTION_RTL},
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016209 * {@link #TEXT_DIRECTION_LOCALE}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016210 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016211 */
16212 public int getResolvedTextDirection() {
Fabrice Di Meglio22ab7752012-03-23 16:39:26 -070016213 // The text direction will be resolved only if needed
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016214 if ((mPrivateFlags2 & TEXT_DIRECTION_RESOLVED) != TEXT_DIRECTION_RESOLVED) {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016215 resolveTextDirection();
16216 }
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016217 return (mPrivateFlags2 & TEXT_DIRECTION_RESOLVED_MASK) >> TEXT_DIRECTION_RESOLVED_MASK_SHIFT;
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016218 }
16219
16220 /**
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016221 * Resolve the text direction. Will call {@link View#onResolvedTextDirectionChanged} when
16222 * resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016223 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016224 */
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016225 public void resolveTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016226 // Reset any previous text direction resolution
16227 mPrivateFlags2 &= ~(TEXT_DIRECTION_RESOLVED | TEXT_DIRECTION_RESOLVED_MASK);
16228
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016229 if (hasRtlSupport()) {
16230 // Set resolved text direction flag depending on text direction flag
16231 final int textDirection = getTextDirection();
16232 switch(textDirection) {
16233 case TEXT_DIRECTION_INHERIT:
16234 if (canResolveTextDirection()) {
16235 ViewGroup viewGroup = ((ViewGroup) mParent);
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016236
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016237 // Set current resolved direction to the same value as the parent's one
16238 final int parentResolvedDirection = viewGroup.getResolvedTextDirection();
16239 switch (parentResolvedDirection) {
16240 case TEXT_DIRECTION_FIRST_STRONG:
16241 case TEXT_DIRECTION_ANY_RTL:
16242 case TEXT_DIRECTION_LTR:
16243 case TEXT_DIRECTION_RTL:
16244 case TEXT_DIRECTION_LOCALE:
16245 mPrivateFlags2 |=
16246 (parentResolvedDirection << TEXT_DIRECTION_RESOLVED_MASK_SHIFT);
16247 break;
16248 default:
16249 // Default resolved direction is "first strong" heuristic
16250 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
16251 }
16252 } else {
16253 // We cannot do the resolution if there is no parent, so use the default one
16254 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016255 }
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016256 break;
16257 case TEXT_DIRECTION_FIRST_STRONG:
16258 case TEXT_DIRECTION_ANY_RTL:
16259 case TEXT_DIRECTION_LTR:
16260 case TEXT_DIRECTION_RTL:
16261 case TEXT_DIRECTION_LOCALE:
16262 // Resolved direction is the same as text direction
16263 mPrivateFlags2 |= (textDirection << TEXT_DIRECTION_RESOLVED_MASK_SHIFT);
16264 break;
16265 default:
16266 // Default resolved direction is "first strong" heuristic
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016267 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Meglio59dfce82012-04-02 16:17:20 -070016268 }
16269 } else {
16270 // Default resolved direction is "first strong" heuristic
16271 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED_DEFAULT;
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016272 }
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016273
16274 // Set to resolved
16275 mPrivateFlags2 |= TEXT_DIRECTION_RESOLVED;
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016276 onResolvedTextDirectionChanged();
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016277 }
16278
16279 /**
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016280 * Called when text direction has been resolved. Subclasses that care about text direction
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016281 * resolution should override this method.
16282 *
16283 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016284 * @hide
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016285 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016286 public void onResolvedTextDirectionChanged() {
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016287 }
16288
16289 /**
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016290 * Check if text direction resolution can be done.
16291 *
16292 * @return true if text direction resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016293 * @hide
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016294 */
16295 public boolean canResolveTextDirection() {
16296 switch (getTextDirection()) {
16297 case TEXT_DIRECTION_INHERIT:
16298 return (mParent != null) && (mParent instanceof ViewGroup);
16299 default:
16300 return true;
16301 }
16302 }
16303
16304 /**
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016305 * Reset resolved text direction. Text direction can be resolved with a call to
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016306 * getResolvedTextDirection(). Will call {@link View#onResolvedTextDirectionReset} when
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016307 * reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016308 * @hide
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016309 */
16310 public void resetResolvedTextDirection() {
Fabrice Di Megliob934db72012-03-20 14:33:01 -070016311 mPrivateFlags2 &= ~(TEXT_DIRECTION_RESOLVED | TEXT_DIRECTION_RESOLVED_MASK);
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016312 onResolvedTextDirectionReset();
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016313 }
16314
16315 /**
16316 * Called when text direction is reset. Subclasses that care about text direction reset should
16317 * override this method and do a reset of the text direction of their children. The default
16318 * implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016319 * @hide
Fabrice Di Meglio6d3d5052012-02-15 20:22:56 -080016320 */
Fabrice Di Megliodd3ef2c2012-03-01 16:37:17 -080016321 public void onResolvedTextDirectionReset() {
Fabrice Di Meglio22268862011-06-27 18:13:18 -070016322 }
16323
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016324 /**
16325 * Return the value specifying the text alignment or policy that was set with
16326 * {@link #setTextAlignment(int)}.
16327 *
16328 * @return the defined text alignment. It can be one of:
16329 *
16330 * {@link #TEXT_ALIGNMENT_INHERIT},
16331 * {@link #TEXT_ALIGNMENT_GRAVITY},
16332 * {@link #TEXT_ALIGNMENT_CENTER},
16333 * {@link #TEXT_ALIGNMENT_TEXT_START},
16334 * {@link #TEXT_ALIGNMENT_TEXT_END},
16335 * {@link #TEXT_ALIGNMENT_VIEW_START},
16336 * {@link #TEXT_ALIGNMENT_VIEW_END}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016337 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016338 */
16339 @ViewDebug.ExportedProperty(category = "text", mapping = {
16340 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"),
16341 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"),
16342 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"),
16343 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"),
16344 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"),
16345 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"),
16346 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END")
16347 })
16348 public int getTextAlignment() {
16349 return (mPrivateFlags2 & TEXT_ALIGNMENT_MASK) >> TEXT_ALIGNMENT_MASK_SHIFT;
16350 }
16351
16352 /**
16353 * Set the text alignment.
16354 *
16355 * @param textAlignment The text alignment to set. Should be one of
16356 *
16357 * {@link #TEXT_ALIGNMENT_INHERIT},
16358 * {@link #TEXT_ALIGNMENT_GRAVITY},
16359 * {@link #TEXT_ALIGNMENT_CENTER},
16360 * {@link #TEXT_ALIGNMENT_TEXT_START},
16361 * {@link #TEXT_ALIGNMENT_TEXT_END},
16362 * {@link #TEXT_ALIGNMENT_VIEW_START},
16363 * {@link #TEXT_ALIGNMENT_VIEW_END}
16364 *
16365 * @attr ref android.R.styleable#View_textAlignment
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016366 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016367 */
16368 public void setTextAlignment(int textAlignment) {
16369 if (textAlignment != getTextAlignment()) {
16370 // Reset the current and resolved text alignment
16371 mPrivateFlags2 &= ~TEXT_ALIGNMENT_MASK;
16372 resetResolvedTextAlignment();
16373 // Set the new text alignment
16374 mPrivateFlags2 |= ((textAlignment << TEXT_ALIGNMENT_MASK_SHIFT) & TEXT_ALIGNMENT_MASK);
16375 // Refresh
16376 requestLayout();
16377 invalidate(true);
16378 }
16379 }
16380
16381 /**
16382 * Return the resolved text alignment.
16383 *
16384 * The resolved text alignment. This needs resolution if the value is
16385 * TEXT_ALIGNMENT_INHERIT. The resolution matches {@link #setTextAlignment(int)} if it is
16386 * not TEXT_ALIGNMENT_INHERIT, otherwise resolution proceeds up the parent chain of the view.
16387 *
16388 * @return the resolved text alignment. Returns one of:
16389 *
16390 * {@link #TEXT_ALIGNMENT_GRAVITY},
16391 * {@link #TEXT_ALIGNMENT_CENTER},
16392 * {@link #TEXT_ALIGNMENT_TEXT_START},
16393 * {@link #TEXT_ALIGNMENT_TEXT_END},
16394 * {@link #TEXT_ALIGNMENT_VIEW_START},
16395 * {@link #TEXT_ALIGNMENT_VIEW_END}
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016396 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016397 */
16398 @ViewDebug.ExportedProperty(category = "text", mapping = {
16399 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_INHERIT, to = "INHERIT"),
16400 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_GRAVITY, to = "GRAVITY"),
16401 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_START, to = "TEXT_START"),
16402 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_TEXT_END, to = "TEXT_END"),
16403 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_CENTER, to = "CENTER"),
16404 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_START, to = "VIEW_START"),
16405 @ViewDebug.IntToString(from = TEXT_ALIGNMENT_VIEW_END, to = "VIEW_END")
16406 })
16407 public int getResolvedTextAlignment() {
16408 // If text alignment is not resolved, then resolve it
16409 if ((mPrivateFlags2 & TEXT_ALIGNMENT_RESOLVED) != TEXT_ALIGNMENT_RESOLVED) {
16410 resolveTextAlignment();
16411 }
16412 return (mPrivateFlags2 & TEXT_ALIGNMENT_RESOLVED_MASK) >> TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT;
16413 }
16414
16415 /**
16416 * Resolve the text alignment. Will call {@link View#onResolvedTextAlignmentChanged} when
16417 * resolution is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016418 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016419 */
16420 public void resolveTextAlignment() {
16421 // Reset any previous text alignment resolution
16422 mPrivateFlags2 &= ~(TEXT_ALIGNMENT_RESOLVED | TEXT_ALIGNMENT_RESOLVED_MASK);
16423
16424 if (hasRtlSupport()) {
16425 // Set resolved text alignment flag depending on text alignment flag
16426 final int textAlignment = getTextAlignment();
16427 switch (textAlignment) {
16428 case TEXT_ALIGNMENT_INHERIT:
16429 // Check if we can resolve the text alignment
16430 if (canResolveLayoutDirection() && mParent instanceof View) {
16431 View view = (View) mParent;
16432
16433 final int parentResolvedTextAlignment = view.getResolvedTextAlignment();
16434 switch (parentResolvedTextAlignment) {
16435 case TEXT_ALIGNMENT_GRAVITY:
16436 case TEXT_ALIGNMENT_TEXT_START:
16437 case TEXT_ALIGNMENT_TEXT_END:
16438 case TEXT_ALIGNMENT_CENTER:
16439 case TEXT_ALIGNMENT_VIEW_START:
16440 case TEXT_ALIGNMENT_VIEW_END:
16441 // Resolved text alignment is the same as the parent resolved
16442 // text alignment
16443 mPrivateFlags2 |=
16444 (parentResolvedTextAlignment << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT);
16445 break;
16446 default:
16447 // Use default resolved text alignment
16448 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16449 }
16450 }
16451 else {
16452 // We cannot do the resolution if there is no parent so use the default
16453 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16454 }
16455 break;
16456 case TEXT_ALIGNMENT_GRAVITY:
16457 case TEXT_ALIGNMENT_TEXT_START:
16458 case TEXT_ALIGNMENT_TEXT_END:
16459 case TEXT_ALIGNMENT_CENTER:
16460 case TEXT_ALIGNMENT_VIEW_START:
16461 case TEXT_ALIGNMENT_VIEW_END:
16462 // Resolved text alignment is the same as text alignment
16463 mPrivateFlags2 |= (textAlignment << TEXT_ALIGNMENT_RESOLVED_MASK_SHIFT);
16464 break;
16465 default:
16466 // Use default resolved text alignment
16467 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16468 }
16469 } else {
16470 // Use default resolved text alignment
16471 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED_DEFAULT;
16472 }
16473
16474 // Set the resolved
16475 mPrivateFlags2 |= TEXT_ALIGNMENT_RESOLVED;
16476 onResolvedTextAlignmentChanged();
16477 }
16478
16479 /**
16480 * Check if text alignment resolution can be done.
16481 *
16482 * @return true if text alignment resolution can be done otherwise return false.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016483 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016484 */
16485 public boolean canResolveTextAlignment() {
16486 switch (getTextAlignment()) {
16487 case TEXT_DIRECTION_INHERIT:
16488 return (mParent != null);
16489 default:
16490 return true;
16491 }
16492 }
16493
16494 /**
16495 * Called when text alignment has been resolved. Subclasses that care about text alignment
16496 * resolution should override this method.
16497 *
16498 * The default implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016499 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016500 */
16501 public void onResolvedTextAlignmentChanged() {
16502 }
16503
16504 /**
16505 * Reset resolved text alignment. Text alignment can be resolved with a call to
16506 * getResolvedTextAlignment(). Will call {@link View#onResolvedTextAlignmentReset} when
16507 * reset is done.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016508 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016509 */
16510 public void resetResolvedTextAlignment() {
16511 // Reset any previous text alignment resolution
16512 mPrivateFlags2 &= ~(TEXT_ALIGNMENT_RESOLVED | TEXT_ALIGNMENT_RESOLVED_MASK);
16513 onResolvedTextAlignmentReset();
16514 }
16515
16516 /**
16517 * Called when text alignment is reset. Subclasses that care about text alignment reset should
16518 * override this method and do a reset of the text alignment of their children. The default
16519 * implementation does nothing.
Fabrice Di Meglio66388dc2012-05-03 18:51:57 -070016520 * @hide
Fabrice Di Meglio9da0f8a2012-03-13 19:37:57 -070016521 */
16522 public void onResolvedTextAlignmentReset() {
16523 }
16524
Chet Haaseb39f0512011-05-24 14:36:40 -070016525 //
16526 // Properties
16527 //
16528 /**
16529 * A Property wrapper around the <code>alpha</code> functionality handled by the
16530 * {@link View#setAlpha(float)} and {@link View#getAlpha()} methods.
16531 */
Chet Haased47f1532011-12-16 11:18:52 -080016532 public static final Property<View, Float> ALPHA = new FloatProperty<View>("alpha") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016533 @Override
16534 public void setValue(View object, float value) {
16535 object.setAlpha(value);
16536 }
16537
16538 @Override
16539 public Float get(View object) {
16540 return object.getAlpha();
16541 }
16542 };
16543
16544 /**
16545 * A Property wrapper around the <code>translationX</code> functionality handled by the
16546 * {@link View#setTranslationX(float)} and {@link View#getTranslationX()} methods.
16547 */
Chet Haased47f1532011-12-16 11:18:52 -080016548 public static final Property<View, Float> TRANSLATION_X = new FloatProperty<View>("translationX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016549 @Override
16550 public void setValue(View object, float value) {
16551 object.setTranslationX(value);
16552 }
16553
16554 @Override
16555 public Float get(View object) {
16556 return object.getTranslationX();
16557 }
16558 };
16559
16560 /**
16561 * A Property wrapper around the <code>translationY</code> functionality handled by the
16562 * {@link View#setTranslationY(float)} and {@link View#getTranslationY()} methods.
16563 */
Chet Haased47f1532011-12-16 11:18:52 -080016564 public static final Property<View, Float> TRANSLATION_Y = new FloatProperty<View>("translationY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016565 @Override
16566 public void setValue(View object, float value) {
16567 object.setTranslationY(value);
16568 }
16569
16570 @Override
16571 public Float get(View object) {
16572 return object.getTranslationY();
16573 }
16574 };
16575
16576 /**
16577 * A Property wrapper around the <code>x</code> functionality handled by the
16578 * {@link View#setX(float)} and {@link View#getX()} methods.
16579 */
Chet Haased47f1532011-12-16 11:18:52 -080016580 public static final Property<View, Float> X = new FloatProperty<View>("x") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016581 @Override
16582 public void setValue(View object, float value) {
16583 object.setX(value);
16584 }
16585
16586 @Override
16587 public Float get(View object) {
16588 return object.getX();
16589 }
16590 };
16591
16592 /**
16593 * A Property wrapper around the <code>y</code> functionality handled by the
16594 * {@link View#setY(float)} and {@link View#getY()} methods.
16595 */
Chet Haased47f1532011-12-16 11:18:52 -080016596 public static final Property<View, Float> Y = new FloatProperty<View>("y") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016597 @Override
16598 public void setValue(View object, float value) {
16599 object.setY(value);
16600 }
16601
16602 @Override
16603 public Float get(View object) {
16604 return object.getY();
16605 }
16606 };
16607
16608 /**
16609 * A Property wrapper around the <code>rotation</code> functionality handled by the
16610 * {@link View#setRotation(float)} and {@link View#getRotation()} methods.
16611 */
Chet Haased47f1532011-12-16 11:18:52 -080016612 public static final Property<View, Float> ROTATION = new FloatProperty<View>("rotation") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016613 @Override
16614 public void setValue(View object, float value) {
16615 object.setRotation(value);
16616 }
16617
16618 @Override
16619 public Float get(View object) {
16620 return object.getRotation();
16621 }
16622 };
16623
16624 /**
16625 * A Property wrapper around the <code>rotationX</code> functionality handled by the
16626 * {@link View#setRotationX(float)} and {@link View#getRotationX()} methods.
16627 */
Chet Haased47f1532011-12-16 11:18:52 -080016628 public static final Property<View, Float> ROTATION_X = new FloatProperty<View>("rotationX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016629 @Override
16630 public void setValue(View object, float value) {
16631 object.setRotationX(value);
16632 }
16633
16634 @Override
16635 public Float get(View object) {
16636 return object.getRotationX();
16637 }
16638 };
16639
16640 /**
16641 * A Property wrapper around the <code>rotationY</code> functionality handled by the
16642 * {@link View#setRotationY(float)} and {@link View#getRotationY()} methods.
16643 */
Chet Haased47f1532011-12-16 11:18:52 -080016644 public static final Property<View, Float> ROTATION_Y = new FloatProperty<View>("rotationY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016645 @Override
16646 public void setValue(View object, float value) {
16647 object.setRotationY(value);
16648 }
16649
16650 @Override
16651 public Float get(View object) {
16652 return object.getRotationY();
16653 }
16654 };
16655
16656 /**
16657 * A Property wrapper around the <code>scaleX</code> functionality handled by the
16658 * {@link View#setScaleX(float)} and {@link View#getScaleX()} methods.
16659 */
Chet Haased47f1532011-12-16 11:18:52 -080016660 public static final Property<View, Float> SCALE_X = new FloatProperty<View>("scaleX") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016661 @Override
16662 public void setValue(View object, float value) {
16663 object.setScaleX(value);
16664 }
16665
16666 @Override
16667 public Float get(View object) {
16668 return object.getScaleX();
16669 }
16670 };
16671
16672 /**
16673 * A Property wrapper around the <code>scaleY</code> functionality handled by the
16674 * {@link View#setScaleY(float)} and {@link View#getScaleY()} methods.
16675 */
Chet Haased47f1532011-12-16 11:18:52 -080016676 public static final Property<View, Float> SCALE_Y = new FloatProperty<View>("scaleY") {
Chet Haaseb39f0512011-05-24 14:36:40 -070016677 @Override
16678 public void setValue(View object, float value) {
16679 object.setScaleY(value);
16680 }
16681
16682 @Override
16683 public Float get(View object) {
16684 return object.getScaleY();
16685 }
16686 };
16687
Jeff Brown33bbfd22011-02-24 20:55:35 -080016688 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016689 * A MeasureSpec encapsulates the layout requirements passed from parent to child.
16690 * Each MeasureSpec represents a requirement for either the width or the height.
16691 * A MeasureSpec is comprised of a size and a mode. There are three possible
16692 * modes:
16693 * <dl>
16694 * <dt>UNSPECIFIED</dt>
16695 * <dd>
16696 * The parent has not imposed any constraint on the child. It can be whatever size
16697 * it wants.
16698 * </dd>
16699 *
16700 * <dt>EXACTLY</dt>
16701 * <dd>
16702 * The parent has determined an exact size for the child. The child is going to be
16703 * given those bounds regardless of how big it wants to be.
16704 * </dd>
16705 *
16706 * <dt>AT_MOST</dt>
16707 * <dd>
16708 * The child can be as large as it wants up to the specified size.
16709 * </dd>
16710 * </dl>
16711 *
16712 * MeasureSpecs are implemented as ints to reduce object allocation. This class
16713 * is provided to pack and unpack the &lt;size, mode&gt; tuple into the int.
16714 */
16715 public static class MeasureSpec {
16716 private static final int MODE_SHIFT = 30;
16717 private static final int MODE_MASK = 0x3 << MODE_SHIFT;
16718
16719 /**
16720 * Measure specification mode: The parent has not imposed any constraint
16721 * on the child. It can be whatever size it wants.
16722 */
16723 public static final int UNSPECIFIED = 0 << MODE_SHIFT;
16724
16725 /**
16726 * Measure specification mode: The parent has determined an exact size
16727 * for the child. The child is going to be given those bounds regardless
16728 * of how big it wants to be.
16729 */
16730 public static final int EXACTLY = 1 << MODE_SHIFT;
16731
16732 /**
16733 * Measure specification mode: The child can be as large as it wants up
16734 * to the specified size.
16735 */
16736 public static final int AT_MOST = 2 << MODE_SHIFT;
16737
16738 /**
16739 * Creates a measure specification based on the supplied size and mode.
16740 *
16741 * The mode must always be one of the following:
16742 * <ul>
16743 * <li>{@link android.view.View.MeasureSpec#UNSPECIFIED}</li>
16744 * <li>{@link android.view.View.MeasureSpec#EXACTLY}</li>
16745 * <li>{@link android.view.View.MeasureSpec#AT_MOST}</li>
16746 * </ul>
16747 *
16748 * @param size the size of the measure specification
16749 * @param mode the mode of the measure specification
16750 * @return the measure specification based on size and mode
16751 */
16752 public static int makeMeasureSpec(int size, int mode) {
16753 return size + mode;
16754 }
16755
16756 /**
16757 * Extracts the mode from the supplied measure specification.
16758 *
16759 * @param measureSpec the measure specification to extract the mode from
16760 * @return {@link android.view.View.MeasureSpec#UNSPECIFIED},
16761 * {@link android.view.View.MeasureSpec#AT_MOST} or
16762 * {@link android.view.View.MeasureSpec#EXACTLY}
16763 */
16764 public static int getMode(int measureSpec) {
16765 return (measureSpec & MODE_MASK);
16766 }
16767
16768 /**
16769 * Extracts the size from the supplied measure specification.
16770 *
16771 * @param measureSpec the measure specification to extract the size from
16772 * @return the size in pixels defined in the supplied measure specification
16773 */
16774 public static int getSize(int measureSpec) {
16775 return (measureSpec & ~MODE_MASK);
16776 }
16777
16778 /**
16779 * Returns a String representation of the specified measure
16780 * specification.
16781 *
16782 * @param measureSpec the measure specification to convert to a String
16783 * @return a String with the following format: "MeasureSpec: MODE SIZE"
16784 */
16785 public static String toString(int measureSpec) {
16786 int mode = getMode(measureSpec);
16787 int size = getSize(measureSpec);
16788
16789 StringBuilder sb = new StringBuilder("MeasureSpec: ");
16790
16791 if (mode == UNSPECIFIED)
16792 sb.append("UNSPECIFIED ");
16793 else if (mode == EXACTLY)
16794 sb.append("EXACTLY ");
16795 else if (mode == AT_MOST)
16796 sb.append("AT_MOST ");
16797 else
16798 sb.append(mode).append(" ");
16799
16800 sb.append(size);
16801 return sb.toString();
16802 }
16803 }
16804
16805 class CheckForLongPress implements Runnable {
16806
16807 private int mOriginalWindowAttachCount;
16808
16809 public void run() {
The Android Open Source Project10592532009-03-18 17:39:46 -070016810 if (isPressed() && (mParent != null)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016811 && mOriginalWindowAttachCount == mWindowAttachCount) {
16812 if (performLongClick()) {
16813 mHasPerformedLongPress = true;
16814 }
16815 }
16816 }
16817
16818 public void rememberWindowAttachCount() {
16819 mOriginalWindowAttachCount = mWindowAttachCount;
16820 }
16821 }
Joe Malin32736f02011-01-19 16:14:20 -080016822
Adam Powelle14579b2009-12-16 18:39:52 -080016823 private final class CheckForTap implements Runnable {
16824 public void run() {
16825 mPrivateFlags &= ~PREPRESSED;
Adam Powell4d6f0662012-02-21 15:11:11 -080016826 setPressed(true);
Patrick Dubroye0a799a2011-05-04 16:19:22 -070016827 checkForLongClick(ViewConfiguration.getTapTimeout());
Adam Powelle14579b2009-12-16 18:39:52 -080016828 }
16829 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016830
Adam Powella35d7682010-03-12 14:48:13 -080016831 private final class PerformClick implements Runnable {
16832 public void run() {
16833 performClick();
16834 }
16835 }
16836
Dianne Hackborn63042d62011-01-26 18:56:29 -080016837 /** @hide */
16838 public void hackTurnOffWindowResizeAnim(boolean off) {
16839 mAttachInfo.mTurnOffWindowResizeAnim = off;
16840 }
Joe Malin32736f02011-01-19 16:14:20 -080016841
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016842 /**
Chet Haasea00f3862011-02-22 06:34:40 -080016843 * This method returns a ViewPropertyAnimator object, which can be used to animate
16844 * specific properties on this View.
16845 *
16846 * @return ViewPropertyAnimator The ViewPropertyAnimator associated with this View.
16847 */
16848 public ViewPropertyAnimator animate() {
16849 if (mAnimator == null) {
16850 mAnimator = new ViewPropertyAnimator(this);
16851 }
16852 return mAnimator;
16853 }
16854
16855 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016856 * Interface definition for a callback to be invoked when a key event is
16857 * dispatched to this view. The callback will be invoked before the key
16858 * event is given to the view.
16859 */
16860 public interface OnKeyListener {
16861 /**
16862 * Called when a key is dispatched to a view. This allows listeners to
16863 * get a chance to respond before the target view.
16864 *
16865 * @param v The view the key has been dispatched to.
16866 * @param keyCode The code for the physical key that was pressed
16867 * @param event The KeyEvent object containing full information about
16868 * the event.
16869 * @return True if the listener has consumed the event, false otherwise.
16870 */
16871 boolean onKey(View v, int keyCode, KeyEvent event);
16872 }
16873
16874 /**
16875 * Interface definition for a callback to be invoked when a touch event is
16876 * dispatched to this view. The callback will be invoked before the touch
16877 * event is given to the view.
16878 */
16879 public interface OnTouchListener {
16880 /**
16881 * Called when a touch event is dispatched to a view. This allows listeners to
16882 * get a chance to respond before the target view.
16883 *
16884 * @param v The view the touch event has been dispatched to.
16885 * @param event The MotionEvent object containing full information about
16886 * the event.
16887 * @return True if the listener has consumed the event, false otherwise.
16888 */
16889 boolean onTouch(View v, MotionEvent event);
16890 }
16891
16892 /**
Jeff Brown10b62902011-06-20 16:40:37 -070016893 * Interface definition for a callback to be invoked when a hover event is
16894 * dispatched to this view. The callback will be invoked before the hover
16895 * event is given to the view.
16896 */
16897 public interface OnHoverListener {
16898 /**
16899 * Called when a hover event is dispatched to a view. This allows listeners to
16900 * get a chance to respond before the target view.
16901 *
16902 * @param v The view the hover event has been dispatched to.
16903 * @param event The MotionEvent object containing full information about
16904 * the event.
16905 * @return True if the listener has consumed the event, false otherwise.
16906 */
16907 boolean onHover(View v, MotionEvent event);
16908 }
16909
16910 /**
Jeff Brown33bbfd22011-02-24 20:55:35 -080016911 * Interface definition for a callback to be invoked when a generic motion event is
16912 * dispatched to this view. The callback will be invoked before the generic motion
16913 * event is given to the view.
16914 */
16915 public interface OnGenericMotionListener {
16916 /**
16917 * Called when a generic motion event is dispatched to a view. This allows listeners to
16918 * get a chance to respond before the target view.
16919 *
16920 * @param v The view the generic motion event has been dispatched to.
16921 * @param event The MotionEvent object containing full information about
16922 * the event.
16923 * @return True if the listener has consumed the event, false otherwise.
16924 */
16925 boolean onGenericMotion(View v, MotionEvent event);
16926 }
16927
16928 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016929 * Interface definition for a callback to be invoked when a view has been clicked and held.
16930 */
16931 public interface OnLongClickListener {
16932 /**
16933 * Called when a view has been clicked and held.
16934 *
16935 * @param v The view that was clicked and held.
16936 *
Brad Fitzpatrick69ea4e12011-01-05 11:13:40 -080016937 * @return true if the callback consumed the long click, false otherwise.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016938 */
16939 boolean onLongClick(View v);
16940 }
16941
16942 /**
Chris Tate32affef2010-10-18 15:29:21 -070016943 * Interface definition for a callback to be invoked when a drag is being dispatched
16944 * to this view. The callback will be invoked before the hosting view's own
16945 * onDrag(event) method. If the listener wants to fall back to the hosting view's
16946 * onDrag(event) behavior, it should return 'false' from this callback.
Joe Fernandez558459f2011-10-13 16:47:36 -070016947 *
16948 * <div class="special reference">
16949 * <h3>Developer Guides</h3>
16950 * <p>For a guide to implementing drag and drop features, read the
16951 * <a href="{@docRoot}guide/topics/ui/drag-drop.html">Drag and Drop</a> developer guide.</p>
16952 * </div>
Chris Tate32affef2010-10-18 15:29:21 -070016953 */
16954 public interface OnDragListener {
16955 /**
16956 * Called when a drag event is dispatched to a view. This allows listeners
16957 * to get a chance to override base View behavior.
16958 *
Joe Malin32736f02011-01-19 16:14:20 -080016959 * @param v The View that received the drag event.
16960 * @param event The {@link android.view.DragEvent} object for the drag event.
16961 * @return {@code true} if the drag event was handled successfully, or {@code false}
16962 * if the drag event was not handled. Note that {@code false} will trigger the View
16963 * to call its {@link #onDragEvent(DragEvent) onDragEvent()} handler.
Chris Tate32affef2010-10-18 15:29:21 -070016964 */
16965 boolean onDrag(View v, DragEvent event);
16966 }
16967
16968 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080016969 * Interface definition for a callback to be invoked when the focus state of
16970 * a view changed.
16971 */
16972 public interface OnFocusChangeListener {
16973 /**
16974 * Called when the focus state of a view has changed.
16975 *
16976 * @param v The view whose state has changed.
16977 * @param hasFocus The new focus state of v.
16978 */
16979 void onFocusChange(View v, boolean hasFocus);
16980 }
16981
16982 /**
16983 * Interface definition for a callback to be invoked when a view is clicked.
16984 */
16985 public interface OnClickListener {
16986 /**
16987 * Called when a view has been clicked.
16988 *
16989 * @param v The view that was clicked.
16990 */
16991 void onClick(View v);
16992 }
16993
16994 /**
16995 * Interface definition for a callback to be invoked when the context menu
16996 * for this view is being built.
16997 */
16998 public interface OnCreateContextMenuListener {
16999 /**
17000 * Called when the context menu for this view is being built. It is not
17001 * safe to hold onto the menu after this method returns.
17002 *
17003 * @param menu The context menu that is being built
17004 * @param v The view for which the context menu is being built
17005 * @param menuInfo Extra information about the item for which the
17006 * context menu should be shown. This information will vary
17007 * depending on the class of v.
17008 */
17009 void onCreateContextMenu(ContextMenu menu, View v, ContextMenuInfo menuInfo);
17010 }
17011
Joe Onorato664644d2011-01-23 17:53:23 -080017012 /**
17013 * Interface definition for a callback to be invoked when the status bar changes
Dianne Hackborn9a230e02011-10-06 11:51:27 -070017014 * visibility. This reports <strong>global</strong> changes to the system UI
Dianne Hackborncf675782012-05-10 15:07:24 -070017015 * state, not what the application is requesting.
Joe Onorato664644d2011-01-23 17:53:23 -080017016 *
Philip Milne6c8ea062012-04-03 17:38:43 -070017017 * @see View#setOnSystemUiVisibilityChangeListener(android.view.View.OnSystemUiVisibilityChangeListener)
Joe Onorato664644d2011-01-23 17:53:23 -080017018 */
17019 public interface OnSystemUiVisibilityChangeListener {
17020 /**
17021 * Called when the status bar changes visibility because of a call to
Romain Guy5c22a8c2011-05-13 11:48:45 -070017022 * {@link View#setSystemUiVisibility(int)}.
Joe Onorato664644d2011-01-23 17:53:23 -080017023 *
Dianne Hackborncf675782012-05-10 15:07:24 -070017024 * @param visibility Bitwise-or of flags {@link #SYSTEM_UI_FLAG_LOW_PROFILE},
17025 * {@link #SYSTEM_UI_FLAG_HIDE_NAVIGATION}, and {@link #SYSTEM_UI_FLAG_FULLSCREEN}.
17026 * This tells you the <strong>global</strong> state of these UI visibility
17027 * flags, not what your app is currently applying.
Joe Onorato664644d2011-01-23 17:53:23 -080017028 */
17029 public void onSystemUiVisibilityChange(int visibility);
17030 }
17031
Adam Powell4afd62b2011-02-18 15:02:18 -080017032 /**
17033 * Interface definition for a callback to be invoked when this view is attached
17034 * or detached from its window.
17035 */
17036 public interface OnAttachStateChangeListener {
17037 /**
17038 * Called when the view is attached to a window.
17039 * @param v The view that was attached
17040 */
17041 public void onViewAttachedToWindow(View v);
17042 /**
17043 * Called when the view is detached from a window.
17044 * @param v The view that was detached
17045 */
17046 public void onViewDetachedFromWindow(View v);
17047 }
17048
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017049 private final class UnsetPressedState implements Runnable {
17050 public void run() {
17051 setPressed(false);
17052 }
17053 }
17054
17055 /**
17056 * Base class for derived classes that want to save and restore their own
17057 * state in {@link android.view.View#onSaveInstanceState()}.
17058 */
17059 public static class BaseSavedState extends AbsSavedState {
17060 /**
17061 * Constructor used when reading from a parcel. Reads the state of the superclass.
17062 *
17063 * @param source
17064 */
17065 public BaseSavedState(Parcel source) {
17066 super(source);
17067 }
17068
17069 /**
17070 * Constructor called by derived classes when creating their SavedState objects
17071 *
17072 * @param superState The state of the superclass of this view
17073 */
17074 public BaseSavedState(Parcelable superState) {
17075 super(superState);
17076 }
17077
17078 public static final Parcelable.Creator<BaseSavedState> CREATOR =
17079 new Parcelable.Creator<BaseSavedState>() {
17080 public BaseSavedState createFromParcel(Parcel in) {
17081 return new BaseSavedState(in);
17082 }
17083
17084 public BaseSavedState[] newArray(int size) {
17085 return new BaseSavedState[size];
17086 }
17087 };
17088 }
17089
17090 /**
17091 * A set of information given to a view when it is attached to its parent
17092 * window.
17093 */
17094 static class AttachInfo {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017095 interface Callbacks {
17096 void playSoundEffect(int effectId);
17097 boolean performHapticFeedback(int effectId, boolean always);
17098 }
17099
17100 /**
17101 * InvalidateInfo is used to post invalidate(int, int, int, int) messages
17102 * to a Handler. This class contains the target (View) to invalidate and
17103 * the coordinates of the dirty rectangle.
17104 *
17105 * For performance purposes, this class also implements a pool of up to
17106 * POOL_LIMIT objects that get reused. This reduces memory allocations
17107 * whenever possible.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017108 */
Romain Guyd928d682009-03-31 17:52:16 -070017109 static class InvalidateInfo implements Poolable<InvalidateInfo> {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017110 private static final int POOL_LIMIT = 10;
Romain Guy2e9bbce2009-04-01 10:40:10 -070017111 private static final Pool<InvalidateInfo> sPool = Pools.synchronizedPool(
17112 Pools.finitePool(new PoolableManager<InvalidateInfo>() {
Romain Guyd928d682009-03-31 17:52:16 -070017113 public InvalidateInfo newInstance() {
17114 return new InvalidateInfo();
17115 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017116
Romain Guyd928d682009-03-31 17:52:16 -070017117 public void onAcquired(InvalidateInfo element) {
17118 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017119
Romain Guyd928d682009-03-31 17:52:16 -070017120 public void onReleased(InvalidateInfo element) {
Romain Guy40c18f52011-09-01 17:01:18 -070017121 element.target = null;
Romain Guyd928d682009-03-31 17:52:16 -070017122 }
17123 }, POOL_LIMIT)
17124 );
17125
17126 private InvalidateInfo mNext;
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017127 private boolean mIsPooled;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017128
17129 View target;
17130
17131 int left;
17132 int top;
17133 int right;
17134 int bottom;
17135
Romain Guyd928d682009-03-31 17:52:16 -070017136 public void setNextPoolable(InvalidateInfo element) {
17137 mNext = element;
17138 }
17139
17140 public InvalidateInfo getNextPoolable() {
17141 return mNext;
17142 }
17143
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017144 static InvalidateInfo acquire() {
Romain Guyd928d682009-03-31 17:52:16 -070017145 return sPool.acquire();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017146 }
17147
17148 void release() {
Romain Guyd928d682009-03-31 17:52:16 -070017149 sPool.release(this);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017150 }
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017151
17152 public boolean isPooled() {
17153 return mIsPooled;
17154 }
17155
17156 public void setPooled(boolean isPooled) {
17157 mIsPooled = isPooled;
17158 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017159 }
17160
17161 final IWindowSession mSession;
17162
17163 final IWindow mWindow;
17164
17165 final IBinder mWindowToken;
17166
17167 final Callbacks mRootCallbacks;
17168
Romain Guy59a12ca2011-06-09 17:48:21 -070017169 HardwareCanvas mHardwareCanvas;
Chet Haasedaf98e92011-01-10 14:10:36 -080017170
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017171 /**
17172 * The top view of the hierarchy.
17173 */
17174 View mRootView;
Romain Guy8506ab42009-06-11 17:35:47 -070017175
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017176 IBinder mPanelParentWindowToken;
17177 Surface mSurface;
17178
Romain Guyb051e892010-09-28 19:09:36 -070017179 boolean mHardwareAccelerated;
Dianne Hackborn7eec10e2010-11-12 18:03:47 -080017180 boolean mHardwareAccelerationRequested;
Romain Guyb051e892010-09-28 19:09:36 -070017181 HardwareRenderer mHardwareRenderer;
Joe Malin32736f02011-01-19 16:14:20 -080017182
Romain Guy7e4e5612012-03-05 14:37:29 -080017183 boolean mScreenOn;
17184
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017185 /**
Romain Guy8506ab42009-06-11 17:35:47 -070017186 * Scale factor used by the compatibility mode
17187 */
17188 float mApplicationScale;
17189
17190 /**
17191 * Indicates whether the application is in compatibility mode
17192 */
17193 boolean mScalingRequired;
17194
17195 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070017196 * If set, ViewAncestor doesn't use its lame animation for when the window resizes.
Dianne Hackborn63042d62011-01-26 18:56:29 -080017197 */
17198 boolean mTurnOffWindowResizeAnim;
Joe Malin32736f02011-01-19 16:14:20 -080017199
Dianne Hackborn63042d62011-01-26 18:56:29 -080017200 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017201 * Left position of this view's window
17202 */
17203 int mWindowLeft;
17204
17205 /**
17206 * Top position of this view's window
17207 */
17208 int mWindowTop;
17209
17210 /**
Adam Powell26153a32010-11-08 15:22:27 -080017211 * Indicates whether views need to use 32-bit drawing caches
Romain Guy35b38ce2009-10-07 13:38:55 -070017212 */
Adam Powell26153a32010-11-08 15:22:27 -080017213 boolean mUse32BitDrawingCache;
Romain Guy35b38ce2009-10-07 13:38:55 -070017214
17215 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017216 * For windows that are full-screen but using insets to layout inside
17217 * of the screen decorations, these are the current insets for the
17218 * content of the window.
17219 */
17220 final Rect mContentInsets = new Rect();
17221
17222 /**
17223 * For windows that are full-screen but using insets to layout inside
17224 * of the screen decorations, these are the current insets for the
17225 * actual visible parts of the window.
17226 */
17227 final Rect mVisibleInsets = new Rect();
17228
17229 /**
17230 * The internal insets given by this window. This value is
17231 * supplied by the client (through
17232 * {@link ViewTreeObserver.OnComputeInternalInsetsListener}) and will
17233 * be given to the window manager when changed to be used in laying
17234 * out windows behind it.
17235 */
17236 final ViewTreeObserver.InternalInsetsInfo mGivenInternalInsets
17237 = new ViewTreeObserver.InternalInsetsInfo();
17238
17239 /**
17240 * All views in the window's hierarchy that serve as scroll containers,
17241 * used to determine if the window can be resized or must be panned
17242 * to adjust for a soft input area.
17243 */
17244 final ArrayList<View> mScrollContainers = new ArrayList<View>();
17245
Dianne Hackborn83fe3f52009-09-12 23:38:30 -070017246 final KeyEvent.DispatcherState mKeyDispatchState
17247 = new KeyEvent.DispatcherState();
17248
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017249 /**
17250 * Indicates whether the view's window currently has the focus.
17251 */
17252 boolean mHasWindowFocus;
17253
17254 /**
17255 * The current visibility of the window.
17256 */
17257 int mWindowVisibility;
17258
17259 /**
17260 * Indicates the time at which drawing started to occur.
17261 */
17262 long mDrawingTime;
17263
17264 /**
Romain Guy5bcdff42009-05-14 21:27:18 -070017265 * Indicates whether or not ignoring the DIRTY_MASK flags.
17266 */
17267 boolean mIgnoreDirtyState;
17268
17269 /**
Romain Guy02ccac62011-06-24 13:20:23 -070017270 * This flag tracks when the mIgnoreDirtyState flag is set during draw(),
17271 * to avoid clearing that flag prematurely.
17272 */
17273 boolean mSetIgnoreDirtyState = false;
17274
17275 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017276 * Indicates whether the view's window is currently in touch mode.
17277 */
17278 boolean mInTouchMode;
17279
17280 /**
Joe Onoratoc6cc0f82011-04-12 11:53:13 -070017281 * Indicates that ViewAncestor should trigger a global layout change
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017282 * the next time it performs a traversal
17283 */
17284 boolean mRecomputeGlobalAttributes;
17285
17286 /**
Dianne Hackborn9a230e02011-10-06 11:51:27 -070017287 * Always report new attributes at next traversal.
17288 */
17289 boolean mForceReportNewAttributes;
17290
17291 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017292 * Set during a traveral if any views want to keep the screen on.
17293 */
17294 boolean mKeepScreenOn;
17295
17296 /**
Joe Onorato664644d2011-01-23 17:53:23 -080017297 * Bitwise-or of all of the values that views have passed to setSystemUiVisibility().
17298 */
17299 int mSystemUiVisibility;
17300
17301 /**
Dianne Hackborn139e5aa2012-05-05 20:36:38 -070017302 * Hack to force certain system UI visibility flags to be cleared.
17303 */
17304 int mDisabledSystemUiVisibility;
17305
17306 /**
Dianne Hackborncf675782012-05-10 15:07:24 -070017307 * Last global system UI visibility reported by the window manager.
17308 */
17309 int mGlobalSystemUiVisibility;
17310
17311 /**
Joe Onorato664644d2011-01-23 17:53:23 -080017312 * True if a view in this hierarchy has an OnSystemUiVisibilityChangeListener
17313 * attached.
17314 */
17315 boolean mHasSystemUiListeners;
17316
17317 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017318 * Set if the visibility of any views has changed.
17319 */
17320 boolean mViewVisibilityChanged;
17321
17322 /**
17323 * Set to true if a view has been scrolled.
17324 */
17325 boolean mViewScrollChanged;
17326
17327 /**
17328 * Global to the view hierarchy used as a temporary for dealing with
17329 * x/y points in the transparent region computations.
17330 */
17331 final int[] mTransparentLocation = new int[2];
17332
17333 /**
17334 * Global to the view hierarchy used as a temporary for dealing with
17335 * x/y points in the ViewGroup.invalidateChild implementation.
17336 */
17337 final int[] mInvalidateChildLocation = new int[2];
17338
Chet Haasec3aa3612010-06-17 08:50:37 -070017339
17340 /**
17341 * Global to the view hierarchy used as a temporary for dealing with
17342 * x/y location when view is transformed.
17343 */
17344 final float[] mTmpTransformLocation = new float[2];
17345
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017346 /**
17347 * The view tree observer used to dispatch global events like
17348 * layout, pre-draw, touch mode change, etc.
17349 */
17350 final ViewTreeObserver mTreeObserver = new ViewTreeObserver();
17351
17352 /**
17353 * A Canvas used by the view hierarchy to perform bitmap caching.
17354 */
17355 Canvas mCanvas;
17356
17357 /**
Jeff Browna175a5b2012-02-15 19:18:31 -080017358 * The view root impl.
17359 */
17360 final ViewRootImpl mViewRootImpl;
17361
17362 /**
Dianne Hackborn6dd005b2011-07-18 13:22:50 -070017363 * A Handler supplied by a view's {@link android.view.ViewRootImpl}. This
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017364 * handler can be used to pump events in the UI events queue.
17365 */
17366 final Handler mHandler;
17367
17368 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017369 * Temporary for use in computing invalidate rectangles while
17370 * calling up the hierarchy.
17371 */
17372 final Rect mTmpInvalRect = new Rect();
svetoslavganov75986cf2009-05-14 22:28:01 -070017373
17374 /**
Chet Haasec3aa3612010-06-17 08:50:37 -070017375 * Temporary for use in computing hit areas with transformed views
17376 */
17377 final RectF mTmpTransformRect = new RectF();
17378
17379 /**
svetoslavganov75986cf2009-05-14 22:28:01 -070017380 * Temporary list for use in collecting focusable descendents of a view.
17381 */
Svetoslav Ganov42138042012-03-20 11:51:39 -070017382 final ArrayList<View> mTempArrayList = new ArrayList<View>(24);
svetoslavganov75986cf2009-05-14 22:28:01 -070017383
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017384 /**
Svetoslav Ganov8643aa02011-04-20 12:12:33 -070017385 * The id of the window for accessibility purposes.
17386 */
17387 int mAccessibilityWindowId = View.NO_ID;
17388
17389 /**
Svetoslav Ganov42138042012-03-20 11:51:39 -070017390 * Whether to ingore not exposed for accessibility Views when
17391 * reporting the view tree to accessibility services.
17392 */
17393 boolean mIncludeNotImportantViews;
17394
17395 /**
17396 * The drawable for highlighting accessibility focus.
17397 */
17398 Drawable mAccessibilityFocusDrawable;
17399
17400 /**
Philip Milne10ca24a2012-04-23 15:38:27 -070017401 * Show where the margins, bounds and layout bounds are for each view.
17402 */
Dianne Hackborna53de062012-05-08 18:53:51 -070017403 boolean mDebugLayout = SystemProperties.getBoolean(DEBUG_LAYOUT_PROPERTY, false);
Philip Milne10ca24a2012-04-23 15:38:27 -070017404
17405 /**
Romain Guyab4c4f4f2012-05-06 13:11:24 -070017406 * Point used to compute visible regions.
17407 */
17408 final Point mPoint = new Point();
17409
17410 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017411 * Creates a new set of attachment information with the specified
17412 * events handler and thread.
17413 *
17414 * @param handler the events handler the view must use
17415 */
17416 AttachInfo(IWindowSession session, IWindow window,
Jeff Browna175a5b2012-02-15 19:18:31 -080017417 ViewRootImpl viewRootImpl, Handler handler, Callbacks effectPlayer) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017418 mSession = session;
17419 mWindow = window;
17420 mWindowToken = window.asBinder();
Jeff Browna175a5b2012-02-15 19:18:31 -080017421 mViewRootImpl = viewRootImpl;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017422 mHandler = handler;
17423 mRootCallbacks = effectPlayer;
17424 }
17425 }
17426
17427 /**
17428 * <p>ScrollabilityCache holds various fields used by a View when scrolling
17429 * is supported. This avoids keeping too many unused fields in most
17430 * instances of View.</p>
17431 */
Mike Cleronf116bf82009-09-27 19:14:12 -070017432 private static class ScrollabilityCache implements Runnable {
Joe Malin32736f02011-01-19 16:14:20 -080017433
Mike Cleronf116bf82009-09-27 19:14:12 -070017434 /**
17435 * Scrollbars are not visible
17436 */
17437 public static final int OFF = 0;
17438
17439 /**
17440 * Scrollbars are visible
17441 */
17442 public static final int ON = 1;
17443
17444 /**
17445 * Scrollbars are fading away
17446 */
17447 public static final int FADING = 2;
17448
17449 public boolean fadeScrollBars;
Joe Malin32736f02011-01-19 16:14:20 -080017450
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017451 public int fadingEdgeLength;
Mike Cleronf116bf82009-09-27 19:14:12 -070017452 public int scrollBarDefaultDelayBeforeFade;
17453 public int scrollBarFadeDuration;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017454
17455 public int scrollBarSize;
17456 public ScrollBarDrawable scrollBar;
Mike Cleronf116bf82009-09-27 19:14:12 -070017457 public float[] interpolatorValues;
17458 public View host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017459
17460 public final Paint paint;
17461 public final Matrix matrix;
17462 public Shader shader;
17463
Mike Cleronf116bf82009-09-27 19:14:12 -070017464 public final Interpolator scrollBarInterpolator = new Interpolator(1, 2);
17465
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017466 private static final float[] OPAQUE = { 255 };
17467 private static final float[] TRANSPARENT = { 0.0f };
Joe Malin32736f02011-01-19 16:14:20 -080017468
Mike Cleronf116bf82009-09-27 19:14:12 -070017469 /**
17470 * When fading should start. This time moves into the future every time
17471 * a new scroll happens. Measured based on SystemClock.uptimeMillis()
17472 */
17473 public long fadeStartTime;
17474
17475
17476 /**
17477 * The current state of the scrollbars: ON, OFF, or FADING
17478 */
17479 public int state = OFF;
17480
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017481 private int mLastColor;
17482
Mike Cleronf116bf82009-09-27 19:14:12 -070017483 public ScrollabilityCache(ViewConfiguration configuration, View host) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017484 fadingEdgeLength = configuration.getScaledFadingEdgeLength();
17485 scrollBarSize = configuration.getScaledScrollBarSize();
Romain Guy35b38ce2009-10-07 13:38:55 -070017486 scrollBarDefaultDelayBeforeFade = ViewConfiguration.getScrollDefaultDelay();
17487 scrollBarFadeDuration = ViewConfiguration.getScrollBarFadeDuration();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017488
17489 paint = new Paint();
17490 matrix = new Matrix();
17491 // use use a height of 1, and then wack the matrix each time we
17492 // actually use it.
17493 shader = new LinearGradient(0, 0, 0, 1, 0xFF000000, 0, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070017494
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017495 paint.setShader(shader);
17496 paint.setXfermode(new PorterDuffXfermode(PorterDuff.Mode.DST_OUT));
Mike Cleronf116bf82009-09-27 19:14:12 -070017497 this.host = host;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017498 }
Romain Guy8506ab42009-06-11 17:35:47 -070017499
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017500 public void setFadeColor(int color) {
17501 if (color != 0 && color != mLastColor) {
17502 mLastColor = color;
17503 color |= 0xFF000000;
Romain Guy8506ab42009-06-11 17:35:47 -070017504
Romain Guye55e1a72009-08-27 10:42:26 -070017505 shader = new LinearGradient(0, 0, 0, 1, color | 0xFF000000,
17506 color & 0x00FFFFFF, Shader.TileMode.CLAMP);
Romain Guy8506ab42009-06-11 17:35:47 -070017507
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017508 paint.setShader(shader);
17509 // Restore the default transfer mode (src_over)
17510 paint.setXfermode(null);
17511 }
17512 }
Joe Malin32736f02011-01-19 16:14:20 -080017513
Mike Cleronf116bf82009-09-27 19:14:12 -070017514 public void run() {
Mike Cleron3ecd58c2009-09-28 11:39:02 -070017515 long now = AnimationUtils.currentAnimationTimeMillis();
Mike Cleronf116bf82009-09-27 19:14:12 -070017516 if (now >= fadeStartTime) {
17517
17518 // the animation fades the scrollbars out by changing
17519 // the opacity (alpha) from fully opaque to fully
17520 // transparent
17521 int nextFrame = (int) now;
17522 int framesCount = 0;
17523
17524 Interpolator interpolator = scrollBarInterpolator;
17525
17526 // Start opaque
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017527 interpolator.setKeyFrame(framesCount++, nextFrame, OPAQUE);
Mike Cleronf116bf82009-09-27 19:14:12 -070017528
17529 // End transparent
17530 nextFrame += scrollBarFadeDuration;
Gilles Debunne3dbf55c2010-12-16 10:31:51 -080017531 interpolator.setKeyFrame(framesCount, nextFrame, TRANSPARENT);
Mike Cleronf116bf82009-09-27 19:14:12 -070017532
17533 state = FADING;
17534
17535 // Kick off the fade animation
Romain Guy0fd89bf2011-01-26 15:41:30 -080017536 host.invalidate(true);
Mike Cleronf116bf82009-09-27 19:14:12 -070017537 }
17538 }
Svetoslav Ganova0156172011-06-26 17:55:44 -070017539 }
Mike Cleronf116bf82009-09-27 19:14:12 -070017540
Svetoslav Ganova0156172011-06-26 17:55:44 -070017541 /**
17542 * Resuable callback for sending
17543 * {@link AccessibilityEvent#TYPE_VIEW_SCROLLED} accessibility event.
17544 */
17545 private class SendViewScrolledAccessibilityEvent implements Runnable {
17546 public volatile boolean mIsPending;
17547
17548 public void run() {
17549 sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_SCROLLED);
17550 mIsPending = false;
17551 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017552 }
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017553
17554 /**
17555 * <p>
17556 * This class represents a delegate that can be registered in a {@link View}
17557 * to enhance accessibility support via composition rather via inheritance.
17558 * It is specifically targeted to widget developers that extend basic View
17559 * classes i.e. classes in package android.view, that would like their
17560 * applications to be backwards compatible.
17561 * </p>
Joe Fernandeze1302ed2012-02-06 14:30:15 -080017562 * <div class="special reference">
17563 * <h3>Developer Guides</h3>
17564 * <p>For more information about making applications accessible, read the
17565 * <a href="{@docRoot}guide/topics/ui/accessibility/index.html">Accessibility</a>
17566 * developer guide.</p>
17567 * </div>
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017568 * <p>
17569 * A scenario in which a developer would like to use an accessibility delegate
17570 * is overriding a method introduced in a later API version then the minimal API
17571 * version supported by the application. For example, the method
17572 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} is not available
17573 * in API version 4 when the accessibility APIs were first introduced. If a
17574 * developer would like his application to run on API version 4 devices (assuming
17575 * all other APIs used by the application are version 4 or lower) and take advantage
17576 * of this method, instead of overriding the method which would break the application's
17577 * backwards compatibility, he can override the corresponding method in this
17578 * delegate and register the delegate in the target View if the API version of
17579 * the system is high enough i.e. the API version is same or higher to the API
17580 * version that introduced
17581 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)}.
17582 * </p>
17583 * <p>
17584 * Here is an example implementation:
17585 * </p>
17586 * <code><pre><p>
17587 * if (Build.VERSION.SDK_INT >= 14) {
17588 * // If the API version is equal of higher than the version in
17589 * // which onInitializeAccessibilityNodeInfo was introduced we
17590 * // register a delegate with a customized implementation.
17591 * View view = findViewById(R.id.view_id);
17592 * view.setAccessibilityDelegate(new AccessibilityDelegate() {
17593 * public void onInitializeAccessibilityNodeInfo(View host,
17594 * AccessibilityNodeInfo info) {
17595 * // Let the default implementation populate the info.
17596 * super.onInitializeAccessibilityNodeInfo(host, info);
17597 * // Set some other information.
17598 * info.setEnabled(host.isEnabled());
17599 * }
17600 * });
17601 * }
17602 * </code></pre></p>
17603 * <p>
17604 * This delegate contains methods that correspond to the accessibility methods
17605 * in View. If a delegate has been specified the implementation in View hands
17606 * off handling to the corresponding method in this delegate. The default
17607 * implementation the delegate methods behaves exactly as the corresponding
17608 * method in View for the case of no accessibility delegate been set. Hence,
17609 * to customize the behavior of a View method, clients can override only the
17610 * corresponding delegate method without altering the behavior of the rest
17611 * accessibility related methods of the host view.
17612 * </p>
17613 */
17614 public static class AccessibilityDelegate {
17615
17616 /**
17617 * Sends an accessibility event of the given type. If accessibility is not
17618 * enabled this method has no effect.
17619 * <p>
17620 * The default implementation behaves as {@link View#sendAccessibilityEvent(int)
17621 * View#sendAccessibilityEvent(int)} for the case of no accessibility delegate
17622 * been set.
17623 * </p>
17624 *
17625 * @param host The View hosting the delegate.
17626 * @param eventType The type of the event to send.
17627 *
17628 * @see View#sendAccessibilityEvent(int) View#sendAccessibilityEvent(int)
17629 */
17630 public void sendAccessibilityEvent(View host, int eventType) {
17631 host.sendAccessibilityEventInternal(eventType);
17632 }
17633
17634 /**
alanv8eeefef2012-05-07 16:57:53 -070017635 * Performs the specified accessibility action on the view. For
17636 * possible accessibility actions look at {@link AccessibilityNodeInfo}.
17637 * <p>
17638 * The default implementation behaves as
17639 * {@link View#performAccessibilityAction(int, Bundle)
17640 * View#performAccessibilityAction(int, Bundle)} for the case of
17641 * no accessibility delegate been set.
17642 * </p>
17643 *
17644 * @param action The action to perform.
17645 * @return Whether the action was performed.
17646 *
17647 * @see View#performAccessibilityAction(int, Bundle)
17648 * View#performAccessibilityAction(int, Bundle)
17649 */
17650 public boolean performAccessibilityAction(View host, int action, Bundle args) {
17651 return host.performAccessibilityActionInternal(action, args);
17652 }
17653
17654 /**
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017655 * Sends an accessibility event. This method behaves exactly as
17656 * {@link #sendAccessibilityEvent(View, int)} but takes as an argument an
17657 * empty {@link AccessibilityEvent} and does not perform a check whether
17658 * accessibility is enabled.
17659 * <p>
17660 * The default implementation behaves as
17661 * {@link View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17662 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)} for
17663 * the case of no accessibility delegate been set.
17664 * </p>
17665 *
17666 * @param host The View hosting the delegate.
17667 * @param event The event to send.
17668 *
17669 * @see View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17670 * View#sendAccessibilityEventUnchecked(AccessibilityEvent)
17671 */
17672 public void sendAccessibilityEventUnchecked(View host, AccessibilityEvent event) {
17673 host.sendAccessibilityEventUncheckedInternal(event);
17674 }
17675
17676 /**
17677 * Dispatches an {@link AccessibilityEvent} to the host {@link View} first and then
17678 * to its children for adding their text content to the event.
17679 * <p>
17680 * The default implementation behaves as
17681 * {@link View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17682 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)} for
17683 * the case of no accessibility delegate been set.
17684 * </p>
17685 *
17686 * @param host The View hosting the delegate.
17687 * @param event The event.
17688 * @return True if the event population was completed.
17689 *
17690 * @see View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17691 * View#dispatchPopulateAccessibilityEvent(AccessibilityEvent)
17692 */
17693 public boolean dispatchPopulateAccessibilityEvent(View host, AccessibilityEvent event) {
17694 return host.dispatchPopulateAccessibilityEventInternal(event);
17695 }
17696
17697 /**
17698 * Gives a chance to the host View to populate the accessibility event with its
17699 * text content.
17700 * <p>
17701 * The default implementation behaves as
17702 * {@link View#onPopulateAccessibilityEvent(AccessibilityEvent)
17703 * View#onPopulateAccessibilityEvent(AccessibilityEvent)} for
17704 * the case of no accessibility delegate been set.
17705 * </p>
17706 *
17707 * @param host The View hosting the delegate.
17708 * @param event The accessibility event which to populate.
17709 *
17710 * @see View#onPopulateAccessibilityEvent(AccessibilityEvent)
17711 * View#onPopulateAccessibilityEvent(AccessibilityEvent)
17712 */
17713 public void onPopulateAccessibilityEvent(View host, AccessibilityEvent event) {
17714 host.onPopulateAccessibilityEventInternal(event);
17715 }
17716
17717 /**
17718 * Initializes an {@link AccessibilityEvent} with information about the
17719 * the host View which is the event source.
17720 * <p>
17721 * The default implementation behaves as
17722 * {@link View#onInitializeAccessibilityEvent(AccessibilityEvent)
17723 * View#onInitializeAccessibilityEvent(AccessibilityEvent)} for
17724 * the case of no accessibility delegate been set.
17725 * </p>
17726 *
17727 * @param host The View hosting the delegate.
17728 * @param event The event to initialize.
17729 *
17730 * @see View#onInitializeAccessibilityEvent(AccessibilityEvent)
17731 * View#onInitializeAccessibilityEvent(AccessibilityEvent)
17732 */
17733 public void onInitializeAccessibilityEvent(View host, AccessibilityEvent event) {
17734 host.onInitializeAccessibilityEventInternal(event);
17735 }
17736
17737 /**
17738 * Initializes an {@link AccessibilityNodeInfo} with information about the host view.
17739 * <p>
17740 * The default implementation behaves as
17741 * {@link View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17742 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)} for
17743 * the case of no accessibility delegate been set.
17744 * </p>
17745 *
17746 * @param host The View hosting the delegate.
17747 * @param info The instance to initialize.
17748 *
17749 * @see View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17750 * View#onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo)
17751 */
17752 public void onInitializeAccessibilityNodeInfo(View host, AccessibilityNodeInfo info) {
17753 host.onInitializeAccessibilityNodeInfoInternal(info);
17754 }
17755
17756 /**
17757 * Called when a child of the host View has requested sending an
17758 * {@link AccessibilityEvent} and gives an opportunity to the parent (the host)
17759 * to augment the event.
17760 * <p>
17761 * The default implementation behaves as
17762 * {@link ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17763 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)} for
17764 * the case of no accessibility delegate been set.
17765 * </p>
17766 *
17767 * @param host The View hosting the delegate.
17768 * @param child The child which requests sending the event.
17769 * @param event The event to be sent.
17770 * @return True if the event should be sent
17771 *
17772 * @see ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17773 * ViewGroup#onRequestSendAccessibilityEvent(View, AccessibilityEvent)
17774 */
17775 public boolean onRequestSendAccessibilityEvent(ViewGroup host, View child,
17776 AccessibilityEvent event) {
17777 return host.onRequestSendAccessibilityEventInternal(child, event);
17778 }
Svetoslav Ganov02107852011-10-03 17:06:56 -070017779
17780 /**
17781 * Gets the provider for managing a virtual view hierarchy rooted at this View
17782 * and reported to {@link android.accessibilityservice.AccessibilityService}s
17783 * that explore the window content.
17784 * <p>
17785 * The default implementation behaves as
17786 * {@link View#getAccessibilityNodeProvider() View#getAccessibilityNodeProvider()} for
17787 * the case of no accessibility delegate been set.
17788 * </p>
17789 *
17790 * @return The provider.
17791 *
17792 * @see AccessibilityNodeProvider
17793 */
17794 public AccessibilityNodeProvider getAccessibilityNodeProvider(View host) {
17795 return null;
17796 }
Svetoslav Ganov031d9c12011-09-09 16:41:13 -070017797 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080017798}